预览

• • 1. log4j
  • • 1.1 基本用法
    • 1.2 配置 logj.properties
    • • 1.2.1 logger
      • 1.2.2 appender
      • 1.2.3 layout
    • 1.3 log4j完整配置示例
  • 2. 门面模式
  • 3. slf4j与log4j联合使用
  • 4. 开发技巧
  • • 4.1 选择恰当的日志级别
    • 4.2 日志级别较低时，进行日志开关判断
    • 4.3 使用参数占位`{}`，而不是用`+`拼接
    • 4.4 不要使用e.printStackTrace()
    • 4.5 禁止在线上环境开启 debug
    • 4.6 日志文件分离

1. log4j

1.1 基本用法

• 引入jar包

<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

• 创建配置文件 resources/log4j.properties

log4j.rootLogger=INFO,console
log4j.additivity.org.apache=true
#console
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Threshold=INFO
log4j.appender.console.ImmediateFlush=true
log4j.appender.console.Target=System.out
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n

• 创建测试类

import org.apache.log4j.Logger;
class Test {
    static final Logger log = Logger.getLogger(Test.class);
    public static void main(String[] args) {
        log.info("hello this is log4j info log");
    }
}

1.2 配置 logj.properties

我们要输出日志，首先得有日志对象（logger），那这些日志对象把日志输出到哪里呢，控制台（stdout)）还是文件（file），这就要设置输出位置（appender），输出的格式与内容又是什么样的呢，这就要设置输出样式（layout），这些设置完，log4j的配置也就完了。

log4j日志等级的概念，日志等级就是日志的重要程度，log4j日志分为7个等级：ALL、DEBUG、INFO、WARN、ERROR、FATAL、OFF，从左到右等级由低到高，分等级是为了设置日志输出的门槛，只有等级等于或高于这个门槛的日志才有机会输出

1.2.1 logger

日志实例，就是代码里实例化的Logger对象，格式：

log4j.rootLogger=LEVEL,appenderName1,appenderName2,...
log4j.additivity.org.apache=false：表示不会在父logger的appender里输出，默认true

这是全局logger的配置，LEVEL用来设定日志等级，appenderName定义日志输出器，示例中的console就是一个日志输出器

下面给出一个更清晰的例子，配置 com.demo.test包下所有类中实例化的Logger对象

log4j.logger.com.demo.test=DEBUG,test
log4j.additivity.com.demo.test=false

1.2.2 appender

日志输出器，指定logger的输出位置，格式：

log4j.appender.appenderName = className

appender有5种选择

org.apache.log4j.ConsoleAppender（控制台）
org.apache.log4j.FileAppender（文件）
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

每种appender都有若干配置项：

• ConsoleAppender（常用）控制台

  #指定日志信息的最低输出级别，默认DEBUG
  Threshold=WARN 
   #表示所有消息都会被立即输出，设为false则不输出，默认值是true
  ImmediateFlush=true
  #默认值是System.out
  Target=System.err 
  

• FileAppender 文件

  # 指定日志信息的最低输出级别，默认DEBUG
  Threshold=WARN
  #表示所有消息都会被立即输出，设为false则不输出，默认true
  ImmediateFlush=true 
  # true表示消息增加到指定文件中，false则将消息覆盖指定的文件内容，默认true
  Append=false 
  # 指定消息输出到logging.log4j文件
  File=D:/logs/logging.log4j 
  

• DailyRollingFileAppender（常用）每天产生一个日志文件

  # 指定日志信息的最低输出级别，默认DEBUG
  Threshold=WARN 
  #表示所有消息都会被立即输出，设为false则不输出，默认true
  ImmediateFlush=true 
  #true表示消息增加到指定文件中，false则将消息覆盖指定的文件内容，默认true
  Append=false
  # 指定当前消息输出到logging.log4j文件
  File=D:/logs/logging.log4j 
  # 每月滚动一次日志文件，即每月产生一个新的日志文件。
  # 当前月的日志文件名为logging.log4j，前一个月的日志文件名为logging.log4j.yyyy-MM
  DatePattern='.'yyyy-MM 
  
  #另外，也可以指定按周、天、时、分等来滚动日志文件，对应的格式如下：
  # 1)'.'yyyy-MM：每月
  # 2)'.'yyyy-ww：每周
  # 3)'.'yyyy-MM-dd：每天
  # 4)'.'yyyy-MM-dd-a：每天两次
  # 5)'.'yyyy-MM-dd-HH：每小时
  # 6)'.'yyyy-MM-dd-HH-mm：每分钟
  

