SpringBoot如何获取当前项目全部Controller接口的两种方式

Easter79
• 阅读 521
业务场景自己想,只分享技术实现。下面的演示由于我为了方便,直接在公司项目中写的,所以一些敏感信息专有名词我要注释,望谅解。

首先我们都知道,Spring的IOC机制,所有的接口和service都存在一个map容器,通过BeanFactory和ApplicationContext可以拿。那么我们可以从这个开刀.

方案一

(1)想想有什么方法或者接口是能够获取到ApplicationContext的,答案当然是有,Aware接口嘛,找到一个ApplicationContextAware,理论上就能获取到ApplicationContext容器本身。

关于Aware接口的详细描述:SpringBoot中的Aware接口
SpringBoot如何获取当前项目全部Controller接口的两种方式
SpringBoot如何获取当前项目全部Controller接口的两种方式

(2)ApplicationContext拿到了,剩下的其实就是从里面拿到接口而已,这里贪图方便,就直接重写启动之后的run方法里面做了。

CommandLineRunner:通过实现这个接口,重写run方法,可以在启动类完成后执行要做的事情,如果多个方法都继承了CommandLineRunner接口,多个run方法都要执行,同时要有先后顺序,加@Order(value = )配权重就可以了。

@Component
@Order(value = 2)
public class A implements CommandLineRunner{
   
   
@Override
public void run(String... strings) throws Exception {
   
   
   
    }
}

@Component
@Order(value = 1)
public class B implements CommandLineRunner {
   
   
@Override
public void run(String... strings) throws Exception {
   
   
   
    }
}

这样,B一定会启动成功后先于A先执行。
扯远了,说回来,为方便直接写:
SpringBoot如何获取当前项目全部Controller接口的两种方式

@Override
    public void run(String... args) throws Exception {
   
   
        //获取使用RestController注解标注的的所有controller类
        Map<String, Object> controllers = applicationContext.getBeansWithAnnotation(RestController.class);
        //遍历每个controller层
        for (Map.Entry<String, Object> entry : controllers.entrySet()) {
   
   
            Object value = entry.getValue();
            System.out.println("拿到controller:"+entry.getKey()+",拿到value:"+value);
            Class<?> aClass = AopUtils.getTargetClass(value);
            System.out.println("拿到Class:"+aClass);
            }
            }
启动,直接看输出结果:

SpringBoot如何获取当前项目全部Controller接口的两种方式
可以看到找到了GoodController 和AnalysisController,但是却没有找到我特意举例的一个Good2Controller
SpringBoot如何获取当前项目全部Controller接口的两种方式

原因就是Good2我没有使用RestController注解,而是使用了 @Controller + @ResponseBody,这是个小坑,不要以为RestController复合注解里面包含了@Controller 就会理所当然被发现,结果是并不会。因为这里是根据接口类型找的,它不关心你接口里面包着什么,只要不是RestController.class,统一发现不了。

SpringBoot如何获取当前项目全部Controller接口的两种方式
SpringBoot如何获取当前项目全部Controller接口的两种方式

(3)我们已经成功拿到了全部controller,但是我们都知道接口指的是controller下面的一个个public方法,于是继续往下找。在上面的代码继续加入这一行。

SpringBoot如何获取当前项目全部Controller接口的两种方式
运行结果:
SpringBoot如何获取当前项目全部Controller接口的两种方式
成功打印出来~

(4)如果我们不想发现全部的方法,而是有选择性的发现Get,Post,Put之类的方法,也很简单
    // 首先拿到所有的方法
    List<Method> declaredMethods = Arrays.asList(aClass.getDeclaredMethods());
            for (int i = 0; i < declaredMethods.size() ; i++) {
   
   
                // 下面开始根据注解类型进行输出统计
                GetMapping getMapping = declaredMethods.get(i).getAnnotation(GetMapping.class);
                PostMapping postMapping = declaredMethods.get(i).getDeclaredAnnotation(PostMapping.class);
                System.out.println("Get相关的:"+JSON.toJSONString(getMapping));
                System.out.println("Post相关的:"+JSON.toJSONString(postMapping));
            }
成功~!

SpringBoot如何获取当前项目全部Controller接口的两种方式

(5)总体代码提供,要做统计或者其他一些什么接口的话,就自己用Map,SET 实现一下:
public class EarlyWarningApplication implements ApplicationContextAware ,CommandLineRunner {
   
   

    // 定义一个私有的方便本class中调用
    private ApplicationContext applicationContext;

    // 通过重写ApplicationContextAware感知接口,将ApplicationContext赋值给当前的私有context容器
    @Override
    public void setApplicationContext(ApplicationContext arg0) {
   
   
        this.applicationContext = arg0;
    }

