Spring注解驱动开发（二）之@ComponentScans、@ComponentScan和@Filter注解

最新推荐文章于 2024-08-09 15:59:01 发布
最新推荐文章于 2024-08-09 15:59:01 发布
阅读量522 收藏 1
点赞数 1
分类专栏： Spring注解驱动开发 文章标签： Spring注解 @ComponentScans @ComponentScan @Filter
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u013639625/article/details/102644971
版权

除了可以通过@Bean注解的方式为IoC容器注册组件，也可以通过包扫描（@ComponentScan注解）的方式为IoC容器注册组件

项目目录结构

在这里插入图片描述

项目环境搭建

  • 创建Maven子工程demo-two，并在子工程的pom.xml文件中导入spring-context等依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>spring-annotation</artifactId>
        <groupId>com.codermyu</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>demo-two</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
        </dependency>
    </dependencies>


</project>
  • 在controller包下创建UserController类
package com.codermyu.controller;

import org.springframework.stereotype.Controller;

/** @author Mingyu */
@Controller
public class UserController {}
  • 在service包下创建UserService类
package com.codermyu.service;

import org.springframework.stereotype.Service;

/** @author Mingyu */
@Service
public class UserService {}
  • 在dao包下创建UserDao类
package com.codermyu.dao;

import org.springframework.stereotype.Repository;

/** @author Mingyu */
@Repository
public class UserDao {}
  • 在config包下创建配置类MySpringConfig
package com.codermyu.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

/** @author Mingyu */
@ComponentScan(basePackages = {"com.codermyu"})
@Configuration
public class MySpringConfig {}
  • 创建启动类App
package com.codermyu;

import com.codermyu.config.MySpringConfig;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

/** @author Mingyu */
public class App {
  public static void main(String[] args) {
    ApplicationContext applicationContext =
        new AnnotationConfigApplicationContext(MySpringConfig.class);
    String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames();
    for (String beanDefinitionName : beanDefinitionNames) {
      System.out.println(beanDefinitionName);
    }
  }
}

细节

  • @ComponentScan注解

    • @ComponentScan注解需要标注在配置类上

    • 为@ComponentScan注解添加basePackages属性，可以指定包扫描时的根路径，IoC容器在启动时会扫描该路径下所有标注了@Configuration、@Component、@Controller、@Service、@Repository注解的类并创建组件，然后将创建的组件注册到IoC容器中

    • 创建的组件的id为类名的首字母小写（默认），为@Configuration、@Component、@Controller、@Service、@Repository注解添加value属性，可以重新指定组件的id，而不使用默认的首字母小写作为组件的id

      • @Controller(value = "userControllerSpecified")

    • 为@ComponentScan注解添加excludeFilters属性，可以指定包扫描时的排除规则（不扫描哪些组件）

      package com.codermyu.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import org.springframework.stereotype.Controller;
import org.springframework.stereotype.Service;

/** @author Mingyu */
@ComponentScan(
    basePackages = {"com.codermyu"},
    excludeFilters = {
      @ComponentScan.Filter(
          /** 包扫描时不扫描标注了@Controller注解和@Service注解的类 */
          type = FilterType.ANNOTATION,
          classes = {Controller.class, Service.class})
    })
@Configuration
public class MySpringConfig {}

    • 为@ComponentScan注解添加includeFilters属性，可以指定包扫描时的包含规则（额外扫描哪些组件）

      • 包扫描时如果希望只扫描某些特定组件，需要禁用默认的过滤器
      package com.codermyu.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import org.springframework.stereotype.Controller;
import org.springframework.stereotype.Repository;

/** @author Mingyu */
@ComponentScan(
    basePackages = {"com.codermyu"},
    /** 禁用默认的过滤器 */
    useDefaultFilters = false,
    includeFilters = {
      @ComponentScan.Filter(
          /** 包扫描时只扫描标注了@Controller注解和@Repository注解的类 */
          type = FilterType.ANNOTATION,
          classes = {Controller.class, Repository.class})
    })
@Configuration
public class MySpringConfig {}
  • @ComponentScans注解
    • Java8以及Java8以后的Java版本支持@Repeatable注解，@ComponentScan注解可以在配置类上标注多次，用于指定不同的包扫描策略
    • Java8以前的Java版本，可以采用@ComponentScans注解包含多个@ComponentScan注解的方式，指定不同的包扫描策略
  • @Filter注解

    • @Filter注解的type属性可以指定5种类型

      • FilterType.ANNOTATION：按照指定的注解规则过滤组件
      • FilterType.ASSIGNABLE_TYPE：按照指定的类型规则过滤组件
      • FilterType.ASPECTJ：按照指定的AspectJ表达式规则过滤组件
      • FilterType.REGEX：按照指定的正则表达式规则过滤组件
      • FilterType.CUSTOM：按照自定义规则过滤组件
      package com.codermyu.config;

