Exclude subpackages from Spring autowiring

Question

Is there a simple way to exclude a package   sub-package from autowiring in Spring 3 1   E g   if I wanted to include a component scan with a base package of com example is there a simple way to exclude com example ignore    Why   I d like to exclude some components from my integration tests

User · Answer

It seems you ve done this through XML  but if you were working in new Spring best practice  your config would be in Java  and you could exclude them as so    Configuration  EnableWebMvc  ComponentScan basePackages    net example tool     excludeFilters     ComponentScan Filter      type   FilterType ASSIGNABLE TYPE      value    JPAConfiguration class  SecurityConfig class

User · Answer

You can also use  SpringBootApplication  which according to Spring documentation does the same functionality as the following three annotations   Configuration   EnableAutoConfiguration  ComponentScan  in one annotation    SpringBootApplication exclude   Foo class   public class MySpringConfiguration

User · Answer

I m not sure you can exclude packages explicitly with an  lt exclude-filter gt   but I bet using a regex filter would effectively get you there     lt context component-scan base-package  com example  gt       lt context exclude-filter type  regex  expression  com  example  ignore       gt    lt  context component-scan gt    To make it annotation-based  you d annotate each class you wanted excluded for integration tests with something like  com example annotation ExcludedFromITests  Then the component-scan would look like     lt context component-scan base-package  com example  gt       lt context exclude-filter type  annotation  expression  com example annotation ExcludedFromITests   gt    lt  context component-scan gt    That s clearer because now you ve documented in the source code itself that the class is not intended to be included in an application context for integration tests

User · Answer

One thing that seems to work for me is this    ComponentScan basePackageClasses    SomeTypeInYourPackage class   resourcePattern      class     Or in XML    lt context component-scan base-package  com example  resource-pattern    class   gt    This overrides the default resourcePattern which is       class    This would seem like the most type-safe way to ONLY include your base package since that resourcePattern would always be the same and relative to your base package

User · Answer

You can also include specific package and excludes them like    Include and exclude  both     SpringBootApplication                           scanBasePackages                              com package1                            com package2                                     exclude    org springframework boot sample class              JUST Exclude   SpringBootApplication exclude   com package1 class   public class MySpringConfiguration

User · Answer

I am using  ComponentScan as follows for the same use case  This is the same  as BenSchro10 s XML answer but this uses annotations  Both use a filter with type AspectJ   import org springframework boot SpringApplication  import org springframework boot autoconfigure EnableAutoConfiguration  import org springframework boot autoconfigure SpringBootApplication  import org springframework boot autoconfigure jdbc DataSourceAutoConfiguration  import org springframework boot autoconfigure jersey JerseyAutoConfiguration  import org springframework boot autoconfigure jms JmsAutoConfiguration  import org springframework boot autoconfigure jmx JmxAutoConfiguration  import org springframework context annotation ComponentScan  import org springframework context annotation FilterType  import org springframework context annotation ImportResource    SpringBootApplication  EnableAutoConfiguration  ComponentScan basePackages      com example         excludeFilters    ComponentScan Filter type   FilterType ASPECTJ  pattern    com example ignore      public class Application       public static void main String   args            SpringApplication run Application class  args

User · Answer

This works in Spring 3 0 5  So  I would think it would work in 3 1   lt context component-scan base-package  com example  gt         lt context exclude-filter type  aspectj  expression  com example dontscanme      gt     lt  context component-scan gt

User · Answer

For Spring 4 I use the following  I am posting it as the question is 4 years old and more people use Spring 4 than Spring 3 1     Configuration  ComponentScan basePackages    com example      excludeFilters    Filter type FilterType REGEX pattern  com   example   ignore          public class RootConfig

User · Answer

I think you should refactor your packages in more convenient hierarchy  so they are out of the base package   But if you can t do this  try    lt context component-scan base-package  com example  gt               lt context exclude-filter type  regex  expression  com  example  ignore     gt   lt  context component-scan gt    Here you could find more examples  Using filters to customize scanning

[spring] Exclude subpackages from Spring autowiring?

Examples related to spring

Examples related to autowired