springboot系列三、spirngboot中配置文件详解

最新推荐文章于 2023-05-03 21:15:37 发布
最新推荐文章于 2023-05-03 21:15:37 发布
阅读量319 收藏 1
点赞数
文章标签： 测试 ldap java
原文链接：https://my.oschina.net/u/4115727/blog/3060939
版权

一、配置文件

SpringBoot使用一个全局的配置文件，配置文件名是固定的，配置文件主要分为以下两种

•application.properties

•application.yml

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

YAML（YAML Ain't Markup Language）

YAML A Markup Language：是一个标记语言

YAML isn't Markup Language：不是一个标记语言；

标记语言：

以前的配置文件；大多都使用的是 xxxx.xml文件；

YAML：以数据为中心，比json、xml等更适合做配置文件；

YAML：配置例子

server:
  port: 8081

XML：

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

二、YAML语法

1、基本语法

k:(空格)v：表示一对键值对（空格必须有）；

以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的

server:
    port: 8081
    path: /hello

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

2、值的写法

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

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
 
people:
 - name
 - age
 - address

行内写法

pets: [cat,dog,pig]

三、配置文件值注入

配置文件

person:
    lastName: hello
    age: 18
    boss: false
    birth: 2017/12/12
    maps: {k1: v1,k2: 12}
    lists:
      - lisi
      - zhaoliu
    dog:
      name: 小狗
      age: 12

javaBean：

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 *
 */
@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;

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

<!--导入配置文件处理器，配置文件进行绑定就会有提示-->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-configuration-processor</artifactId>
	<optional>true</optional>
</dependency>
①在springboot单元测试中，bean对象注入失败的问题

2c4bbe8e63151ff70afd1fe6ff32187ee88.jpg

8584882b481eb20164378142a54a3e61b9c.jpg

我的单元测试里面显示bean对象注入失败，我们都知道spring中使用注解会在spring配置文件中开启扫描注解的方法，springmvc也是一样，那么spring-boot也会提供一个扫描注解的方法叫做@ComponentScan(basePackages = {"com.bdqn.Controller"})，表示会扫描到basePackages中所有约定包下面的所有注解

后来经研究发现，SpringBoot项目的Bean装配默认规则是根据Application类所在的包位置从上往下扫描！ “Application类”是指SpringBoot项目入口类。这个类的位置很关键：

如果Application类所在的包为：io.github.gefangshuai.app，则只会扫描io.github.gefangshuai.app包及其所有子包，如果service或dao所在包不在io.github.gefangshuai.app及其子包下，则不会被扫描！

本次测试的是yml配置文件映射动态绑定到实体类中，但是在单元测试类中出现bean对象扫描失败

这里给大家说明两点要注意的地方

①测试文件的项目名称要和启动类的项目名称保持一致

②扫描注解只有放在启动类上面才会起到扫描bean对象的作用

实现步骤如下

/***
 * 将配置文件中配置的每一个值映射到这个组件中
 *  * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *  *      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 *  *
 *  * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 *  *
 *  */
@Component //把实体类注入容器
@ConfigurationProperties(prefix = "person")
public class Person {
//  alt+insert
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;

    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
###aplication.yml配置文件
person:
  lastName: hello
  age: 18
  boss: false
  birth: 2017/12/12
  maps: {k1: v1,k2: 12}
  lists:
    - lisi
    - zhaoliu
  dog:
    name: 小狗
    age: 12

springboot启动类

@SpringBootApplication
@ComponentScan(basePackages = {"com.bdqn"})
/**
 * 当测试启动类和Controller不位于同一个包下面时候需要
 * 配置@ComponentScan(basePackages = {"com.bdqn.Controller"})去扫描controller的路径
 */
public class SpringBootQuickApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringBootQuickApplication.class, args);

    }
}

在springboot提供的单元测试类里面进行测试

启动单元测试类，拿到了application.yml文件中配置的值

084e57b2d3f1e6e66596f25738ade25f345.jpg

②@Value获取值和@ConfigurationProperties获取值比较

784741ebe8ca70af79d2137939e915e2dbc.jpg

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

如果说，我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value；

测试代码如下

application.properties文件,实体类的代码还是不变

##修改spring-boot给我们底层的默认配置
#默认是的的是utf-8
#配置person的值
person.last-name=tom
person.age=18
person.boss=true
person.birth=2017/10/1
person.maps.k1=v1
person.maps.k2=v2
person.lists=a,b,c
person.dog.name=dog
person.dog.age=15
@RestController
/**
 * 相当于 Contoller和RequestBody的合体，都是把数据响应给浏览器
 */
