Springboot Interceptor Returns Formatted JSON to Front End

后端

2023-10-04 06:43:05

拦截器：轻松返回格式化的 JSON 数据

理解拦截器

Spring Boot 中的拦截器是一种强大的工具，它使开发人员能够轻松增强应用程序的功能。拦截器允许您在请求处理的特定阶段执行自定义逻辑，从而为您的应用程序添加自定义行为。

使用拦截器返回格式化的 JSON 数据

拦截器的一个特别有用的功能是轻松返回格式化的 JSON 数据给前端。这可以通过利用 JSON 解析器（如 Spring Boot 中提供的解析器）将数据转换为 JSON 格式并将其返回给客户端来实现。

使用拦截器进行 JWT 验证

如果您使用 JSON Web 令牌 (JWT) 进行身份验证，您还可以使用拦截器来验证 JWT 并提取有关用户的相关信息。这可以通过解析 JWT 令牌并验证其签名、有效期和发行者等信息来实现。

关键注意事项

在使用拦截器返回格式化的 JSON 数据时，需要注意两点：

确保您的拦截器能够正确处理 JSON 数据。
确保您的拦截器能够正确处理 JWT 验证。

示例实现

以下代码示例展示了如何使用 Spring Boot 拦截器来返回格式化的 JSON 数据并进行 JWT 验证：

Controller 类：

@RestController
public class MyController {

    @RequestMapping(value = "/api/data", method = RequestMethod.GET)
    public ResponseEntity<String> getData() {
        // 获取数据
        List<String> data = new ArrayList<>();
        data.add("Hello");
        data.add("World");

        // 将数据转换为 JSON 格式
        String json = new ObjectMapper().writeValueAsString(data);

        // 返回 JSON 数据
        return ResponseEntity.ok(json);
    }
}

拦截器类：

@Component
public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 获取请求头中的 Authorization 字段
        String authorization = request.getHeader("Authorization");

        // 验证 JWT
        if (authorization != null && authorization.startsWith("Bearer ")) {
            String token = authorization.substring(7);
            try {
                // 解析 JWT
                Claims claims = Jwts.parser().setSigningKey("secret").parseClaimsJws(token).getBody();

                // 验证 JWT 是否有效
                if (claims.getExpiration().before(new Date())) {
                    throw new Exception("JWT 已过期");
                }

                // 验证 JWT 是否合法
                if (!claims.getIssuer().equals("issuer") || !claims.getAudience().equals("audience")) {
                    throw new Exception("JWT 非法");
                }

                // 将用户 ID 放入 request 中
                request.setAttribute("userId", claims.getSubject());

                return true;
            } catch (Exception e) {
                // JWT 验证失败
                response.sendError(401, "JWT 验证失败");
                return false;
            }
        } else {
            // 没有提供 JWT
            response.sendError(401, "没有提供 JWT");
            return false;
        }
    }
}