导言
一、配置文件语法
1. 了解配置文件
当我们使用spring 初始化器构建完一个Spring Boot项目后，只需引入一个web启动器的依赖，它就变成一个web项目了，而且呢我们 什么都没有配置就能通过localhost:8080进行访问了，那这是为什么呢?
那是因为Spring Boot在底层已经把配置信息都给我们自动配置好了。 那我们怎么去修改默认配置信息?
在使用Spring 初始化器创建一个Springboot项目的时候会在resources目录下自动生成一个文件 application.properties，这是一个空 文件，它的作用是提供我们修改默认配置信息的入口。
Spring Boot还提供给我们另外一种风格的配置文件 application.yml，虽然是两个不同的文件但是本质是一样的，区别只是其中的语法 略微不同。下面我们就来一一介绍一下这两种不同风格的配置文件。
2. Properties 语法
application.properties 配置文件比较简单，形式如下
key = value
不需要空格进行区分，父属性和子属性之间是以“.”进行区分的
3. YML 语法
- 大小写敏感。
- k:(空格)v:表示一对键值对(
空格必须有)，以空格的缩进来控制层级关系。 - 只要是左对齐的一列数据，则表示都是同一个层级的。
- “#” 表示注释，从这个字符一直到行尾，都会被解析器忽略。
4. 例子
我们写一个简单的例子看看它们之间的区别：配置端口号
以前是这样配置的
<server> <port>8080</port> </server>AI 代码解读现在是这样配置的
application.ymlserver: port: 8080AI 代码解读application.propertiesserver.port=8080AI 代码解读
二、配置文件读取
1. 创建工程
项目细节
项目依赖
项目结构
配置流程
- 在配置文件加上配置信息
- 创建一个Person实体类用来验证@Value 读取配置文件属性是否成功
- 创建一个PersonConfig 配置类读取属性
- 把属性set到Person注入到容器
- 单元测试拿到person实例打印它
2. 简单的数据类型读取-@Value
a、修改配置文件 application
我这里使用第一种方式
修改
application.properties#基本类型 person.userName=zhangsan person.age=29 person.salary=22000 person.sex=maleAI 代码解读或者修改为application.yml(和application.properties本质一样 两者选其一 )person: userName: zhangsan age: 29 salary: 220000 sex: maleAI 代码解读
b、属性注入类
创建: bean.Person.java javabean
package com.feng.springBoot_configuration_properties.Bean;
public class Person {
private String userName;
private int age;
private double salary;
private String sex;
@Override
public String toString() {
return "Person{" +
"userName='" + userName + '\'' +
", age=" + age +
", salary=" + salary +
", sex='" + sex + '\'' +
'}';
}
public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public double getSalary() {
return salary;
}
public void setSalary(double salary) {
this.salary = salary;
}
public String getSex() {
return sex;
}
public void setSex(String sex) {
this.sex = sex;
}
}
AI 代码解读
c、 声明配置类
创建 config.PersonConfig.java 配置类
package com.feng.springBoot_configuration_properties.config;
import com.feng.springBoot_configuration_properties.bean.Person;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class PersonConfig {
@Value("${person.userName}")
private String userName;
@Value("${person.age}")
private int age;
@Value("${person.salary}")
private double salary;
@Value("${person.sex}")
private String sex;
@Bean
public Person getPerson(){
Person person=new Person();
person.setSex(sex);
person.setAge(age);
person.setUserName(userName);
person.setSalary(salary);
return person;
}
}
AI 代码解读
d、单元测试
创建 SpringBootConfigurationPropertiesApplicationTests Junit 单元测试
package com.feng.springBoot_configuration_properties;
import com.feng.springBoot_configuration_properties.bean.Person;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class SpringBootConfigurationPropertiesApplicationTests {
@Autowired
private Person person;
@Test
void contextLoads() {
}
@Test
public void testPerson(){
System.out.println(person.toString());
}
}
AI 代码解读
测试输出
e、解读
@Configuration:声明我们PersonConfig 是一个配置类- 通过
@Value为属性注入值 - 通过
@Bean Spring会自动调用该方法，将方法的返回值加入Spring容器中
f、项目结构
3. 配置文件读取- @ConfigurationProperties
- 配置流程
- 配置文件配置复杂的内容
- 创建映射实体
- 屏蔽PersonConfig 配置类的代码
- 修改 Person 实体类
- 打印person实体
a、修改配置文件 application
我这里使用第二种方式
application.Properties#基本类型 person.userName=zhangsan person.age=29 person.salary=22000 person.sex=male #array person.pets=dog,cat #map person.friend.userName=wangwu person.friend.age=28 #list person.list[0]=value1 person.list[1]=value2 #list嵌套Map/对象 person.children[0].name=ting person.children[0].weight=2 person.children[1].name=hao person.children[1].weight=5 #对象嵌套对象 person.employee.name=lisi person.employee.age=21AI 代码解读或者是 修改为
application.yml
#基本类型
#person.userName=zhangsan
#person.age=29
#person.salary=22000
#person.sex=male
persontwo:
userName: zhangsan # String userName
age: 29
salary: 220000
sex: male
pets: cat,dog # String[] pets
friend: # Map<String,String> friend;
userName: wangwu
age: 27
list: # List<String> list;
- value1
- value2
children: # List<Map<String,String>> children
- name: ting
weight: 2
- name: hao
weight: 5
employee: # Employee employee
name: lisi
age: 21
AI 代码解读
b、修改 PersonConifg
c、创建 Employee 实体类
package com.feng.springBoot_configuration_properties.bean;
public class Employee {
private String name;
private String age;
@Override
public String toString() {
return "Employee{" +
"name='" + name + '\'' +
", age='" + age + '\'' +
'}';
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getAge() {
return age;
}
public void setAge(String age) {
this.age = age;
}
}
AI 代码解读
d、创建 PersonTwo 实体类
在Person类的基础上 增加了几个集合属性 变为 PersonTwo- 并添加了两个注解
@ConfigurationProperties(prefix = "personTwo") 和 @Component - 代码
package com.feng.springBoot_configuration_properties.bean;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
@ConfigurationProperties(prefix = "personTwo")
@Component
public class PersonTwo {
private String userName;
private int age;
private double salary;
private String sex;
//array
private String[] pets;
//map
private Map<String,String> friend;
//list
private List<String> list; //list嵌套对象或者map
private List<Map<String,String>> children; //对象嵌套对象
private Employee employee;
@Override
public String toString() {
return "PersonTwo{" +
"userName='" + userName + '\'' +
", age=" + age +
", salary=" + salary +
", sex='" + sex + '\'' +
", pets=" + Arrays.toString(pets) +
", friend=" + friend +
", list=" + list +
", children=" + children +
", employee=" + employee +
'}';
}
public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
public double getSalary() {
return salary;
}
public void setSalary(double salary) {
this.salary = salary;
}
public String getSex() {
return sex;
}
public void setSex(String sex) {
this.sex = sex;
}
public String[] getPets() {
return pets;
}
public void setPets(String[] pets) {
this.pets = pets;
}
public Map<String, String> getFriend() {
return friend;
}
public void setFriend(Map<String, String> friend) {
this.friend = friend;
}
public List<String> getList() {
return list;
}
public void setList(List<String> list) {
this.list = list;
}
public List<Map<String, String>> getChildren() {
return children;
}
public void setChildren(List<Map<String, String>> children) {
this.children = children;
}
public Employee getEmployee() {
return employee;
}
public void setEmployee(Employee employee) {
this.employee = employee;
}
}
AI 代码解读
e、单元测试
需要将原来的Person 给注释掉，因为application的后缀变了，所以PersonConfig连带起来都要改变。
package com.feng.springBoot_configuration_properties;
import com.feng.springBoot_configuration_properties.bean.PersonTwo;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class SpringBootConfigurationPropertiesApplicationTests {
// @Autowired
// private Person person;
@Autowired
private PersonTwo personTwo;
@Test
void contextLoads() {
}
@Test
public void testPerson(){
// System.out.println(person.toString());
}
@Test
public void testPersonTwo(){
System.out.println(personTwo.toString());
}
}
AI 代码解读
- 测试结果
f. 注解解读
@ConfigurationProperties注解向Spring Boot声明该类中的所有属性和配置文件中相关的配置进行绑定。prefix = "person":声明配置前戳，将该前戳下的所有属性进行映射。
@Component将该组件加入Spring Boot容器，只有这个组件是容器中的组件，配置才生效。
g、项目结构
三、 静态工具类读取配置文件
在日常开发中经常会遇到这种情况，就是有一些方法经常用到但是呢又需要外部的一些静态常量(各个环境的值是不一样的)进行组装， 所以呢我们会把这些方法抽出来统一放在一个工具类里面，大家也知道通常来说工具类里面都是一些静态的方法，后续在其它地方使 用的时候直接工具类.方法就可以了。但是呢我们的方法改成静态方法后，里面用到的变量也同样要改成静态的变量，这里就涉及到了 静态属性的注入问题了，如果我们还像上小节那样用 @Value 直接注入是注入不进来的。
那么我们怎么去改造呢?怎么才能把它 注入到静态的变量 呢?好下面我们就来实践一下。
- 加入配置文件信息
- 新增一个配置读取类:TokenSettings
- 新增静态工具类 :JwtTokenUtil
- 创建一个代理工具类:StaticInitializerUtil
- 单元测试
1. 配置文件信息application.yml
以后都采用application.yml方式进行配对
#JWT 密钥
jwt:
secretKey: xxxxfjcxxx
issuer: fengjianchi.com
AI 代码解读
2. 新增 配置读取类 TokenSettings
package com.feng.springBoot_configuration_properties.config;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
@Configuration
@ConfigurationProperties(prefix = "jwt")
public class TokenSettings {
private String secretKey;
private String issuer;
@Override
public String toString() {
return "TokenSettings{" +
"secretKey='" + secretKey + '\'' +
", issuer='" + issuer + '\'' +
'}';
}
public String getSecretKey() {
return secretKey;
}
public void setSecretKey(String secretKey) {
this.secretKey = secretKey;
}
public String getIssuer() {
return issuer;
}
public void setIssuer(String issuer) {
this.issuer = issuer;
}
}
AI 代码解读
3. 创建一个 JwtTokenUtil
package com.feng.springBoot_configuration_properties.config;
public class JwtTokenUtil {
private static String secretKey;
private static String issuer;
public static void setTokenSettings(TokenSettings tokenSettings){
secretKey = tokenSettings.getSecretKey();
issuer = tokenSettings.getIssuer();
}
public static String getSecretKey(){
return secretKey;
}
public static String getIssuer(){
return issuer;
}
}
AI 代码解读
4. 创建一个代理类 StaticInitializerUtil
package com.feng.springBoot_configuration_properties.config;
import org.springframework.stereotype.Component;
@Component
public class StaticInitializerUtil {
private TokenSettings tokenSettings;
public StaticInitializerUtil(TokenSettings tokenSettings) {
JwtTokenUtil.setTokenSettings(tokenSettings);
}
}
AI 代码解读
5. 单元测试
@Test
public void testStaticUtil(){
System.out.println("secretKey="+JwtTokenUtil.getSecretKey());
System.out.println("issuer="+JwtTokenUtil.getIssuer());
}
AI 代码解读
