Spring Boot2.0 启动加载指定环境application.properties配置文件

以你之姓@ 2024-04-18 09:33 48阅读 0赞

通常我们在开发完成一个SpringBoot项目时，总是要打包部署的。

在启动SpringBoot应用时，我们常常会使用命令java -jar xxx.jar来启动这个服务。

命令java -jar 除了启动应用之外，还可以在命令中指定应用的参数，比如一下带参数的命令：

(1)java -jar xxx.jar **--server.port=8081**，直接以命令的方式来设置服务的访问端口server.port属性，将端口设置为8081;

(2)java -jar -Xms1024m -Xmx1024m xxx.jar **--spring.profiles.active=test** ，以命令方式设置该服务启动时的内存大小，以及设置启动环境为test，并且服务是后台启动。

在使用命令行方式启动SpringBoot应用时，设置参数时所使用的连续的两个减号 -- 就是对其属性配置文件application.properties或者application.yml中的属性值进行赋值的标识。所以java -jar xxx.jar --server.port=8081命令，就等价于在属性文件中添加属性server.port=8081。

通过命令行的方式设置启动参数是SpringBoot的一个重要特性，在启动应用时，我们不仅可以设置应用的端口、访问路径、运行环境，还可以设置它的数据库连接等。但是在实际生产过程中，同一套应用程序会被应用和安装到不同的环境中，同时需要设置多个参数，这样的方式肯定不可取的。以是有了SpringBoot的多环境配置。

# 一、SpringBoot多环境配置 #

在SpringBoot中，进行多环境配置，需要配置多个属性文件。多环境配置的文件名需要满足application-\{profile\}.properties的格式，其中\{profile\}对应你的环境标识，比如：

application-dev.properties: 表示你的开发环境

application-test.properties: 表示你的测试环境

application-prod.properties: 表示你的生产环境

在启动项目的时候具体加载哪个属性文件，需要你**在application.properties文件中通过spring.profiles.active属性来设置，比如spring.profiles.active=test就会加载application-test.properties属性文件**。

其中在application.properties属性文件中配置通用内容，并设置spring.profiles.active属性来指定启动环境。而application-\{profile\}.properties属性文件中则配置各个环境的不同信息，比如数据库连接信息、端口以及其他信息等。

另外，虽然我们在application.properties属性文件中指定了启动时的环境，我们依然可以使用java -jar xxx.jar --spring.profiles.active命令来改变它的启动运行环境。

在启动应用的时候，我们可以使用命令java -jar xxx.jar **--spring.profiles.active=prod**来随意切换环境即可。

# 二、SpringBoot启动时加载顺序 #

在SpringBoot应用启动时，将会按照下面的顺序来进行属性的加载：

(1) 首先加载启动命令中传入的参数;

(2) 加载SPRING\_APPLICATION\_JSON中的属性。SPRING\_APPLICATION\_JSON是以JSON格式配置在系统环境变量中的内容;

(3) 加载java:comp/dev中的JNDI属性;

(4) 加载Java的系统属性，可以通过System.getProperties()获取到的内容;

(5) 加载操作系统的环境变量;

(6) 加载random.\*配置的随机属性;

(7) 加载位于当前应用jar包之外，针对不同\{profile\}环境的配置文件内容，比如application-\{profile\}.properties或者YAML定义的配置文件;

(8) 加载位于当前应用jar包之内，针对不同\{profile\}环境的配置文件内容，比如application-\{profile\}.properties或者YAML定义的配置文件;

(9) 加载位于当前应用jar包之外的application.properties和YAML配置内容;

(10) 加载位于当前应用jar包之内的application.properties和YAML配置内容;

(11) 加载含有@Configuration注解的类，通过@PropertySource注解定义的属性;

(12) 最后加载应用的默认属性，使用SpringApplication.setDefaultProperties定义的内容。

加载的优先级按照以上顺序由高到底，数字越小的优先级越高，越先被加载。

# 在这里额外说一下(6)中提到的随机数： #

在SpringBoot的属性配置文件中，可以通过使用$\{random\}配置来产生随机的int值、long值或者string字符串，这样我们就可以容易地通过配置随机生成属性。

$\{random\}的配置主要有以下几种形式：

(1)随机字符串：

random.stringValue=$\{random.value\}

(2)随机int：

random.intValue=$\{random.int\}

(3)随机long：

random.longValue=$\{random.long\}

(4)100以内的随机数：

random.number=$\{random.int(100)\}

(5)100到1000的随机数：

random.number=$\{random.int\[100,1000\]\}

··········································

Spring Boot程序默认从application.properties或者application.yaml读取配置，如何将配置信息外置，方便配置呢？

查询官网，可以得到下面的几种方案:

## 通过命令行指定 ##

SpringApplication会默认将命令行选项参数转换为配置信息  
例如，启动时命令参数指定：

java -jar myproject.jar --server.port = 9000

从命令行指定配置项的优先级最高，不过你可以通过setAddCommandLineProperties来禁用

SpringApplication.setAddCommandLineProperties(false).

## 外置配置文件 ##

Spring程序会按优先级从下面这些路径来加载application.properties配置文件

*  当前目录下的/config目录
 *  当前目录
 *  classpath里的/config目录
 *  classpath 跟目录

因此，要外置配置文件就很简单了，在jar所在目录新建config文件夹，然后放入配置文件，或者直接放在配置文件在jar目录

## 自定义配置文件 ##

如果你不想使用application.properties作为配置文件，怎么办？完全没问题

java -jar myproject.jar **--spring.config.location=classpath:/default.properties,classpath:/override.properties**

或者

java -jar **-Dspring.config.location=D:\\config\\config.properties** springbootrestdemo-0.0.1-SNAPSHOT.jar

当然，还能在代码里指定

@SpringBootApplication
    @PropertySource(value={"file:config.properties"})
    public class SpringbootrestdemoApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(SpringbootrestdemoApplication.class, args);
        }
    }

## 按Profile不同环境读取不同配置 ##

不同环境的配置设置一个配置文件，例如：

*  dev环境下的配置配置在application-dev.properties中；
 *  prod环境下的配置配置在application-prod.properties中。

在application.properties中指定使用哪一个文件

spring.profiles.active = dev

当然，你也可以在运行的时候手动指定：

java -jar myproject.jar --spring.profiles.active = prod

参考：  
1 参见[Externalized Configuration][]

链接：

https://juejin.im/post/5c8f4dd06fb9a070bc3f04be

[https://www.cnblogs.com/xiaoqi/p/6955288.html][https_www.cnblogs.com_xiaoqi_p_6955288.html]

[Externalized Configuration]: http://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html
[https_www.cnblogs.com_xiaoqi_p_6955288.html]: https://www.cnblogs.com/xiaoqi/p/6955288.html