68e9c93d57
* Add csharp to rule S1312 * First specification * Fix ascii * Improve description * Address comments * Add the list of supported frameworks * Add links to supported frameworks * Small fixes * Add missing closing brace * Add tag logging * Remove VB.NET * Fix code snippets --------- Co-authored-by: cristian-ambrosini-sonarsource <cristian-ambrosini-sonarsource@users.noreply.github.com> Co-authored-by: Cristian Ambrosini <cristian.ambrosini@sonarsource.com> Co-authored-by: Gregory Paidis <gregory.paidis@sonarsource.com> Co-authored-by: Gregory Paidis <115458417+gregory-paidis-sonarsource@users.noreply.github.com>
30 lines
1.0 KiB
Plaintext
30 lines
1.0 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Regardless of the logging framework in use (logback, log4j, commons-logging, java.util.logging, ...), loggers should be:
|
|
|
|
|
|
* ``++private++``: never be accessible outside of its parent class. If another class needs to log something, it should instantiate its own logger.
|
|
* ``++static++``: not be dependent on an instance of a class (an object). When logging something, contextual information can of course be provided in the messages but the logger should be created at class level to prevent creating a logger along with each object.
|
|
* ``++final++``: be created once and only once per class.
|
|
|
|
=== Noncompliant code example
|
|
|
|
With a default regular expression of ``++LOG(?:GER)?++``:
|
|
|
|
[source,java]
|
|
----
|
|
public Logger logger = LoggerFactory.getLogger(Foo.class); // Noncompliant
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
private static final Logger LOGGER = LoggerFactory.getLogger(Foo.class);
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
Variables of type ``++org.apache.maven.plugin.logging.Log++`` are ignored.
|
|
|
|
include::../rspecator.adoc[] |