ใน Java วิธีสร้างระดับการบันทึกของคุณเองโดยใช้ Log4j (การกำหนดค่า Log4j 2)

เผยแพร่แล้ว: 2017-07-26
ใน Java วิธีสร้างระดับการบันทึกของคุณเองโดยใช้ Log4j 2

หากคุณต้องการเพิ่มระดับการบันทึกของคุณเองใน Log4j คุณสามารถทำได้ดังนี้ คุณจะต้องสร้างคลาสของคุณเองซึ่งจะขยายจาก Level , Custom Log Levels ด้วย Apache Log4j 2

Log4j เป็น logging framework ที่ง่ายและยืดหยุ่น การบันทึกช่วยให้นักพัฒนามีบริบทโดยละเอียดสำหรับความล้มเหลวของแอปพลิเคชัน ด้วย log4j คุณสามารถเปิดใช้งานการบันทึกที่รันไทม์โดยไม่ต้องแก้ไขไบนารีของแอปพลิเคชัน

แพ็คเกจ log4j ได้รับการออกแบบเพื่อให้คำสั่งเหล่านี้ยังคงอยู่ในรหัสที่จัดส่งโดยไม่ก่อให้เกิดค่าใช้จ่ายด้านประสิทธิภาพจำนวนมาก

วิธีสร้างระดับการบันทึกของคุณเองใน Log4j (การกำหนดค่า Log4j)

Log4j อนุญาตให้บันทึกคำขอพิมพ์ไปยังหลายปลายทาง ในการพูด log4j ปลายทางของเอาต์พุตจะเรียกว่า appender โดยจะแตกต่างกันไปตั้งแต่คอนโซล ไฟล์ ส่วนประกอบ GUI เซิร์ฟเวอร์ซ็อกเก็ตระยะไกลไปจนถึง JMS

ไฟล์ Jar ที่คุณต้องการ

นี่คือการพึ่งพา Maven:

1
2
3
4
5
< dependency >
< groupId > log4j < / groupId >
< artifactId > log4j < / artifactId >
< version > 2.16.0 < / version >
< / dependency >

อัปเดต Log4j เป็นเวอร์ชันล่าสุด

CVE-2021-44228: คุณสมบัติ Apache Log4j2 <=2.14.1 JNDI ที่ใช้ในการกำหนดค่า ข้อความบันทึก และพารามิเตอร์ไม่ได้ป้องกัน LDAP ที่ควบคุมโดยผู้โจมตีและปลายทางอื่นที่เกี่ยวข้องกับ JNDI

จาก log4j 2.16.0 ลักษณะการทำงานนี้ถูกปิดใช้งานโดยค่าเริ่มต้น

คุณต้องวางไฟล์ log4j.xml ไว้ใต้โฟลเดอร์ /resources :

ไฟล์ log4j.xml ในโฟลเดอร์ทรัพยากร

นี่คือตัวอย่างโค้ด Java สำหรับ:

  • Log4j Logging สำหรับระดับบันทึกที่กำหนดเองใน Java
  • การสร้างระดับการบันทึกของคุณเองใน log4j
  • ตัวอย่างบันทึกที่กำหนดเองของ log4j

CrunchifyLog4jLevel.java

Java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
package com . crunchify . tutorials ;
import org . apache . log4j . Level ;
 
/**
* @author Crunchify.com
*
*/
 
@SuppressWarnings ( "serial" )
public class CrunchifyLog4jLevel extends Level {
 
     /**
     * Value of CrunchifyLog4jLevel level. This value is lesser than DEBUG_INT and higher
     * than TRACE_INT}
     */
     public static final int CRUNCHIFY_INT = DEBUG_INT - 10 ;
 
     /**
     * Level representing my log level
     */
     public static final Level CRUNCHIFY = new CrunchifyLog4jLevel ( CRUNCHIFY_INT , "CRUNCHIFY" , 10 ) ;
 
     /**
     * Constructor
     */
     protected CrunchifyLog4jLevel ( int arg0 , String arg1 , int arg2 ) {
         super ( arg0 , arg1 , arg2 ) ;
 
     }
 
     /**
     * Checks whether logArgument is "CRUNCHIFY" level. If yes then returns
     * CRUNCHIFY}, else calls CrunchifyLog4jLevel#toLevel(String, Level) passing
     * it Level#DEBUG as the defaultLevel.
     */
     public static Level toLevel ( String logArgument ) {
         if ( logArgument ! = null && logArgument.toUpperCase().equals("CRUNCHIFY")) {
            return CRUNCHIFY;
         }
         return ( Level ) toLevel ( logArgument , Level . DEBUG ) ;
     }
 
     /**
     * Checks whether val is CrunchifyLog4jLevel#CRUNCHIFY_INT. If yes then
     * returns CrunchifyLog4jLevel#CRUNCHIFY, else calls
     * CrunchifyLog4jLevel#toLevel(int, Level) passing it Level#DEBUG as the
     * defaultLevel
     *
     */
     public static Level toLevel ( int val ) {
         if ( val == CRUNCHIFY_INT ) {
             return CRUNCHIFY ;
         }
         return ( Level ) toLevel ( val , Level . DEBUG ) ;
     }
 
