从 JDK 5开始,Java 增加了注解的新功能,注解其实是代码里面的特殊标记,这些标记可以在编译、类加载和运行时被读取,在不改变代码原有逻辑下,给源文件嵌入注解信息。再通过返回获取注解信息,根据不同的注解信息处理不同逻辑。其中 Java 有以下几个元Annotation:
@Retention修饰 Annotation 可以保留多长时间,只包含一个 RetentionPolicy 一个成员变量。
@Target 修饰一个 Annotation 定义,它表示 Annotation 可以修饰在哪些地方:
以电商系统举例,请求后端接口分成两类:需要登录后才能访问和不需要登录访问,所以就需要根据不同的需求做不同的处理,不需要登录的访问的接口不用做处理,而需要登录的接口需要在每次请求时验证请求,而在 Spring 可以使用拦截器作一个登录信息验证,而是否需要登录验证,这就需要用到注解了。
首先创建一个注解 @Logined,它要实现的功能:在需要登录才能访问的接口上添加该注解,可以添加在类和方法上,如果添加在类上,类下面所以的请求方法都需要进行登录验证。添加到方法上,只针对该方法需要验证。@Logined 注解定义如下:
@Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Logined { /** * 是否需要已经登录才允许访问 * * @return */ boolean isLogined() default true; }
其中 @Target 设置 ElementType.METHOD 和 ElementType.TYPE 表示注解可以修饰在类和方法上,@Retention 设置 RetentionPolicy.RUNTIME 需要在运行时,JVM 可以获取到注解信息。isLogined 是注解的一个成员变量,这个在后面会讲到。
首先定义一个 Controller 控制器:
@RestController @Logined public class TestController { @GetMapping("/login") public String login() { return "need login"; } }
每次发送一个 http 请求后,都会进入到拦截器中。
public class MyInterceptor extends HandlerInterceptorAdapter{ @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { if (!(handler instanceof HandlerMethod)) { return true; } HandlerMethod handlerMethod = (HandlerMethod) handler; Method method = handlerMethod.getMethod(); boolean isLogin = this.isLogin(method); if (!isLogin){ return true; } // 这里对登录信息验证,比如token验证,cookie验证 return true; } private boolean isLogin(Method method) { //获取方法头部值 Logined classLogined = method.getDeclaringClass().getAnnotation(Logined.class); Logined methodLogined = method.getAnnotation(Logined.class); // 如果方法上有注解返回 isLogined if (classLogined != null && methodLogined == null) { System.out.println(classLogined.isLogined()); return classLogined.isLogined(); } // 方法没有注解,再找类上注解 if ((classLogined != null && methodLogined != null) || (classLogined == null && methodLogined != null)) { return methodLogined.isLogined(); } return false; } }
拦截器流程:
经过上述判断,如果返回是false,就不进行后续登录信息验证,否则需要登录信息验证。登录信息验证可以 token 验证、cookie验证。