写点什么

spring boot 自定义配置文件 & 参数绑定

作者:Java高工P7
  • 2021 年 11 月 11 日
  • 本文字数:4432 字

    阅读完需:约 15 分钟

注意:如果 Map 类型的 key 包含非字母数字和-的字符,需要用[]括起来,比如:


spring:


my-example:


'[foo.baz]': bar


注入 Map(String,Object)格式的 map 对象:


@Service("mc_member:openMemberCard")//这是 map 的 key


public class RegisterServiceImpl implements WmeimobMsgService {


@Override


public boolean execute(String param) {


// todo 执行推送会员信息


return false;


}


}


@Autowired


private Map<String,WmeimobMsgService> wmeimobMsgService;


配置文件与配置类的属性映射方式




使用注解 @Value 映射:


application.properties 配置:


person.name=zhangsan


person.age=18


或者,application.yml 配置:


person:


? name: zhangsan


? age: 18


  • 然后通过[@Value]( )("${属性名}")注解来加载对应的配置属性:


@Controller


public class QuickStartController {


@Value("${person.name}")


private String name;


//设置默认值,person.name:是空值


@Value("${person.name:王大拿}")


private String name2;


@Value("${person.age}")


private Integer age;


@RequestMapping("/quick")


@ResponseBody


public String quick(){


return "springboot 访问成功! name="+name+",age="+age;


}


}


使用 @Value 注入 map、List 稍微复杂


配置文件


list: topic1,topic2,topic3


maps: "{key1: 'value1', key2: 'value2'}


实体类


@Value("#{'${list}'.split(',')}")


private List<String> list;


@Value("#{${maps}}") ?


private Map<String,String> maps;


  • 使用注解 @ConfigurationProperties 映射对象(配置文件与对象绑定)


通过注解 @ConfigurationProperties(prefix="配置文件中的 key 的前缀,可以使 properties 文件也可以是 yml 文件")可以将配置文件中的配置自动与实体进行映射(这个注解能作用在类上也能作用在方法上)


实体 Bean 代码如下:


@Controller


//@PropertySource("classpath:/production/wxpay.properties") //的值是配置文件文件的路径


@ConfigurationProperties(prefix = "person")//配置文件前缀


public class QuickStartController {


private String name;


private Integer age;


@RequestMapping("/quick")


@ResponseBody


public String quick(){


return "springboot 访问成功! name="+name+",age="+age;


}


public void setName(String name) {


this.name = name;


}


public void setAge(Integer age) {


this.age = age;


}


}


注意:使用 @ConfigurationProperties 方式可以进行配置文件与实体字段的自动映射,但需要字段必须提供 set 方法才可以,而使用 @Value 注解修饰的字段不需要提供 set 方法



@PropertySource("classpath:/production/wxpay.properties") 的值是 properties 文件的路径,如果是默认配置文件可以不写此注解


@ConfigurationProperties(prefix = "wxpay") prefix 属性值是配置文件 key 的前缀


也可以这样写:


@Component


public class SysConfiguration {


@Bean


@ConfigurationProperties("wxpay")


public WxPayBean wxPayBean() {


return new WxPayBean();


}


}


个人觉得这种方式更好,pojo 就做最纯正的 pojo 不写别的


--------------------------------------------------------------------扩展-------------------


【一线大厂Java面试题解析+后端开发学习笔记+最新架构讲解视频+实战项目源码讲义】
浏览器打开:qq.cn.hn/FTf 免费领取
复制代码




参数间的引用




application.properties中的各个参数之间也可以直接引用来使用,就像下面的设置:


com.didispace.blog.name=圈圈


com.didispace.blog.title=Spring Boot 教程


com.didispace.blog.desc={com.didispace.blog.title}》


com.didispace.blog.desc参数引用了上文中定义的nametitle属性,最后该属性的值就是程序猿DD正在努力写《Spring Boot教程》


使用随机数




