Comment gérer le module de journalisation JDK sous-jacent Java
- WBOYavant
- 2023-05-10 14:55:061253parcourir
Commencez par un exemple
L'utilisation de JDK Logging est très simple, comme le montre le code suivant, vous pouvez d'abord utiliser la méthode statique getLogger de la classe Logger pour obtenir un logger, puis vous pouvez utiliser le logger obtenu pour le journal. saisir n'importe où. Par exemple, des appels comme logger.info("Main running.").
package com.bes.logging;
import java.util.logging.Level;
import java.util.logging.Logger;
public class LoggerTest {
private static Loggerlogger = Logger.getLogger("com.bes.logging");
public static void main(String argv[]) {
// Log a FINEtracing message
logger.info("Main running.");
logger.fine("doingstuff");
try {
Thread.currentThread().sleep(1000);// do some work
} catch(Exception ex) {
logger.log(Level.WARNING,"trouble sneezing", ex);
}
logger.fine("done");
}
}Si vous exécutez l'exemple ci-dessus sans apporter de modifications de code ou de configuration JDK, vous constaterez que seul le journal [Main running.] apparaîtra sur la console. Les questions suivantes devraient apparaître dans votre cerveau...
1. Pourquoi les journaux autres que [Main running.] ne sont-ils pas affichés ? Comment les faire apparaître ?
2. Où sont l'heure, le nom de la classe, le nom de la méthode, etc. qui apparaissent dans la sortie du journal ?
3. Pourquoi le journal apparaît-il dans la console ?
4. Un grand système peut avoir de nombreux sous-modules (ce qui peut être simplement compris comme ayant de nombreux noms de packages). Comment contrôler les niveaux de journalisation de ces sous-modules individuellement ?
5. Expansion : le projet log4j populaire d'Apache est-il lié à la journalisation du JDK ? Comment implémenter votre propre LoggerManager ?
Avec ces questions, vous serez peut-être plus intéressé à en savoir plus sur le mécanisme de journalisation du JDK. Ce chapitre analysera pour vous le mécanisme de ce module simple.
Réponse terminologique
Avant une analyse approfondie, vous devez maîtriser les termes suivants
logger : Pour logger, vous devez connaître les aspects suivantslogger:对于logger，需要知道其下几个方面
1,代码需要输入日志的地方都会用到Logger，这几乎是一个JDK logging模块的代言人，我们常常用Logger.getLogger("com.aaa.bbb");获得一个logger，然后使用logger做日志的输出。
2,logger其实只是一个逻辑管理单元，其多数操作都只是作为一个中继者传递别的6d646f3bd37b02dfe0ce571e5054fe2f，比如说：Logger.getLogger(“xxx”)的调用将会依赖于LogManager类，使用logger输入日志信息的时候会调用logger中的所有handler进行日志的输入。
3,logger是有层次关系的，我们可一般性的理解为包名之间的父子继承关系。每个logger通常以java包名为其名称。子logger通常会从父logger继承logger级别、handler、ResourceBundle名(与国际化信息有关)等。
4,整个JVM会存在一个名称为空的root logger，所有匿名的logger都会把root logger作为其父
LogManager：整个JVM内部所有logger的管理，logger的生成、获取等操作都依赖于它，也包括配置文件的读取。LogManager中会有一个Hashtable【private Hashtable35bf2dffdda6a7e3e41e02bf88c5368c> loggers】用于存储目前所有的logger，如果需要获取logger的时候，Hashtable已经有存在logger的话就直接返回Hashtable中的，如果hashtable中没有logger，则新建一个同时放入Hashtable进行保存。
Handler：用来控制日志输出的，比如JDK自带的ConsoleHanlder把输出流重定向到System.err输出，每次调用Logger的方法进行输出时都会调用Handler的publish方法，每个logger有多个handler。我们可以利用handler来把日志输入到不同的地方(比如文件系统或者是远程Socket连接).
Formatter：日志在真正输出前需要进行一定的格式话：比如是否输出时间？时间格式？是否输入线程名？是否使用国际化信息等都依赖于Formatter。
Log Level
LogManager : Gestion de tous les loggers au sein de l'ensemble de la JVM, génération de loggers, des opérations telles que l'acquisition en dépendent, y compris la lecture des fichiers de configuration. Il y aura une table de hachage [enregistreurs privés Hashtable35bf2dffdda6a7e3e41e02bf88c5368c> dans le LogManager pour stocker tous les enregistreurs actuels. Si vous avez besoin d'obtenir l'enregistreur, s'il existe déjà un enregistreur dans la table de hachage, il sera renvoyé. directement à la table de hachage. S'il n'y a pas d'enregistreur, créez-en un nouveau et placez-le dans la table de hachage pour l'enregistrer.
Handler : utilisé pour contrôler la sortie du journal. Par exemple, le ConsoleHanlder fourni avec le JDK redirige le flux de sortie vers la sortie System.err. Chaque fois que la méthode Logger est appelée pour la sortie, la publication du gestionnaire. La méthode est appelée, chaque enregistreur a plusieurs gestionnaires. Nous pouvons utiliser des gestionnaires pour saisir les journaux à différents endroits (tels que les systèmes de fichiers ou les connexions Socket distantes).
Formatter : les journaux doivent être formatés avant d'être réellement générés : par exemple, s'il faut afficher le fichier. temps. ? Format horaire ? Voulez-vous saisir un nom de fil de discussion ? L'utilisation ou non des informations d'internationalisation, etc. dépend du formateur.
Log Level : Inutile de dire que c'est celui qui est facile à comprendre, et c'est aussi pourquoi la journalisation peut nous aider à nous adapter aux différents besoins de granularité de sortie des journaux à différentes étapes du développement et du débogage au déploiement et en ligne. Les niveaux du journal JDK, de haut en bas, sont OFF(231-1)—>SEVERE(1000)—>WARNING(900)—>INFO(800)—>CONFIG(700)—> ; FINE(500)>FINER(400)>FINEST(300)>ALL(-231). La comparaison des niveaux lors de la sortie des journaux dépend de la taille de. le numéro. Comparez. Mais il convient de noter que non seulement les enregistreurs ont des niveaux, les gestionnaires ont également des niveaux. Autrement dit, si un niveau d'enregistreur est FINE et que le client souhaite saisir des journaux de niveau FINE, si le niveau de gestionnaire correspondant à l'enregistreur est INFO, alors les journaux de niveau FINE ne peuvent toujours pas être générés. 🎜🎜Résumé de la relation correspondante🎜🎜LogManager et logger sont dans une relation 1-à-plusieurs. Il n'y a qu'un seul LogManager lorsque l'ensemble de la JVM est en cours d'exécution, et tous les enregistreurs sont dans LogManager 🎜🎜Logger et handler sont dans un. relation plusieurs-à-plusieurs. Lorsque l'enregistreur génère des journaux, tous les gestionnaires seront appelés pour traiter les journaux🎜🎜le gestionnaire et le formateur ont une relation un-à-un. Chaque gestionnaire a un formateur pour formater le journal🎜🎜C'est évident : l'enregistreur et le niveau ont une relation un-à-un, et le gestionnaire et le niveau sont également une relation un-à-un 🎜🎜Configuration de la journalisation : 🎜🎜Le fichier de configuration de journalisation par défaut de JDK est : $JAVA_HOME/jre/lib. /logging.properties. Vous pouvez utiliser la propriété système java.util.logging.config.file pour spécifier le fichier de configuration correspondant par défaut. Le fichier de configuration est remplacé. Le fichier de configuration contient généralement les définitions suivantes : 🎜1， handlers：用逗号分隔每个Handler，这些handler将会被加到root logger中。也就是说即使我们不给其他logger配置handler属性，在输出日志的时候logger会一直找到root logger，从而找到handler进行日志的输入。
2， .level是root logger的日志级别
3， 0827ab9817f5e2ad2bd92ebb7f6baa6b.xxx是配置具体某个handler的属性，比如java.util.logging.ConsoleHandler.formatter便是为ConsoleHandler配置相应的日志Formatter.
4， logger的配置，所有以[.level]结尾的属性皆被认为是对某个logger的级别的定义，如com.bes.server.level=FINE是给名为[com.bes.server]的logger定义级别为FINE。顺便说下，前边提到过logger的继承关系，如果还有com.bes.server.webcontainer这个logger，且在配置文件中没有定义该logger的任何属性，那么其将会从[com.bes.server]这个logger进行属性继承。除了级别之外，还可以为logger定义handler和useParentHandlers(默认是为true)属性，如com.bes.server.handler=com.bes.test.ServerFileHandler(需要是一个extends java.util.logging.Handler的类)，com.bes.server.useParentHandlers=false(意味着com.bes.server这个logger进行日志输出时，日志仅仅被处理一次，用自己的handler输出，不会传递到父logger的handler)。以下是JDK配置文件示例
handlers= java.util.logging.FileHandler,java.util.logging.ConsoleHandler .level= INFO java.util.logging.FileHandler.pattern = %h/java%u.log java.util.logging.FileHandler.limit = 50000 java.util.logging.FileHandler.count = 1 java.util.logging.FileHandler.formatter =java.util.logging.XMLFormatter java.util.logging.ConsoleHandler.level = INFO java.util.logging.ConsoleHandler.formatter =java.util.logging.SimpleFormatter com.xyz.foo.level = SEVERE sun.rmi.transport.tcp.logLevel = FINE
Logging执行原理
Logger的获取
A，首先是调用Logger的如下方法获得一个logger
public static synchronized Logger getLogger(String name) {
LogManager manager =LogManager.getLogManager();
returnmanager.demandLogger(name);
}B,上面的调用会触发java.util.logging.LoggerManager的类初始化工作，LoggerManager有一个静态化初始化块(这是会先于LoggerManager的构造函数调用的~_~)：
static {
AccessController.doPrivileged(newPrivilegedAction<Object>() {
public Object run() {
String cname =null;
try {
cname =System.getProperty("java.util.logging.manager");
if (cname !=null) {
try {
Class clz =ClassLoader.getSystemClassLoader().loadClass(cname);
manager= (LogManager) clz.newInstance();
} catch(ClassNotFoundException ex) {
Class clz =Thread.currentThread().getContextClassLoader().loadClass(cname);
manager= (LogManager) clz.newInstance();
}
}
} catch (Exceptionex) {
System.err.println("Could not load Logmanager \"" + cname+ "\"");
ex.printStackTrace();
}
if (manager ==null) {
manager = newLogManager();
}
manager.rootLogger= manager.new RootLogger();
manager.addLogger(manager.rootLogger);
Logger.global.setLogManager(manager);
manager.addLogger(Logger.global);
return null;
}
});
}从静态初始化块中可以看出LoggerManager是可以使用系统属性java.util.logging.manager指定一个继承自java.util.logging.LoggerManager的类进行替换的，比如Tomcat启动脚本中就使用该机制以使用自己的LoggerManager。
不管是JDK默认的java.util.logging.LoggerManager还是自定义的LoggerManager，初始化工作中均会给LoggerManager添加两个logger，一个是名称为””的root logger，且logger级别设置为默认的INFO；另一个是名称为global的全局logger，级别仍然为INFO。
LogManager”类”初始化完成之后就会读取配置文件(默认为$JAVA_HOME/jre/lib/logging.properties)，把配置文件的属性名e09be6022d700e04aeaa85a5f42fdcb2属性值这样的键值对保存在内存中，方便之后初始化logger的时候使用。
C,A步骤中Logger类发起的getLogger操作将会调用java.util.logging.LoggerManager的如下方法：
Logger demandLogger(String name) {
Logger result =getLogger(name);
if (result == null) {
result = newLogger(name, null);
addLogger(result);
result =getLogger(name);
}
return result;
}可以看出，LoggerManager首先从现有的logger列表中查找，如果找不到的话，会新建一个looger并加入到列表中。当然很重要的是新建looger之后需要对logger进行初始化，这个初始化详见java.util.logging.LoggerManager#addLogger()方法中，改方法会根据配置文件设置logger的级别以及给logger添加handler等操作。
到此为止logger已经获取到了，你同时也需要知道此时你的logger中已经有级别、handler等重要信息，下面将分析输出日志时的逻辑。
日志的输出
首先我们通常会调用Logger类下面的方法，传入日志级别以及日志内容。
public void log(Levellevel, String msg) {
if (level.intValue() < levelValue ||levelValue == offValue) {
return;
}
LogRecord lr = new LogRecord(level, msg);
doLog(lr);
}该方法可以看出，Logger类首先是进行级别的校验，如果级别校验通过，则会新建一个LogRecord对象，LogRecord中除了日志级别，日志内容之外还会包含调用线程信息，日志时刻等；之后调用doLog(LogRecord lr)方法
private void doLog(LogRecord lr) {
lr.setLoggerName(name);
String ebname =getEffectiveResourceBundleName();
if (ebname != null) {
lr.setResourceBundleName(ebname);
lr.setResourceBundle(findResourceBundle(ebname));
}
log(lr);
}doLog(LogRecord lr)方法中设置了ResourceBundle信息(这个与国际化有关)之后便直接调用log(LogRecord record) 方法
public void log(LogRecord record) {
if (record.getLevel().intValue() <levelValue || levelValue == offValue) {
return;
}
synchronized (this) {
if (filter != null &&!filter.isLoggable(record)) {
return;
}
}
Logger logger = this;
while (logger != null) {
Handler targets[] = logger.getHandlers();
if(targets != null) {
for (int i = 0; i < targets.length; i++){
targets[i].publish(record);
}
}
if(!logger.getUseParentHandlers()) {
break;
}
logger= logger.getParent();
}
}很清晰，while循环是重中之重，首先从logger中获取handler，然后分别调用handler的publish(LogRecordrecord)方法。while循环证明了前面提到的会一直把日志委托给父logger处理的说法，当然也证明了可以使用logger的useParentHandlers属性控制日志不进行往上层logger传递的说法。到此为止logger对日志的控制差不多算是完成，接下来的工作就是看handler的了，这里我们以java.util.logging.ConsoleHandler为例说明日志的输出。
public class ConsoleHandler extends StreamHandler {
public ConsoleHandler() {
sealed = false;
configure();
setOutputStream(System.err);
sealed = true;
}ConsoleHandler构造函数中除了需要调用自身的configure()方法进行级别、filter、formatter等的设置之外，最重要的我们最关心的是setOutputStream(System.err)这一句，把系统错误流作为其输出。而ConsoleHandler的publish(LogRecordrecord)是继承自java.util.logging.StreamHandler的，如下所示：
public synchronized void publish(LogRecord record) {
if(!isLoggable(record)) {
return;
}
String msg;
try {
msg =getFormatter().format(record);
} catch (Exception ex){
// We don't want tothrow an exception here, but we
// report theexception to any registered ErrorManager.
reportError(null,ex, ErrorManager.FORMAT_FAILURE);
return;
}
try {
if (!doneHeader) {
writer.write(getFormatter().getHead(this));
doneHeader =true;
}
writer.write(msg);
} catch (Exception ex){
// We don't want tothrow an exception here, but we
// report theexception to any registered ErrorManager.
reportError(null,ex, ErrorManager.WRITE_FAILURE);
}
}方法逻辑也很清晰，首先是调用Formatter对消息进行格式化，说明一下：格式化其实是进行国际化处理的重要契机。然后直接把消息输出到对应的输出流中。需要注意的是handler也会用自己的level和LogRecord中的level进行比较，看是否真正输出日志。
总结
至此，整个日志输出过程已经分析完成。细心的读者应该可以解答如下四个问题了。
1，【Main running.】以外的日志为什么没有输出？怎么让它们也能够出现？
这就是JDK默认的logging.properties文件中配置的handler级别和跟级别均为info导致的，如果希望看到FINE级别日志，需要修改logging.properties文件,同时进行如下两个修改
java.util.logging.ConsoleHandler.level= FINE//修改
com.bes.logging.level=FINE//添加2，日志中出现的时间、类名、方法名等是从哪里输出的？
请参照[java.util.logging.ConsoleHandler.formatter= java.util.logging.SimpleFormatter]配置中指定的java.util.logging.SimpleFormatter类，其publicsynchronized String format(LogRecord record) 方法说明了一切。
public synchronized String format(LogRecord record) { StringBuffer sb = new StringBuffer(); // Minimize memory allocations here. dat.setTime(record.getMillis()); args[0] = dat; StringBuffer text = new StringBuffer(); if (formatter == null) { formatter = new MessageFormat(format); } formatter.format(args, text, null); sb.append(text); sb.append(" "); if (record.getSourceClassName() != null) { sb.append(record.getSourceClassName()); } else { sb.append(record.getLoggerName()); } if (record.getSourceMethodName() != null) { sb.append(" "); sb.append(record.getSourceMethodName()); } sb.append(lineSeparator); String message = formatMessage(record); sb.append(record.getLevel().getLocalizedName()); sb.append(": "); sb.append(message); sb.append(lineSeparator); if (record.getThrown() != null) { try { StringWriter sw = newStringWriter(); PrintWriter pw = newPrintWriter(sw); record.getThrown().printStackTrace(pw); pw.close(); sb.append(sw.toString()); } catch (Exception ex) { } } return sb.toString();}public synchronized String format(LogRecord record) {
StringBuffer sb = new StringBuffer();
// Minimize memory allocations here.
dat.setTime(record.getMillis());
args[0] = dat;
StringBuffer text = new StringBuffer();
if (formatter == null) {
formatter = new MessageFormat(format);
}
formatter.format(args, text, null);
sb.append(text);
sb.append(" ");
if (record.getSourceClassName() != null) {
sb.append(record.getSourceClassName());
} else {
sb.append(record.getLoggerName());
}
if (record.getSourceMethodName() != null) {
sb.append(" ");
sb.append(record.getSourceMethodName());
}
sb.append(lineSeparator);
String message = formatMessage(record);
sb.append(record.getLevel().getLocalizedName());
sb.append(": ");
sb.append(message);
sb.append(lineSeparator);
if (record.getThrown() != null) {
try {
StringWriter sw = newStringWriter();
PrintWriter pw = newPrintWriter(sw);
record.getThrown().printStackTrace(pw);
pw.close();
sb.append(sw.toString());
} catch (Exception ex) {
}
}
return sb.toString();
}3，为什么日志就会出现在控制台？
看到java.util.logging.ConsoleHandler 类构造方法中的[setOutputStream(System.err)]语句，相信你已经明白。
4，大型的系统可能有很多子模块(可简单理解为有很多包名)，如何对这些子模块进行单独的日志级别控制？
在logging.properties文件中分别对各个logger的级别进行定义，且最好使用java.util.logging.config.file属性指定自己的配置文件。
Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!