一：Spring Boot 的配置文件 application.properties

ゝ一纸荒年。 2023-02-23 08:23 12阅读 0赞

### Spring Boot 的配置文件 application.properties ###

*  1、位置问题
 *  2、普通的属性注入
 *  3、类型安全的属性注入

# 1、位置问题 #

当我们创建一个 Spring Boot 工程时，默认 resources 目录下就有一个 application.properties 文件，可以在 application.properties 文件中进行项目配置，但是这个文件并非唯一的配置文件，在 Spring Boot 中，一共有 4 个地方可以存放 application.properties 文件。

1.  当前项目根目录下的 config 目录下
2.  当前项目的根目录下
3.  resources 目录下的 config 目录下
4.  resources 目录下

按如上顺序，四个配置文件的优先级依次降低。如下：  
![format_png][]

这四个位置是默认位置，即 Spring Boot 启动，默认会从这四个位置按顺序去查找相关属性并加载。

也可以在项目启动时自定义配置文件位置。  
例如，现在在 resources 目录下创建一个 javaboy 目录，目录中存放一个 application.properties 文件，那么正常情况下，当我们启动 Spring Boot 项目时，这个配置文件是不会被自动加载的。我们可以通过 spring.config.location 属性来手动的指定配置文件位置，指定完成后，系统就会自动去指定目录下查找 application.properties 文件。  
![format_png 1][]  
此时启动项目，就会发现，项目以 classpath:/javaboy/application.propertie 配置文件启动。

这是在开发工具中配置了启动位置，如果项目已经打包成 jar ，在启动命令中加入位置参数即可：  
`java -jar properties-0.0.1-SNAPSHOT.jar --spring.config.location=classpath:/javaboy/`

# 2、普通的属性注入 #

由于 Spring Boot 中，默认会自动加载 application.properties 文件，所以简单的属性注入可以直接在这个配置文件中写。  
例如，现在定义一个 Book 类：

public class Book { 
        private Long id;
        private String name;
        private String author;
        //省略 getter/setter
    }

然后，在 application.properties 文件中定义属性：

book.name=三国演义
    book.author=罗贯中
    book.id=1

按照传统的方式（Spring中的方式），可以直接通过 @Value 注解将这些属性注入到 Book 对象中：

@Component
    public class Book { 
        @Value("${book.id}")
        private Long id;
        @Value("${book.name}")
        private String name;
        @Value("${book.author}")
        private String author;
        //省略getter/setter
    }

**注意:**  
Book 对象本身也要交给 Spring 容器去管理，如果 Book 没有交给 Spring 容器，那么 Book 中的属性也无法从 Spring 容器中获取到值。  
配置完成后，在 Controller 或者单元测试中注入 Book 对象，启动项目，就可以看到属性已经注入到对象中了。  
一般来说，我们在 application.properties 文件中主要存放系统配置，这种自定义配置不建议放在该文件中，可以自定义 properties 文件来存在自定义配置。  
例如在 resources 目录下，自定义 book.properties 文件，内容如下：

book.name=三国演义
    book.author=罗贯中
    book.id=1

此时，项目启动并不会自动的加载该配置文件，如果是在 XML 配置中，可以通过如下方式引用该 properties 文件：  
`<context:property-placeholder location="classpath:book.properties"/>`  
如果是在 Java 配置中，可以通过 @PropertySource 来引入配置：

@Component
    @PropertySource("classpath:book.properties")
    public class Book { 
        @Value("${book.id}")
        private Long id;
        @Value("${book.name}")
        private String name;
        @Value("${book.author}")
        private String author;
        //getter/setter
    }

这样，当项目启动时，就会自动加载 book.properties 文件。  
这只是 Spring 中属性注入的一个简单用法，和 Spring Boot 没有任何关系。

# 3、类型安全的属性注入 #

pring Boot 引入了类型安全的属性注入，如果采用 Spring 中的配置方式，当配置的属性非常多的时候，工作量就很大了，而且容易出错。

使用类型安全的属性注入，可以有效的解决这个问题。

@Component
    @PropertySource("classpath:book.properties")
    @ConfigurationProperties(prefix = "book")
    public class Book { 
        private Long id;
        private String name;
        private String author;
        //省略getter/setter
    }

这里，主要是引入 @ConfigurationProperties(prefix = “book”) 注解，并且配置了属性的前缀，此时会自动将 Spring 容器中对应的数据注入到对象对应的属性中，就不用通过 @Value 注解挨个注入了，减少工作量并且避免出错。

[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly93d3cuamF2YWJveS5vcmcvaW1hZ2VzL2Jvb3QvMTEtMS5wbmc?x-oss-process=image/format,png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly93d3cuamF2YWJveS5vcmcvaW1hZ2VzL2Jvb3QvMTEtMi5wbmc?x-oss-process=image/format,png