最佳实践之SpringBoot.2.X里面的配置文件-EW帮帮网

1 带你看SpringBoot2.x常见配置文件形式

简介：SpringBoot2.x常见的配置文件形式 xml、yml、properties的区别和使用

常见的配置文件格式
```
xml、properties、json、yaml
```
Springboot里面常用xx.yml
- YAML（Yet Another Markup Language）
- 写 YAML 要比写 XML 快得多(无需关注标签或引号) 使用空格 Space 缩进表示分层，不同层次之间的缩进可以使用不同的空格数目
- 注意：key后面的冒号，后面一定要跟一个空格,树状结构
```
server:
  port: 8080  //设置启动端口号为8080
  
house:
  family:
    name: Doe
    parents:
      - John
      - Jane
    children:
      - Paul
      - Mark
      - Simone
  address:
    number: 34
    street: Main Street
    city: Nowheretown
    zipcode: 12345
```

Springboot里面常用 xx.properties（推荐）

Key=Value格式
语法简单，不容易出错

server.port=8082

#session失效时间，30m表示30分钟
server.servlet.session.timeout=30m

# Maximum number of connections that the server accepts and processes at any given time.
server.tomcat.max-connections=10000 

# Maximum size of the HTTP post content.
server.tomcat.max-http-post-size=2MB 
server.tomcat.max-http-form-post-size=2MB


# Maximum amount of worker threads
server.tomcat.max-threads=200

官方文档配置
- https://docs.spring.io/spring-boot/docs/2.3.0.BUILD-SNAPSHOT/reference/htmlsingle/#core-properties
- 如果需要修改，直接复制对应的配置文件加到application.properties里面，一般不需要调整

若创建项目无resources文件可参考以下文章：【报错】新建springboot项目时缺少resource_springboot没有resource-CSDN博客

2 新版SpringBoot注解配置文件映射属性和实体类实战

简介：讲解使用@value注解配置文件自动映射到属性和实体类

配置文件加载
- 方式一
  - 1、Controller上面配置 @PropertySource({"classpath:resource.properties"})
  - 2、增加属性 @Value("${test.name}") private String name;
- 方式二：实体类配置文件
  - 1、添加 @Component 注解；
  - 2、使用 @PropertySource 注解指定配置文件位置；
  - 3、使用 @ConfigurationProperties 注解，设置相关属性；
  - 4、必须通过注入IOC对象Resource 进来，才能在类中使用获取的配置文件值。
    
    @Autowired private ServerSettings serverSettings;
```
例子：
```
```
@Configuration
@ConfigurationProperties(prefix="test")
@PropertySource(value="classpath:resource.properties")
public class ServerConstant {

}
```
@ConfigurationProperties(prefix = "test") 是 Spring Boot 中一个非常有用的注解，主要用于将配置文件中的属性值绑定到一个 Java 类上。

作用:
属性绑定：它允许你将配置文件（如 application.properties 或 application.yml）中以指定前缀（这里是 test）开头的属性，自动绑定到标注了该注解的 Java 类的属性上。这使得配置和代码之间的映射更加清晰和便捷，尤其适用于管理一组相关的配置属性。

优点
类型安全：通过将配置属性绑定到 Java 类，利用 Java 的类型系统确保属性类型的正确性。例如，如果在配置文件中 test.age 设置为非数字值，Spring Boot 在启动时会抛出异常，提示类型转换错误，从而避免运行时错误。
代码清晰：将相关的配置属性集中管理在一个类中，使代码结构更加清晰，易于维护。同时，也方便对配置属性进行分组和组织，提高了代码的可读性。
灵活配置：可以在不同的环境（开发、测试、生产）使用不同的配置文件，而代码无需修改。只需要在不同的配置文件中调整 test 前缀下的属性值，Spring Boot 会自动加载相应的配置。





常见问题：

1、配置文件注入失败，Could not resolve placeholder
解决：根据springboot启动流程，会有自动扫描包没有扫描到相关注解, 
默认Spring框架实现会从声明@ComponentScan所在的类的package进行扫描，来自动注入，
因此启动类最好放在根路径下面，或者指定扫描包范围
spring-boot扫描启动类对应的目录和子目录

2、注入bean的方式，属性名称和配置文件里面的key一一对应，就用加@Value 这个注解
如果不一样，就要加@value("${XXX}")

最佳实践之SpringBoot.2.X里面的配置文件

1 带你看SpringBoot2.x常见配置文件形式

2 新版SpringBoot注解配置文件映射属性和实体类实战

网站公告

今日签到

热门文章

最新发布