Preface :
This article describes how to use the Logging API in Java programs. It includes an example for creating a HTML logger.
OVERVIEW :
- LOGGING IN JAVA
The JDK contains the "Java Logging API". Via a logger you can save text to a central place to report on errors, provide additional information about your program, etc. This logging API allows to configure how messages are written by which class with which priority.
- CREATE A LOGGER
The package java.util.logging provides the logging capabilities via the class Logger. To create a logger in your Java coding :
- import java.util.logging.Logger;
- private final static Logger LOGGER = Logger.getLogger(MyClass.class .getName());
The log levels define the severity of a message. The class Level is used to define which messages should be written to the log. The following lists the Log Levels in descending order :
In addition to that you have also the levels OFF and ALL to turn the logging of or to log everything. For example the following will set the logger to level info which means all messages with severe, warning and info will be logged :
- LOGGER.setLevel(Level.INFO);
Each logger can have access to several handler. The handler receives the log message from the logger and exports it to a certain target. A handler can be turn off withsetLevel(Level.OFF) and turned on with setLevel(...). You have several standard handler, e.g.
Log Levels INFO and higher will be automatically written to the console.
- FORMATTER
Each handlers output can be configured with a formatter. Below are Available formatters :
You can also build your own formatter. The following is an example of a formatter which will use create HTML output :
-
package test.logging;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.logging.Formatter;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.LogRecord;
//This custom formatter formats parts of a log record to a single line
public class MyHtmlFormatter extends Formatter
{
// This method is called for every log records
@Override
public String format(LogRecord rec)
{
StringBuffer buf = new StringBuffer(1000);
// Bold any levels >= WARNING
buf.append("<tr>");
buf.append("<td>");
if (rec.getLevel().intValue() >= Level.WARNING.intValue())
{
buf.append("<b><font color='red'>");
buf.append(rec.getLevel());
buf.append("</font></b>");
} else
{
buf.append(rec.getLevel());
}
buf.append("</td>");
buf.append("<td>");
buf.append(calcDate(rec.getMillis()));
buf.append(' ');
buf.append(formatMessage(rec));
buf.append('\n');
buf.append("</td>");
buf.append("</tr>\n");
return buf.toString();
}
private String calcDate(long millisecs)
{
SimpleDateFormat date_format = new SimpleDateFormat("MMM dd,yyyy HH:mm");
Date resultdate = new Date(millisecs);
return date_format.format(resultdate);
}
// This method is called just after the handler using this
// formatter is created
@Override
public String getHead(Handler h)
{
return "<HTML>\n<HEAD>\n" (new Date()) "\n</HEAD>\n<BODY>\n<PRE>\n"
"<table border>\n "
"<tr><th>Time</th><th>Log Message</th></tr>\n";
}
// This method is called just after the handler using this
// formatter is closed
@Override
public String getTail(Handler h)
{
return "</table>\n </PRE></BODY>\n</HTML>\n";
}
}
The log manager is responsible for creating and managing the logger and the maintenance of the configuration. We could set the logging level for a package, or even a set of packages, by calling the LogManager.setLevel(String name, Level level) method. So, for example, we could set the logging level of all loggers "logging" to Level.FINE by making this call :
- LogManager.getLogManager().setLevel("logging", Level.FINE);
It is common practice to use the fully qualified name of each class whose activity is being logged as a message category because this allows developers to fine-tune log settings for each class. Using the fully qualified class name of your class as the name of your Logger is the approach recommended by the Logging API documentation.
EXAMPLE :
Create your own formatter :
- MyHtmlFormatter.java : Refer to previous FORMATTER example.
Initialize the logger :
- MyLogger.java :
- package test.logging;
- import java.io.IOException;
- import java.util.logging.FileHandler;
- import java.util.logging.Formatter;
- import java.util.logging.Level;
- import java.util.logging.Logger;
- import java.util.logging.SimpleFormatter;
- public class MyLogger {
- static private FileHandler fileTxt;
- static private SimpleFormatter formatterTxt;
- static private FileHandler fileHTML;
- static private Formatter formatterHTML;
- static public void setup() throws IOException {
- // Create Logger
- Logger logger = Logger.getLogger("");
- logger.setLevel(Level.INFO);
- fileTxt = new FileHandler("Logging.txt");
- fileHTML = new FileHandler("Logging.html");
- // Create txt Formatter
- formatterTxt = new SimpleFormatter();
- fileTxt.setFormatter(formatterTxt);
- logger.addHandler(fileTxt);
- // Create HTML Formatter
- formatterHTML = new MyHtmlFormatter();
- fileHTML.setFormatter(formatterHTML);
- logger.addHandler(fileHTML);
- }
- }
- UseLogger.java
- package test.logging;
- import java.io.IOException;
- import java.util.logging.Level;
- import java.util.logging.Logger;
- public class UseLogger {
- // Always use the classname, this way you can refactor
- private final static Logger LOGGER = Logger.getLogger(UseLogger.class.getName());
- public void writeLog() {
- // Set the LogLevel to Severe, only severe Messages will be written
- LOGGER.setLevel(Level.SEVERE);
- LOGGER.severe("Info Log");
- LOGGER.warning("Info Log");
- LOGGER.info("Info Log");
- LOGGER.finest("Really not important");
- // Set the LogLevel to Info, severe, warning and info will be written
- // Finest is still not written
- LOGGER.setLevel(Level.INFO);
- LOGGER.severe("Severe Log");
- LOGGER.warning("Warn Log");
- LOGGER.info("Info Log");
- LOGGER.finest("Really not important");
- }
- public static void main(String[] args) {
- UseLogger logger = new UseLogger();
- try {
- MyLogger.setup();
- } catch (IOException e) {
- e.printStackTrace();
- throw new RuntimeException("Problems with creating the log files");
- }
- logger.writeLog();
- }
- }
And the txt file :
SUPPLEMENT :
* 記錄（Logging）: 簡 介 Logging
* 記錄（Logging）: Logging 的層級
* 記錄（Logging）: Handler、 Formatter
* 記錄（Logging）: 自 訂 Formatter
* 記錄（Logging）: 自 訂 Handler
* 記錄（Logging）: 自 訂 Filter
* 記錄（Logging）: Logger 階層關係
沒有留言:
張貼留言