• SLF4+Logback 使用及配置


    在SpringBoot项目中使用slf4+logback

    ①在pom.xml中添加依赖

    <dependency>
    	<groupId>ch.qos.logback</groupId>
    	<artifactId>logback-classic</artifactId>
    </dependency>
    <dependency>
    	<groupId>org.slf4j</groupId>
    	<artifactId>jcl-over-slf4j</artifactId>
    </dependency>
    

    ②在resources目录下新建配置文件logback.xml

    <?xml version="1.0" encoding="UTF-8"?>
    <configuration debug="false">
    <contextName>study</contextName>
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_HOME" value="d:/idea/logs" />
    <property name="appName" value="onlineStudy" />
    
    <!--控制台日志, 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度,%msg:日志消息,%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>
    <!--RollingFileAppender:滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件-->
    <!--文件日志, 按照每天生成日志文件 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true -->
        <append>true</append>
        <!--当发生滚动时,决定RollingFileAppender的行为,涉及文件移动和重命名-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <!--logType:日志类型,如 stats/monitor/access-->
            <FileNamePattern>${LOG_HOME}/${appName}_monitor_debug_%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出:%d表示日期,%thread表示线程名,%-5level:级别从左显示5个字符宽度%msg:日志消息,%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
        <!--日志文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>
    
    <!-- 按日志级别打印  INFO -->
    <appender name="infoAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。-->
        <file>${LOG_HOME}/info/info.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 文件名称 -->
            <fileNamePattern>${LOG_HOME}/info/info.%d{yyyy-MM-dd}.log.gz</fileNamePattern>
            <!-- 文件最大保存历史数量 -->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>
    
    
    <!-- show parameters for hibernate sql 专为 Hibernate 定制 -->
    <logger name="org.hibernate.type.descriptor.sql.BasicBinder" level="TRACE" />
    <logger name="org.hibernate.type.descriptor.sql.BasicExtractor" level="DEBUG" />
    <logger name="org.hibernate.SQL" level="DEBUG" />
    <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />
    <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" />
    
    <!--myibatis log configure-->
    <logger name="com.apache.ibatis" level="TRACE"/>
    <logger name="java.sql.Connection" level="DEBUG"/>
    <logger name="java.sql.Statement" level="DEBUG"/>
    <logger name="java.sql.PreparedStatement" level="DEBUG"/>
    
    <!-- 日志输出级别 -->
    <root level="DEBUG">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE"/>
        <appender-ref ref="infoAppender"/>
    </root>
    </configuration>
    

    这里给出三种日志输出方式:控制台,日期分类的文件,日志级别分类的文件


    ③ 使用

    public class DemoApplication {
    	private final static Logger logger = LoggerFactory.getLogger(DemoApplication.class);
    	public static void main(String[] args) {
    		SpringApplication.run(DemoApplication.class, args);
    	}
    	
    	@Bean(destroyMethod = "close", initMethod = "init")
    	@ConfigurationProperties(prefix = "spring.datasource")
    	public DruidDataSource druidDataSource() {
    		DruidDataSource druidDataSource = new DruidDataSource();
    		logger.debug("数据库连接池");
    		return  druidDataSource;
    	}
    
    }
    

    控制台:

    文件:

    ④日志规约--《阿里巴巴java手册》

    1. 【强制】应用中不可直接使用日志系统(Log4j、Logback)中的 API,而应依赖使用日志框架
      SLF4J 中的 API,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。

       import org.slf4j.Logger; 
       import org.slf4j.LoggerFactory;
       private static final Logger logger = LoggerFactory.getLogger(Abc.class); 
      
    2. 【强制】日志文件至少保存 15 天,因为有些异常具备以“周”为频次发生的特点。

    3. 【强制】应用中的扩展日志(如打点、临时监控、访问日志等)命名方式:
      appName_logType_logName.log。

    logType:日志类型,如 stats/monitor/access 等;logName:日志描述。这种命名的好处:
    通过文件名就可知道日志文件属于什么应用,什么类型,什么目的,也有利于归类查找。

    正例:mppserver 应用中单独监控时区转换异常,如: 
    mppserver_monitor_timeZoneConvert.log
    说明:推荐对日志进行分类,如将错误日志和业务日志分开存放,便于开发人员查看,也便于
    通过日志对系统进行及时监控。
    
    1. 【强制】对 trace/debug/info 级别的日志输出,必须使用条件输出形式或者使用占位符的方
      式。
      说明:logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);
      如果日志级别是 warn,上述日志不会打印,但是会执行字符串拼接操作,如果 symbol 是对象,
      会执行 toString()方法,浪费了系统资源,执行了上述操作,最终日志却没有打印。

       正例:(条件)建设采用如下方式
       if (logger.isDebugEnabled()) { 
       logger.debug("Processing trade with id: " + id + " and symbol: " + symbol); 
       } 
       正例:(占位符)
       logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol); 
      
    2. 【强制】避免重复打印日志,浪费磁盘空间,务必在 log4j.xml 中设置 additivity=false。

       正例:<logger name="com.taobao.dubbo.config" additivity="false"> 
      
    3. 【强制】异常信息应该包括两类信息:案发现场信息和异常堆栈信息。如果不处理,那么通过
      关键字 throws 往上抛出。

       正例:logger.error(各类参数或者对象 toString() + "_" + e.getMessage(), e);
      
    4. 【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志;有选择地输出 info 日志;如果使
      用 warn 来记录刚上线时的业务行为信息,一定要注意日志输出量的问题,避免把服务器磁盘
      撑爆,并记得及时删除这些观察日志。

    说明:大量地输出无效日志,不利于系统性能提升,也不利于快速定位错误点。记录日志时请
    思考:这些日志真的有人看吗?看到这条日志你能做什么?能不能给问题排查带来好处?

    1. 【推荐】可以使用 warn 日志级别来记录用户输入参数错误的情况,避免用户投诉时,无所适
      从。如非必要,请不要在此场景打出 error 级别,避免频繁报警。

    说明:注意日志输出的级别,error 级别只记录系统逻辑出错、异常或者重要的错误信息。

    1. 【推荐】尽量用英文来描述日志错误信息,如果日志中的错误信息用英文描述不清楚的话使用
      中文描述即可,否则容易产生歧义。国际化团队或海外部署的服务器由于字符集问题,【强制】
      使用全英文来注释和描述日志错误信息。
  • 相关阅读:
    一起谈.NET技术,用PagePaser创建Page作为HttpHandler 狼人:
    一起谈.NET技术,Visual Studio 2010构建Web浏览器应用程序 狼人:
    一起谈.NET技术,C#中的lock关键字 狼人:
    一起谈.NET技术,OnLoad与Page_Load的差异分析 狼人:
    一起谈.NET技术,使用LINQ Expression构建Query Object 狼人:
    一起谈.NET技术,Visual Studio 2008单元测试_数据库测试 狼人:
    一起谈.NET技术,ASP.NET绑定的技巧 狼人:
    动态加载js和css
    错误:该行已经属于另一个表
    c#中转义符总结
  • 原文地址:https://www.cnblogs.com/lifan1998/p/10347341.html
Copyright © 2020-2023  润新知