Spring自动扫描组件

Spring将所有的bean都纳入到IoC中创建、管理和维护,一个系统往往有成千上万的组件,如果需要手动将所有组件都放入spring容器中去管理,这样spring配置文件将变得非常冗余且庞大,管理也将十分不方便。

从Spring2.5开始引入了组件自动扫描机制,你可以不用在xml文件中配置繁琐的bean,Spring会自动扫描、检查你指定包的bean或component。

Spring容器提供了@Component@Bean注解来标记如何向IoC容器添加Bean。在@Component基础上又派生出

@Controller@Service@Repository这三个注解(在其他的Spring工程或包中还有更多的派生)。

@Controller@Service@Repository注释是在@Component基础上添加了角色的组件,它们分别用于表示层、服务层和数据访问层。

下面是一个简单的Spring项目,包括自定义的service和dao层。我们研究一下在Spring中手动声明组件和自动扫描组件之间的区别。

1、手动声明组件

创建EmployeeServicebean ,如下所示。

EmployeeService.java

package com.wxbsht.spring.componentscan.example.service;

import com.wxbsht.spring.componentscan.example.dao.EmployeeDao;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

/**
 * @author HP-susht
 * @create 2020/4/27 11:31
 */

public class EmployeeService {

    private EmployeeDao employeeDao;
    
    public void setEmployeeDao(EmployeeDao employeeDao) {
        this.employeeDao = employeeDao;
    }

    public void doSomething(){
        System.out.println("Inside EmployeeService's doSomething() method.");
        employeeDao.doSomething();
    }
}

创建EmployeeDaobean ,如下所示。

EmployeeDao.java

package com.wxbsht.spring.componentscan.example.dao;

import org.springframework.stereotype.Repository;

/**
 * @author HP-susht
 * @create 2020/4/27 11:32
 */
public class EmployeeDao {

    public void doSomething() {
        System.out.println("Inside EmployeeDao's doSomething() method.");
    }
}

Bean配置文件(beans.xml), Spring中的普通Bean配置。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">

    <bean id="employeeDao" class="com.wxbsht.spring.componentscan.example.dao.EmployeeDao"/>
    <bean id="employeeService" class="com.wxbsht.spring.componentscan.example.service.EmployeeService">
        <property name="employeeDao" ref="employeeDao"/>
    </bean>
</beans>

运行主程序MainApplication.java

package com.wxbsht.spring.componentscan.example;

import com.wxbsht.spring.componentscan.example.config.AppConfig;
import com.wxbsht.spring.componentscan.example.service.EmployeeService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

/**
 * @author HP-susht
 * @create 2020/4/27 11:35
 */
public class MainApplication {
    public static void main(String[] args) {
        ApplicationContext context=new ClassPathXmlApplicationContext("beans.xml");
        EmployeeService service = context.getBean(EmployeeService.class);
        service.doSomething();
    }
}

输出

Inside EmployeeService's doSomething() method.
Inside EmployeeDao's doSomething() method.

2、自动扫描组件

在Spring框架中,我们可以使用以下命令来启用组件自动扫描

  • <context:component-scan/>基于XML的配置中的元素
  • @ComponentScan 基于Java的配置中的注释
  • AnnotationConfigApplicationContext#scan()方法

2.1、创建Spring组件

创建EmployeeServicebean ,如下所示。

EmployeeService.java

package com.wxbsht.spring.componentscan.example.service;

import com.wxbsht.spring.componentscan.example.dao.EmployeeDao;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

/**
 * @author HP-susht
 * @create 2020/4/27 11:31
 */

@Service
public class EmployeeService {

    @Autowired
    private EmployeeDao employeeDao;

    public void doSomething(){
        System.out.println("Inside EmployeeService's doSomething() method.");
        employeeDao.doSomething();
    }
}

创建EmployeeDaobean ,如下所示。

EmployeeDao.java

package com.wxbsht.spring.componentscan.example.dao;

import org.springframework.stereotype.Repository;

/**
 * @author HP-susht
 * @create 2020/4/27 11:32
 */

@Repository
public class EmployeeDao {

    public void doSomething() {
        System.out.println("Inside EmployeeDao's doSomething() method.");
    }
}

2.2、使用<context:component-scan />元素启用组件扫描

