Spring Boot实现任意位置的properties及yml文件内容配置与获取 ...

〇、参考资料

1、Spring Boot 中文乱码问题解决方案汇总

https://blog.51cto.com/u_15236724/5372824
2、spring boot读取自定义配置properties文件★

https://www.yisu.com/zixun/366877.html
3、spring boot通过配置工厂类，实现读取指定位置的yml文件★

https://blog.csdn.net/weixin_45168162/article/details/125427465
4、springBoot 读取yml 配置文件的三种方式（包含以及非component下）★

https://blog.csdn.net/weixin_44131922/article/details/126866040
5、SpringBoot集成Swagger的详细步骤

https://blog.csdn.net/m0_67788957/article/details/123670244
一、项目介绍

1、项目框架

 
2、技术栈

 Spring Boot+Swagger+Lombok+Hutool
3、项目地址

 https://gitee.com/ljhahu/kettle_processor.git
需要权限请联系：liujinhui-ahu@foxmail.com
二、properties配置与使用

1、默认配置文件

（1）配置-application.properties

1. # Spring Boot端口配置
2. server.port=9088
3. # spring数据源配置
4. spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
5. spring.datasource.password=qaz123
6. spring.datasource.username=root
7. spring.datasource.url=jdbc:mysql://192.168.40.111:3306/visualization?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=true
8. spring.thymeleaf.prefix=classpath:/templates/

复制代码

（2）读取

Spring Boot自己会读取，配置数据源、thymeleaf等信息
 
2、自定义配置文件

（1）配置-kettle.properties

1. # properties  https://blog.csdn.net/weixin_42352733/article/details/121830775
2. environment=xuelei-www
3. kettle.repository.type=database
4. kettle.repository.username=admin
5. kettle.repository.password=admin

复制代码

（2）使用-读取单个值-PropertiesController.java

1. package com.boulderaitech.controller;
3. import com.boulderaitech.entity.KettleRepositoryBean;
4. import io.swagger.annotations.Api;
5. import io.swagger.annotations.ApiImplicitParam;
6. import io.swagger.annotations.ApiOperation;
7. import org.springframework.beans.factory.annotation.Autowired;
8. import org.springframework.beans.factory.annotation.Value;
9. import org.springframework.context.annotation.PropertySource;
10. import org.springframework.web.bind.annotation.RequestMapping;
11. import org.springframework.web.bind.annotation.RestController;
13. @Api("properties测试")
14. @RestController //Controller和RestController的区别
15. @PropertySource("classpath:kettle.properties") //默认是application.properties
16. //可以将PropertySource注解加入entity，也可以加入controller将bean注入
17. public class PropertiesController {
18.     @Value("${environment}")
19.     private String envName;
21.     @Autowired
22.     private KettleRepositoryBean kettleRepositoryBean;
24.     @RequestMapping("/getEnv")
25.     @ApiOperation("properties方式获取当前的环境")
26.     public String getEnv() {
27.         return "hello " + envName;
28.     }
29.     @ApiOperation("properties方式获取当前的环境")
30.     @RequestMapping("/getRepoInfo")
31.     public String getRepoInfo() {
32.         return "hello " + kettleRepositoryBean.toString();
33.     }
34. }

复制代码

（3）使用-读取多个值到对象-KettleRepositoryBean.java

1. package com.boulderaitech.entity;
3. import lombok.AllArgsConstructor;
4. import lombok.Data;
5. import lombok.NoArgsConstructor;
6. import org.springframework.boot.context.properties.ConfigurationProperties;
7. import org.springframework.stereotype.Component;
8. @Data
9. @Component
10. @NoArgsConstructor
11. @AllArgsConstructor
12. @ConfigurationProperties(prefix = "kettle.repository")
13. public class KettleRepositoryBean {
14.     private String type;
15.     private String username;
16.     private String password;
17. }

复制代码

三、yml配置

1、默认配置文件

application.yml
2、自定义配置文件

（1）配置-repository.yml

1. kettle:
2.   repository:
3.     repo1:
4.       type: postgresql
5.       ip_addr: 192.168.4.68
6.       port: 5432
7.       username: admin
8.       password: admin
9.       db_name: kettle
10.   version: 8.0.0

复制代码

（2）实现任意位置读取的工厂类-YamlConfigFactory.java

