Mybatis最入门---日志配置
原文地址:http://blog.****.net/qi49125/article/details/52277488
对于以往的开发过程,我们会经常使用到debug模式来调节,跟踪我们的代码执行过程。但是现在使用Mybatis是基于接口,配置文件的源代码执行过程。因此,我们必须选择日志工具来作为我们开发,调节程序的工具。
--------------------------------------------------------------------------------------------------------------------------------------------------------
正文开始:
Mybatis内置的日志工厂提供日志功能,具体的日志实现有以下几种工具:
- SLF4J
- Apache Commons Logging
- Log4j 2
- Log4j
- JDK logging
具体选择哪个日志实现工具由MyBatis的内置日志工厂确定。它会使用最先找到的(按上文列举的顺序查找)。 如果一个都未找到,日志功能就会被禁用。
不少应用服务器的classpath中已经包含Commons Logging,如Tomcat和WebShpere, 所以MyBatis会把它作为具体的日志实现。记住这点非常重要。这将意味着,在诸如 WebSphere的环境中——WebSphere提供了Commons Logging的私有实现,你的Log4J配置将被忽略。 这种做法不免让人悲催,MyBatis怎么能忽略你的配置呢?事实上,因Commons Logging已经存 在了,按照优先级顺序,Log4J自然就被忽略了!不过,如果你的应用部署在一个包含Commons Logging的环境, 而你又想用其他的日志框架,你可以通过在MyBatis的配置文件mybatis-config.xml里面添加一项setting(配置)来选择一个不同的日志实现。
- <configuration>
- <settings>
- ...
- <setting name="logImpl" value="LOG4J"/>
- ...
- </settings>
- </configuration>
- org.apache.ibatis.logging.LogFactory.useSlf4jLogging();
- org.apache.ibatis.logging.LogFactory.useLog4JLogging();
- org.apache.ibatis.logging.LogFactory.useJdkLogging();
- org.apache.ibatis.logging.LogFactory.useCommonsLogging();
- org.apache.ibatis.logging.LogFactory.useStdOutLogging();
-------------------------------------------------------------------------------------------------------------------------------------
我们以前文HelloWorld工程为例,说明Log4j的使用方法
1.创建log4j.properties文件,具体内容如下:
- log4j.rootLogger=debug,stdout
- log4j.appender.stdout=org.apache.log4j.ConsoleAppender
- log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
- log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n
- <dependency>
- <groupId>log4j</groupId>
- <artifactId>log4j</artifactId>
- <version>1.2.17</version>
- </dependency>
- package com.****.ingo.main;
- import org.apache.ibatis.session.SqlSession;
- import org.apache.log4j.Logger;
- import com.****.ingo.dao.UserDao;
- import com.****.ingo.entity.User;
- import com.****.ingo.util.SqlSessionFactoryUtil;
- public class main {
- private static Logger log = Logger.getLogger(main.class);
- public static void main(String[] args) {
- SqlSession sqlSession=SqlSessionFactoryUtil.openSession();
- UserDao userDao = sqlSession.getMapper(UserDao.class);
- String id = "admin";
- User curUser = userDao.findUserById(id);
- if(curUser!=null){
- log.info("HelloWorld:"+curUser.getId());
- // System.out.println("HelloWorld:"+curUser.getId());
- }
- }
- }
各位看官可能要问了,为什么没有配置Setting呢?
其实,如果仔细阅读上文,就会发现Mybatis是按照顺序加载日志组件。本例中,我们只使用了LOG4J,因此Mybatis自动使用了LOG4J。但是如果存在多个日志时,我们就需要进行配置Setting,示例代码如下:
- <?xml version="1.0" encoding="UTF-8" ?>
- <!DOCTYPE configuration
- PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
- "http://mybatis.org/dtd/mybatis-3-config.dtd">
- <configuration>
- <properties resource="jdbc.properties"/>
- <settings>
- <setting name="logImpl" value="LOG4J"/>
- </settings>
- <typeAliases>
- <typeAlias alias="User" type="com.****.ingo.entity.User"/>
- </typeAliases>
- <environments default="development">
- <environment id="development">
- <transactionManager type="JDBC" />
- <dataSource type="POOLED">
- <property name="driver" value="${jdbc.driverClassName}" />
- <property name="url" value="${jdbc.url}" />
- <property name="username" value="${jdbc.username}" />
- <property name="password" value="${jdbc.password}" />
- </dataSource>
- </environment>
- </environments>
- <mappers>
- <mapper resource="mappers/UserMapper.xml" />
- </mappers>
- </configuration>
对于这份配置文件,请读者一定按照此配置顺序进行配置。虽然没有明确的官方说明,但是如果配置项的顺序出错,将会抛入如下错误,请读者特别注意:
除了基本的使用方法之外,也可以将日志从整个mapper接口级别调整到到语句级别,从而实现更细粒度的控制。如下配置只记录 select 语句的日志:【注意,此时的日志级别请设置为高于debug,这样才能看出配置后的效果】
- log4j.logger.com.****.ingo.dao.UserDao.findUserById=TRACE
与此相对,可以对一组mapper接口记录日志,只要对mapper接口所在的包开启日志功能即可:
- log4j.logger.com.****.ingo=TRACE
某些查询可能会返回大量的数据,只想记录其执行的SQL语句该怎么办?为此,Mybatis中SQL语 句的日志级别被设为DEBUG(JDK Logging中为FINE),结果日志的级别为TRACE(JDK Logging中为FINER)。所以,只要将日志级别调整为DEBUG即可达到目的:
- log4j.logger.com.****.ingo=DEBUG
要记录日志的是mapper文件而不是mapper接口又该怎么呢?
- log4j.logger.com.****.ingo.dao.UserDao=TRACE
-------------------------------------------------------------------------------------------------------------------------------------
至此,Mybatis最入门---日志配置结束
参考资料
官方文档:http://www.mybatis.org/mybatis-3/