java 自定义注解 权限拦截

1.首先创建一个注解RequiresPermissions

package com.sky.annotation;


import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/*
 *
 * 自定义注解 控制权限
 * 定义了一个名为 RequiresPermissions 的注解，它可以用于方法或类上。这个注解具有一个属性 value，用于指定需要进行权限验证的权限列表。这个属性是一个字符串数组，可以包含多个权限。
 * */
@Target(ElementType.METHOD)  //指定注解只能加在方法上面
@Retention(RetentionPolicy.RUNTIME)  //注解在运行时仍然可用
public @interface RequiresPermissions {
    // String[] value();
    String value(); //获取字符串就可以了
}

2.然后创建权限注解拦截器 模拟数据库权限表数据 后续会查询数据库或者放入缓存里面
PermissionInterceptor

package com.sky.interceptor;


import com.sky.annotation.RequiresPermissions;
import com.sky.context.BaseContext;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;

/**
* 创建了一个名为 PermissionInterceptor 的拦截器。在 preHandle 方法中，我们首先判断当前请求是否需要权限验证。
* 如果需要验证，我们从请求对象中获取 HandlerMethod 对象，然后获取注解 @RequiresPermissions 并读取其中的权限列表。
* 接下来，你需要根据具体的权限验证逻辑来验证当前用户是否具有这些权限。如果用户没有权限，你可以抛出一个异常或重定向到错误页面。
* 如果用户有权限，你可以继续处理请求，并返回 true；否则，中断请求，并返回 false。
*  拦截器配置完之后需要WebMvcConfiguration注册才生效
* */

@Component
@Slf4j
public class PermissionInterceptor implements HandlerInterceptor {


    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        if (handler instanceof HandlerMethod) {
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            Method method = handlerMethod.getMethod();
            RequiresPermissions annotation = method.getAnnotation(RequiresPermissions.class);

            if (annotation != null) {
                String permissions = annotation.value();  //是一个字符串
                log.info("获取权限的值：{}",permissions);  //取数组的值
                // 在这里验证用户权限，如果用户没有权限，抛出异常或重定向到错误页面。
                //获取当前用户  根据用户查询菜单栏的权限 可以把权限存入缓存或者直接查询数据库都可以
                Long currentId= BaseContext.getCurrentId();//当前用户登录的id 线程里面取的局部变量

                System.out.println(currentId);
                List<String> list = new ArrayList<String>();
                list.add("postUpdateRule,POST");
                list.add("postCreateRule,POST");
                log.info("获取权限集合：{}",list);
                if (list.contains(permissions)) {
                    //3、通过，放行
                    return true;
                } else {
                    //4、不通过，响应401状态码
                    return   MessageUtil.returnErrorMessage(response,"你没有权限访问该接口");
                }
                // ... 省略验证权限的代码 ...
            }
        }
        return true; // 如果验证通过，继续处理请求，返回true；否则，中断请求，返回false。
    }
}

3.去WebMvcConfiguration注册 addInterceptors里面注册

package com.sky.config;

import com.sky.interceptor.JwtTokenAdminInterceptor;
import com.sky.interceptor.JwtTokenUserInterceptor;
import com.sky.interceptor.PermissionInterceptor;
import com.sky.json.JacksonObjectMapper;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

import java.util.List;

/**
 * 配置类，注册web层相关组件
 */
@Configuration
@Slf4j
public class WebMvcConfiguration extends WebMvcConfigurationSupport {

    @Autowired
    private JwtTokenAdminInterceptor jwtTokenAdminInterceptor;

    @Autowired
    private JwtTokenUserInterceptor jwtTokenUserInterceptor;

    @Autowired
    private PermissionInterceptor permissionInterceptor;