import com.codermyu.service.UserService;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import org.springframework.stereotype.Controller;

/** @author Mingyu */
@ComponentScan(
    basePackages = {"com.codermyu"},
    useDefaultFilters = false,
    includeFilters = {
      @ComponentScan.Filter(
          type = FilterType.ANNOTATION,
          classes = {Controller.class}),
      @ComponentScan.Filter(
          type = FilterType.ASSIGNABLE_TYPE,
          classes = {UserService.class})
    })
@Configuration
public class MySpringConfig {}

    • 自定义Filter

      • 在filter包下创建MyFilter类，该类需要实现TypeFilter接口，并重写match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory)方法
      • metadataReader
        • 用来获取当前正在扫描的类的信息
        • metadataReader.getResource()：获取类的资源信息
        • metadataReader.getClassMetadata()：获取类的类信息
        • metadataReader.getAnnotationMetadata()：获取类的注解信息
      • metadataReaderFactory
        • 用来获取其他类的metadataReader，然后通过metadataReader获取类的信息
        • metadataReaderFactory.getMetadataReader(String className)：通过类名获取metadataReader
      package com.codermyu.filter;

import org.springframework.core.type.AnnotationMetadata;
import org.springframework.core.type.classreading.MetadataReader;
import org.springframework.core.type.classreading.MetadataReaderFactory;
import org.springframework.core.type.filter.TypeFilter;
import org.springframework.stereotype.Controller;

import java.io.IOException;

/** @author Mingyu */
public class MyFilter implements TypeFilter {
  @Override
  public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory)
      throws IOException {
    /** 通过metadataReader获取当前正在扫描的类的注解信息 */
    AnnotationMetadata annotationMetadata = metadataReader.getAnnotationMetadata();
    /** 如果当前正在扫描的类标注了@Controller注解，match方法就返回true，否则返回false */
    return annotationMetadata.hasAnnotation(Controller.class.getName());
  }
}
      • 将自定义Filter添加到Filter组中
        • basePackages指定的路径下的每个类都会通过MyFilter类中的match()方法进行过滤，如果匹配成功，就将当前正在扫描的类注册到IoC容器中
      package com.codermyu.config;

import com.codermyu.filter.MyFilter;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

/** @author Mingyu */
@ComponentScan(
    basePackages = {"com.codermyu"},
    useDefaultFilters = false,
    includeFilters = {
      @ComponentScan.Filter(
          type = FilterType.CUSTOM,
          classes = {MyFilter.class})
    })
