SpringBoot 中对拦截器的简单使用

文章目录

明确需求第一步：实现一个注解实现接口实现一个拦截器注册拦截器测试

明确需求

我们的部分接口需要访问者具有相应的权限才能进行相应的访问，即需要有正确的通行密码才能放行。看到这个需求，相应大家脑海中瞬间浮现出一个词 – 拦截器，确实，我们可以使用拦截器来实现这个需求，下面就让我来带领大家一起完成这个任务吧！

第一步：实现一个注解

首先，我们先实现一个注解，这个注解可以被加在方法上面，其主要功能如下：对于加上了这个注解的接口，会对其进行权限校验，通过才能执行下面的逻辑，否则会直接抛出异常。

package edu.szu.demo.annotation; import java.lang.annotation.*; @Target(ElementType.METHOD) // 作用于方法上 @Retention(RetentionPolicy.RUNTIME) // 运行期保留 @Inherited @Documented public @interface Judge { public boolean need() default true; }

实现接口

我们的接口逻辑很简单，对于传入的字符串参数，稍作修改便直接返回。而我们的接口使用了之前定义的 @Judge 注解，意味着该接口需要进行校验。

package edu.szu.demo.controller; import edu.szu.demo.annotation.Judge; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class TestController { /** * 该方法对传入数据做一定的修改，然后将其返回 * @param judgePassword 通行密码，通过校验才放行 * @param name 传入的数据 * @return */ @Judge @RequestMapping("/test") public String test(String judgePassword, String name) { return name + " 已被修改"; } }

实现一个拦截器

实现拦截器比较简单，既可以实现接口 HandlerInterceptor ，也可以继承抽象类 HandlerInterceptorAdapter，在这一步博主选择了实现接口。

我们先来看看这个 HandlerInterceptor 接口是何方神圣。

public interface HandlerInterceptor { default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { return true; } default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception { } default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception { } } preHandle：在业务处理器处理请求之前被调用，可用于编码、安全控制、权限校验postHandle：在业务处理器处理请求执行完成后，生成视图之前执行afterCompletion：在 DispatcherServlet 完全处理完请求后被调用，可用于清理资源

明白了 HandlerInterceptor 的构造，我们便可以使用这个接口了。我们定义一个拦截器，该拦截器对于带有 Judge 注解的请求，会进行判断，若密码不为 happy，会直接抛出异常，其余情况均会放行。

package edu.szu.demo.interceptor; import edu.szu.demo.annotation.Judge; import org.springframework.web.method.HandlerMethod; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; public class TestInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { HandlerMethod handlerMethod = (HandlerMethod) handler; //获取注解 Judge judge = handlerMethod.getMethod().getAnnotation(Judge.class); if(judge != null && judge.need()) { String getJudgePassword = request.getParameter("judgePassword"); //这里直接写死，密码必须设置为 happy if(!getJudgePassword.equals("happy")) { throw new Exception(); } } return true; } @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 { } }

注册拦截器

然后把我们前面写好的拦截器注册一下

package edu.szu.demo.config; import edu.szu.demo.interceptor.TestInterceptor; 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 WebAppConfigurer implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { // 拦截所有请求地址 registry.addInterceptor(new TestInterceptor()).addPathPatterns("/**"); } }

这样子，我们的需求就已经实现了，接下来我们测试一下。

测试

在浏览器中我们输入以下 URL：

localhost:8080/test?judgePassword=happy&name=fdg

返回结果如下，可见对于添加了 @Judge 注解的接口，若 judgePassword 设置为 happy，拦截器会放行。

然后我们在浏览器输入以下 URL：

http://localhost:8080/test?judgePassword=not&name=fdg

返回结果如下，可见对于添加了 @Judge 注解的接口，若 judgePassword 设置不为 happy，拦截器会抛出异常。