日志,在系统运行中出现异常,甚至错误后可以为我们提供第一手的资料,帮助我们去解决问题。
常用的日志框架,包括slf4j、jcL、log4j、log4j2、logback等。Log4和logback的使用比较方便。
本内容以springboot的环境为基础,不同的日志框架,默认扫描的配置文件:
** 日志的级别:TRACE,DEBUG,INFO,WARN,ERROR,FATAL或OFF**
-
在日志的使用过程中,一般生产环境只打印info级别以上的日志,对于debug级别的日志,都在测试环境,上线后,建议删除。 日志的打印最好可以带上可以定位问题的信息描述,比如用户id。
**** 在项目中日志又分为业务日志和异常日志。业务日志建议使用warn,异常日志使用error。
对于日志的一些自定义配置:
日志中不同日志颜色的配置
<pattern>%black(控制台的日志-)%red(%d{yyyy-MM-ddHH:mm:ss})%green([%thread])%highlight(%-5level)%boldMagenta(%logger)-%cyan(%msg%n)</pattern>
§ 定义日志的颜色,比如%red(),括号内放入想要显示红色的模块
§ 每个模块之间用空格分开
§ 可以定义一个pattern变量
□ <property name = "hello" value =""/>
§ 使用变量
□ <appender name="console" class ="ch.qos.logback.core.ConsoleAppender">
® <layout class ="ch.qos.logback.classic.PatternLayout">
◊ <pattern>${hello}</pattern>
® </layout>
□ </appender>
日志的使用要求
1) 对系统的影响尽量小
2) 没有安全问题
3) 在特殊情况下,可以了解程序的内部运行状态
4) 用于开发者可以准确的定位问题
日志使用的建议:
□ try..catch中的异常信息,不要用e.pristackTrace()或者e.getMessage。
logger.error("execption:{}" ,e);
□ 不要再记录日志后,又抛出异常;也不要再不同地方多次记录同一个日志 。
□ 不要使用sysout等类似的打印信息
□ 在流程中比较重要的方法,可以在入口和结尾打印相应的参数和执行结果。
□ 日志的打印信息,一定要保证不出错,比如user.getId。如果user为空,次日志打印就会出错。
□ 尽量使用slf4j
□ 保证日志的可读性,开发者通过读取日志可以定位信息
□ 使用
LOGGER.debug("returning contents: {}", contents);
替代 LOGGER.debug("returning contents: "+ contents);
//自己定义的logger-spring.xml
<!--文件的存储路径,不要使用相对路径-->
<property name="${LOG_FILE}" value="${LOG_PATH}"></property>
<!-- trace debug info warn error -->
<!-- 控制台输出 -->
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>DEBUG</level>
</filter>
<layout class="ch.qos.logback.classic.PatternLayout">
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
<pattern>%black(控制台-) %red(%d{yyyy-MM-dd HH:mm:ss}) %green([%thread])
%highlight(%-5level) %boldMagenta(%logger) - %cyan(%msg%n)</pattern>
</layout>
</appender>
<!-- 按照每天生成日志文件 -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_PATH}/${LOG_FILE}</file>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>info</level>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<!--日志文件输出的文件名-->
<FileNamePattern>${LOG_PATH}/snow_log.%d{yyyy-MM-dd}.log.%i.gz</FileNamePattern>
<!--日志文件最大的大小-->
<MaxFileSize>100MB</MaxFileSize>
<MaxHistory>30</MaxHistory>
<totalSizeCap>10GB</totalSizeCap>
</rollingPolicy>
<layout class="ch.qos.logback.classic.PatternLayout">
<!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %caller{1} %-5level %logger{50} - %msg%n
</pattern>
</layout>
</appender>
<!--打印的内容-->
<logger name="com.summer.isnow.aspect.AspectDto" level="DEBUG" addictivity="false">
<appender-ref ref="console" />
</logger>
<logger name="com.summer" level="DEBUG" addictivity="true">
<appender-ref ref="FILE" />
</logger>
<logger name="org.springframework.jdbc" level="debug">
<appender-ref ref="console"/>
</logger>
<logger name="org.springframework.web" level="debug">
<appender-ref ref="console"/>
</logger>
<logger name="com.vsi.springboot" level="debug">
<appender-ref ref="console"/>
</logger>
<root level="info">
<appender-ref ref="console" />
<appender-ref ref="FILE" />
</root>
application.xml的配置
logging.config=classpath:logback-spring.xml
logging.path=D:/log
logging.file=isnow.log