在Spring框架中，拦截器（Interceptor）是一种非常有用的工具，可以用于处理请求和响应的预处理与后处理。通过拦截器，我们可以轻松实现一些通用的功能，例如权限校验、日志记录或性能监控等。
接下来，我们将通过一个简单的例子来展示如何在Spring项目中设置拦截器。
1. 创建 Spring Boot 项目
首先，确保你已经创建了一个Spring Boot项目。如果还没有创建，可以通过Spring Initializr快速生成一个基础项目。
2. 创建拦截器类
我们需要定义一个类来实现`HandlerInterceptor`接口。这个类将包含拦截逻辑。
```java
package com.example.interceptor;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Component
public class MyInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("Pre Handle method is called.");
return true; // 如果返回false，请求将被终止
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, Object modelAndView) throws Exception {
System.out.println("Post Handle method is called.");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("After Completion method is called.");
}
}
```
3. 配置拦截器
接下来，我们需要配置拦截器，使其能够拦截特定的请求路径。
```java
package com.example.config;
import com.example.interceptor.MyInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
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 MyInterceptor myInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(myInterceptor)
.addPathPatterns("/api/") // 拦截所有以/api开头的请求
.excludePathPatterns("/api/public/"); // 排除/api/public下的请求
}
}
```
4. 测试拦截器
现在，你可以启动你的Spring Boot应用程序，并访问一些URL来测试拦截器是否正常工作。例如：
- 访问`/api/test`时，拦截器应该会打印日志。
- 访问`/api/public/test`时，拦截器不会触发。
总结
通过上述步骤，我们成功地在Spring Boot项目中设置了一个简单的拦截器。拦截器在实际开发中非常有用，尤其是在需要对请求进行统一处理的情况下。你可以根据具体需求扩展拦截器的功能，比如添加日志记录、权限验证等。
希望这个示例对你有所帮助！如果你有任何问题或需要进一步的帮助，请随时联系我。
