springboot入门之路(三)_Spring Boot特性

springboot入门之路(三)_Spring Boot特性

4.Spring Boot特性

---

阅读：springboot入门之路(二)

spring Boot特性:代码获取点我

4.1 自定义Banner

• 接下来我们就来介绍一下这个轻松愉快的自定义banner功能。实现的方式非常简单，我们只需要在Spring Boot工程的/src/main/resources目录下创建一个banner.txt文件，然后将ASCII字符画复制进去，就能替换默认的banner了。比如上图中的输出，就采用了下面的banner.txt内容

${AnsiColor.BRIGHT_GREEN}  
##     ##    ###    ########  ########  ##    ##    ##    ## ######## ##      ##    ##    ## ########    ###    ########  
##     ##   ## ##   ##     ## ##     ##  ##  ##     ###   ## ##       ##  ##  ##     ##  ##  ##         ## ##   ##     ##  
##     ##  ##   ##  ##     ## ##     ##   ####      ####  ## ##       ##  ##  ##      ####   ##        ##   ##  ##     ##  
######### ##     ## ########  ########     ##       ## ## ## ######   ##  ##  ##       ##    ######   ##     ## ########  
##     ## ######### ##        ##           ##       ##  #### ##       ##  ##  ##       ##    ##       ######### ##   ##  
##     ## ##     ## ##        ##           ##       ##   ### ##       ##  ##  ##       ##    ##       ##     ## ##    ##  
##     ## ##     ## ##        ##           ##       ##    ## ########  ###  ###        ##    ######## ##     ## ##     ##  
${AnsiColor.BRIGHT_RED}  
Application Version: ${application.version}${application.formatted-version}  
Spring Boot Version: ${spring-boot.version}${spring-boot.formatted-version}  

• 注：如果想以编程的方式产生一个banner，可以使用SpringBootApplication.setBanner(…)方法。使用
  org.springframework.boot.Banner接口，实现你自己的printBanner()方法。

4.2 命令行启动器

• 如果你想获取原始的命令行参数，或一旦SpringApplication启动，你需要运行一些特定的代码，你可以实现
  CommandLineRunner接口。在所有实现该接口的Spring beans上将调用run(String… args)方法。

package com.test.common;

import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

/**
 * 类CommonConfig.java的实现描述：TODO 类实现描述
 * 
 * @author tangjinhui 2018年4月9日 下午4:15:13
 */
@Component
public class CommonConfig implements CommandLineRunner {

    @Override
    public void run(String... arg0) throws Exception {
        // TODO Auto-generated method stub
        System.err.print("commandLineRunner");
    }

}

• 如果一些CommandLineRunner beans被定义必须以特定的次序调用，你可以额外实现org.springframework.core.Ordered接
  口或使用org.springframework.core.annotation.Order注解。

4.3.1 外化配置

• Spring Boot允许外化（externalize）你的配置，这样你能够在不同的环境下使用相同的代码。你可以使用properties文件，
  YAML文件，环境变量和命令行参数来外化配置。使用@Value注解，可以直接将属性值注入到你的beans中，并通过Spring
  的Environment抽象或绑定到结构化对象来访问。

• 需要以下面的次序考虑属性：

1. 命令行参数
2. 来自于java:comp/env的JNDI属性
3. Java系统属性（System.getProperties()）
4. 操作系统环境变量
5. 只有在random.*里包含的属性会产生一个RandomValuePropertySource
6. 在打包的jar外的应用程序配置文件（application.properties，包含YAML和profile变量）
7. 在打包的jar内的应用程序配置文件（application.properties，包含YAML和profile变量）
8. 在@Configuration类上的@PropertySource注解
9. 默认属性（使用SpringApplication.setDefaultProperties指定）

4.3.2 属性占位符

• 当application.properties里的值被使用时，它们会被存在的Environment过滤，所以你能够引用先前定义的值（比如，系统属
  -性）。

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

4.3.3 使用YAML代替Properties

• YAML是JSON的一个超集，也是一种方便的定义层次配置数据的格式。无论你何时将SnakeYAML 库放到classpath下，
  SpringApplication类都会自动支持YAML作为properties的替换。
• Spring框架提供两个便利的类用于加载YAML文档，YamlPropertiesFactoryBean会将YAML作为Properties来加载，
  YamlMapFactoryBean会将YAML作为Map来加载。

示例：
environments:
dev:
url: http://dev.bar.com
name: Developer Setup
prod:
url: http://foo.bar.com
name: My Cool App

