springboot 实现拦截器

时间: 2023-10-21 12:29:00 浏览: 136

spring自定义注解实现拦截器的实现方法

在Spring框架中，自定义注解结合AOP（面向切面编程）是实现业务逻辑与非业务逻辑分离的一种有效方式。通过自定义注解，可以针对不同的业务场景灵活地添加功能，比如权限控制、日志记录、事务管理等。本文将详细讨论如何通过自定义注解实现Spring的拦截器功能。 ### 自定义注解自定义注解是通过Java注解来标记某个方法或者类是否需要拦截，以及如何拦截。在Spring MVC中，常见的注解如`@RequestMapping`就是Spring内置的注解，用于映射Web请求到对应的处理方法上。而我们这里要做的则是自定义注解，它不会直接参与请求的处理，但会在请求处理之前或之后提供扩展功能。在自定义注解部分，首先定义了一个名为`@LoginRequired`的注解。这个注解的作用是标记那些需要登录后才能访问的Controller方法。通过`@Target(ElementType.METHOD)`指定该注解可以用在方法上，`@Retention(RetentionPolicy.RUNTIME)`表示该注解在运行时仍然存在，可以通过反射来获取到。 ```java @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface LoginRequired {} ``` ### AOP和MethodInterceptor AOP是面向切面编程的英文缩写，它允许开发者将横切关注点（比如日志、事务管理等）与业务逻辑分离，从而减少代码重复，提高模块化。在AOP中，`MethodInterceptor`是一个拦截方法执行的接口，它在目标方法执行前后提供了一种动态拦截的方法。通过实现`MethodInterceptor`接口，可以在方法调用前后加入额外的逻辑处理，如权限验证、性能监控等。 `LoginRequiredInterceptor1`类就实现了`MethodInterceptor`接口，用于处理`@LoginRequired`注解标记的方法。在这个拦截器中，首先获取到方法的参数列表，检查是否包含`HttpServletRequest`对象。然后，检查目标方法是否有`@LoginRequired`注解，如果有，则执行登录验证逻辑。通过调用`mi.proceed()`方法来确保目标方法被正常调用。 ```java public class LoginRequiredInterceptor1 implements MethodInterceptor { @Override public Object invoke(MethodInvocation mi) throws Throwable { Object[] args = mi.getArguments(); for (Object arg : args) { if (arg instanceof HttpServletRequest) { System.out.println("------------this is a HttpServletRequest parameter------------"); } } if (mi.getMethod().isAnnotationPresent(LoginRequired.class)) { System.out.println("----------this method is added @LoginRequired-------------------------"); } return mi.proceed(); } } ``` ### 配置拦截器 Spring通过配置来完成拦截器的定义和切入点的指定。首先需要配置一个bean来定义拦截器实例，然后通过`<aop:config>`元素来定义切入点和拦截规则。这里的切入点是指定在哪个包下的哪些类中的哪些方法将会被拦截。在`<aop:config>`中，`<aop:pointcut>`元素定义了切入点表达式`execution(public* com.qunar.wireless.ugc.controller.web.*.*(..))`，它说明了拦截器将应用于`com.qunar.wireless.ugc.controller.web`包中所有的公有方法。`<aop:advisor>`元素则将切入点与拦截器关联起来，`advice-ref`属性指定了拦截器的bean id。 ```xml <bean id="springMethodInterceptor" class="com.qunar.wireless.ugc.interceptor.LoginRequiredInterceptor1"></bean> <aop:config>  <aop:pointcut id="loginPoint" expression="execution(public* com.qunar.wireless.ugc.controller.web.*.*(..))"/>  <aop:advisor pointcut-ref="loginPoint" advice-ref="springMethodInterceptor"/> </aop:config> ``` 总结起来，通过定义一个自定义注解来标记需要拦截的方法，并通过AOP配置来指定拦截器的执行时机和方法，可以灵活地在Spring MVC应用中添加各种前置处理逻辑，而不影响核心业务代码的清晰和专注。这种方式不仅可以用于权限校验，还可以用于其他的横切关注点，比如请求日志记录、性能统计等，是提升代码质量和维护性的有效手段。

Spring Boot实现拦截器的过程可以参考中提供的详细示例代码解析。在Spring Boot中，可以通过创建一个自定义的拦截器类来实现拦截功能。拦截器类需要实现Spring框架中的HandlerInterceptor接口，并重写其中的方法。首先，需要创建一个拦截器类，该类需要实现HandlerInterceptor接口，并重写其中的preHandle、postHandle和afterCompletion方法。preHandle方法在请求处理之前执行，可以用于进行权限验证、日志记录等操作；postHandle方法在请求处理之后执行，可以对响应结果进行处理；afterCompletion方法在视图渲染之后执行，可以进行一些资源的清理操作。接下来，需要在Spring Boot应用程序的配置类（通常是带有@SpringBootApplication注解的类）中注册拦截器。可以通过重写WebMvcConfigurer接口中的addInterceptors方法来实现。在该方法中，可以使用addInterceptor方法将自定义的拦截器类添加到拦截器链中，指定需要拦截的路径或排除的路径。通过以上步骤，就可以实现拦截器在Spring Boot应用中的使用了。拦截器会在请求到达控制器方法之前进行拦截，并执行拦截器类中定义的相关逻辑。需要注意的是，拦截器在Spring Boot中是针对Spring MVC的访问进行增强的，与Servlet技术中的过滤器（Filter）有所区别。拦截器通过动态拦截方法调用的机制来实现，而过滤器对所有访问进行增强。1234

阅读全文

springboot 实现拦截器

相关推荐

SpringBoot的拦截器

springboot拦截器

Springboot实现拦截器

springboot实现拦截器

springboot实现拦截器之验证登录示例

SpringBoot实现拦截器、过滤器、监听器过程解析

SpringBoot实现拦截器代码

springboot实现拦截器以及获取当前用户登录信息

springboot的拦截器如何实现

springboot全局拦截器

springboot编写拦截器

springboot自定义拦截器

springboot登录拦截器

springboot controller 拦截器

springboot 自定义拦截器

springboot使用拦截器

springboot的拦截器

springboot异常拦截器

springboot配置拦截器

最新推荐

springboot实现拦截器之验证登录示例

Springboot引入拦截器并放行swagger代码实例

SpringBoot拦截器实现对404和500等错误的拦截

详谈springboot过滤器和拦截器的实现及区别

Springboot过滤器禁止ip频繁访问功能实现

火炬连体网络在MNIST的2D嵌入实现示例

管理建模和仿真的文件

L2正则化的终极指南：从入门到精通，揭秘机器学习中的性能优化技巧

如何构建一个符合GB/T19716和ISO/IEC13335标准的信息安全事件管理框架，并确保业务连续性规划的有效性？

Angular插件增强Application Insights JavaScript SDK功能