快捷導(dǎo)航

SpringBoot實現(xiàn)接口統(tǒng)一前綴

更新時間：2023年07月25日 10:08:15 作者：catoop

本文主要介紹了SpringBoot實現(xiàn)接口統(tǒng)一前綴，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

需求

需求如題，想給一個 spring boot 項目的所有請求路徑添加統(tǒng)一前綴，可以通過 context-path 來配置。但是在同時存在靜態(tài)資源和 Controller 接口的項目中，如果希望靜態(tài)資源從根路徑訪問，并且所有接口擁有統(tǒng)一路徑前綴，則需要通過 Spring 層面來解決這個問題（context-path 是 web 容器層面的，如果配置它則會把靜態(tài)資源都包含進(jìn)去）。

如下接口示例：

# 3個靜態(tài)資源
http://localhost:8080/index.html
http://localhost:8080/home.js
http://localhost:8080/dog.png

# 3個統(tǒng)一前綴為 /api
http://localhost:8080/api/test/show
http://localhost:8080/api/test/display
http://localhost:8080/api/test/print

如上URL示例中，希望放在 springboot 根目錄 static 中的靜態(tài)資源能直接通過根路徑訪問。其他 Controller 接口的前綴 “/api” 可以在配置文件中自定義配置變更。

實現(xiàn)

實現(xiàn)方法很簡單，如下代碼和配置文件：

1、GlobalControllerPathPrefixConfiguration.java

package com.example.demospringbean;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.servlet.config.annotation.PathMatchConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
/**
?* 為 Controller 接口配置統(tǒng)一前綴
?*
?* @author shanhy
?* @date 2023-03-20 15:50
?*/
@Configuration
public class GlobalControllerPathPrefixConfiguration implements WebMvcConfigurer {
? ? @Value("${spring.controller.path-prefix:}")
? ? private String pathPrefix;
? ? @Override
? ? public void configurePathMatch(PathMatchConfigurer configurer) {
? ? ? ? configurer.addPathPrefix(pathPrefix, c -> c.isAnnotationPresent(RestController.class));
? ? }
}

2、application.properties

spring.controller.path-prefix=/api

配置文件中參數(shù) spring.controller.path-prefix 也可以是多級路徑，例如 /api/demo。

3、TestController.java

/**
 * 接口示例
 * 
 * @author shanhy
 * @date 2023-03-20 15:49
 */
@RestController
@RequestMapping("/test")
public class TestController {
    @GetMapping("/show")
    public String show(){
        return "OK";
    }
}

最后將 dog.png 放在 springboot 項目的 static 目錄中用來測試。