上面的YAML文档会被转化到下面的属性中：
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列表被表示成使用[index]间接引用作为属性keys的形式，例如下面的YAML：
my:
servers:
- dev.bar.com
- foo.bar.com

将会转化到下面的属性中:
my.servers[0]=dev.bar.com
my.servers[1]=foo.bar.com
使用Spring DataBinder工具绑定那样的属性（这是@ConfigurationProperties做的事），你需要确定目标bean中有个
java.util.List或Set类型的属性，并且需要提供一个setter或使用可变的值初始化它，比如，下面的代码将绑定上面的属性：
@ConfigurationProperties(prefix="my")
public class Config {
private List<String> servers = new ArrayList<String>();
public List<String> getServers() {
return this.servers;
}

4.3.4 YAML缺点

• YAML文件不能通过@PropertySource注解加载。所以，在这种情况下，如果需要使用@PropertySource注解的方式加载值，
  那就要使用properties文件。

4.3.5 安全的配置属性

• 使用@Value("${property}")注解注入配置属性有时可能比较笨重，特别是需要使用多个properties或你的数据本身有层次结
  构。为了控制和校验你的应用配置，Spring Boot提供一个允许强类型beans的替代方法来使用properties。

示例：
@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {
private String username;
private InetAddress remoteAddress;
// ... getters and setters
}

• 当@EnableConfigurationProperties注解应用到你的@Configuration时，任何被@ConfigurationProperties注解的beans将自
  动被Environment属性配置。这种风格的配置特别适合与SpringApplication的外部YAML配置进行配合使用。

# application.yml
connection:
username: admin
remoteAddress: 192.168.1.1
# additional configuration as required
为了使用@ConfigurationProperties beans，你可以使用与其他任何bean相同的方式注入它们。

4.3.6 Profiles

• Spring Profiles提供了一种隔离应用程序配置的方式，并让这些配置只能在特定的环境下生效。任何@Component或
  @Configuration都能被@Profile标记，从而限制加载它的时机。

举例子：
@Configuration
@Profile("production")
public class ProductionConfiguration {
// ...
}

• 以正常的Spring方式，你可以使用一个spring.profiles.active的Environment属性来指定哪个配置生效。你可以使用平常的任
  何方式来指定该属性，例如，可以将它包含到你的application.properties中：

spring.profiles.active=dev,hsqldb

4.3.6.1 添加激活的配置(profiles)

• spring.profiles.active属性和其他属性一样都遵循相同的排列规则，最高的PropertySource获胜。也就是说，你可以在
  application.properties中指定生效的配置，然后使用命令行开关替换它们。
  有时，将特定的配置属性添加到生效的配置中而不是替换它们是有用的。
• spring.profiles.include属性可以用来无条件的添加
  生效的配置。SpringApplication的入口点也提供了一个用于设置额外配置的Java API（比如，在那些通过
• spring.profiles.active属性生效的配置之上）：参考setAdditionalProfiles()方法。
  示例：当一个应用使用下面的属性，并用 --spring.profiles.active=prod 开关运行，那proddb和prodmq配置也会生效：

在yaml中配置：

spring.profiles: prod
spring.profiles.include: proddb,prodmq

4.3.6.2 Profile特定配置文件

• application.properties（或application.yml）和通过@ConfigurationProperties引用的文件这两种配置特定变种都被当作文件
  来加载的

4.4 日志的配置使用

• Spring Boot内部日志系统使用的是Commons Logging，但开放底层的日志实现。默认为会Java Util Logging, Log4J, Log4J2
  和Logback提供配置。每种情况下都会预先配置使用控制台输出，也可以使用可选的文件输出。
  默认情况下，如果你使用'Starter POMs'，那么就会使用Logback记录日志。为了确保那些使用Java Util Logging, Commons
  Logging, Log4J或SLF4J的依赖库能够正常工作，正确的Logback路由也被包含进来。

注：如果上面的列表看起来令人困惑，不要担心，Java有很多可用的日志框架。通常，你不需要改变日志依赖，Spring Boot
默认的就能很好的工作。-

4.4.1 日志格式

Spring Boot默认的日志输出格式如下：

2018-04-10 16:38:35.165  INFO 9224 --- [  restartedMain] com.test.SpringbootApplication           : Starting SpringbootApplication on PC-20170526TZZP with PID 9224 (started by Administrator in E:\ruiyouProjects\springbootDemo（三）)
2018-04-10 16:38:35.187  INFO 9224 --- [  restartedMain] com.test.SpringbootApplication           : No active profile set, falling back to default profiles: default
2018-04-10 16:38:37.059  INFO 9224 --- [  restartedMain] ationConfigEmbeddedWebApplicationContext : Refreshing org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@193b4fef: startup date [Tue Apr 10 16:38:37 CST 2018]; root of context hierarchy

输出的节点（items）如下：

1. 日期和时间 - 精确到毫秒，且易于排序。
2. 日志级别 - ERROR, WARN, INFO, DEBUG 或 TRACE。
3. Process ID。
4. 一个用于区分实际日志信息开头的---分隔符。
5. 线程名 - 包括在方括号中（控制台输出可能会被截断）。
6. 日志名 - 通常是源class的类名（缩写）。
7. 日志信息。
   8

4.4.2 日志级别

• 所有支持的日志系统在Spring的Environment（例如在application.properties里）都有通
  logging.level：日志级别控制前缀，*为包名或Logger名
  LEVEL：选项TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF。

示例：application.properties
logging.level.root=WARN：root日志以WARN级别输出
logging.level.org.springframework.web: DEBUG #包下所有class以DEBUG级别输出

2018-04-10 17:20:08.942  INFO 9224 --- [  restartedMain] o.s.b.d.a.OptionalLiveReloadServer       : LiveReload server is running on port 35729
2018-04-10 17:20:09.010  INFO 9224 --- [  restartedMain] o.s.j.e.a.AnnotationMBeanExporter        : Registering beans for JMX exposure on startup
2018-04-10 17:20:09.020 DEBUG 9224 --- [  restartedMain] o.s.w.s.resource.ResourceUrlProvider     : Looking for resource handler mappings
2018-04-10 17:20:09.027 DEBUG 9224 --- [  restartedMain] o.s.w.s.resource.ResourceUrlProvider     : Found resource handler mapping: URL pattern="/**/favicon.ico", locations=[ServletContext resource [/], class path resource [META-INF/resources/], class path resource [resources/], class path resource [static/], class path resource [public/], class path resource []], resolvers=[org.springframework.web.servlet.resource.PathResourceResolver@3bd57b15]

4.4.3 日志文件输出路径配置

1. 默认情况下，Spring Boot将日志输出到控制台，不会写到日志文件。

• 使用Spring Boot喜欢在application.properties或application.yml配置，这样只能配置简单的场景，保存路径、日志格式等，复杂的场景（区分 info 和 error 的日志、每天产生一个日志文件等）满足不了，只能自定义配置，下面会演示。

如果要编写除控制台输出之外的日志文件，则需在application.properties中设置logging.file或logging.path属性。logging.file，设置文件，可以是绝对路径，也可以是相对路径。如：logging.file=my.log
logging.path，设置目录，会在该目录下创建spring.log文件，并写入日志内容，如：logging.path=/var/log 
如果只配置 logging.file，会在项目的当前路径下生成一个 xxx.log 日志文件。 
如果只配置 logging.path，在 /var/log文件夹生成一个日志文件为 spring.log
#默认会在设置的 path 生成一个spring.log 文件。
#logging.path:E:/log1234
logging.pattern.console:"%d - %msg%n"
logging.file:E:/log1234/springboot_log_4.log

注：二者不能同时使用，如若同时使用，则只有logging.file生效
默认情况下，日志文件的大小达到10MB时会切分一次，产生新的日志文件，默认级别为：ERROR、WARN、INFO

4.4.4 自定义日志配置

4.4.4.1 日志系统定制

通过将适当的库添加到classpath，可以激活各种日志系统。然后在classpath的根目录(root)或通过Spring Environment
的 logging.config 属性指定的位置提供一个合适的配置文件来达到进一步的定制（注意由于日志是在ApplicationContext被创
建之前初始化的，所以不可能在Spring的@Configuration文件中，通过@PropertySources控制日志。系统属性和平常的
Spring Boot外部配置文件能正常工作）。-

日志系统定制
Logback：logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
Log4j：log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
Log4j2：log4j2-spring.xml, log4j2.xml
JDK (Java Util Logging)：logging.properties

4.4.4.2日志系统定制路径配置

Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置（如使用logback-spring.xml，而不是logback.xml），命名为logback-spring.xml的日志配置文件，spring boot可以为它添加一些spring boot特有的配置项（下面会提到）。
默认的命名规则，并且放在 src/main/resources 下面即可：
如果你即想完全掌控日志配置，但又不想用logback.xml作为Logback配置的名字，application.yml可以通过logging.config属性指定自定义的名字

logging.config=classpath:logging-config.xml

注：为了帮助定制一些其他的属性，从Spring的Envrionment转换到系统属性：
SpringEnvironment SystemProperty 评价
logging.file LOG_FILE 如果定义，在默认的日志配置中使用
logging.path LOG_PATH 如果定义，在默认的日志配置中使用
PID PID 当前的处理进程(process)ID（如果能够被发现且还没有作为操作系统环境
变量被定义）
所有支持的日志系统在解析它们的配置文件时都能查询系统属性。具体可以参考spring-boot.jar中的默认配置。

3. logback日志的配置详解(springbootDemo（四）中查看该部分代码)

3.1 根节点包含的属性

scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
根节点<configuration>有5个子节点，下面一一会详细介绍

子节点一 <root>

Root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性。

level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。 
默认是DEBUG。 
可以包含零个或多个元素，标识这个appender将会添加到这个loger。


<root level="debug">
  <appender-ref ref="console" />
  <appender-ref ref="file" />
</root>

子节点二：<contextName> 设置上下文名称

每个logger都关联到logger上下文，默认上下文名称为“default”。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改,可以通过%contextName来打印日志上下文名称，一般来说我们不用这个属性，可有可无。

<contextName>logback</contextName>

子节点三：<property> 设置变量

用来定义变量值的标签， 有两个属性，name和value；其中name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。

<property name="logback.logdir" value="/Users/inke/dev/log/tomcat"/>
<property name="logback.appname" value="app"/>

这里可以看后通过 application.yml 传递参数过来

子节点四：<appender>

appender用来格式化日志输出节点，有俩个属性name和class，class用来指定哪种输出策略，常用就是控制台输出策略和文件输出策略。

控制台输出ConsoleAppender：
示例一：

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <contextName>logback-demo</contextName>

