@Repository("djo")

28
février
2008

Un article de djo.mos Comments

Si vous utilisez Log4j dans vos projets, et si en plus vous êtes sur Java >= 5, alors log5j devrait vous intéresser.
C’est un tout petit projet hébergé dans Google Code et qui se contente de présenter une interface moderne à Log4j, en utilisant les varargs mais surtout java.util.Formatter, le tout pour éviter l’erreur très répandue que voici:

log.debug("Nom="+nom+", prenom="+prenom);

On sait tous que la charge induite lors de la vérification du niveau de log est très réduite pour Log4j, mais c’est pas le cas tout le temps, et certainement pas avec un tas d’instructions comme celle au dessus.

En effet, quelque soit le niveau de log défini (disons info par exemple), cette instruction va induire une charge qui est la génération de la chaine passée au logger, ce qui peut être très couteux avec des milliers d’occurences ~~décimées~~ disséminées le long du code.

La bonne manière de procéder serait de vérifier d’abord si le logger est en mode debug avant d’appeler la méthode debug, mais ceci peut vite devenir pénible et casse gueule: on décide de changer le debug en warn sans toutefos changer le test du if xD, etc.

Log5j offre une solution élégante à ce problème, en surchargant les 5 méthodes de log de log4j (debug, info, warn, error, fatal) avec des méthode acceptant un paramètre format et un varargs, ce qui donne:

log.debug("Nom=%s, prenom=%s", nom, prenom);

Log5j s’occupe ensuite de tester si on est au bon niveau de log, et si c’est le cas il utilise java.util.Formatter pour générer la chaine résultante et la passer à Log4j.

Enfin, Log5j offre un autre goodie qui est la simplification de la déclaration du logger: Qui n’a jamais mal-usé du copier/coller de la (longue) déclaration d’un Logger en oubliant de changer la classe passée comme paramètre ?
Ainsi, ceci (Log4j)

private static final Logger log = Logger.getLogger(MaClasse.class);

devient (log5j):

private static final Logger log = Logger.getLogger();

Et ce pour un même résultat.

Pour finir, la bête (le jar) ne fait que 3Ko, et est composé d’une seule classe (com.spinn3r.log5j.Logger)

6 Commentaires + Ajouter un commentaire

rems_ 28 février 2008 à 14 h 21 min

J’ai oublié de donner un exemple d’appel

  
  public static Logger make() {  
    return Logger.getLogger(StackUtil.getCaller(false));  
  }  

Connectez-vous pour répondre
rems_ 28 février 2008 à 14 h 18 min

Concernant le tip pour déclarer le logger de cette facon :

  
private static final Logger log = Logger.getLogger();  

vous pouvez consulter ce billet

http://www.javaspecialists.eu/archive/Issue137.html

principalement cette partie (vers la fin)

  
package com.cretesoft.tjsn;  
  
import org.apache.log4j.Logger;  
  
public class LoggerFactory {  
  public static Logger make() {  
  Throwable t = new Throwable();  
  StackTraceElement directCaller = t.getStackTrace()[1];  
  return Logger.getLogger(directCaller.getClassName());  
  }  
}  

Dans un environnement utilisant un JDK inférieur à 1.4 (oui, je sais, mais ca existe encore, la preuve est que je n’ai pas le choix), il n’y a pas encore de notion de StackTraceElement ; l’astuce consiste alors a écrire la stack trace dans un flux particulier.

Un exemple tres vite fait (avec toute la javadoc bien sur) :

  
  
public class StackUtil {  
  public static final String getCaller() {  
    return getCaller(false);  
  }  
  
  public static final String getCaller(boolean withMethodName) {  
    Throwable t = new Throwable();  
    StackPrinter writer = new StackPrinter(System.err, withMethodName);  
    t.printStackTrace(writer);  
    return writer.getCaller();  
  }  
}  
  
  
class StackPrinter extends PrintStream {  
  
  public StackPrinter(OutputStream out, boolean method) {  
    super(out);  
    this.withMethodName = method;  
  }  
  
  private boolean withMethodName;  
  
  private Collection stack = new LinkedList();  
  
  public Collection getStackTrace() {  
    return stack;  
  }  
  public String getCaller() {  
    for (Iterator it = stack.iterator(); it.hasNext();) {  
      String caller = it.next().toString();  
      //example : "  at com.company.util.log.LogFactory.make(LogFactory.java:29)"  
      caller = caller.trim();  
      int delim1 = caller.indexOf(' ');  
      int delim2 = caller.indexOf('(');  
      if (delim1 >= 0 && delim2 > delim1) {  
        String method = "";  
        caller = caller.substring(delim1, delim2).trim();  
        int lastDot = caller.lastIndexOf('.');  
        if (lastDot > 0) {  
          if (Character.isLowerCase(caller.charAt(lastDot + 1))) {  
            // method name  
            method = caller.substring(lastDot + 1);  
            caller = caller.substring(0, lastDot);  
          }  
        }  
  
        if (caller.startsWith("com.company") && !StackUtil.class.getName().equals(caller)) {  
          if (withMethodName && !"".equals(method)) {  
            return caller + "." + method;  
          }  
          return caller;  
        }  
      }  
    }  
    return "";  
  }  
  
  public void println(Object obj) {  
    stack.add(obj.toString());  
  }  
  
  public void println(String data) {  
    stack.add(data);  
  }  
  
}  

Comment ca, « c’est laid » ? Je trouve ca super drole moi

Connectez-vous pour répondre
lunatix 28 février 2008 à 13 h 36 min

sinon, ca fait un moment que je veux jeter un oeil sur Logback , mais j’ai pas encore eu le temps.

Connectez-vous pour répondre
djo.mos 28 février 2008 à 10 h 53 min

@lunatix: Oui en effet, j’ai remarqué ça aussi … bon, vais certainement y jeter un coup d’oeil, même si je deteste vraiment son nom (slf4j).

@zedros: Tout à fait, c’est corrigé ! xD

Connectez-vous pour répondre
joseph_p 28 février 2008 à 9 h 26 min

salut

chtite remarque :
milliers d’occurences décimées le long du code
ne devrait pas plutôt être :
milliers d’occurrences disséminées le long du code ?

voili

++
Joseph en mode pointilleux

Connectez-vous pour répondre
lunatix 28 février 2008 à 1 h 11 min

intéressant. moi perso, je suis passé a slf4j a la place de common loggin (http://www.slf4j.org/), j’utilise rarement log4j en direct.

ca permet aussi de s’affranchir de la concatenation de texte avec une api du genre
logger.debug(« je veux logger {} et aussi {} », var1, var2);

bon nombre de projets sont en train de passer a cette api (spring, hibernate etc…)
et en plus, pour remplacer common loggin, y’a juste un jar a mettre qui reprendre l’exacte api de l’ancienne lib, en attendant d’aller corriger tout le code.

Connectez-vous pour répondre