SpringBoot 配置文件详解

你的名字 2022-10-15 12:53 231阅读 0赞

  springboot采纳了建立生产就绪spring应用程序的观点。 Spring Boot优先于配置的惯例,旨在让您尽快启动和运行。在一般情况下,我们不需要做太多的配置就能够让spring boot正常运行。在一些特殊的情况下,我们需要做修改一些配置,或者需要有自己的配置属性。

一.自定义属性

  当我们创建一个springboot项目的时候,系统默认会为我们在src/main/Java/resources目录下创建一个application.properties。个人习惯,我会将application.properties改为application.yml文件,两种文件格式都支持。

在application.yml自定义一组属性:

  1. my:
  2. name: forezp
  3. age: 12

如果你需要读取配置文件的值只需要加@Value(“${属性名}”):

  1. @RestController
  2. public class MiyaController {
  3. @Value("${my.name}")
  4. private String name;
  5. @Value("${my.age}")
  6. private int age;
  7. @RequestMapping(value = "/miya")
  8. public String miya(){
  9. return name+":"+age;
  10. }
  11. }

启动工程,访问:localhost:8080/miya,浏览器显示:

forezp:12

二.将配置文件的属性赋给实体类

当我们有很多配置属性的时候,这时我们会把这些属性作为字段来创建一个javabean,并将属性值赋予给他们,比如:

  1. my:
  2. name: forezp
  3. age: 12
  4. number: ${ random.int}
  5. uuid : ${ random.uuid}
  6. max: ${ random.int(10)}
  7. value: ${ random.value}
  8. greeting: hi,i'm ${ my.name}

其中配置文件中用到了${random} ,它可以用来生成各种不同类型的随机值。
怎么讲这些属性赋于给一个javabean 呢,首先创建一个javabean :

  1. @ConfigurationProperties(prefix = "my")
  2. @Component
  3. public class ConfigBean {
  4. private String name;
  5. private int age;
  6. private int number;
  7. private String uuid;
  8. private int max;
  9. private String value;
  10. private String greeting;
  11. 省略了getter setter....

需要加个注解@ConfigurationProperties,并加上它的prrfix。另外@Component可加可不加。另外spring-boot-configuration-processor依赖

  1. <!--导入配置文件处理器,配置文件进行绑定就会有提示-->
  2. <dependency>
  3. <groupId>org.springframework.boot</groupId>
  4. <artifactId>spring-boot-configuration-processor</artifactId>
  5. <optional>true</optional>
  6. </dependency>

另外需要在应用类或者application类,加EnableConfigurationProperties注解。

  1. @RestController
  2. @EnableConfigurationProperties({ ConfigBean.class})
  3. public class LucyController {
  4. @Autowired
  5. ConfigBean configBean;
  6. @RequestMapping(value = "/lucy")
  7. public String miya(){
  8. return configBean.getGreeting()+" >>>>"+configBean.getName()+" >>>>"+ configBean.getUuid()+" >>>>"+configBean.getMax();
  9. }

启动工程,访问localhost:8080/lucy,我们会发现配置文件信息读到了。

三.自定义配置文件

上面介绍的是我们都把配置文件写到application.yml中。有时我们不愿意把配置都写到application配置文件中,这时需要我们自定义配置文件,比如test.properties:

  1. com.forezp.name=forezp
  2. com.forezp.age=12

怎么将这个配置文件信息赋予给一个javabean呢?

  1. @Configuration
  2. @PropertySource(value = "classpath:test.properties")
  3. @ConfigurationProperties(prefix = "com.forezp")
  4. public class User {
  5. private String name;
  6. private int age;
  7. public String getName() {
  8. return name;
  9. }
  10. public void setName(String name) {
  11. this.name = name;
  12. }
  13. public int getAge() {
  14. return age;
  15. }
  16. public void setAge(int age) {
  17. this.age = age;
  18. }
  19. }

在最新版本的springboot,需要加这三个注解。@Configuration
@PropertySource(value = “classpath:test.properties”)
@ConfigurationProperties(prefix = “com.forezp”);
在1.4版本需要 PropertySource加上location。

  1. @RestController
  2. @EnableConfigurationProperties({ ConfigBean.class,User.class})
  3. public class LucyController {
  4. @Autowired
  5. ConfigBean configBean;
  6. @RequestMapping(value = "/lucy")
  7. public String miya(){
  8. return configBean.getGreeting()+" >>>>"+configBean.getName()+" >>>>"+ configBean.getUuid()+" >>>>"+configBean.getMax();
  9. }
  10. @Autowired
  11. User user;
  12. @RequestMapping(value = "/user")
  13. public String user(){
  14. return user.getName()+user.getAge();
  15. }
  16. }

启动工程,打开localhost:8080/user;浏览器会显示:

forezp12

四.多个环境配置文件
在现实的开发环境中,我们需要不同的配置环境;格式为application-{profile}.properties,其中{profile}对应你的环境标识,比如:
application-test.properties:测试环境
application-dev.properties:开发环境
application-prod.properties:生产环境
怎么使用?只需要我们在application.yml中加:

  1. spring:
  2. profiles:
  3. active: dev

其中application-dev.yml:

  1. server:
  2. port: 8082

启动工程,发现程序的端口不再是8080,而是8082。

发表评论

表情:
评论列表 (有 0 条评论,231人围观)

还没有评论,来说两句吧...

相关阅读

    相关 SpringBoot 配置文件详解

      springboot采纳了建立生产就绪spring应用程序的观点。 Spring Boot优先于配置的惯例,旨在让您尽快启动和运行。在一般情况下,我们不需要做太多的配置就能