在一些情况下,有些参数我们需要希望它不是一个固定的值,比如密钥、服务端口等。Spring Boot 的属性配置文件中可以通过${random}来产生 int 值、long 值或者 string 字符串,来支持属性的随机值。

随机字符串

com.didispace.blog.value=${random.value}

随机 int

com.didispace.blog.number=${random.int}

随机 long

com.didispace.blog.bignumber=${random.long}

10 以内的随机数

com.didispace.blog.test1=${random.int(10)}

10-20 的随机数

com.didispace.blog.test2=${random.int[10,20]}


通过命令行设置属性值




相信使用过一段时间 Spring Boot 的用户,一定知道这条命令:java -jar xxx.jar --server.port=8888,通过使用—server.port 属性来设置 xxx.jar 应用的端口为 8888。


在命令行运行时,连续的两个减号--就是对application.properties中的属性值进行赋值的标识。所以,java -jar xxx.jar --server.port=8888命令,等价于我们在application.properties中添加属性server.port=8888,该设置在样例工程中可见,读者可通过删除该值或使用命令行来设置该值来验证。


通过命令行来修改属性值固然提供了不错的便利性,但是通过命令行就能更改应用运行的参数,那岂不是很不安全?是的,所以 Spring Boot 也贴心的提供了屏蔽命令行访问属性的设置,只需要这句设置就能屏蔽:SpringApplication.setAddCommandLineProperties(false)


多环境配置




我们在开发 Spring Boot 应用时,通常同一套程序会被应用和安装到几个不同的环境,比如:开发、测试、生产等。其中每个环境的数据库地址、服务器端口等等配置都会不同,如果在为不同环境打包时都要频繁修改配置文件的话,那必将是个非常繁琐且容易发生错误的事。


对于多环境的配置,各种项目构建工具或是框架的基本思路是一致的,通过配置多份不同环境的配置文件,再通过打包命令指定需要打包的内容之后进行区分打包,Spring Boot 也不例外,或者说更加简单。


在 Spring Boot 中多环境配置文件名需要满足application-{profile}.properties的格式,其中{profile}对应你的环境标识,比如:


  • application-dev.properties:开发环境


  • application-test.properties:测试环境


  • application-prod.properties:生产环境


至于哪个具体的配置文件会被加载,需要在application.properties文件中通过spring.profiles.active属性来设置,其值对应{profile}值。


如:spring.profiles.active=test就会加载application-test.properties配置文件内容


下面,以不同环境配置不同的服务端口为例,进行样例实验。


  • 针对各环境新建不同的配置文件application-dev.propertiesapplication-test.propertiesapplication-prod.properties

  • 在这三个文件均都设置不同的server.port属性,如:dev 环境设置为 1111,test 环境设置为 2222,prod 环境设置为 3333

  • application.properties 中设置spring.profiles.active=dev,就是说默认以 dev 环境设置

  • 测试不同配置的加载

  • 执行java -jar xxx.jar,可以观察到服务端口被设置为1111,也就是默认的开发环境(dev)

  • 执行java -jar xxx.jar --spring.profiles.active=test,可以观察到服务端口被设置为2222,也就是测试环境的配置(test)

  • 执行java -jar xxx.jar --spring.profiles.active=prod,可以观察到服务端口被设置为3333,也就是生产环境的配置(prod)


按照上面的实验,可以如下总结多环境的配置思路:


  • application.properties中配置通用内容,并设置spring.profiles.active=dev,以开发环境为默认配置

  • application-{profile}.properties中配置各个环境不同的内容

  • 通过命令行方式去激活不同环境的配置


在 Spring Boot 2.0 中推出了 Relaxed Binding 2.0,对原有的属性绑定功能做了非常多的改进以帮助我们更容易的在 Spring 应用中加载和读取配置信息。下面本文就来说说 Spring Boot 2.0 中对配置的改进。


配置文件绑定



环境属性绑定