     /**
     * Checks whether val is CrunchifyLog4jLevel#CRUNCHIFY_INT. If yes
     * then returns CrunchifyLog4jLevel#CRUNCHIFY, else calls Level#toLevel(int, org.apache.log4j.Level)
     *
     */
     public static Level toLevel ( int val , Level defaultLevel ) {
         if ( val == CRUNCHIFY_INT ) {
             return CRUNCHIFY ;
         }
         return Level . toLevel ( val , defaultLevel ) ;
     }
 
     /**
     * Checks whether logArgument is "CRUNCHIFY" level. If yes then returns
     * CrunchifyLog4jLevel#CRUNCHIFY, else calls
     * Level#toLevel(java.lang.String, org.apache.log4j.Level)
     *
     */
     public static Level toLevel ( String logArgument , Level defaultLevel ) {
         if ( logArgument ! = null && logArgument.toUpperCase().equals("CRUNCHIFY")) {
            return CRUNCHIFY;
         }
         return Level . toLevel ( logArgument , defaultLevel ) ;
     }
}

ต้องอ่านอีก:

  • จะเริ่มหยุดเซิร์ฟเวอร์ Apache Tomcat ผ่าน Command Line ได้อย่างไร (ตั้งค่าเป็น Windows Service)
  • สร้างและปรับใช้ Web Service และ Web Service Client อย่างง่ายใน Eclipse

นี่คือเนื้อหาของไฟล์ log4j.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
<? xml version = "1.0" encoding = "UTF-8" ?>
< ! DOCTYPE log4j : configuration SYSTEM "log4j.dtd" >
< log4j : configuration xmlns : log4j = "http://jakarta.apache.org/log4j/"
     debug = "false" >
 
     < ! -- FILE Appender -- >
     < appender name = "FILE" class = "org.apache.log4j.FileAppender" >
         < param name = "File" value = "c:/crunchify.log" / >
         < param name = "Append" value = "false" / >
         < layout class = "org.apache.log4j.PatternLayout" >
             < param name = "ConversionPattern" value = "%t %-5p %c - %m%n" / >
         < / layout >
     < / appender >
 
     < ! -- CONSOLE Appender -- >
     < appender name = "CONSOLE" class = "org.apache.log4j.ConsoleAppender" >
         < layout class = "org.apache.log4j.PatternLayout" >
             < param name = "ConversionPattern" value = "%d{ISO8601} %-5p [%c{1}] %m%n" / >
         < / layout >
     < / appender >
 
     < ! -- Limit Category and Specify Priority -- >
     < category name = "com.crunchify" >
         < priority value = "CRUNCHIFY" class = "com.crunchify.tutorials.CrunchifyLog4jLevel" / >
         < appender - ref ref = "CONSOLE" / >
     < / category >
 
     < ! -- Setup the Root category -- >
     < root >
         < appender - ref ref = "CONSOLE" / >
     < / root >
< / log4j : configuration >

CrunchifyLog4jLevelTest.java

Java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
package com . crunchify . tutorials ;
 
import org . apache . log4j . Level ;
import org . apache . log4j . Logger ;
import com . crunchify . tutorials . CrunchifyLog4jLevel ;
 
/**
* Tests whether the new log level
* com.crunchify.tutorials.CrunchifyLog4jLevel#CRUNCHIFY} is working
*
* @author Crunchify.com
*
*/
public class CrunchifyLog4jLevelTest {
 
     public static void main ( String [ ] args ) {
         Logger logger = Logger . getLogger ( CrunchifyLog4jLevelTest . class ) ;
         logger . log ( CrunchifyLog4jLevel . CRUNCHIFY , "I am CrunchifyLog4jLevelTest log" ) ;
         logger . log ( Level . DEBUG , "I am a DEBUG message" ) ;
     }
}

เรียกใช้โปรแกรมทดสอบ และคุณควรเห็นประเภทผลลัพธ์ด้านล่างใน Eclipse's Console

1
2
2013 - 08 - 01 15 : 22 : 36 , 758 CRUNCHIFY [ CrunchifyLog4jLevelTest ] I am CrunchifyLog4jLevelTest log
2013 - 08 - 01 15 : 22 : 36 , 758 DEBUG [ CrunchifyLog4jLevelTest ] I am a DEBUG message

ค่า int ที่คุณระบุสำหรับระดับบันทึกของคุณมีความสำคัญ ที่นี่ฉันได้กำหนดระดับบันทึก " CRUNCHIFY " ให้สูงกว่าระดับ DEBUG แต่ต่ำกว่าระดับ TRACE ที่ log4j ให้ไว้

ดังนั้นเมื่อใดก็ตามที่คุณตั้งค่าระดับความสำคัญเป็น DEBUG ในหมวดหมู่ (ในไฟล์ log4j.xml ของคุณ) บันทึกระดับ CRUNCHIFY จะ ไม่ ส่งไปยังไฟล์บันทึก