@RequestMapping("/test")
public class HelloController {
    @Value("${person.last-name}")
    private String name;
    @RequestMapping("/hello")
    public String hello(){
        return "hello you name is"+name;
    }
}

8ab68a66956c1997248ff9fa00919d14844.jpg

③、配置文件注入值数据校验
@Component
@ConfigurationProperties(prefix = "person")
@Validated  //专门验证数据的格式是否正确
public class Person {

    /**
     * <bean class="Person">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * <bean/>
     */

   //lastName必须是邮箱格式
    @Email
    //@Value("${person.last-name}")
    private String lastName;
    //@Value("#{11*2}")
    private Integer age;
    //@Value("true")
    private Boolean boss;

    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
④@PropertySource&@ImportResource&@Bean
/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 *  @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值；
 *
 */
@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated
public class Person {

    /**
     * <bean class="Person">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * <bean/>
     */

   //lastName必须是邮箱格式
   // @Email
    //@Value("${person.last-name}")
    private String lastName;
    //@Value("#{11*2}")
    private Integer age;
    //@Value("true")
    private Boolean boss;

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

Spring Boot里面没有Spring的配置文件，我们自己编写的配置文件，也不能自动识别；

想让Spring的配置文件生效，加载进来；@ImportResource标注在一个启动Application配置类上，ApplicationContext.xml

<bean id="helloService" class="com.bdqn.Controller.service.HelloService"></bean>

单元测试类代码如下,不加入@ImportResource情况下

@Test
    public void TestService(){
        //测试容器中是否有这个值
        Boolean bean= (Boolean) ioc.containsBean("helloService");
        System.out.println(bean);
    }

e3c0720d2f65939c978d6a54eb6bbd56c9f.jpg

@SpringBootApplication
@ComponentScan(basePackages = {"com.bdqn"})
//引入spring的配置文件
@ImportResource(locations = {"classpath:ApplicationContext.xml"})
/**
 * 当测试启动类和Controller不位于同一个包下面时候需要
 * 配置@ComponentScan(basePackages = {"com.bdqn.Controller"})去扫描controller的路径
 */
public class SpringBootQuickApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringBootQuickApplication.class, args);

    }
}
不用编写Spring的配置文件

SpringBoot推荐给容器中添加组件的方式；推荐使用全注解的方式，但是我觉得太麻烦了，每次创建一个bean都要创建一个类对象

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();
    }
}
⑤、配置文件占位符

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.maps这个值，后面person.dog.name想用一下前面的值
person.dog.name=${person.maps:hello}_dog
person.dog.age=15

四、Profile

是springboot用来做多环境支持的，开发环境、测试环境、运行环境

①、多Profile文件

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

默认使用application.properties的配置；

②、yml支持多文档块方式
server:
  port: 8081
spring:
  profiles:
    active: prod

---//三个横线+回车
server:
  port: 8083
spring:
  profiles: dev


---

server:
  port: 8084
spring:
  profiles: prod  #指定属于哪个环境
③、激活指定profile

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

2、命令行：

java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev；

可以直接在测试的时候，配置传入命令行参数

5ae67cb43f836b349306c66423d6d31300d.jpg

3、虚拟机参数；

-Dspring.profiles.active=dev

da6098d38c6199c6c5375cb6f548402669b.jpg

五、配置文件加载位置或顺序

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

–file:./config/

–file:./

–classpath:/config/

–classpath:/

1ba34d04e944bab94a327091bd015de6085.jpg

入图上所展示，优先级由高到底，高优先级的配置会覆盖低优先级的配置；

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

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

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

先输入 cd target

在输出dir

2c19d122b2c6e2b4c181d336c515cf9681d.jpg

输入：java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=F:/application.properties(里面是湍口号内容)也可以运行项目

2ae22ff93242c1853ca1efb778654b3dbf4.jpg

 

六、外部配置加载顺序

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

 

1.命令行参数

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

java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.port=8087

--server.context-path=/abc //访问项目名称，但是需要修改多个配置的时候这么写的话？显得很累赘

可以专门写一个外部配置文件

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

 

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

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

4.操作系统环境变量

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

 

==由jar包外向jar包内进行寻找；==

==优先加载带profile==

f87f091bd040613ede4a2d7276d5779cc54.jpg

优先加载，外部jar包旁边的配置文件

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

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

 

==再来加载不带profile==

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

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

 

10.@Configuration注解类上的@PropertySource

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

所有支持的配置加载来源；

参考官方文档

七、自动配置原理

配置文件到底能写什么？怎么写？自动配置原理；

