SpringBoot配置详解

朴灿烈づ我的快乐病毒、 2022-05-21 09:23 148阅读 0赞

> SpringBoot 虽然干掉了 XML 但未做到 零配置，它体现出了一种 约定优于配置，也称作按约定编程，是一种软件设计范式，旨在减少软件开发人员需做决定的数量，获得简单的好处，而又不失灵活性。 一般情况下默认的配置足够满足日常开发所需，但在特殊的情况下，我们往往需要用到自定义属性配置、自定义文件配置、多环境配置、外部命令引导等一系列功能。不用担心，这些 SpringBoot 都替我们考虑好了，我们只需要遵循它的规则配置即可

## 1 准备 ##

为了让 Spring Boot 更好的生成配置元数据文件，我们需要添加如下依赖（该依赖可以不添加，但是在 IDEA 和 STS 中不会有属性提示，没有提示的配置就跟你用记事本写代码一样苦逼，出个问题弄哭你去），该依赖只会在编译时调用，所以不用担心会对生产造成影响…

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

## 2 自定义属性配置 ##

在 application.properties 写入如下配置内容

my1.age=22
    my1.name=battcn

其次定义 MyProperties1.java 文件，用来映射我们在 application.properties 中的内容，这样一来我们就可以通过操作对象的方式来获得配置文件的内容了

package com.battcn.properties;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    
    /** * @author Levin * @since 2018/4/23 0023 */
    @Component
    @ConfigurationProperties(prefix = "my1")
    public class MyProperties1 { 
    
        private int age;
        private String name;
        // 省略 get set
    
        @Override
        public String toString() {
            return "MyProperties1{" +
                    "age=" + age +
                    ", name='" + name + '\'' +
                    '}';
        }
    }

接下来就是定义我们的 PropertiesController 用来注入 MyProperties1 测试我们编写的代码，值得注意的是 Spring4.x 以后，推荐使用构造函数的形式注入属性…

import com.battcn.properties.MyProperties1;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /** * @author Levin * @since 2018/4/23 0023 */
    @RequestMapping("/properties")
    @RestController
    public class PropertiesController { 
    
        private static final Logger log = LoggerFactory.getLogger(PropertiesController.class);
    
        private final MyProperties1 myProperties1;
    
        @Autowired
        public PropertiesController(MyProperties1 myProperties1) {
            this.myProperties1 = myProperties1;
        }
    
        @GetMapping("/1")
        public MyProperties1 myProperties1() {
            log.info("=================================================================================================");
            log.info(myProperties1.toString());
            log.info("=================================================================================================");
            return myProperties1;
        }
    }