• RollingFileAppender 文件大小到达指定尺寸的时候产生一个新的文件

  # 指定日志信息的最低输出级别，默认DEBUG
  Threshold=WARN 
  # 表示所有消息都会被立即输出，设为false则不输出，默认true
  ImmediateFlush=true 
  # true表示消息增加到指定文件中，false则将消息覆盖指定的文件内容，默认true
  Append=false 
  # 指定消息输出到logging.log4j文件
  File=D:/logs/logging.log4j 
  # 后缀可以是KB,MB或者GB。
  # 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到logging.log4j.1文件
  MaxFileSize=100KB 
  # 指定可以产生的滚动文件的最大数
  # 例如，设为2则可以产生logging.log4j.1，logging.log4j.2两个滚动文件和一个logging.log4j文件
  MaxBackupIndex=2 
  

1.2.3 layout

指定logger输出内容，格式：

log4j.appender.appenderName.layout = className

layout有4种选择

org.apache.log4j.HTMLLayout（以HTML表格形式布局）
org.apache.log4j.PatternLayout（可以灵活地指定布局模式）
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等信息）

layout也有配置项：

• HTMLLayout

#输出java文件名称和行号，默认false
LocationInfo = true 
# 默认值是Log4J Log Messages
Title = My Logging 

• PatternLayout（最常用的配置）

# 设定以怎样的格式显示消息
ConversionPattern = %m%n 

设置格式的参数说明如下

%p：输出日志信息的优先级，即DEBUG，INFO，WARN，ERROR，FATAL
%d：输出日志时间点的日期或时间，默认格式为ISO8601，可以指定格式如：%d{yyyy/MM/dd HH:mm:ss,SSS}
%r：输出自应用程序启动到输出该log信息耗费的毫秒数
%t：输出产生该日志事件的线程名
%l：输出日志事件的发生位置，相当于%c.%M(%F:%L)的组合，包括类全名、方法、文件名以及在代码中的行数
%c：输出日志信息所属的类目，通常就是类全名
%M：输出产生日志信息的方法名
%F：输出日志消息产生时所在的文件名
%L：输出代码中的行号
%m：输出代码中指定的具体日志信息
%n：输出一个回车换行符，Windows平台为"rn"，Unix平台为"n"
%x：输出和当前线程相关联的NDC(嵌套诊断环境)
%%：输出一个"%"字符

1.3 log4j完整配置示例

示例配置一些常用的日志输出

log4j.rootLogger=DEBUG,console,logFile,rollingFile,dailyFile
log4j.additivity.org.apache=true

• 控制台console日志输出器

  # 控制台(console)
  log4j.appender.console=org.apache.log4j.ConsoleAppender
  log4j.appender.console.Threshold=DEBUG
  log4j.appender.console.ImmediateFlush=true
  log4j.appender.console.Target=System.err
  log4j.appender.console.layout=org.apache.log4j.PatternLayout
  log4j.appender.console.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n
  

• 文件logFile日志输出器

  # 日志文件(logFile)
  log4j.appender.logFile=org.apache.log4j.FileAppender
  log4j.appender.logFile.Threshold=DEBUG
  log4j.appender.logFile.ImmediateFlush=true
  log4j.appender.logFile.Append=true
  log4j.appender.logFile.File=D:/logs/log.log4j
  log4j.appender.logFile.layout=org.apache.log4j.PatternLayout
  log4j.appender.logFile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n
  

• 滚动文件rollingFile日志输出器

  # 滚动文件(rollingFile)
  log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender
  log4j.appender.rollingFile.Threshold=DEBUG
  log4j.appender.rollingFile.ImmediateFlush=true
  log4j.appender.rollingFile.Append=true
  log4j.appender.rollingFile.File=D:/logs/log.log4j
  log4j.appender.rollingFile.MaxFileSize=200KB
  log4j.appender.rollingFile.MaxBackupIndex=50
  log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
  log4j.appender.rollingFile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n
  

• 定期滚动文件dailyFile日志输出器

  log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender
  log4j.appender.dailyFile.Threshold=DEBUG
  log4j.appender.dailyFile.ImmediateFlush=true
  log4j.appender.dailyFile.Append=true
  log4j.appender.dailyFile.File=D:/logs/log.log4j
  log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd
  log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout
  log4j.appender.dailyFile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n
  

2. 门面模式

《阿里巴巴Java开发手册》，其中有一条规范做了『强制』要求：

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

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

private static final Logger logger= LoggerFactory.getLogger( Abc.class);

日志门面，是门面模式的一个典型的应用。

门面模式（Facade Pattern），也称之为外观模式，其核心为：外部与一个子系统的通信必须通过一个统一的外观对象进行，使得子系统更易于使用。

