Hướng dẫn sử dụng Java Commons Logging
Công ty Vĩnh Cửu tuyển dụng lập trình viên Java

1- Commons Logging làm gì?

Trong ứng dụng Java của bạn, bạn muốn viết code để log ra thông điệp của ứng dụng trong quá trình làm việc của nó? Bạn có thể sử dụng một trong 3 thư viện Logger sau:
  • Log4J Logger
  • Jdk14 Logger
  • Simple Logger
Commons Logging là một thư viện cho phép bạn làm việc với một trong 3 bộ thư viện trên một cách dễ dàng hơn. Như vậy để viết một chương trình Log, một mình nó không thể là một Logger. Một cách tương tự bạn làm việc với java.io để sử lý vào ra dữ liệu, Commons IO là bộ thư viện viết dựa trên java.io giúp bạn sử lý IO dễ dàng hơn, Common IO không thể thay thế java.io.
Như vậy bạn có 3 lựa chọn:
Việc bạn chọn Logger nào không quan trọng chúng được sử lý một cách giống nhau với sự hỗ trợ của Commons Logging.

2- Mục tiêu của tài liệu hướng dẫn

Trong tài liệu hướng dẫn này tôi sẽ hướng dẫn bạn cách làm việc với:
  • Commons Logging + Log4J Logger

3- Commons Logging + Log4J Logger

3.1- Thư viện

Thư viện Commons Logging:
Maven:
<dependency>
    <groupId>commons-logging</groupId>
    <artifactId>commons-logging</artifactId>
    <version>1.1.3</version>
</dependency>
Thư viện Log4J Logger:
Maven:
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

3.2- Tạo project

  • pom.xml
<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.o7planning</groupId>
    <artifactId>CommonsLoggingTutorial</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
            <version>1.1.3</version>
        </dependency>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
    </dependencies>
    
</project>

3.3- Ví dụ đơn giản HelloWorld (Log ra màn hình Console)

Trong bước này chúng ta sẽ làm một ví dụ đơn giản HelloWorld, nó sẽ ghi Log ra màn hình Console.
  • HelloWorld.java
package org.o7planning.tutorial.commonslogging;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

public class HelloWorld {

    private static final Log log = LogFactory.getLog(HelloWorld.class);

    public static void main(String[] args) {
        log.debug("Example debug message ..");
        log.info("Example info message ..");
        log.warn("Example warn message ..");
        log.error("Example error message ..");
        log.fatal("Example fatal message ..");   
    }
}
  • commons-logging.properties
org.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JLogger

log4j.configuration=log4j.properties
  • log4j.properties
log4j.rootLogger=DEBUG, CA, NTEventLog

#Console Appender
log4j.appender.CA=org.apache.log4j.ConsoleAppender
log4j.appender.CA.layout=org.apache.log4j.PatternLayout
log4j.appender.CA.layout.ConversionPattern=%-4r [%t] %-5p %c %x - %m%n
Trong thực tế bạn có thể cấu hình Commons logging để sử dụng các thư viện Logging khác, không phải log4j:
Chạy class HelloWorld:
Với Log4j bạn có thể cấu hình trên file xml, và việc cấu hình trên xml là dễ dàng và dễ hiểu hơn so với properties.
Mở file commons-logging.properties và thay đổi thành:
org.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JLogger

log4j.configuration=log4j.xml
  • log4j.xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

    <appender name="MyConsole" class="org.apache.log4j.ConsoleAppender">
        <param name="Target" value="System.out" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%-4r [%t] %-5p %c %x - %m%n" />
        </layout>
    </appender>



    <root>
        <priority value="debug" />
        <appender-ref ref="MyConsole" />
    </root>

</log4j:configuration>
Chạy class HelloWorld và xem Log trên màn hình Console:

3.4- Ví dụ phức tạp hơn (Log ra file)

Tiếp theo chúng ta sẽ tiếp tục với một ví dụ phức tạp hơn, ghi Log ra file.
  • AdminApplication.java
package org.o7planning.tutorial.commonslogging.admin;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

public class AdminApplication {

    private static final Log log = LogFactory.getLog(AdminApplication.class);

    public static void main(String[] args) {
        log.debug("Example debug message ..");
        log.info("Example info message ..");
        log.warn("Example warn message ..");
        log.error("Example error message ..");
        log.fatal("Example fatal message ..");

        try {
            raiseException();
        } catch (Exception e) {
            log.fatal("<Some Object>", e);
        }
    }

    private static void raiseException() throws Exception {
        throw new Exception("Test Exception");
    }
}
 
  • FrontEndApplication.java
