【注】本文译自:https://www.tutorialspoint.com/spring_boot/spring_boot_interceptor.htm
在以下两种情况下,可以在 Spring Boot 中使用拦截器来执行操作:
-
- 发送请求到控制器之前
- 发送响应到客户端之前
譬如,可以使用拦截器在发送请求到控制器之前添加请求头,并在发送响应到客户端之前添加响应头。
要用拦截器,你需要创建 @Component 类,并且要实现 HandlerInterceptor 接口。
下面是使用拦截器要知道的三个方法:
-
- preHandle() 方法:用于在发送请求到控制器之前执行操作。这个方法应当返回 true 以响应客户端。
- postHandle() 方法:用于在发送响应到客户端之前执行操作。
- afterCompletion() 方法: 用于在请求和响应完成之后执行操作。
观察以下代码以加深理解:
@Component
还要通过 WebMvcConfigurerAdapter 用 InterceptorRegistry 注册这个拦截器:
@Component
在下面给出的示例中,我们将要使用后面给出的 GET products API:
Interceptor 类文件 ProductServiceInterceptor.java 如下所示:
package
Application Configuration 类文件把拦截器注册到 Interceptor Registry中,ProductServiceInterceptorAppConfig.java 文件如下:
package
Controller 类文件 ProductServiceController.java 如下:
package
POJO 类文件 Product.java 如下:
package
主 Spring Boot 应用类文件DemoApplication.java如下所示:
package com.tutorialspoint.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
Maven build –pom.xml文件在此:
<?xml version = "1.0" encoding = "UTF-8"?>
Gradle Buildbuild.gradle文件在此:
buildscript
你可以使用下面的 Maven 或 Gradle 命令创建可执行的 JAR 文件,运行 Spring Boot 应用:
对于 Maven,使用以下命令:
mvn clean install
在 “BUILD SUCCESS” 之后,你可以在 target 目录下找到 JAR 文件:
对于 Gradle,使用以下命令:
gradle clean build
在 “BUILD SUCCESSFUL” 之后,你可以在 build/libs 目录下找到 JAR 文件:
可以使用以下命令运行 JAR 文件:
java –jar <JARFILE>
此刻,应用已经在 Tomcat 8080 端口启动了,如下所示:
在 POSTMAN 应用中单击以下 URL,你可以看到下面的结果:
GET API: http://localhost:8080/products
在控制台窗口,你可以看到加在拦截器中的 System.out.println 打印出来的结果,截屏如下: