SONARJAVA-5284 Create rule S7178: Injecting data into static fields is not supported by Spring #4611
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
leonardo-pilastri-sonarsource
requested changes
Jan 24, 2025
rules/S7178/java/metadata.json
Outdated
Comment on lines
18
to
22
| "impacts": { | ||
| "MAINTAINABILITY": "HIGH", | ||
| "RELIABILITY": "HIGH", | ||
| "SECURITY": "LOW" | ||
| }, |
There was a problem hiding this comment.
I would say that the issue mostly impacts reliability, as the code will not behave as intended
rules/S7178/java/rule.adoc
Outdated
|
|
||
| Spring dependency injection framework does not support injecting data into static fields. When @Value, @Inject, or @Autowired are applied to static fields, they are ignored. | ||
|
|
||
| What is the potential impact? |
There was a problem hiding this comment.
Suggested change
| What is the potential impact? | |
| === What is the potential impact? |
rules/S7178/java/rule.adoc
Outdated
| * Null Values: Uninitialized static fields annotated with @Value, @Inject, or @Autowired will not be initialized by Spring, potentially causing NullPointerException at runtime. | ||
| * Confusing Code: The presence of injection annotations on static fields can mislead developers into believing that the fields will be populated by Spring. | ||
|
|
||
| This rule raises an issue when a static will is annotated with @Value, @Inject, or @Autowired. |
There was a problem hiding this comment.
Suggested change
| This rule raises an issue when a static will is annotated with @Value, @Inject, or @Autowired. | |
| This rule raises an issue when a static field is annotated with @Value, @Inject, or @Autowired. |
rules/S7178/java/rule.adoc
Outdated
| public class MyComponent { | ||
|
|
||
| @Value("${my.app.prop}") | ||
| private static SomeDependency dependency; // Noncompliant, @Value will be ignored and no value will be injected |
There was a problem hiding this comment.
Suggested change
| private static SomeDependency dependency; // Noncompliant, @Value will be ignored and no value will be injected | |
| private static SomeDependency dependency; // Non compliant, @Value will be ignored and no value will be injected |
erwan-serandour
changed the title
leonardo-pilastri-sonarsource
approved these changes
Jan 24, 2025
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
You can preview this rule here (updated a few minutes after each push).
Review
A dedicated reviewer checked the rule description successfully for: