Singerw's Repository
Singerw
2021-09-25

实现日志功能

# 实现日志功能⚡️

# 1、日志工厂

Mybatis内置的日志工厂提供日志功能，具体的日志实现有以下几种工具：

  • SLF4J
  • Apache Commons Logging
  • Log4j 2
  • Log4j
  • JDK logging

【示例】mybatis-config.xml中配置setting

<settings>
<setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>
1
2
3

# 2、 Log4j的基本使用

​ Log4j是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件，甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

# 步骤一：导入Jar文件

<!--log4j-->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.16</version>
</dependency>
1
2
3
4
5
6

# 步骤二：配置log4j配置文件

新建log4j.properties，进行配置

log4j.rootLogger=DEBUG, console, file
#控制台输出的相关设置
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Target=System.out
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%p][%c{1}] - %m%n
log4j.appender.console.Encoding=UTF-8

#文件输出的相关设置
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.File=./logs/log.log
log4j.appender.file.MaxFileSize=500KB
log4j.appender.file.MaxBackupIndex=1
log4j.appender.file.Threshold=DEBUG
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%p]-%c{1} - %m%n
log4j.appender.file.encoding=UTF-8

#日志输出级别
log4j.logger.org.mybatis=DEBUG
log4j.logger.java.sql=DEBUG
log4j.logger.java.sql.Connection=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.ResultSet=DEBUG
log4j.logger.java.sql.PreparedStatement=DEBUG
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

  1. log4j.rootCategory=INFO, stdout , R

    此句为将等级为INFO的日志信息输出到stdout和R这两个目的地，stdout和R的定义在下面的代码，可以任意起名。等级可分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL，如果配置OFF则不打出任何信息，如果配置为INFO这样只显示INFO、WARN、ERROR的log信息，而DEBUG信息不会被显示，具体讲解可参照第三部分定义配置文件中的logger。

  2. log4j.appender.stdout=org.apache.log4j.ConsoleAppender

    此句为定义名为stdout的输出端是哪种类型，可以是

    org.apache.log4j.ConsoleAppender（控制台），

    org.apache.log4j.FileAppender（文件），

    org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），

    org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）

    org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

    具体讲解可参照第三部分定义配置文件中的Appender。

  3. log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

    此句为定义名为stdout的输出端的layout是哪种类型，可以是

    org.apache.log4j.HTMLLayout（以HTML表格形式布局），

    org.apache.log4j.PatternLayout（可以灵活地指定布局模式），

    org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），

    org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

    具体讲解可参照第三部分定义配置文件中的Layout。

  4. log4j.appender.stdout.layout.ConversionPattern= [QC] %p [%t] %C.%M(%L) | %m%n

    如果使用pattern布局就要指定的打印信息的具体格式ConversionPattern，打印参数如下：

    %m 输出代码中指定的消息；

    %M 输出打印该条日志的方法名；

    %p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL；

    %r 输出自应用启动到输出该log信息耗费的毫秒数；

    %c 输出所属的类目，通常就是所在类的全名；

    %t 输出产生该日志事件的线程名；

    %n 输出一个回车换行符，Windows平台为"rn”，Unix平台为"n”；

    %d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyyy-MM-dd HH:mm:ss,SSS}，输出类似：2002-10-18 22:10:28,921；

    %l输出日志事件的发生位置，及在代码中的行数；

    [QC]是log信息的开头，可以为任意字符，一般为项目简称。

    输出的信息

    [TS] DEBUG [main] AbstractBeanFactory.getBean(189) | Returning cached instance of singleton bean 'MyAutoProxy'

    具体讲解可参照第三部分定义配置文件中的格式化日志信息。

  5. log4j.appender.R=org.apache.log4j.DailyRollingFileAppender

    此句与第3行一样。定义名为R的输出端的类型为每天产生一个日志文件。

  6. log4j.appender.R.File=D:\Tomcat 5.5\logs\qc.log

    此句为定义名为R的输出端的文件名为D:\Tomcat 5.5\logs\qc.log可以自行修改。

  7. log4j.appender.R.layout=org.apache.log4j.PatternLayout

    与第4行相同。

  8. log4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n

    与第5行相同。

  9. log4j.logger.com. neusoft =DEBUG

    指定com.neusoft包下的所有类的等级为DEBUG。

    可以把com.neusoft改为自己项目所用的包名。

  10. log4j.logger.com.opensymphony.oscache=ERROR

    og4j.logger.net.sf.navigator=ERROR

    这两句是把这两个包下出现的错误的等级设为ERROR，如果项目中没有配置EHCache，则不需要这两句。

  11. log4j.logger.org.apache.commons=ERROR

    log4j.logger.org.apache.struts=WARN

    这两句是struts的包。

  12. log4j.logger.org.displaytag=ERROR

    这句是displaytag的包。（QC问题列表页面所用）

  13. log4j.logger.org.springframework=DEBUG

    此句为Spring的包。

  14. log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN

    log4j.logger.org.hibernate=DEBUG

    此两句是hibernate的包。

