【框架学习】日志实践Logging - hippowc/hippowc.github.io GitHub Wiki

一般日志格式

2018-06-12 09:51:46.829 INFO 20632 --- [ main] org.apache.catalina.core.StandardEngine : Starting Servlet

时间日期 日志级别 进程ID ---分隔符 [线程名] Logger名(通常是类名称) 日志内容

以logback为例，其他也差不多

是根结点，下面一共有2个属性，3个子节点。

两个属性：属性一：设置上下文名称，默认上下文名称为“default”。但可以使用设置成其他名字，用于区分不同应用程序的记录；属性二：设置变量，用来定义变量值的标签， 有两个属性，name和value；其中name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。

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

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

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

ThresholdFilter为系统定义的拦截器，例如我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中。如果不用记得注释掉，不然你控制台会发现没日志

输出到文件：

<!--输出到文件-->
<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
		<fileNamePattern>${log.path}/logback.%d{yyyy-MM-dd}.log</fileNamePattern>
        <maxHistory>30</maxHistory>
		<totalSizeCap>1GB</totalSizeCap>
    </rollingPolicy>
    <encoder>
        <pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern>
    </encoder>
</appender>

其中重要的是rollingPolicy的定义，上例中${log.path}/logback.%d{yyyy-MM-dd}.log定义了日志的切分方式——把每一天的日志归档到一个文件中，30表示只保留最近30天的日志，以防止日志填满整个磁盘空间。同理，可以使用%d{yyyy-MM-dd_HH-mm}来定义精确到分的日志切分方式。1GB用来指定日志文件的上限大小，例如设置为1GB的话，那么到了这个值，就会删除旧的日志。

子节点二: root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性。level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF;默认是DEBUG;可以包含零个或多个元素，标识这个appender将会添加到这个logger

子节点三: 用来设置某一个包或者具体的某一个类的日志打印级别、以及指定。仅有一个name属性，一个可选的level和一个可选的addtivity属性。

name:用来指定受此logger约束的某一个包或者具体的某一个类。level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前logger将会继承上级的级别；addtivity:是否向上级logger传递打印信息。默认是true。

使用例子：

第一种：带有logger的配置，不指定级别，不指定appender：；将控制controller包下的所有类的日志的打印，但是并没用设置打印级别，所以继承他的上级的日志级别“info”； 没有设置addtivity，默认为true，将此logger的打印信息向上级传递； 没有设置appender，此logger本身不打印任何信息。 将root的打印级别设置为“info”，指定了名字为“console”的appender。

当执行打印操作时：在包com.dudu.controller中，所以首先执行，将级别为“info”及大于“info”的日志信息传递给root，本身并不打印； root接到下级传递的信息，交给已经配置好的名为“console”的appender处理，“console”appender将信息打印到控制台；

第二种：带有多个logger的配置，指定级别，指定appender：

<logger name="com.dudu.controller.LearnController" level="WARN" additivity="false">
    <appender-ref ref="console"/>
</logger>

控制com.dudu.controller.LearnController类的日志打印，打印级别为“WARN”; additivity属性为false，表示此logger的打印信息不再向上级传递; 指定了名字为“console”的appender;

将级别为“WARN”及大于“WARN”的日志信息交给此logger指定的名为“console”的appender处理，在控制台中打出日志，不再向上级root传递打印信息。当然如果你把additivity=”false”改成additivity=”true”的话，就会打印两次，因为打印信息向上级传递，logger本身打印一次，root接到后又打印一次。

代码中使用

代码中使用日志也很简单，类里面添加private Logger logger = LoggerFactory.getLogger(this.getClass());即可。

springboot中的实践

Spring Boot在所有内部日志中使用Commons Logging，但是默认配置也提供了对常用日志的支持，如：Java Util Logging，Log4J, Log4J2和Logback。每种Logger都可以通过配置使用控制台或者文件输出日志内容。

默认情况下，Spring Boot会用Logback来记录日志，并用INFO级别输出到控制台。

设置debug级别：Spring Boot中默认配置了ERROR、WARN和INFO级别的日志输出到控制台。

1、在运行命令后加入--debug标志，如：$ java -jar myapp.jar --debug 2、在application.properties中配置debug=true，该属性置为true的时候，核心Logger（包含嵌入式容器、hibernate、spring）会输出更多内容，但是你自己应用的日志并不会输出为DEBUG级别。

Spring Boot默认配置只会输出到控制台，并不会记录到文件中，但是我们通常生产环境使用时都需要以文件方式记录。 若要增加文件输出，需要在application.properties中配置logging.file或logging.path属性。

logging.file，设置文件，可以是绝对路径，也可以是相对路径。如：logging.file=my.log logging.path，设置目录，会在该目录下创建spring.log文件，并写入日志内容，如：logging.path=/var/log

级别控制

在Spring Boot中只需要在application.properties中进行配置完成日志记录的级别控制。

配置格式：logging.level.*=LEVEL

logging.level：日志级别控制前缀，*为包名或Logger名 LEVEL：选项TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF 举例：

logging.level.com.didispace=DEBUG：com.didispace包下所有class以DEBUG级别输出 logging.level.root=WARN：root日志以WARN级别输出

自定义输出格式

在Spring Boot中可以通过在application.properties配置如下参数控制输出格式：

logging.pattern.console：定义输出到控制台的样式（不支持JDK Logger） logging.pattern.file：定义输出到文件的样式（不支持JDK Logger）

关于使用application.properties的变量：由于logback-spring.xml加载的比application.properties早，所以logback中的占位符不能使用application中变量。logback中的使用的变量都是环境变量，可能是jvm参数（-Dlog.level）或者通过logbackListener设置的。

spring-boot-starter-logging的依赖：

ch.qos.logback:logback-classic：logback实现了slf4j的API，logback-core:logback的核心包

org.slf4j:jcl-over-slf4j：jcl和slf4j类似也是一个日志框架，为了兼容jcl框架的内容，通过这个jar，把jcl实现的日志输出重定向到 SLF4J，其中提供了common-logging的API

org.slf4j:jul-to-slf4j：兼容使用java.util.Logging，其中提供了java.util.Logging的API

org.slf4j:log4j-over-slf4j：兼容使用log4j的API

也就是说，应用层可以使用jcl、jul、log4j的API去记录日志。然后通过以上三个桥接包，内部使用slf4j的API去实现，最终slf4j再使用底层的logback实现。

⚠️ **GitHub.com Fallback** ⚠️