欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Spring Boot: 配置文件详解

程序员文章站 2022-05-29 09:13:48
SpringBoot是为了简化Spring应用的创建、运行、调试、部署等一系列问题而诞生的产物,自动装配的特性让我们可以更好的关注业务本身而不是外部的XML配置,我们只需遵循规范,引入相关的依赖就可以轻易的搭建出一个 WEB 工程。 一、准备前提 为了让SpringBoot更好的生成数据,我们需要添 ......

springboot是为了简化spring应用的创建、运行、调试、部署等一系列问题而诞生的产物,自动装配的特性让我们可以更好的关注业务本身而不是外部的xml配置,我们只需遵循规范,引入相关的依赖就可以轻易的搭建出一个 web 工程。

一、准备前提

为了让springboot更好的生成数据,我们需要添加如下依赖(该依赖可以不添加,但是在 idea 不会有属性提示),该依赖只会在编译时调用,所以不用担心会对生产造成影响…

<dependency>
    <groupid>org.springframework.boot</groupid>
    <artifactid>spring-boot-configuration-processor</artifactid>
    <optional>true</optional>
</dependency>

二、自定义属性配置

springboot 主配置文件默认为application.yml或者application.properties,我更喜欢用前者,所以文章中基本以第一种为例读取自定义属性

2.1 application.yml 自定义属性

server:
  port: 8081

original:
  config:
    title: originalconfig
    description: 主配置文件中属性

2.2 新建originalconfig配置类

该配置类用来映射我们在application.yml中的内容,这样一来我们就可以通过操作对象的方式来获得配置文件的内容了。

@data
@component
public class originalconfig {
    /**
     * 注入 application.yml 配置
     *
     */
    @value("${original.config.title}")
    private string title;

    @value("${original.config.description}")
    private string description;
    
}

这里,可以采用@configurationproperties简化@value注入值的写法,详见文末github源码写法。

2.3 configtest.java测试

2.3.1 测试方法testoriginalconfig

    @autowired
    originalconfig originalconfig;

    /**
     * 读取自定义属性
     */
    @test
    public void testoriginalconfig() {
        system.out.println("开始读取 application.yml 的自定义属性:");
        system.out.println("读取配置信息:");
        system.out.println("title: " + originalconfig.gettitle());
        system.out.println("desc: " + originalconfig.getdescription());
        system.out.println("application.yml 文件的属性读取完毕!");
    }

2.3.2 控制台打印如下:

开始读取 application.yml 的自定义属性:
读取配置信息:
title: originalconfig
desc: 主配置文件中属性
application.yml 文件的属性读取完毕!

三、自定义文件配置

3.1 定义一个名为myconfig.properties的自定义文件

自定义配置文件的命名不强制application开头

customize.config.title=customizeconfig
customize.config.description=自定义配置文件中属性

3.2 新建customizeconfig配置类

该配置类用来映射我们在myconfig.properties中的内容,这样一来我们就可以通过操作对象的方式来获得配置文件的内容了。

@data
@component
@propertysource(value = "classpath:myconfig.properties", encoding = "utf-8")
public class customizeconfig {
    /**
     * 注入 myconfig.properties 配置
     *
     */
    @value("${customize.config.title}")
    private string title;

    @value("${customize.config.description}")
    private string description;
}
  • @propertysource :配置文件路径和编码格式

2.3 单元测试

    @autowired
    customizeconfig customizeconfig;

    /**
     * 从 myconfig.properties 获取配置
     */
    @test
    public void testcustomizeconfig() {
        system.out.println("开始读取 myconfig.properties 文件的属性:");
        system.out.println("title: " + customizeconfig.gettitle());
        system.out.println("desc: " + customizeconfig.getdescription());
        system.out.println("myconfig.properties 文件的属性读取完毕!");
    }
  • 控制台打印如下:
开始读取 myconfig.properties 文件的属性:
title: customizeconfig
desc: 自定义配置文件中属性
myconfig.properties 文件的属性读取完毕!

三、多环境化配置

真实的应用中,常常会有多个环境(如:本地,开发,测试,正式),不同的环境数据库连接都不一样,这个时候就需要用到spring.profile.active,它的格式为application-{profile}.yml,这里的application为前缀不能改,{profile}是我们自己定义的。

3.1 指定不同环境的路径

通过server.servlet.context-path将不同环境指定不同的路径。

  • application-local.yml
title: local配置文件
server:
  servlet:
    context-path: /local
  • application-daily.yml
title: daily配置文件
server:
  servlet:
    context-path: /daily
  • application-gray.yml
title: gray配置文件
server:
  servlet:
    context-path: /gray
  • application-production.yml
title: production配置文件
server:
  servlet:
    context-path: /production

3.2 新增配置类envconfig.java

@data
@configuration
public class envconfig {

    @value("${title}")
    private string title;
}

3.3 测试方法

    @autowired
    envconfig envconfig;

    /**
     * 从 不同环境配置读取
     */
    @test
    public void testenvconfig() {
        system.out.println("开始读取 不同环境 文件的属性:");
        system.out.println("title: " + envconfig.gettitle());
        system.out.println("myconfig.properties 文件的属性读取完毕!");
    }

3.4 激活某个环境配置

application.yml配置文件中指定环境,例如指定gray环境:

spring:
  profiles:
    active: daily
  • 控制台打印如下:
开始读取 不同环境 文件的属性:
title: gray配置文件
myconfig.properties 文件的属性读取完毕!

这里指定不同的环境配置文件,即可访问到不同环境的配置。

四、源码地址

https://github.com/vandusty/springboot-home/tree/master/springboot-demo-list/springboot-demo-config