在软件开发领域有这样一句话：计算机科学领域的任何问题都可以通过增加一个间接的中间层来解决。而门面模式就是对于这句话的典型实践。

3. slf4j与log4j联合使用

slf4j是什么？

​ slf4j只是定义了一组日志接口，但并未提供任何实现。

既然这样，为什么要用slf4j呢？log4j不是已经满足要求了吗？

是的，log4j满足了要求，但是，日志框架并不只有log4j一个，你喜欢用log4j，有的人可能更喜欢logback，有的人甚至用jdk自带的日志框架，这种情况下，如果你要依赖别人的jar，整个系统就用了两个日志框架，如果你依赖10个jar，每个jar用的日志框架都不同，岂不是一个工程用了10个日志框架，那就乱了！

如果你的代码使用slf4j的接口，具体日志实现框架你喜欢用log4j，其他人的代码也用slf4j的接口，具体实现未知，那你依赖其他人jar包时，整个工程就只会用到log4j日志框架，这是一种典型的门面模式应用，与jvm思想相同，我们面向slf4j写日志代码，slf4j处理具体日志实现框架之间的差异，正如我们面向jvm写java代码，jvm处理操作系统之间的差异，结果就是，一处编写，到处运行。况且，现在越来越多的开源工具都在用slf4j了。

• 导入slf4j jar包

  <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.21</version>
  </dependency>
  

• 导入 slf4j与log4j的关联jar包

  通过这个jar包，将对slf4j接口的调用转换为对log4j的调用，不同的日志实现框架，转换工具不同

  <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
      <version>1.7.21</version>
  </dependency>
  

• 使用

  原来是：

  import org.apache.log4j.Logger;
  class Test {
      static final Logger log = Logger.getLogger(Test.class);
      public static void main(String[] args) {
          log.info("hello this is log4j info log");
      }
  }
  

  现在是：

  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  class Test {
      Logger log = LoggerFactory.getLogger(Test.class);
      public static void main(String[] args) {
          log.info("hello, my name is {}", "chengyi");
      }
  }
  

  依赖的Logger变了，而且，slf4j的api还能使用占位符，很方便

4. 开发技巧

4.1 选择恰当的日志级别

常见的日志级别有5种，分别是error、warn、info、debug、trace。日常开发中，我们需要选择恰当的日志级别，不要反手就是打印info。

• error：错误日志，指比较严重的错误，对正常业务有影响，需要运维配置监控的；
• warn：警告日志，一般的错误，对业务影响不大，但是需要开发关注；
• info：信息日志，记录排查问题的关键信息，如调用时间、出参入参等等；
• debug：用于开发DEBUG的，关键逻辑里面的运行时数据；
• trace：最详细的信息，一般这些信息只记录到日志文件中。

4.2 日志级别较低时，进行日志开关判断

对于trace、debug这些比较低的日志级别，必须进行日志级别的开关判断。

正例：

User user = new User(1, "Jack", 18);
if (log.isDebugEnabled()) {
    logger.debug("userId is: {}", user.getId());
}

因为当前有如下的日志代码：

logger.debug("Processing trade with id: " + id + " and user: " + user);

如果配置的日志级别是warn的话，上述日志不会打印，但是会执行字符串拼接操作，如果user是对象， 还会执行toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印，因此建议加日志开关判断。

4.3 使用参数占位{}，而不是用+拼接

slf4j支持占位符{}，使用+操作符进行字符串的拼接，有一定的性能损耗，而使用占位符{}仅是替换动作

logger.debug("user id = {}, name = {}", user.getId(), user.getName());

4.4 不要使用e.printStackTrace()

通常e.getMessage()并不能获取全部的错误信息,需要用到e.printStackTrace()查看完整错误信息

但是：

• e.printStackTrace()打印出的堆栈日志跟业务代码日志是交错混合在一起的，通常排查异常日志不太方便。
• e.printStackTrace()语句产生的字符串记录的是堆栈信息，如果信息太长太多，字符串常量池所在的内存块没有空间了，即内存满了，那么，用户的请求就卡住了
• e.printStackTrace()方法返回值是void ，只能在控制台输出，建议单独输出到error.log文件中

正例：

try {
    // to do
} catch (Exception e) {
    logger.error("出现异常啦", e);
} 

4.5 禁止在线上环境开启 debug

因为一般系统的debug日志会很多，并且各种框架中也大量使用 debug的日志，线上开启debug不久可能会打满磁盘，影响业务系统的正常运行。

4.6 日志文件分离

• 把不同类型的日志分离出去，比如正常的业务log，或者error级别error.log，都可以单独打印到一个文件里面
• 也可以根据不同的业务模块，打印到不同的日志文件里，这样我们排查问题和做数据统计的时候，都会比较方便