配置文件能配置的属性参照

1、自动配置原理：

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

2）、@EnableAutoConfiguration 作用：

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

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

  • List<String> 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,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\
org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\
org.springframework.boot.autoconfigure.cloud.CloudAutoConfiguration,\
org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\
org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration,\
org.springframework.boot.autoconfigure.couchbase.CouchbaseAutoConfiguration,\
org.springframework.boot.autoconfigure.dao.PersistenceExceptionTranslationAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.ldap.LdapDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.ldap.LdapRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.neo4j.Neo4jDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.neo4j.Neo4jRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.solr.SolrRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,\
org.springframework.boot.autoconfigure.data.redis.RedisRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.rest.RepositoryRestMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.data.web.SpringDataWebAutoConfiguration,\
org.springframework.boot.autoconfigure.elasticsearch.jest.JestAutoConfiguration,\
org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration,\
org.springframework.boot.autoconfigure.gson.GsonAutoConfiguration,\
org.springframework.boot.autoconfigure.h2.H2ConsoleAutoConfiguration,\
org.springframework.boot.autoconfigure.hateoas.HypermediaAutoConfiguration,\
org.springframework.boot.autoconfigure.hazelcast.HazelcastAutoConfiguration,\
org.springframework.boot.autoconfigure.hazelcast.HazelcastJpaDependencyAutoConfiguration,\
org.springframework.boot.autoconfigure.info.ProjectInfoAutoConfiguration,\
org.springframework.boot.autoconfigure.integration.IntegrationAutoConfiguration,\
org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.JndiDataSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.XADataSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.JmsAutoConfiguration,\
org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.JndiConnectionFactoryAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.activemq.ActiveMQAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.artemis.ArtemisAutoConfiguration,\
org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration,\
org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAutoConfiguration,\
org.springframework.boot.autoconfigure.jersey.JerseyAutoConfiguration,\
org.springframework.boot.autoconfigure.jooq.JooqAutoConfiguration,\
org.springframework.boot.autoconfigure.kafka.KafkaAutoConfiguration,\
org.springframework.boot.autoconfigure.ldap.embedded.EmbeddedLdapAutoConfiguration,\
org.springframework.boot.autoconfigure.ldap.LdapAutoConfiguration,\
org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration,\
org.springframework.boot.autoconfigure.mail.MailSenderAutoConfiguration,\
org.springframework.boot.autoconfigure.mail.MailSenderValidatorAutoConfiguration,\
org.springframework.boot.autoconfigure.mobile.DeviceResolverAutoConfiguration,\
org.springframework.boot.autoconfigure.mobile.DeviceDelegatingViewResolverAutoConfiguration,\
org.springframework.boot.autoconfigure.mobile.SitePreferenceAutoConfiguration,\
org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongoAutoConfiguration,\
org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration,\
org.springframework.boot.autoconfigure.mustache.MustacheAutoConfiguration,\
org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration,\
org.springframework.boot.autoconfigure.reactor.ReactorAutoConfiguration,\
org.springframework.boot.autoconfigure.security.SecurityAutoConfiguration,\
org.springframework.boot.autoconfigure.security.SecurityFilterAutoConfiguration,\
org.springframework.boot.autoconfigure.security.FallbackWebSecurityAutoConfiguration,\
org.springframework.boot.autoconfigure.security.oauth2.OAuth2AutoConfiguration,\
org.springframework.boot.autoconfigure.sendgrid.SendGridAutoConfiguration,\
org.springframework.boot.autoconfigure.session.SessionAutoConfiguration,\
org.springframework.boot.autoconfigure.social.SocialWebAutoConfiguration,\
org.springframework.boot.autoconfigure.social.FacebookAutoConfiguration,\
org.springframework.boot.autoconfigure.social.LinkedInAutoConfiguration,\
org.springframework.boot.autoconfigure.social.TwitterAutoConfiguration,\
org.springframework.boot.autoconfigure.solr.SolrAutoConfiguration,\
org.springframework.boot.autoconfigure.thymeleaf.ThymeleafAutoConfiguration,\
org.springframework.boot.autoconfigure.transaction.TransactionAutoConfiguration,\
org.springframework.boot.autoconfigure.transaction.jta.JtaAutoConfiguration,\
org.springframework.boot.autoconfigure.validation.ValidationAutoConfiguration,\
org.springframework.boot.autoconfigure.web.DispatcherServletAutoConfiguration,\
org.springframework.boot.autoconfigure.web.EmbeddedServletContainerAutoConfiguration,\
org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.web.HttpEncodingAutoConfiguration,\
org.springframework.boot.autoconfigure.web.HttpMessageConvertersAutoConfiguration,\
org.springframework.boot.autoconfigure.web.MultipartAutoConfiguration,\
org.springframework.boot.autoconfigure.web.ServerPropertiesAutoConfiguration,\
org.springframework.boot.autoconfigure.web.WebClientAutoConfiguration,\
org.springframework.boot.autoconfigure.web.WebMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.WebSocketAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.WebSocketMessagingAutoConfiguration,\
org.springframework.boot.autoconfigure.webservices.WebServicesAutoConfiguration

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

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

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

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

