Spring Boot-(2)配置文件

Spring Boot使用一个全局的配置文件application.properties 或 application.yml,放在src/main/resources目录下。

比如Tomcat默认端口号为8080,我们可以进行修改,在application.yml中添加:

server: <--这里有个空格
  port: 8090  <--空两个port:空格8090

这样配置后,启动Spring Boot项目时Tomcat端口变为8090。
这时候就有一个疑问了,为什么这里写server和port就能让Tomcat的端口改变,为什么不能写成tomcatserver、tomcatport,找找是哪里去读这个配置的,怎么读取到的。

首先,参考官方文档,写一个自己的配置,然后在java文件中读取:

1.使用@Value:

application.yml中添加

myConfig: something

java代码中可以直接使用

@Value(value="${myConfig}")
private String myConfig;

2.使用@ConfigurationProperties:

application.yml中添加

---
#自定义的属性和值  
myProps: 
  simpleProp: simplePropValue  
  arrayProps: 1,2,3,4,5  
  listProp1:  
    - name: abc  
      value: abcValue  
    - name: efg  
      value: efgValue  
  listProp2:  
    - config2Value1  
    - config2Vavlue2  
  mapProps:  
    key1: value1  
    key2: value2  

增加YmlConfig.java,用于接收application.yml中配置的参数。

package com.spring.lw.Towns.vo;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix="myProps") //application.yml中的myProps下的属性    
public class YmlConfig {
    private String simpleProp;    
    private String[] arrayProps;    
    private List<Map<String, String>> listProp1 = new ArrayList<>(); //接收prop1里面的属性值    
    private List<String> listProp2 = new ArrayList<>(); //接收prop2里面的属性值    
    private Map<String, String> mapProps = new HashMap<>(); //接收prop1里面的属性值    
        
    public String getSimpleProp() {    
        return simpleProp;    
    }    
        
    public void setSimpleProp(String simpleProp) {    
        this.simpleProp = simpleProp;    
    }    
        
    public List<Map<String, String>> getListProp1() {    
        return listProp1;    
    }    
    public List<String> getListProp2() {    
        return listProp2;    
    }    
    
    public String[] getArrayProps() {    
        return arrayProps;    
    }    
    
    public void setArrayProps(String[] arrayProps) {    
        this.arrayProps = arrayProps;    
    }    
    
    public Map<String, String> getMapProps() {    
        return mapProps;    
    }    
    
    public void setMapProps(Map<String, String> mapProps) {    
        this.mapProps = mapProps;    
    } 
}

在Controller中使用配置好的参数:

@RestController
@RequestMapping(value="/user")
@EnableConfigurationProperties({YmlConfig.class})  
public class UserController {
    @Autowired  
    private YmlConfig ymlConfig; 

    @RequestMapping(value="/getProps")
    public List getArrayProps(){
    List list = new ArrayList();
    
    list.add(ymlConfig.getSimpleProp());
    list.add(ymlConfig.getArrayProps());
    list.add(ymlConfig.getListProp1());
    list.add(ymlConfig.getListProp2());
    list.add(ymlConfig.getMapProps());
    
    return list ;
}

当然上面例子中的simpleProp也可以使用@Value获取到:

@Value(value="${myProps.simpleProp}")
private String single;

3.@ConfigurationProperties vs. @Value

官方比较推荐使用@ConfigurationProperties,它支持Relaxed binding和Meta-data support。我用自己的话对这两个概念解释一下...

  • Relaxed binding:绑定的时候不需要完全按照完整的名称进行绑定,比如可以@ConfigurationProperties(prefix="person")表示person开头的配置。@Value需要严格的要求使用完整的名称。
  • Meta-data support:支持使用Meta-data。Spring boot的jars中,附带了metadata.json结尾的文件,这个文件可以帮助使用IDE的开发人员快速的完成代码的补全。就好像我们使用eclipse的时候,输入【类.】的时候,eclipse可以提示这个类里面的所有方法。当然使用这个功能的时候,需要使用Spring Tool Suite,要么直接下载STS使用,要么在现有的IDE里面安装插件。Spring Tool Suite,效果是这样的:
image.png

回到最上面的问题:为什么这里写server和port就能让Tomcat的端口改变。我们翻翻源代码看看是在哪里规定的。
spring boot中有一个jar包,名称为:spring-boot-autoconfigure-1.5.4.RELEASE-sources.jar,这个jar专门负责自动配置的。Spring Boot提供的自动配置都是位于包 org.springframework.boot.autoconfigure之下,这个是Spring Boot提供的,而非第三方(如MyBatis-Spring-Boot-Starter)提供的。

找到org.springframework.boot.autoconfigure.web.ServerProperties,可以server.port:

@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
public class ServerProperties
        implements EmbeddedServletContainerCustomizer, EnvironmentAware, Ordered {

    /**
     * Server HTTP port.
     */
    private Integer port;

    ... ...

好了,这就对应起来了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,298评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,701评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,078评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,687评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,018评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,410评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,729评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,412评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,124评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,379评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,903评论 1 257
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,268评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,894评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,014评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,770评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,435评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,312评论 2 260

推荐阅读更多精彩内容