玩转Spring Boot 自定义配置、导入XML配置与外部化配置

在这里我会全面介绍在Spring Boot里面如何自定义配置,更改Spring Boot默认的配置,以及介绍各配置的优先级顺序。Spring Boot使用一个全局的配置文件application.properties,Spring Boot 支持使用YAML语言的配置文件,YAML是以数据位中心的语言,所以使用application.yml作为全局配置也是同样的效果,如果使用YAML替代properties注意写法,冒号后面要加个空格,否则会解析不出来。而且在Spring

Boot里面配置名称支持多种方式,例如:server.ssl.key-store,可以写成:server.ssl.keyStore都是可以的。下面具体详细介绍。

1.引用XML文件配置

在实际项目中有的情况需要使用到XML配置文件,或者是你还不习惯用Java 配置的方式,那么你可以通过在入口启动类上加上@ImportResource(value = { "路径" })或者使用@ImportResource(locations= { "路径" }),一样的效果,多个XML文件的话你可以用逗号“,”分隔,就这样轻而易举的引用XML配置。

2.引入多个@Configuration 配置类

在实际项目中可能不会把所有的配置都放在一个配置类(用@Configuration注解的类)中,可能会分开配置。这时可以用@Import注解引用。

3.引用自定义properties

Spring Boot使用全局配置(application.properties)提供了很多的默认的配置属性。在开发的时候,大多数会用到自定义的一些配置属性,例如:指定上传文件保存的路径,定义:file.upload.stor-path=E:/test/,Spring Boot 提供了@Value注解获取properties中的属性,还提供了基于类型安全的配置方式,通过@ConfigurationProperties将properties属性注入到一个Bean中,在1.4以上版本官方不建议使用@ConfigurationProperties来指定properties文件位置。接下来请看实例:

在pom.xml中加入以下依赖:

org.springframework.boot

spring-boot-configuration-processor

true

org.springframework.boot

spring-boot-configuration-processor

true

第一种:

(1) 在src/main/resources下新建application.properties文件并加入以下代码:

file.upload.stor-path=E:/test/file.upload.stor-path=E:/test/      (2)直接使用@Value注解方式,具体代码如下:

packagecom.chengli.springboot.helloworld;

importorg.springframework.beans.factory.annotation.Value;

importorg.springframework.boot.SpringApplication;

importorg.springframework.boot.autoconfigure.SpringBootApplication;

importorg.springframework.web.bind.annotation.RequestMapping;

importorg.springframework.web.bind.annotation.RestController;

@RestController

@SpringBootApplication

publicclassSampleController {

@Value(value ="${file.upload.stor-path}")

privateString storPath;

@RequestMapping("/")

String home() {

return"Hello World! file.upload.stor-path为:"+ storPath;

}

publicstaticvoidmain(String[] args)throwsException {

SpringApplication springApplication = newSpringApplication(SampleController.class);

springApplication.run(args);

}

}package com.chengli.springboot.helloworld;

import org.springframework.beans.factory.annotation.Value;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

@RestController

@SpringBootApplication

public class SampleController {

@Value(value = "${file.upload.stor-path}")

private String storPath;

@RequestMapping("/")

String home() {

return "Hello World! file.upload.stor-path为:" + storPath;

}

public static void main(String[] args) throws Exception {

SpringApplication springApplication = new SpringApplication(SampleController.class);

springApplication.run(args);

}

}第二种:

属性配置放在application.properties文件中,使用@ConfigurationProperties将配置属性注入到Bean中,代码如下:

(1)定义FileUploadProperties类

packagecom.chengli.springboot.helloworld;

importorg.springframework.boot.context.properties.ConfigurationProperties;

importorg.springframework.stereotype.Component;

@Component

@ConfigurationProperties(prefix ="file.upload")

publicclassFileUploadProperties {

privateString storPath;

publicString getStorPath() {

returnstorPath;

}

publicvoidsetStorPath(String storPath) {

this.storPath = storPath;

}

}package com.chengli.springboot.helloworld;

import org.springframework.boot.context.properties.ConfigurationProperties;

import org.springframework.stereotype.Component;

@Component

