在项目中,记录日志是非常有必要的,在测试或生产环境,哪个功能点出了问题,往往要通过日志来分析定位,这里总结下在Spring+Spring MVC中记录日志的方法。
1、需要在pom.xml文件中引入slf4j和log4j的依赖,如下
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.14</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.7.2</version>
</dependency>
这里为什么要使用slf4j,用log4j不就可以了吗?稍后介绍
2、增加一个log4j.propertis的配置文件,内容如下
log4j.rootLogger=debug,console
#Output to console
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Target=System.out
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%p %d{yyyy-MM-dd HH:mm:ss} %t %C.%M %L-line %m%n
log4j.rootLogger=org.apache.log4j.ConsoleAppender:日志级别及日志输出的位置,debug表示当前日志级别,console表示日志输出的位置,可以指定多个输出位置,如log4j.rootLogger=debug,console,file
log4j.appender.console=org.apache.log4j.ConsoleAppender:定义console输出端,可以是:
org.apache.log4j.ConsoleAppender—控制台
org.apache.log4j.FileAppender—文件
org.apache.log4j.DailyRollingFileAppender —每天产生一个文件
org.apache.log4j.RollingFileAppender —达到指定文件大小后新建一个文件
org.apache.log4j.WriterAppender –将日志以流的形式发送到任何地方
log4j.appender.console.layout=org.apache.log4j.PatternLayout:定义console输出端的layout是哪种类型,可以是:
org.apache.log4j.HTMLLayout —以HTML表格形式布局
org.apache.log4j.PatternLayout —可以灵活地指定布局模式
org.apache.log4j.SimpleLayout—包含日志信息的级别和信息字符串
org.apache.log4j.TTCCLayout —包含日志产生的时间、线程、类别等等信息
log4j.appender.console.layout.ConversionPattern:如果使用pattern布局,就要指定日志的打印格式
%p:日志级别
%d:日期,可以在后面指定日期格式,如%d{yyyy-MM-dd HH:mm:ss}
%t:输出该日志的线程名
%C:类的全限定名
%M:方法名
%L:行号
%m:代码中指定输出的日志信息
%n:换行
3、在web.xml中配置log4j.propertis文件
<context-param>
<param-name>log4jConfigLocation</param-name>
<param-value>classpath:config/log4j.properties</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
</listener>
4、以上的准备工作完成后,接下来在UserController中记录日志测试一下
package com.bug.controller.user;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import com.bug.service.user.IUserService;
@Controller
@RequestMapping("/user")
public class UserController {
private final static Logger logger = LoggerFactory.getLogger(UserController.class);
@Autowired
private IUserService userService;
@RequestMapping("/login")
public String login() {
logger.info("login method start,the parameter is :");
logger.info("UserId:{},{},{}", "1", "longwentao1999", "abcdefg");
return "user/login";
}
}
结果如下,日志级别,时间,线程名,类名,方法名,行号都打印出来了
INFO 2016-12-09 22:15:01 http-bio-8080-exec-3 com.bug.controller.user.UserController.login 23-line login method start,the parameter is :
INFO 2016-12-09 22:15:02 http-bio-8080-exec-3 com.bug.controller.user.UserController.login 24-line userId:1,userName:longwentao1999,password:abcdefg
回到上面遗留的问题,为什么要使用slf4j和log4j,是否注意到,在记录日志的时候,使用的是占位符的方式logger.info(“UserId:{},{},{}”, “1”, “userName:longwentao1999”, “abcdefg”),类似于String中的format,LoggerFactory.getLogger是slf4j中的方法,slf4j允许使用占位符的方式进行字符串的填充,避免字符串的拼接,而log4j是没有这种占位符的实现方式的,因此这里使用了slf4j的方式联合记录日志