SpringBoot多controller如何添加URL前綴

這篇“SpringBoot多controller如何添加URL前綴”文章的知識點(diǎn)大部分人都不太理解，所以小編給大家總結(jié)了以下內(nèi)容，內(nèi)容詳細(xì)，步驟清晰，具有一定的借鑒價值，希望大家閱讀完這篇文章能有所收獲，下面我們一起來看看這篇“SpringBoot多controller如何添加URL前綴”文章吧。

前言

在某些情況下，服務(wù)的controller中前綴是一致的，例如所有URL的前綴都為/context-path/api/v1，需要為某些URL添加統(tǒng)一的前綴。

能想到的處理辦法為修改服務(wù)的context-path，在context-path中添加api/v1，這樣修改全局的前綴能夠解決上面的問題，但存在弊端，如果URL存在多個前綴，例如有些URL需要前綴為api/v2，就無法區(qū)分了，如果服務(wù)中的一些靜態(tài)資源不想添加api/v1，也無法區(qū)分。

下面通過自定義注解的方式實(shí)現(xiàn)某些URL前綴的統(tǒng)一添加。

一、配置文件內(nèi)添加前綴配置

如果需要多種前綴，添加多組配置，例如添加：api.prefix.v2=/api/v2

###############url前綴配置##################
api.prefix.v1=/api/v1

二、配置映射的實(shí)體

@Data
@Component
@ConfigurationProperties(prefix = "api.prefix")
public class ApiPrefix {
    private String v1;
}

三、自定義注解

此注解功能與@RestController一致，對應(yīng)api.prefix.v1的配置，如果有多組配置，定義多個注解即可

@RestController
@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiV1RestController {
}

四、自定義PathMatch添加前綴

添加一個配置類繼承WebMvcConfigurer，重寫configurePathMatch方法，為類上有ApiV1RestController注解的controller中的接口添加對應(yīng)的前綴。

@AutoConfiguration
public class WebMvcConfig implements WebMvcConfigurer {
    @Autowired
    private ApiPrefix apiPrefix;
    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        configurer.addPathPrefix(apiPrefix.getV1(), c -> c.isAnnotationPresent(ApiV1RestController.class));
    }
}

五、測試

需要在對應(yīng)的controller上使用@ApiV1RestController注解代替@RestController注解

@ApiV1RestController
@RequestMapping("/test/apiv1")
public class TestApiV1RestController {
    @GetMapping()
    public ResponseEntity get() {
        return new ResponseEntity();
    }
}

以上就是關(guān)于“SpringBoot多controller如何添加URL前綴”這篇文章的內(nèi)容，相信大家都有了一定的了解，希望小編分享的內(nèi)容對大家有幫助，若想了解更多相關(guān)的知識內(nèi)容，請關(guān)注億速云行業(yè)資訊頻道。