SpringBoot如何根據(jù)目錄結(jié)構(gòu)生成API接口前綴

更新時(shí)間：2022年02月18日 10:17:32 作者：Y7000也拯救不了我

這篇文章主要介紹了SpringBoot如何根據(jù)目錄結(jié)構(gòu)生成API接口前綴，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

一、根據(jù)目錄結(jié)構(gòu)生成接口前綴

在寫(xiě)api的接口時(shí)，通常有很多版本的迭代，比如：v1、v2。

如圖所示，建立的包結(jié)構(gòu)。

列舉v1版本，每新建一個(gè)controller都要寫(xiě)上@RequestMapping("/v1/****")的路由的前綴，如果v1下面還有幾個(gè)包結(jié)構(gòu)，這樣路由就要寫(xiě)的很麻煩。

我們可以通過(guò)當(dāng)前api下的目錄結(jié)構(gòu)自動(dòng)加上請(qǐng)求前綴。

二、自定義RequestMappingInfo

在Spring里有一個(gè)專(zhuān)門(mén)處理?yè)碛蠤RequestMapping()注解的控制器的類(lèi)(RequestMappingHandlerMapping)，因?yàn)槲覀円薷目刂破鞯穆酚伞?/p>

寫(xiě)一個(gè)類(lèi)繼承RequestMappingHandlerMapping，重寫(xiě)類(lèi)的getMappingForMethod方法。這個(gè)方法就是定義和生成路由。
調(diào)用基類(lèi)的getMappingForMethod方法就能拿到RequestMappingInfo 的路由信息，先接受信息，修改完了，再返回。
這里要進(jìn)行路由前綴的修改，封裝一個(gè)方法getPrefix()，而handlerType這個(gè)參數(shù)就是獲取控制器的信息。
獲取控制器的目錄結(jié)構(gòu)，進(jìn)行替換，保留api目錄之后的路徑。
這里的apiPackagePath，就是com.api。指定api是所有api的根目錄。
獲取到的請(qǐng)求路徑是.，替換為/。
得到了prefix前綴，修改MappingInfo。通過(guò)RequestMappingInfo的靜態(tài)方法合并url。

public class AutoPrefixUrlMapping extends RequestMappingHandlerMapping {
    @Value("${api-package}")
    private String apiPackagePath;
    @Override
    protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType) {
        RequestMappingInfo mappingForMethod = super.getMappingForMethod(method, handlerType);
        String prefix = getPrefix(handlerType);
        if (mappingForMethod!=null){
           return RequestMappingInfo.paths(prefix).build().combine(mappingForMethod);
        }
        return mappingForMethod;
    }
    private String getPrefix(Class<?> handlerType){
        String packageName = handlerType.getPackage().getName();
        String doPath = packageName.replaceAll(this.apiPackagePath, "");
        return doPath.replace('.', '/');
    }
}

配置類(lèi)的方法將AutoPrefixUrlMapping類(lèi)注入ioc容器中。
新建一個(gè)配置類(lèi)繼承WebMvcRegistrations接口。實(shí)現(xiàn)getRequestMappingHandlerMapping方法，直接實(shí)例化AutoPrefixUrlMapping。
將配置類(lèi)加入容器中@Component

@Component
public class AutoPrefixConfiguration implements WebMvcRegistrations {
    @Override
    public RequestMappingHandlerMapping getRequestMappingHandlerMapping() {
        return new AutoPrefixUrlMapping();
    }
}

三、測(cè)試

在v1包下新建一個(gè)controller

@RestController()
@RequestMapping("/banner")
public class BannerController {
    @GetMapping("/test")
    public String test() {
        return "你好 hello";
    }
}

啟動(dòng)主程序，測(cè)試接口http://localhost:8080/v1/banner/test,

自動(dòng)合并了路由,v1是自動(dòng)拼接的。