简单类型


在环境变量中通过小写转换与.替换_来映射配置文件中的内容,比如:环境变量SPRING_JPA_DATABASEPLATFORM=mysql的配置会产生与在配置文件中设置spring.jpa.databaseplatform=mysql一样的效果。


List 类型


由于环境变量中无法使用[]符号,所以使用_来替代。任何由下划线包围的数字都会被认为是[]的数组形式。比如:


MY_FOO_1_ = my.foo[1]


MY_FOO_1_BAR = my.foo[1].bar


MY_FOO_1_2_ = my.foo[1][2]


另外,最后环境变量最后是以数字和下划线结尾的话,最后的下划线可以省略,比如上面例子中的第一条和第三条等价于下面的配置:


MY_FOO_1 = my.foo[1]


MY_FOO_1_2 = my.foo[1][2]


系统属性绑定




简单类型


系统属性与文件配置中的类似,都以移除特殊字符并转化小写后实现绑定,比如下面的命令行参数都会实现配置spring.jpa.databaseplatform=mysql的效果:


-Dspring.jpa.database-platform=mysql


-Dspring.jpa.databasePlatform=mysql


-Dspring.JPA.database_platform=mysql


List 类型


系统属性的绑定也与文件属性的绑定类似,通过[]来标示,比如:


-D"spring.my-example.url[0]=http://example.com"


-D"spring.my-example.url[1]=http://spring.io"


同样的,他也支持逗号分割的方式,比如:


-Dspring.my-example.url=http://example.com,http://spring.io


属性的读取




上文介绍了 Spring Boot 2.0 中对属性绑定的内容,可以看到对于一个属性我们可以有多种不同的表达,但是如果我们要在 Spring 应用程序的 environment 中读取属性的时候,每个属性的唯一名称符合如下规则:


  • 通过.分离各个元素

  • 最后一个.将前缀与属性名称分开

  • 必须是字母(a-z)和数字(0-9)

  • 必须是小写字母

  • 用连字符-来分隔单词

  • 唯一允许的其他字符是[],用于 List 的索引

  • 不能以数字开头


所以,如果我们要读取配置文件中spring.jpa.database-platform的配置,可以这样写:


this.environment.containsProperty("spring.jpa.database-platform")


而下面的方式是无法获取到spring.jpa.database-platform配置内容的:


this.environment.containsProperty("spring.jpa.databasePlatform")


注意:使用[@Value]( )获取配置内容的时候也需要这样的特点


全新的绑定 API




在 Spring Boot 2.0 中增加了新的绑定 API 来帮助我们更容易的获取配置信息。下面举个例子来帮助大家更容易的理解:


例子一:简单类型


假设在 propertes 配置中有这样一个配置:com.didispace.foo=bar


我们为它创建对应的配置类:


@Data


@ConfigurationProperties(prefix = "com.didispace")


public class FooProperties {


private String foo;


}


接下来,通过最新的Binder就可以这样来拿配置信息了:


@SpringBootApplication


public class Application {


public static void main(String[] args) {


ApplicationContext context = SpringApplication.run(Application.class, args);


Binder binder = Binder.get(context.getEnvironment());


// 绑定简单配置


FooProperties foo = binder.bind("com.didispace", Bindable.of(FooProperties.class)).get();


System.out.println(foo.getFoo());


}


}


例子二:List 类型


如果配置内容是 List 类型呢?比如:


com.didispace.post[0]=Why Spring Boot


com.didispace.post[1]=Why Spring Cloud


com.didispace.posts[0].title=Why Spring Boot


com.didispace.posts[0].content=It is perfect!


com.didispace.posts[1].title=Why Spring Cloud


com.didispace.posts[1].content=It is perfect too!

用户头像

Java高工P7

关注

还未添加个人签名 2021.11.08 加入

还未添加个人简介

评论

发布
暂无评论
spring boot  自定义配置文件&参数绑定