spring注解的那些事-1

基于Schema的配置

schema是一种基于xml配置文件的约束,spring中常见的schema有bean、aop、tx、context

http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd

将所有的组件配置在xml文件中,通过加载配置文件将组建装配到ioc容器中,配置文件中使用<bean>可以配置一个bean,举个栗子,配置一个Person对象到ioc容器中

<bean id="person" class="a.b.c.Person">
    <property name="car" ref="xxx"/>
</bean>

有了定义好的配置文件,如何加载配置文件呢?以下是两种常见的加载方式

// 通过文件系统加载
ApplicationContext applicationContext = new FileSystemXmlApplicationContext("src/main/resources/ioc/applicationContext-beanFactory.xml");
// 通过classpath加载
ApplicationContext applicationContext = new ClassPathXmlApplicationContext("classpath:ioc/applicationContext-beanFactory.xml");

配置文件这种方式在spring2.5、spring3.x都是常见的加载配置文件方式,稍微有些规模的项目都会造成配置文件爆炸,然后对配置文件进行拆分,比如按三层架构的方式拆分:

  • applicationContext-web.xml:web mvc架构中controller组建相关的配置(Struts2的Action、SpringMVC的Controller)
  • applicationContext-service.xml:业务层组建配置
  • applicationContext-dao.xml:持久层组建配置

也可以按照功能模块拆分配置文件,但仍然无法避免单个配置文件过大的问题

基于注解的配置

JDK在1.5开始支持主机,spring作为java领域事实的工业标准,也对注解有非常友好的支持,真的是非常之友好。常见的注解@Controller@Service@Repository,这三个注解都是从@Component派生出来的,加载注解的方式相对比较单一,使用AnnotationConfigApplicationContext类,构造方法中传入一个配置类,该类被@Configuration标注,等同于是applicationContext.xml文件

AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(BeanConfig.class);

随着springboot大行其道,注解在整个spring体系中越发的重要,有多重要呢,不懂spring的注解,就不懂springboot的自动装配,不懂自动装配就是不懂springboot,下面我将详细的说说与注解有关的那些事

@Configuration

@Configuration声明当前类为一个配置类,功能类似于applicationContext.xml文件,看一下这个注解是如何定义的

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Configuration {
    String value() default "";
}

只能标注在类级别的,被@Component标注,也就是派生自@Component,注解中只有一个属性value,被@Configuration标注的类在ioc容器中默认id/name是类名(首字母小写),如果向自定义名称使用value属性

@Configuration
public class BeanConfig{}

BeanConfig在ioc容器中默认的id=beanConfig,如果想自定义名称为beanConfiguration,使用value属性修改@Configuration(value="beanConfiguration"),@Configuration对类进行标注,只能声明该类为配置类,并不能实现xml配置中<bean>标签的作用

@Bean

@Configuration必须联合@Bean一起使用才有意义,表示类中所有带@Bean注解的方法都会被spring调用,方法返回的对象都由容器管理

@Bean注解可以声明在方法和注解上,声明在方法上时,该方法的方法名就是该bean在ioc容器中的id/name

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Bean {}

举个栗子,有一Person对象实例,想交由ioc容器管理,声明一个方法bill(),在方法上使用@Bean注解,返回值Person对象的实例就由ioc容器管理,在ioc容器中的id/name就是方法名称bill

@Bean
public Person bill(){
    return new Person("bill",30);
}

@Scope

容器中的bean可以配置是否为单例,比如配置Person对象实例bill为多实例bean,即每次获取都new一个新的实例,可以使用@Scope注解

@Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
@Bean
public Person bill(){
    return new Person("bill",30);
}

bean scope有两种:

  • singleton:IoC容器初始化时实例化bean
  • prototype:IoC容器初始化时不会创建对象,获取bean时才初始化对象

@Lazy

@Lazy作用是配置容器中的单例bean是否需要懒加载,既想配置bean为单例,又想实现懒加载时,使用@Lazy

    @Bean
    @Lazy
    @Scope(ConfigurableBeanFactory.SCOPE_SINGLETON)
    public Person person() {
        return new Person("苍老师", 20);
    }

此时苍老师就是一个单例bean,但是不会随着ioc容器启动而被初始化,只有当被调用时,才会初始化,实现了单例bean懒加载的效果

