SpringBoot　日志（学习笔记13）

选择 SLF4j 和 Logback 组合方式。

1、如何在系统中使用SLF4j：

以后在开发的时候，日志记录方法的调用，不应该来直接调用日志的实现类，而是调用日志抽象层的方法；抽象层的方法自动实现日志实现类的方法。

SLF4j地址：https://www.slf4j.org/manual.html

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;public class HelloWorld {public static void main(String[] args) {Logger logger = LoggerFactory.getLogger(HelloWorld.class);logger.info("Hello World");}
}

简单说明：深蓝颜色的都是一些实现、墨绿颜色的是中间的适配层、

这里我们需要导入 slf4j.jar(门面jar) 和 logback.jar(实现jar)。每一个日志的实现框架都有自己的配置文件信息，slf4j提供了统一的抽象层(上图淡蓝色SLF4J API处)，如果你选择哪个实现（深灰色是实现）你就使用其自身的配置文件。

2、其它日志框架统一转换为slf4j

场景：

比如我们在开一个项目时，采用的日志方式是(slf4j + logback)，项目中要依赖一些框架 Spring、Hibernate、MyBatis等等，但是每一个框架在底层中可能也用到了日志，各不相同；比如：Spring 用到了commons-logging、Hibernate 用到了 jboss-loggin。整个项目在日志方面很混乱，所有我们需要统一日志记录，都采用(slf4j + logback)这一种方式。

上图出处：https://www.slf4j.org/legacy.html

如何让系统中所有的日志都统一到SLF4J:

1、将系统中其它日志框架先排除出去；

比如导入Spring 的时候，不导入commons-logging 日志，用 jcl-over-slf4j.jar 来代替。

2、用中间包来替换原有的日志框架；

jcl-over-slf4j.jar 就一个中间包，如果不导入commons-logging 日志，也不用中间包代替，Spring 框架就会出现异常

3、我们导入 slf4j 其它的实现

3、SpringBoot日志关系

小结：

1、SpringBoot底层使用 slf4j+logback 的方式进行日志记录，SpringBoot能自动适配所有的日志

2、SpringBoot把其它的日志都替换成了slf4j

3、SpringBoot加入了中间替换包

4、如果我引入其它框架，一定要把这个框架中的日志依赖移除掉，否则会有冲突

4、日志默认配置

SpringBoot默认帮我配置好了日志；

不同的级别的含义大家都很容易理解，这里就简单介绍一下：

trace：是追踪，就是程序推进以下，你就可以写个trace输出，所以trace应该会特别多，不过没关系，我们可以设置最低日志级别不让他输出。

debug：调试么，我一般就只用这个作为最低级别，trace压根不用。是在没办法就用eclipse或者idea的debug功能就好了么。

info：输出一下你感兴趣的或者重要的信息，这个用的最多了。

warn：有些信息不是错误信息，但是也要给程序员的一些提示，类似于eclipse中代码的验证不是有error 和warn（不算错误但是也请注意，比如以下depressed的方法）。

error：错误信息。用的也比较多。

------------------------------------------------------------------------------------------------------------------------------------------------------------------------

5、如果我们想定义自己的配置，该如何实现呢？

根据日志系统，加载下列文件:

注：在可能的情况下，我们建议您使用-spring变量来进行日志配置(例如，使用logback-spring.xml而不是logback.xml)。如果使用标准配置位置，Spring不能完全控制日志初始化。如果你配置的是logback.xml，直接就被日志框架识别了;推荐使用 logback-spring.xml 形式。

配置文件的放置规则，如果你是：

１、Logback，你就放置 logback-spring.xml, logback-spring.groovy, logback.xml, or logback.groovy

２、Log4j2，你就放置　log4j2-spring.xml or log4j2.xml

３、Log4j2，你就放置　logging.properties

如果在项目中加入自定义的日志配置文件（如下代码所示），名字叫 logback-spring.xml,

自定义的日志代码如下：

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false"><!-- 定义日志的根目录 --><property name="LOG_HOME" value="/app/log" /><!-- 定义日志文件名称 --><property name="appName" value="atguigu-springboot"></property><!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 --><appender name="stdout" class="ch.qos.logback.core.ConsoleAppender"><!--日志输出格式：%d表示日期时间，%thread表示线程名，%-5level：级别从左显示5个字符宽度%logger{50} 表示logger名字最长50个字符，否则按照句点分割。 %msg：日志消息，%n是换行符--><layout class="ch.qos.logback.classic.PatternLayout"><!-- 开发环境日志打印格式 --><springProfile name="dev"><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ---> [%thread] ---> %-5level %logger{50} - %msg%n</pattern></springProfile><!-- 非开发环境的日志格式信息 (通过一个简单表达式进行判断)--><springProfile name="!dev"><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern></springProfile></layout></appender><!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->  <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender"><!-- 指定日志文件的名称 --><file>${LOG_HOME}/${appName}.log</file><!--当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。--><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><!--滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动 %i：当文件大小超过maxFileSize时，按照i进行文件滚动--><fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern><!-- 可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动，且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。--><MaxHistory>365</MaxHistory><!-- 当日志文件超过maxFileSize指定的大小是，根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy--><timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"><maxFileSize>100MB</maxFileSize></timeBasedFileNamingAndTriggeringPolicy></rollingPolicy><!-- 日志输出格式： -->     <layout class="ch.qos.logback.classic.PatternLayout"><pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern></layout></appender><!-- logger主要用于存放日志对象，也可以定义日志类型、级别name：表示匹配的logger类型前缀，也就是包的前半部分level：要记录的日志级别，包括 TRACE < DEBUG < INFO < WARN < ERRORadditivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出，false：表示只用当前logger的appender-ref，true：表示当前logger的appender-ref和rootLogger的appender-ref都有效--><!-- hibernate logger --><logger name="com.atguigu" level="debug" /><!-- Spring framework logger --><logger name="org.springframework" level="debug" additivity="false"></logger><!-- root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。 --><root level="info"><appender-ref ref="stdout" /><appender-ref ref="appLogAppender" /></root>
</configuration>

