Java Language
Registrazione (java.util.logging)

Utilizzo del logger predefinito

Questo esempio mostra come utilizzare l'API di registrazione predefinita.

import java.util.logging.Level;
import java.util.logging.Logger;

public class MyClass {
    
    // retrieve the logger for the current class
    private static final Logger LOG = Logger.getLogger(MyClass.class.getName());
    
    public void foo() {
        LOG.info("A log message");
        LOG.log(Level.INFO, "Another log message");

        LOG.fine("A fine message");
    
        // logging an exception
        try {
            // code might throw an exception
        } catch (SomeException ex) {
            // log a warning printing "Something went wrong"
            // together with the exception message and stacktrace
            LOG.log(Level.WARNING, "Something went wrong", ex);
        }

        String s = "Hello World!";

        // logging an object
        LOG.log(Level.FINER, "String s: {0}", s);

        // logging several objects
        LOG.log(Level.FINEST, "String s: {0} has length {1}", new Object[]{s, s.length()});
    }

}

Livelli di registrazione

Java Logging Api ha 7 livelli . I livelli in ordine decrescente sono:

• SEVERE (valore più alto)
• WARNING
• INFO
• CONFIG
• FINE
• FINER
• FINEST (valore più basso)

Il livello predefinito è INFO (ma dipende dal sistema e utilizza una macchina virtuale).

Nota : ci sono anche dei livelli OFF (può essere usato per disattivare la registrazione) e ALL (la prospettiva di OFF ).

Esempio di codice per questo:

import java.util.logging.Logger;

public class Levels {
    private static final Logger logger = Logger.getLogger(Levels.class.getName());

    public static void main(String[] args) {

        logger.severe("Message logged by SEVERE");
        logger.warning("Message logged by WARNING");
        logger.info("Message logged by INFO");
        logger.config("Message logged by CONFIG");
        logger.fine("Message logged by FINE");
        logger.finer("Message logged by FINER");
        logger.finest("Message logged by FINEST");

        // All of above methods are really just shortcut for
        // public void log(Level level, String msg):
        logger.log(Level.FINEST, "Message logged by FINEST");
    }
}

Per impostazione predefinita, in esecuzione questa classe verranno visualizzati solo i messaggi con livello superiore a CONFIG :

Jul 23, 2016 9:16:11 PM LevelsExample main
SEVERE: Message logged by SEVERE
Jul 23, 2016 9:16:11 PM LevelsExample main
WARNING: Message logged by WARNING
Jul 23, 2016 9:16:11 PM LevelsExample main
INFO: Message logged by INFO

Registrazione di messaggi complessi (in modo efficiente)

Diamo un'occhiata ad un campione di registrazione che puoi vedere in molti programmi:

public class LoggingComplex {
    
    private static final Logger logger = 
        Logger.getLogger(LoggingComplex.class.getName());

    private int total = 50, orders = 20;
    private String username = "Bob";

    public void takeOrder() {
        // (...) making some stuff
        logger.fine(String.format("User %s ordered %d things (%d in total)", 
                                  username, orders, total));
        // (...) some other stuff
    }

    // some other methods and calculations
}

L'esempio sopra sembra perfettamente a posto, ma molti programmatori dimenticano che Java VM è uno stack machine. Ciò significa che tutti i parametri del metodo vengono calcolati prima dell'esecuzione del metodo.

Questo fatto è cruciale per la registrazione in Java, specialmente per la registrazione di qualcosa in livelli bassi come FINE , FINER , FINEST che sono disabilitati di default. Diamo un'occhiata al bytecode Java per il metodo takeOrder() .

Il risultato per javap -c LoggingComplex.class è qualcosa del genere:

public void takeOrder();
    Code:
       0: getstatic     #27 // Field logger:Ljava/util/logging/Logger;
       3: ldc           #45 // String User %s ordered %d things (%d in total)
       5: iconst_3
       6: anewarray     #3  // class java/lang/Object
       9: dup
      10: iconst_0
      11: aload_0
      12: getfield      #40 // Field username:Ljava/lang/String;
      15: aastore
      16: dup
      17: iconst_1
      18: aload_0
      19: getfield      #36 // Field orders:I
      22: invokestatic  #47 // Method java/lang/Integer.valueOf:(I)Ljava/lang/Integer;
      25: aastore
      26: dup
      27: iconst_2
      28: aload_0
      29: getfield      #34 // Field total:I
      32: invokestatic  #47 // Method java/lang/Integer.valueOf:(I)Ljava/lang/Integer;
      35: aastore
      36: invokestatic  #53 // Method java/lang/String.format:(Ljava/lang/String;[Ljava/lang/Object;)Ljava/lang/String;
      39: invokevirtual #59 // Method java/util/logging/Logger.fine:(Ljava/lang/String;)V
      42: return

La riga 39 esegue la registrazione effettiva. Tutto il lavoro precedente (caricamento di variabili, creazione di nuovi oggetti, concatenazione di stringhe nel metodo di format ) può essere inutile se il livello di registrazione è impostato su un valore superiore a FINE (e di default è). Tale registrazione può essere molto inefficiente, consumando risorse di memoria e processore non necessarie.

Ecco perché dovresti chiedere se il livello che vuoi utilizzare è abilitato.

La strada giusta dovrebbe essere:

public void takeOrder() {
    // making some stuff
    if (logger.isLoggable(Level.FINE)) {
        // no action taken when there's no need for it
        logger.fine(String.format("User %s ordered %d things (%d in total)",
                                  username, orders, total));
    }
    // some other stuff
}

Da quando Java 8:

La classe Logger ha metodi aggiuntivi che prendono come parametro un parametro Supplier<String> , che può essere semplicemente fornito da un lambda:

public void takeOrder() {
    // making some stuff
    logger.fine(() -> String.format("User %s ordered %d things (%d in total)",
            username, orders, total));
    // some other stuff
}

Il metodo get() fornitori - in questo caso il lambda - viene chiamato solo quando il livello corrispondente è abilitato e quindi la costruzione if non è più necessaria.