拿到所有controller_SpringBoot如何获取当前项目全部Controller接口的两种方式

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

方案一

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

关于Aware接口的详细描述：SpringBoot中的Aware接口

 

c10c0ac82cb75db9fd349570f62d557a.png

 

de07e970951b72d2aa1a4f1cf188793a.png

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

CommandLineRunner：通过实现这个接口，重写run方法，可以在启动类完成后执行要做的事情，如果多个方法都继承了CommandLineRunner接口，多个run方法都要执行，同时要有先后顺序，加@Order(value = ）配权重就可以了。
 
  1. @Component
  2. @Order(value = 2)
  3. public class A implements CommandLineRunner{
  4. @Override
  5. public void run(String... strings) throws Exception {
  6.  
  7. }
  8. }
  9.  
  10. @Component
  11. @Order(value = 1)
  12. public class B implements CommandLineRunner {
  13. @Override
  14. public void run(String... strings) throws Exception {
  15.  
  16. }
  17. }
 

这样，B一定会启动成功后先于A先执行。
扯远了，说回来，为方便直接写：

 

f51c10d695709bdfacdfabbfd29c34a8.png
 
  1. @Override
  2. public void run(String... args) throws Exception {
  3. //获取使用RestController注解标注的的所有controller类
  4. Map<String, Object> controllers = applicationContext.getBeansWithAnnotation(RestController.class);
  5. //遍历每个controller层
  6. for (Map.Entry<String, Object> entry : controllers.entrySet()) {
  7. Object value = entry.getValue();
  8. System.out.println("拿到controller："+entry.getKey()+"，拿到value："+value);
  9. Class<?> aClass = AopUtils.getTargetClass(value);
  10. System.out.println("拿到Class:"+aClass);
  11. }
  12. }
 

启动，直接看输出结果：

 

1470a11c09c2c4f7754360064429421c.png


可以看到找到了GoodController 和AnalysisController，但是却没有找到我特意举例的一个Good2Controller

 

18fa2ed7282c7c51641d3a073e5e2a5b.png

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

 

cdaaa4cbaf103e9167775c2548cc65e1.png

 

bc193d073746aa11bfc6db790acfa0d5.png

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

 

3ab5a4615566881d54e3d5650a5b12c8.png


运行结果：

 

35e1f3c891b9145b60ebc4886e767f1d.png


成功打印出来～

（4）如果我们不想发现全部的方法，而是有选择性的发现Get,Post,Put之类的方法，也很简单

 
  1. // 首先拿到所有的方法
  2. List<Method> declaredMethods = Arrays.asList(aClass.getDeclaredMethods());
  3. for (int i = 0; i < declaredMethods.size() ; i++) {
  4. // 下面开始根据注解类型进行输出统计
  5. GetMapping getMapping = declaredMethods.get(i).getAnnotation(GetMapping.class);
  6. PostMapping postMapping = declaredMethods.get(i).getDeclaredAnnotation(PostMapping.class);
  7. System.out.println("Get相关的："+JSON.toJSONString(getMapping));
  8. System.out.println("Post相关的："+JSON.toJSONString(postMapping));
  9. }
 

成功～！

 

010bcdcadfcc0a42b2f4d5b8f7e567c1.png

（5）总体代码提供，要做统计或者其他一些什么接口的话，就自己用Map,SET 实现一下：

 
  1. public class EarlyWarningApplication implements ApplicationContextAware ,CommandLineRunner {
  2.  
  3. // 定义一个私有的方便本class中调用
  4. private ApplicationContext applicationContext;
  5.  
  6. // 通过重写ApplicationContextAware感知接口，将ApplicationContext赋值给当前的私有context容器
  7. @Override
  8. public void setApplicationContext(ApplicationContext arg0) {
  9. this.applicationContext = arg0;
  10. }
  11.  
  12. public static void main(String[] args) {
  13. SpringApplication application = new SpringApplication(EarlyWarningApplication.class);
  14. application.run(args);
  15. }
  16.  
  17.  
  18. @Override
  19. public void run(String... args) throws Exception {
  20.  
  21. Map<String, Object> controllers = applicationContext.getBeansWithAnnotation(RestController.class);
  22.  
  23. for (Map.Entry<String, Object> entry : controllers.entrySet()) {
  24. Object value = entry.getValue();
  25. System.out.println("拿到controller："+entry.getKey()+"，拿到value："+value);
  26. Class<?> aClass = AopUtils.getTargetClass(value);
  27. System.out.println("拿到Class:"+aClass);
  28. RequestMapping annotation = aClass.getAnnotation(RequestMapping.class);
  29. RequestMapping declaredAnnotation = aClass.getDeclaredAnnotation(RequestMapping.class);
  30.  
  31. List<Method> methods = Arrays.asList(aClass.getMethods());
  32. System.out.println("Public Methods:" + methods);
  33. List<Method> declaredMethods = Arrays.asList(aClass.getDeclaredMethods());
  34. for (int i = 0; i < declaredMethods.size() ; i++) {
  35. GetMapping getMapping = declaredMethods.get(i).getAnnotation(GetMapping.class);
  36. PostMapping postMapping = declaredMethods.get(i).getDeclaredAnnotation(PostMapping.class);
  37. System.out.println("Get相关的："+JSON.toJSONString(getMapping));
  38. System.out.println("Post相关的："+JSON.toJSONString(postMapping));
  39. }
  40. }
  41. }
  42. }
 

方案二

（1）隆重介绍WebApplicationContext 全局接口，属于ApplicationContext的一个儿子，它的作用很多，但是今天！在这里！它只用来获取每个Controller里面的全部public接口～

 

5e8d861c0d5c889193431989ed50fb75.png

（2）直接上代码，直接写在某个Service或者Controller都行，写在哪都行：

 
  1. @Autowired
  2. WebApplicationContext applicationContext;
  3.  
  4. @GetMapping("/getParam")
  5. public String getParam(){
  6.  
  7. RequestMappingHandlerMapping mapping = applicationContext.getBean(RequestMappingHandlerMapping.class);
  8. // 拿到Handler适配器中的全部方法
  9. Map<RequestMappingInfo, HandlerMethod> methodMap = mapping.getHandlerMethods();
  10. List<String> urlList = new ArrayList<>();
  11. for (RequestMappingInfo info : methodMap.keySet()){
  12.  
  13. Set<String> urlSet = info.getPatternsCondition().getPatterns();
  14. // 获取全部请求方式
  15. Set<RequestMethod> Methods = info.getMethodsCondition().getMethods();
  16. System.out.println(Methods.toString());
  17. for (String url : urlSet){
  18. // 加上自己的域名和端口号，就可以直接调用
  19. urlList.add("http://localhost:XXXX"+url);
  20. }
  21. }
  22. return urlList.toString();
  23. }
 

看下结果：

 

59881979b5a5a14a48ee079566b5d322.png

 

47365c1d123b95d0924ce246711150b6.png

成功～

作者：凉拌海蜇丝

链接：https://blog.csdn.net/whiteBearClimb/article/details/109311769

posted @ 2024-02-21 11:48  CharyGao  阅读(1309)  评论(0)    收藏  举报