要用拦截器必须要将实现HandlerInterceptor的拦截器注册到InterceptorRegistry
对象中。
需要先写一个拦截器,规则:实现HandlerInterceptor
作用:在请求的处理过程中添加自定义的逻辑。
-
preHandle()
:在请求被处理之前执行的逻辑,可以通过返回值决定是否继续处理请求。return true会放行,return false不放行 -
postHandle()
:在请求处理完成后,视图渲染之前执行的逻辑。 -
afterCompletion()
:在整个请求完成后(包括视图渲染)执行的逻辑。
package com.example.demo.interceptor; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; public class loginInterceptor implements HandlerInterceptor { // 在请求被处理之前执行的逻辑,可以通过返回值决定是否继续处理请求。 @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { return false; } // 在请求处理完成后,视图渲染之前执行的逻辑。 @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 { } }
拦截器写完后还需要把拦截器注册到InterceptorRegistry
对象中,规则:实现WebMvcConfigurer
WebMvcConfigurer中的方法与作用
-
configurePathMatch(PathMatchConfigurer configurer)
: 用于配置路径匹配规则,可以设置是否忽略路径的大小写,以及添加自定义的路径匹配器或路径过滤器。 -
configureContentNegotiation(ContentNegotiationConfigurer configurer)
: 用于配置内容协商,可以设置默认的媒体类型、默认的请求参数以及自定义的内容协商策略。 -
configureAsyncSupport(AsyncSupportConfigurer configurer)
: 用于配置异步支持,可以设置异步请求的超时时间、异步请求拦截器等。 -
configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer)
: 用于配置静态资源的处理,默认情况下,静态资源的处理是由Servlet容器处理的,通过该方法可以将静态资源的请求转发到默认的Servlet容器。 -
addFormatters(FormatterRegistry registry)
: 用于注册自定义的格式化器和解析器,用于处理表单数据的格式化和解析。 -
addInterceptors(InterceptorRegistry registry)
: 用于注册自定义的拦截器,可以拦截请求并对其进行处理,如权限验证、日志记录等。 -
addCorsMappings(CorsRegistry registry)
: 用于配置跨域资源共享(CORS),可以设置允许访问的域名、请求方法和头部信息等。 -
addViewControllers(ViewControllerRegistry registry)
: 用于增加简单的视图控制器,可以直接将请求映射到视图,不需要编写具体的处理逻辑。 -
configureViewResolvers(ViewResolverRegistry registry)
: 用于配置视图解析器,可以设置视图解析器的前缀、后缀、缓存等。
-
addPathPatterns() 放要拦截的接口
- excludePathPatterns()放开放的接口
package com.example.demo.interceptor; import org.springframework.context.annotation.Bean; 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 interceptorConfig implements WebMvcConfigurer { // 获取loginInterceptor拦截器对象 @Bean public loginInterceptor getLoginInterceptor(){ return new loginInterceptor(); } @Override public void addInterceptors(InterceptorRegistry registry) { System.out.println("拦截器启动"); // 将loginInterceptor拦截器对象注册到InterceptorRegistry对象中 registry.addInterceptor(getLoginInterceptor()) .addPathPatterns("/**") //拦截所有接口 .excludePathPatterns("/demoDept/getDeptOne","/loginTest/login"); //排除这些接口 } }
向前端返回json数据:ObjectMapper向前端响应json数据,将java对象与json字符串互相转换 - Lwmm - 博客园 (cnblogs.com)
注册拦截器的两种方法:
1.注册拦截器的常见方式是通过实现WebMvcConfigurer
接口,并在addInterceptors()
方法中将拦截器添加到InterceptorRegistry
中。示例代码如下:
@Configuration public class InterceptorConfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new CustomInterceptor()); } }
2.另外一种方式是使用@Configuration
注解创建一个配置类,并在该类中使用@Bean
注解将拦截器实例注册为一个Spring Bean。示例代码如下:
@Configuration public class InterceptorConfig { @Bean public HandlerInterceptor customInterceptor() { return new CustomInterceptor(); } }