一起学JAVA之《spring boot》04 - spring boot 自定义(外化)配置

一、导航

本节内容简介:
1. 配置介绍
2. 配置随机值
3. 访问命令行属性,jar包代码结构
4. 不同环境的配置文件
5. 配置文件中的占位符
6. 使用YAML代替properties

一、 配置介绍

spring boot 可以有多种方法来实现对配置的自定义,我们需要知道有哪些配置的方式,顺序是怎么样的

配置顺序(优先级循序即优先级高的可以覆盖低的):

  1. 命令行参数
  2. 来自java的JNDI属性
  3. java系统属性(System.properties)
  4. 操作系统环境变量
  5. random.*里包含的属性(RandomValuePropertySource)
  6. 在打包jar外的应用配置文件(application.properties,YAML)
  7. 在打包jar内的应用配置文件(application.properties,YAML)
  8. 在@Configuration配置的
  9. spring boot默认属性

注意:

  • spring boot 可以在启动的时候动态修改配置文件内容,包括自定义内容
  • jar 打包外部配置文件可以覆盖jar内的配置文件

二、配置随机值

随机值使用情况

  • 随机值可以在访问页面的时候带上,防止缓存,
  • 在某些需要测试数据每次不一致的时候使用
  • 也可以从当UUID

在配置文件中加如下配置

server.port=8081
server.context-path=/boot

number=${random.int}

在昨天的测试类中继续添加测试方法

package com.likeoak.controller;


import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 测试Controller
 * The type Test controller.
 */
@RestController
public class TestController {
    @Value("${number}")
    private Integer number;

    /**
     * 返回 String 字符串,访问成功,返回“test ok”
     * Test string.
     *
     * @return the string
     */
    @RequestMapping("/test")
    public String test(){

        return  "test ok!";
    }

    /**
     * 测试随机返回一个整数
     * Test random int integer.
     *
     * @return the integer
     */
@RequestMapping("/testRandomInt")
    public Integer testRandomInt(){
        return number;
    }


}


启动,访问http://localhost:8081/boot/testRandomInt
结果:
1574663730

配置随机值,可以配置的情况

  • 随机整数(int)
  • 随机范围内的整数
  • 随机long整数
  • 随机字符串

在配置文件中添加如下属性

//随机整数
number=${random.int}
//随机小于10的整数
numberLessThan=${random.int(10)}
//随机10-100整数
numberRange=${random.int(10,100)}
//随机long
longNumber=${random.long}
//随机字符串
randomStr=${random.value}

在测试类中继续添加如下方法

  @RequestMapping("/testRandom")
    public String testRandom(){

        StringBuilder builder = new StringBuilder();
        builder.append("随机返回值:{");
        builder.append(" 随机整数:"+number );
        builder.append(" 随机小于10的整数:"+numberLessThan  );
        builder.append(" 随机10-100的整数:"+numberRange  );
        builder.append(" 随机long:"+longNumber  );
        builder.append(" 随机字符串:"+randomStr  +"}");

        return builder.toString();
    }

启动,访问:http://localhost:8081/boot/testRandom
结果:随机返回值:{ 随机整数:905599732 随机小于10的整数:0 随机10-100的整数:26 随机long:-8568292958322258583 随机字符串:1a4b7f3091807cee19a44a18f08caae5}

三、访问命令行属性,jar包代码结构

  • 对当前程序用maven打包,即使用mvn clean , mvn package命令
  • 打包之后在项目的target目录中,可以看到打包好的jar包
    [图片上传失败...(image-5063dc-1524582956743)]

默认情况下,spring boot可以执行任何以--开头的参数,如 --server.port=8081

执行:
java -jar SpringApplicationIntroduce-1.0.0.jar --server.port=8082
执行结果:


--server.port

可以看到,端口已经被覆盖,变为8082了

在target目中我们还看到一个SpringApplicationIntroduce-1.0.0.jar.original文件,这个文件可以看到这个jar包结构,执行以下命令
jar tvf SpringApplicationIntroduce-1.0.0.jar.original

目录结构:
[图片上传失败...(image-6487e1-1524582956743)]
jar包主要有三层目录
org
METE-INF
BOOT-INF

  • 其中org目录中包含spring boot加载的依赖包
  • METE-INF包中主要是spring boot 启动配置
    特别注意MANIFEST.MF 配置:
Manifest-Version: 1.0
Implementation-Title: SpringApplicationIntroduce
Implementation-Version: 1.0.0
Archiver-Version: Plexus Archiver
Built-By: SEELE
Implementation-Vendor-Id: com.likeoak
Spring-Boot-Version: 1.5.2.RELEASE
Implementation-Vendor: Pivotal Software, Inc.
Main-Class: org.springframework.boot.loader.JarLauncher
Start-Class: com.likeoak.App
Spring-Boot-Classes: BOOT-INF/classes/
Spring-Boot-Lib: BOOT-INF/lib/
Created-By: Apache Maven 3.2.5
Build-Jdk: 1.8.0_121
Implementation-URL: http://maven.apache.org

可以看到打包的信息,还可以看到启动主类,版本信息等
有时候启动报错,找不到主类,就可以看看这个配置文件是否打包正确

  • BOOT-INF为我们自己写的代码及配置文件

四、不同环境的配置文件

一般我们开发有开发环境,测试有测试环境,生产有生产环境,我们应该把配置文件分开,分开规则是:
application-{profile}.properties
如:

  • 生产 application-prod.properties
  • 测试 application-test.properties
    然后在application.properties中指定环境
spring.profiles.action=prod

五、配置文件中的占位符

在一个配置文件中,如果有共同属性,我们可以提取出来用占位符

如:

 app.name=aaa
 app.description=${app.name} is a Spring Boot application

这里在app.description中${app.name}就是占位符,就会被替换成aaa

六、使用YAML代替properties

YAML是JSON的一个超集,也是一种方便的定义层次配置数据的格式。spring boot 可以使用YAML替代properties文件

  • 普通替代
    如:
    在properties中
environments.dev.url=http://dev.bar.com
environments.dev.name=Developer Setup
environments.prod.url=http://foo.bar.com
environments.prod.name=My Cool App

在YAML中

environments:
    dev:
        url: http://dev.bar.com
        name: Developer Setup
    prod:
        url: http://foo.bar.com
        name: My Cool App
  • YAML列表
    如:
my:
    servers:
        - dev.bar.com
        - foo.bar.com

变成properties就变为以下格式

my.servers[0]=dev.bar.com
my.servers[1]=foo.bar.com
  • YAML 多环境可以使用同一配置文件
    如:
server:
    address: 192.168.1.100
---
spring:
    profiles: development
server:
    address: 127.0.0.1
---
spring:
    profiles: production
server:
    address: 192.168.1.120

如果在上面配置文件中在配置spring.profiles.action=production,那么 server.address=192.168.1.120 就会被激活
如果没有配置,就会默认使用server.address=192.168.1.100

你可能感兴趣的:(一起学JAVA之《spring boot》04 - spring boot 自定义(外化)配置)