Springboot-读取核心配置文件及自定义配置文件

Posted 2020-10-06 军子

读取核心配置文件

核心配置文件是指在resources根目录下的application.properties或application.yml配置文件，读取这两个配置文件的方法有两种，都比较简单。

核心配置文件application.properties内容如下：

server.port=9090
test.msg=Hello World Springboot!

 

• 使用@Value方式（常用）

 1 @RestController
 2 public class WebController {
 3 
 4     @Value("${test.msg}")
 5     private String msg;
 6 
 7     @RequestMapping(value = "index", method = RequestMethod.GET)
 8     public String index() {
 9         return "The Way 1 : " +msg;
10     }
11 }

注意：在@Value的${}中包含的是核心配置文件中的键名。在Controller类上加@RestController表示将此类中的所有视图都以JSON方式显示，类似于在视图方法上加@ResponseBody。

访问：http://localhost:9090/index 时将得到The Way 1 : Hello World Springboot!

• 使用Environment方式

@RestController
public class WebController {

    @Autowired
    private Environment env;

    @RequestMapping(value = "index2", method = RequestMethod.GET)
    public String index2() {

        return "The Way 2 : " + env.getProperty("test.msg");
    }
}

 

注意：这种方式是依赖注入Evnironment来完成，在创建的成员变量private Environment env上加上@Autowired注解即可完成依赖注入，然后使用env.getProperty("键名")即可读取出对应的值。

访问：http://localhost:9090/index2 时将得到The Way 2 : Hello World Springboot!

---

读取自定义配置文件

• 通过@ConfigurationProperties注解，通过getter、setter方法注入及获取配置

为了不破坏核心文件的原生态，但又需要有自定义的配置信息存在，一般情况下会选择自定义配置文件来放这些自定义信息，这里在resources/config目录下创建配置文件my-web.properties

resources/config/my-web.properties内容如下：

web.name=isea533 
web.jdbc.username=root 
web.jdbc.password=root

 

创建管理配置的实体类：

@ConfigurationProperties(locations = "classpath:config/my-web.properties", prefix = "web")
@Component
public class MyWebConfig{
    private String name;
    private Jdbc jdbc;
    class Jdbc {
        private String username;
        private String password;
        //getter...
    }

    public Integer gePort(){
        return this.port;
    }
    public Jdbc getJdbc() {
        return this.jdbc;
    }
}

注意：

1. 在@ConfigurationProperties注释中有两个属性：

   • locations：指定配置文件的所在位置
   • prefix：指定配置文件中键名称的前缀（我这里配置文件中所有键名都是以web.开头）

2. 使用@Component是让该类能够在其他地方被依赖使用，即使用@Autowired注释来创建实例。

• 通过@PropertySource注解，然后使用@Value逐个注入配置

 1 @Configuration
 2 @PropertySource("classpath:test.properties")
 3 public class ELConfig {
 4 
 5     @Value("${book.name}")
 6     private String bookName;
 7 
 8     //PropertySourcesPlaceholderConfigurer这个bean，这个bean主要用于解决@value中使用的${…}占位符。假如你不使用${…}占位符的话，可以不使用这个bean。
 9     @Bean
10     public static PropertySourcesPlaceholderConfigurer propertyConfigure() {
11         return new PropertySourcesPlaceholderConfigurer();
12     }
13 
14     public void outputSource() {
15         System.out.println(bookName);
16     }
17 }