SONARJAVA-5285 Create rule S7180: "@Cache*" annotations should only be applied on concrete classes (#4613)
This commit is contained in:
parent
040c9dabef
commit
46eb087a63
26
rules/S7180/java/metadata.json
Normal file
26
rules/S7180/java/metadata.json
Normal file
@ -0,0 +1,26 @@
|
||||
{
|
||||
"title": "\"@Cache*\" annotations should only be applied on concrete classes",
|
||||
"type": "CODE_SMELL",
|
||||
"status": "ready",
|
||||
"remediation": {
|
||||
"func": "Constant\/Issue",
|
||||
"constantCost": "5min"
|
||||
},
|
||||
"tags": [
|
||||
"spring"
|
||||
],
|
||||
"defaultSeverity": "Major",
|
||||
"ruleSpecification": "RSPEC-7180",
|
||||
"sqKey": "S7180",
|
||||
"scope": "Main",
|
||||
"defaultQualityProfiles": ["Sonar way"],
|
||||
"quickfix": "unknown",
|
||||
"code": {
|
||||
"impacts": {
|
||||
"MAINTAINABILITY": "LOW",
|
||||
"RELIABILITY": "MEDIUM",
|
||||
"SECURITY": "LOW"
|
||||
},
|
||||
"attribute": "LOGICAL"
|
||||
}
|
||||
}
|
45
rules/S7180/java/rule.adoc
Normal file
45
rules/S7180/java/rule.adoc
Normal file
@ -0,0 +1,45 @@
|
||||
== Why is this an issue?
|
||||
|
||||
Annotating interfaces or interface methods with ``++@Cache*++`` annotations is not recommended. When using CGLIB-based proxies, these annotations will be ignored, and no caching proxy will be created.
|
||||
|
||||
=== What is the potential impact?
|
||||
|
||||
* *Confusing Code*: Developers may mistakenly believe that caching is in effect, leading to confusion and incorrect assumptions about application performance.
|
||||
|
||||
This rule raises an issue when an interface or an interface method is annotated with a ``++@Cache*++`` annotation.
|
||||
|
||||
== How to fix it
|
||||
|
||||
Move ``++@Cache*++`` annotation from interface or interface method to the concrete class.
|
||||
|
||||
=== Code examples
|
||||
|
||||
==== Noncompliant code example
|
||||
|
||||
[source,java,diff-id=1,diff-type=noncompliant]
|
||||
----
|
||||
public interface ExampleService {
|
||||
|
||||
@Cacheable("exampleCache") //non compliant, interface method is annotated with @Cacheable
|
||||
String getData(String id);
|
||||
}
|
||||
----
|
||||
|
||||
==== Compliant solution
|
||||
|
||||
[source,java,diff-id=1,diff-type=compliant]
|
||||
----
|
||||
@Service
|
||||
public class ExampleServiceImpl implements ExampleService {
|
||||
|
||||
@Cacheable("exampleCache")
|
||||
@Override
|
||||
public String getData(String id) {
|
||||
// Implementation here
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
== Resources
|
||||
=== Documentation
|
||||
* Spring - https://docs.spring.io/spring-framework/reference/integration/cache/annotations.html#cache-annotation-enable[Declarative Annotation-based Caching]
|
2
rules/S7180/metadata.json
Normal file
2
rules/S7180/metadata.json
Normal file
@ -0,0 +1,2 @@
|
||||
{
|
||||
}
|
Loading…
x
Reference in New Issue
Block a user