Spring Boot 快速入门系列（I） —— 属性配置篇
通过上一篇（Spring Boot 快速入门系列（先导篇） —— 从 Hello World 开始）的介绍，相信大家对 Spring Boot 构建轻量级项目已经有了初步的了解和认识。
今天就给大家讲解一下 Spring Boot 项目中很关键的配置文件 application.properties 的使用方法。
1. 配置文件位置
1.1 application.properties 文件默认路径(使用《先导篇》中构建的 Spring Boot 项目讲解)：
src/main/resources/application.properties
1.2 添加配置文件中的项目访问端口和应用的上下文路径。
在 IDEA 软件中打开 application.properties 文件，输入配置项的key 会智能提示：
在application.properties 中添加如下配置项：
上一篇中，项目的 Tomcat 默认端口：8080，默认路径是根目录。
# 应用的访问端口server.port=9999# 应用的上下文路径，也可以称为项目路径，是构成url地址的一部分server.servlet.context-path=/HelloWorld
1.3 添加完配置后启动HelloWorldApplication类
启动成功会出现以下信息，如图所示：
通过 Postman 验证配置项是否生效。
请求的方式：Get
请求的url：http://localhost:9999/api/hello
请求结果：返回404
请求的url：http://localhost:9999/api/hello
请求结果：Spring Boot，hello World ！
2. Spring Boot 支持自定义属性
我们在 application.properties 中加一个 giserway 属性，属性值hello world。
# 应用的访问端口
server.port=9999
# 应用的上下文路径，也可以称为项目路径，是构成url地址的一部分
server.servlet.context-path=/HelloWorld
# 自定义属组
giserway=hello world
编码如下：
package cn.giserway.helloworld.Controller;
import cn.giserway.helloworld.Config.MysqlConfig;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @program: helloworld
*
* @author: giserway
*
**/
@RestController
@RequestMapping("/api")
public class HelloWorldController {
@Value("${giserway}")
private String giserway;
@GetMapping("/giserway")
public String giserway() {
return "获取key为giserway的自定义属性值：" + giserway;
}
@GetMapping("/hello")
public String Hello() {
return "Spring Boot, hello World !";
}
}其中 @Value 注解读取配置文件属性值。
通过 Postman 发送 Get 请求，获取自定义属性成功，如下所示：
3. 配置一个类别下的多个属性
# mysql的jdbc连接配置
mysql.jdbcName=com.mysql.jdbc.Driver
mysql.dbUrl=jdbc:mysql://localhost:3306/db_test
mysql.userName=root
mysql.password=123456将上面的mysql的配置信息新增到 application.properties 配置文件中，如图所示：
然后在 HelloWorldController 类里通过 @Value 注解分别获取这四个配置项的值，代码如下：
package cn.giserway.helloworld.Controller;
import cn.giserway.helloworld.Config.MysqlConfig;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @program: helloworld
*
* @author: giserway
*
**/
@RestController
@RequestMapping("/api")
public class HelloWorldController {
@Value("${mysql.jdbcName}")
private String jdbcName;
@Value("${mysql.dbUrl}")
private String dbUrl;
@Value("${mysql.userName}")
private String userName;
@Value("${mysql.password}")
private String password;
@GetMapping("/mysql")
public String mysql() {
return "mysql.jdbcName的属性值：" + jdbcName
+ "\nmysql.dbUrl的属性值：" + dbUrl
+ "\nmysql.userName属性值：" + userName
+ "\nmysql.userName属性值：" + userName;
}
}Postman 请求结果如下：
上面这种获取类属性很多的情况下，代码编码很多，如果多个地方引用，则每个引用的类都需要写多个 @Value 获取属性值，明显这种获取属性的方式不可取。
下面我们使用一种简单方便的获取属性方式，即通过 @ConfigurationProperties 注解
在 config 包下新建一个 MysqlConfig 类，把所有 jdbc 连接的mysql 属性都配置上去。
先在 pom 文件添加依赖：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>代码如下：
package cn.giserway.helloworld.Config;
/**
* @program: helloworld
*
* @author: giserway
*
**/
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
/**
* Mysql 连接配置类
*/
@Component
@ConfigurationProperties(prefix = "mysql")
public class MysqlConfig {
private String jdbcName;
private String dbUrl;
private String userName;
private String password;
public String getJdbcName() {
return jdbcName;
}
public void setJdbcName(String jdbcName) {
this.jdbcName = jdbcName;
}
public String getDbUrl() {
return dbUrl;
}
public void setDbUrl(String dbUrl) {
this.dbUrl = dbUrl;
}
public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
}再修改 HelloWorldController 类中获取 mysql 连接的配置，代码如下：
package cn.giserway.helloworld.Controller;
import cn.giserway.helloworld.Config.MysqlConfig;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @program: helloworld
*
* @author: giserway
*
**/
@RestController
@RequestMapping("/api")
public class HelloWorldController {
@Autowired
private MysqlConfig mysqlConfig;
@GetMapping("/mysqlConfig")
public String mysqlConfig() {
return "mysql.jdbcName的属性值：" + mysqlConfig.getJdbcName()
+ "\nmysql.dbUrl的属性值：" + mysqlConfig.getDbUrl()
+ "\nmysql.userName的属性值：" + mysqlConfig.getUserName()
+ "\nmysql.userName的属性值：" + mysqlConfig.getPassword();
}
}通过代码可以看出，直接通过 @Autowired 注解直接注入 MysqlConfig 类，然后使用 MysqlConfig 类的 getter 方法获取特别方便，什么地方需要直接注入即可，是不是方便了很多。
4. 小结
通过今天的简单的介绍及示例，相信大家对于 application.properties 配置文件有了一定的了解，以及怎么通过注解的方式便捷的获取配置文件中属性信息。另外还有好多属性配置项，由于文章篇幅关系，没有办法一一赘述，有了丰富的默认注解配置才使得 Spring Boot 开发效率更高，因此本文只是起了抛砖引玉的作用，后续希望大家自己去探索 Spring Boot 配置项的奥秘。