Log4j là một logging framework được sử dụng để theo dõi, ghi nhận những thông tin mà chúng ta muốn khi ứng dụng của chúng ta chạy. Trong bài viết này, chúng ta sẽ cùng tìm hiểu tổng quan về Log4j 1.x và các thành phần của nó các bạn nhé!
Tạo project
Để các bạn có thể dễ hình dung, mình sẽ tạo một project Maven sử dụng Log4j, cấu trúc của project như sau:
Tiếp theo, mình sẽ thêm dependency của Log4j vào project của chúng ta bằng cách sửa tập tin của Maven pom.xml như sau:
|
1 2 3 4 5 6 7 |
<dependencies> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency> </dependencies> |
Sau khi thêm, project của chúng ta sẽ có các dependencies như sau:
Để làm việc với Log4j phiên bản 1.x, chúng ta cần một tập tin cấu hình cho nó với tên gọi mặc định là log4j.xml nằm trong thư mục /src/main/resources. Bây giờ, mình sẽ tạo tập tin này:
và thêm một ví dụ các cấu hình cần thiết cho Log4j để nó có thể làm việc được. Nội dung của tập tin log4j.xml của mình như sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE log4j:configuration PUBLIC "-//APACHE//DTD LOG4J 1.2//EN" "log4j.dtd"> <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/"> <!-- Appenders --> <appender name="console" class="org.apache.log4j.ConsoleAppender"> <param name="Target" value="System.out" /> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%-5p: %c - %m%n" /> </layout> </appender> <!-- Root Logger --> <root> <priority value="info" /> <appender-ref ref="console" /> </root> </log4j:configuration> |
Bây giờ, mình sẽ tạo một lớp Log4jExample để khi chạy, lớp này sẽ sử dụng Log4j và in ra console dòng chữ “Welcome to Log4j!”.
Nội dung của lớp Log4jExample như sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 |
package com.huongdanjava.log4j; import org.apache.log4j.Logger; public class Log4jExample { private static Logger logger = Logger.getLogger(Log4jExample.class); public static void main(String[] args) { logger.info("Welcome to Log4j!"); } } |
Kết quả
Như các bạn thấy, chỉ với bấy nhiêu bước như trên, chúng ta đã có thể làm việc với Log4j rồi. Trong phần tiếp theo, chúng ta sẽ cùng tìm hiểu tổng quan về các thành phần của Log4j tương ứng với ví dụ mà mình vừa làm các bạn nhé!
Các thành phần của log4j
Log4j có 3 thành phần chính để nó có thể làm việc được, đó là:
Đối tượng Logger: đảm nhận việc định nghĩa thông tin nào cần được log.
Trong ví dụ của mình, đối tượng Logger được sử dụng trong lớp Log4jExample để log dòng chữ “Welcome to Log4j!”.
Ngoài ra, chúng ta còn có một đối tượng gọi là Root Logger dùng để định nghĩa cấu hình chung cho tất cả các đối tượng Logger trong ứng dụng của chúng ta. Trong tập tin log4j.xml, các bạn thấy chúng ta có thẻ <root>, thẻ này chính là thẻ dùng để định nghĩa cấu hình cho Root Logger.
Đối tượng Appender: đảm nhận việc thông tin sẽ được log ở đâu.
Trong tập tin log4j.xml của ví dụ trên, mình đã định nghĩa một đối tượng Appender là ConsoleAppender để ghi thông tin cần log ra console.
Đối tượng Layout: đảm nhận việc định nghĩa định dạng của thông tin cần log.
Trong đối tượng ConsoleAppender trong ví dụ trên, mình đã sử dụng đối tương PatternLayout để định dạng thông tin cần log.
Và các thành phần hỗ trợ, bao gồm:
- Đối tượng Level: định nghĩa độ ưu tiên của các thông tin cần log. Đối tượng này định nghĩa 7 cấp độ cần log của các thông tin: OFF, DEBUG, INFO, ERROR, WARN, FATAL và ALL.
- Đối tượng Filter: đối tượng này được sử dụng để phân tích các thông tin rồi quyết định thông tin đó có cần log hay không?
- Đối tượng ObjectRenderer: được sử dụng để định nghĩa một đối tượng Java được log dưới dạng chuỗi sẽ như thế nào?
- Đối tượng LogManager: đối tượng này dùng để quản lý logging framework.
