rspec/rules/S1312/rule-dotnet.adoc
Costin Zaharia 70bdb31f51
Logging rules: add "how to fix" section (#3969)
* S6674: add how to fix section

* S6677: add how to fix section

* S2629: add how to fix section

* S6670: add how to fix section

* S1312: add how to fix section

* S6672: add how to fix section

* S6670: add compliant/noncompliant headers

* S6669: add how to fix section

* S6668: add how to fix section

* S2629: remove method definition

* S6669: update formatting

* S6670: add links

* Fix formatting
2024-06-05 10:39:56 +02:00

44 lines
2.0 KiB
Plaintext
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

== Why is this an issue?
Regardless of the logging framework in use (Microsoft.Extension.Logging, Serilog, Log4net, NLog, ...), logger fields should be:
* *{private}*: this restricts access to the logger from outside the enclosing type (class, struct, record...). Using any other access modifier would allow other types to use the logger to log messages in the type where it's defined.
* *{static}*: making the logger field `{static}` will ensure that the lifetime of the object doesn't depend on the lifetime of the instance of the enclosing type.
* *{readonly}*: marking the field as `{readonly}` will prevent modifications to the reference of the logger. This ensures that the reference to the logger remains consistent and doesn't get accidentally reassigned during the lifetime of the enclosing type.
This rule should be activated when https://en.wikipedia.org/wiki/Service_locator_pattern[Service Locator Design pattern] is followed in place of https://en.wikipedia.org/wiki/Dependency_injection[Dependency Injection] for logging.
The rule supports the most popular logging frameworks:
* https://www.nuget.org/packages/Microsoft.Extensions.Logging[Microsoft.Extensions.Logging]
* https://www.nuget.org/packages/Serilog[Serilog]
* https://www.nuget.org/packages/Castle.Core[Castle.Core]
* https://www.nuget.org/packages/NLog[NLog]
* https://www.nuget.org/packages/log4net[log4net]
== How to fix it
Make the logging field `{private static readonly}`.
=== Noncompliant code example
include::{language}/noncompliant.adoc[]
=== Compliant solution
include::{language}/compliant.adoc[]
== Resources
=== Documentation
include::{language}/resources.adoc[]
* Wikipedia - https://en.wikipedia.org/wiki/Service_locator_pattern[Service locator pattern]
* Wikipedia - https://en.wikipedia.org/wiki/Dependency_injection[Dependency injection]
=== Articles & blog posts
* https://stackoverflow.com/questions/968132/c-sharp-private-static-and-readonly[C# `private`, `static`, and `readonly`]
include::rspecator-dotnet.adoc[]