    /**
     * 注册自定义拦截器
     *
     * @param registry
     */
    protected void addInterceptors(InterceptorRegistry registry) {
        log.info("开始注册自定义拦截器...");
        registry.addInterceptor(jwtTokenAdminInterceptor)
                .addPathPatterns("/admin/**")
                .excludePathPatterns("/admin/employee/login");
        /*注册
        * 可以注册多个
        * */
        registry.addInterceptor(jwtTokenUserInterceptor)
                .addPathPatterns("/user/**")
                .excludePathPatterns("/user/user/login")
                .excludePathPatterns("/user/shop/status");
        /*
          增删改查权限拦截  不能全部拦截 否则会拦截静态资源的访问
        * */
        registry.addInterceptor(permissionInterceptor)
                .addPathPatterns("/admin/**")
                .excludePathPatterns("/admin/employee/login");
    }

    /**
     * 通过knife4j生成接口文档
     * @return
     */
    @Bean
    public Docket docket1() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("苍穹外卖项目接口文档")
                .version("2.0")
                .description("苍穹外卖项目接口文档")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .groupName("管理端接口")
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.sky.controller.admin"))  //指定生成接口需要扫描的包
                .paths(PathSelectors.any())
                .build();
        return docket;
    }


    /**
     * 通过knife4j生成接口文档
     * @return
     */
    @Bean
    public Docket docket2() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("苍穹外卖项目接口文档")
                .version("2.0")
                .description("苍穹外卖项目接口文档")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .groupName("用户端接口")
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.sky.controller.user"))  //指定生成接口需要扫描的包
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

    /**
     * 设置静态资源映射
     * @param registry
     */
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
         /*
            配置server虚拟路径，handler为前台访问的URL目录，locations为files相对应的本地路径
            也就是说如果有一个 upload/avatar/aaa.png 请求，那程序会到后面的目录里面找aaa.png文件
            另外：如果项目中有使用Shiro，则还需要在Shiro里面配置过滤下
         */
        String projectDir = System.getProperty("user.dir"); //获取当前项目的根目录
        registry.addResourceHandler("/public/uploads/**").addResourceLocations("file:"+projectDir+"/public/uploads/");
    }

    /**
    * 统一处理响应的时间格式
    *扩展spring mvc框架的消息转化器
    * */
    @Override
    protected void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
        log.info("开始扩展消息转换器...");
        //创建一个消息转换器对象
        MappingJackson2HttpMessageConverter converter=new MappingJackson2HttpMessageConverter();
        //需要为消息转换器设置一个对象转换器，对象转换器可以将java对象序列化为json数据
        converter.setObjectMapper(new JacksonObjectMapper());

        //将我们自己的撞墙放入spring MVC框架的容器中  将自己的消息转换器加入容器中  排在第一位优先使用
        converters.add(0,converter);
    }
}

4.使用 @RequiresPermissions注解

package com.sky.controller.admin;

import com.sky.annotation.RequiresPermissions;
import com.sky.dto.SysMenuQueryDTO;
import com.sky.entity.SysMenu;
import com.sky.result.Result;
import com.sky.service.SysMenuService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/admin/system/menu")
@Api(tags = "菜单栏权限接口")
@Slf4j
public class SysMenuContrller {
    @Autowired
    private SysMenuService sysMenuService;
    /**
     * 查询系统菜单列表
     */
    @GetMapping("/list")
    @RequiresPermissions("postCreateRule,POST")
    @ApiOperation("查询菜单列表")
    public Result<List<SysMenu>> list(SysMenuQueryDTO sysMenuQueryDTO){
        List<SysMenu> sysMenuList=sysMenuService.selectMenuList(sysMenuQueryDTO);
       return Result.success(sysMenuList);
    }

    /**
     * 查询系统菜单树列表
     */
    @GetMapping("/treeselect")
    @ApiOperation("查询菜单树列表")
    public Result<List<SysMenu>> treeselect(){
        List<SysMenu> sysMenuList=sysMenuService.menuTreeData();
        return Result.success(sysMenuList);
    }
    /*
    * 新增保存菜单
    * */
    @PostMapping("/add")
    @ApiOperation("新增菜单")
    public Result addSave(@RequestBody SysMenu sysMenu){
             log.info("新增菜单：{}",sysMenu);
            //验证菜单名称是否重复
            sysMenuService.insertMenu(sysMenu);

            return Result.success();
    }
}