以上这些包的设置可根据项目的实际情况而自行定制。

# 步骤三：配置log4j为日志实现

在mybatis-config.xm文件中配置log4j为日志实现

<!--配置log4j为日志实现-->
<settings>
    <setting name="logImpl" value="LOG4J"/>
</settings>
1
2
3
4

# 步骤四：log4j的使用

  • 在要使用Log4j的类中，导入import org.apache.log4j.Logger;
  • 创建日志对象，参数为当前类的class

在要输出日志的类中加入相关语句来定义属性：

static Logger logger = Logger.getLogger(UserMapperTest.class);
1
public class UserMapperTest {
    static Logger logger = Logger.getLogger(UserMapperTest.class);

    @Test
    public void testLog4j() {
        logger.info("info:进入了testLog4j方法");
        logger.debug("debug:进入了进入了testLog4j方法");
        logger.error("debug:进入了进入了testLog4j方法");
    }
}
1
2
3
4
5
6
7
8
9
10
2021-08-25 01:55:30 [DEBUG]-LogFactory - Logging initialized using 'class org.apache.ibatis.logging.log4j.Log4jImpl' adapter.
2021-08-25 01:55:30 [DEBUG]-PooledDataSource - PooledDataSource forcefully closed/removed all connections.
2021-08-25 01:55:30 [DEBUG]-PooledDataSource - PooledDataSource forcefully closed/removed all connections.
2021-08-25 01:55:30 [DEBUG]-PooledDataSource - PooledDataSource forcefully closed/removed all connections.
2021-08-25 01:55:30 [DEBUG]-PooledDataSource - PooledDataSource forcefully closed/removed all connections.
2021-08-25 01:55:31 [INFO]-UserMapperTest - info:进入了testLog4j方法
2021-08-25 01:55:31 [DEBUG]-UserMapperTest - debug:进入了进入了testLog4j方法
2021-08-25 01:55:31 [ERROR]-UserMapperTest - debug:进入了进入了testLog4j方法
1
2
3
4
5
6
7
8

​ log4j定义了8个级别的log（除去OFF和ALL，可以说分为6个级别），优先级从高到低依次为：

  • OFF
  • FATAL
  • ERROR
  • WARN
  • INFO
  • DEBUG
  • TRACE
  • ALL
  1. ALL 最低等级的，用于打开所有日志记录。
  2. TRACE designates finer-grained informational events than the DEBUG.Since:1.2.12，很低的日志级别，一般不会使用。
  3. DEBUG 指出细粒度信息事件对调试应用程序是非常有帮助的，主要用于开发过程中打印一些运行信息。
  4. INFO 消息在粗粒度级别上突出强调应用程序的运行过程。打印一些你感兴趣的或者重要的信息，这个可以用于生产环境中输出程序运行的一些重要信息，但是不能滥用，避免打印过多的日志。
  5. WARN 表明会出现潜在错误的情形，有些信息不是错误信息，但是也要给程序员的一些提示。
  6. ERROR 指出虽然发生错误事件，但仍然不影响系统的继续运行。打印错误和异常信息，如果不想输出太多的日志，可以使用这个级别。
  7. FATAL 指出每个严重的错误事件将会导致应用程序的退出。这个级别比较高了。重大错误，这种级别你可以直接停止程序了。
  8. OFF 最高等级的，用于关闭所有日志记录。

​ 如果将log level设置在某一个级别上，那么比此级别优先级高的log都能打印出来。例如，如果设置优先级为WARN，那么OFF、FATAL、ERROR、WARN 4个级别的log能正常输出，而INFO、DEBUG、TRACE、 ALL级别的log则会被忽略。Log4j建议只使用四个级别，优先级从高到低分别是ERROR、WARN、INFO、DEBUG。

编辑 (opens new window)
#MyBatis
ResultMat的使用
MyBatis动态SQL

← MyBatis动态SQL→

最近更新
01
Maven资源导出问题终极版
 10-12
02
《MyBatis-Plus》学习笔记
 10-07
03
MyBatis-Plus—配置日志
 10-07
更多文章>
Theme by Vdoing | Copyright © 2020-2021 版权所有 | repository.singerw.com
×