【从零开始学Spring Boot】-5.Spring Boot Profile环境隔离

1.简介

1.1 概述

Spring Profiles provide a way to segregate parts of your application configuration and make it be available only in certain environments. Any @Component, @Configuration or @ConfigurationProperties can be marked with @Profile to limit when it is loaded

Spring Profiles 提供了一种隔离应用程序配置部分并使之仅在某些环境中可用的方法。任何 @Component，@ Configuration 或 @ConfigurationProperties 都可以用 @Profile 标记来限制它的加载。

1.2 特点

1. 可在 xml 中使用；
2. 可以修饰类、注解、方法；
3. 可以通过 命令行、系统属性、启动变量、配置文件 等方式激活；

2.环境

1. JDK 1.8.0_201
2. Spring Boot 2.2.0.RELEASE
3. 构建工具（apache maven 3.6.3）
4. 开发工具（IntelliJ IDEA ）

3.代码

3.1 代码说明

提供了 dev、prod 两套环境的配置和代码，测试激活不同的 profile，功能是否如预期

3.2 代码结构

3.3 maven 依赖

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

3.4 配置文件

application.properties

spring.profiles.active=dev

application-dev.properties

spring.application.name=spring-boot-profile
server.port=8080

user.age=20

application-prod.properties

spring.application.name=spring-boot-profile
server.port=9090

user.age=30

3.5 java代码

UserModel.java

public class UserModel {

    private String name;

    @Value("${user.age}")
    private Integer age;

    public UserModel(String name, Integer age) {
        this.name = name;
        this.age = age;
    }

    public UserModel() {
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "UserModel{name='" + name + '\'' + ", age='" + age + '\'' + '}';
    }
}

DevConfig.java

@Profile("dev")
@Configuration
public class DevConfig {

    @Bean
    public UserModel userModel() {
        UserModel userModel = new UserModel();
        userModel.setName("zhangsan");
        return userModel;
    }
}

ProdConfig.java

@Profile("prod")
@Configuration
public class ProdConfig {

    @Bean
    public UserModel userModel() {
        UserModel userModel = new UserModel();
        userModel.setName("lisi");
        return userModel;
    }
}

UserController.java

@RestController
public class UserController {

    @Autowired
    private final ApplicationContext applicationContext;

    public UserController(ApplicationContext applicationContext) {
        this.applicationContext = applicationContext;
    }

    @GetMapping(value = "/user/get")
    public UserModel getUser() {
        return applicationContext.getBean(UserModel.class);
    }

    @Profile("dev")
    @GetMapping(value = "/user/dev")
    public UserModel devUser() {
        return new UserModel("dev-user", 22);
    }

    @Profile("prod")
    @GetMapping(value = "/user/prod")
    public UserModel prodUser() {
        return new UserModel("prod-user", 33);
    }
}

3.6 git 地址

spring-boor/spring-boot-05-basis/spring-boot-profile

4.效果展示

4.1 profile 的几种激活方式

1. 使用 jar 包启动时，指定为命令行参数

   java -jar spring-boot-profile-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev

2. 使用 jar 包启动时，指定为启动参数

   java -Dspring.profiles.active=dev -jar spring-boot-profile-0.0.1-SNAPSHOT.jar

3. 通过配置文件指定

   spring.profiles.active=dev

4. 通过代码设定为系统变量

   System.setProperty("spring.profiles.active", "dev");

5. 启动类中指定

   new SpringApplicationBuilder(SpringBootProfileApplication.class)
                   .properties("spring.profiles.active=dev").run(args);

6. idea 启动时指定（配置任意一处即可）

   

7. web.xml 中配置

   <context-param> 
       <param-name>spring.profiles.active</param-name> 
       <param-value>dev</param-value> 
   </context-param>

优先级

命令行方式 > Java系统属性方式 > 系统变量方式 > 配置文件方式

profile 值可以指定多个，例如： –spring.profiles.active=dev,test

4.2 profile 测试

按照上面任意一种方式激活 profile，分别设置为 dev 和 prod，启动 SpringBootProfileApplication.main 方法，在 spring-boot-profile.http 访问下列地址，观察输出信息是否符合预期。

4.2.1 profile=dev

### GET /user/get
GET http://localhost:8080/user/get

### GET /user/dev
GET http://localhost:8080/user/dev

4.2.1 profile=prod

### GET /user/get
GET http://localhost:9090/user/get

### GET /user/prod
GET http://localhost:9090/user/prod

5.参考

1. 官方文档–Spring Boot Features/Profiles
2. SpringBoot 教程之 profile 的应用