打开浏览器，输入如下地址： [http://localhost:8080/properties/1][http_localhost_8080_properties_1]，观察控制台，监听到如下内容则表示程序正确

2018-04-23 15:51:43.145  INFO 15352 --- [nio-8080-exec-2] c.b.controller.PropertiesController : =================================================================================================
    2018-04-23 15:51:43.145  INFO 15352 --- [nio-8080-exec-2] c.b.controller.PropertiesController : MyProperties1{
       age=22, name='battcn'}
    2018-04-23 15:51:43.145  INFO 15352 --- [nio-8080-exec-2] c.b.controller.PropertiesController : =================================================================================================

## 3 自定义文件配置 ##

定义一个名为 my2.properties 的资源文件，自定义配置文件的命名不强制 application 开头

my2.age=22
    my2.name=Levin
    my2.email=1837307557@qq.com

其次定义 MyProperties2.java 文件，用来映射我们在 my2.properties 中的内容

package com.battcn.properties;
    
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.context.annotation.PropertySource;
    import org.springframework.stereotype.Component;
    
    /** * @author Levin * @since 2018/4/23 0023 */
    @Component
    @PropertySource("classpath:my2.properties")
    @ConfigurationProperties(prefix = "my2")
    public class MyProperties2 { 
    
        private int age;
        private String name;
        private String email;
        // 省略 get set 
    
        @Override
        public String toString() {
            return "MyProperties2{" +
                    "age=" + age +
                    ", name='" + name + '\'' +
                    ", email='" + email + '\'' +
                    '}';
        }
    }

接下来在 PropertiesController 用来注入 MyProperties2 测试我们编写的代码

@GetMapping("/2")
    public MyProperties2 myProperties2() {
        log.info("=================================================================================================");
        log.info(myProperties2.toString());
        log.info("=================================================================================================");
        return myProperties2;
    }

打开浏览器，输入如下地址： [http://localhost:8080/properties/2][http_localhost_8080_properties_2]，观察控制台，监听到如下内容则表示程序正确

2018-04-23 15:59:45.395  INFO 6232 --- [nio-8080-exec-4] c.b.controller.PropertiesController : =================================================================================================
    2018-04-23 15:59:45.395  INFO 6232 --- [nio-8080-exec-4] c.b.controller.PropertiesController : MyProperties2{
       age=22, name='Levin', email='1837307557@qq.com'}
    2018-04-23 15:59:45.395  INFO 6232 --- [nio-8080-exec-4] c.b.controller.PropertiesController : =================================================================================================

## 4 多环境化配置 ##

在真实的应用中，常常会有多个环境（如：开发，测试，生产等），不同的环境数据库连接都不一样，这个时候就需要用到spring.profile.active 的强大功能了，它的格式为 application-\{profile\}.properties，这里的 application 为前缀不能改，\{profile\} 是我们自己定义的。

创建 application-dev.properties、application-test.properties、application-prod.properties，内容分别如下

*  application-dev.properties

server.servlet.context-path=/dev

*  application-test.properties

server.servlet.context-path=/test

*  application-prod.properties

server.servlet.context-path=/prod

在 application.properties 配置文件中写入 spring.profiles.active=dev，这个时候我们在次访问 [http://localhost:8080/properties/1][http_localhost_8080_properties_1] 就没用处了，因为我们设置了它的context-path=/dev，所以新的路径就是 [http://localhost:8080/dev/properties/1][http_localhost_8080_dev_properties_1] ，由此可以看出来我们激活不同的配置读取的属性值是不一样的

## 5 外部命令引导 ##

前面三种方式都是基于配置文件层面的，那么有没有办法外部引导呢，假设这样的场景，我们对已经开发完成的代码打包发布，期间在测试环境测试通过了，那么即可发布上生产，这个时候是修改application.properties的配置方便还是直接在命令参数配置方便呢，毫无疑问是后者更有说服力。默认情况下，SpringApplication 会将命令行选项参数（即：–property，如–server.port=9000）添加到Environment，命令行属性始终优先于其他属性源。

*  进入到项目目录，此处以我本地目录为主：F:/battcn-workspace/spring-boot2-learning/chapter2  
    然后打开 cmd 程序，不会在当前目录打开 cmd 的请自行百度，输入：mvn package
 *  打包完毕后进入到：F:/battcn-workspace/spring-boot2-learning/chapter2/target 目录中去，我们可以发现一个名为chapter2-0.0.1-SNAPSHOT.jar 的包
 *  接着在打开 cmd 程序，输入：java -jar chapter2-0.0.1-SNAPSHOT.jar –spring.profiles.active=test –my1.age=32。仔细观察spring.profiles.active=test、my1.age=32 这俩配置的键值是不是似曾相识（不认识的请从开头认真阅读）
 *  最后输入测试地址：[http://localhost:8080/test/properties/1][http_localhost_8080_test_properties_1] 我们可以发现返回的JSON变成了 \{“age”:32,”name”:”battcn”\} 表示正确

## 6 外部配置 ##

Spring Boot允许您外部化配置，以便您可以在不同的环境中使用相同的应用程序代码。您可以使用属性文件，YAML文件，环境变量和命令行参数来外部化配置。属性值可以通过直接注射到你的bean @Value注释，通过Spring的访问Environment抽象，或者被 绑定到结构化对象通过@ConfigurationProperties。

Spring Boot使用一种非常特殊的PropertySource顺序，旨在允许合理地覆盖值。按以下顺序考虑属性：

Devtools 主目录上的全局设置属性（~/.spring-boot-devtools.properties当devtools处于活动状态时）。
    @TestPropertySource 测试上的注释。
    @SpringBootTest#properties 测试中的注释属性。
    命令行参数。
    来自SPRING_APPLICATION_JSON（嵌入在环境变量或系统属性中的内联JSON）的属性。
    ServletConfig init参数。
    ServletContext init参数。
    JNDI属性来自java:comp/env。
    Java系统属性（System.getProperties()）。
    OS环境变量。
    一RandomValuePropertySource，只有在拥有性能random.*。
    特定于配置文件的应用程序属性在打包的jar（application-{profile}.properties和YAML变体）之外。
    打包在jar中的特定于配置文件的应用程序属性（application-{profile}.properties 以及YAML变体）。
    应用程序属性在打包的jar之外（application.properties和YAML变体）。
    打包在jar中的应用程序属性（application.properties和YAML变体）。
    @PropertySource 你的@Configuration课上的注释。
    默认属性（由设置指定SpringApplication.setDefaultProperties）。

要提供一个具体示例，假设您开发了一个@Component使用name 属性的示例，如以下示例所示：

import org.springframework.stereotype。*
     import org.springframework.beans.factory.annotation。* @Component public class MyBean {  @Value（“$ {name}”） private String name; // ... 
    }

在应用程序类路径上（例如，在jar中），您可以拥有一个 application.properties为其提供合理的默认属性值的文件name。在新环境中运行时，application.properties可以在jar外部提供一个覆盖的文件name。对于一次性测试，您可以使用特定的命令行开关启动（例如，java -jar app.jar –name=”Spring”）。

该SPRING_APPLICATION_JSON属性可以以环境变量在命令行上被供给。例如，您可以在UN * X shell中使用以下行：
    
    $ SPRING_APPLICATION_JSON ='{“acme”：{“name”：“test”}}'java -jar myapp.jar
    在前面的示例中，您最终会acme.name=test在Spring中结束Environment。您还可以像spring.application.json在System属性中一样提供JSON ，如以下示例中所示：
    
    $ java -Dspring.application.json ='{“name”：“test”}'-jar myapp.jar
    您还可以使用命令行参数提供JSON，如以下示例所示：
    
    $ java -jar myapp.jar --spring.application.json ='{“name”：“test”}'
    您还可以将JSON作为JNDI变量提供，如下所示： java:comp/env/spring.application.json。

## 6 总结 ##

*  掌握@ConfigurationProperties、@PropertySource 等注解的用法及作用
 *  掌握编写自定义配置
 *  掌握外部命令引导配置的方式

[http_localhost_8080_properties_1]: http://localhost:8080/properties/1
[http_localhost_8080_properties_2]: http://localhost:8080/properties/2
[http_localhost_8080_dev_properties_1]: http://localhost:8080/dev/properties/1
[http_localhost_8080_test_properties_1]: http://localhost:8080/test/properties/1