package org.o7planning.tutorial.commonslogging.frontend;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

public class FrontEndApplication {

    private static final Log log = LogFactory.getLog(FrontEndApplication.class);

    public static void main(String[] args) {
        log.debug("Example debug message ..");
        log.info("Example info message ..");
        log.warn("Example warn message ..");
        log.error("Example error message ..");
        log.fatal("Example fatal message ..");
    }
}

 
Cấu hình thêm vào trong log4j.xml, thêm vào đoạn cấu hình:
  <appender name="AdminFileAppender" class="org.apache.log4j.FileAppender">
      <param name="File" value="logs/admin.log" />
      <layout class="org.apache.log4j.PatternLayout">
          <param name="ConversionPattern"
              value="%d{dd MMM yyyy HH:mm:ss,SSS} {%t} %-5p %c %x - %m%n" />
      </layout>
  </appender>

  <appender name="FrontEndFileAppender" class="org.apache.log4j.FileAppender">
      <param name="File" value="logs/frontEnd.log" />
      <layout class="org.apache.log4j.PatternLayout">
          <param name="ConversionPattern"
              value="%d{dd MMM yyyy HH:mm:ss,SSS} {%t} %-5p %c %x - %m%n" />
      </layout>
  </appender>

  <!-- logger name phải là tên của package! -->
  <logger name="org.o7planning.tutorial.commonslogging.admin">
      <level value="ERROR" />
      <appender-ref ref="AdminFileAppender" />
  </logger>

  <!-- logger name phải là tên của package! -->
  <logger name="org.o7planning.tutorial.commonslogging.frontend">
      <level value="DEBUG" />
      <appender-ref ref="FrontEndFileAppender" />
  </logger>
  • log4j.xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

  <appender name="MyConsole" class="org.apache.log4j.ConsoleAppender">
      <param name="Target" value="System.out" />
      <layout class="org.apache.log4j.PatternLayout">
          <param name="ConversionPattern" value="%-4r [%t] %-5p %c %x - %m%n" />
      </layout>
  </appender>




  <appender name="AdminFileAppender" class="org.apache.log4j.FileAppender">
      <param name="File" value="logs/admin.log" />
      <layout class="org.apache.log4j.PatternLayout">
          <param name="ConversionPattern"
              value="%d{dd MMM yyyy HH:mm:ss,SSS} {%t} %-5p %c %x - %m%n" />
      </layout>
  </appender>

  <appender name="FrontEndFileAppender" class="org.apache.log4j.FileAppender">
      <param name="File" value="logs/frontEnd.log" />
      <layout class="org.apache.log4j.PatternLayout">
          <param name="ConversionPattern"
              value="%d{dd MMM yyyy HH:mm:ss,SSS} {%t} %-5p %c %x - %m%n" />
      </layout>
  </appender>

  <!-- logger name phải là tên của package! -->
  <logger name="org.o7planning.tutorial.commonslogging.admin">
      <level value="ERROR" />
      <appender-ref ref="AdminFileAppender" />
  </logger>

  <!-- logger name phải là tên của package! -->
  <logger name="org.o7planning.tutorial.commonslogging.frontend">
      <level value="DEBUG" />
      <appender-ref ref="FrontEndFileAppender" />
  </logger>


  <root>
      <priority value="debug" />
      <appender-ref ref="MyConsole" />
  </root>

</log4j:configuration>
Có một chú ý về thứ tự các thẻ khi bạn cấu hình log4j.xml:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">

    <!-- render -->
    <renderer></renderer>
    <renderer></renderer>
    <renderer></renderer>
    
    <!-- appender -->
    <appender></appender>
    <appender></appender>
    <appender></appender>
    
    
    <!-- plugin -->
    <plugin></plugin>
    <plugin></plugin>
    <plugin></plugin>
    
    <!-- logger -->
    <logger></logger>
    <logger></logger>
    <logger></logger>
    
    <!-- category -->
    <category></category>
    <category></category>
    <category></category>
    
    <!-- root -->
    <root></root>
    <root></root>
    <root></root>
    
    <!-- loggerfactory -->
    <loggerfactory></loggerfactory>
    <loggerfactory></loggerfactory>
    <loggerfactory></loggerfactory>
    
    <!-- categoryfactory -->
    <categoryfactory></categoryfactory>
    <categoryfactory></categoryfactory>
    <categoryfactory></categoryfactory>

</log4j:configuration>
Chạy class AdminApplication:
Chạy class FrontEndApplication
Một thư mục logs đã được tạo ra và có 2 file log (admin.log & frontEnd.log)