Spring Boot 多种方式更改上下文路径

news2025/1/16 16:39:26

1. spring boot上下文路径概述

默认情况下，Spring Boot 在根上下文路径（“/”）上提供内容。

尽管通常最好采用约定而不是配置，但有时我们确实希望拥有自定义路径。
在此快速教程中，我们将介绍配置它的不同方法。
在这里插入图片描述

2. 直接设置server.servlet.context-path

与许多其他配置选项一样，可以通过设置属性server.servlet.context-path来更改 Spring Boot 中的上下文路径。

请注意，这适用于 Spring Boot 2.x。对于 Boot 1.x，该属性为 server.context-path。
有多种设置此属性的方法，让我们逐一看一下。

2.1 使用application.properties/yml设置

改变上下文路径最直接的方法是在application.properties / yml文件中设置属性：

server.servlet.context-path=/baeldung

2.2. 通过Java系统属性设置

我们还可以在上下文初始化之前将上下文路径设置为 Java 系统属性：

public static void main(String[] args) {
    System.setProperty("server.servlet.context-path", "/test");
    SpringApplication.run(Application.class, args);
}

2.3. 通过操作系统环境变量设置

Spring Boot 还可以依赖于操作系统环境变量。在基于 Unix 的系统上，我们可以这样写：

$ export SERVER_SERVLET_CONTEXT_PATH=/baeldung

在 Windows 上，设置环境变量的命令是：

> set SERVER_SERVLET_CONTEXT_PATH=/baeldung

注意：上述环境变量适用于 Spring Boot 2.xx 如果我们有 1.xx，则变量为SERVER_CONTEXT_PATH。

2.4. 命令行参数设置上下文

我们也可以通过命令行参数动态设置属性：

$ java -jar app.jar --server.servlet.context-path=/baeldung

在这里插入图片描述

3. Java 代码配置容器上下文

现在让我们通过使用配置 bean 填充 bean 工厂来设置上下文路径。
使用 Spring Boot 2时，我们可以使用 WebServerFactoryCustomizer：

@Bean
public WebServerFactoryCustomizer<ConfigurableServletWebServerFactory>
  webServerFactoryCustomizer() {
    return factory -> factory.setContextPath("/baeldung");
}

如果使用 Spring Boot 1，我们需要创建EmbeddedServletContainerCustomizer的实例：

@Bean
public EmbeddedServletContainerCustomizer
  embeddedServletContainerCustomizer() {
    return container -> container.setContextPath("/baeldung");
}

4. 不同包名下的请求前缀设置

这个配置方法，在很多场景尤为重要，如果一个分布式架构想改装成单体架构，如果把某些组件服务合并到一个项目里面，请求前缀都会统一成一个，这个时候就需要为每个模块组件根据包名单独设置前缀路径。

以下分为webflux应用和webmvc应用两类进行不同包名下的请求自定义前缀配置

4.1 若为webflux应用

在这里插入图片描述

新建一个java配置类，实现WebFluxConfigurer接口，如下代码所示：

public abstract class WebFluxPathConfig implements WebFluxConfigurer
{

    @Override
    public void configurePathMatching(PathMatchConfigurer configurer)
    {
        configurer.addPathPrefix("/test", cla -> {
            return cla.getName().startsWith("com.sinhy.test");
        });
    }
}

4.2 若为webmvc应用

在这里插入图片描述

新建一个java配置类，实现WebMvcConfigurer接口，如下代码所示：

public abstract class WebFluxPathConfig implements WebMvcConfigurer
{

    @Override
    public void configurePathMatching(PathMatchConfigurer configurer)
    {
        configurer.addPathPrefix("/test", cla -> {
            return cla.getName().startsWith("com.sinhy.test");
        });
    }
}