一、Logback介绍:
同样是由log4j的作者设计完成的,拥有更好的特性,用来取代log4j的一个日志框架。是slf4j的原生实现,也就是说logback实现slf4j是不消耗内存和计算开销的。
Logback替代log4J的十大理由:自行百度吧,总而言之,就是logback好用就对了
本篇文章因为在线上jar包直接打印nohup.out文件过大,同事推荐加入Logback,其中包括加入分层打包方案,具体看下面:
二、Logback 配置
pom.xml【定义日志插件和打包定义】
assembly.xml【分层打包,这个目录在pom里面】
logback-spring.xml【日志打印配置】
pom.xml :
<build>
<!--<resources>-->
<!--<resource>-->
<!--<!–deploy.type 指定部署类型:dev、pre_pro、pro–>-->
<!--<directory>src/main/resources/application.${deploy.type}</directory>-->
<!--</resource>-->
<!--</resources>-->
<!--<finalName>usmart-iot-${version}-${deploy.type}</finalName>-->
<resources>
<resource>
<directory>src/main/resources</directory>
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<configuration>
<!-- 将静态资源排除出jar包 -->
<archive>
<manifest>
<addClasspath>true</addClasspath>
<!-- MANIFEST.MF 中 Class-Path 加入前缀 -->
<classpathPrefix>lib/</classpathPrefix>
<!-- jar包不包含唯一版本标识 -->
<useUniqueVersions>false</useUniqueVersions>
<!-- 指定启动类的包路径 -->
<mainClass>com.usmart.IotDataCollectionApplication</mainClass>
</manifest>
<manifestEntries>
<!--MANIFEST.MF 中 Class-Path 加入资源文件目录 -->
<Class-Path>config/</Class-Path>
</manifestEntries>
</archive>
<!-- 指定打出的jar包路径 -->
<outputDirectory>${project.build.directory}</outputDirectory>
</configuration>
</plugin>
<!-- 这个插件是用来复制项目依赖的jar包 -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<executions>
<execution>
<!-- 自定义 -->
<id>copy-dependencies</id>
<phase>package</phase>
<goals>
<!-- 复制依赖的jar包 -->
<goal>copy-dependencies</goal>
</goals>
<configuration>
<!-- 将依赖的jar包复制到该路径下 -->
<outputDirectory>${project.build.directory}/lib</outputDirectory>
</configuration>
</execution>
</executions>
</plugin>
<!-- 这个插件是用来复制项目的静态资源-->
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<executions>
<execution>
<!-- 自定义 -->
<id>copy-resources</id>
<phase>package</phase>
<goals>
<!-- 复制静态资源 -->
<goal>copy-resources</goal>
</goals>
<configuration>
<resources>
<resource>
<!-- 指定静态资源的路径 -->
<directory>src/main/resources</directory>
<!-- 指定需要复制的文件 -->
<includes>
<include>application.properties</include>
<include>application.yml</include>
</includes>
</resource>
</resources>
<!-- 指定复制到该目录下 -->
<outputDirectory>${project.build.directory}/config</outputDirectory>
</configuration>
</execution>
</executions>
</plugin>
<!-- 以上配置后你的文件打包后的文件目录如下
-lib
-config
-项目名.jar
-->
<!-- 这个插件使用来将分离出来的静态资源和依赖的jar包(就是上面说到的文件目录),
压缩成一个zip文件。个人感觉这个蛮方便的 -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<!-- 这个插件需要指定一个配置文件 【重点:这里的assembly.xml 就是讲到分层打包】 -->
<descriptors>
<descriptor>src/main/assembly/assembly.xml</descriptor>
</descriptors>
</configuration>
<executions>
<execution>
<!-- 自定义 -->
<id>make-assembly</id>
<phase>package</phase>
<goals>
<!-- 只执行一次 -->
<goal>single</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
分层配置地址: src/main/assembly/assembly.xml
assembly.xml:
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0
http://maven.apache.org/xsd/assembly-1.1.0.xsd">
<id>kean</id>
<formats>
<!-- 可以根据自己的需求定义压缩文件的格式 -->
<format>zip</format>
</formats>
<!-- 不包含根目录,如果为true,生成的压缩文件会有一个根目录 -->
<includeBaseDirectory>false</includeBaseDirectory>
<!-- 指定需要压缩的文件清单 -->
<fileSets>
<fileSet>
<!-- 指定你需要压缩的文件目录 -->
<directory>${project.build.directory}/lib/</directory>
<!-- 指定压缩后的文件目录 -->
<outputDirectory>lib</outputDirectory>
</fileSet>
<fileSet>
<directory>${project.build.directory}/</directory>
<includes>
<include>*.jar</include>
</includes>
<outputDirectory>./</outputDirectory>
</fileSet>
<fileSet>
<directory>${project.build.directory}/config/</directory>
<outputDirectory>config</outputDirectory>
</fileSet>
</fileSets>
</assembly>
配置完后,打包就是三层目录
config:就是yml配置文件,可以根据需要来更改,优先使用config里面的配置文件
lib:引入的jar包
logback-spring.xml:
<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL,如果设置为WARN,则低于WARN的信息都不会输出 -->
<!-- scan:当此属性设置为true时,配置文档如果发生改变,将会被重新加载,默认值为true -->
<!-- scanPeriod:设置监测配置文档是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。
当scan为true时,此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 -->
<!--
总体说明:根节点下有2个属性,三个节点
属性: contextName 上下文名称; property 设置变量
节点: appender, root, logger
-->
<configuration scan="false" scanPeriod="10 seconds">
<!--
contextName说明:
每个logger都关联到可以使用设logger上下文,默认上下文名称为“default”。但置成其他名字,
用于区分不同应用程序的记录。一旦设置,不能修改,可以通过%contextName来打印日志上下文名称。
-->
<contextName>logback</contextName>
<!-- name的值是变量的名称,value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义后,可以使“${}”来使用变量。 -->
<property name="LOG_FILE" value="/opt/product/kean-connection/log"/>
<!--0. 日志格式和颜色渲染 -->
<!-- 彩色日志依赖的渲染类 -->
<conversionRule conversionWord="clr"
converterClass="org.springframework.boot.logging.logback.ColorConverter"/>
<conversionRule conversionWord="wex"
converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/>
<conversionRule conversionWord="wEx"
converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/>
<!-- 彩色日志格式 -->
<property name="CONSOLE_LOG_PATTERN"
value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
<!--1.输出到控制台-->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<!--此日志appender是为开发使用,只配置最底级别,控制台输出的日志级别是大于或等于此级别的日志信息-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>debug</level>
</filter>
<!--日志文档输出格式-->
<encoder>
<!--指定日志格式-->
<pattern>%black(控制台-) %red(%d{yyyy-MM-dd HH:mm:ss}) %green([%thread]) %highlight(%-5level) %boldmagenta(%logger) - %cyan(%msg%n)</pattern>
<!--设置字符集-->
<charset>UTF-8</charset>
</encoder>
</appender>
<!-- 2.2 level为 INFO 日志,时间滚动输出 -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 正在记录的日志文档的路径及文档名 -->
<file>${LOG_FILE}/kean-connectionFILE.log</file>
<!--日志文档输出格式-->
<encoder>
<pattern>%black(控制台-) %red(%d{yyyy-MM-dd HH:mm:ss}) %green([%thread]) %highlight(%-5level) %boldmagenta(%logger) - %cyan(%msg%n)</pattern>
<charset>UTF-8</charset>
</encoder>
<!-- 日志记录器的滚动策略,按日期,按大小记录 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 每天日志归档路径以及格式 -->
<fileNamePattern>${LOG_FILE}/kean-connection-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy
class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<maxFileSize>30MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--日志文档保留天数-->
<maxHistory>30</maxHistory>
</rollingPolicy>
</appender>
<!--
<logger>用来设置某一个包或者具体的某一个类的日志打印级别、
以及指定<appender>。<logger>仅有一个name属性,
一个可选的level和一个可选的addtivity属性。
name:用来指定受此logger约束的某一个包或者具体的某一个类。
level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。
如果未设置此属性,那么当前logger将会继承上级的级别。
addtivity:是否向上级logger传递打印信息。默认是true。
<logger name="org.springframework.web" level="info"/>
<logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>
-->
<!--
使用mybatis的时候,sql语句是debug下才会打印,而这里我们只配置了info,所以想要查看sql语句的话,有以下两种操作:
第一种把<root level="info">改成<root level="DEBUG">这样就会打印sql,不过这样日志那边会出现很多其他消息
第二种就是单独给dao下目录配置debug模式,代码如下,这样配置sql语句会打印,其他还是正常info级别:
【logging.level.org.mybatis=debug logging.level.dao=debug】
-->
<!--
root节点是必选节点,用来指定最基础的日志输出级别,只有一个level属性
level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,
不能设置为INHERITED或者同义词NULL。默认是DEBUG
可以包含零个或多个元素,标识这个appender将会添加到这个logger。
-->
<!-- 4. 最终的策略 -->
<!-- 4.1 开发环境:打印控制台-->
<!-- <springProfile name="dev">
<logger name="com.cic.analysis.business.dao" level="debug"/><!– 修改此处扫描包名 –>
</springProfile>-->
<!--
root指定最基础的日志输出级别,level属性指定
appender-ref标识的appender将会添加到这个logger
-->
<root level="info">
<appender-ref ref="CONSOLE"/>
<appender-ref ref="FILE"/>
</root>
<!-- 4.2 生产环境:输出到文档
<springProfile name="pro">
<root level="info">
<appender-ref ref="CONSOLE" />
<appender-ref ref="DEBUG_FILE" />
<appender-ref ref="INFO_FILE" />
<appender-ref ref="ERROR_FILE" />
<appender-ref ref="WARN_FILE" />
</root>
</springProfile> -->
</configuration>
配置日志路径(20行):/opt/product/kean-connection/log
配置具体日志文件(54行):${LOG_FILE}/kean-connectionFILE.log
配置每天日志归档(63行):${LOG_FILE}/kean-connection-%d{yyyy-MM-dd}.%i.log
配置日志大小(66):30MB