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

业务场景本身想，只分享技术实现。下面的演示因为我为了方便，直接在公司项目中写的，因此一些敏感信息专有名词我要注释，望谅解。

首先咱们都知道，Spring的IOC机制，全部的接口和service都存在一个map容器，经过BeanFactory和ApplicationContext能够拿。那么咱们能够从这个开刀.java

方案一

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

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

app

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

CommandLineRunner：经过实现这个接口，重写run方法，能够在启动类完成后执行要作的事情，若是多个方法都继承了CommandLineRunner接口，多个run方法都要执行，同时要有前后顺序，加@Order(value = ）配权重就能够了。ide

@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先执行。
扯远了，说回来，为方便直接写：

post

@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);
            }
            }

启动，直接看输出结果：

能够看到找到了GoodController 和AnalysisController，可是却没有找到我特地举例的一个Good2Controller

this

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

（3）咱们已经成功拿到了所有controller，可是咱们都知道接口指的是controller下面的一个个public方法，因而继续往下找。在上面的代码继续加入这一行。

运行结果：

成功打印出来～

url

（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));
            }

成功～！

（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接口～

（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();
    }