一、自定义属性
当我们创建一个springboot项目的时候,系统默认会为我们在src/main/java/resources目录下创建一个application.properties。个人习惯,我会将application.properties改为application.yml文件,两种文件格式都支持。
在application.yml自定义一组属性:
my: name: forezp age: 12
如果你需要读取配置文件的值只需要加@Value(“${属性名}”):
@RestControllerpublic class MiyaController { @Value("${my.name}") private String name; @Value("${my.age}") private int age; @RequestMapping(value = "/miya") public String miya(){ return name+":"+age; } }
启动工程,访问:localhost:8080/miya,浏览器显示:
forezp:12
二、将配置文件的属性赋给实体类
当我们有很多配置属性的时候,这时我们会把这些属性作为字段来创建一个javabean,并将属性值赋予给他们,比如:
my: name: forezp age: 12 number: ${random.int} uuid : ${random.uuid} max: ${random.int(10)} value: ${random.value} greeting: hi,i'm ${my.name}
其中配置文件中用到了${random} ,它可以用来生成各种不同类型的随机值。
怎么讲这些属性赋于给一个javabean 呢,首先创建一个javabean :
@ConfigurationProperties(prefix = "my") @Componentpublic class ConfigBean { private String name; private int age; private int number; private String uuid; private int max; private String value; private String greeting; 省略了getter setter....
需要加个注解@ConfigurationProperties,并加上它的prrfix。另外@Component可加可不加。另外spring-boot-configuration-processor依赖可加可不加,具体原因不详。
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <optional>true</optional> </dependency>
另外需要在应用类或者application类,加EnableConfigurationProperties注解。
@RestController@EnableConfigurationProperties({ConfigBean.class})public class LucyController { @Autowired ConfigBean configBean; @RequestMapping(value = "/lucy") public String miya(){ return configBean.getGreeting()+" >>>>"+configBean.getName()+" >>>>"+ configBean.getUuid()+" >>>>"+configBean.getMax(); }
启动工程,访问localhost:8080/lucy,我们会发现配置文件信息读到了。
三、自定义配置文件
上面介绍的是我们都把配置文件写到application.yml中。有时我们不愿意把配置都写到application配置文件中,这时需要我们自定义配置文件,比如test.properties:
com.forezp.name=forezpcom.forezp.age=12
怎么将这个配置文件信息赋予给一个javabean呢?
@Configuration@PropertySource(value = "classpath:test.properties") @ConfigurationProperties(prefix = "com.forezp")public class User { private String name; private int age; public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } }
在最新版本的springboot,需要加这三个注解。@Configuration
@PropertySource(value = “classpath:test.properties”)
@ConfigurationProperties(prefix = “com.forezp”);在1.4版本需要
PropertySource加上location。
@RestController@EnableConfigurationProperties({ConfigBean.class,User.class})public class LucyController { @Autowired ConfigBean configBean; @RequestMapping(value = "/lucy") public String miya(){ return configBean.getGreeting()+" >>>>"+configBean.getName()+" >>>>"+ configBean.getUuid()+" >>>>"+configBean.getMax(); } @Autowired User user; @RequestMapping(value = "/user") public String user(){ return user.getName()+user.getAge(); } }
启动工程,打开localhost:8080/user;浏览器会显示:
forezp12
四、多个环境配置文件
在现实的开发环境中,我们需要不同的配置环境;格式为application-{profile}.properties,其中{profile}对应你的环境标识,比如:
application-test.properties:测试环境
application-dev.properties:开发环境
application-prod.properties:生产环境
怎么使用?只需要我们在application.yml中加:
spring: profiles: active: dev
其中application-dev.yml:
server: port: 8082
启动工程,发现程序的端口不再是8080,而是8082。
源码下载:https://github.com/forezp/SpringBootLearning
SpringBoot非官方教程 | 第一篇:构建第一个SpringBoot工程
SpringBoot非官方教程 | 第三篇:SpringBoot用JdbcTemplates访问Mysql
SpringBoot非官方教程 | 第四篇:SpringBoot 整合JPA
SpringBoot非官方教程 | 第五篇:springboot整合 beatlsql
SpringBoot非官方教程 | 第六篇:springboot整合mybatis
SpringBoot非官方教程 | 第七篇:springboot开启声明式事务
SpringBoot非官方教程 | 第八篇:springboot整合mongodb
SpringBoot非官方教程 | 第九篇: springboot整合Redis
SpringBoot非官方教程 | 第十篇: 用spring Restdocs创建API文档
SpringBoot非官方教程 | 第十一篇:springboot集成swagger2,构建优雅的Restful API
SpringBoot非官方教程 | 第十二篇:springboot集成apidoc
SpringBoot非官方教程 | 第十三篇:springboot集成spring cache
SpringBoot非官方教程 | 第十四篇:在springboot中用redis实现消息队列
SpringBoot非官方教程 | 第十五篇:Springboot整合RabbitMQ
SpringBoot非官方教程 | 第十六篇:用restTemplate消费服务
SpringBoot非官方教程 | 第十八篇: 定时任务(Scheduling Tasks)
SpringBoot非官方教程 | 第十九篇: 验证表单信息
SpringBoot非官方教程 | 第二十篇: 处理表单提交
SpringBoot非官方教程 | 第二十一篇: springboot集成JMS
SpringBoot非官方教程 | 第二十二篇: 创建含有多module的springboot工程
SpringBoot非官方教程 | 第二十四篇: springboot整合docker
SpringBoot非官方教程 | 第二十五篇:2小时学会springboot
SpringBoot非官方教程 | 第二十六篇: sprinboot整合elk,搭建实时日志平台
五、参考文献
spring-boot-reference-guide-zh
优秀文章推荐:
更多springboot 教程:springBoot非官方教程 | 文章汇总
更多springcoud 教程:史上最简单的 SpringCloud 教程 | 文章汇总