Spring Boot入门+深入(二)-配置文件

杀神lwz

已于 2024-03-07 17:42:14 修改

阅读量629

点赞数 1

于 2021-10-30 18:11:52 首次发布

本文链接：https://blog.csdn.net/weixin_42472027/article/details/121051706

版权

Spring Boot 专栏收录该内容

7 篇文章 0 订阅

订阅专栏

2.application.properties中配置

4.properties配置文件在idea中默认utf-8可能会乱码

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

松散绑定（松散语法）：

SpringEL：Spring表达式

JSR303数据校验 @Validated

6.@ConfigurationProperties与@PropertySource（只能用于properties文件）结合读取指定文件

7.@ImportResource @Bean

@ImportResource：导入Spring的配置文件，让配置文件里面的内容生效；

@Bean：将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名

二、配置文件占位符

1.随机数

2.占位符获取之前配置的值，如果没有可以是用:指定默认值

@Conditional派生注解（原生的@Conditional作用）

一、Spring Boot配置文件

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

①application.properties

②application.yml

配置文件的作用：修改SpringBoot自动配置的默认值；SpringBoot在底层都给我们自动配置好；

yml是YAML（YAML Ain't Markup Language）语言的文件，以数据为中心，比json、xml等更适合做配置文件

参考语法规范：The Official YAML Web Site

YAML：配置例子

server:
    port: 8081

XML：配置例子

<server>
    <port>8081</port>
</server>

1.YAML语法

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

server:
    port: 8081
    path: /hello

– 使用缩进表示层级关系

– 缩进时不允许使用Tab键，只允许使用空格。

– 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可

– 属性和值也是大小写敏感；

2.YAML值的写法

①字面量：普通的值（数字，字符串，布尔）

k: v：字面直接来写；

字符串默认不用加上单引号或者双引号；

""：双引号；不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思

name: "zhangsan \n lisi"：输出；zhangsan 换行 lisi

''：单引号；会转义特殊字符，特殊字符最终只是一个普通的字符串数据

name: ‘zhangsan \n lisi’：输出；zhangsan \n lisi

字符串可以写成多行，从第二行开始，必须有一个单空格缩进。换行符会被转为空格。

②对象、Map（属性和值）（键值对）：

k: v：在下一行来写对象的属性和值的关系；注意缩进

对象还是k: v的方式

friends:
    lastName: zhangsan
    age: 20

行内写法：

friends: {lastName: zhangsan,age: 18}

③数组（List、Set）：

用- 值表示数组中的一个元素

pets:
    ‐ cat
    ‐ dog
    ‐ pig

行内写法

pets: [cat,dog,pig]

多个文档用 - - - 隔开

3.配置文件值注入

1.application.yml中配置

person:
    lastName: jingjing
    age: 18
    boss: false
    birth: 2018/12/13
    maps: {k1: v1,k2: 12}
    lists:
        ‐ zhangwuji
        ‐ zhaowei
    dog:
        name: 旺旺
        age: 12

javaBean：

@ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "person"：配置文件中那个下面的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件，才能使用容器提供的@ConfigurationProperties功能；
 *  @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值；
 *
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;

    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
....

public class Dog {

    private String name;
    private Integer age;
...

在application.yml等配置文件中编写配置有提示，需要在pom.xml中导入配置文件处理器，以后编写配置就有提示了。

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

2.application.properties中配置

person.last-name=张无忌
person.age=12
person.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=dog
person.dog.age=15

其他同上application.yml中配置

4.properties配置文件在idea中默认utf-8可能会乱码

调整配置，properties文件中编码utf-8,后面勾上选项，程序运行中转换ascii码。

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

@Value可像@ConfigurationProperties一样获取配置文件等值。

@Value("值")：相当于以前的bean中的value="值"。

@Component
public class Person {

    /**
     * <bean class="Person">
     *      <property name="lastName" value="值"></property>
     * <bean/>
     *      value=值的取值类型：1.字面量/2.${key}从环境变量、配置文件中获取值/3.#{SpEL}
     *
     */
    @Value("${person.last-name}")  //获取配置文件中的值
    private String lastName;
    @Value("#{11*2}")             //#{SpEL}方式表达式方式计算值等
    private Integer age;
    @Value("true")                //字面量：直接设置值
    private Boolean boss;

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

配置文件yml还是properties他们都能获取到值；

@Value：只是在某个业务逻辑中需要获取一下配置文件中的某项值

@ConfigurationProperties：批量读取配置

松散绑定（松散语法）：

– person.firstName：使用标准方式

– person.first-name：大写用-

– person.first_name：大写用_

– PERSON_FIRST_NAME： • 推荐系统属性使用这种写法

SpringEL：Spring表达式

– person.age=#{11*2}

JSR303数据校验 @Validated

--@Email

--@NotNull

--@Valid

@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
    //lastName必须是邮箱格式
    @Email
    private String lastName;
...

6.@ConfigurationProperties与@PropertySource（只能用于properties文件）结合读取指定文件

把person配置单独写一个配置文件person.properties内容如下，把application.properties中person配置注掉

person.last-name=张无忌
person.age=12
person.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=dog
person.dog.age=15

@PropertySource(value = {"classpath:person.properties"})：指定person.properties文件

@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
public class Person {

