Spring Boot 属性配置和使用

Posted 2022-10-18 R-Pursue

Spring Boot 属性配置和使用

Spring Boot是由Pivotal团队提供的全新框架，其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置，从而使开发人员不再需要定义样板化的配置。简单说就是可以通过配置文件来注入属性或者修改默认的配置。

Spring Boot 支持多种外部配置方式

这些方式优先级如下：

1. 命令行参数
2. 来自java:comp/env的JNDI属性
3. Java系统属性（System.getProperties()）
4. 操作系统环境变量
5. RandomValuePropertySource配置的random.*属性值
6. jar包外部的application-profile.properties或application.yml(带spring.profile)配置文件
7. jar包内部的application-profile.properties或application.yml(带spring.profile)配置文件
8. jar包外部的application.properties或application.yml(不带spring.profile)配置文件
9. jar包内部的application.properties或application.yml(不带spring.profile)配置文件
10. @Configuration注解类上的@PropertySource
11. 通过SpringApplication.setDefaultProperties指定的默认属性

命令行参数

通过Java -jar app.jar --name="Spring boot" --server.port=7001方式来传递参数。

可以通SpringApplication.setAddCommandLineProperties(false)来取消这种方式的配置

Java系统属性

Java系统属性配置方式为
java -Dname="SpringBoot" -jar app.jar

这和命令行参数可以配置的属性都是一样的，只是优先级不同。

例如java -Dname="SpringBoot" -jar app.jar --name="Spring!"中name值为Spring!

操作系统环境变量

操作系统环境变量是设备上的配置的环境变量，各Java开发肯定配置过java_home。这就是一种操作系统环境变量
需要注意的是，有些OS不支持使用.这种名字，如server.port，这种情况可以使用SERVER_PORT来配置。

具体名字如何匹配，看本文后面。

应用配置文件（.properties或.yml）

在.properties配置文件中直接写：

name=SpringBoot
server.port=7001

.yml格式的配置文件：

name: SpringBoot
server:
    port: 7001

当有前缀的情况下，使用.yml格式的配置文件更简单。关于

.yml配置文件用法请戳官方文档

注意：使用.yml时，属性名的值和冒号中间必须有空格，如name: SpringBoot正确，SpringBoot就是错的。

属性配置文件的位置

spring会从classpath下的/config目录或者classpath的根目录查找application.properties或application.yml。

/config优先于classpath根目录

@PropertySource

这个注解可以指定具体的属性配置文件，优先级比较低。

SpringApplication.setDefaultProperties

例如：

SpringApplication application = new SpringApplication(Application.class);
Map<String, Object> defaultMap = new HashMap<String, Object>();
defaultMap.put("name", "SpringBoot");
//还可以是Properties对象
application.setDefaultProperties(defaultMap);
application.run(args);

使用属性

Value(“$xxx”)

这种方式是最简单的，通过@Value注解可以将属性值注入进来。

ConfigurationProperties

Spring Boot 可以方便的将属性注入到一个配置对象中。例如：

my.name=SpringBoot
my.port=7001
my.servers[0]=dev.bar.com
my.servers[1]=foo.bar.com

对应对象：

@ConfigurationProperties(prefix="my")
public class Config 
    private String name;
    private Integer port;
    private List<String> servers = new ArrayList<String>();

    public String geName()
        return this.name;
    

    public Integer gePort()
        return this.port;
    
    public List<String> getServers() 
        return this.servers;
    

Spring Boot 会自动将prefix="my"前缀为my的属性注入进来。

Spring Boot 会自动转换类型，当使用List的时候需要注意在配置中对List进行初始化！

Spring Boot 还支持嵌套属性注入，例如：

name=isea533
jdbc.username=root
jdbc.password=root
...

对应的配置类：

@ConfigurationProperties
public class Config 
    private String name;
    private Jdbc jdbc;
    class Jdbc 
        private String username;
        private String password;
        //getter...
    

    public Integer gePort()
        return this.port;
    
    public Jdbc getJdbc() 
        return this.jdbc;
    

jdbc开头的属性都会注入到Jdbc对象中。

在@Bean方法上使用@ConfigurationProperties
例如：

@ConfigurationProperties(prefix = "foo")
@Bean
public FooComponent fooComponent() 
    ...

Spring Boot 会将foo开头的属性按照名字匹配注入到FooComponent对象中。

属性占位符

例如：

app.name=MyApp
app.description=$app.name is a Spring Boot application

可以在配置文件中引用前面配置过的属性（优先级前面配置过的这里都能用）。

通过如$app.name:默认名称方法还可以设置默认值，当找不到引用的属性时，会使用默认的属性。

由于$方式会被Maven处理。如果你pom继承的```spring-boot-starter-parent```，Spring Boot 已经将maven-resources-plugins默认的$方式改为了@ @方式，例如@name@。

如果你是引入的Spring Boot，你可以修改使用其他的分隔符

通过属性占位符还能缩短命令参数

server.port=$port:7001

那么就可以使用更短的--port=7002，当不提供该参数的时候使用默认值7001。

属性名匹配规则

例如有如下配置对象：

@Component
@ConfigurationProperties(prefix="person")
public class ConnectionSettings 

    private String firstName;

firstName可以使用的属性名如下：

person.firstName，标准的驼峰式命名

person.first-name，虚线（-）分割方式，推荐在.properties和.yml配置文件中使用

PERSON_FIRST_NAME，大写下划线形式，建议在系统环境变量中使用

属性验证

可以使用JSR-303注解进行验证，例如：

@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings 

    @NotNull
    private InetAddress remoteAddress;

    // ... getters and setters

最后

以上是Spring Boot 属性配置和使用的内容，有些不全面的地方或者有更多疑问，可以查看Spring Boot完整文档 或 Externalized Configuration。文章哪里有不妥之处还烦请指正。