SpringBoot-配置

一、创建项目

采用Spring Initializr的方式创建

选择需要的相关模块，他会自动写好依赖

springboot由于是内嵌的Tomcat，所以提供了一个主程序启动应用

springboot的目录结构

二、配置相关

1.配置文件(修改SpringBoot自动配置的默认值)

springboot使用一个全局的配置文件，配置文件名是固定的

1. application.properties
2. application.yml

application.properties格式（以修改端口为例）

server.port=8081

application.yml格式

server:
	port: 8081
#冒号后面有一个空格

2.yml语法

（1）基本语法

格式：k：（空格）v：表示一对键值对
以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的

（2）值的写法

1.字面量直接来写（数字，字符串，布尔）

• 字符串默认不加单引号或者双引号
• “”：双引号，不会转义特殊字符
• ‘’：单引号，会转义特殊字符
  日期写法

person.birth: 1996/12/24 13:56:12

2.对象或者map写法

• k：v写法

 user：
 	name： tom
 	age：18

• 行内写法

user： {name： tom，age： 18}

3.数组（list，set）写法

• k: v写法：用-（空格）值表示数组中的一个值

pets：
 - cat
 - dog

• 行内写法

pets： [cat,dog]

3.配置文件值（@ConfigurationProperties）注入

@Component
@ConfigurationProperties(prefix = "user")
public class User {
    private String userName;
    private String passWord;
public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getPassWord() {
        return passWord;
    }

    public void setPassWord(String passWord) {
        this.passWord = passWord;
    }
    @Override
    public String toString() {
        return "User{" +
                "userName='" + userName + '\'' +
                ", passWord='" + passWord + '\'' +
                '}';
    }
}

user:
  username: liangqiu
  password: 123456

我们可以导入配置文件处理器，以后编写配置就有提示了

<!‐‐导入配置文件处理器，配置文件进行绑定就会有提示‐‐>
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring‐boot‐configuration‐processor</artifactId>
	<optional>true</optional>
</dependency>

4.properties乱码问题

idea默认utf-8，properties以前使用ASCII码
settings->Editor->File Encodings->把properties编码编码选为utf-8，有个√需要打上

5.@value单个值注入

加在某一属性上

@Component
public class User {
    @Value ( "${user.username}" )
    private String userName;
    @Value ( "${user.password}" )
    private String passWord;
	public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getPassWord() {
        return passWord;
    }

    public void setPassWord(String passWord) {
        this.passWord = passWord;
    }
    @Override
    public String toString() {
        return "User{" +
                "userName='" + userName + '\'' +
                ", passWord='" + passWord + '\'' +
                '}';
    }
}

6.JSR 303数据校验

@Validated加在类上，配合@ConfigurationProperties使用
属性上加@Email表示该属性会进行邮箱格式校验，不符合格式就会报错

@Component
@ConfigurationProperties(prefix = "user")
@Validated
public class User {
    @Email
    private String userName;
    private String passWord;

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getPassWord() {
        return passWord;
    }

    public void setPassWord(String passWord) {
        this.passWord = passWord;
    }

    @Override
    public String toString() {
        return "User{" +
                "userName='" + userName + '\'' +
                ", passWord='" + passWord + '\'' +
                '}';
    }
}

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

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

JSR303数据校验

• @Validated加在类上，配合@ConfigurationProperties使用，
• 属性上加@Email，表示此属性进行邮箱格式校验，不符合启动会报错

@Component
@ConfigurationProperties(prefix = "user")
@Validated
public class User {
    @Email
    private String userName;
    private String passWord;

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getPassWord() {
        return passWord;
    }

    public void setPassWord(String passWord) {
        this.passWord = passWord;
    }

    @Override
    public String toString() {
        return "User{" +
                "userName='" + userName + '\'' +
                ", passWord='" + passWord + '\'' +
                '}';
    }
}

8.其他配置注解

1. @PropertySource加载指定properties配置文件，配合@ConfigurationProperties使用

@ConfigurationProperties(prefix = "student")
@Component
@PropertySource( value = {"classpath:student.properties"})
public class Student {
    private String sname;
    private int sid;
    private Date birthday;
    private String sex;

