@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Indexed
public @interface Component {
String value() default “”;
}
从定义中可以看出,这个注解可以用在任何类型上面。
通常情况下将这个注解用在类上面,标注这个类为一个组件,默认情况下,被扫描的时候会被作为bean注册到容器中。
value参数:被注册为bean的时候,用来指定bean的名称,如果不指定,默认为类名首字母小写。如:类UserService对应的beanname为userService
再来看看@Repository
源码如下:
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Repository {
@AliasFor(annotation = Component.class)
String value() default “”;
}
Repository上面有@Component注解。
value参数上面有
@AliasFor(annotation = Component.class)
,设置value参数的时候,也相当于给@Component
注解中的value设置值。
其他两个注解@Service、@Controller
源码和@Repository
源码类似。
这4个注解本质上是没有任何差别,都可以用在类上面,表示这个类被spring容器扫描的时候,可以作为一个bean组件注册到spring容器中。
spring容器中对这4个注解的解析并没有进行区分,统一采用@Component
注解的方式进行解析,所以这几个注解之间可以相互替换。
spring提供这4个注解,是为了让系统更清晰,通常情况下,系统是分层结构的,多数系统一般分为controller层、service层、dao层。
@controller通常用来标注controller层组件,@service注解标注service层的组件,@Repository标注dao层的组件,这样可以让整个系统的结构更清晰,当看到这些注解的时候,会和清晰的知道属于哪个层,对于spring来说,将这3个注解替换成@Component注解,对系统没有任何影响,产生的效果是一样的。
下面通过案例来感受@ComponentScan各种用法。
UserController
package com.javacode2018.lesson001.demo22.test1.controller;
import org.springframework.stereotype.Controller;
@Controller
public class UserController {
}
UserService
package com.javacode2018.lesson001.demo22.test1.service;
import org.springframework.stereotype.Service;
@Service
public class UserService {
}
UserDao
package com.javacode2018.lesson001.demo22.test1.dao;
import org.springframework.stereotype.Repository;
@Repository
public class UserDao {
}
UserModel
package com.javacode2018.lesson001.demo22.test1;
import org.springframework.stereotype.Component;
@Component
public class UserModel {
}
上面几个类中,分别使用了4种注解。
@CompontentScan修饰的类
package com.javacode2018.lesson001.demo22.test1;
import org.springframework.context.annotation.ComponentScan;
@ComponentScan
public class ScanBean1 {
}
上面几个类的结构图
测试用例
package com.javacode2018.lesson001.demo22;
import com.javacode2018.lesson001.demo22.test1.ScanBean1;
import org.junit.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
public class ComponentScanTest {
@Test
public void test1() {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ScanBean1.class);
for (String beanName : context.getBeanDefinitionNames()) {
System.out.println(beanName + “->” + context.getBean(beanName));
}
}
}
@1:使用AnnotationConfigApplicationContext作为ioc容器,将
ScanBean
作为参数传入。
默认会扫描
ScanBean
类所在的包中的所有类,类上有@Component、@Repository、@Service、@Controller任何一个注解的都会被注册到容器中
运行输出
部分输出如下:
userModel->com.javacode2018.lesson001.demo22.test1.UserModel@595b007d
userController->com.javacode2018.lesson001.demo22.test1.controller.UserController@72d1ad2e
userDao->com.javacode2018.lesson001.demo22.test1.dao.UserDao@2d7275fc
userService->com.javacode2018.lesson001.demo22.test1.service.UserService@399f45b1
注意最后4行这几个bean,都被注册成功了。
指定需要扫毛哪些包,可以通过value或者basePackage来配置,二者选其一,都配置运行会报错,下面我们通过value来配置。
ScanBean2
package com.javacode2018.lesson001.demo22.test2;
import org.springframework.context.annotation.ComponentScan;
@ComponentScan({
“com.javacode2018.lesson001.demo22.test1.controller”,
“com.javacode2018.lesson001.demo22.test1.service”
})
public class ScanBean2 {
}
上面指定了2需要扫描的包,这两个包中有2个类。
测试用例
ComponentScanTest中新增个方法
@Test
public void test2() {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ScanBean2.class);
for (String beanName : context.getBeanDefinitionNames()) {
System.out.println(beanName + “->” + context.getBean(beanName));
}
}
运行输出
截取了关键几行如下:
userController->com.javacode2018.lesson001.demo22.test1.controller.UserController@dd8ba08
userService->com.javacode2018.lesson001.demo22.test1.service.UserService@245b4bdc
可以看出只有controller包和service包中的2个类被注册为bean了。
注意
指定包名的方式扫描存在的一个隐患,若包被重名了,会导致扫描会失效,一般情况下面我们使用basePackageClasses的方式来指定需要扫描的包,这个参数可以指定一些类型,默认会扫描这些类所在的包及其子包中所有的类,这种方式可以有效避免这种问题。
下面来看一下basePackageClasses的方式。
我们可以在需要扫描的包中定义一个标记的接口或者类,他们的唯一的作用是作为basePackageClasses的值,其他没有任何用途。
下面我们定义这样一个接口
package com.javacode2018.lesson001.demo22.test6.beans;
public interface ScanClass {
}
再来定义2个类,用@Component注解标记
package com.javacode2018.lesson001.demo22.test6.beans;
import org.springframework.stereotype.Component;
@Component
public class Service1 {
}
package com.javacode2018.lesson001.demo22.test6.beans;
import org.springframework.stereotype.Component;
@Component
public class Service2 {
}
来一个@CompontentScan标记的类
package com.javacode2018.lesson001.demo22.test6;
import com.javacode2018.lesson001.demo22.test6.beans.ScanClass;
import org.springframework.context.annotation.ComponentScan;
@ComponentScan(basePackageClasses = ScanClass.class)
public class ScanBean6 {
}
测试用例
ComponentScanTest中新增个方法
@Test
public void test6() {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ScanBean6.class);
for (String beanName : context.getBeanDefinitionNames()) {
System.out.println(beanName + “->” + context.getBean(beanName));
}
}
运行输出
service1->com.javacode2018.lesson001.demo22.test6.beans.Service1@79924b
service2->com.javacode2018.lesson001.demo22.test6.beans.Service2@7b9a4292
用法
再来看一下includeFilters这个参数的定义:
Filter[] includeFilters() default {};
是一个Filter
类型的数组,多个Filter之间为或者关系,即满足任意一个就可以了,看一下Filter
的代码:
@Retention(RetentionPolicy.RUNTIME)
@Target({})
@interface Filter {
FilterType type() default FilterType.ANNOTATION;
@AliasFor(“classes”)
Class<?>[] value() default {};
@AliasFor(“value”)
Class<?>[] classes() default {};
String[] pattern() default {};
}
可以看出Filter也是一个注解,参数:
type:过滤器的类型,是个枚举类型,5种类型
ANNOTATION:通过注解的方式来筛选候选者,即判断候选者是否有指定的注解
ASSIGNABLE_TYPE:通过指定的类型来筛选候选者,即判断候选者是否是指定的类型
ASPECTJ:ASPECTJ表达式方式,即判断候选者是否匹配ASPECTJ表达式
REGEX:正则表达式方式,即判断候选者的完整名称是否和正则表达式匹配
CUSTOM:用户自定义过滤器来筛选候选者,对候选者的筛选交给用户自己来判断
value:和参数classes效果一样,二选一
classes:3种情况如下
当type=FilterType.ANNOTATION时,通过classes参数可以指定一些注解,用来判断被扫描的类上是否有classes参数指定的注解
当type=FilterType.ASSIGNABLE_TYPE时,通过classes参数可以指定一些类型,用来判断被扫描的类是否是classes参数指定的类型
当type=FilterType.CUSTOM时,表示这个过滤器是用户自定义的,classes参数就是用来指定用户自定义的过滤器,自定义的过滤器需要实现org.springframework.core.type.filter.TypeFilter接口
pattern:2种情况如下
当type=FilterType.ASPECTJ时,通过pattern来指定需要匹配的ASPECTJ表达式的值
当type=FilterType.REGEX时,通过pattern来自正则表达式的值
案例:扫描包含注解的类
需求
我们自定义一个注解,让标注有这些注解的类自动注册到容器中
代码实现
下面的代码都在com.javacode2018.lesson001.demo22.test3
包中。
定义一个注解
package com.javacode2018.lesson001.demo22.test3;
import java.lang.annotation.*;
@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyBean {
}
创建一个类,使用这个注解标注
package com.javacode2018.lesson001.demo22.test3;
@MyBean
public class Service1 {
}
再来一个类,使用spring中的@Compontent
标注
package com.javacode2018.lesson001.demo22.test3;
import org.springframework.stereotype.Component;
@Component
public class Service2 {
}
再来一个类,使用@CompontentScan标注
package com.javacode2018.lesson001.demo22.test3;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.FilterType;
@ComponentScan(includeFilters = {
@ComponentScan.Filter(type = FilterType.ANNOTATION, classes = MyBean.class)
})
public class ScanBean3 {
}
上面指定了Filter的type为注解的类型,只要类上面有
@MyBean
注解的,都会被作为bean注册到容器中。
测试用例
ComponentScanTest中新增个测试用例
@Test
public void test3() {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ScanBean3.class);
for (String beanName : context.getBeanDefinitionNames()) {
System.out.println(beanName + “->” + context.getBean(beanName));
}
}
运行输出,截取了主要的几行
service1->com.javacode2018.lesson001.demo22.test3.Service1@6b81ce95
service2->com.javacode2018.lesson001.demo22.test3.Service2@2a798d51
Service1上标注了@MyBean
注解,被注册到容器了,但是Service2
上没有标注@MyBean
啊,怎么也被注册到容器了?
原因:Service2上标注了@Compontent
注解,而@CompontentScan注解中的useDefaultFilters
默认是true
,表示也会启用默认的过滤器,而默认的过滤器会将标注有@Component、@Repository、@Service、@Controller
这几个注解的类也注册到容器中
如果我们只想将标注有@MyBean
注解的bean注册到容器,需要将默认过滤器关闭,即:useDefaultFilters=false,我们修改一下ScanBean3的代码如下:
@ComponentScan(
useDefaultFilters = false, //不启用默认过滤器
includeFilters = {
@ComponentScan.Filter(type = FilterType.ANNOTATION, classes = MyBean.class)
})
public class ScanBean3 {
}
再次运行test3
输出:
service1->com.javacode2018.lesson001.demo22.test3.Service1@294425a7
扩展:自定义注解支持定义bean名称
上面的自定义的@MyBean注解,是无法指定bean的名称的,可以对这个注解做一下改造,加个value参数来指定bean的名称,如下:
@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Component //@1
public @interface MyBean {
@AliasFor(annotation = Component.class) //@2
String value() default “”; //@3
}
重点在于@1和@2这2个地方的代码,通过上面的参数可以间接给@Component注解中的value设置值。
这块用到了@AliasFor注解,对这块不了解的,可以去看一下:java注解详解及spring对注解的增强
修改一下Service1的代码:
@MyBean(“service1Bean”)
public class Service1 {
}
运行test3用例输出:
service1Bean->com.javacode2018.lesson001.demo22.test3.Service1@222545dc
此时bean名称就变成了service1Bean
。
案例:包含指定类型的类
下面的代码都位于com.javacode2018.lesson001.demo22.test4
包中。
来个接口
package com.javacode2018.lesson001.demo22.test4;
public interface IService {
}
让spring来进行扫描,类型满足IService的都将其注册到容器中。
来2个实现类
package com.javacode2018.lesson001.demo22.test4;
public class Service1 implements IService {
}
package com.javacode2018.lesson001.demo22.test4;
public class Service2 implements IService {
}
来一个@CompontentScan标注的类
package com.javacode2018.lesson001.demo22.test4;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.FilterType;
@ComponentScan(
useDefaultFilters = false, //不启用默认过滤器
includeFilters = {
@ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, classes = IService.class) //@1
})
public class ScanBean4 {
}
@1:被扫描的类满足
IService.class.isAssignableFrom(被扫描的类)
条件的都会被注册到spring容器中
来个测试用例
ComponentScanTest中新增个测试用例
@Test
public void test4() {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ScanBean4.class);
for (String beanName : context.getBeanDefinitionNames()) {
System.out.println(beanName + “->” + context.getBean(beanName));
}
}
运行输出
service1->com.javacode2018.lesson001.demo22.test4.Service1@6379eb
service2->com.javacode2018.lesson001.demo22.test4.Service2@294425a7
用法
有时候我们需要用到自定义的过滤器,使用自定义过滤器的步骤:
1.设置@Filter中type的类型为:FilterType.CUSTOM
2.自定义过滤器类,需要实现接口:org.springframework.core.type.filter.TypeFilter
3.设置@Filter中的classses为自定义的过滤器类型
来看一下TypeFilter
这个接口的定义:
@FunctionalInterface
public interface TypeFilter {
boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory)
throws IOException;
}
是一个函数式接口,包含一个match方法,方法返回boolean类型,有2个参数,都是接口类型的,下面介绍一下这2个接口。
MetadataReader接口
类元数据读取器,可以读取一个类上的任意信息,如类上面的注解信息、类的磁盘路径信息、类的class对象的各种信息,spring进行了封装,提供了各种方便使用的方法。
看一下这个接口的定义:
public interface MetadataReader {
/**
- 返回类文件的资源引用
*/
Resource getResource();
/**
- 返回一个ClassMetadata对象,可以通过这个读想获取类的一些元数据信息,如类的class对象、是否是接口、是否有注解、是否是抽象类、父类名称、接口名称、内部包含的之类列表等等,可以去看一下源码
*/
ClassMetadata getClassMetadata();
/**
- 获取类上所有的注解信息
*/
AnnotationMetadata getAnnotationMetadata();
}
MetadataReaderFactory接口
类元数据读取器工厂,可以通过这个类获取任意一个类的MetadataReader对象。
源码:
public interface MetadataReaderFactory {
自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数Java工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!
因此收集整理了一份《2024年Java开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Java开发知识点,真正体系化!
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!
如果你觉得这些内容对你有帮助,可以扫码获取!!(备注Java获取)
最后
Java架构学习技术内容包含有:Spring,Dubbo,MyBatis, RPC, 源码分析,高并发、高性能、分布式,性能优化,微服务 高级架构开发等等。
还有Java核心知识点+全套架构师学习资料和视频+一线大厂面试宝典+面试简历模板可以领取+阿里美团网易腾讯小米爱奇艺快手哔哩哔哩面试题+Spring源码合集+Java架构实战电子书+2021年最新大厂面试题。
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!
ta getClassMetadata();
/**
- 获取类上所有的注解信息
*/
AnnotationMetadata getAnnotationMetadata();
}
MetadataReaderFactory接口
类元数据读取器工厂,可以通过这个类获取任意一个类的MetadataReader对象。
源码:
public interface MetadataReaderFactory {
自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数Java工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!
因此收集整理了一份《2024年Java开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。[外链图片转存中…(img-8NMigwyI-1713338479965)]
[外链图片转存中…(img-YOWcNZkX-1713338479965)]
[外链图片转存中…(img-Ti7f5dUf-1713338479965)]
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Java开发知识点,真正体系化!
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!
如果你觉得这些内容对你有帮助,可以扫码获取!!(备注Java获取)
最后
Java架构学习技术内容包含有:Spring,Dubbo,MyBatis, RPC, 源码分析,高并发、高性能、分布式,性能优化,微服务 高级架构开发等等。
还有Java核心知识点+全套架构师学习资料和视频+一线大厂面试宝典+面试简历模板可以领取+阿里美团网易腾讯小米爱奇艺快手哔哩哔哩面试题+Spring源码合集+Java架构实战电子书+2021年最新大厂面试题。
[外链图片转存中…(img-4KTl9hoq-1713338479966)]
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取!