SpringBoot 配置

最新推荐文章于 2024-08-31 17:16:56 发布

miao95

最新推荐文章于 2024-08-31 17:16:56 发布

阅读量590

点赞数

分类专栏： SpringBoot

本文链接：https://blog.csdn.net/sinat_30436087/article/details/80455621

版权

SpringBoot 专栏收录该内容

4 篇文章 0 订阅

订阅专栏

1.配置文件

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

application.properties
application.yml

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

YAML（YAML Ain’t Markup Language）

YAML 是专门用来写配置文件的语言，以数据为中心，比 xml, JSON 格式方便

YAML配置实例：

server:
  port: 8081

XML配置实例：

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

2.YAML语法

1.基本语法

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

server:
    port: 8081
    path: /hello

属性和值都是大小写敏感

2.值的写法

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

 k: v 
  字符串默认加单引号或双引号，不用再添加
     "" ： 双引号中的特殊字符无法转义
     name: "miao \n  hao "    输出：miao 换行 hao 
     '' ：单引号中的特殊字符被转义 
     name:'miao \n hao'       输出：miao \n hao

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

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

  people:
         name: miao
         age: 23

行内写法

    people: {name: miao, age: 23}

数组（List，Set）

用-表示数组的一个元素

pets:
    -cat:
    -pig:
    -dog:

行内写法：

pets: [cat,pig,dog]

3.配置文件值注入

配置文件 application.yml

person:
  name: miao
  age: 23
  boss: false
  birth: 1995/05/31
  maps: {k1: v1,k2: v2}
  lists:
    - lisi
    - zhangsan
  dog:
    name: 大黄
    age: 3

让配置文件和创建的类一一对应
这里写图片描述
根据上方红色提示，导入配置文件处理器

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

application.properties

person.name=闵豪
person.age=18
person.boss=true
person.birth=1995/05/31
person.maps.k1=v1
person.maps.k2=v2
person.lists=a,b,c
person.dog.name=dog
person.dog.age=3

@ConfigurationProperties和@Value获取值比较

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

那该选择哪一个呢？
如果我们只是在某个业务逻辑中需要获取配置文件中的一个值，用@Value
如果我们专门写了一个JavaBean来和配置文件映射，用@ConfigurationProperties

配置文件注入值校验

@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
    //@Value("${person.name}")
    @Email
    private String name;
    private Integer age;
    private Boolean boss;
    private Date birth;

@PropertySource和@ImportResource

@PropertySource：加载指定的配置文件
创建一个person.properties的文件，写好属性和值，在类中添加@PropertySource注解

@PropertySource(value = "classpath:person.properties")

@ImportResource：导入spring的配置文件，让文件内容生效。
SpringBoot里面没有Spring的配置文件，自己编写的配置文件也不能自动识别。要让配置文件生效，加载进来，使用@ImportResource标注在一个类上
bean.xml

<bean id="helloService" class="com.miao.springboothelloworld.service.HelloService" ></bean>

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

SpringBoot 推荐给容器添加组件的方法：推荐是用全注解的方式
SpringBoot中配置类就相当于配置文件，在配置类中添加@Bean注解

**
 * @Configuration指明当前类为配置类：用来替代spring的配置文件
 */
@Configuration
public class MyAppConfig {

    //将方法的返回值添加到容器中，容器组件默认的id就为方法名
    @Bean
    public HelloService helloService() {
        System.out.println("给容器中添加组件");
        return new HelloService();
    }
}

4.配置文件占位符

1.随机数

这里写图片描述

2.占位符获取之前指定的值，如果没有就用：获取默认值

person.name=闵豪${random.uuid}
person.age=${random.int(20)}
person.boss=true
person.birth=1995/05/31
person.maps.k1=v1
person.maps.k2=v2
person.lists=a,b,c
person.dog.name=${person.hello: hello}_dog #获取默认值
person.dog.age=3

5.Profile

Profile是Spring对不同环境提供不同配置功能的支持，可以通过激活、指定参数等方式快速切换环境。

1.多Profile文件

这里写图片描述
我们在主配置文件编写的时候，配置名可以为application-{profile}.properties/yml
默认使用application.properties的配置

2.yml支持多文档块方式

以- - -作为分隔文档块的方法
properties.yml

server:
  port: 8080
spring:
  profiles:
    active: prod
---
server:
  port: 8089
spring:
  profiles: dev
---
server:
  port: 8090
spring:
  profiles: prod

3.激活指定Profile

在配置文件中指定：spring.profiles.active=dev
命令行的方式 program arguments： java -jar --spring.profiles.active=dev 用来测试配置传输命令行参数
虚拟机参数 VM option：-Dspring.profiles.active=dev
可在图中直接修改，从而指定想要的profile

6.配置文件加载位置

优先级由高到低：

