简单实现一个登录验证的注解来保护私有资源

背景

自定义注解标注受保护的资源访问,当要访问的url被标注了@LoginRequied的时候就变成了一个受保护的资源,需要用户登录或者更进一步需要用户拥有某个权限才能操作。本项目使用的springboot2.0
话不多说直接上代码。

实现过程

注解类:LoginRequired

//省略import
/**
* 拦截声明
*/

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface LoginRequired {

boolean value() default true;
}

现在有了我们想要使用的注解 下一步就是怎么去实现它,因为要对http请求进行拦截所以我们在这可以直接设置一个拦截器拦截所有的请求,当看到被拦截的请求有@LoginRequired注解的时候,我们再去判断是否符合条件。
下面我们来实现这个拦截器。

//省略import
/**
 * 自定义的一个登录拦截器
 */
public class LoginInterceptor extends HandlerInterceptorAdapter {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (handler instanceof HandlerMethod) {
            LoginRequired loginRequired = findAnnotation((HandlerMethod) handler, LoginRequired.class);
//没有声明需要权限,或者声明不验证权限
            if (loginRequired == null) {
                return true;
            } else {
                String token = request.getHeader(“token”);//得到token
                if (StringUtils.isEmpty(token)) {
                    token = request.getParameter(“token”);
                }
//在这里实现自己的权限验证逻辑
                if (!StringUtils.isEmpty(token)) {//如果验证成功返回true(这里直接写false来模拟验证失败的处理)
                    return true;
                } else {//如果验证失败

                    response.getWriter().write(new Result(HttpStatusConstant.REQUIRED_LOGIN).toJSONString());
                    return false;
                }
            }
        } else {
            return true;
        }
    }

    private T findAnnotation(HandlerMethod handler, Class annotationType) {
        T annotation = handler.getBeanType().getAnnotation(annotationType);
        if (annotation != null) return annotation;
        return handler.getMethodAnnotation(annotationType);
    }
}

preHandle函数表示在之前处理,用到这里就是在访问发生之前触发,我们利用反射找到LoginRequired 然后进行处理。这样所有准备工作就做完了。但是我们想要在spring中使用它还需要告诉spring我写了一个拦截器。

所以我们再新建一个InterceptorConfig类:

//ignore import
@Configuration
public class InterceptorConfig extends WebMvcConfigurerAdapter {
@Bean
public LoginInterceptor loginInterceptor(){
    return new LoginInterceptor();
}
/**
* 注册当前的interceptor
* @param registry
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(loginInterceptor());
}
}

大功告成。剩下的就是在你Controller中需要登录验证的请求的方法上面添加@LoginRequired注解了。

评论

暂无评论