1. package com.boulderaitech.factory;
3. import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
4. import org.springframework.core.env.PropertiesPropertySource;
5. import org.springframework.core.env.PropertySource;
6. import org.springframework.core.io.support.DefaultPropertySourceFactory;
7. import org.springframework.core.io.support.EncodedResource;
9. import java.io.IOException;
10. import java.util.Properties;
12. /**
13. * 在任意位置读取指定的yml文件
14. * 参考：https://blog.csdn.net/weixin_45168162/article/details/125427465
15. */
16. public class YamlConfigFactory extends DefaultPropertySourceFactory {
17.     //继承父类，可以重载父类方法@Override
18.     //实现接口，重写方法@Override
19.     @Override
20.     public PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException {
21.         String sourceName = name != null ? name : resource.getResource().getFilename();
22.         if (!resource.getResource().exists()) {
23.             return new PropertiesPropertySource(sourceName, new Properties());
24.         } else if (sourceName.endsWith(".yml") || sourceName.endsWith(".yaml")) {
25.             Properties propertiesFromYaml = loadYml(resource);
26.             return new PropertiesPropertySource(sourceName, propertiesFromYaml);
27.         } else {
28.             return super.createPropertySource(name, resource);
29.         }
30.     }
31.     private Properties loadYml(EncodedResource resource) throws IOException {
32.         YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
33.         factory.setResources(resource.getResource());
34.         factory.afterPropertiesSet();
35.         return factory.getObject();
36.     }
37. }

复制代码

（3）使用-读取单个值-KettleEnvBean.java

1. package com.boulderaitech.entity;
3. import com.boulderaitech.factory.YamlConfigFactory;
4. import lombok.AllArgsConstructor;
5. import lombok.Data;
6. import lombok.NoArgsConstructor;
7. import org.springframework.beans.factory.annotation.Value;
8. import org.springframework.context.annotation.PropertySource;
9. import org.springframework.stereotype.Component;
11. @Data
12. @Component
13. @AllArgsConstructor
14. @NoArgsConstructor
15. @PropertySource(value = "classpath:repository.yml",factory = YamlConfigFactory.class)//需要通过工厂加载指定的配置文件
16. public class KettleEnvBean {
17.     @Value("${kettle.version}")
18.     private String kettleVersion;
19. }

复制代码

（4）使用-读取多个值到对象-KettleRepositoryYmlBean.java

1. package com.boulderaitech.entity;
3. import com.boulderaitech.factory.YamlConfigFactory;
4. import lombok.AllArgsConstructor;
5. import lombok.Data;
6. import lombok.NoArgsConstructor;
7. import org.springframework.boot.context.properties.ConfigurationProperties;
8. import org.springframework.context.annotation.PropertySource;
9. import org.springframework.stereotype.Component;
11. @Data
12. @AllArgsConstructor
13. @NoArgsConstructor
14. @PropertySource(value = "classpath:repository.yml",factory = YamlConfigFactory.class)//需要通过工厂加载指定的配置文件
15. @ConfigurationProperties(prefix = "kettle.repository.repo1") //需要添加spring boot的注解，才可以使用
16. //思考：能否通过反射操作修改注解的参数
17. @Component()
18. public class KettleRepositoryYmlBean {
19.     private String type;
20.     private String ip_addr; //命名只能用下划线
21.     private String username;
22.     private String password;
23.     private String port;
24.     private String db_name;
25. }

复制代码

（5）使用-YmlController.java

1. package com.boulderaitech.controller;
3. import com.boulderaitech.entity.KettleEnvBean;
4. import com.boulderaitech.entity.KettleRepositoryYmlBean;
5. import org.springframework.beans.factory.annotation.Autowired;
6. import org.springframework.beans.factory.annotation.Value;
7. import org.springframework.context.annotation.PropertySource;
8. import org.springframework.stereotype.Controller;
9. import org.springframework.web.bind.annotation.GetMapping;
10. import org.springframework.web.bind.annotation.RequestMapping;
11. import org.springframework.web.bind.annotation.RequestMethod;
12. import org.springframework.web.bind.annotation.RestController;
14. @RestController //使用controller返回的结果会按照template进行解析
15. //使用RestController则会返回对应的字符串
16. public class YmlController {
17.     @Autowired
18.     private KettleRepositoryYmlBean kettleRepositoryYmlBean;
20.     @Autowired
21.     private KettleEnvBean kettleEnvBean;
23.     @RequestMapping(value = "/getKettleVersion") //默认是get
24.     public String getKettleVersion() {
25.         return "hello " + kettleEnvBean.getKettleVersion();
26.     }
28.     // @GetMapping("/getRepoInfoYml")，不支持get方法
29.     //@RequestMapping(value = "/getRepoInfoYml", method = RequestMethod.POST)
30.     @RequestMapping(value = "/getRepoInfoYml")
31.     public String getRepoInfoYml() {
32.         return "hello " + kettleRepositoryYmlBean.toString();
33.     }
34. }

复制代码

 

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！