1. 技术文章
  2. spring boot（4）application.properties配置和使用

spring boot（4）application.properties配置和使用

由 房东的猫 提交于 2019-12-23 21:44:05

【推荐】2019 Java 开发者跳槽指南.pdf(吐血整理) >>>

      Spring Boot使用了一个全局的配置文件application.properties，放在src/main/resources目录下或者类路径的/config下。Sping Boot的全局配置文件的作用是对一些默认配置的配置值进行修改。接下来，让我们一起来解开配置文件的面纱。

注:如果你工程没有这个application.properties，那就在src/main/java/resources目录下新建一个。

1 自定义属性

      application.properties提供自定义属性的支持，这样我们就可以把一些常量配置在这里：

com.qiuqiu.name="球球"
com.qiuqiu.want="祝大家鸡年大吉！"

      然后直接在要使用的地方通过注解@Value(value=”${XXX}”)就可以绑定到你想要的属性上面

@RestController
public class UserController {
    @Value("${com.qiuqiu.name}")
    private  String name;
    @Value("${com.qiuqiu.want}")
    private  String want;

    @RequestMapping("/hello")
    public String hello(){
        return name+","+want;
    }
}

      属性很多时，一个个绑定到属性字段上太麻烦，官方提倡绑定一个对象的bean，这里我们建一个ConfigBean.java类，顶部需要使用注解@ConfigurationProperties(prefix = “XXX”)来指明使用哪个  

@ConfigurationProperties(prefix = "com.qiuqiu")
public class ConfigBean {
    private String name;
    private String want;

    // 省略getter和setter
}

        Spring Boot 会自动转换类型，当使用List的时候需要注意在配置中对List进行初始化！Spring Boot 还支持嵌套属性注入。

name=Isea533
servers[0]=dev.bar.com
servers[1]=foo.bar.com
jdbc.username=root
jdbc.password=root
@ConfigurationProperties
public class Config {
    private String name;
    private List<String> servers = new ArrayList<String>();
    private Jdbc jdbc;
    // 省略getter和setter

    class Jdbc {
        private String username;
        private String password;
        // 省略getter和setter
    }
}

      另外一种使用配置文件属性的方式，在@Bean方法上使用@ConfigurationProperties

@ConfigurationProperties(prefix = "com.qiuqiu")
@Bean
public ConfigBean configBean() {
    ...
}

2 属性占位符

      例如：

app.name=MyApp
app.description=${app.name} is a Spring Boot application

      可以在配置文件中引用前面配置过的属性（优先级前面配置过的这里都能用）。通过如${app.name:默认名称}方法还可以设置默认值，当找不到引用的属性时，会使用默认的属性。由于${}方式会被Maven处理。如果你pom继承的spring-boot-starter-parent，Spring Boot 已经将maven-resources-plugins默认的${}方式改为了@ @方式，例如@name@。如果你是引入的Spring Boot，你可以修改使用其他的分隔符。

      通过属性占位符还能缩短命令参数

      例如修改web默认端口需要使用--server.port=9090方式，如果在配置中写上：

server.port=${port:8080}

      那么就可以使用更短的--port=9090，当不提供该参数的时候使用默认值8080。

3 使用自定义配置文件

      有时我们不希望把所有配置都放在application.properties里面，这时候我们可以另外定义一个，这里我们定义一个名为test.properties配置文件，路径跟也放在src/main/resources下面。

com.md.name="球球"
com.md.want="祝大家鸡年大吉"
@Configuration
@ConfigurationProperties(prefix = "com.md") 
@PropertySource("classpath:test.properties")
public class ConfigTestBean {
    private String name;
    private String want;
    // 省略getter和setter
}

注：如果你使用的是1.5以前的版本，那么可以通过locations指定properties文件的位置，这样：
@ConfigurationProperties(prefix = "config2",locations="classpath:test.properties")
但是1.5版本之后就没有这个属性，需要添加@Configuration和@PropertySource(“classpath:test.properties”)后才可以读取。

4 随机值配置

      配置文件中${random.*} 可以用来生成各种不同类型的随机值，从而简化了代码生成的麻烦，例如 生成 int 值、long 值或者 string 字符串。

qiuqiu.secret=${random.value}
qiuqiu.number=${random.int}
qiuqiu.bignumber=${random.long}
qiuqiu.uuid=${random.uuid}
qiuqiu.number.less.than.ten=${random.int(10)}
qiuqiu.number.in.range=${random.int[1024,65536]}

5 外部配置-命令行参数配置

      Spring Boot是基于jar包运行的，打成jar包的程序可以直接通过下面命令运行：

java -jar xx.jar

      可以以下命令修改tomcat端口号：

java -jar xx.jar --server.port=9090

      可以看出，命令行中连续的两个减号--就是对application.properties中的属性值进行赋值的标识。
