获取所有Controller接口信息并导出

一路向北929

已于 2024-01-10 10:21:06 修改

阅读量1.7k

点赞数 10

分类专栏： java 文章标签： spring mvc

于 2024-01-09 16:39:26 首次发布

本文链接：https://blog.youkuaiyun.com/yanxuhly/article/details/135483217

版权

项目中有个需求需要获取项目特定controller的所有方法信息（包括请求路径、方法名、注释、出入参等），代码如下：

package com.it.controller;

import cn.hutool.core.collection.CollUtil;
import com.alibaba.fastjson.JSON;
import com.it.businesscenter.controller.vo.RequestMethodBo;
import com.it.businesscenter.util.ExcelUtil;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.mvc.condition.PatternsRequestCondition;
import org.springframework.web.servlet.mvc.condition.RequestMethodsRequestCondition;
import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;

import javax.annotation.Resource;
import javax.servlet.http.HttpServletResponse;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;

/**
 * 测试
 *
 * @date 2024/1/5 11:14
 **/
@RestController
@RequestMapping("/test")
public class TestController {

    @Resource
    private WebApplicationContext applicationContext;

    @GetMapping("getAllUrl")
    public void getAllUrl(HttpServletResponse response) {
        RequestMappingHandlerMapping mapping = applicationContext.getBean(RequestMappingHandlerMapping.class);
        Map<RequestMappingInfo, HandlerMethod> handlerMethods = mapping.getHandlerMethods();

        List<RequestMethodBo> list = new ArrayList<>();
        for (Map.Entry<RequestMappingInfo, HandlerMethod> item : handlerMethods.entrySet()) {
            //请求信息对象
            RequestMappingInfo key = item.getKey();
            //控制器信息缓存
            HandlerMethod value = item.getValue();

            //controller扫描范围（注意默认的控制器名称首字母小写）,没有元素则扫描所有controller
            String[] conArr = new String[]{"userController","orgController"};
            List<String> controllerList = Arrays.asList(conArr);

            if(CollUtil.isEmpty(controllerList) || controllerList.contains(value.getBean().toString())){
                System.out.println("method："+ JS