spring boot接口设置秘钥

原创

mob64ca12d94299 2024-08-30 05:28:22 ©著作权

文章标签 spring API 拦截器 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12d94299的原创作品，请联系作者获取转载授权，否则将追究法律责任

在Spring Boot中实现接口秘钥设置

在现代的Web应用程序中，秘钥管理是确保数据和服务安全的关键组成部分。开发者需要在API请求中使用秘钥来认证用户身份，确保只有授权用户才能访问特定资源。在这篇文章中，我们将逐步推进，帮助刚入行的小白实现Spring Boot接口的秘钥设置。

流程概述

下面是实现Spring Boot接口秘钥管理的流程图，展示了各个步骤之间的关系：

步骤	描述
1	创建Spring Boot项目
2	添加依赖库
3	配置秘钥
4	创建拦截器
5	编写控制器
6	测试接口

sequenceDiagram
    participant dev as 开发者
    participant app as Spring Boot应用
    dev->>app: 创建Spring Boot项目
    dev->>app: 添加依赖库
    dev->>app: 配置秘钥
    dev->>app: 创建拦截器
    dev->>app: 编写控制器
    dev->>app: 测试接口

逐步实现

1. 创建Spring Boot项目

首先，你需要一个Spring Boot项目。你可以使用Spring Initializr（ Boot工程。

2. 添加依赖库

在项目的pom.xml中添加需要的依赖库，比如spring-boot-starter-web：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

上述代码用来引入Spring Web模块，支持RESTful API的开发。

3. 配置秘钥

在application.properties文件中设置秘钥：

# 应用秘钥配置
api.secret.key=mySecretKey

这行代码用于设置一个秘钥，在后续的请求中将被用来验证请求的合法性。

4. 创建拦截器

在项目中添加一个拦截器来处理API请求。首先创建一个类ApiKeyInterceptor：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Component
public class ApiKeyInterceptor implements HandlerInterceptor {

    @Value("${api.secret.key}")
    private String apiKey;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        String requestApiKey = request.getHeader("X-API-KEY");

        if (apiKey.equals(requestApiKey)) {
            return true; // 如果秘钥匹配，继续处理请求
        } else {
            response.sendError(HttpServletResponse.SC_UNAUTHORIZED, "Unauthorized"); // 秘钥不匹配，返回401状态码
            return false;
        }
    }
}

@Value注解用于注入配置文件中的秘钥。
preHandle方法用于在处理请求之前验证秘钥。

接下来，在Spring Boot的配置类中注册这个拦截器：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private ApiKeyInterceptor apiKeyInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(apiKeyInterceptor).addPathPatterns("/api/**");
    }
}

这段代码注册了我们刚才创建的ApiKeyInterceptor，并指定拦截的路径。

5. 编写控制器

现在，让我们创建一个简单的控制器，供用户测试秘钥接口：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ApiController {

    @GetMapping("/api/hello")
    public String hello() {
        return "Hello, authenticated user!"; // 如果请求合法，将返回这段消息
    }
}

@RestController注解表示这是一个控制器，提供RESTful API。
@GetMapping注解用于处理GET请求。

6. 测试接口

现在你可以启动Spring Boot应用，打开Postman或其他API测试工具，尝试发送请求：

无秘钥请求：

GET /api/hello

应该返回401 Unauthorised状态。

带秘钥请求：

GET /api/hello
头部：
X-API-KEY: mySecretKey

应该返回："Hello, authenticated user!"

gantt
    title API秘钥管理实现流程
    dateFormat  YYYY-MM-DD
    section 项目准备
    创建Spring Boot项目 :done, 2023-10-01, 1d
    添加依赖库 :done, 2023-10-01, 1d
    section 功能实现
    配置秘钥 :done, 2023-10-02, 1d
    创建拦截器 :done, 2023-10-03, 1d
    编写控制器 :done, 2023-10-04, 1d
    测试接口 :done, 2023-10-05, 1d