@ConfigurationProperties(prefix = "file.upload")

public class FileUploadProperties {

private String storPath;

public String getStorPath() {

return storPath;

}

public void setStorPath(String storPath) {

this.storPath = storPath;

}

}      (2)入口启动类代码如下:

packagecom.chengli.springboot.helloworld;

importorg.springframework.beans.factory.annotation.Autowired;

importorg.springframework.boot.SpringApplication;

importorg.springframework.boot.autoconfigure.SpringBootApplication;

importorg.springframework.web.bind.annotation.RequestMapping;

importorg.springframework.web.bind.annotation.RestController;

@RestController

@SpringBootApplication

publicclassSampleController {

@Autowired

privateFileUploadProperties fileUploadProperties;

@RequestMapping("/")

String home() {

return"Hello World! file.upload.stor-path为:"+ fileUploadProperties.getStorPath();

}

publicstaticvoidmain(String[] args)throwsException {

SpringApplication springApplication = newSpringApplication(SampleController.class);

springApplication.run(args);

}

}package com.chengli.springboot.helloworld;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

@RestController

@SpringBootApplication

public class SampleController {

@Autowired

private FileUploadProperties fileUploadProperties;

@RequestMapping("/")

String home() {

return "Hello World! file.upload.stor-path为:" + fileUploadProperties.getStorPath();

}

public static void main(String[] args) throws Exception {

SpringApplication springApplication = new SpringApplication(SampleController.class);

springApplication.run(args);

}

}      注意:这里我对FileUploadProperties使用了@Component注解,如果没有使用@Component注解,则需要在入口启动类上加上@EnableConfigurationProperties注解。Spring Boot 在properties文件中支持使用SpEL表达式,可以进行校验(校验注解使用的是javax.validation)等操作。

例如以下:

(1)随机数:

test.int.random=${random.int}

(2)数组注入

test.int.random[0]=${random.int}

test.int.random[1]=${random.int}

(3)校验

@NotNull

private String storPath;

4.外部化配置(配置方式与优先级)

Spring Boot 允许外化配置,Spring Boot使用了一个特别的PropertySource次序来允许对值进行覆盖,覆盖的优先级顺序如下:

(1)Devtools全局设置主目录(~ /.spring-boot-devtools.properties 为活跃的)。

(2)@TestPropertySource注解在Test。

(3)@SpringBootTest#properties 注解在Test。

(4)命令行参数。

(5)从SPRING_APPLICATION_JSON属性(内联JSON嵌入在一个环境变量或系统属性)。

(6)ServletConfig init参数。

(7)ServletContext init参数。

(8)JNDI属性java:comp/env。

(9)Java系统属性(System.getProperties())。

(10)操作系统环境变量。

(11)RandomValuePropertySource配置的random.*属性值

(12)打包在jar以外的application-{profile}.properties或application.yml配置文件

(13)打包在jar以内的application-{profile}.properties或application.yml配置文件

(14)打包在jar以外的application.properties或application.yml配置文件

(15)打包在jar以内的application.properties或application.yml配置文件

(16)@configuration注解类上的@PropertySource。

(17)默认的属性(使用SpringApplication.setDefaultProperties指定)。

a) 通过命令行来修改默认参数,例如:

启动命令:java -jar *.jar --name="chengli"

以上的意思是,将name值修改为:chengli

b) 通过命令行来设置加载properties 例如:

java -jar *.jar --spring.profiles.active=dev

这里如果不了解profile的话,后面的文章中会介绍到。

5.application.properties文件按优先级,优先级高的会覆盖优先级低的

优先级顺序如下:

(1)当前目录下的一个/config子目录

(2)当前目录

(3)一个classpath下的/config包

(4)classpath根目录

有兴趣的朋友可以加群探讨相互学习:

Spring Boot QQ交流群:599546061

Logo

魔乐社区(Modelers.cn) 是一个中立、公益的人工智能社区,提供人工智能工具、模型、数据的托管、展示与应用协同服务,为人工智能开发及爱好者搭建开放的学习交流平台。社区通过理事会方式运作,由全产业链共同建设、共同运营、共同享有,推动国产AI生态繁荣发展。

更多推荐