Writing a simple print method for debugging in Java

Question

Before I reinvent the wheel - I want to be able to insert debugging traces in my code, such as say("We are here.");, without defining static void say() in every class. It needs to do System.out.println(s), and to be globally switched on or off (doSay(false)), and I'd also like it to be able to identify the class from which it's being invoked (as described here). For example:

MyClass: We are here.

Does Java already have such a tool?

Why would you need to redefine the `static` function in every class? By definition, `static` functions don't require an instance, so you can just call them from anywhere. — Karl Knechtel, Aug 04 '11 at 22:17
possible duplicate of [Java, how to trace functions called](http://stackoverflow.com/questions/4677502/java-how-to-trace-functions-called) — CoolBeans, Aug 04 '11 at 22:23
@Karl: is there a way to define it so that I can call it from anywhere as simply `say(...)` or `log(...)`, rather than `MyUtils.say(...)`? — Chap, Aug 05 '11 at 03:54

score 3 · Answer 1 · edited May 23 '17 at 12:04

Use SLF4j, not log4j (at least, not directly). They are both created by the same author, Ceki Gülcü, but SLF4J incorporates knowledge gained by seeing log4j in use, and looking at advances in other logging packages.

SLF4J is a common API for a number of different underlying logging systems, like log4j, the java.util.logging package, etc. It also has its own "native" implementation, logback.

One reason I like it better than log4j is its support for message templates. These keep your code simpler.

Also, it allows me to include logging in a library, but let the user of my library choose the logging implementation. Without something like this, a user might have to configure logging just for my library, and it wouldn't be unified with the rest of his application.

score 1 · Answer 2 · answered Aug 04 '11 at 22:18

1

The most popular Java logging framework is Log4J which does this (and much more).

Look here for a list of other.

answered Aug 04 '11 at 22:18

MByD

135,866
28
264
277

score 1 · Answer 3 · answered Aug 04 '11 at 22:19

1

Yes. It's called a logging framework. Java has java.util.logging. But many prefer using Log4J.

answered Aug 04 '11 at 22:19

JB Nizet

678,734
91
1,224
1,255

score 0 · Answer 4 · answered Aug 04 '11 at 22:19

0

You could use a logger like Apache's Log4J and do something like logger.trace("We are here");. When you want that off, set the log level higher (debug, warn, error) in your configuration and the trace logs will disappear.

answered Aug 04 '11 at 22:19

dee-see

23,668
5
58
91

score 0 · Answer 5 · answered Aug 04 '11 at 22:20

Java has more advanced logging tools, like log4j or logback. There you should create a public static final Logger logger = Logger.getLogger(..) and use the logger to write debug/info/warn/error messages to wherever you like. They are highly configurable - what and where to log.

For the simpler case (if this is a toy project), you can simply define a class with the public static void log(..) method and use it from every class.

karllindmark · Answer 6 · 2011-08-05T04:57:54.970

0

Why not static-declare a function in your Main.java, and use it allround?

public class Main {

    private static boolean debug;

    public static void setDebug(boolean d) { Main.debug = d; }

    public static void say(String s) { if(Main.debug) System.out.println(s); }

}

Let me know if this fits your needs.

Edit: revised the code

edited Aug 05 '11 at 04:57

answered Aug 04 '11 at 22:21

karllindmark

6,031
1
26
41

This is actually the kind of simplicity I was looking for, except that, unless I'm doing something wrong, the static say() can't reference 'this'. Most of all, I'd like to be able to invoke say() from anywhere without having to qualify is; e.g. Main.say("something"); Is that possible in Java? – Chap Aug 05 '11 at 03:51
1

`debug` and `setDebug` can be made `static` as well. – Karl Knechtel Aug 05 '11 at 04:07
I update the code so that it doesn't reference the this-context anymore (isn't a smart move when it's static heh). – karllindmark Aug 05 '11 at 04:58

score 0 · Accepted Answer · answered Aug 05 '11 at 16:12

I didn't know about static import! I combined ideas from @ninetwozero, @karl, and @erickson to create this:

package myPkg;
public class CLHUtilities {

    private static boolean saying = false;
    public static void tracing(boolean b) {
        saying = b;
    }

    /*
     * Technique taken from:
     * http://stackoverflow.com/questions/282977/which-class-invoked-my-static-method
     */
    public static void say(String s) {
        if (saying) {
            Throwable t = new Throwable();
            StackTraceElement[] trace = t.getStackTrace();
            String className = trace[1].getClassName();
            String whoCalledMe = null;
            try {
                whoCalledMe = Class.forName(className).getSimpleName();
            } catch (Exception e) {
            }
            System.out.println(whoCalledMe + ": " + s);
        }

    }
}

which can be used simply as:

import static myPkg.CLHUtilities.*;
 :
tracing(true);
 :
say("We are here.");

Which suits my needs perfectly.

Writing a simple print method for debugging in Java

7 Answers7