SSM框架下结合 log4j、slf4j打印日志

迷南。 2022-02-05 03:37 330阅读 0赞

## maven ##

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

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

SLF4J  
Apache Commons Logging  
Log4j 2  
Log4j  
JDK logging  
1、具体选择哪个日志实现工具由MyBatis的内置日志工厂确定。它会使用最先找到的（按上文列举的顺序查找）。 如果一个都未找到，日志功能就会被禁用。

不少应用服务器的classpath中已经包含Commons Logging，如Tomcat和WebShpere， 所以MyBatis会把它作为具体的日志实现。记住这点非常重要。这将意味着，在诸如 WebSphere的环境中——WebSphere提供了Commons Logging的私有实现，你的Log4J配置将被忽略。 这种做法不免让人悲催，MyBatis怎么能忽略你的配置呢？事实上，因Commons Logging已经存 在了，按照优先级顺序，Log4J自然就被忽略了！不过，如果你的应用部署在一个包含Commons Logging的环境， 而你又想用其他的日志框架，你可以通过在MyBatis的配置文件mybatis-config.xml里面添加一项setting（配置）来选择一个不同的日志实现。

## mybatis-config.xml ##

<?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>
    
        
        <settings>  
            <setting name="logImpl" value="SLF4J"/>  
        </settings>  
    
        
        
        
        <plugins>
            
            <plugin interceptor="com.github.pagehelper.PageHelper">
                
                <property name="dialect" value="mysql" />
                
                
                
                <property name="offsetAsPageNum" value="true" />
                
                
                <property name="rowBoundsWithCount" value="true" />
                
                
                <property name="pageSizeZero" value="true" />
                
                
                
    
                
                
                
                
    
                
                <property name="supportMethodsArguments" value="false" />
                
                <property name="returnPageInfo" value="none" />
            </plugin>
        </plugins>
        
    </configuration>

logImpl可选的值有：SLF4J、LOG4J、LOG4J2、JDK\_LOGGING、COMMONS\_LOGGING、STDOUT\_LOGGING、NO\_LOGGING 或者是实现了接口org.apache.ibatis.logging.Log的类的完全限定类名， 并且这个类的构造函数需要是以一个字符串（String类型）为参数的。 （可以参考org.apache.ibatis.logging.slf4j.Slf4jImpl.java的实现）

你根据需要调用如下的某一方法：

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();

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

## web.xml ##

<context-param>
            <param-name>log4jConfigLocation</param-name>
            <param-value>classpath:log4j.properties</param-value>
        </context-param>
        <listener>
            <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
    </listener>

## log4j.properties ##

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

