Mybatis内置的日志工厂提供日志功能,

本文介绍如何在MyBatis中配置Log4j来记录不同级别的日志,包括整体配置方法及针对特定Mapper接口或XML文件的精细化控制。

mybatis还提供了另外一种(推荐使用这种)解决方法,继续看下面。

 

另一种解决为,在mybatis-config.xml配置文件中:

 

[html]   view plain copy 在CODE上查看代码片 派生到我的代码片
  1. <configuration>  
  2.     <settings>  
  3.         <setting name="logImpl" value="LOG4J"/>  
  4.     </settings>  
  5. </configuration>  


这里只写了关键的一部分配置信息,在你自己配置的基础上增加<setting name="logImpl" value="LOG4J"/>即可。这样一来log4j的配置信息就会起作用。

 

 

参数说明:

 

 

 

Mybatis对Log4j的配置支持:

 

Logging Configuration

MyBatis可以对包、类、命名空间和全限定的语句记录日志。

具体怎么做,视使用的日志框架而定,这里以Log4J为例。配置日志功能非常简单:添加几个配置文件, 如log4j.properties,再增加个jar包,如log4j.jar。下面是具体的例子,共两个步骤:

 

步骤1: 增加Log4J jar包

因为采用Log4J,要确保在应用中对应的jar包是可用的。要满足这一点,只要将jar包添加到应用的classpath中即可。 Log4J的jar包可以从上方的链接下载。

具体而言,对于web或企业应用,需要将log4j.jar 添加到WEB-INF/lib 目录; 对于独立应用, 可以将它添加到jvm的-classpath启动参数中。

 

步骤2:配置Log4J

配置Log4J比较简单, 比如需要记录这个mapper接口的日志:

 

[java]   view plain copy 在CODE上查看代码片 派生到我的代码片
  1. package org.mybatis.example;  
  2. public interface BlogMapper {  
  3.   @Select("SELECT * FROM blog WHERE id = #{id}")  
  4.   Blog selectBlog(int id);  
  5. }  

 

只要在应用的classpath中创建一个名称为log4j.properties的文件, 文件的具体内容如下:

 

[plain]   view plain copy 在CODE上查看代码片 派生到我的代码片
  1. # Global logging configuration  
  2. log4j.rootLogger=ERROR, stdout  
  3. # MyBatis logging configuration...  
  4. log4j.logger.org.mybatis.example.BlogMapper=TRACE  
  5. # Console output...  
  6. log4j.appender.stdout=org.apache.log4j.ConsoleAppender  
  7. log4j.appender.stdout.layout=org.apache.log4j.PatternLayout  
  8. log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n  

 

添加以上配置后,Log4J就会把 org.mybatis.example.BlogMapper 的详细执行日志记录下来,对于应用中的其它类则仅仅记录错误信息。

也可以将日志从整个mapper接口级别调整到到语句级别,从而实现更细粒度的控制。如下配置只记录 selectBlog语句的日志:

 

[plain]   view plain copy 在CODE上查看代码片 派生到我的代码片
  1. log4j.logger.org.mybatis.example.BlogMapper.selectBlog=TRACE  

 

与此相对,可以对一组mapper接口记录日志,只要对mapper接口所在的包开启日志功能即可:

 

[plain]   view plain copy 在CODE上查看代码片 派生到我的代码片
  1. log4j.logger.org.mybatis.example=TRACE  

 

某些查询可能会返回大量的数据,只想记录其执行的SQL语句该怎么办?为此,Mybatis中SQL语 句的日志级别被设为DEBUG(JDK Logging中为FINE),结果日志的级别为TRACE(JDK Logging中为FINER)。所以,只要将日志级别调整为DEBUG即可达到目的:

 

[plain]   view plain copy 在CODE上查看代码片 派生到我的代码片
  1. log4j.logger.org.mybatis.example=DEBUG  

 

要记录日志的是类似下面的mapper文件而不是mapper接口又该怎么呢?

 

[html]   view plain copy 在CODE上查看代码片 派生到我的代码片
  1. <?xml version="1.0" encoding="UTF-8" ?>  
  2. <!DOCTYPE mapper  
  3.   PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"  
  4.   "http://mybatis.org/dtd/mybatis-3-mapper.dtd">  
  5. <mapper namespace="org.mybatis.example.BlogMapper">  
  6.   <select id="selectBlog" resultType="Blog">  
  7.     select * from Blog where id = #{id}  
  8.   </select>  
  9. </mapper>  

 

对这个文件记录日志,只要对命名空间增加日志记录功能即可:

 

[plain]   view plain copy 在CODE上查看代码片 派生到我的代码片
  1. log4j.logger.org.mybatis.example.BlogMapper=TRACE  

 

进一步,要记录具体语句的日志可以这样做:

 

[plain]   view plain copy 在CODE上查看代码片 派生到我的代码片
  1. log4j.logger.org.mybatis.example.BlogMapper.selectBlog=TRACE  

 

看到了把,两种配置没差别!

配置文件log4j.properties的余下内容是针对日志格式的,这一内容已经超出本 文档范围。关于Log4J的更多内容,可以参考Log4J的网站。不过,可以简单试一下看看,不同的配置 会产生什么不一样的效果。

 

MyBatis 中集成日志功能,可以通过多种方式实现,包括使用内置日志实现、第三方日志框架(如 Log4J、Logback 等),以及通过 MyBatis 插件机制实现更细粒度的 SQL 日志记录。 ### 配置内置日志实现 MyBatis 支持多种日志实现,包括 `STDOUT_LOGGING`,它可以直接将日志信息输出到控制台。要启用这种日志实现,可以在 MyBatis 的配置文件中设置 `logImpl` 属性为 `STDOUT_LOGGING`: ```xml <settings> <setting name="logImpl" value="STDOUT_LOGGING"/> </settings> ``` 这种方式简单直接,适合于开发阶段快速查看日志信息,但在生产环境中通常需要更强大的日志管理功能[^3]。 ### 使用第三方日志框架 MyBatis 也支持集成第三方日志框架,如 Log4J 或 Logback。为了使用这些框架,需要在项目的类路径中包含相应的日志库,并且配置 MyBatis 使用这些日志框架。例如,如果想要使用 Log4J,需要确保类路径中存在 Log4J 的 JAR 文件,并且可以通过调用 `org.apache.ibatis.logging.LogFactory` 类的静态方法来设置日志工厂: ```java LogFactory.useLog4JLogging(); ``` 需要注意的是,只有在运行时类路径中存在对应的日志工具时,调用与该日志工具对应的方法才会生效,否则 MyBatis 会忽略这些调用,并按照默认的查找顺序寻找日志工具。如果环境中并没有安装 Log4J,但却调用了相应的方法,MyBatis 会忽略这一调用[^1]。 ### 利用 MyBatis 插件机制记录 SQL 日志 对于需要记录所有增删改操作的 SQL 并持久化到数据库表中的场景,可以考虑使用 MyBatis 的插件机制。通过创建一个实现了 `Interceptor` 接口的类,可以拦截 MyBatis 的执行过程,并记录下执行的 SQL 语句。这种方法的好处是可以非常灵活地控制日志记录的行为,并且不会影响到业务逻辑的正常执行。 实现这样的插件涉及到对 MyBatis 内部 API 的深入了解,包括如何正确地拦截 SQL 执行、如何获取执行的 SQL 语句及其参数等。此外,还需要考虑日志记录的性能影响以及如何处理可能出现的异常情况。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值