解决@ConfigurationProperties注解的使用及乱码问题

目录

@ConfigurationProperties解决方法第二种不推荐写法

@ConfigurationProperties

作用：用于获取配置文件中的属性定义并绑定到javaBean属性中
举个栗子：
配置文件

1. mycar.name=徐昂
2. mycar.price=18w

复制代码

定义实体类

1. package com.maggie.demo.entity;
3. import lombok.Data;
4. import org.springframework.boot.context.properties.ConfigurationProperties;
5. import org.springframework.stereotype.Component;
7. @Data   //生成setget方法
8. @Component //将此类注册为组件
9. @ConfigurationProperties(prefix = "mycar",ignoreUnknownFields = true) //配置文件属性读取，读取前缀时mycar的,忽略不存在的字段
10. public class Car {
11.     private String name;
12.     private String  price;
13.     @Override
14.     public String toString() {
15.         return "Car{" +
16.                 "name='" + name + '\'' +
17.                 ", price='" + price + '\'' +
18.                 '}';
19.     }
20. }

复制代码

启动类输出验证

1. package com.maggie.demo;
3. import com.maggie.demo.entity.Car;
4. import org.springframework.boot.SpringApplication;
5. import org.springframework.boot.autoconfigure.SpringBootApplication;
6. import org.springframework.context.ConfigurableApplicationContext;
8. import java.io.IOException;
10. @SpringBootApplication
11. public class DemoApplication {
13.         public static void main(String[] args) throws IOException {
14.                 ConfigurableApplicationContext run = SpringApplication.run(DemoApplication.class, args);
15.                 Car car = run.getBean(Car.class);
16.                 System.out.println(car.toString());
17.         }
18. }

复制代码

输出结果

Car{name='', price='18w'}

产生问题，定义中文时，会产生乱码

解决方法

1，将配置文件换成yml文件，则不会产生乱码问题

1. mycar:
2.   name: '徐昂'
3.   price: '18w'

复制代码

2, 覆盖原文件：org.springframework.boot.env.OriginTrackedPropertiesLoader
将OriginTrackedPropertiesLoader所有代码复制出来，按照包路径建立自己的包和类（包名和类名都必须和原来的一致，不然不生效）

然后找出原来的OriginTrackedPropertiesLoader上的编码片段：

1.         CharacterReader(Resource resource) throws IOException {
2.             this.reader = new LineNumberReader(new InputStreamReader(resource.getInputStream(), StandardCharsets.ISO_8859_1));
3.         }

复制代码

将其改为 : StandardCharsets.UTF_8

1.     CharacterReader(Resource resource) throws IOException {
2.             this.reader = new LineNumberReader(new InputStreamReader(resource.getInputStream(), StandardCharsets.UTF_8));
3.         }

复制代码

重启项目，发现项目中文乱码已经解决

1. Car{name='徐昂', price='18w'}

复制代码

3, 自定义配置类

配置类

1. mycar.name=小汽车
2. mycar.price=18w

复制代码

定义实体,添加**@PropertySource**注解，指定字符集取utf-8,并指定读取配置文件的路径。
注意：这种方法只能对自定义的properties文件有效，对于spring boot默认生成的application.properties没有效果

1. @Data   //生成setget方法
2. @Component //将此类注册为组件
3. //指定字符集，并且指定读取的配置文件
4. @PropertySource(encoding = "UTF-8", value = "classpath:car.properties", ignoreResourceNotFound = true)
5. @ConfigurationProperties(prefix = "mycar",ignoreUnknownFields = true) //配置文件属性读取，读取前缀是mycar的
6. public class Car {
7.     private String name;
8.     private String  price;
10.     @Override
11.     public String toString() {
12.         return "Car{" +
13.                 "name='" + name + '\'' +
14.                 ", price='" + price + '\'' +
15.                 '}';
16.     }
17. }

复制代码

结果：

Car{name='小汽车', price='18w'}

第二种不推荐写法

@ConfigurationProperties+ @EnableConfigurationProperties
@EnableConfigurationProperties作用：开启组件配置绑定功能，将实体类组件注入到容器中
eg：

1. mycar.name=小汽车
2. mycar.price=18w

复制代码

实体类

1. package com.maggie.demo.entity;
3. import lombok.Data;
4. import org.springframework.boot.context.properties.ConfigurationProperties;
5. import org.springframework.stereotype.Component;
7. @Data   //生成setget方法
8. @ConfigurationProperties(prefix = "mycar",ignoreUnknownFields = true) //配置文件属性读取，读取前缀时mycar的,忽略不存在的字段
9. public class Car {
10.     private String name;
11.     private String  price;
12.     @Override
13.     public String toString() {
14.         return "Car{" +
15.                 "name='" + name + '\'' +
16.                 ", price='" + price + '\'' +
17.                 '}';
18.     }
19. }

复制代码

配置类

1. @Configuration //配置类注解 ==配置文件
2. @EnableConfigurationProperties(Car.class) //开启加载配置类
3. public class BeansConfiguration {
5. }

复制代码

以上为个人经验，希望能给大家一个参考，也希望大家多多支持中国红客联盟。