@ConditionalOnWebApplication //Spring底层@Conditional注解（Spring注解版），根据不同的条件，如果满足指定的条件，整个配置类里面的配置就会生效；    判断当前应用是否是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");

精髓：springboot里面的HttpEncodingProperties会自动配置好很多注组件

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

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

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

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

xxxxAutoConfigurartion：自动配置类；

给容器中添加组件

xxxxProperties:封装配置文件中相关属性；

2、细节

1、@Conditional派生注解（Spring注解版原生的@Conditional作用）

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

cd6d72c362c66b59a9a1d317ca5c5ae6212.jpg

自动配置类必须在一定的条件下才能生效；

我们怎么知道哪些自动配置类生效；

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

#开启Springboot中的debug
debug=true
#配置端口号
server.port=8089
#我们能配置那些都是来源于properties类
spring.http.encoding.enabled=true
spring.http.encoding.charset=utf-8
spring.http.encoding.force=true
=========================
AUTO-CONFIGURATION REPORT
=========================


Positive matches:（自动配置类启用的）
-----------------

   DispatcherServletAutoConfiguration matched:
      - @ConditionalOnClass found required class 'org.springframework.web.servlet.DispatcherServlet'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)
      - @ConditionalOnWebApplication (required) found StandardServletEnvironment (OnWebApplicationCondition)
        
    
Negative matches:（没有启动，没有匹配成功的自动配置类）
-----------------

   ActiveMQAutoConfiguration:
      Did not match:
         - @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory', 'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)

   AopAutoConfiguration:
      Did not match:
         - @ConditionalOnClass did not find required classes 'org.aspectj.lang.annotation.Aspect', 'org.aspectj.lang.reflect.Advice' (OnClassCondition)

 

转载于:https://my.oschina.net/u/4115727/blog/3060939

