Springboot項目如何獲取所有的接口
更新時間：2021年09月11日 10:29:39 作者：小石潭記丶
這篇文章主要介紹了Springboot項目如何獲取所有的接口，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
Springboot項目獲取所有接口
@Autowired
private WebApplicationContext applicationContext;
@Override
public List getAllUrl() {
RequestMappingHandlerMapping mapping = applicationContext.getBean(RequestMappingHandlerMapping.class);
// 獲取url與類和方法的對應信息
Map<RequestMappingInfo, HandlerMethod> map = mapping.getHandlerMethods();
List<Map<String, String>> list = new ArrayList<Map<String, String>>();
for (Map.Entry<RequestMappingInfo, HandlerMethod> m : map.entrySet()) {
Map<String, String> map1 = new HashMap<String, String>();
RequestMappingInfo info = m.getKey();
HandlerMethod method = m.getValue();
//獲取當前方法所在類名
Class<?> bean = method.getBeanType();
//使用反射獲取當前類注解內容
Api api = bean.getAnnotation(Api.class);
RequestMapping requestMapping = bean.getAnnotation(RequestMapping.class);
String[] value = requestMapping.value();
map1.put("parent",value[0])
//獲取方法上注解以及注解值
ApiOperation methodAnnotation = method.getMethodAnnotation(ApiOperation.class);
String privilegeName = methodAnnotation.notes();
PatternsRequestCondition p = info.getPatternsCondition();
for (String url : p.getPatterns()) {
map1.put("url", url);
}
map1.put("className", method.getMethod().getDeclaringClass().getName()); // 類名
map1.put("method", method.getMethod().getName()); // 方法名
RequestMethodsRequestCondition methodsCondition = info.getMethodsCondition();
for (RequestMethod requestMethod : methodsCondition.getMethods()) {
map1.put("type", requestMethod.toString());
}
list.add(map1);
}
return list;
}
獲取項目下所有http接口的信息
一、接口信息類
新建一個類用于存放http接口的相關信息
class RequestToMethodItem {
public String controllerName;
public String methodName;
public String requestType;
public String requestUrl;
public Class<?>[] methodParmaTypes;
public String getControllerName() {
return controllerName;
}
public void setControllerName(String controllerName) {
this.controllerName = controllerName;
}
public String getMethodName() {
return methodName;
}
public void setMethodName(String methodName) {
this.methodName = methodName;
}
public String getRequestType() {
return requestType;
}
public void setRequestType(String requestType) {
this.requestType = requestType;
}
public String getRequestUrl() {
return requestUrl;
}
public void setRequestUrl(String requestUrl) {
this.requestUrl = requestUrl;
}
public Class<?>[] getMethodParmaTypes() {
return methodParmaTypes;
}
public void setMethodParmaTypes(Class<?>[] methodParmaTypes) {
this.methodParmaTypes = methodParmaTypes;
}
public RequestToMethodItem(String requestUrl, String requestType, String controllerName, String requestMethodName, Class<?>[] methodParmaTypes){
this.requestUrl = requestUrl;
this.requestType = requestType;
this.controllerName = controllerName;
this.methodName = requestMethodName;
this.methodParmaTypes = methodParmaTypes;
}
}
二、單元測試
寫兩個http接口用于測試
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class TestController {
@GetMapping(value = "/test1")
@ResponseBody
public void test1(Integer a) {
}
@PostMapping(value = "/test2")
@ResponseBody
public void test2(Integer a,Integer b) {
}
}
測試單元
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
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 cn.hutool.json.JSONUtil; //hutool是一個很方便的工具包
@SpringBootTest
@RunWith(SpringRunner.class)
public class Test {
@Autowired
WebApplicationContext applicationContext;
@org.junit.Test
public void index() {
List<RequestToMethodItem> requestToMethodItemList = new ArrayList<RequestToMethodItem>();
RequestMappingHandlerMapping requestMappingHandlerMapping = applicationContext.getBean(RequestMappingHandlerMapping.class);
Map<RequestMappingInfo, HandlerMethod> handlerMethods = requestMappingHandlerMapping.getHandlerMethods();
for (Map.Entry<RequestMappingInfo, HandlerMethod> requestMappingInfoHandlerMethodEntry : handlerMethods
.entrySet()) {
RequestMappingInfo requestMappingInfo = requestMappingInfoHandlerMethodEntry.getKey();
RequestMethodsRequestCondition methodCondition = requestMappingInfo.getMethodsCondition();
PatternsRequestCondition patternsCondition = requestMappingInfo.getPatternsCondition();
HandlerMethod mappingInfoValue = requestMappingInfoHandlerMethodEntry.getValue();
// 請求類型
String requestType = methodCondition.getMethods().toString();
// 請求路徑
String requestUrl = patternsCondition.getPatterns().iterator().next();
// 控制器名稱
String controllerName = mappingInfoValue.getBeanType().toString();
// 請求方法名
String requestMethodName = mappingInfoValue.getMethod().getName();
// 請求參數(shù)
Class<?>[] methodParamTypes = mappingInfoValue.getMethod().getParameterTypes();
// Spring通過BasicErrorController進行統(tǒng)一的異常處理,不計入這些API
if("class org.springframework.boot.autoconfigure.web.servlet.error.BasicErrorController".equals(controllerName)) {
continue;
}
RequestToMethodItem item = new RequestToMethodItem(requestUrl, requestType, controllerName,
requestMethodName, methodParamTypes);
requestToMethodItemList.add(item);
}
System.out.println(JSONUtil.toJsonStr(requestToMethodItemList));
}
}
測試結果
以上為個人經驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關文章
這篇文章主要介紹了Java中的Field類和Method類,是Java入門學習中的基礎知識,需要的朋友可以參考下2015-12-12
本篇文章主要介紹了詳解Java無需解壓直接讀取Zip文件和文件內容，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-10-10
這篇文章主要介紹了Java實現(xiàn)求小于n的質數(shù)的3種方法,本文給出了根據(jù)定義去求解、平方根、找規(guī)律三種解法,需要的朋友可以參考下2015-03-03
在本篇文章里小編給大家整理的是一篇關于java集合進行排序的兩種方式總結，有興趣的朋友們可以學習參考下。2021-08-08
java之CSV大批量數(shù)據(jù)入庫的實現(xiàn)
本文主要介紹了java之CSV大批量數(shù)據(jù)入庫的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2023-02-02
Parquet 是一個強大的列式存儲格式,適用于大數(shù)據(jù)場景,能夠高效地進行數(shù)據(jù)壓縮、查詢和存儲,在 Java 中使用 Apache Spark 讀取和寫入 Parquet 文件是一項常見的任務,本文給大家介紹了在 Java 中使用 Spark 來讀取和寫入 Parquet 文件的基本步驟,需要的朋友可以參考下2025-03-03
這篇文章主要介紹了SpringBoot Test及注解的使用，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-07-07
所有與該configuration 對象關聯(lián)的模版實例都就可以通過獲得to_upper 轉換器，company 來獲得字符串，因此你不需要再一次次的往root 中添加這些變量了。如果你往root 添加同名的變量，那么你新添加的變量將會覆蓋之前的共享變量。2016-04-04
Sentinel 是一個高可用、高擴展、高穩(wěn)定性的開源流量控制和熔斷降級框架，可以在分布式系統(tǒng)中實現(xiàn)實時的流量控制,下面就來和大家聊聊是具體如何操作的吧2023-05-05
Spring源碼之事件監(jiān)聽機制詳解(@EventListener實現(xiàn)方式)
這篇文章主要介紹了Spring源碼之事件監(jiān)聽機制(@EventListener實現(xiàn)方式),具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-08-08