    private String lastName;
    private Integer age;
    private Boolean boss;

    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
...

7.@ImportResource @Bean

@ImportResource：导入Spring的配置文件，让配置文件里面的内容生效；

在resources文件夹下创建spring文件：beans.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean id="helloService" class="com.springboot.service.HelloService"></bean>
</beans>

测试类：

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBootTests {

	@Autowired
	ApplicationContext ioc;

	@Test
	public void testHelloService(){
		boolean b = ioc.containsBean("helloService");
		System.out.println(b);
	}
}

运行看结果：false

Spring Boot里面没有加载上beans.xml配置文件，如果想让配置文件加载进来，需要把@ImportResource标注在一个配置类上

@ImportResource(locations = {"classpath:beans.xml"})//导入Spring的配置文件让其生效
@SpringBootApplication
public class SpringBootApplication {

	public static void main(String[] args) {
		SpringApplication.run(SpringBootApplication.class, args);
	}
}

上面这种写配置文件导入的方式SpringBoot不推荐使用。

@Bean：将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名

SpringBoot推荐给容器中添加组件的方式；推荐使用全注解的方式

1、配置类@Configuration------>Spring配置文件

2、使用@Bean给容器中添加组件

/**
 * @Configuration：指明当前类是一个配置类；就是来替代之前的Spring配置文件
 *
 * 在配置文件中用<bean><bean/>标签添加组件
 *
 */
@Configuration
public class MyAppConfig {

    //将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名
    @Bean
    public HelloService helloService02(){
        System.out.println("配置类@Bean给容器中添加组件了...");
        return new HelloService();
    }

}

测试类：

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBootTests {

	@Autowired
	ApplicationContext ioc;

	@Test
	public void testHelloService(){
		boolean b = ioc.containsBean("helloService02");
		System.out.println(b);
	}
}

返回：true 表示组件默认id是方法名

二、配置文件占位符

1.随机数

${random.value}、${random.int}、${random.long}
${random.int(10)}、${random.int[1024,65536]}

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.hello:hello}_dog
person.dog.age=15

三、Profile

1.多Profile文件

我们在主配置文件编写的时候，文件名可以是 application-{profile}.properties/yml 默认使用application.properties的配置；

例如：

application-dev.properties

application-prod.properties

2.yml支持多文档块方式

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

3.激活指定profile

1、在配置文件中指定 spring.profiles.active=dev

2、命令行： java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev；可以直接在测试的时候，配置传入命令行参数

3、虚拟机参数； -Dspring.profiles.active=dev

四、配置文件加载位置

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件

–file:./config/

–file:./

–classpath:/config/

–classpath:/

优先级由高到底，高优先级的配置会覆盖低优先级的配置；

SpringBoot会从这四个位置全部加载主配置文件；互补配置；

我们还可以通过spring.config.location来改变默认的配置文件位置

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

java -jar spring-boot-xxx.jar --spring.config.location=G:/application.properties

五、外部配置加载顺序

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

1.命令行参数

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

java -jar spring-boot-xxx.jar --server.port=8087 --server.context-path=/abc

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

2.来自java:comp/env的JNDI属性

3.Java系统属性（System.getProperties()）

4.操作系统环境变量

5.RandomValuePropertySource配置的random.*属性值

6.jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件

7.jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件

8.jar包外部的application.properties或application.yml(不带spring.profile)配置文件

9.jar包内部的application.properties或application.yml(不带spring.profile)配置文件

10.@Configuration注解类上的@PropertySource

11.通过SpringApplication.setDefaultProperties指定的默认属性

配置项目访问路径：server.context-path=/abc

六、自动配置原理

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

2）、@EnableAutoConfiguration 作用：

①利用EnableAutoConfigurationImportSelector给容器中导入一些组件

②可以查看selectImports()方法的内容；

③List configurations = getCandidateConfigurations(annotationMetadata, attributes);获取候选的配置

④SpringFactoriesLoader.loadFactoryNames()：扫描所有jar包类路径下META‐INF/spring.factories

⑤把扫描到的这些文件的内容包装成properties对象从properties中获取到EnableAutoConfiguration.class类（类名）对应的值，然后把他们添加在容器中

⑥将类路径下 META-INF/spring.factories 里面配置的所有EnableAutoConfiguration的值加入到了容器中；

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
....

⑦每一个这样的 xxxAutoConfiguration类都是容器中的一个组件，都加入到容器中；用他们来做自动配置；

3）、每一个自动配置类进行自动配置功能；

4）、以HttpEncodingAutoConfiguration（Http编码自动配置）为例解释自动配置原理；

@Configuration //表示这是一个配置类，以前编写的配置文件一样，也可以给容器中添加组件
@EnableConfigurationProperties(HttpEncodingProperties.class) //启动指定类的
ConfigurationProperties功能；将配置文件中对应的值和HttpEncodingProperties绑定起来；并把
HttpEncodingProperties加入到ioc容器中

@ConditionalOnWebApplication //Spring底层@Conditional注解，根据不同的条件，
如果满足指定的条件，整个配置类里面的配置就会生效;判断当前应用是否是web应用，如果是，当前配置类生效

@ConditionalOnClass(CharacterEncodingFilter.class) //判断当前项目有没有这个类
CharacterEncodingFilter；SpringMVC中进行乱码解决的过滤器；

@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing =
true) //判断配置文件中是否存在某个配置 spring.http.encoding.enabled；如果不存在，判断也是成立的
//即使我们配置文件中不配置pring.http.encoding.enabled=true，也是默认生效的；

public class HttpEncodingAutoConfiguration {