@Configuration
public class MySpringConfig {}
codermyu
关注
专栏目录
SpringBoot配置exclude时需要同时配置@ComponentScan与@SringbootApplication才生效
ceyowa的博客
02-24 2853
SpringBoot配置exclude时需要同时配置@ComponentScan与@SringbootApplication才生效
（二）Spring组件注册-@ComponentScan和@ComponentScans
欧阳惜竹的博客
08-02 749
文章目录链接视频github老的方式注解@ComponentScan测试用例配置类启动类结果结果解析ComponentScan注解ComponentScan的excludeFilters配置类启动类结果结果解析ComponentScan的includeFilters配置类结果结果解析真正的配置正常xml配置配置类配置结果ComponentScans配置类运行结果 链接 视频 https://www.bilibili.com/medialist/play/ml1022680573/p3 github http
Spring注解详解：@ComponentScan自动扫描组件使用
m0_67392182的博客
07-28 966
PersonConfig修改**
Spring Boot 常见注解的用法和功能
最新发布
精神小牛马
08-09 1151
springboot 常用注解说明
（四）组件注册--@ComponentScan--Filter属性
cb的博客
07-26 5819
1，前言 有关@ComponentScan的Filter属性的记录 2，Filter @ComponentScan中还有一些属性： //扫描的时候只扫描哪些指定的组件 ComponentScan.Filter[] includeFilters() default {}; //扫描的时候按照哪些规则排除指定的组件 ComponentScan.Filter[] excludeFilters() default {}; 2.1，excludeFilters MainConfig主配置类 /*
03-组件注册-@ComponentScan自定义TypeFilter指定过滤规则
航行博客
03-28 1146
组件注册也可以使用其他过滤规则 //配置文件=配置类 @Configuration //告诉Spring 这是一个配置类 @ComponentScan(value = "com.spring", includeFilters = { //@ComponentScan.Filter(type = FilterType.ANNOTATION,classes ={Co...
Spring @ComponentScan过滤器详解
qq_36412195的博客
04-23 486
使用@ComponentScan可以让Spring取扫描Bean并注册到Spring容器中，如果我们想对这扫描添加一定的限制可以使用过滤器。 package service; import org.springframework.stereotype.Service; import pojo.User; @Service public class UserService { public void printUser(User user){ System.out.println(
Spring @ComponentScan – Filter Types
张紫娃的博客
03-16 710
There are five types of filters available for 1、 2、 3、 4、 5、We should note that all these filters can or classes from scanning by using and parameters of the @ComponentScan annotation. 2. FilterType.ASSIGNABLE_TYPE 3. FilterType.REGEX 4. FilterTy
【Spring注解驱动开发】使用@ComponentScan自动扫描组件并指定扫描规则(1)
2401_83915664的博客
04-18 273
按照上面的过程，4个月的时间刚刚好。当然Java的体系是很庞大的，还有很多更高级的技能需要掌握，但不要着急，这些完全可以放到以后工作中边用别学。学习编程就是一个由混沌到有序的过程，所以你在学习过程中，如果一时碰到理解不了的知识点，大可不必沮丧，更不要气馁，这都是正常的不能再正常的事情了，不过是“人同此心，心同此理”的暂时而已。道路是曲折的，前途是光明的！《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！发知识点，真正体系化！**
【Spring注解驱动开发】自定义TypeFilter指定@ComponentScan注解的过滤规则
2401_83916283的博客
04-18 389
对于很多Java工程师而言，想要提升技能，往往是自己摸索成长，不成体系的学习效果低效漫长且无助。整理的这些资料希望对Java开发的朋友们有所参考以及少走弯路，本文的重点是你有没有收获与成长，其余的都不重要，希望读者们能谨记这一点。再分享一波我的Java面试真题+视频学习详解+技能进阶书籍《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！” />对于很多Java工程师而言，想要提升技能，往往是自己摸索成长，不成体系的学习效果低效漫长且无助。
spring的@ComponentScan.Filter注解
听海边涛声
01-31 231
spring的@ComponentScan.Filter注解
《读spring源码》6注解@ComponentScan的FilterType.CUSTOM 讲解 自定义过滤器
ppwwp的专栏
11-29 1840
在@ComponentScan 注解FilterType.CUSTOM 如何使用： package com.enjoy.cap2.MainConfiguer; import com.enjoy.cap1.Person; import com.enjoy.cap2.controller.OderController; import org.springframework.context.anno...
@componentScan
ybbgrain的历程
11-12 571
spring注解目录 sping注解包括了许多的spring相关注解的解释和应用。 目录 概述 excludeFilters includeFilters ComponentScans 概述 @ComponentScan主要是扫描包下面的组件。 @ComponentScan告诉他一个包com.demo，他就会到com.demo下面去找所有的组件。 然后还可以，里面有一些spring的默认包。 excludeFilters 然后想要指定扫描一些组件呢？使观察到@Compone.
Spring全注解之@CompontScan注解的自定义FilterType指定过滤规则（三）
qq_39746820的博客
06-01 1160
Spring全注解之@CompontScan注解的自定义FilterType指定过滤规则
SpringBoot—@ComponentScan注解过滤排除某个类
Andya_net的博客
06-21 3612
问题   在抽取公共swagger配置类时，将swagger放入com.test.common.config包内，其他模块通过@ComponentScan进行进行引用，但有的模块在引用时，会扫描到common.config包路径下的其他配置类而引发错误，如引用到RedisConfig类而报错，此时需要将该类排除掉。 解决方案   通过@ComponentScan中的excludeFilters属性进行排除类。 @SpringBootApplication @ComponentScan(basePackage
002--@ComponentScan、@Filter注解（方式二）
热门推荐
诗水人间
01-31 11万+
一般情况下，通过ComponentScan注解来配置要扫描的包，默认情况下会自动被扫描进IOC容器的是@Controller、@Service、@Repository、@Component注解的配置类 使用@ComponentScan的示例，其中的value就是指明要扫描的包名 package config; import bean.HelloWorld; import org.sprin...
@ComponentScan.Filter type的类型
Leon_Jinhai_Sun的博客
09-23 1509
a)注解形式的FilterType.ANNOTATION @Controller @Service @Repository @Compent b)指定类型的 FilterType.ASSIGNABLE_TYPE @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE,value = {TulingService.class}) c)aspectj类型的 FilterType.ASPECTJ(不常用) d)正则表达式的 FilterType.RE
@ComponentScan.Filter中找不到classes属性
qq_45120826的博客
01-06 236
换一下spring-context的版本就可以了，之前用的4点几的版本，换成5点几的就可以
@ComponentScan注解的Filter
03-23
@ComponentScan注解的Filter用于在Spring的组件扫描过程中过滤掉不需要的组件。@ComponentScan注解可以通过includeFilters和excludeFilters属性来指定过滤规则。其中，includeFilters用于包含需要扫描的组件，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值