SpringBoot 学习笔记二 配置文件详解

在创建SpringBoot项目时，工程会自动创建一个application.properties，或者application.yml，两种文件格式都支持，这里用application.yml，加入以下配置，注意空格

1. 引入依赖

        <!-- web 使项目拥有web功能，该包自动依赖了springweb，MVC等包，可以点进去查看 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
      <!-- 要使用ConfigurationProperties注解来读取外部配置文件属性的话必须引入该依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

2. 新建application.yml

输入内容如下，yml语法不知道的可以百度一下

person:
  name: 殷俊杰
  age: 18
  habits:
    - watch movies
    - play hhh
  schools: { high: 县三,university: 河南科技学院}
  dog:
    name: 二哈
    age: 2

pname: springboot练习

3. 新建Person类对应person的各项属性

ConfigurationProperties注解表示从配置文件读取属性值，prefix表示只读取person的属性，该配置类必须标明为一个组件注入到容器中

@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    private String name;
    private Integer age;
    private List habits;
    private Map schools;
    private Dog dog;

    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", habits=" + habits +
                ", schools=" + schools +
                ", dog=" + dog +
                '}';
    }
}

Dog类如下

public class Dog {
    private String name;
    private Integer age;

    @Override
    public String toString() {
        return "Dog{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

4. 该方式也可以从单独的properties文件中读取配置，yml也可以

新建一个cat.properties文件输入内容如下

cat.name=喵喵喵
cat.age=3
cat.email=dlsjkfklajsierwt

5. 新建Cat类

@Component
//由于该类的属性是从单独的配置文件中读取，并不是spring默认的配置文件所以需要一个PropertySource属性指定配置文件
@PropertySource("classpath:cat.properties")
@ConfigurationProperties(prefix = "cat")
@Validated
public class Cat {

    private String name;
    private Integer age;
//    @Email
    private String email;

    @Override
    public String toString() {
        return "Cat{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", email='" + email + '\'' +
                '}';
    }
}

6. 新建controller进行测试

package com.yjj.web;

import com.yjj.config.Cat;
import com.yjj.config.Person;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.constraints.Email;

/**
 * @Description:
 * @Author: yinjunjie
 * @CreateDate: 2018/7/11 16:13
 * @Version: 1.0
 */
@RestController
@RequestMapping("test")
public class TestController {

    @Autowired
    private Person person;
    @Autowired
    private Cat cat;

    @Value("${pname}")
    @Email
    private String projectName;
    //#可以使用spring表达式SpEl
    @Value("#{cat.getEmail()}")
    private String catEmail;
    @Value("#{100/2}")
    private Integer num;

    @GetMapping("/person")
    public String getPerson(){
        System.out.println(person);
        System.out.println(cat);
        System.out.println(projectName);
        System.out.println(catEmail);
        System.out.println(num);
        return "ok";
    }
}

以上代码均经过测试，准确输出

注意：
1. 使用ConfigurationProperties注解时必须在启动类或者Controller类上加入EnableAutoConfiguration注解表示开启自动配置功能
2. #可以使用SpEl表达式语法
3. @Value不支持JSR303数据校验，比如Email校验，使用@ConfigurationProperties时候如果属性值不符合要求会报错，但是@Value没反应，不做校验

7. @Value获取值和@ConfigurationProperties获取值比较

内容	@ConfigurationProperties	@Value
功能	批量注入配置文件中的属性	一个个指定
松散绑定(松散语法)	支持	不支持
SpEL	不支持	支持
JSR303数据校验	支持	不支持
复杂类型封装map、list等	支持	不支持

如果不是单独做一个配置文件bean的话，在controller或者service中，读取属性值只需要在属性上加上
@Value注解即可

8. 配置文件属性可以用${属性名}来引用

如果为空可以用${属性名:默认值}来指定默认值,不再演示

9. 多环境配置文件

在现实的开发环境中，我们需要不同的配置环境；格式为application-{profile}.properties，其中{profile}对应你的环境标识，比如：application.yml中加入如下配置

spring:
  profiles:
    active: dev

新建application-dev.yml

server:
  port: 8082

然后启动项目发现已经运行在8082端口啦，好神奇 哈哈哈

多环境配置文件可以使用多种方式实现，可以在默认properties文件中指定spring.profiles.active=dev
也可在yml中分块，也可在idea的Program arguments里写–spring.profiles.active=dev
也可以在idea的VM options中写-Dspring.profiles.active=dev

10. 配置文件默认加载位置优先级

springboot启动会扫描一下位置的application.properties或者application.yml文件
-file:./config/
-file:./
-classpath:/config/
-classpath:/
由高到低，高优先级配置会覆盖低优先级配置，springboot会加载全部的配置，然后互补配置，高优先级的用高优先级的，低优先级的如果在高优先级不存在则也会生效
我们还可以通过spring.config.location=. 来指定配置文件位置，不过必须使用命令行参数的形式，指定配置文件和默认配置文件会一起被加载然后互补配置。

11.配置bean的几种方式

可参考我的csdn文章
https://blog.csdn.net/yinjune/article/details/79843755