Spring boot 中 WebMvcConfigurationSupport 详解
应用场景:
新写了一个简单项目,里面需要提供一个接口给第三方访问,第三方要求的接口响应时间为3s,因此需要对接口进行时间的记录 以下是具体的使用。
第一步:自定义拦截器
实现HandlerInterceptor这个接口
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* @author HongYi
* @createTime 2021年02月01日 14:00:00
*/
@Component
public class MyInterceptor implements HandlerInterceptor {
private static final Logger logger = LoggerFactory.getLogger(MyInterceptor.class);
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
logger.info("------------------ preHandle");
request.setAttribute("startTime",System.currentTimeMillis());
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
logger.info("------------------ postHandle");
long startTime = (long) request.getAttribute("startTime");
request.removeAttribute("startTime");
logger.info("请求处理时间: " + (System.currentTimeMillis() - startTime) + "毫秒");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
Object handler, Exception ex) {
logger.info("------------------ after");
}
}
第二步:注册拦截器
继承 WebMvcConfigurationSupport ,重写 addInterceptors 方法
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
/**
* @author HongYi
* @createTime 2021年02月01日 14:00:00
*/
@Configuration
public class AddInterceptor extends WebMvcConfigurationSupport {
@Override
public void addInterceptors(InterceptorRegistry interceptorRegistry) {
interceptorRegistry.addInterceptor(new MyInterceptor()).addPathPatterns("/sell_record/**");
}
}
以上两步完成,即完成拦截器的注册。该拦截器会对/sell_record/**
请求路径进行拦截。
controller测试类
/**
* @author HongYi
* @createTime 2021年01月26日 11:23:00
*/
@RestController
@RequestMapping("/sell_record")
public class TestController {
@PostMapping("/secret_report/home_dispatch")
public void getCallRecordBySecretReport1(){
for (int i = 0;i < 100; i++){
System.out.println(i);
}
}
}
一个简单的拦截器就写完了~
拦截器不起作用问题
- 继承 WebMvcConfigurationSupport ,重写 addInterceptors 方法的类需用到
@Configuration
注解 -
addPathPatterns
中的**
问题。拦截器最后路径一定要/**
, 如果是目录的话则是/*/
拦截器的主要方法
configurePathMatch:配置路由请求规则
configureContentNegotiation:内容协商配置
configureAsyncSupport
configureDefaultServletHandling:默认静态资源处理器
addFormatters:注册自定义转化器
addInterceptors:拦截器配置
addResourceHandlers:资源处理
addCorsMappings:CORS配置
addViewControllers:视图跳转控制器
configureViewResolvers:配置视图解析
addArgumentResolvers:添加自定义方法参数处理器
addReturnValueHandlers:添加自定义返回结果处理器
configureMessageConverters:配置消息转换器。重载会覆盖默认注册的HttpMessageConverter
extendMessageConverters:配置消息转换器。仅添加一个自定义的HttpMessageConverter.
configureHandlerExceptionResolvers:配置异常转换器
extendHandlerExceptionResolvers:添加异常转化器
getValidator
getMessageCodesResolver
其中用的比较多的是一下三个接口:
/** 解决跨域问题 **/
public void addCorsMappings(CorsRegistry registry) ;
/** 添加拦截器 **/
void addInterceptors(InterceptorRegistry registry);
/** 静态资源处理 **/
void addResourceHandlers(ResourceHandlerRegistry registry);
跨域
@Configuration
public class AddCorsMappings extends WebMvcConfigurationSupport {
/**
* 跨域访问配置接口
* @param registry
*/
@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping("/**")
.allowedOrigins("*")
.allowedMethods("POST", "GET", "PUT", "OPTIONS", "DELETE")
.allowCredentials(true)
.allowedHeaders("*")
.maxAge(3600);
}
}
非常重要的提示:Springboot
中只能有一个WebMvcConfigurationSupport
配置类是真正起作用的,对于这个问题,其实可以通过implements WebMvcConfigurer
来解决,多个不同的类实现这个接口后的配置都可以正常运行。