-file:./config/  项目下创建config文件夹
-file:./
-classpath:/config/
-classpath:/

高优先的配置会覆盖掉低优先级的配置；springboot会从这四个位置全部加载主配置文件；互补配置

这里写图片描述

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

7.外部配置加载顺序

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

官方文档

1.命令行参数

java -jar springboot-config-0.0.1-SNAPSHOT.jar --server.port=8099 --server.path=/miao

多个配置用空格分开，
2.来自java:comp/env的JNDI属性

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

4.操作系统环境变量

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

优先加载profile, 由jar包外到jar包内

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指定的默认属性

8.自动配置原理

配置文件可以配置的属性参考

自动配置原理

(1) Springboot启动的时候加载主配置类，开启自动配置功能@EnableAutoConfiguration

(2) @EnableAutoConfiguration的作用：利用EnableAutoConfigurationImportSelector导入一些组件；查看selectImports方法的内容；

 public String[] selectImports(AnnotationMetadata annotationMetadata) {
        if (!this.isEnabled(annotationMetadata)) {
            return NO_IMPORTS;
        } else {
            try {
                AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader.loadMetadata(this.beanClassLoader);
                AnnotationAttributes attributes = this.getAttributes(annotationMetadata);
                //获取候选的配置
                List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
                configurations = this.removeDuplicates(configurations);
                configurations = this.sort(configurations, autoConfigurationMetadata);
                Set<String> exclusions = this.getExclusions(annotationMetadata, attributes);
                this.checkExcludedClasses(configurations, exclusions);
                configurations.removeAll(exclusions);
                configurations = this.filter(configurations, autoConfigurationMetadata);
                this.fireAutoConfigurationImportEvents(configurations, exclusions);
                return (String[])configurations.toArray(new String[configurations.size()]);
            } catch (IOException var6) {
                throw new IllegalStateException(var6);
            }
        }
    }


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

# Failure analyzers
org.springframework.boot.diagnostics.FailureAnalyzer=\
org.springframework.boot.autoconfigure.diagnostics.analyzer.NoSuchBeanDefinitionFailureAnalyzer,\
org.springframework.boot.autoconfigure.jdbc.DataSourceBeanCreationFailureAnalyzer,\
org.springframework.boot.autoconfigure.jdbc.HikariDriverConfigurationFailureAnalyzer

# Template availability providers
org.springframework.boot.autoconfigure.template.TemplateAvailabilityProvider=\
org.springframework.boot.autoconfigure.freemarker.FreeMarkerTemplateAvailabilityProvider,\
org.springframework.boot.autoconfigure.mustache.MustacheTemplateAvailabilityProvider,\
org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAvailabilityProvider,\
org.springframework.boot.autoconfigure.thymeleaf.ThymeleafTemplateAvailabilityProvider,\
org.springframework.boot.autoconfigure.web.JspTemplateAvailabilityProvider

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

(3) 每一个自动配置类进行自动配置功能

(4) 以HttpEncodingAutoConfiguration为例分析自动配置原理

@Configuration //表示这是一个配置类，可以给容器中添加组件
//启动指定类的ConfigurationProperties功能；将配置文件中对应的值和HttpEncodingProperties绑定起来
@EnableConfigurationProperties({HttpEncodingProperties.class})
@ConditionalOnWebApplication//Spring底层@Conditional注解；判断当前应用是否是web应用
@ConditionalOnClass({CharacterEncodingFilter.class})//判断当前项目有没有这个类
@ConditionalOnProperty(
    prefix = "spring.http.encoding",
    value = {"enabled"},
    matchIfMissing = true
)//判断配置文件中是否有这个spring.http.encoding配置
public class HttpEncodingAutoConfiguration {

    //给容器添加组件，这个组件的值需要从properties属性中获取
    private final HttpEncodingProperties properties;

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

    @Bean
    @ConditionalOnMissingBean
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        filter.setForceRequestEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpEncodingProperties.Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpEncodingProperties.Type.RESPONSE));
        return filter;
    }

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

(5) 所有配置文件中能配置的属性都是在xxxProperties类中封装着

@ConfigurationProperties(
    prefix = "spring.http.encoding"
)//从配置文件中获取指定的值或者bean的属性进行绑定
public class HttpEncodingProperties {

SpringBoot的精髓：

SpringBoot启动会加载大量的自动配置类
我们看我们需要的功能有没有SpringBoot默认写好的默认配置类
如果有在看这个自动配置类中配置了哪些组件；（只要我们要用的组件有，我们就不需要再来配置）
给容器中自动配置添加组件的时候，会从properties类中获取属性。我们就可以在配置文件中指定这些属性的值

例如：
xxxAutoConfiguration:自动配置类；给容器中添加组件

xxxProperties:封装配置文件中的属性；

细节

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

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

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

自动配置类必须在一定条件下生效
我们可以通过在application.properties中启用debug=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)