################################################################################
    #①配置根Logger，其语法为：
    #
    #log4j.rootLogger=[level],appenderName,appenderName2,...
    #level是日志记录的优先级，分为OFF,TRACE,DEBUG,INFO,WARN,ERROR,FATAL,ALL
    ##Log4j建议只使用四个级别，优先级从低到高分别是DEBUG,INFO,WARN,ERROR
    #通过在这里定义的级别，您可以控制到应用程序中相应级别的日志信息的开关
    #比如在这里定义了INFO级别，则应用程序中所有DEBUG级别的日志信息将不被打印出来
    #appenderName就是指定日志信息输出到哪个地方。可同时指定多个输出目的
    ################################################################################
    #OFF,systemOut,logFile,logDailyFile,logRollingFile,logMail,logDB,ALL
    log4j.rootLogger=INFO,systemOut,DB
    
    
    
    
    
    #输出到控制台
    log4j.appender.systemOut=org.apache.log4j.ConsoleAppender
    log4j.appender.systemOut.layout=org.apache.log4j.PatternLayout
    log4j.appender.systemOut.layout.ConversionPattern=[%-5p][%-22d{yyyy/MM/ddHH:mm:ssS}][%l]%n%m%n
    
    ################################################################################
    #指定特定包的输出特定的级别
    #log4j.logger.org.springframework=DEBUG
    ################################################################################
    #log4j.appender.systemOut.Threshold=DEBUG
    log4j.appender.systemOut.ImmediateFlush=TRUE
    log4j.appender.systemOut.Target=System.out
    log4j.logger.org.mybatis=DEBUG
    log4j.logger.com.yaosiyuan.dao=DEBUG
    
    #mybatis显示SQL语句日志配置
    #log4j.logger.org.mybatis=DEBUG
    #log4j.logger.com.itzixi.mapper=DEBUG
    
    
    #将日志登录到MySQL数据库
    log4j.appender.DB=org.apache.log4j.jdbc.JDBCAppender
    log4j.appender.DB.layout=org.apache.log4j.PatternLayout
    log4j.appender.DB.Driver=com.mysql.jdbc.Driver
    log4j.appender.DB.Threshold=DEBUG
    # 定义字符集防止中文乱码
    log4j.appender.DB.encoding=UTF-8 
    log4j.appender.DB.URL=jdbc:mysql://localhost:3306/ms
    log4j.appender.DB.User=root
    log4j.appender.DB.Password=root
    #log4j.appender.DB.Sql=INSERT INTO t_log4j(project_name,create_date,level,category,file_name,thread_name,line,all_category,message)values('秒杀项目','%d{yyyy-MM-ddHH:mm:ss}','%p','%c','%F','%t','%L','%l','%m')
    log4j.appender.DB.Sql=INSERT INTO t_log4j(project_name,create_date,level,category,file_name,thread_name,line,all_category,message)values("秒杀项目","%d{yyyy-MM-ddHH:mm:ss}","%p","%c","%F","%t","%L","%l","%m")
    #Sql参数
    #%p输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
    #%r输出自应用启动到输出该log信息耗费的毫秒数
    #%c输出所属的类目，通常就是所在类的全名
    #%t输出产生该日志事件的线程名
    #%n输出一个回车换行符，Windows平台为“rn”，Unix平台为“n”
    #%d输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyyMMMddHH:mm:ss,SSS}，输出类似：2002年10月18日22：10：28，921
    #%l输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java:10)
    
    #sql table
    #DROP TABLE IF EXISTS `t_log4j`;
    #CREATE TABLE `t_log4j` (
    #  `log_id` int(11) NOT NULL AUTO_INCREMENT,
    #  `project_name` varchar(255) DEFAULT NULL COMMENT '目项名',
    #  `create_date` varchar(255) DEFAULT NULL COMMENT '创建时间',
    #  `level` varchar(255) DEFAULT NULL COMMENT '优先级',
    #  `category` varchar(255) DEFAULT NULL COMMENT '所在类的全名',
    #  `file_name` varchar(255) DEFAULT NULL COMMENT '输出日志消息产生时所在的文件名称 ',
    #  `thread_name` varchar(255) DEFAULT NULL COMMENT '日志事件的线程名',
    #  `line` varchar(255) DEFAULT NULL COMMENT '号行',
    #  `all_category` varchar(255) DEFAULT NULL COMMENT '日志事件的发生位置',
    #  `message` varchar(4000) DEFAULT NULL COMMENT '输出代码中指定的消息',
    #  PRIMARY KEY (`log_id`)
    #) ENGINE=InnoDB AUTO_INCREMENT=170 DEFAULT CHARSET=utf8;
    
    
    #用Email发送日志
    log4j.appender.logMail=org.apache.log4j.net.SMTPAppender
    log4j.appender.logMail.layout=org.apache.log4j.HTMLLayout
    log4j.appender.logMail.layout.LocationInfo=TRUE
    log4j.appender.logMail.layout.Title=MSMailLogFile
    log4j.appender.logMail.Threshold=DEBUG
    log4j.appender.logMail.SMTPDebug=FALSE
    log4j.appender.logMail.SMTPHost=SMTP.163.com
    log4j.appender.logMail.From=yaosiyuanmail@163.com
    log4j.appender.logMail.To=yaosiyuanmail@gmail.com
    #log4j.appender.logMail.Cc=xly3000@gmail.com
    #log4j.appender.logMail.Bcc=xly3000@gmail.com
    log4j.appender.logMail.SMTPUsername=yaosiyuan
    log4j.appender.logMail.SMTPPassword=1234567
    log4j.appender.logMail.Subject=Log4jLogMessages
    #log4j.appender.logMail.BufferSize=1024
    #log4j.appender.logMail.SMTPAuth=TRUE
    
    #按DatePattern输出到文件
    log4j.appender.logDailyFile=org.apache.log4j.DailyRollingFileAppender
    log4j.appender.logDailyFile.layout=org.apache.log4j.PatternLayout
    log4j.appender.logDailyFile.layout.ConversionPattern=[%-5p][%-22d{yyyy/MM/ddHH:mm:ssS}][%l]%n%m%n
    log4j.appender.logDailyFile.Threshold=DEBUG
    log4j.appender.logDailyFile.ImmediateFlush=TRUE
    log4j.appender.logDailyFile.Append=TRUE
    log4j.appender.logDailyFile.File=../Struts2/WebRoot/log/DailyFile/log4j_Struts
    log4j.appender.logDailyFile.DatePattern='.'yyyy-MM-dd-HH-mm'.log'
    log4j.appender.logDailyFile.Encoding=UTF-8
    
    #输出到文件
    log4j.appender.logFile=org.apache.log4j.FileAppender
    log4j.appender.logFile.layout=org.apache.log4j.PatternLayout
    log4j.appender.logFile.layout.ConversionPattern=[%-5p][%-22d{yyyy/MM/ddHH:mm:ssS}][%l]%n%m%n
    log4j.appender.logFile.Threshold=DEBUG
    log4j.appender.logFile.ImmediateFlush=TRUE
    log4j.appender.logFile.Append=TRUE
    log4j.appender.logFile.File=../Struts2/WebRoot/log/File/log4j_Struts.log
    log4j.appender.logFile.Encoding=UTF-8
    
    
    
    #设定文件大小输出到文件
    log4j.appender.logRollingFile=org.apache.log4j.RollingFileAppender
    log4j.appender.logRollingFile.layout=org.apache.log4j.PatternLayout
    log4j.appender.logRollingFile.layout.ConversionPattern=[%-5p][%-22d{yyyy/MM/ddHH:mm:ssS}][%l]%n%m%n
    log4j.appender.logRollingFile.Threshold=DEBUG
    log4j.appender.logRollingFile.ImmediateFlush=TRUE
    log4j.appender.logRollingFile.Append=TRUE
    log4j.appender.logRollingFile.File=../Struts2/WebRoot/log/RollingFile/log4j_Struts.log
    log4j.appender.logRollingFile.MaxFileSize=1MB
    log4j.appender.logRollingFile.MaxBackupIndex=10
    log4j.appender.logRollingFile.Encoding=UTF-8
    
    
    ##显示SQL语句部分
    #log4j.logger.com.ibatis=DEBUG
    #log4j.logger.com.ibatis.common.jdbc.SimpleDataSource=DEBUG
    #log4j.logger.com.ibatis.common.jdbc.ScriptRunner=DEBUG
    #log4j.logger.com.ibatis.sqlmap.engine.impl.SqlMapClientDelegate=DEBUG
    #log4j.logger.java.sql.Connection=DEBUG
    #log4j.logger.java.sql.Statement=DEBUG
    #log4j.logger.java.sql.PreparedStatement=DEBUG
    
    
    # 定期滚动日志文件，每天都会生成日志
    log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender
    log4j.appender.dailyFile.encoding=UTF-8
    log4j.appender.dailyFile.Threshold=INFO
    # TODO 本地日志地址，正式环境请务必切换为阿里云地址
    #log4j.appender.dailyFile.File=C:/logs/log.log4j
    log4j.appender.dailyFile.File=/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,SSS} [%t] [%l] - [%p] %m%n
    
    
    
    ################################################################################
    #②配置日志信息输出目的地Appender，其语法为：
    #
    #log4j.appender.appenderName=fully.qualified.name.of.appender.class
    #log4j.appender.appenderName.optionN=valueN
    #
    #Log4j提供的appender有以下几种：
    #1)org.apache.log4j.ConsoleAppender(输出到控制台)
    #2)org.apache.log4j.FileAppender(输出到文件)
    #3)org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
    #4)org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
    #5)org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
    #
    #1)ConsoleAppender选项属性
    #-Threshold=DEBUG:指定日志消息的输出最低层次
    #-ImmediateFlush=TRUE:默认值是true,所有的消息都会被立即输出
    #-Target=System.err:默认值System.out,输出到控制台(err为红色,out为黑色)
    #
    #2)FileAppender选项属性
    #-Threshold=INFO:指定日志消息的输出最低层次
    #-ImmediateFlush=TRUE:默认值是true,所有的消息都会被立即输出
    #-File=C:\log4j.log:指定消息输出到C:\log4j.log文件
    #-Append=FALSE:默认值true,将消息追加到指定文件中，false指将消息覆盖指定的文件内容
    #-Encoding=UTF-8:可以指定文件编码格式
    #
    #3)DailyRollingFileAppender选项属性
    #-Threshold=WARN:指定日志消息的输出最低层次
    #-ImmediateFlush=TRUE:默认值是true,所有的消息都会被立即输出
    #-File=C:\log4j.log:指定消息输出到C:\log4j.log文件
    #-Append=FALSE:默认值true,将消息追加到指定文件中，false指将消息覆盖指定的文件内容
    #-DatePattern='.'yyyy-ww:每周滚动一次文件,即每周产生一个新的文件。还可以按用以下参数:
    #'.'yyyy-MM:每月
    #'.'yyyy-ww:每周
    #'.'yyyy-MM-dd:每天
    #'.'yyyy-MM-dd-a:每天两次
    #'.'yyyy-MM-dd-HH:每小时
    #'.'yyyy-MM-dd-HH-mm:每分钟
    #-Encoding=UTF-8:可以指定文件编码格式
    #
    #4)RollingFileAppender选项属性
    #-Threshold=ERROR:指定日志消息的输出最低层次
    #-ImmediateFlush=TRUE:默认值是true,所有的消息都会被立即输出
    #-File=C:/log4j.log:指定消息输出到C:/log4j.log文件
    #-Append=FALSE:默认值true,将消息追加到指定文件中，false指将消息覆盖指定的文件内容
    #-MaxFileSize=100KB:后缀可以是KB,MB,GB.在日志文件到达该大小时,将会自动滚动.如:log4j.log.1
    #-MaxBackupIndex=2:指定可以产生的滚动文件的最大数
    #-Encoding=UTF-8:可以指定文件编码格式
    ################################################################################
    ################################################################################
    #③配置日志信息的格式(布局)，其语法为：
    #
    #log4j.appender.appenderName.layout=fully.qualified.name.of.layout.class
    #log4j.appender.appenderName.layout.optionN=valueN
    #
    #Log4j提供的layout有以下几种：
    #5)org.apache.log4j.HTMLLayout(以HTML表格形式布局)
    #6)org.apache.log4j.PatternLayout(可以灵活地指定布局模式)
    #7)org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串)
    #8)org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
    #9)org.apache.log4j.xml.XMLLayout(以XML形式布局)
    #
    #5)HTMLLayout选项属性
    #-LocationInfo=TRUE:默认值false,输出java文件名称和行号
    #-Title=StrutsLogMessage:默认值Log4JLogMessages
    #
    #6)PatternLayout选项属性
    #-ConversionPattern=%m%n:格式化指定的消息(参数意思下面有)
    #
    #9)XMLLayout选项属性
    #-LocationInfo=TRUE:默认值false,输出java文件名称和行号
    #
    #Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，打印参数如下：
    #%m输出代码中指定的消息
    #%p输出优先级，即DEBUG,INFO,WARN,ERROR,FATAL
    #%r输出自应用启动到输出该log信息耗费的毫秒数
    #%c输出所属的类目,通常就是所在类的全名
    #%t输出产生该日志事件的线程名
    #%n输出一个回车换行符，Windows平台为“\r\n”，Unix平台为“\n”
    #%d输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式
    #如：%d{yyyy年MM月dd日HH:mm:ss,SSS}，输出类似：2012年01月05日22:10:28,921
    #%l输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数
    #如：Testlog.main(TestLog.java:10)
    #%F输出日志消息产生时所在的文件名称
    #%L输出代码中的行号
    #%x输出和当前线程相关联的NDC(嵌套诊断环境),像javaservlets多客户多线程的应用中
    #%%输出一个"%"字符
    #
    #可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：
    #%5c:输出category名称，最小宽度是5，category<5，默认的情况下右对齐
    #%-5c:输出category名称，最小宽度是5，category<5，"-"号指定左对齐,会有空格
    #%.5c:输出category名称，最大宽度是5，category>5，就会将左边多出的字符截掉，<5不会有空格
    #%20.30c:category名称<20补空格，并且右对齐，>30字符，就从左边交远销出的字符截掉
    ################################################################################