Java_日志_log4j

今天药忘吃喽~ 2021-10-06 04:16 392阅读 0赞

### Java\_日志\_log4j ###

*  简述
 *  组件说明
 *   *  Appender
     *  Layout
     *  ConversionPattern
 *  代码中使用
 *   *  导入
     *  读取配置文件
     *  使用
     *  示例配置一
     *  示例配置二

# 简述 #

Log4j是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件，甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

# 组件说明 #

## Appender ##

日志信息输出目的地

org.apache.log4j.ConsoleAppender（控制台）， # 常用 
    org.apache.log4j.FileAppender（文件），  
    org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），  # 常用 
    org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），  
    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:可以指定文件编码格式

## Layout ##

日志信息的格式

org.apache.log4j.HTMLLayout（以HTML表格形式布局），  
    org.apache.log4j.PatternLayout（可以灵活地指定布局模式），   # 常用 
    org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），  
    org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

1、HTMLLayout选项属性

LocationInfo = TRUE:默认值false,输出java文件名称和行号
    Title=Struts Log Message:默认值 Log4J Log Messages

2、PatternLayout选项属性

ConversionPattern = %m%n:格式化指定的消息，参考 ConversionPattern

3、XMLLayout选项属性

LocationInfo = TRUE:默认值false,输出java文件名称和行号

## ConversionPattern ##

日志信息的样式

%m 输出代码中指定的消息
    %p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
    %r 输出自应用启动到输出该log信息耗费的毫秒数
    %c 输出所属的类目，通常就是所在类的全名
    %t 输出产生该日志事件的线程名
    %n 输出一个回车换行符，Windows平台为“rn”，Unix平台为“n”
    %d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
    %l 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。
    %F 输出日志消息产生时所在的文件名称
    %L 输出代码中的行号
    %5p在优先级前面加5个空格

# 代码中使用 #

## 导入 ##

<dependency>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-web</artifactId>
    		<exclusions>
    			<exclusion>
    				<groupId>ch.qos.logback</groupId>
    				<artifactId>logback-classic</artifactId>
    			</exclusion>
    			<exclusion>
    				<groupId>org.slf4j</groupId>
    				<artifactId>log4j-over-slf4j</artifactId>
    			</exclusion>
    		</exclusions>
    	</dependency>
    	<dependency>
    		<groupId>org.slf4j</groupId>
    		<artifactId>slf4j-log4j12</artifactId>
    	</dependency>

## 读取配置文件 ##

方式一：默认方式，无法配置，log4j.properties/xml 放到classpath下即可
    BasicConfigurator.configure ()： 自动快速地使用缺省Log4j环境。   
    方式二：自定义配置文件
    PropertyConfigurator.configure ( String configFilename) ：读取使用Java的特性文件编写的配置文件。  
    DOMConfigurator.configure ( String filename ) ：读取XML形式的配置文件。

如：

PropertyConfigurator.configure("E:\\data-handler\\data_handler\\src\\main\\resources\\log4j-dev.properties");

## 使用 ##

static Logger log = Logger.getLogger ( Test.class);
    
    	log.debug("debugg...");
    	log.info("info...");
    	log.warn("warn...");
    	log.error("error...");

## 示例配置一 ##

