快捷導(dǎo)航

SpringBoot根據(jù)目錄結(jié)構(gòu)自動(dòng)配置Url前綴方式

更新時(shí)間：2021年11月19日 14:50:56 作者：三毛村滴雪魚粉

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

在很多其他框架中，比如Python的Flask、node.js的KOA，Controller要想能夠響應(yīng)前端的請(qǐng)求都需要我們主動(dòng)去注冊(cè)到應(yīng)用程序上。而Spring不需要我們自己去注冊(cè)，由Spring通過掃描注解的方式去主動(dòng)發(fā)現(xiàn)。

自定義RequestMappingInfo

Spring中的RequestMappingHandlerMapping專門來負(fù)責(zé)處理標(biāo)注了@RequestMapping的控制器。創(chuàng)建一個(gè)類繼承并覆蓋其中的方法，從而實(shí)現(xiàn)對(duì)默認(rèn)機(jī)制的修改。

覆蓋其中的getMappingForMethod方法，這個(gè)方法的返回值RequestMappingInfo就包含了請(qǐng)求的Url，修改RequestMappingInfo中的Url從而修改路由中的Url。

package com.lin.missyou.hack;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
import java.lang.reflect.Method;
public class AutoPrefixUrlMapping extends RequestMappingHandlerMapping {
    @Value("${missyou.api-package}")
    private String apiPackagePath ;		//從配置文件中獲取根包的路徑
    @Override
    protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType) {
        RequestMappingInfo requestMappingInfo = super.getMappingForMethod(method, handlerType);
        if(null != requestMappingInfo){
        	//獲取url前綴
            String prefix = getPrefix(handlerType);		
            //根據(jù)url前綴生成RequestMappingInfo并與原有的RequestMappingInfo合并
            RequestMappingInfo mappingInfo = RequestMappingInfo.paths(prefix).build().combine(requestMappingInfo);		
            return mappingInfo;
        }
        return requestMappingInfo;
    }
    private String getPrefix(Class<?> handlerType){
        String packageName = handlerType.getPackage().getName();	//獲取控制器所在包路徑
        String dotPath = packageName.replaceAll(this.apiPackagePath,"");	//將包路徑中多于的部分截取掉
        return dotPath.replace(".","/");		//將包路徑中的.替換成/
    }
}

通過接口的形式發(fā)現(xiàn)類

創(chuàng)建一個(gè)配置類AutoPrefixConfiguration將AutoPrefixUrlMapping加入到容器。配置類AutoPrefixConfiguration實(shí)現(xiàn)接口WebMvcRegistrations并覆蓋其中的getRequestMappingHandlerMapping方法

package com.lin.missyou.core.config;
import com.lin.missyou.hack.AutoPrefixUrlMapping;
import org.springframework.boot.autoconfigure.web.servlet.WebMvcRegistrations;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
@Component
public class AutoPrefixConfiguration implements WebMvcRegistrations {
    @Override
    public RequestMappingHandlerMapping getRequestMappingHandlerMapping() {
        return new AutoPrefixUrlMapping();
    }
}

在配置文件中指定根包

missyou.api-package = com.lin.missyou.api

SprinBoot的發(fā)現(xiàn)機(jī)制有兩種。一種是在控制器上標(biāo)注特定注解，例如上一篇文章SpringBoot全局異常處理中在GlobalExceptionAdvice 上標(biāo)注@ControllerAdvice。另外一種是實(shí)現(xiàn)特定接口并覆蓋其中的特定方法，例如上面的AutoPrefixConfiguration。

測(cè)試一下

在這里插入圖片描述