要在基于XML的配置中启用自动组件扫描,使用以下<context:component-scan base-package=""/>元素。

beans.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">

     <!--<context:component-scan base-package="com.wxbsht.spring.componentscan.example"/>-->
    
    <context:component-scan base-package="com.wxbsht.spring.componentscan.example.service,
                                         com.wxbsht.spring.componentscan.example.dao"/>
</beans>

运行应用程序MainApplication.java

package com.wxbsht.spring.componentscan.example;

import com.wxbsht.spring.componentscan.example.config.AppConfig;
import com.wxbsht.spring.componentscan.example.service.EmployeeService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

/**
 * @author HP-susht
 * @create 2020/4/27 11:35
 */
public class MainApplication {
    public static void main(String[] args) {
        ApplicationContext context=new ClassPathXmlApplicationContext("beans.xml");
        EmployeeService service = context.getBean(EmployeeService.class);
        service.doSomething();
    }
}

输出

Inside EmployeeService's doSomething() method.
Inside EmployeeDao's doSomething() method.

2.3、使用@ComponentScan注解启用组件扫描

要在基于Java的配置中启用自动组件扫描。

AppConfig.java

package com.wxbsht.spring.componentscan.example.config;

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

/**
 * @author HP-susht
 * @create 2020/4/27 11:37
 */
@Configuration
@ComponentScan(basePackages = { "com.wxbsht.spring.componentscan.example.dao",
        "com.wxbsht.spring.componentscan.example.service"})
public class AppConfig {
}

运行应用程序。

MainApplication.java

package com.wxbsht.spring.componentscan.example;

import com.wxbsht.spring.componentscan.example.config.AppConfig;
import com.wxbsht.spring.componentscan.example.service.EmployeeService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

/**
 * @author HP-susht
 * @create 2020/4/27 11:35
 */
public class MainApplication {
    public static void main(String[] args) {
//        ApplicationContext context=new ClassPathXmlApplicationContext("beans.xml");
//        EmployeeService service = context.getBean(EmployeeService.class);
//        service.doSomething();

        ApplicationContext context1=new AnnotationConfigApplicationContext(AppConfig.class);
        EmployeeService service1 = context1.getBean(EmployeeService.class);
        service1.doSomething();

    }
}

输出

Inside EmployeeService's doSomething() method.
Inside EmployeeDao's doSomething() method.

2.4、使用上下文的scan()方法启用组件扫描

不使用XML或基于java的配置,我们可以使用以下注释configapplicationcontext #scan()方法启用组件扫描。

MainApplication.java

package com.wxbsht.spring.componentscan.example;

import com.wxbsht.spring.componentscan.example.config.AppConfig;
import com.wxbsht.spring.componentscan.example.service.EmployeeService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

/**
 * @author HP-susht
 * @create 2020/4/27 11:35
 */
public class MainApplication {
    public static void main(String[] args) {
//        ApplicationContext context=new ClassPathXmlApplicationContext("beans.xml");
//        EmployeeService service = context.getBean(EmployeeService.class);
//        service.doSomething();

//        ApplicationContext context1=new AnnotationConfigApplicationContext(AppConfig.class);
//        EmployeeService service1 = context1.getBean(EmployeeService.class);
//        service1.doSomething();


        AnnotationConfigApplicationContext context3 =
                new AnnotationConfigApplicationContext();

        context3.scan("com.wxbsht.spring.componentscan.example.service");
        context3.scan("com.wxbsht.spring.componentscan.example.dao");
        context3.refresh();

        EmployeeService service3 = context3.getBean(EmployeeService.class);
        service3.doSomething();
        context3.close();

    }
}

输出

Inside EmployeeService's doSomething() method.
Inside EmployeeDao's doSomething() method.

2.5、自定义自动扫描组件名称

默认情况下,Spring将组件类名首字母小写后作为组件在容器中的id(employeeService)。您可以使用此名称“employeeService”获取此组件。

    EmployeeService service = (EmployeeService)context.getBean("employeeService");

要为组件创建一个自定义名称,您可以按如下代码自定义名称:

@Service("AAA")
public class EmployeeService 
...

现在,您可以使用“ AAA”这个名称来获取它

    EmployeeService cust = (EmployeeService)context.getBean("AAA");

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

推荐阅读更多精彩内容