# priority  :debug<info<warn<error
    #you cannot specify every priority with different file for log4j 
    log4j.rootLogger=all,stdout,info,debug,error
    
    # 指定特定包的输出特定的级别 
    log4j.logger.com.plxc.data.handler=error
     
    #console
    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=%d{yyyy-MM-dd HH:mm:ss} %5p (%F:%L) - %m%n
    #info log
    log4j.appender.info=org.apache.log4j.DailyRollingFileAppender 
    log4j.appender.info.DatePattern='_'yyyy-MM-dd'.log'
    log4j.appender.info.File=D://logs/test/info.log 
    log4j.appender.info.Append=true
    log4j.appender.info.Threshold=INFO
    log4j.appender.info.layout=org.apache.log4j.PatternLayout 
    log4j.appender.info.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss a} [Thread: %t][ Class:%c >> Method: %l ]%n%p:%m%n
    #debug log
    log4j.appender.debug=org.apache.log4j.DailyRollingFileAppender 
    log4j.appender.debug.DatePattern='_'yyyy-MM-dd'.log'
    log4j.appender.debug.File=D://logs/test/debug.log
    log4j.appender.debug.Append=true
    log4j.appender.debug.Threshold=DEBUG
    log4j.appender.debug.layout=org.apache.log4j.PatternLayout 
    log4j.appender.debug.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss a} [Thread: %t][ Class:%c >> Method: %l ]%n%p:%m%n
    #warn log
    log4j.appender.warn=org.apache.log4j.DailyRollingFileAppender 
    log4j.appender.warn.DatePattern='_'yyyy-MM-dd'.log'
    log4j.appender.warn.File=D://logs/test/warn.log  
    log4j.appender.warn.Append=true
    log4j.appender.warn.Threshold=WARN
    log4j.appender.warn.layout=org.apache.log4j.PatternLayout 
    log4j.appender.warn.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss a} [Thread: %t][ Class:%c >> Method: %l ]%n%p:%m%n
    #error
    log4j.appender.error = org.apache.log4j.DailyRollingFileAppender
    log4j.appender.error.DatePattern='_'yyyy-ww'.log'
    log4j.appender.error.File = D://logs/test/error.log
    log4j.appender.error.Append = true
    log4j.appender.error.Threshold = ERROR 
    log4j.appender.error.layout = org.apache.log4j.PatternLayout
    log4j.appender.error.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss a} [Thread: %t][ Class:%c >> Method: %l ]%n%p:%m%n

## 示例配置二 ##

#OFF,systemOut,logFile,logDailyFile,logRollingFile,logMail,logDB,ALL 
    log4j.rootLogger =ALL,systemOut,logFile,logDailyFile,logRollingFile,logMail,logDB 
    
    #输出到控制台 
    log4j.appender.systemOut = org.apache.log4j.ConsoleAppender 
    log4j.appender.systemOut.layout = org.apache.log4j.PatternLayout 
    log4j.appender.systemOut.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n 
    log4j.appender.systemOut.Threshold = DEBUG 
    log4j.appender.systemOut.ImmediateFlush = TRUE 
    log4j.appender.systemOut.Target = System.out 
    
    #输出到文件 
    log4j.appender.logFile = org.apache.log4j.FileAppender 
    log4j.appender.logFile.layout = org.apache.log4j.PatternLayout 
    log4j.appender.logFile.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH: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 
    
    #按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/dd HH: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.logRollingFile = org.apache.log4j.RollingFileAppender 
    log4j.appender.logRollingFile.layout = org.apache.log4j.PatternLayout 
    log4j.appender.logRollingFile.layout.ConversionPattern = [%-5p][%-22d{yyyy/MM/dd HH: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 
    
    #用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 = Struts2 Mail LogFile 
    log4j.appender.logMail.Threshold = DEBUG 
    log4j.appender.logMail.SMTPDebug = FALSE 
    log4j.appender.logMail.SMTPHost = SMTP.163.com 
    log4j.appender.logMail.From = xly3000@163.com 
    log4j.appender.logMail.To = xly3000@gmail.com 
    #log4j.appender.logMail.Cc = xly3000@gmail.com 
    #log4j.appender.logMail.Bcc = xly3000@gmail.com 
    log4j.appender.logMail.SMTPUsername = xly3000 
    log4j.appender.logMail.SMTPPassword = 1234567 
    log4j.appender.logMail.Subject = Log4j Log Messages 
    #log4j.appender.logMail.BufferSize = 1024 
    #log4j.appender.logMail.SMTPAuth = TRUE 
    
    #将日志登录到MySQL数据库 
    log4j.appender.logDB = org.apache.log4j.jdbc.JDBCAppender 
    log4j.appender.logDB.layout = org.apache.log4j.PatternLayout 
    log4j.appender.logDB.Driver = com.mysql.jdbc.Driver 
    log4j.appender.logDB.URL = jdbc:mysql://127.0.0.1:3306/xly 
    log4j.appender.logDB.User = root 
    log4j.appender.logDB.Password = 123456 
    log4j.appender.logDB.Sql = INSERT INTOT_log4j(project_name,create_date,level,category,file_name,thread_name,line,all_category,message)values('Struts2','%d{yyyy-MM-ddHH:mm:ss}','%p','%c','%F','%t','%L','%l','%m')