在某些情況下,服務的controller中前綴是一致的,例如所有URL的前綴都為/context-path/api/v1,需要為某些URL添加統一的前綴。
能想到的處理辦法為修改服務的context-path,在context-path中加入api/v1,這樣修改全域的前綴能夠解決上面的問題,但存在弊端,如果URL存在多個前綴,例如有些URL需要前綴為api/v2,就無法區分了,如果服務中的一些靜態資源不想添加api/v1,也無法區分。
下面透過自訂註解的方式實現某些URL前綴的統一添加。
如果需要多種前綴,新增多組配置,例如新增:api.prefix.v2=/api/v2
url前綴配置
@Data @Component @ConfigurationProperties(prefix = "api.prefix") public class ApiPrefix { private String v1; }
@RestController一致,對應api.prefix.v1的配置,如果有多組配置,定義多個註解即可
@RestController @Documented @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface ApiV1RestController { }###四、自訂PathMatch新增前綴######新增一個設定類別繼承WebMvcConfigurer,重寫configurePathMatch方法,為類別上有ApiV1RestController註解的controller中的介面加入對應的前綴。 ###
@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)); } }###五、測試######需要在對應的controller上使用@ApiV1RestController註解來取代@RestController註解###
@ApiV1RestController @RequestMapping("/test/apiv1") public class TestApiV1RestController { @GetMapping() public ResponseEntity get() { return new ResponseEntity(); } }##########
以上是SpringBoot多controller如何加入URL前綴的詳細內容。更多資訊請關注PHP中文網其他相關文章!