4.Springboot 之自定义配置文件及读取配置文件

我不是女神ヾ 2022-06-17 05:16 184阅读 0赞

本文所属【 [知识林][Link 1]】：http://www.zslin.com/web/article/detail/12

### 读取核心配置文件 ###

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

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

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

*  使用`@Value`方式（常用）：

@RestController
    public class WebController {
    
        @Value("${test.msg}")
        private String msg;
    
        @RequestMapping(value = "index", method = RequestMethod.GET)
        public String index() {
            return "The Way 1 : " +msg;
        }
    }

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

访问：[http://localhost:9090/index][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][http_localhost_9090_index2] 时将得到`The Way 2 : Hello World Springboot!`

--------------------

### 读取自定义配置文件 ###

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

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

web.name=zslin
    web.version=V 1.0
    web.author=393156105@qq.com

#### 创建管理配置的实体类： ####

@ConfigurationProperties(locations = "classpath:config/my-web.properties", prefix = "web")
    @Component
    public class MyWebConfig {
    
        private String name;
    
        private String version;
    
        private String author;
    
        public String getAuthor() {
            return author;
        }
    
        public String getName() {
            return name;
        }
    
        public String getVersion() {
            return version;
        }
    
        public void setAuthor(String author) {
            this.author = author;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        public void setVersion(String version) {
            this.version = version;
        }
    }

注意：

*  在`@ConfigurationProperties`注释中有两个属性：
    
     *  `locations`：指定配置文件的所在位置
     *  `prefix`：指定配置文件中键名称的前缀（我这里配置文件中所有键名都是以`web.`开头）
 *  使用`@Component`是让该类能够在其他地方被依赖使用，即使用`@Autowired`注释来创建实例。

#### 创建测试Controller ####

@RestController
    @RequestMapping(value = "config")
    public class ConfigController {
    
        @Autowired
        private MyWebConfig myWebConfig;
    
        @RequestMapping(value = "index", method = RequestMethod.GET)
        public String index() {
            return "webName: "+myWebConfig.getName()+", webVersion: "+
                    myWebConfig.getVersion()+", webAuthor: "+myWebConfig.getAuthor();
        }
    }

注意：由于在MyWebConfig类上加了注释`@Component`，所以可以直接在这里使用`@Autowired`来创建其实例对象。

访问：[http://localhost:9090/config/index][http_localhost_9090_config_index] 时将得到`webName: zslin, webVersion: V 1.0, webAuthor: 393156105@qq.com`

[Link 1]: http://www.zslin.com/
[http_localhost_9090_index]: http://localhost:9090/index
[http_localhost_9090_index2]: http://localhost:9090/index2
[http_localhost_9090_config_index]: http://localhost:9090/config/index