目录
1.前言
哈喽大家好吖，在Spring Boot项目中，配置文件是连接代码与环境的桥梁，直接影响着应用的可维护性和扩展性。面对传统的Properties格式与新兴的YAML格式，开发者该如何选择？它们的语法差异是什么？如何高效读取复杂配置？本文将从基础语法、数据类型支持、配置读取方式、对象/集合映射等维度，深入解析两种配置文件的特性，并结合实际代码演示，助你在项目中做出最合理的技术选型！
2.正文
2.1配置文件的格式
在Spring框架中，配置文件是应用程序的重要组成部分，它允许我们将配置信息从代码中分离出来，实现配置与代码的松耦合。Spring支持多种配置文件格式，其中最常用的两种是：
**
.properties文件：**传统的键值对格式**
.yml或.yaml文件：**基于缩进的层次结构格式
这两种格式各有优缺点，开发者可以根据项目需求和个人偏好进行选择。接下来我们将详细探讨这两种配置格式的特点和使用方法。
2.2properties
2.2.1基础语法
Properties 文件 是 Spring Boot 中最传统的配置文件格式，采用简单的 键值对（Key-Value） 形式定义配置，语法清晰但灵活性较低。以下是核心语法规则和示例：
键值对格式：
每行定义一个配置项，格式为
key=value。
key是配置项的唯一标识，支持.分隔的层级命名（如db.url）。
value可以是字符串、数字、布尔值等，默认按字符串处理。
java# 示例：数据库配置 db.url=jdbc:mysql://localhost:3306/test db.username=root db.password=123456
注释：
使用
#或!开头添加注释，解释配置用途：
java# 服务器端口配置 server.port=8080 ! 开发环境开关 dev.mode=true
特殊字符处理：
若
value包含空格、等号或冒号，需用反斜杠\转义：
javaerror.message=参数\ 不能为空！ special.symbol=key\=valueUnicode 字符支持：非 ASCII 字符（如中文）需转换为 Unicode 编码：
javagreeting=\u4F60\u597D（表示"你好"）
2.2.2value读取配置文件
在 Spring 中，可通过 @Value 注解或 Environment 对象直接读取配置值。
1.@Value 注解
直接在字段上使用
@Value("${key}")注入配置值。支持设置默认值（当配置项不存在时生效）：
java@Component public class DatabaseConfig { @Value("${db.url:jdbc:mysql://default}") // 默认值 private String url; @Value("${db.username}") private String username; }
2.Environment 对象
注入
Environment对象，通过getProperty()动态获取配置：
java@Autowired private Environment env; public void printConfig() { String password = env.getProperty("db.password"); Integer port = env.getProperty("server.port", Integer.class); // 自动类型转换 }
3.类型转换
非字符串类型（如整数、布尔值）需手动转换：
java@Value("${server.port}") private int port; // Spring 自动转换为 int 类型 @Value("${feature.enabled:false}") // 默认值 false private boolean isEnabled;
2.2.3缺点
尽管 Properties 格式简单易用，但在复杂项目中存在明显短板：
1.层级结构缺失
所有配置项平铺展示，缺乏逻辑分组。
对比示例：
java# Properties 格式 user.name=Alice user.age=25 user.address.city=Beijing
java# yml 等效配置（结构更清晰） user: name: Alice age: 25 address: city: Beijing
2.重复前缀冗余
相同前缀的配置需重复书写，导致冗余：
javaredis.cache.host=127.0.0.1 redis.cache.port=6379 redis.cache.timeout=30
3.复杂类型支持不足
无法直接定义集合或对象，需手动拆分或借助特殊格式：
java# 列表需用逗号分隔，代码中需手动解析 server.ports=8080,8081,8082 # 对象需拆分为多个键值对 book.title=Spring Guide book.author=John Doe
2.3yml
2.3.1基础语法
YAL是一种以层级缩进为核心的配置文件格式，语法简洁且可读性强。以下是核心规则：
层级结构
使用 空格缩进 表示层级关系（禁止用 Tab 键）。
同一层级的元素左对齐，缩进空格数需一致。
javaserver: port: 8080 # 正确：server 下的子层级缩进 2 空格 servlet: context-path: /api # servlet 的子层级继续缩进
键值对
键与值之间用
:分隔，冒号后必须加 一个空格。字符串默认不加引号，特殊字符（如
:、#）可用双引号包裹。
javaname: Spring Boot # 普通字符串 version: "3.2.0" # 引号可省略，但推荐明确 message: "Hello:World" # 包含冒号，需用引号
注释
单行注释以
#开头。
java# 服务器配置 server: port: 8080 # 开发环境端口
多行文本
用
|保留换行符，或用>折叠换行符。
javadescription: | # 保留换行 This is a multi-line text. summary: > # 折叠为一行（换行符转空格） This is a single-line text.
2.3.2配置不同数据类型
YML 自动识别数据类型，无需手动转换，支持以下常见类型：
字符串
javapath: /api/v1 # 普通字符串 error: "Error: 404\nPage not found." # 包含冒号和换行符默认不加引号，特殊字符用双引号包裹（支持转义符如
\n）。数值
javaint: 100 float: 3.14 scientific: 6.022e23 # 科学计数法整数、浮点数直接书写，支持科学计数法。
布尔值
javaenabled: true debug-mode: False # 实际解析为 false使用
true/false（不区分大小写）。日期
javacreate-date: 2023-10-01 # 日期 timestamp: 2023-10-01T12:00:00+08:00 # 日期时间遵循 ISO 8601 格式，如
yyyy-MM-dd。null 值
javadescription: null value: ~用
null或~表示。
2.3.3配置读取
YML 配置的读取方式与 Properties 类似，但更推荐对象绑定以发挥层级优势。
@Value 注解
java@Value("${server.port}") private int port; @Value("${user.name}") private String userName;直接注入单个配置值（与 Properties 一致）。
@ConfigurationProperties 绑定对象
java# YML 配置 database: url: jdbc:mysql://localhost/test username: root pool-size: 10
java@Component @ConfigurationProperties(prefix = "database") public class DatabaseConfig { private String url; private String username; private int poolSize; // 支持驼峰命名自动匹配（pool-size → poolSize） // Getter & Setter }将层级配置映射到 Java 对象的字段，适合复杂配置。
Environment 对象
java@Autowired private Environment env; public void readConfig() { String url = env.getProperty("database.url"); int poolSize = env.getProperty("database.pool-size", Integer.class); }动态获取配置值，支持类型转换。
2.3.4配置对象和集合
YML 天然支持复杂数据结构的定义，无需拆分键名。
对象嵌套
javauser: name: Alice age: 25 address: # 嵌套对象 city: Beijing street: ZhongguancunJava 实体类绑定：
java@ConfigurationProperties(prefix = "user") public class User { private String name; private int age; private Address address; // 内部类 Address 需定义 city 和 street 字段 }通过缩进表示对象层级。
集合（List 和 Map）
java# List 示例 servers: - 192.168.1.1 - 192.168.1.2 # Map 示例（两种写法等效） config: properties: key1: value1 key2: value2 # 或 properties: {key1: value1, key2: value2}Java 实体类绑定：
java@ConfigurationProperties(prefix = "servers") public class ServerList { private List<String> servers; // 自动映射 List } @ConfigurationProperties(prefix = "config") public class AppConfig { private Map<String, String> properties; // 自动映射 Map }List ：用
-表示列表项。Map ：直接写键值对或使用
{}。
2.3.5优缺点
优点：
结构清晰：层级缩进直观展示配置关系，适合复杂业务场景。
类型丰富：自动识别字符串、数值、布尔值、日期等类型。
代码简洁 ：通过
@ConfigurationProperties一键绑定对象，减少冗余代码。多行文本支持：无需拼接符即可定义长文本。
缺点：
缩进敏感：缩进错误（如混用空格和 Tab）会导致解析失败。
兼容性限制：旧版本 IDE 或工具可能不支持 YAML（需安装插件）。
学习成本：对新手来说，层级规则和语法细节需时间熟悉。
2.4综合练习：验证码案例
https://gitee.com/crjs-hao/springboot/tree/master/src/main/java/captcha2.4.1分析需求
- 页面生成验证码。
- 输入验证码，点击提交，验证用户输入验证码是否正确，正确则进行页面跳转。
2.4.2接口
1. 生成验证码
请求URL ：
/captcha/getCaptcha
响应 ：验证码图片内容
说明 ：浏览器向服务器发送/captcha/getCaptcha请求，服务器返回验证码图片并在浏览器页面显示。
2. 校验验证码是否正确
请求URL ：
/captcha/check
请求参数 ：captcha=xn8d
参数说明 ：captcha为用户输入的验证码。
响应 ：true或false
说明 ：根据用户输入的验证码校验是否正确，true表示验证成功，false表示验证失败。
2.4.3介绍hutool
官方文档：简介 | Hutool
特点：
✅ 简单易用 ：方法命名直观，API 设计友好，降低学习成本。
✅ 功能全面 ：涵盖 Java 开发中的常见工具需求，减少依赖第三方库。
✅ 高性能 ：优化底层实现，避免重复造轮子。
✅ 模块化设计：可按需引入特定模块，避免项目臃肿。
maven引入依赖：
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.8.16</version> <!-- 使用最新版本 -->
</dependency>2.4.4代码实现
代码结构：
先配置好yml文件：
java
spring:
application:
name: springboot
captcha:
width: 150
height: 50
session:
key: CAPTCHA_SESSION_KEY
date: CAPTCHA_SESSION_DATE2.4.4.1后端实现
java
@RequestMapping("/captcha")
@RestController
public class CaptchaController {
@Autowired
private CaptchaPropertities captchaPropertities;
private final static Long VALID_TIME = 30 * 60 * 1000L;
@RequestMapping("/getCaptcha")
public void getCaptcha(HttpServletResponse response, HttpSession session){
response.setContentType("image/jpg");
response.setCharacterEncoding("utf-8");
//生成验证码
try {
ShearCaptcha captcha = CaptchaUtil.createShearCaptcha(captchaPropertities.getWidth(), captchaPropertities.getHeight());
String code = captcha.getCode();
session.setAttribute(captchaPropertities.getSession().getKey(), code);
session.setAttribute(captchaPropertities.getSession().getDate(), new Date());
captcha.write(response.getOutputStream());
} catch (IOException e) {
e.printStackTrace();
}
// }finally {
// response.getOutputStream().close();
// }
}
/**
* 验证用户输入的验证码是否正确
* @param captcha: 用户输入的验证码
* @param session
* @return false: 校验失败, true: 成功
*/
@RequestMapping("/check")
public boolean check(String captcha,HttpSession session){
if(!StringUtils.hasLength(captcha)){
return false;
}
String code = (String) session.getAttribute(captchaPropertities.getSession().getKey());
Date date = (Date) session.getAttribute(captchaPropertities.getSession().getDate());
//验证码正确且没有过期
if(captcha.equalsIgnoreCase(code) && date != null && System.currentTimeMillis() - date.getTime() < VALID_TIME){
return true;
}
return false;
}
}1. 验证码生成流程 (
/getCaptcha)
初始化响应
- 设置响应类型为图片 (
image/jpg) 和字符编码 (utf-8)。生成验证码
使用 Hutool 的
ShearCaptcha工具生成指定宽高的图形验证码。获取验证码文本 (
code) 并存入 Session，同时记录生成时间。返回验证码图片
- 将验证码图片写入响应输出流，供前端显示。
异常处理
- 捕获并打印
IOException，确保生成失败时不影响程序运行。
2. 验证码校验流程 (
/check)
参数检查
- 检查用户输入的验证码是否为空，若空则直接返回
false。Session 验证
- 从 Session 中获取存储的验证码文本 (
code) 和生成时间 (date)。校验逻辑
验证码正确性：忽略大小写比较用户输入与 Session 中的验证码。
时效性检查：验证码需在有效期内（30 分钟内）。
返回结果
- 若验证码正确且未过期，返回
true；否则返回false。
3. 关键设计点
Session 存储：验证码文本和生成时间通过 Session 共享，确保安全性和状态管理。
时效控制 ：通过
VALID_TIME（30 分钟）限制验证码有效期，增强安全性。工具库集成 ：利用 Hutool 的
CaptchaUtil快速生成图形验证码，简化开发。
java
package captcha.model;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
@ConfigurationProperties(prefix = "captcha")
@Configuration
@Data
public class CaptchaPropertities {
private Integer width;
private Integer Height;
private Session session;
@Data
public static class Session{
private String key;
private String date;
}
}1. 核心作用
这是一个基于Spring Boot的配置属性绑定类，主要功能是：
集中管理验证码相关的所有配置参数
实现配置与代码的分离，提高灵活性和可维护性
2. 关键设计
配置绑定
使用
@ConfigurationProperties注解绑定配置文件中的属性
prefix="captcha"表示所有配置以captcha为前缀配置分组
主配置项：验证码图片的
width和Height嵌套配置：通过内部类
Session管理session相关的配置项自动配置
@Configuration使该类成为Spring配置类
@Data自动生成getter/setter等方法
2.4.4.2前端核心实现
html
<script>
$("#Img").click(function () {
$(this).hide().attr('src', '/captcha/getCaptcha?dt=' + new Date().getTime()).fadeIn();
});
$("#checkCaptcha").click(function () {
$.ajax({
type: "post",
url: "/captcha/check",
data: {
captcha: $("#inputCaptcha").val()
},
success: function(result){
if(result){
location.href = "success.html";
}else {
alert("验证码错误, 请重新输入");
}
}
});
});
</script>1. 验证码刷新功能
实现方式：
通过jQuery的
click事件绑定图片点击事件点击时先隐藏图片，然后修改src属性（添加时间戳防止缓存），最后淡入显示
技术要点：
使用
new Date().getTime()添加时间戳参数，强制浏览器重新请求图片
hide()和fadeIn()实现平滑的视觉过渡效果2. 验证码校验功能
实现方式：
通过AJAX POST请求发送用户输入的验证码到服务端校验
根据返回结果进行页面跳转或错误提示
技术要点：
使用jQuery的
$.ajax方法发送异步请求成功回调中根据服务端返回的布尔值进行不同处理
location.href实现验证成功后的页面跳转3. 整体交互流程
用户点击验证码图片 → 刷新验证码
用户输入验证码并点击校验按钮 → 发送AJAX请求
服务端返回校验结果 → 前端根据结果跳转或提示
4. 安全性考虑
时间戳参数防止浏览器缓存验证码图片
POST请求方式避免验证码出现在URL中
服务端校验结果决定后续操作
3.小结
今天的分享到这里就结束了，喜欢的小伙伴点点赞点点关注，需要所有的源代码可以去我的gitee上就可以啦~你的支持就是对我最大的鼓励，大家加油！
另外最后的最后，欢迎大家加入我的社区哦，初创社区难免经验不足，请大家多多包涵，也欢迎大家前来多多交流。