springboot(18)-interceptor

springboot&interceptor

引

言

拦截器(Interceptor): 用于在某个方法被访问之前进行拦截，然后在方法执行之前或之后加入某些操作，其实就是AOP的一种实现策略。它通过动态拦截Action调用的对象，允许开发者定义在一个action执行的前后执行的代码，也可以在一个action执行前阻止其执行。同时也是提供了一种可以提取action中可重用的部分的方式。

在应用中拦截器的作用可以用来判断用户是否登录以及权限认证、记录日志信息等等。

一

拦截器实现方式

spring中拦截器的通用接口是HandlerInterceptor，我们实现自定义拦截器有两种方式：

• 自定义类实现HandlerInterceptor接口
• 自定义类继承HandlerInterceptorAdapter类，HandlerInterceptorAdapter间接实现了HandlerInterceptor接口

二

目标

基于springboot使用拦截器实现简单的登录认证。

三

springboot使用interceptor

1：引入依赖

引入springboot基础依赖和序列化依赖：

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!-- fastjson --> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> </dependency>

2：编码实现

自定义认证注解：

@Target({ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface NeedLogin { /** * if need login or not * * @return */ boolean value() default true; }

自定义拦截器：

@Slf4j public class CustomInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { if(!(handler instanceof HandlerMethod)) { return true; } HandlerMethod handlerMethod = (HandlerMethod)handler; NeedLogin needLogin = handlerMethod.getMethod().getAnnotation(NeedLogin.class); if(null == needLogin || !needLogin.value()) { log.info("{}没有加注解或者不需登录",handlerMethod.getMethod().getName()); return true; } this.putFailResult(response,"需要登录"); return false; } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception { } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception { } private void putFailResult(HttpServletResponse response, String msg) { Map<String, Object> results = new HashMap<>(); results.put("code", "error"); results.put("msg", msg); ResponseUtils.renderJson(response, JSONObject.toJSONString(results, SerializerFeature.WriteMapNullValue)); } }

注册拦截器：

@Configuration public class WebMvcConfig implements WebMvcConfigurer { @Bean public CustomInterceptor customInterceptor() { return new CustomInterceptor(); } @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(customInterceptor()); } }

请求入口：

@RestController public class IndexController { @GetMapping("/hello") public String hello() { return "hello,world"; } @GetMapping("/needlogin") @NeedLogin(true) public String testNeedLogin() { return "needlogin"; } @GetMapping("/noneedlogin") @NeedLogin(false) public String testNoNeedLogin() { return "noneedlogin"; } }

3：启动应用&测试

运行启动类启动应用，发送请求http://localhost:8080/hello:

发送请求http://localhost:8080/needlogin:

发送请求http://localhost:8080/noneedlogin:

4：原理解析

上述自定义拦截器的核心逻辑是preHanble方法：

• 首先判断拦截的是否是方法，如果不是直接跳过
• 然后判断拦截到的方法如果没有NeedLogin注解或者注解属性值为不需要登录，不拦截
• 如果方法有NeedLogin注解并且属性为需要登录就返回需要登录

总结

spring拦截器其实是框架透出给我开发者一个扩展插件，对于框架的通用能力不能满足特殊业务场景的特殊需求的时候，开发者可以扩展拦截器做一些定制化的能力扩展，比如有些小的应用不想引入权限框架，可以基于自定义拦截器和注解实现简单的权限管理，

或者使用拦截器对业务中一些比较关键的通用日志打印，以及web层的通用异常拦截处理等等，都可以通过自定义拦截器实现。