SpringBoot 配置文件核心用法（Properties YAML）

SpringBoot 配置文件作用SpringBoot 定义了规范的配置文件格式用于集成其他框架并集中管理项目各类配置信息典型场景包括项目启动端口自定义服务监听端口数据库连接信息包含用户名、密码等第三方系统调用密钥日志配置普通日志、异常日志用于问题定位与排查1.关键配置场景说明项目启动端口SpringBoot 内置 Tomcat 服务器默认端口号为 8080若 8080 端口被其他程序占用需通过配置文件自定义端口号数据库连接信息持久层框架如 MyBatis、JPA 等是对 JDBC 的深层封装不同应用访问的数据库不同需通过配置文件自定义数据库连接参数2.配置文件快速入门SpringBoot 项目创建时会自动生成配置文件可通过修改配置文件更改服务端口号解决 8080 端口被占用问题修改 application.properties ⽂件server.port9090显⽰Tomcat启动端⼝号为9090访问程序:http://127.0.0.1:9090/login.html此时:http://127.0.0.1:808/login.html 就不能再访问了3.配置文件的格式Spring Boot 配置文件有以下三种application.propertiesapplication.ymlapplication.yaml注意properties 优先级比yml. yaml的优先级要高一些yml为yaml的简写实际开发中出现频率最高。yaml和yml的使用方式一样课堂中只讲yml文件的使用。当应用程序启动时Spring Boot 会自动从 classpath 路径找到并加载application.properties和application.yaml或者application.yml文件。也可以通过spring.config.name指定文件路径和名称参考 https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.external-config.files如下图所示3.1配置文件包装类比类似商品包装.properties是老款包装Spring Boot 项目默认格式.yml是新版包装实际开发中更推荐使用。3.2特殊说明共存与优先级理论上.properties和.yml可共存启动时都会加载若配置冲突.properties优先级更高。实践建议实际业务中建议统一使用一种格式便于维护、降低故障概率。注意事项重启idea ,会出现有一点小问题我们重启idea我们会发现他乱码了遇到这种情况我们没有恢复的办法解决办法1.2.3.这个只是修改了这个的配置我们需要修改整个的这个配置文件4.修改本地的配置4.properties 配置文件说明4.1 基本语法格式键值对keyvalue形式注释使用#添加注释示例# 配置项目端口号 server.port8080 # 配置数据库连接信息 spring.datasource.urljdbc:mysql://127.0.0.1:3306/testdb?characterEncodingutf8useSSLfalse spring.datasource.usernameroot spring.datasource.passwordroot4.2 读取配置文件方式使用Value注解以${key}格式读取配置示例mykey.key1 bite代码示例import org.springframework.beans.factory.annotation.Value; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; RestController public class PropertiesController { Value(${mykey.key1}) private String key1; RequestMapping(/key) public String key(){ return 读取到值:key1; } }补充说明Value注解可直接注入配置文件中的值到类成员变量。访问/key接口时会返回配置文件中mykey.key1对应的值如读取到值:bite。PostConstruct 核心说明1. 基本定义PostConstruct是 Java EE 中的注解Spring 也完全支持作用是在 Spring 容器创建完 Bean 实例、完成依赖注入后自动执行标注了这个注解的方法。简单说Bean 先被创建 → 依赖注入比如Autowired注入的对象→PostConstruct方法执行。初始化数据比如加载配置、初始化缓存、连接第三方服务执行 Bean 创建后的前置操作依赖注入完成后才能执行避免空指针。二、完整可运行示例import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; import javax.annotation.PostConstruct; // 普通的Spring Bean Component public class UserService { // 依赖注入的对象 Autowired private ConfigService configService; // 空参、无返回值的初始化方法 PostConstruct public void init() { // 此时configService已经完成注入可安全使用 String config configService.getConfig(); System.out.println(Bean初始化完成加载配置 config); // 还可以做缓存初始化、数据预加载等操作 } } // 依赖的ConfigService示例 Component class ConfigService { public String getConfig() { return 数据库连接配置jdbc:mysql://localhost:3306/test; } }三、关键注意点标注的方法必须是无参数、无返回值void、非静态执行时机晚于Autowired依赖注入早于 Bean 被业务代码使用替代方案Spring 的InitializingBean接口但PostConstruct更简洁4.3 properties 缺点分析properties 配置是以key-value的形式配置的如下图所⽰从上述配置key看出properties配置⽂件中会有很多的冗余的信息⽐如这些想要解决这个问题就可以使⽤yml配置⽂件的格式化了.5. yml 配置文件说明yml 是 YAML 的缩写它的全称是Yet Another Markup Language翻译成中文就是 “另一种标记语言”。我们先来学习 yml 的语法。5.1 yml 基本语法yml 是树形结构的配置文件它的基础语法是key: value。key 和 value 之间使用英文冒号加空格的方式组成空格不可省略。基础语法如下1. 基础键值对核心语法# 正确写法冒号后必须带空格 server: port: 8080 host: localhost # 错误写法无空格配置无法解析 # server:port:80802. 数据类型# 字符串默认无需引号特殊字符需加引号 name: 张三 nickname: zhangsan:001 # 包含特殊符号时加双引号 remark: hello\nworld # 单引号会转义特殊字符\n 不会换行 # 数字 age: 20 score: 98.5 # 布尔值 enabled: true disabled: false # 空值 empty: null # 或 ~ # 日期ISO 8601 格式 birthday: 2024-03-183. 集合 / 数组两种写法# 写法1短横线 空格推荐层级清晰 user: hobbies: - 篮球 - 游泳 - 编程 # 写法2中括号简写单行 user: tags: [Java, SpringBoot, MySQL]4. 对象 / 嵌套配置# 多层嵌套SpringBoot 常用 spring: datasource: driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhost:3306/test username: root password: 123456 redis: host: 127.0.0.1 port: 6379 timeout: 5000ms5. 注释规则# 单行注释仅支持单行用 # 开头 server: port: 8080 # 端口配置行内注释也需用 # # 多行注释需每行加 # # 开发环境端口 # 生产环境可改为 80使用 yml 连接数据库yml使用示例:spring: datasource: url: jdbc:mysql://127.0.0.1:3306/dbname?characterEncodingutf8useSSLfalse username: root password: rootyml 和 properties 连接数据库的配置对比5.2 yml 使用进阶5.2.1 yml 配置不同数据类型及 null# 字符串 string.value: Hello # 布尔值true或false boolean.value: true boolean.value1: false # 整数 int.value: 10 # 浮点数 float.value: 3.14159 # Null~代表null null.value: ~ # 空字符串 #直接后面什么都不加就可以了但这种方式不直观更多的表示是使用引号括起来 empty.value: 5.2.1.1 yml 配置读取yml 读取配置的方式和 properties 相同使用Value注解即可实现代码如下yml 配置string: hello: biteJava 代码RestController public class ReadYml { Value(${string.hello}) private String hello; RequestMapping(/ymlKey) public String key(){ return 读取到值:hello; } }访问地址http://127.0.0.1:8080/ymlKey运行结果页面显示读取到值:bite5.2.1.2 注意事项value 值加单双引号字符串默认不用加上单引号或者双引号如果加英文的单双引号可以表示特殊的含义。尝试在application.yml中配置如下信息string: str1: Hello \n Spring Boot. str2: Hello \n Spring Boot. str3: Hello \n Spring Boot.读取程序实现代码如下RestController public class ReadYml { Value(${string.str1}) private String str1; Value(${string.str2}) private String str2; Value(${string.str3}) private String str3; RequestMapping(/yml) public String readYml(){ System.out.println(str1); System.out.println(str2); System.out.println(str3); return yml; } }以上程序的执行结果如下Hello \n Spring Boot. Hello \n Spring Boot. Hello Spring Boot.从上述结果可以看出字符串默认不用加上单引号或者双引号。单引号会转义特殊字符使其失去特殊功能始终是一个普通的字符串。双引号不会转义字符串里面的特殊字符特殊字符会表示本身的含义。此处的转义理解起来会有些拗口\n本意表示的是换行使用单引号会转义\n不再表示换行而是表示一个普通的字符串。使用双引号不会转义\n表示的是它本身的含义就是换行。JavaEE 的学习重在理解和使用不纠结概念和描述想要快速赋值value5.2.2 配置对象我们还可以在 yml 中配置对象如下配置student: id: 1 name: Java age: 18或者是使用行内写法与上面的写法作用一致student: {id: 1,name: Java,age: 18}这个时候就不能用Value来读取配置中的对象了此时要使用另一个注解ConfigurationProperties来读取具体实现如下import lombok.Data; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component; ConfigurationProperties(prefix student) Component Data public class Student { private int id; private String name; private int age; }调用类的实现如下RestController public class StudentController { Autowired private Student student; RequestMapping(/readStudent) public String readStudent(){ return student.toString(); } }访问地址http://127.0.0.1:8080/readStudent5.2.3 配置集合配置文件也可以配置list集合如下所示dbtypes: name: - mysql - sqlserver - db2集合的读取和对象一样也是使用ConfigurationProperties来读取的具体实现如下import lombok.Data; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component; import java.util.List; Component ConfigurationProperties(dbtypes) Data public class ListConfig { private ListString name; }访问集合的实现如下import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; RestController public class ReadYml2 { Autowired private ListConfig listConfig; RequestMapping(/readList) public String readList() { return listConfig.toString(); } }5.2.4 配置 Map配置文件也可以配置map如下所示maptypes: map: k1: kk1 k2: kk2 k3: kk3或者是使用行内写法与上面的写法作用一致maptypes: {map: {k1: kk1,k2: kk2, k3: kk3}}Map 的读取和对象一样也是使用ConfigurationProperties来读取的具体实现如下import lombok.Data; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component; import java.util.HashMap; Component ConfigurationProperties(maptypes) Data public class MapConfig { private HashMapString,String map; }打印类的实现java运行RestController public class ReadYml2 { Autowired private MapConfig mapConfig; RequestMapping(/readMap) public String readStudent() { return mapConfig.toString(); } }5.3 yml 优缺点优点可读性高写法简单易于理解支持更多的数据类型可以简单表达对象、数组、List、Map 等数据形态支持更多的编程语言不止是 Java 中可以使用在 Golang、Python、Ruby、JavaScript 中也可以使用缺点不适合写复杂的配置文件比如 properties 格式如下keycloak.realm demo keycloak.resource fm-cache-cloud keycloak.credentials.secret d4589683-0ce7-4982-bcd3 keycloak.security[0].authRoles[0] user keycloak.security[0].collections[0].name ssologinurl keycloak.security[0].collections[0].patterns[0] /login/*转换为 ymlkeycloak: realm: demo resource: fm-cache-cloud credentials: secret: d4589683-0ce7-4982-bcd3 security: - authRoles: - user collections: - name: ssologinurl patterns: - /login/*转换的过程也比较花费精力如果配置更复杂一点可读性会更差代码也会更难写对格式有较强的要求一个空格可能会引起一场血案