chouji5160
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
springboot的5种读取配置方式（6）：总结properties，yml,xml的区别
别抢我蓝buff
02-06 971
通过springboot的5种读取配置方式（1）：直接读取beanspringboot的5种读取配置方式（2）：通过config读取指定文件springboot的5种读...
Spring Boot——Maven使用SystemPath引用本地jar：ClassNotFoundException
无限迭代中......
08-31 1607
问题描述 <dependency> <groupId>com.dingtalk</groupId> <artifactId>dingtalk-api-sdk</artifactId> <version>1.0.0-SNAPSHOT</version> <scope>system</scope&g
Spring Boot 配置文件
lfm1010123的博客
10-04 7441
本片博客主要介绍了，properties 文件 和 yml 文件
SpringBoot 配置文件
最新发布
qq_63218110的博客
05-03 1732
本篇主要介绍SpringBoot的配置文件，分别为properties与yml(yaml)，其中对properties和yml的优缺点进行了分析，并且解决了yml的单双引号问题，以及对yml和properties配置，读取进行了讲解。
SpringBoot配置文件application.yml属性解读及使用学习记录
weixin_49045960的博客
10-28 4093
【代码】java项目中application.yml配置详解记录。
SPRINGBOOT读取PROPERTIES配置文件数据过程详解
08-25
SPRINGBOOT 读取 PROPERTIES 配置文件数据过程详解 SPRINGBOOT 框架中，读取 PROPERTIES 配置文件数据是非常重要的一步骤。通过使用 `@ConfigurationProperties` 注解，可以轻松地读取配置文件中的数据，并将其...
详解Springboot配置文件的使用
08-30
在Spring Boot项目中，我们可以选择使用`.properties`或`.yml`两种类型的配置文件，其中`.yml`文件以其更易读的格式受到许多开发者的青睐。 首先，让我们详细了解一下如何使用`.yml`配置文件。在IDEA创建的Spring ...
SpringBoot注入配置文件的3种方法详解
08-25
SpringBoot 注入配置文件的 3 种方法详解 SpringBoot 框架提供了多种方式来注入配置文件，下面将详细介绍三种常用的方法： 方法一：@ConfigurationProperties + @Component 使用 @ConfigurationProperties 注解...
springboot配置文件抽离 git管理统 配置中心详解
09-18
在本篇文章里小编给大家整理的是关于springboot配置文件抽离 git管理统 配置中心的相关知识点内容，有需要的朋友们可以学习下。
走进SpringBoot之配置文件与多环境详解
08-26
在Spring Boot框架中，配置文件管理和多环境支持是至关重要的，因为它们允许开发者根据不同的运行环境（如开发、测试、生产等）灵活地调整应用的配置。本文将深入讲解Spring Boot的配置文件以及如何实现多环境配置。...
yml详解以及java对yml的使用
11-08
关于yml的介绍，java对yml的解析，yml的规范的详解。
SpringBoot--application.yml配置文件--用法
IT利刃出鞘的博客
09-21 1万+
原文网址： bootstrap与application 参考网址 SpringCloud入门之常用的配置文件 application.yml和 bootstrap.yml区别 - JackYang - 博客园 简介 bootstrap与application都有两种配置格式：yml格式与properties格式。 项 bootstrap application 加载顺序 先于 applicatio
SpringBoot配置文件
emgexgb_sef的博客
07-28 260
理论上讲properties可以和yml起存在于个项目当中，当properties和yml起存在个项目中时，如果配置文件中出现了同样的配置，那么这个时候会以properties中的配置为主，properties类型的配置文件就属于旧版配置类型，也是创建SpringBoot项目时默认的文件格式，而yml属于新版配置类型。配置文件是最早期的配置文件格式，也是创建SpringBoot项目默认的配置文件。如果在项目中，想要主动的读取配置文件中的内容，可以使用。...
spring-boot打包，引入外部jar包问题
ggf的专栏
12-19 2万+
将本地jar添加到本地maven仓库，最直接的办法，在本地仓库创建目录                      self.tls         tls         2.4         api.jar      这种只时候自己开发，别人是找不目录的。不见意这么做 现在使用maven 打包，虽然添加到仓库里了，但是打包后到boot-info lib里是找不到的。 所有
springboot借助maven插件system path，加载本地jar
qq_34412985的博客
06-09 2233
当引用第三方包，且没有源代码时候，可以使用system path <dependency> <groupId>ctec</groupId> <artifactId>xxx-core</artifactId> <version>1.0</version> <scope>system</scope> <systemPath>${project.b
SpringBoot使用Nacos作为配置中心服务和服务注册中心
热门推荐
牧竹子
03-07 22万+
简介 从spring开始，所有的配置文件都放在项目中，如果需要修改配置文件内容，则需要登陆服务器重启服务。想象一下如果你有一百台服务的需要修改，那是不可想象的工作量。 目前已有的配置中心 携程开源的Apollo:数据保存在mysql中，支持命名空间和分发更新配置 springcloud 中的springcloud config:必须使用git保存配置信息 阿里的开源Nacos 其他项目未关注 最次...
springboot项目配置文件属性变量引用方式${}和@@用法与区别
weixin_42315600的博客
03-16 3万+
${}和@@都是springboot引用属性变量的方式，具体区别与用法： 1、${}常用于pom.xml，和 src/main/resources/application.properties等默认配置文件的属性变量引用。 语法为：field_name=${field_value} pom.xml示例： &lt;properties&gt; &lt;dubbo.version&g...
关于spring-boot中的@SpringBootApplication中的@ComponentScan的basePackages的路劲的设置。...
weixin_30505225的博客
07-08 5990
最近在看spring-boot的东西，然后搭建了spring-boot的简单项目。但是在spring的入口处加载的时候一直加载不到。最后看了@SpringBootApplication的源码才知道 @ComponentScan 如果不设置basePackage的话 默认会扫描包的所有类，所以最好还是写上basePackage ,减少加载时间。默认扫描**/*.class路径 比如这个注解在com...
SpringBoot（7）--配置文件占位符，profile
一个人的江湖
04-25 3306
内容： 1 随机数 2 占位符获取之前配置的值，如果没有可以使用默认值 3 多Profile文件 4 yml支持多文档块方式 5 激活指定profile配置文件占位符1 随机数${random.uuid}、${random.int}、${random.long} ${random.int(10)}、${random.int[1024,65536]}（1）第一个取出来的是随机数 （2）第二
第2章 SpringBoot核心配置与注解.ppt
03-08
SpringBoot 允许将配置文件中的属性值注入到bean的字段、构造函数参数或方法中。这可以通过 `@ConfigurationProperties` 注解实现，该注解可以绑定整个配置段到一个Java类上，提供更强大的类型安全和验证。 通过...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值