所以java -jar xx.jar --server.port=9090等价于在application.properties中添加属性server.port=9090。
如果你怕命令行有风险，可以使用SpringApplication.setAddCommandLineProperties(false)禁用它。

      实际上，Spring Boot应用程序有多种设置途径，Spring Boot能从多重属性源获得属性，包括如下几种：

  • 根目录下的开发工具全局设置属性(当开发工具激活时为~/.spring-boot-devtools.properties)。
  • 测试中的@TestPropertySource注解。
  • 测试中的@SpringBootTest#properties注解特性。
  • 命令行参数
  • SPRING_APPLICATION_JSON中的属性(环境变量或系统属性中的内联JSON嵌入)。
  • ServletConfig初始化参数。
  • ServletContext初始化参数。
  • java:comp/env里的JNDI属性
  • JVM系统属性
  • 操作系统环境变量
  • 随机生成的带random.* 前缀的属性（在设置其他属性时，可以应用他们，比如${random.long}）
  • 应用程序以外的application.properties或者appliaction.yml文件
  • 打包在应用程序内的application.properties或者appliaction.yml文件
  • 通过@PropertySource标注的属性源
  • 默认属性(通过SpringApplication.setDefaultProperties指定).

      这里列表按组优先级排序，也就是说，任何在高优先级属性源里设置的属性都会覆盖低优先级的相同属性，例如我们上面提到的命令行属性就覆盖了application.properties的属性。

6 配置文件优先级

      application.properties和application.yml文件可以放在以下四个位置：

  • 外置，在相对于应用程序运行目录的/config子目录里。
  • 外置，在应用程序运行的目录里
  • 内置，在config包内
  • 内置，在Classpath根目录

      同样，这个列表按照优先级排序，也就是说，src/main/resources/config下application.properties覆盖src/main/resources下application.properties中相同的属性，如图：

   此外，如果你在相同优先级位置同时有application.properties和application.yml，那么application.properties里的属性里面的属性就会覆盖application.yml。

7 profile-多环境配置

      当应用程序需要部署到不同运行环境时，一些配置细节通常会有所不同，最简单的比如日志，生产日志会将日志级别设置为WARN或更高级别，并将日志写入日志文件，而开发的时候需要日志级别为DEBUG，日志输出到控制台即可。
      如果按照以前的做法，就是每次发布的时候替换掉配置文件，这样太麻烦了，Spring Boot的Profile就给我们提供了解决方案，命令带上参数就搞定。
      在Spring Boot中多环境配置文件名需要满足application-{profile}.properties的格式，其中{profile}对应你的环境标识，比如：

  • application-dev.properties：开发环境
  • application-prod.properties：生产环境

      想要使用对应的环境，只需要在application.properties中使用spring.profiles.active属性来设置，值对应上面提到的{profile}，这里就是指dev、prod这2个。
      当然你也可以用命令行启动的时候带上参数：

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

      除了可以用profile的配置文件来分区配置我们的环境变量，在代码里，我们还可以直接用@Profile注解来进行配置，例如数据库配置，这里我们先定义一个接口 :

public  interface DBConnector {
    public  void  configure(); 
}

      定义俩个实现类来实现它:

/**
  * 测试数据库
  */
@Component
@Profile("testdb")
public class TestDBConnector implements DBConnector {
    @Override
    public void configure() {
        System.out.println("testdb");
    }
}
/**
 * 生产数据库
 */
@Component
@Profile("devdb")
public class DevDBConnector implements DBConnector {
    @Override
    public void configure() {
        System.out.println("devdb");
    }
}

      通过在配置文件激活具体使用哪个实现类

spring.profiles.active=testdb

      然后就可以如下方使用：

@RestController
@RequestMapping("/task")
public class TaskController {

    @Autowired DBConnector connector ;

    @RequestMapping(value = "/hello")
    public String helloTask(){

        connector.configure(); //最终打印testdb     
        return "hello task !! myage is " + myage;
    }
}

      除了spring.profiles.active来激活一个或者多个profile之外，还可以用spring.profiles.include来叠加profile。

spring.profiles.active=testdb  
spring.profiles.include=proddb,prodmq

8 读取系统环境变量和application配置文件中的属性

  • 实现EnvironmentAware接口
import org.springframework.boot.bind.RelaxedPropertyResolver;
import org.springframework.context.EnvironmentAware;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;

@Configuration
public class MyEnvironmentAware implements EnvironmentAware {
	/**
	 * 注意重写的方法 setEnvironment是在系统启动的时候被执行。
	 */
	@Override
	public void setEnvironment(Environment environment) {
		// 通过 environment 获取到系统属性.
		System.out.println(environment.getProperty("JAVA_HOME"));

		// 通过 environment 同样能获取到application.properties配置的属性.
		System.out.println(environment.getProperty("spring.datasource.url"));

		// 获取到前缀是"spring.datasource." 的属性列表值.
		RelaxedPropertyResolver relaxedPropertyResolver = new RelaxedPropertyResolver(environment,
				"spring.datasource.");
		System.out.println("spring.datasource.url=" + relaxedPropertyResolver.getProperty("url"));
		System.out.println("spring.datasource.driverClassName=" + relaxedPropertyResolver.getProperty("driverClassName"));
	}
}
  • 实现ApplicationContextAware接口
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;

@Component
public class SpringCtxHolder implements ApplicationContextAware {

    private static ApplicationContext applicationContext;

    private static Environment env;

    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        SpringCtxHolder.applicationContext = applicationContext;
        env = applicationContext.getEnvironment();
    }

    public static Environment getEnv() {
        return env;
    }

    public static void setEnv(Environment env) {
        SpringCtxHolder.env = env;
    }

    public static String getProperty(String key) {
        if (StringUtils.isEmpty(key)) {
            return "";
        }
        return env.getProperty(key);
    }
}
SpringCtxHolder.getProperty("spring.datasource.url");

 

标签
boot
string
properties
易学教程内所有资源均来自网络或用户发布的内容，如有违反法律规定的内容欢迎反馈！
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!