拦截器（使用注解) 基于牛客网项目 ---笔记

利用拦截器，实现只处理带有自定义注解的方法，防止用户在未登录情况下通过 url 访问没有权限的页面。

创建 @LoginRequired 自定义注解，作用范围在方法上，有效期为运行时。

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

}

在 UserController 中：需要在登录状态下调用的方法，如访问设置页面、修改密码、上传头像等加上自定义注解。

@LoginRequired
@RequestMapping(path = "/setting", method = RequestMethod.GET)
public String getSettingPages(){
    return "/site/setting";
}

@RequestMapping(path = "/upload", method = RequestMethod.POST)
@LoginRequired
public String uploadHeader(MultipartFile headerImage, Model model){
    if(headerImage == null){
        model.addAttribute("error","您还没有选择文件！");
        return "/site/setting";
    }
    //获取文件名   及文件格式后缀
    String filename = headerImage.getOriginalFilename();
    String suffix = filename.substring(filename.lastIndexOf("."));
    if(StringUtils.isBlank(suffix)){
        model.addAttribute("error","文件格式错误！");
        return "/site/setting";
    }
    //生成随机文件名（防止多个用户上传的文件名一样）
    filename = CommunityUtil.generateUUID() + "." + suffix;
    //确定文件存储的路径
    File dest = new File(uploadPath + "/" + filename);
    //向该文件写入
    try {
        headerImage.transferTo(dest);
    } catch (IOException e) {
        logger.error("上传文件失败："+e.getMessage());
        throw new RuntimeException("上传文件失败，服务器发生异常",e);
    }
    //更新当前用户头像的路径（web访问路径）
    //localhost:8080/community/user/header/xxx.png
    User user = hostHolder.getUser();
    String headerUrl = domain + contextPath + "/user/header/" + filename;
    userService.updateHeader(user.getId() ,headerUrl);
    return "redirect:/index";
}

 

创建 LoginRequiredInterceptor 拦截器，在 preHandle 方法中判断方法是否加了 @LoginRequired 注解，如果加了注解并且此时从 hostHolder 中获取不到用户则拒绝访问。

@Component
public class LoginRequiredInterceptor implements HandlerInterceptor {
    @Autowired
    private HostHolder hostHolder;
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //判断要拦截Object的是否是方法 是方法就处理
        if(handler instanceof HandlerMethod){
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            Method method = handlerMethod.getMethod();
            LoginRequired loginRequired = method.getAnnotation(LoginRequired.class);//获取指定类型的注解
            if(loginRequired != null && hostHolder.getUser()==null){
                response.sendRedirect(request.getContextPath() + "/login");
                return false;
            }
        }
        return true;
    }
}

在 WebMvcConfig 配置类配置 LoginRequiredInterceptor，拦截除了静态资源之外的所有路径。

@Autowired
private LoginRequiredInterceptor loginRequiredInterceptor;

public void addInterceptors(InterceptorRegistry registry) {

registry.addInterceptor(loginRequiredInterceptor)
                .excludePathPatterns("/**/*.css","/**/*.js","/**/*.png","/**/*.jpg","/**/*.jpeg");
    }
}

一些说明：

private HostHolder hostHolder;
具体代码：

package com.nowcoder.community.util;

import com.nowcoder.community.entity.User;
import org.springframework.stereotype.Component;

/**
 * 持有用户的信息，用于代替session对象
 */
@Component
public class HostHolder {

    private ThreadLocal<User>  users = new ThreadLocal<>();

    public void setUsers(User user) {
        users.set(user);
    }
    public User getUser(){
        return users.get();
    }
    public void clear(){
        users.remove();
    }
}