16f6c0aecf
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
94 lines
3.0 KiB
Plaintext
94 lines
3.0 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Spring beans belonging to packages that are not included in a ``++@ComponentScan++`` configuration will not be accessible in the Spring Application Context. Therefore, it's likely to be a configuration mistake that will be detected by this rule.
|
|
|
|
|
|
*Note:* the ``++@ComponentScan++`` is implicit in the ``++@SpringBootApplication++`` annotation, case in which Spring Boot will auto scan for components in the package containing the Spring Boot main class and its sub-packages.
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,java]
|
|
----
|
|
package com.mycompany.app;
|
|
|
|
@Configuration
|
|
@ComponentScan("com.mycompany.app.beans")
|
|
public class Application {
|
|
...
|
|
}
|
|
|
|
package com.mycompany.app.web;
|
|
|
|
@Controller
|
|
public class MyController { // Noncompliant; MyController belong to "com.mycompany.app.web" while the ComponentScan is looking for beans in "com.mycompany.app.beans" package
|
|
...
|
|
}
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
package com.mycompany.app;
|
|
|
|
@Configuration
|
|
@ComponentScan({"com.mycompany.app.beans","com.mycompany.app.web"})
|
|
or
|
|
@ComponentScan("com.mycompany.app")
|
|
or
|
|
@ComponentScan
|
|
public class Application {
|
|
...
|
|
}
|
|
|
|
package com.mycompany.app.web;
|
|
|
|
@Controller
|
|
public class MyController { // "com.mycompany.app.web" is referenced by a @ComponentScan annotated class
|
|
...
|
|
}
|
|
----
|
|
|
|
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
XXX is not reachable by @ComponentScan or @SpringBootApplication. Either move it to a package configured in @ComponentScan or update your @ComponentScan configuration.
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
=== on 11 Jun 2018, 15:34:47 Andrei Epure wrote:
|
|
*Note:* the ``++@ComponentScan++`` is implicit in the ``++@SpringBootApplication++`` annotation, case in which Spring Boot will auto scan for components in the package containing the ``++@SpringBoot++`` main class and its sub packages.
|
|
|
|
|
|
*Out of scope:* usage of filters to customize scanning, e.g.:
|
|
|
|
----
|
|
@ComponentScan(basePackages = "org.example",
|
|
includeFilters = @Filter(type = FilterType.REGEX, pattern = ".*Stub.*Repository"),
|
|
excludeFilters = @Filter(Repository.class))
|
|
----
|
|
|
|
|
|
=== on 27 Jun 2018, 11:16:04 Andrei Epure wrote:
|
|
This rule should never be in the Default Profile because:
|
|
|
|
* it ignores XML _component-scan_ configuration
|
|
* it's perfectly valid to have project A with a @Component class which is not actually consumed in project A. And then project B declares in a @ComponentScan configuration class the package from Project A, and consumes it as a dependency. Everything will work just fine, even if the code for project A is totally separate from the code from project B.
|
|
|
|
=== on 14 Mar 2021, 18:10:12 Stéphane Nicoll wrote:
|
|
A more compliant solution would be to remove the `@ComponentScan` directive altogether and use `@SpringBootApplication`. This way `com.mycompany.app` is used. This also helps with slice tests where the appropriate filter will be configured automatically.
|
|
|
|
endif::env-github,rspecator-view[]
|