Loggable
A simple log4j meta-library
Loggable is a Java library to be used in conjunction with the Apache log4j standard logging library.
Its main goal is semplifying the logging process throughout the application, thus reducing the usual declarations overhead due to the log4j library.
Example
A standard call to the log4j library is written this way:
[java][RAW]
package com.marzapower.test;
import org.apache.log4j.Logger;
public class Log4jCaller {
private static final Logger logger = Logger.getLogger(Log4jCaller.class);
public static void main(String… args) {
logger.debug("A simple log call");
}
}
[/RAW][/java]
The Loggable meta-library requires a lighter approach:
[java][RAW]
package com.marzapower.test;
import com.marzapower.loggable.*;
@Loggable
public class LoggableCaller {
public static void main(String… args) {
Log.get().debug("A simple log call");
}
}
[/RAW][/java]
This definition will have the same effect at runtime. A still valid approach is the following:
[java][RAW]
package com.marzapower.test;
import com.marzapower.loggable.*;
public class RootLoggerCaller {
public static void main(String… args) {
Log.get().debug("A simple log call");
}
}
[/RAW][/java]
where the @Loggable annotation is missing. This implementation would be equivalent to the first example, if we changed the logger definition to Logger.getRootLogger() instead of Logger.getLogger(Log4jLogger.class).
How does it work
The Loggable meta-library uses two main elements: the @Loggable annotation and the Log class. The first drives the logging logic of our classes, while the latter is a centralized controller that each class has to call in a static way. While, using only the base log4j library, each class had to define a private org.apache.log4j.Logger instance, and then had to invoke methods on this instance, now each class must be annoted with the @Loggable annotation and must call the Log class directly for logging.
We can increase the ease of implementation of the logging architecture doing the following:
- Design an appropriate log4j configuration, so that the root logger can be used equally by each class
- Write down the code of the application classes, without using any additional parameter or annotation or private logger instance
- Within each class, call Log.get() to retrieve the Logger instance to be used directly.
What will happen is that each class, using this approach, will log using the log4j root logger. We can easily convert this code:
[java][RAW]
package com.marzapower.test;
import org.apache.log4j.Logger;
public class Log4jCaller1 {
private static final Logger logger = Logger.getRootLogger();
public void log() {
logger.debug("A simple log call");
}
}
final class Log4jCaller2 {
private static final Logger logger = Logger.getRootLogger();
public void log() {
logger.debug("A simple log call");
}
}
final class Log4jCaller3 {
private static final Logger logger = Logger.getRootLogger();
public void log() {
logger.debug("A simple log call");
}
}
[/RAW][/java]
into this:
[java][RAW]
package com.marzapower.test;
import com.marzapower.loggable.Log;
public class LoggableCaller1 {
public void log() {
Log.get().debug("A simple log call");
}
}
final class LoggableCaller2 {
public void log() {
Log.get().debug("A simple log call");
}
}
final class LoggableCaller3 {
public void log() {
Log.get().debug("A simple log call");
}
}
[/RAW][/java]
Speed up development time
This meta-library will surely speed up development time. This is true because we no longer have to worry about useless definitions. We can insert that Log.get() call everywhere with no additional effort, and every logging call will succeed. By default in fact, every class can at least log through the root logger.
So, we do not have to worry about the definition of the local logger instance, neither have to worry about deleting this instance when we erase every logging call from our class. If we want our class to log into its dedicated logger, we just have to add the short “@Loggable” annotation before the class definition. If we want to modify the logger for that class, we will just change some parameters passed to the annotation.
A more complex example
This is a more complex example:
[java][RAW]
package com.marzapower.test;
import com.marzapower.loggable.*;
import com.marzapower.loggable.Loggable.LogLevel;
@Loggable(clazz = MyOtherClass.class, logLevel = LogLevel.ERROR)
public class LoggableComplexCaller {
public void log() {
Log.get().debug("This will never be logged");
Log.get().error("But this surely will!");
}
}
@Loggable(loggerName = "myLoggable")
final class MyLoggableCaller {
public void log() {
Log.get().debug(
"A simple log call, " +
"using the myLoggable " +
"logger instance");
}
}
@Loggable(exclude = true)
final class LoggableSilentCaller {
public void log() {
Log.get().debug("This will never be logged");
}
}
[/RAW][/java]
The following will happen:
- LoggableComplexCaller will log using the logger instance dedicated to the MyLogger class (the equivalent of Logger.getLogger(MyOtherClass.class)), and only messages whose level is ERROR or higher will be logged
- MyLoggableCaller will log using the log4j logger named “myLoggable“, if present in the log4j configuration files
- LoggableSilentCaller will never log, since Log.get() will return a silent logger for this class.
Additional info
You can find a detailed introduction and explanation of the Loggable meta-library in these two posts:
Download
All the source code and compiled packages for the Loggable meta-library are hosted on github. Please follow this link to the main project page
Changelog
v. 1.0.3
- FIX: A bug in the LoggerContainer class caused an endless loop when asking for a void logger or the root logger
v. 1.0.2
- FIX: A bug in the LoggerContainer class caused a NullPointerException under certain (rare) circumstances
v. 1.0.1
- FIX: A bug in the LoggerContainer class caused a stack overflow when calling Log.get()
v. 1.0
- First official release
Credits and copyright
The Loggable meta-library is released under the GNU Lesser General Public License v. 3.
Heya i’m for the first time here. I came across this board and I find It truly useful & it
helped me out a lot. I hope to give something back and
help others like you helped me.
I think the admin of this website is in fact working hard in favor of his
website, because here every information is quality based material.
Having read this I thought it was rather enlightening. I appreciate you finding the time and effort to put this short article together. I once again find myself personally spending a significant amount of time both reading and leaving comments. But so what, it was still worthwhile!
I am sure this article has touched all the internet
visitors, its really really nice piece of writing on building up new weblog.
It’s genuinely very complicated in this active life
to listen news on Television, therefore I just use internet for that reason, and
obtain the most up-to-date news.
Thanks a lot for the article post.Thanks Again. Keep writing.
Greetings from Los angeles! I’m bored at work so I decided to check out your website on my
iphone during lunch break. I enjoy the information you
provide here and can’t wait to take a look when I get home.
I’m surprised at how quick your blog loaded on my mobile ..
I’m not even using WIFI, just 3G .. Anyways, good blog!
my webpage :: m88
Enjoyed every bit of your post.Really thank you! Awesome.
May I simply just say what a comfort to discover somebody that truly understands what they’re talking about on the net. You certainly realize how to bring a problem to light and make it important. A lot more people ought to read this and understand this side of the story. It’s surprising you are not more popular given that you surely possess the gift.
Im grateful for the article post. Really Great.
Thanks a lot for the blog post. Fantastic.
Howdy! I could have sworn I’ve been to this web site before but after browsing through some of the articles I realized it’s new to me. Anyhow, I’m definitely happy I came across it and I’ll be bookmarking it and checking back regularly!