SpringBoot項(xiàng)目啟動(dòng)過程動(dòng)態(tài)修改接口請求路徑的解決方案

更新時(shí)間：2024年10月10日 09:19:16 作者：codest

在SpringBoot服務(wù)整合過程中,遇到了多個(gè)服務(wù)中相同RequestMapping路徑導(dǎo)致的啟動(dòng)問題,解決方案是通過修改RequestMappingHandlerMapping類的getMappingForMethod方法,本文給大家介紹SpringBoot修改接口請求路徑的解決方案,感興趣的朋友一起看看吧

背景

最近遇到一個(gè)技術(shù)需求，需要對(duì)其他多個(gè)已有的服務(wù)進(jìn)行整合打包為一個(gè)整體的服務(wù)，項(xiàng)目啟動(dòng)過程發(fā)現(xiàn)一個(gè)問題，在controller層多個(gè)服務(wù)之間存在相同的RequestMapping接口請求路徑，導(dǎo)致服務(wù)無法啟動(dòng)。

目前的接口定義規(guī)范為：/服務(wù)名(context-path)/接口版本號(hào)/模塊名/接口名

例如通過用戶Id查詢用戶信息的接口，在統(tǒng)一認(rèn)證服務(wù)和用戶管理服務(wù)有如下接口定義

統(tǒng)一認(rèn)證服務(wù)：/sso/v1.0/user/get/{id}

用戶管理服務(wù)：/user/v1.0/user/get/{id}

當(dāng)我們把統(tǒng)一認(rèn)證服務(wù)和用戶管理服務(wù)進(jìn)行整合為一個(gè)服務(wù)時(shí)，/v1.0/user/get/{id}請求路徑發(fā)生重復(fù)，導(dǎo)致服務(wù)無法啟動(dòng)。

解決方案

為了解決服務(wù)之間接口定義沖突的問題，我們準(zhǔn)備對(duì)接口的請求路徑進(jìn)行動(dòng)態(tài)修改，主要是通過controller類所在的包路徑進(jìn)行服務(wù)名的識(shí)別，并加入到接口請求路徑的最前面。

舉個(gè)栗子：

統(tǒng)一認(rèn)證服務(wù)controller層偽代碼如下：

package cn.codest.sso.web;
@RestController
@Api(tags = "統(tǒng)一認(rèn)證服務(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方法，實(shí)現(xiàn)在項(xiàng)目啟動(dòng)過程中注冊/v1.0/user/get/{id}接口時(shí)，識(shí)別package的路徑cn.codest.sso.web提取業(yè)務(wù)標(biāo)識(shí)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";
    /**
     * 包名對(duì)應(yīng)的服務(wù)名緩存類
     */
    private final LinkedHashMap<String, String> services = new LinkedHashMap<>(8);
    @Override
    protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType) {
        // 判斷當(dāng)前注冊的controller接口屬于業(yè)務(wù)層controller，部分中間件例如swagger也會(huì)進(jìn)行接口注冊
        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對(duì)象
            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請求路徑時(shí)發(fā)生錯(cuò)誤[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，項(xiàng)目使用的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項(xiàng)目啟動(dòng)過程動(dòng)態(tài)修改接口請求路徑的文章就介紹到這了,更多相關(guān)SpringBoot動(dòng)態(tài)修改接口請求路徑內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: