spring boot 中获取所有 RequestMapping 的 URL 路径列表集

spring boot 项目在做 URL 权限控制的时候需要获得全部的 URL，一个一个去 controller 中找费时费力，有的权限点的命名和 URL 有一定的对应关系。如果能用程序获得全部 URL，将会省去很多事。在项目中添加如下 Controller，请求 /getAllUrl，即可看到项目所有的 URL。当然也可以根据项目将 URL 写入数据库或写入配置文件。

1. @Autowired
2. WebApplicationContext applicationContext;
3.  
4. @RequestMapping(value = "v1/getAllUrl", method = RequestMethod.POST)
5. public Object getAllUrl() {
6. RequestMappingHandlerMapping mapping = applicationContext.getBean(RequestMappingHandlerMapping.class);
7. // 获取url与类和方法的对应信息
8. Map<RequestMappingInfo, HandlerMethod> map = mapping.getHandlerMethods();
9.  
10. // List<String> urlList = new ArrayList<>();
11. // for (RequestMappingInfo info : map.keySet()) {
12. // // 获取url的Set集合，一个方法可能对应多个url
13. // Set<String> patterns = info.getPatternsCondition().getPatterns();
14. //
15. // for (String url : patterns) {
16. // urlList.add(url);
17. // }
18. // }
19.  
20. List<Map<String, String>> list = new ArrayList<Map<String, String>>();
21. for (Entry<RequestMappingInfo, HandlerMethod> m : map.entrySet()) {
22. Map<String, String> map1 = new HashMap<String, String>();
23. RequestMappingInfo info = m.getKey();
24. HandlerMethod method = m.getValue();
25. PatternsRequestCondition p = info.getPatternsCondition();
26. for (String url : p.getPatterns()) {
27. map1.put("url", url);
28. }
29. map1.put("className", method.getMethod().getDeclaringClass().getName()); // 类名
30. map1.put("method", method.getMethod().getName()); // 方法名
31. RequestMethodsRequestCondition methodsCondition = info.getMethodsCondition();
32. for (RequestMethod requestMethod : methodsCondition.getMethods()) {
33. map1.put("type", requestMethod.toString());
34. }
35.  
36. list.add(map1);
37. }
38.  
39. JSONArray jsonArray = JSONArray.fromObject(list);
40.  
41. return jsonArray;
42. }

参考 http://jayung.iteye.com/blog/2240864，
https://blog.csdn.net/Clark_Lu/article/details/78670411?locationNum=7&fps=1

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
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;

@Controller
public class MappingController {

    @Autowired
    private RequestMappingHandlerMapping requestMappingHandlerMapping;

    @RequestMapping(value = "/mappings")
    public String list(Model model) {
        List<HashMap<String, String>> urlList = new ArrayList<HashMap<String, String>>();

        Map<RequestMappingInfo, HandlerMethod> map = requestMappingHandlerMapping.getHandlerMethods();
        for (Map.Entry<RequestMappingInfo, HandlerMethod> m : map.entrySet()) {
            HashMap<String, String> hashMap = new HashMap<String, String>();
            RequestMappingInfo info = m.getKey();
            HandlerMethod method = m.getValue();
            PatternsRequestCondition p = info.getPatternsCondition();
            for (String url : p.getPatterns()) {
                hashMap.put("url", url);
            }
            hashMap.put("className", method.getMethod().getDeclaringClass().getName()); // 类名
            hashMap.put("method", method.getMethod().getName()); // 方法名
            RequestMethodsRequestCondition methodsCondition = info.getMethodsCondition();
            String type = methodsCondition.toString();
            if (type != null && type.startsWith("[") && type.endsWith("]")) {
                type = type.substring(1, type.length() - 1);
                hashMap.put("type", type); // 方法名
            }
            urlList.add(hashMap);
        }
        model.addAttribute("list", urlList);
        return "/console/system/mappingList";
    }

}

 然后再在页面上遍历 list 即可

<table class="tableList" >
<tr>
        <th> 类名 </th>
        <th> 方法名 </th>
        <th>URL</th>
        <th> 类型 </th>
<tr>
    <c:forEach items="${list}" var="mvc" varStatus="status">
    <tr id="${status.index}">
        <td>${mvc.className}</td>
        <td>${mvc.method}</td>
        <td>
            <c:choose>
            <c:when test="${!fn:contains(mvc.url,'}') and (mvc.type=='GET' or mvc.type=='')}">
                <a href="${ctx}${mvc.url}" target="_blank">${mvc.url}</a>
            </c:when>
            <c:otherwise>${mvc.url}</c:otherwise>
            </c:choose>
        </td>
        <td>${mvc.type}</td>
    </tr>
    </c:forEach>
</table>