Buscando una manera más fácil de escribir declaraciones de impresión de depuración en Java

Question

EDITAR: Me encantaría leer las reacciones al enfoque de AOP de Steve Reed. Comentarios a su respuesta son alentados!

Soy un novato, y en algún momento me di cuenta de que sería útil conocer el contenido de una variable durante la ejecución del programa. Así que comencé a hacer esto:

EDITAR: solucionado esto. Solía ​​ser: var + ":" + var, que era totalmente erróneo. Tonto tonto.

System.err.println ("var: " + var); 

Más tarde me enteré de que esto era una práctica común. Al menos, cuando un depurador no estaba disponible o no deseado.

Puedo usar un editor de texto básico, y escribiendo el comunicado de impresión cada vez que necesito para depurar una variable es bastante tedioso, así que pensé, ¿por qué no algo como esto:

void dbug (Object obj) 
{ 
    String variableName = obj.somehowGetVariableName(); 
    String variableContents = obj.toString(); 
    System.out.println (variableName +": " + variableContents); 
} 

Pero al parecer conseguir la variable nombre es más fácil decirlo que hacerlo.

java-reflection-how-to-get-the-name-of-a-variable

estoy atascado con:

System.err.println ("var: " + var); 

O hay una versión abreviada popular de esto?

Answer 1

No trataría de escribir ningún método elegante sobre la impresión de información de depuración. Simplemente quédese con LOG.debug(...) si está usando un registrador o System.err.println(...) de lo contrario.

Es posible que desee utilizar String.format("var=%s val=%s", "VarName", val) en lugar de la concatenación de cadenas.

Asegúrese de anular el método toString en cada una de sus clases para proporcionar información significativa sobre la depuración.

Al final del día, a menudo es más fácil iniciar el depurador y observar lo que sucede en lugar de tener que rastrear un montón de líneas de depuración registradas.

El único momento en que utilizaría el tipo de método de depuración sería si mi aplicación mantuviera todo el estado dentro de un mapa que podría imprimir fácilmente los pares de valores clave (por ejemplo, el mapa de sesión en una aplicación web) .

Answer 2

Tenga una mirada en Simple Logging Framework, que le permite escribir:

class Example { 
    static final org.slf4j.Logger LOG = org.slf4j.LoggerFactory.getLogger(Example.class); 

    void doSomething(Object obj1, Object obj2) { 
     LOG.debug("This is object 1: {}, and this is object 2: {}", obj1, obj2); 
    } 
} 

Answer 3

Algunos pensamientos:

1. Me gustaría poner en práctica toString() en objetos de interés, y en ese imprimir los miembros de una forma amigable moda (por ejemplo, convertir las marcas de tiempo a un formato legible, etc.). Normalmente me elegir un formato como:

   Object[member1=,member2=...] 
   

   impresión de lo contrario el objeto solo le dará el nombre de clase, más el código hash de identidad, y (como usted ha descubierto) que no es enormemente útil!

   Commons tiene una facilidad de do this automatically. Pero aquí hay un simple toString()tutorial que creo que es más apropiado.

2. Existen marcos de registro que pueden interesarle en el futuro. p.ej. echa un vistazo a Log4j. Por el momento, sin embargo, no me preocuparía por eso.

Answer 4

Personalmente, no sugiero usar declaraciones sysout en ningún lado. Siempre debe usar un depurador (usando algún IDE). No puedo imaginar dónde no se querría esto.

De lo contrario, sugiero marcos de registro como log4j, pero una vez más, esto ya se vuelve más complicado donde volvería a cambiar a un IDE real con depurador.

Answer 5

creo que System.err.format es lo que quiere:

System.err.format("var: %s\n", var); 

es una abreviatura para:

System.err.println(String.format("var: %s", var)); 

Answer 6

Puede obtener acceso a los nombres de variables con AOP y en tiempo de compilación tejer. Lo bueno de esto es que si no haces el tejido, no agregas el código de registro de depuración y, como resultado, tu código de tiempo de ejecución es más rápido y más ágil.

Aquí hay un ejemplo del uso de AspectJ para lanzar una excepción cuando un campo está configurado como nulo. Tenga en cuenta el uso de "joinPoint.getSignature()" para obtener acceso a los metadatos del código.

