第十章、配置文件和自动注入讲解(SpringBoot2.x)

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

        xml、properties、json、yaml
        1、常见的配置文件 xx.yml, xx.properties，
            1)YAML（Yet Another Markup Language）
                写 YAML 要比写 XML 快得多(无需关注标签或引号)
                使用空格 Space 缩进表示分层，不同层次之间的缩进可以使用不同的空格数目
                注意：key后面的冒号，后面一定要跟一个空格,树状结构
            application.properties示例

server.port=8090
server.session-timeout=30
server.tomcat.max-threads=0
server.tomcat.uri-encoding=UTF-8 

            application.yml示例

server:  
	port: 8090  
	session-timeout: 30 
	tomcat.max-threads: 0 
	tomcat.uri-encoding: UTF-8

        2、默认示例文件仅作为指导。 不要将整个内容复制并粘贴到您的应用程序中，只挑选您需要的属性。
        
        3、参考：https://docs.spring.io/spring-boot/docs/2.1.0.BUILD-SNAPSHOT/reference/htmlsingle/#common-application-properties

        如果需要修改，直接复制对应的配置文件，加到application.properties里面
-----------------------------------------------------------------------------------------------

简介：讲解使用@value注解配置文件自动映射到属性和实体类
            
    1、配置文件加载
        方式一
            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 {

            常见问题：
                1、配置文件注入失败，Could not resolve placeholder
                    解决：根据springboot启动流程，会有自动扫描包没有扫描到相关注解, 
                    默认Spring框架实现会从声明@ComponentScan所在的类的package进行扫描，来自动注入，
                    因此启动类最好放在根路径下面，或者指定扫描包范围
                    spring-boot扫描启动类对应的目录和子目录
                2、注入bean的方式，属性名称和配置文件里面的key一一对应，就用加@Value 这个注解
                    如果不一样，就要加@value("${XXX}")

----------------------------------------------------------------------------------------

映射到属性

测试代码，在之前的上传中注入application.properties中定义的上传路径

----------------------------------------------------------------------------------------

映射到实体类

application.properties文件：

实体类：

package net.xdclass.demo.domain;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

//服务器配置

@Component
@PropertySource({"classpath:application.properties"})
@ConfigurationProperties(prefix = "test")//使用了前缀就不能使用@Value再次注入
public class ServerSettings {
	//名称
	private String name;
	//域名地址
	private String domain;

测试类：

@Autowired
private ServerSettings serverSettings;
@GetMapping(value = "/v1/test_properties")
public Object testProperties(){
	
	return serverSettings;
}

在浏览器中访问：http://localhost:8080/v1/test_properties

页面显示如下：

注意事项：该案例SpringBoot版本 2.2.1，在某个类中使用@ConfigurationProperties注解来和配置文件（application.yml或者application.properties）中的属性进行绑定的时候，会出现警告：

When using @ConfigurationProperties it is recommended to add 'spring-boot-configuration-processor' to your classpath to generate configuration metadata

解决办法:在pom.xml文件加入：

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-configuration-processor</artifactId>
	<optional>true</optional>
</dependency>

额外补充知识点：@value和@ConfigurationProperties对比