Spring Boot拦截器：3步打造安全、高效的Web应用

前端

2023-04-28 21:07:28

Spring Boot拦截器：打造安全、高效、可维护的Web应用

简介

在构建Web应用时，拦截器是一个强大的工具，可以显著提升应用的安全性、效率和可维护性。Spring Boot为开发者提供了强大的拦截器支持，允许开发者对请求进行拦截并执行一系列操作，包括登录验证、权限验证、乱码解决、性能监控和异常处理等。

什么是拦截器？

拦截器是一种设计模式，用于拦截请求并在处理请求前或完成后执行特定的操作。在Spring Boot中，拦截器可以基于URL对请求进行拦截，主要应用于以下场景：

登录验证： 拦截器可检查请求是否已通过授权，若未授权则重定向至登录页面。
权限验证： 拦截器可验证请求是否具有访问特定资源的权限，若无权限则返回错误信息。
乱码解决： 拦截器可将请求中的乱码数据转换成正确的编码格式。
性能监控： 拦截器可记录请求的执行时间和资源消耗情况，便于进行性能分析。
异常处理： 拦截器可捕获请求中抛出的异常并进行统一处理。

定义拦截器

在Spring Boot中定义拦截器非常简单，只需创建一个拦截器类并实现HandlerInterceptor接口，重写以下三个方法即可：

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    // 在请求处理前执行
    return true;
}

@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    // 在请求处理后执行
}

@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    // 在请求处理完成后执行
}

注册拦截器

定义好拦截器后，需要在Spring Boot配置文件中进行注册。在application.properties文件中添加以下配置：

spring.mvc.interceptor.register-interceptor-beans=true

并在Spring Boot启动类中添加@EnableWebMvc注解，如下：

@SpringBootApplication
@EnableWebMvc
public class App {

    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
}

指定拦截规则

注册完拦截器后，需要指定拦截规则。在application.properties文件中添加以下配置：

spring.mvc.interceptor.order=1
spring.mvc.interceptor.pathPatterns=/api/**

其中，order属性指定拦截器的优先级，pathPatterns属性指定拦截器的拦截路径。

代码示例

假设我们需要实现一个登录验证拦截器，以下是具体代码：

@Component
public class LoginInterceptor implements HandlerInterceptor {

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

        // 如果未提供Authorization，返回401未授权
        if (authHeader == null) {
            response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
            return false;
        }

        // 解析Authorization
        String[] parts = authHeader.split(" ");

        // 如果不是Bearer，返回401未授权
        if (!parts[0].equals("Bearer")) {
            response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
            return false;
        }

        // 解析JWT，验证是否合法
        try {
            JWT jwt = JWT.decode(parts[1]);

            // 验证JWT签名是否合法
            if (!jwt.verifySignature(SignatureAlgorithm.HS256, "secret")) {
                response.setStatus(HttpServletResponse.SC_FORBIDDEN);
                return false;
            }

            // 验证JWT是否已过期
            if (jwt.getExpiration().before(new Date())) {
                response.setStatus(HttpServletResponse.SC_FORBIDDEN);
                return false;
            }

        } catch (Exception e) {
            response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
            return false;
        }

        // 如果验证通过，返回true允许请求继续
        return true;
    }
}