Spring Boot实际应用讲解(二):配置详解

文/ZYRzyr
原文链接:http://www.jianshu.com/p/d4c7f33c9b37

本文提纲
一、默认配置
二、自定义配置(属性)
三、适配多环境
四、最后

本文运行环境

Ubuntu 16.04 LTS
JDK 8 +
IntelliJ IDEA ULTIMATE 2017.2
Maven 3.5.0
Spring Boot 1.5.8.RELEASE

一、默认配置

Spring Boot提供了很多默认配置,不需要进行显示声明,并且大多数的默认配置已经能满足实际的开发,节省了很多时间。
通常一个moudle中的配置文件为:application.ymlapplication.properties,里面可以声明如数据库连接、tomcat、缓存等等非常多的配置,可根据项目实际需要进行配置。.yml.properties区别仅在于.yml使用YAML语法进行书写,更方便人阅读,所以本系列文章,均使用.yml作为后缀的配置文件。
某些情况下,需要改变配置参数,比如项目运行时进行配置参数修改,需要遵循以下配置优先级:

  1. 命令行参数
  2. 来自java:comp/env的JNDI属性
  3. Java系统属性(System.getProperties())
  4. 操作系统环境变量
  5. RandomValuePropertySource 属性类生成的 random.* 属性
  6. 应用以外(jar包外部)的 application.yml(或 properties)(带spring.profile)文件
  7. 打包在应用内(jar包内部)的 application.yml(或 properties)(带spring.profile)文件
  8. 应用以外(jar包外部)的 application.yml(或 properties)(不带spring.profile)文件
  9. 打包在应用内(jar包内部)的 application.yml(或 properties)(不带spring.profile)文件
  10. @Configuration注解类上的@PropertySource
  11. SpringApplication.setDefaultProperties 声明的默认属性

由于涉及内容众多,本系列暂不展开细讲。

二、自定义配置(属性)

2.1 定义属性类

一本书的属性包含:书名、价格、页数等,定义一个Book类,如下:

package com.zyr.demo.domain;

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

@Component  //将该类作为Bean注入Spring容器
@ConfigurationProperties(prefix = "book")  //配置文件中book前缀的属性将自动绑定到本类对应的字段
public class Book {
    private String name;
    private Double price;
    private Integer page;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Double getPrice() {
        return price;
    }

    public void setPrice(Double price) {
        this.price = price;
    }

    public Integer getPage() {
        return page;
    }

    public void setPage(Integer page) {
        this.page = page;
    }

    @Override
    public String toString() {
        return "Book{" +
                "name='" + name + '\'' +
                ", price=" + price +
                ", page=" + page +
                '}';
    }
}

2.2 添加配置参数

类定义完成后,就可在application.ymlkey-value的形式,增加想自定义的配置,如下:

#Book.java的属性
book:
  name: 一本书
  price: 35.5
  page: 128

配置完成后,当使用Book类的时候,其字段将自动赋值配置中的值。

2.3 测试

编写Book的测试类,如下:

package com.zyr.demo.domain;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import static org.junit.Assert.assertEquals;

@RunWith(SpringRunner.class)
@SpringBootTest
public class BookTest {

    @Autowired
    private Book book;

    @Test
    public void test() {
        assertEquals("一本书", book.getName());
        assertEquals(35.5, book.getPrice(), .001);
        assertEquals(128, book.getPage(), .001);
    }
}

运行测试用例,测试通过,说明上面的自定义配置成功。

2.4 另外

Spring BootRandomValuePropertySource类,提供了很多生成随机数的工具,如随机字符串,随机整数,指定范围内的随机数等等。
直接将application.ymlbook的参数修改如下:

#Book.java的属性
book:
  name: ${random.value} #赋值随机字符串
  price: ${random.int}  #赋值随机整数
  page: ${random.int}   #赋值随机整数

BookTest.test改为打印输出Book,多次运行,控制台每次显示的Book的值都不一样:

@Test
public void test() {
    System.out.println(book);
}

三、适配多环境

通常在一个实际的项目中,会有开发环境,生产环境等,并且在不同的环境中,对应的配置如:数据库配置,端口号配置,缓存配置等,一般会不同,所以需要针对不同的环境,编写不同的配置文件,公用的配置直接写在application.yml中。

3.1 新增配置文件

在与application.yml同级的地方,即resources文件夹下新增如下两个配置文件:

application-dev.yml        //开发环境配置文件
application-pro.yml        //生产环境配置文件

3.2 使用指定环境的配置文件

通过在application.yml使用spring.profiles.active配置,即可使用指定环境的配置文件,如:

#文件`application.yml`

spring:
  profiles:
    active: dev  #使用开发环境配置
#文件`application-dev.yml`

#Book.java的属性
book:
  name: ${random.value} #赋值随机字符串
  price: ${random.int}  #赋值随机整数
  page: ${random.int}   #赋值随机整数
#文件`application-pro.yml`

#Book.java的属性
book:
  name: 一本书
  price: 35.5
  page: 128

3.3 测试

现在是开发环境,运行上面的测试用例BookTest.test,控制台输出随机数的Book

Book{name='d326d313d13023c9b32f9f76efe90063', price=1.8404973E9, page=1297575634}

application.yml改为:

spring:
  profiles:
    active: pro #使用生成环境配置

再次运行测试用例BookTest.test,控制台输出application-pro.yml中指定的Book的值:

Book{name='一本书', price=35.5, page=128}

最后

本文介绍了实际开发中Spring Boot常用的配置情况,关于application.yml中详细的配置说明,请参考官方说明

本文代码已上传至我的GitHub仓库,进入以后将branches切换为2-Config即可看见。

前篇:
Spring Boot实际应用讲解(一):Hello World

后续将推出以下文章,敬请关注!

Spring Boot实际应用讲解(三):表单验证
Spring Boot实际应用讲解(四):RESTful API
Spring Boot实际应用讲解(五):AOP之请求日志
Spring Boot实际应用讲解(六):MySQL + Spring-data-jpa(Hibernate)
Spring Boot实际应用讲解(七):统一异常处理
Spring Boot实际应用讲解(八):MySQL + Mybatis
Spring Boot实际应用讲解(九):MySQL + Mybatis + Redis

文中若有错之处,还请各位批评指正,谢谢!

原文作者/ZYRzyr
原文链接:http://www.jianshu.com/p/d4c7f33c9b37

请进入这里获取授权:https://101709080007647.bqy.mobi

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