    //他已经和SpringBoot的配置文件映射了
    private final HttpEncodingProperties properties;

    //只有一个有参构造器的情况下，参数的值就会从容器中拿
    public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
        this.properties = properties;
    }

    @Bean //给容器中添加一个组件，这个组件的某些值需要从properties中获取
    @ConditionalOnMissingBean(CharacterEncodingFilter.class) //判断容器没有这个组件？
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));
        return filter;
    }

根据当前不同的条件判断，决定这个配置类是否生效

一但这个配置类生效；这个配置类就会给容器中添加各种组件；这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的；

5）、所有在配置文件中能配置的属性都是在xxxxProperties类中封装者‘；配置文件能配置什么就可以参照某个功能对应的这个属性类

@ConfigurationProperties(prefix = "spring.http.encoding") //从配置文件中获取指定的值和bean的属性进行绑定
public class HttpEncodingProperties {
    public static final Charset DEFAULT_CHARSET = Charset.forName("UTF‐8");

核心精髓：

1）、SpringBoot启动会加载大量的自动配置类

2）、我们看我们需要的功能有没有SpringBoot默认写好的自动配置类；

3）、我们再来看这个自动配置类中到底配置了哪些组件；（只要我们要用的组件有，我们就不需要再来配置了）

4）、给容器中自动配置类添加组件的时候，会从properties类中获取某些属性。我们就可以在配置文件中指定这些属性的值；

@Conditional派生注解（原生的@Conditional作用）

作用：必须是@Conditional指定的条件成立，才给容器中添加组件，配置配里面的所有内容才生效；

@Conditional扩展注解	作用（判断是否满足当前指定条件）
@ConditionalOnJava	系统的java版本是否符合要求
@ConditionalOnBean	容器中存在指定Bean；
@ConditionalOnMissingBean	容器中不存在指定Bean；
@ConditionalOnExpression	满足SpEL表达式指定
@ConditionalOnClass	系统中有指定的类
@ConditionalOnMissingClass	系统中没有指定的类
@ConditionalOnSingleCandidate	容器中只有一个指定的Bean，或者这个Bean是首选Bean
@ConditionalOnProperty	系统中指定的属性是否有指定的值
@ConditionalOnResource	类路径下是否存在指定资源文件
@ConditionalOnWebApplication	当前是web环境
@ConditionalOnNotWebApplication	当前不是web环境
@ConditionalOnJndi	JNDI存在指定项

自动配置类必须在一定的条件下才能生效；我们怎么知道哪些自动配置类生效；

我们可以通过在application.properties中启用 debug=true属性；来让控制台打印自动配置报告，这样我们就可以很方便的知道哪些自动配置类生效；

=========================
AUTO‐CONFIGURATION REPORT
=========================
Positive matches:（自动配置类启用的）
‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐
DispatcherServletAutoConfiguration matched:

......

Negative matches:（没有启动，没有匹配成功的自动配置类）
‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐
ActiveMQAutoConfiguration:
Did not match:
‐ @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory',
'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)

......

Spring Boot入门+深入(一)：Spring Boot入门+深入(一)

Spring Boot入门+深入(三)：Spring Boot入门+深入(三)-日志

杀神lwz

关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
打赏
0
评论
Spring Boot入门+深入(二)-配置文件

一、快速创建Spring Boot项目1、IDEA：使用 Spring Initializer快速创建项目IDE都支持使用Spring的项目创建向导快速创建一个Spring Boot项目；选择我们需要的模块；向导会联网创建Spring Boot项目；https://start.spring.io/创建项目默认生成的Spring Boot项目；1.主程序已经生成好了，我们只需要我们自己的逻辑2.resources文件夹中目录结构static：保存所有的静态资源； ...
复制链接

扫一扫