    <!--输出到控制台 ConsoleAppender-->
    <appender name="consoleLog1" class="ch.qos.logback.core.ConsoleAppender">
        <!--展示格式 layout-->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d -1 %msg%n</pattern>
        </layout>
    </appender>

    <!--输出到控制台 ConsoleAppender-->
    <appender name="consoleLog2" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d -2 %msg%n</pattern>
        </encoder>
    </appender>

    <!--指定最基础的日志输出级别-->
    <root level="INFO">
        <!--appender将会添加到这个loger-->
        <appender-ref ref="consoleLog1"/>
        <appender-ref ref="consoleLog2"/>
    </root>

</configuration>

eg:console控制台

2018-04-16 11:37:00,116 -1 Mapped URL path [/**/favicon.ico] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2018-04-16 11:37:00,116 -2 Mapped URL path [/**/favicon.ico] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2018-04-16 11:37:00,853 -1 ClassTemplateLoader for Spring macros added to FreeMarker configuration
2018-04-16 11:37:00,853 -2 ClassTemplateLoader for Spring macros added to FreeMarker configuration
2018-04-16 11:37:00,904 -1 

示例二：

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <contextName>logback-demo</contextName>

    <!--输出到控制台 ConsoleAppender-->
    <appender name="consoleLog1" class="ch.qos.logback.core.ConsoleAppender">
        <!--展示格式 layout-->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>
                <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
            </pattern>
        </layout>
        <!--
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
             <level>ERROR</level>
        </filter>
         -->
    </appender>

    <!--指定最基础的日志输出级别-->
    <root level="INFO">
        <!--appender将会添加到这个loger-->
        <appender-ref ref="consoleLog1"/>
  
    </root>
</configuration>

eg:consloe控制台

11:44:49.005 logback-demo [restartedMain] INFO  o.s.b.d.a.OptionalLiveReloadServer - LiveReload server is running on port 35729
11:44:49.102 logback-demo [restartedMain] INFO  o.s.j.e.a.AnnotationMBeanExporter - Registering beans for JMX exposure on startup
11:44:49.120 logback-demo [restartedMain] INFO  o.a.coyote.http11.Http11NioProtocol - Initializing ProtocolHandler ["http-nio-8080"]
1

<encoder>表示对日志进行编码：

%d{HH: mm:ss.SSS}——日志输出时间
%thread——输出日志的进程名字，这在Web应用以及异步任务处理中很有用
%-5level——日志级别，并且使用5个字符靠左对齐
%logger{36}——日志输出者的名字
%msg——日志消息
%n——平台的换行符 

参考文档：

1. Spring Boot 日志配置；
2. Springboot参考指南
3. Springboot实战，丁雪峰（译者）