SpringBoot Controller 自定义注解

博主： zmx
发布时间：2024 年 01 月 03 日
195 次浏览
暂无评论
4288字数
分类： Java

# 引言

想点做点的，一直也没完善，今天加了点东西，比如说`/User/AddUser`为新增用户，我想把所有的控制器集中起来，做权限管理，下面的demo是把所有的控制器写入到数据库。当然，如果想扩展，通过反射，也是可以很轻松的实现的。

# 代码

## 注解的定义

```java
package top.zunmx.csm.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE_USE, ElementType.METHOD})
public @interface Permission {
    String comment() default "";
}
```

## 启动触发器

```java
package top.zunmx.csm.annotation;

import jakarta.servlet.ServletContext;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.context.ServletContextAware;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
import top.zunmx.csm.services.PermissionService;
import top.zunmx.csm.utils.algorithm.MD5Utils;

import java.util.Map;
import java.util.logging.Logger;

@Component
public class AnnotationHandler implements ServletContextAware {
    @Autowired
    private RequestMappingHandlerMapping handlerMapping;
    @Autowired
    private PermissionService permissionService;
    private final Logger logger = Logger.getLogger("PermissionAnnotationHandler");

public void permissionRegister() {
        Map<RequestMappingInfo, HandlerMethod> handlerMethods = handlerMapping.getHandlerMethods();
        for (Map.Entry<RequestMappingInfo, HandlerMethod> entry : handlerMethods.entrySet()) {
            Permission annotation = AnnotationUtils.findAnnotation(entry.getValue().getMethod(), Permission.class);
            if (null != annotation) {
                String parent = "undefined";
                Permission parentAnnotation = AnnotationUtils.findAnnotation(entry.getValue().getBeanType(), Permission.class);
                if (parentAnnotation != null) {
                    parent = parentAnnotation.comment();
                }
                String methods = ((RequestMethod) entry.getKey().getMethodsCondition().getMethods().toArray()[0]).name();
                String route = (String) entry.getKey().getPatternValues().toArray()[0];
                String comment = annotation.comment();
                top.zunmx.csm.pojo.Permission permission = new top.zunmx.csm.pojo.Permission();
                permission.setMid(MD5Utils.encode(methods + ":" + route));
                permission.setUrl(route);
                permission.setParent(parent);
                permission.setMethod(methods);
                permission.setFunc_comment(comment);
                permissionService.AddPermission(permission);
//                System.out.println(methods + "::" + route + "::" + comment);
            }
        }
    }

@Override
    public void setServletContext(ServletContext servletContext) {
        permissionRegister();
    }
}
```

## 控制器

```
@Permission(comment = "用户相关")
@RequestMapping("/user")
@RestController
public class UserController {
    @Permission(comment = "获取当前用户名")
    @GetMapping("whoami")
    public ResponseBodyVO whoami() {
        return ResponseBodyVO.success(EnumResponseType.SUCCESS_OK.getCode(), EnumResponseType.SUCCESS_OK.getDesc(), SecurityContextHolder.getContext().getAuthentication().getName());
    }

@Permission(comment = "获取当前用户所有权限")
    @GetMapping("getPermissions")
    public ResponseBodyVO getPermission() {
        return ResponseBodyVO.success(EnumResponseType.SUCCESS_OK.getCode(), EnumResponseType.SUCCESS_OK.getDesc(), SecurityContextHolder.getContext().getAuthentication().getName());
    }
}
```

![image.png](https://www.zunmx.top/usr/uploads/2024/01/4088277300.png)

# 结语

其它工具类我就不往里面写了，总结一下。

`implements ServletContextAware` 为了确保Servlet注册完成

`Map<RequestMappingInfo, HandlerMethod> handlerMethods = handlerMapping.getHandlerMethods();` 获取注册的控制器

`for (Map.Entry<RequestMappingInfo, HandlerMethod> entry : handlerMethods.entrySet())` 遍历那些方法

`AnnotationUtils.findAnnotation(entry.getValue().getMethod(), Permission.class)` 判断是否存在这个注解

以上

如果觉得我的文章对你有用，请随意赞赏

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款了昂。

评论 *

私密评论

名称 *

🎲

邮箱 *

地址

zunmx.fans
我 www.hao123.com实名申请友链OωO
zunmx.fans
作者小小骗人，我登陆了也看不到( ง ᵒ̌皿ᵒ̌)ง⁼³₌₃
zunmx.fans
please many update 算法 (´இ皿இ｀)boke
zunmx.fans
df1/df2 df1+df2 转置，累加----*。。。...
zunmx.fans
为何无人评论？OωO

SpringBoot Controller 自定义注解

zmx • 2024 年 01 月 03 日

# 引言

# 代码

## 注解的定义

```java
package top.zunmx.csm.annotation;

## 启动触发器

```java
package top.zunmx.csm.annotation;

import java.util.Map;
import java.util.logging.Logger;

@Override
    public void setServletContext(ServletContext servletContext) {
        permissionRegister();
    }
}
```

## 控制器

![image.png](https://www.zunmx.top/usr/uploads/2024/01/4088277300.png)

# 结语

其它工具类我就不往里面写了，总结一下。

`implements ServletContextAware` 为了确保Servlet注册完成

`Map<RequestMappingInfo, HandlerMethod> handlerMethods = handlerMapping.getHandlerMethods();` 获取注册的控制器

`for (Map.Entry<RequestMappingInfo, HandlerMethod> entry : handlerMethods.entrySet())` 遍历那些方法

`AnnotationUtils.findAnnotation(entry.getValue().getMethod(), Permission.class)` 判断是否存在这个注解

以上

SpringBoot Controller 自定义注解

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款了昂。

Typecho 插件开发 ZSecurity

个人空间使用规则[拟定] 23/3/9修订

企业微信-摸鱼必备，避免离开状态

基于Lively wallpaper的壁纸

中公教育CTS视频下载

安装原生的FastDFS

此内容被密码保护

chrome浏览器直接修改网页

python 导出html以及pdf

ssh无法连接到另一台服务器的ssh

SpringBoot Controller 自定义注解

发表评论 取消回复 使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款了昂。

SpringBoot Controller 自定义注解

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款了昂。