SpringBoot項目啟動過程動態(tài)修改接口請求路徑的解決方案
背景
最近遇到一個技術(shù)需求,需要對其他多個已有的服務(wù)進行整合打包為一個整體的服務(wù),項目啟動過程發(fā)現(xiàn)一個問題,在controller層多個服務(wù)之間存在相同的RequestMapping接口請求路徑,導(dǎo)致服務(wù)無法啟動。
目前的接口定義規(guī)范為:/服務(wù)名(context-path)/接口版本號/模塊名/接口名
例如通過用戶Id查詢用戶信息的接口,在統(tǒng)一認證服務(wù)和用戶管理服務(wù)有如下接口定義
統(tǒng)一認證服務(wù):/sso/v1.0/user/get/{id}
用戶管理服務(wù):/user/v1.0/user/get/{id}
當我們把統(tǒng)一認證服務(wù)和用戶管理服務(wù)進行整合為一個服務(wù)時,/v1.0/user/get/{id}請求路徑發(fā)生重復(fù),導(dǎo)致服務(wù)無法啟動。
解決方案
為了解決服務(wù)之間接口定義沖突的問題,我們準備對接口的請求路徑進行動態(tài)修改,主要是通過controller類所在的包路徑進行服務(wù)名的識別,并加入到接口請求路徑的最前面。
舉個栗子:
統(tǒng)一認證服務(wù)controller層偽代碼如下:
package cn.codest.sso.web;
@RestController
@Api(tags = "統(tǒng)一認證服務(wù)")
@RequestMapping("/v1.0/user")
@RequiredArgsConstructor
public class SSOController {
private final UserService userService;
@GetMapping("/get/{id}")
@ApiOperation(value = "用戶查詢", httpMethod = "GET", notes = "用戶查詢")
public SwaggerResultUtil getById(String id){
return SwaggerResultUtil.resultSuccess(userService.get(id));
}
}通過重載RequestMappingHandlerMapping類的getMappingForMethod方法,實現(xiàn)在項目啟動過程中注冊/v1.0/user/get/{id}接口時,識別package的路徑cn.codest.sso.web提取業(yè)務(wù)標識sso,修改接口注冊地址為/sso/v1.0/user/get/{id},具體代碼如下:
@Slf4j
@Configuration
@Order(Ordered.HIGHEST_PRECEDENCE)
public class PackagePathRequestMappingHandler extends RequestMappingHandlerMapping {
private static final String PACKAGE_PREFIX = "cn.codest";
private static final String SERVICE_PREFIX = "service";
private static final String PROVIDER_PREFIX = "providerD";
/**
* 包名對應(yīng)的服務(wù)名緩存類
*/
private final LinkedHashMap<String, String> services = new LinkedHashMap<>(8);
@Override
protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType) {
// 判斷當前注冊的controller接口屬于業(yè)務(wù)層controller,部分中間件例如swagger也會進行接口注冊
if (!StringUtils.startsWith(handlerType.getName(), PACKAGE_PREFIX)
|| !AnnotatedElementUtils.hasAnnotation(method, RequestMapping.class)
|| AnnotatedElementUtils.hasAnnotation(handlerType, FeignClient.class)) {
return super.getMappingForMethod(method, handlerType);
}
try {
// 構(gòu)造RequestMapping對象
RequestMappingInfo mapping = super.getMappingForMethod(method, handlerType);
// 根據(jù)包路徑獲取服務(wù)名
String serviceName = getServiceName(handlerType.getName());
if (StringUtils.isBlank(serviceName)) {
return mapping;
}
// 增加服務(wù)名前綴
return RequestMappingInfo.paths(serviceName).build().combine(mapping);
} catch (Exception e) {
log.error("重寫RequestMapping請求路徑時發(fā)生錯誤[class: {}, method: {}]", handlerType.getName(), method.getName(), e);
throw e;
}
}
protected String getServiceName(String className) {
// 分割類限定名
String[] packages = className.split("\\.");
// 判斷包路徑長度
if (packages.length > 3) {
// 獲取子產(chǎn)品包名
String serviceName = packages[2];
// 讀取緩存
if (services.containsKey(serviceName)) {
return services.get(serviceName);
} else if (StringUtils.startsWith(serviceName, SERVICE_PREFIX)) { // service服務(wù)
services.put(serviceName, serviceName.replace(SERVICE_PREFIX, StringUtils.EMPTY));
} else if (StringUtils.startsWith(serviceName, PROVIDER_PREFIX.toLowerCase())) { // provider服務(wù)
services.put(serviceName, serviceName.replace(PROVIDER_PREFIX.toLowerCase(), PROVIDER_PREFIX));
}
return services.get(serviceName);
}
return StringUtils.EMPTY;
}
}注冊自定義RequestMappingHandler,項目使用的SpringBoot版本為2.0.x,不同版本注冊方式不同,可以自行查閱官方文檔。
public class CustomWebMvcConfig implements WebMvcRegistrations {
@Override
public RequestMappingHandlerMapping getRequestMappingHandlerMapping() {
RequestMappingHandlerMapping handlerMapping = new PackagePathRequestMappingHandler();
handlerMapping.setOrder(Ordered.HIGHEST_PRECEDENCE);
return handlerMapping;
}
}到此這篇關(guān)于SpringBoot項目啟動過程動態(tài)修改接口請求路徑的文章就介紹到這了,更多相關(guān)SpringBoot動態(tài)修改接口請求路徑內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java數(shù)據(jù)結(jié)構(gòu)之HashMap和HashSet
這篇文章主要介紹了HashMap和HashSet,什么是哈希表以及HashMap的部分源碼解讀,想了解更多的小伙伴,可以參考閱讀本文2023-03-03
Spring內(nèi)部bean和級聯(lián)屬性用法詳解
這篇文章主要介紹了Java內(nèi)部bean和級聯(lián)屬性用法詳解,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-10-10

