【springboot】springboot核心配置文件

Love The Way You Lie 2024-02-19 18:30 9阅读 0赞

#### 文章目录 ####

*  举例：application.properties方式
 *  举例：application.yml方式
 *  多环境配置文件
 *  读取自定义配置文件
 *  1 -用@Value注解读取，用于逐个读取自定义的配置
 *  2-用ConfigurationProperties 将这个文件映射为一个对象
 *  总结

> 在《[【SpringBoot】idea创建第一个springBoot 程序][SpringBoot_idea_springBoot]》中，我们已经创建好 一个springboot 的项目。在创建的时候，他出现了一个application.properties 文件，这就是我们的核心配置文件。

springboot的核心配置文件主要用来配置springboot程序。他有两种形式：

*  application.properties ：键值对的properties属性文件配置方式
 *  application.yml

## 举例：application.properties方式 ##

server.port=8080   #配置Tomcat端口号
    server.servlet.context-path=/01-springboot-web # 配置请求上下文
    #旧版本中为server.context-path=/01-springboot-web

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70]  
此时启动项目后，我们需要写如下网址才能访问：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 1]

## 举例：application.yml方式 ##

1、yml 是一种yaml格式的配置文件，主要采用一定的空格，换行等格式进行配置  
2、值与前面的冒号配置项必须有一个空格  
3、yml 后缀也可以使用yaml后缀

server:
      port: 9090
      servlet:
        context-path: /02-springboot-web

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 2]  
删除application.properties后，启动，访问如下；  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 3]

## 多环境配置文件 ##

在我们开发过程中，我们用于开发，测试，和发布的配置文件内容能不同，比如端口。那么我们该如何配置内。这时候就用到了spring.profiles.active  
比如我们现在有开发环境和测试环境  
开发文件中application-dev.properties

server.port=8090
    server.servlet.context-path=/01-springboot-web
    #旧版本中为server.context-path=/01-springboot-web

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 4]  
在测试环境中application-test.properties(与application-dev.properties的区别在于端口)

server.port=8099
    server.servlet.context-path=/01-springboot-web
    #旧版本中为server.context-path=/01-springboot-web

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 5]  
现在如果想使用application-test.properties文件中的配置，需要在application.properties 文件中如下操作  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 6]  
这样写，就是以端口8099启动了。

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

## 1 -用@Value注解读取，用于逐个读取自定义的配置 ##

如果我们在application.properties中自定义了一些配置项，比如：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 7]  
为了读取内容，我们写一个controller

package com.cjp.springboot.controller;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    @Controller
    public class ConfigInfoController {
        
    //    1。用@Value注解读取，用于逐个读取自定义的配置
        @Value("${boot.name}")
        private String name;
    
        @Value("${boot.location}")
        private String location;
        @RequestMapping("/boot/config")
        public @ResponseBody String Config(){
        
            return name+ "_______"+location;
        }
      
        
    }

启动后访问网址：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 8]  
这里出现了乱码，我们需要配置一下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 9]  
在application.properties文件中添加配置项：

spring.http.encoding.charset=utf-8
    spring.http.encoding.enabled=true
    spring.http.encoding.force=true

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 10]  
重新启动后，即可显示正常了：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 11]

## 2-用ConfigurationProperties 将这个文件映射为一个对象 ##

我们在配置文件中，自定义的配置项为：

#自定义配置项
    boot.name=myboot
    boot.location=河北

我们首先创建一个包config 并在包内创建一个类ConfigInfo.java  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 12]  
代码如下；

package com.cjp.springboot.config;
    
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    
    //ConfigurationProperties 注解，并且用prefix配置前缀，因为我们在配置文件中的名字为boot.name,为此前缀为boot
    @Component
    @ConfigurationProperties(prefix = "boot")
    public class ConfigInfo {
        
        private String name;
        private String location;// 属性的名字必须和配置文件的自定义的名字一样，这样才能映射
    
        public String getName() {
        
            return name;
        }
    
        public void setName(String name) {
        
            this.name = name;
        }
    
        public String getLocation() {
        
            return location;
        }
    
        public void setLocation(String location) {
        
            this.location = location;
        }
    }

完成ConfigInfoController文件：

package com.cjp.springboot.controller;
    
    import com.cjp.springboot.config.ConfigInfo;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    @Controller
    public class ConfigInfoController {
        
    //    1。用@Value注解读取，用于逐个读取自定义的配置
        @Value("${boot.name}")
        private String name;
    
        @Value("${boot.location}")
        private String location;
    
    //    2/用ConfigurationProperties注解的方式
            @Autowired
            private ConfigInfo configInfo;
    
    
        @RequestMapping("/boot/config")
        public @ResponseBody String Config(){
        
            return name+ "_______"+location + "=====" +configInfo.getName()+"------"+configInfo.getLocation();
        }
    
    
    
    }

启动运行：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 13]

## 总结 ##

1、application.yml和application.properties中都是固定的名字，不能改动  
2、如果两个文件同时存在，则会优先使用application.properties，application.yml无效，为此，要想使用application.yml需要删除application.properties  
3、在多环境配置中，如果application.properties和application-test.properties中有相同的配置项，则以application-test.properties为准。  
4、如果application.properties有server.servlet.context-path等配置项，而application-test.properties等文件中没有此配置，application.properties中的server.servlet.context-path配置项才会生效

[SpringBoot_idea_springBoot]: https://blog.csdn.net/aiming66/article/details/88252136
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/d17c7de7bc084637bddd0c88304e0c46.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/1863c5370e9c480c848076f2ccbb924f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/9d956ff4aede47559dcfc0c9d6a306dd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/648e14ea56bd4b57b87fc0326392d5e7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/d4fbefe7cb084384ba4ed4215f9f251c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/a519f351cdd14f4680bc7b943ad01eef.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/814c31a646e54181979f032bc09a81ab.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/bf29d89058ba49d6a7c0ccf0f6837c09.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/95e68508789b4d17a1ef07497f1b8ffa.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/ddff899eb22c4015acb7231c9cc08621.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 10]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/f8c08bfee5aa47c2857dfcb248c74214.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 11]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/87c88ff4f082425fb047ef1d516734ad.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 12]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/972f76e8e9fd4cc499807b2eb534139d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpbWluZzY2_size_16_color_FFFFFF_t_70 13]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/6874a974ff8d42a982f4b1680a3d5c4b.png