通过<springProfile>标签，Spring配置文件选择性地包含或排除配置的各个部分。配置文件部分在<configuration>元素的任何位置都受支持。使用name属性指定哪个配置文件接受配置。多个配置文件可以用逗号分隔列表指定。以下清单显示了三个样本配置文件：

注：logback.xml，直接就被日志框架识别了；logback-spring.xml 日志框架不能直接加载日志的配置项，由SpringBoot 解析日志配置，可以使用SpringBoot 的高级Profile 功能，如果在 logback.xml 日志配置文件中使用 springProfile，启动报错。

<springProfile name="staging"><!-- configuration to be enabled when the "staging" profile is active -->
</springProfile><springProfile name="dev, staging"><!-- configuration to be enabled when the "dev" or "staging" profiles are active -->
</springProfile><springProfile name="!production"><!-- configuration to be enabled when the "production" profile is not active -->
</springProfile>

这里可以配置不同环境下的日志打印格式，需要配置日志环境，如下图所示：

还可以通过命令行来激活日志环境：

６、切换日志框架

配置文件：

### set log levels ###
log4j.rootLogger = debug ,  stdout ,  D ,  E### 输出到控制台 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern =  %d{ABSOLUTE} %5p %c{ 1 }:%L - %m%n#### 输出到日志文件 ###
#log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
#log4j.appender.D.File = logs/log.log
#log4j.appender.D.Append = true
#log4j.appender.D.Threshold = DEBUG ## 输出DEBUG级别以上的日志
#log4j.appender.D.layout = org.apache.log4j.PatternLayout
#log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
#
#### 保存异常信息到单独文件 ###
#log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
#log4j.appender.D.File = logs/error.log ## 异常日志文件名
#log4j.appender.D.Append = true
#log4j.appender.D.Threshold = ERROR ## 只输出ERROR级别以上的日志!!!
#log4j.appender.D.layout = org.apache.log4j.PatternLayout
#log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

这里不推荐使用 log4j ,上面也是演示说明。

SLF4J不同于其他日志类库，与其它有很大的不同。SLF4J(Simple logging Facade for Java)不是一个真正的日志实现，而是一个抽象层（ abstraction layer），它允许你在后台使用任意一个日志类库。如果是在编写供内外部都可以使用的API或者通用类库，那么你真不会希望使用你类库的客户端必须使用你选择的日志类库。

如果一个项目已经使用了log4j，而你加载了一个类库，比方说 Apache Active MQ——它依赖于于另外一个日志类库logback，那么你就需要把它也加载进去。但如果Apache Active MQ使用了SLF4J，你可以继续使用你的日志类库而无语忍受加载和维护一个新的日志框架的痛苦。

总的来说，SLF4J使你的代码独立于任意一个特定的日志API，这是一个对于开发API的开发者很好的思想。虽然抽象日志类库的思想已经不是新鲜的事物而且Apache commons logging也已经在使用这种思想了，但现在SLF4J正迅速成为Java世界的日志标准。

总结

总结这次说的，我建议使用SLF4J的而不是直接使用 Log4j, commons logging, logback 或者 java.util.logging 已经足够充分了。

在你的开源或内部类库中使用SLF4J会使得它独立于任何一个特定的日志实现，这意味着不需要管理多个日志配置或者多个日志类库，你的客户端会很感激这点。
SLF4J提供了基于占位符的日志方法，这通过去除检查isDebugEnabled(), isInfoEnabled()等等，提高了代码可读性。
通过使用SLF4J的日志方法，你可以延迟构建日志信息（Srting）的开销，直到你真正需要，这对于内存和CPU都是高效的。
作为附注，更少的暂时的字符串意味着垃圾回收器（Garbage Collector）需要做更好的工作，这意味着你的应用程序有为更好的吞吐量和性能。
这些好处只是冰山一角，你将在开始使用SL4J和阅读其中代码的时候知道更多的好处。我强烈建议，任何一个新的Java程序员，都应该使用SLF4J做日志而不是使用包括Log4J在内的其他日志API。

感谢--尚硅谷