@ComponentScan

使用@Configuration+@Bean每次都需要定义方法,将方法的返回值交由容器管理,有没有一种更简洁的方式能将package下的一些类统一的交由容器处理呢?spring使用包扫描实现这一功能,@ComponentScan只能标注在类上

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Repeatable(ComponentScans.class)
public @interface ComponentScan {
    @AliasFor("basePackages")
    String[] value() default {};
    @AliasFor("value")
    String[] basePackages() default {};

    Filter[] includeFilters() default {};
    Filter[] excludeFilters() default {};

    boolean useDefaultFilters() default true;
}

挑几个@ComponentScan注解中比较重要的属性介绍一下:

  • basePackages:扫描的包路径信息,比如basePackages="com.foo",表示扫描com.foo包下bean,什么样的bean能被@ComponentScan扫描到呢,由includeFilters决定
  • includeFilters:扫描被哪些注解标注的类,默认扫描@Componet注解和@Componet派生出的注解,常见的派生注解@Controller、@Service、@Repository,是怎么确定只扫描@Componet注解和派生注解呢,这个要看一下ClassPathBeanDefinitionScanner的构造器实现类,这个类是BeanDefinition的扫描器实现
    public ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry, boolean useDefaultFilters,
            Environment environment, ResourceLoader resourceLoader) {

        Assert.notNull(registry, "BeanDefinitionRegistry must not be null");
        this.registry = registry;

        if (useDefaultFilters) {
            registerDefaultFilters();
        }
        setEnvironment(environment);
        setResourceLoader(resourceLoader);
    }
    protected void registerDefaultFilters() {
        this.includeFilters.add(new AnnotationTypeFilter(Component.class));
                // 略...
        }

其中useDefaultFilters是ComponentScan中的一个属性,默认取值为true,会调用registerDefaultFilters(),在该方法中添加里要扫描的注解Component

// 扫描com.foo包下被Controller标注的对象
@ComponentScan(value="com.foo",includeFilters ={@ComponentScan.Filter(classes = {Controller.class})},useDefaultFilters =false)

要想includeFilters配置生效,一定要禁用掉默认includeFilters规则useDefaultFilters =false

  • excludeFilters:不需要扫描的注解
// 扫描com.foo包下的类,但不包含Controller
@ComponentScan(value="com.foo",excludeFilters = {@ComponentScan.Filter(classes={Controller.class})})
  • @ComponentScan.Filter:includeFilters也是可以自定义的,不使用spring提供的那套默认规则,Filter是ComponentScan的内部类,定义如下
@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会更直观一些,只扫描com.foo包下的@Controller注解标注的bean,想要使用自定义的includeFilters策略,useDefaultFilters一定要设置为false,否则就会使用spring默认的扫描策略,前面源码已经分析过了,默认的FilterType是注解类型的

@ComponentScans({
        @ComponentScan(basePackages = "com.foo", includeFilters = {@ComponentScan.Filter(type = FilterType.ANNOTATION, value = Controller.class)}, useDefaultFilters = false)
})

FilterType也是可以自定义的,需要自己实现TypeFilter接口,看个栗子

@ComponentScan(basePackages = "com.foo", includeFilters = {@ComponentScan.Filter(type = FilterType.CUSTOM, classes={MyTypeFilter.class})}, useDefaultFilters = false)

FilterType.CUSTOM表示自定义过滤规则,MyTypeFilter.class的规则是扫描com.foo包下类名中包含Service、Dao关键字的,其它的都过滤

public class MyTypeFilter implements TypeFilter {
    /**
     *
     * @param metadataReader:类源数据信息
     * @param metadataReaderFactory:类元数据工厂
     * @return
     * @throws IOException
     */
    @Override
    public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory) throws IOException {
        // 获取当前类的资源信息,如路径
        Resource resource = metadataReader.getResource();
        // 获取当前注解的信息
        AnnotationMetadata annotationMetadata = metadataReader.getAnnotationMetadata();
        // 获取当前类的信息
        ClassMetadata classMetadata = metadataReader.getClassMetadata();
        if(classMetadata.getClassName().contains("Service")|| classMetadata.getClassName().contains("Dao")){
            return true;
        }
        return false;
    }
}

以上就是@ComponentScan比较常用的使用方式

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容