这篇文章是我们企业开发实战篇应用spring拦截器的第二篇文章,第一篇《解决跨域问题》,该篇文章我们主要讲解下如何使用拦截器+自定义注解来实现登录鉴权校验的功能,关于拦截器和自定义注解的基础语法下面也会稍带讲解,但不是本文重点,所以讲解的可能不会很细O(∩_∩)O。
需求描述
我们需要一个Java注解,使用这个注解标记在Controller的类或某个方法上时,就代表着该类下所有方法或某个注解标记的方法需要登录后才可以进行访问。
实现思路
首先我们需要一个注解,名字定义为@LoginedAuth,然后需要使用拦截器,名字就定为LoginedAuthInterceptor,在调用controller方法前该拦截器根据调用类的基本信息判定是否标记了登录鉴权注解,如果在所在方法或该方法所在类上有标记,则进行登录鉴权逻辑。
那么用户的登录身份信息放在哪里呢?我们约定用户的身份信息通过http请求头参数方式传递,其参数字段名字为X-Token,当然在你的系统中也可以设计为放入cookie+header两种并行的方式。
代码实现
登录鉴权注解
package com.zhuma.demo.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @desc 已登录权限验证注解
*
* @author zhumaer
* @since 10/17/2017 3:13 PM
*/
@Target({
ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LoginedAuth {
}
说明
注解类上有三个注解
- @Target 用它来指明自定义注解的使用范围,ElementType.TYPE代表可以将该注解使用在类、接口或枚举上,ElementType.METHOD 代表可以应用在类的方法上。
- @Retention 用它来指明该注解在.java变.class文件过程中会被保留到那个阶段。RetentionPolicy.RUNTIME 这种类型的注解将被JVM保留,所以他们能在运行时被JVM或其他使用反射机制的代码所读取和使用。
- @Documented 注解表明这个注解应该被 javadoc工具记录。
更详细的说明可参考这里
拦截器类
package com.zhuma.demo.interceptors;
import java.lang.reflect.Method;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import com.zhuma.demo.annotations.LoginedAuth;
import com.zhuma.demo.enums.ResultCode;
import c