java项目中日志处理 · TUNA-daily

[TOC] ## 1. 什么是log4j？ Log4j是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件，甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。 ## 2. 什么是slf4j？ SLF4J，即简单日志门面（Simple Logging Facade for Java），不是具体的日志解决方案，**它只服务于各种各样的日志系统。** 按照官方的说法，SLF4J是一个用于日志系统的简单Facade，允许最终用户在部署其应用时使用其所希望的日志系统。 **实际上，SLF4J所提供的核心API是一些接口以及一个LoggerFactory的工厂类。** 从某种程度上，SLF4J有点类似JDBC，不过比JDBC更简单，在JDBC中，你需要指定驱动程序，而在使用SLF4J的时候，不需要在代码中或配置文件中指定你打算使用那个具体的日志系统。如同使用JDBC基本不用考虑具体数据库一样，SLF4J提供了统一的记录日志的接口，只要按照其提供的方法记录即可，最终日志的格式、记录级别、输出方式等通过具体日志系统的配置来实现，因此可以在应用中灵活切换日志系统。如果你开发的是类库或者嵌入式组件，那么就应该考虑采用SLF4J，因为不可能影响最终用户选择哪种日志系统。在另一方面，如果是一个简单或者独立的应用，**确定只有一种日志系统，那么就没有使用SLF4J的必要**。假设你打算将你使用log4j的产品卖给要求使用JDK 1.4 Logging的用户时，面对成千上万的log4j调用的修改，相信这绝对不是一件轻松的事情。但是如果开始便使用SLF4J，那么这种转换将是非常轻松的事情。 ## 3. 在Java项目中如何使用log4j和slf4j实现日志打印？ ### 3.1 添加相关jar包 1、log4j 2、slf4j-api 3、slf4j-log4j12 若是maven项目，pom.xml文件中添加配置（x-具体版本号）： ~~~ <slf4j.version>1.7.25</slf4j.version> <log4j.version>1.2.17</log4j.version> <slf4j-log4j12.version>1.7.25</slf4j-log4j12.version>  <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>${log4j.version}</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>${slf4j.version}</version> </dependency> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-log4j12</artifactId> <version>${slf4j-log4j12.version}</version> </dependency> ~~~ ### 3.2 添加log4j配置文件在项目类路径下添加log4j.properties配置文件，具体内容如下： ~~~ ### set log levels ### log4j.rootLogger = DEBUG,stdout,D,E log4j.appender.stdout = org.apache.log4j.ConsoleAppender log4j.appender.stdout.Target = System.out log4j.appender.stdout.Threshold = INFO log4j.appender.stdout.layout = org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss} %l%m%n log4j.appender.D = org.apache.log4j.DailyRollingFileAppender log4j.appender.D.File = F://logs/log.log log4j.appender.D.Append = true log4j.appender.D.Threshold = DEBUG log4j.appender.D.layout = org.apache.log4j.PatternLayout log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n log4j.appender.E = org.apache.log4j.DailyRollingFileAppender log4j.appender.E.File =F://logs/error.log log4j.appender.E.Append = true log4j.appender.E.Threshold = ERROR log4j.appender.E.layout = org.apache.log4j.PatternLayout log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n ~~~ ### 3.3 配置说明 #### 3.3.1 log4j.rootCategory=DEBUG, stdout , D,E 定义日志级别此句为将等级为INFO以上的日志信息输出到stdout和D,E这三个目的地，stdout和D,E的定义在下面的代码，可以任意起名。 #### 3.3.2 等级可分为： OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL 如果配置OFF则不打出任何信息，如果配置为INFO这样只显示INFO, WARN, ERROR的log信息，而DEBUG信息不会被显示。stdout和D,E定义的输出日志级别如log4j.appender.D.Threshold的值必须比log4j.rootLogger定义的级别高才生效。例如：log4j.rootLogger定义的级别为INFO，log4j.appender.D.Threshold定义的级别为DEBUG，D也只会输出INFO以上级别的日志。 #### 3.3.3 log4j.appender.stdout=org.apache.log4j.ConsoleAppender **此句为定义名为stdout的输出端是哪种类型**，可以是： > 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（将日志信息以流格式发送到任意指定的地方） #### 3.3.4 log4j.appender.stdout.layout=org.apache.log4j.PatternLayout **此句为定义名为stdout的输出端的layout是哪种类型，可以是：** > 1. org.apache.log4j.HTMLLayout（以HTML表格形式布局） > 2. org.apache.log4j.PatternLayout（可以灵活地指定布局模式） > 3. org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串） > 4. org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息） #### 3.3.5 log4j.appender.stdout.layout.ConversionPattern= [%-5p] %d{yyyy-MM-dd HH:mm:ss} %l%m%n 如果使用pattern布局就要指定的打印信息的具体格式ConversionPattern，打印参数如下： > %p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL, > %r: 输出自应用启动到输出该log信息耗费的毫秒数 > %c: 输出日志信息所属的类目，通常就是所在类的全名 > %t: 输出产生该日志事件的线程名 > %l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main (TestLog4.Java:10) > %x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像Java servlets这样的多客户多线程的应用中。 > %%: 输出一个"%"字符 > %F: 输出日志消息产生时所在的文件名称 > %L: 输出代码中的行号 > %m: 输出代码中指定的消息,产生的日志具体信息 %n: 输出一个回车换行符，Windows平台为"/r/n"，Unix平台为"/n"输出日志信息换行 %d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式 ### 3.4 在项目的web.xml文件中添加log4j配置 ~~~  <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> ~~~ ### 3.5 在类中添加日志 ~~~ // 导入slf4j类 import org.slf4j.Logger; import org.slf4j.LoggerFactory; // 添加slf4j日志实例对象 private final static Logger logger = LoggerFactory.getLogger(Test.class); // 输出日志 logger.info("输出日志"); ~~~ ### 3.6 启动服务器运行项目 ## 4. 项目中log的问题