Mybatis的logging

使用Mybatis的时候,有些时候能输出(主要是指sql,参数,结果)日志。有些时候就不能。

无法输出日志的时候,无论怎么配置log4j,不管是properties的还是xml的,都不起作用。

有些时候,我们没做什么配置就能输出日志....

这是一个让无数人烦躁的问题。其实解决问题很容易(我过了这么久才解决,以前都用拦截器输出)。

这是一个普大喜奔的日子,让我们一起来看看如何解决mybatis的日志问题。

为什么说这个问题很容易解决呢?因为mybatis的文档写的很清楚。

为什么我们都没找到解决办法呢?因为即使看过文档的人,也未必去看Logging这一节。但是这一节正是解决问题的关键。

已经等不及的小伙伴们可以直接去这里看文档:http://mybatis.github.io/mybatis-3/zh/logging.html

提醒最常用的方法不再这个链接中,但是这个文档提供了对log4j的详细配置。本文下面的内容大部分是这个文档的Copy。

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

SLF4J

Apache Commons Logging

Log4j 2

Log4j

JDK logging

具体选择哪个日志实现由MyBatis的内置日志工厂确定。它会使用最先找到的(按上文列举的顺序查找)。如果一个都未找到,日志功能就会被禁用。

不少应用服务器的classpath中已经包含Commons Logging,如TomcatWebShpere所以MyBatis会把它作为具体的日志实现

记住这点非常重要。这意味着,在诸如WebSphere的环境中——WebSphere提供了Commons Logging的私有实现,你的Log4J配置将被忽略。

这种做法不免让人悲催,MyBatis怎么能忽略你的配置呢?事实上,Commons Logging已经存在,按优先级Log4J自然就被忽略了!

不过,如果你的应用部署在一个包含Commons Logging的环境,而你又想用其他的日志框架,你可以根据需要调用如下的某一方法:

[java]view plaincopy

1.org.apache.ibatis.logging.LogFactory.useSlf4jLogging();

2.org.apache.ibatis.logging.LogFactory.useLog4JLogging();

3.org.apache.ibatis.logging.LogFactory.useJdkLogging();

4.org.apache.ibatis.logging.LogFactory.useCommonsLogging();

5.org.apache.ibatis.logging.LogFactory.useStdOutLogging();

如果的确需要调用以上的某个方法,请在调用所有其他MyBatis方法前调用它。另外,只有在相应日志实现存在的前提下,调用对应的方法才是有意义的,否则MyBatis一概忽略。如你环境中并不存在Log4J,你却调用了相应的方法,MyBatis就会忽略这一调用,代之默认的查找顺序查找日志实现。

例如使用log4j就需要在调用mybatis方法前,先执行代码:

[java]view plaincopy

1.org.apache.ibatis.logging.LogFactory.useLog4JLogging();

上面这是一种解决办法,但是有些情况你不知道何时执行这个方法。

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

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

[html]view plaincopy

1.

2.

3.name="logImpl"value="LOG4J"/>

4.

5.

这里只写了关键的一部分配置信息,在你自己配置的基础上增加即可。这样一来log4j的配置信息就会起作用。

参数说明:

MybatisLog4j的配置支持:

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 plaincopy

1.packageorg.mybatis.example;

2.publicinterfaceBlogMapper {

3.@Select("SELECT * FROM blog WHERE id = #{id}")

4.Blog selectBlog(intid);

5.}

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

[plain]view plaincopy

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 plaincopy

1.log4j.logger.org.mybatis.example.BlogMapper.selectBlog=TRACE

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

[plain]view plaincopy

1.log4j.logger.org.mybatis.example=TRACE

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

[plain]view plaincopy

1.log4j.logger.org.mybatis.example=DEBUG

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

[html]view plaincopy

1.version="1.0"encoding="UTF-8"?>

2.

3.PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"

4."http://mybatis.org/dtd/mybatis-3-mapper.dtd">

5.namespace="org.mybatis.example.BlogMapper">

6.id="selectBlog"resultType="Blog">

7.select * from Blog whereid= #{id}

8.

9.

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

[plain]view plaincopy

1.log4j.logger.org.mybatis.example.BlogMapper=TRACE

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

[plain]view plaincopy

1.log4j.logger.org.mybatis.example.BlogMapper.selectBlog=TRACE

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

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

��C"����'

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,711评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,932评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,770评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,799评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,697评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,069评论 1 276
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,535评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,200评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,353评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,290评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,331评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,020评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,610评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,694评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,927评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,330评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,904评论 2 341

推荐阅读更多精彩内容

  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,951评论 0 6
  • springmvc+mybatis+maven整合视频 http://www.java1234.com/a/jav...
    zhuyuansj阅读 633评论 0 2
  • 在应用程序中添加日志记录总的来说基于三个目的:监视代码中变量的变化情况,周期性的记录到文件中供其他应用进行统计分析...
    时待吾阅读 4,912评论 1 13
  • 1. 简介 1.1 什么是 MyBatis ? MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的...
    笨鸟慢飞阅读 5,422评论 0 4
  • 通过之前的两篇我们能在本地搭建单一和集群两种方式的dubbo服务,这篇我们来看 springmvc+spring+...
    安琪拉_4b7e阅读 2,136评论 0 6