    @Override
    public String toString() {
        return "Student{" +
                "sname='" + sname + '\'' +
                ", sid=" + sid +
                ", birthday=" + birthday +
                ", sex='" + sex + '\'' +
                '}';
    }

    public String getSname() {
        return sname;
    }

    public void setSname(String sname) {
        this.sname = sname;
    }

    public int getSid() {
        return sid;
    }

    public void setSid(int sid) {
        this.sid = sid;
    }

    public Date getBirthday() {
        return birthday;
    }

    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }
}

2.@ImportResource导入spring配置文件，加在启动类上，让里面的内容生效（这种方式已经过时）

@ImportResource（locations="classpath：beans.xml"）

springboot推荐管理bean的方式（配置类的方式）

@Configuration
public class MyAppConfig {
    @Bean
    public Dog dog(){
        return new Dog ();
    }
}

测试的时候获取ioc容器

@Autowired
    private ApplicationContext ioc;//容器
    @Test
    public void dogTest(){
        System.out.println (ioc.containsBean ( "dog" ) );
    }

9.配置文件占位符

（1）随机数

1. random.int
2. random.long
3. random.int(10)#10以下的随机数
4. random.int[5,10]#5-10

dog:
	age: ${random.int(10)}

（2）占位符获取之前配置的值

person.last‐name=张三${random.uuid}
person.age=${random.int}
person.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=${person.last‐name：无主}_dog
person.dog.age=15

10.多profile

（1）多profile文件

我们在主配置文件编写的时候，可以激活其他配置文件的内容，文件名可以是application-{profile}.properties/yml

spring.profiles.active=dev

（2）yml支持多文档块方式

server:
	port: 8081
spring:
	profiles:
		active: prod
‐‐‐
server:
	port: 8083
spring:
	profiles: dev
‐‐‐
server:
	port: 8084
spring:
	profiles: prod #指定属于哪个环境

（3）其他激活profile的方式

• 运行jar包的时候命令行

java -jar *.jar --spring.profiles.active=dev;

• 测试时直接传入命令行参数（Edit Configurations->program arguments后加参数–spring.profiles.active=dev;）
• 虚拟机参数（Edit Configurations->VM options后加参数-Dspring.profiles.active=dev）

11.配置文件加载位置

springboot启动会从以下路径扫描application.properties或application.yml作为配置文件

• file:/config/
• file:/
• classpath:/config/
• classpath:/
  以上路径优先级由高到低，同一路径下properties配置文件高于yml配置文件，所有文件全部会加载，同一配置高优先级生效，称为互补配置原则。

我们还可以通过spring.config.location来改变默认的配置文件位置，项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；指定配置文件和默认加载的这些配置文件共同起作用形成互补配置

java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar 
--spring.config.location=G:/application.properties

12.外部配置文件加载顺序

SpringBoot也可以从以下位置加载配置； 优先级从高到低；高优先级的配置覆盖低优先级的配置，所有的配置会形成互补配置

1. 命令行参数
   所有的配置都可以在命令行上进行指定

java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar 
--server.port=8087 --server.context-path=/abc

多个配置用空格分开； --配置项=值

1. 来自java:comp/env的JNDI属性
2. Java系统属性（System.getProperties()）
3. 操作系统环境变量
4. RandomValuePropertySource配置的random.*属性值
5. jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件
6. jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件
7. jar包外部的application.properties或application.yml(不带spring.profile)配置文件
8. jar包内部的application.properties或application.yml(不带spring.profile)配置文件
9. @Configuration注解类上的@PropertySource
10. 通过SpringApplication.setDefaultProperties指定的默认属性

13.自动配置原理

1）、SpringBoot启动的时候加载主配置类，开启了自动配置功能 @EnableAutoConfiguration
2）、@EnableAutoConfiguration 作用：

• 利用EnableAutoConfigurationImportSelector给容器中导入一些组件？
• 可以查看selectImports()方法的内容；
• List configurations = getCandidateConfigurations(annotationMetadata, attributes);获取候选的配置
  将 类路径下 META-INF/spring.factories 里面配置的所有EnableAutoConfiguration的值加入到了容器中；
  每一个这样的 xxxAutoConfiguration类都是容器中的一个组件，都加入到容器中；用他们来做自动配置；
  3）、每一个自动配置类进行自动配置功能；