5.Spring Boot 自定义配置、导入XML配置与外部化配置

关注

原创 2022-03-15 11:22:08 2.1w 阅读 AI 写同款· GEO 优化 ›

在Spring Boot中导入和解析XML文件的实践总结来说，在Spring Boot项目中导入和解析XML文件主要分为两步：一是通过Spring的Resource机制获取XML文件资源，二是利用诸如DOM4J这样的XML解析库将XML文件转换为可操作的对象结构。}上述代码中，我们首先通过ClassPathResource加载类路径下的"example.xml"文件，然后使用SAXReader将其读取并解析成一个Document对象，这样就可以对XML文档进行各种操作了。}以上代码展示了如何获取XML文件的所有子节点及其名称和值。阅读详情

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中加入以下依赖：

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

第一种：

（1）在src/main/resources下新建application.properties文件并加入以下代码：

file.upload.stor-path=E:/test/

（2）直接使用@Value注解方式，具体代码如下：

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类

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）入口启动类代码如下：

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;