@Aspect 
public class NotNullValidator { 

    @Pointcut(value = "set(@com.acme.NotNull * *.*) && args(valueBeingSet)") 
    private void setOfNonNullField(final Object valueBeingSet) { } 

    @Before(value = "setOfNonNullField(valueBeingSet)") 
    public void validate(final JoinPoint joinPoint, final Object valueBeingSet) { 
     if (valueBeingSet == null) { 
     throw new NullPointerException("Cannot set " + joinPoint.getSignature().getName() + " to null."); 
     } 
    } 
} 

Ver JoinPoint Javadoc para ver qué más se puede obtener (números de línea, fuente y objetos de destino, etc.).

Answer 7

Es un tramo, pero ...

Usted está recibiendo consejos de usar un IDE en lugar de un simple editor de texto. Yo estaría de acuerdo con eso, 100%.

Está recibiendo consejos para utilizar un marco de registro o un depurador en lugar de llamar a println(). Bueno, claro, pero ...

Mejor aún son las pruebas unitarias. No pregunte qué es, cuéntele lo que espera. Entonces, el marco integrado de pruebas unitarias (junit, por lo general) verificará que está obteniendo lo que esperaba. Cuanto más uso las pruebas unitarias, menos necesito depuración y menos necesito println. Y cuando algo cambia, el marco de prueba me dice: no necesito volver a evaluar manualmente la salida de cada prueba, solo mire la barra.

Las pruebas de unidad son mejores que la depuración, mejor que el registro. No son un reemplazo del 100% para la depuración y el registro, pero comienza a usarlos y encontrarás mucha menos necesidad de esas tediosas actividades.

Answer 8

Le recomendaría que configure y use Apache Log4J correctamente. Las líneas System.out o System.err causan una gran cantidad de retraso en la ejecución del programa. (Puede confirmar esto agregando alguna información de tiempo sobre cuánto tiempo tarda su programa sin System.out, etc. y cuánto sin estas líneas.)

Las API de registro utilizan hilos separados para registrar su información de registro en archivos de registro, por eso son más útiles en aplicaciones realistas. Además, las API de registro como Log4J dan mucho control sobre cómo configurar y dar formato a tus registros.Por ejemplo, mire aquí algunos registros generados desde Log4J:

2012-01-05 15:16:41,730 [main] 16 DEBUG dmfssecbuild.IOUtil - 
2012-01-05 15:16:41,730 [main] 16 DEBUG dmfssecbuild.IOUtil - Application Configs Loaded 
2012-01-05 15:16:41,730 [main] 16 DEBUG dmfssecbuild.Constants - Running Application between dates. 
2012-01-05 15:16:41,730 [main] 16 DEBUG dmfssecbuild.Constants - Sat Jan 01 00:00:00 GMT+05:00 2011 From Date 
2012-01-05 15:16:41,730 [main] 16 DEBUG dmfssecbuild.Constants - Mon Dec 31 00:00:00 GMT+05:00 2012 To Date 

Answer 9

¿Ha probado DoodleDebug? Es un plugin de Eclipse y pretende ser tan fácil como System.out.println() pero mucho más potente.

Se puede encontrar aquí: http://scg.unibe.ch/wiki/projects/DoodleDebug

Answer 10

Si utiliza IntelliJ IDEA, puede utilizar la "plantilla vivo" de acceso directo para la impresión a system.out como soutp (and then a TAB) para depurar los parámetros del método, soutv para rastrear el nombre de una variable junto con su valor, etc.

para leer la lista de atajos \ modificarla, vaya a Archivo-> Configuración> Live Plantillas-> salida

Answer 11

Mi primer consejo es: se adhieren a paquete java.util.logging. Realmente no hay necesidad de bibliotecas de registro de terceros.

1. Obtener instancia de java.util.Logger

   Logger logger = Logger.getLogger ("some.package.XyzClassName");

2. objetos Log (usando marcador de posición {N})

   Logger.log (Level.INFO, "cosas tala {0} y {1}", nuevo Object [] {new String ("Test") , 1222});

En el caso de las clases definidas por el usuario que necesita tener alguna aplicación anulación toString sensible(), ya que este método es llamado cuando la sustitución de marcador de posición en el mensaje {N}.