    public static void main(String[] args) {
   
   
        SpringApplication application = new SpringApplication(EarlyWarningApplication.class);
        application.run(args);
    }


    @Override
    public void run(String... args) throws Exception {
   
   
        
        Map<String, Object> controllers = applicationContext.getBeansWithAnnotation(RestController.class);
       
        for (Map.Entry<String, Object> entry : controllers.entrySet()) {
   
   
            Object value = entry.getValue();
            System.out.println("拿到controller:"+entry.getKey()+",拿到value:"+value);
            Class<?> aClass = AopUtils.getTargetClass(value);
            System.out.println("拿到Class:"+aClass);
            RequestMapping annotation = aClass.getAnnotation(RequestMapping.class);
            RequestMapping declaredAnnotation = aClass.getDeclaredAnnotation(RequestMapping.class);
           
            List<Method> methods = Arrays.asList(aClass.getMethods());
            System.out.println("Public Methods:" + methods);
            List<Method> declaredMethods = Arrays.asList(aClass.getDeclaredMethods());
            for (int i = 0; i < declaredMethods.size() ; i++) {
   
   
                GetMapping getMapping = declaredMethods.get(i).getAnnotation(GetMapping.class);
                PostMapping postMapping = declaredMethods.get(i).getDeclaredAnnotation(PostMapping.class);
                System.out.println("Get相关的:"+JSON.toJSONString(getMapping));
                System.out.println("Post相关的:"+JSON.toJSONString(postMapping));
            }
        }
    }
}

方案二

(1)隆重介绍WebApplicationContext 全局接口,属于ApplicationContext的一个儿子,它的作用很多,但是今天!在这里!它只用来获取每个Controller里面的全部public接口~

SpringBoot如何获取当前项目全部Controller接口的两种方式

(2)直接上代码,直接写在某个Service或者Controller都行,写在哪都行:
 @Autowired
    WebApplicationContext applicationContext;

    @GetMapping("/getParam")
    public String getParam(){
   
   

        RequestMappingHandlerMapping mapping = applicationContext.getBean(RequestMappingHandlerMapping.class);
        // 拿到Handler适配器中的全部方法
        Map<RequestMappingInfo, HandlerMethod> methodMap = mapping.getHandlerMethods();
        List<String> urlList = new ArrayList<>();
        for (RequestMappingInfo info : methodMap.keySet()){
   
   
           
            Set<String> urlSet = info.getPatternsCondition().getPatterns();
            // 获取全部请求方式
            Set<RequestMethod> Methods = info.getMethodsCondition().getMethods();
            System.out.println(Methods.toString());
            for (String url : urlSet){
   
   
                // 加上自己的域名和端口号,就可以直接调用
                urlList.add("http://localhost:XXXX"+url);
            }
        }
        return urlList.toString();
    }
看下结果:

SpringBoot如何获取当前项目全部Controller接口的两种方式

SpringBoot如何获取当前项目全部Controller接口的两种方式

成功~
点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
待兔 待兔
3个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
Jacquelyn38 Jacquelyn38
3年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
Easter79 Easter79
3年前
SpringBoot自定义序列化的使用方式
场景及需求:项目接入了SpringBoot开发,现在需求是服务端接口返回的字段如果为空,那么自动转为空字符串。例如:\    {        "id":1,        "name":null    },    {        "id":2,        "name":"x
Easter79 Easter79
3年前
Twitter的分布式自增ID算法snowflake (Java版)
概述分布式系统中,有一些需要使用全局唯一ID的场景,这种时候为了防止ID冲突可以使用36位的UUID,但是UUID有一些缺点,首先他相对比较长,另外UUID一般是无序的。有些时候我们希望能使用一种简单一些的ID,并且希望ID能够按照时间有序生成。而twitter的snowflake解决了这种需求,最初Twitter把存储系统从MySQL迁移
Wesley13 Wesley13
3年前
mysql设置时区
mysql设置时区mysql\_query("SETtime\_zone'8:00'")ordie('时区设置失败,请联系管理员!');中国在东8区所以加8方法二:selectcount(user\_id)asdevice,CONVERT\_TZ(FROM\_UNIXTIME(reg\_time),'08:00','0
Stella981 Stella981
3年前
SpringBoot如何获取当前项目全部Controller接口的两种方式
业务场景自己想,只分享技术实现。下面的演示由于我为了方便,直接在公司项目中写的,所以一些敏感信息专有名词我要注释,望谅解。首先我们都知道,Spring的IOC机制,所有的接口和service都存在一个map容器,通过BeanFactory和ApplicationContext可以拿。那么我们可以从这个开刀.方案一
Wesley13 Wesley13
3年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
Python进阶者 Python进阶者
9个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这
Easter79
Easter79
Lv1
今生可爱与温柔,每一样都不能少。
文章
2.8k
粉丝
5
获赞
1.2k