hualinux spring 3.13：在 classpath 中扫描组件

最新推荐文章于 2023-06-27 10:56:42 发布

hualinux

最新推荐文章于 2023-06-27 10:56:42 发布

阅读量220

点赞数

分类专栏： java基础篇3 spring 基于XML 文章标签： hualinux hualinux spring spring 组件扫描 classpath 扫描组件 Autowired注解

本文链接：https://blog.csdn.net/hualinux/article/details/106960861

版权

java基础篇3 spring 基于XML 专栏收录该内容

19 篇文章 0 订阅

订阅专栏

2.2 例1：通过resource-pattern指定扫描的资源

3.3 使用 @Autowired 自动装配 Bean

3.4 如果类有冲突怎办

四、使用 @Resource 或 @Inject 自动装配 Bean

spring扫描组件这个使用频率是比较高的，要熟悉

一、知识点

组件扫描(component scanning): Spring 能够从 classpath 下自动扫描, 侦测和实例化具有特定注解的组件.
特定组件包括:
@Component: 基本注解, 标识了一个受 Spring 管理的组件
@Repository: 标识持久层组件
@Service: 标识服务层(业务层)组件
@Controller: 标识表现层组件
对于扫描到的组件, Spring 有默认的命名策略: 使用非限定类名, 第一个字母小写. 也可以在注解中通过 value 属性值标识组件的名称

1、@controller 控制器（注入服务）
2、@service 服务（注入dao）
3、@repository dao（实现dao访问）
4、@component （把普通pojo实例化到spring容器中，相当于配置文件中的<bean id="" class=""/>）

@Component,@Service,@Controller,@Repository注解的类，并把这些类纳入进spring容器中管理。
下面写这个是引入component的扫描组件
<context:component-scan base-package=”com.mmnc”>

其中base-package为需要扫描的包（含所有子包）
       1、@Service用于标注业务层组件
       2、@Controller用于标注控制层组件(如struts中的action)
       3、@Repository用于标注数据访问组件，即DAO组件.
       4、@Component泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。
           @Service public class UserServiceImpl implements UserService { }
           @Repository public class UserDaoImpl implements UserDao { } getBean的默认名称是类名（头字母小写），如果想自定义，可以@Service(“***”) 这样来指定，这种bean默认是单例的，如果想改变，可以使用@Service(“beanName”) @Scope(“prototype”)来改变。
       可以使用以下方式指定初始化方法和销毁方法（方法名任意）： @PostConstruct public void init() { }

当在组件类上使用了特定的注解之后, 还需要在 Spring 的配置文件中声明 <context:component-scan> ：
base-package 属性指定一个需要扫描的基类包，Spring 容器将会扫描这个基类包里及其子包中的所有类.
当需要扫描多个包时, 可以使用逗号分隔.
如果仅希望扫描特定的类而非基包下的所有类，可使用 resource-pattern 属性过滤特定的类，示例：

<context:component-scan base- package= "com.hualinux.spring.beans resource- pattern= "autowire/*.class"/ >

<context:include-filter> 子节点表示要包含的目标类
<context:exclude-filter> 子节点表示要排除在外的目标类
<context:component-scan> 下可以拥有若干个 <context:include-filter> 和 <context:exclude-filter> 子节点
<context:include-filter> 和 <context:exclude-filter> 子节点支持多种类型的过滤表达式：

二、例子

2.1 普通例子

2.1.1 目录结构

2.1.2 代码

src--> beans-annotation.xml

src右击-->new-->XML Configuration File-->Spring config-->输入名字“beans-annotation” ，凡是后面创建xml我都简写

src-->xxx.xml

<!-- 指定Spring IOC 容器扫描的包-->
<context:component-scan base-package="com.hualinux.beans.annotation" />

src-->com.hualinux.beans.annotation.controller.UserController.java

package com.hualinux.beans.annotation.controller;

import org.springframework.stereotype.Controller;

@Controller
public class UserController {
    public void execute(){
        System.out.println("UserController execute...");
    }
}

src-->com.hualinux.beans.annotation.repository.UserRepository.java

package com.hualinux.beans.annotation.repository;

public interface UserRepository {
    void save();
}

src-->com.hualinux.beans.annotation.repository.UserRepositoryImpl.java

package com.hualinux.beans.annotation.repository;

import org.springframework.stereotype.Repository;

@Repository("userRepository")
public class UserRepositoryImpl implements UserRepository {
    @Override
    public void save() {
        System.out.println("UserRepository Save...");
    }
}

src-->com.hualinux.beans.annotation.service.UserService.java

package com.hualinux.beans.annotation.service;

import org.springframework.stereotype.Service;

@Service
public class UserService {
    public void add(){
        System.out.println("UserService add...");
    }
}

src-->com.hualinux.beans.annotation.TestObject.java

package com.hualinux.beans.annotation;

import org.springframework.stereotype.Component;

@Component
public class TestObject {

}

src-->com.hualinux.beans.annotation.Main.java

package com.hualinux.beans.annotation;

import com.hualinux.beans.annotation.controller.UserController;
import com.hualinux.beans.annotation.repository.UserRepository;
import com.hualinux.beans.annotation.service.UserService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Main {
    public static void main(String[] args) {
        ApplicationContext ctx = new ClassPathXmlApplicationContext("beans-annotation.xml");

        TestObject to = (TestObject) ctx.getBean("testObject");
        System.out.println(to);

        UserController userController = (UserController) ctx.getBean("userController");
        System.out.println(userController);

        UserService userService = (UserService) ctx.getBean("userService");
        System.out.println(userService);

        UserRepository userRepository = (UserRepository) ctx.getBean("userRepository");
        System.out.println(userRepository);

    }
}

运行如果如下：

com.hualinux.beans.annotation.TestObject@bcec361
com.hualinux.beans.annotation.controller.UserController@26794848
com.hualinux.beans.annotation.service.UserService@302552ec
com.hualinux.beans.annotation.repository.UserRepositoryImpl@3d285d7e

2.2 例1：通过resource-pattern指定扫描的资源

上面的例子就是了，在这里把上面例子中的 com.hualinux.beans.annotation.Main.java修改一下，只剩下“UserRepository”其余的注解掉，以方便后台例子测试

package com.hualinux.beans.annotation;

import com.hualinux.beans.annotation.controller.UserController;
import com.hualinux.beans.annotation.repository.UserRepository;
import com.hualinux.beans.annotation.service.UserService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Main {
    public static void main(String[] args) {
        ApplicationContext ctx = new ClassPathXmlApplicationContext("beans-annotation.xml");

/*        TestObject to = (TestObject) ctx.getBean("testObject");
        System.out.println(to);

        UserController userController = (UserController) ctx.getBean("userController");
        System.out.println(userController);

        UserService userService = (UserService) ctx.getBean("userService");
        System.out.println(userService);*/

        UserRepository userRepository = (UserRepository) ctx.getBean("userRepository");
        System.out.println(userRepository);

    }
}

2.3 例2：过滤表达式<context:include-filter>

<context:include-filter> 和 <context:exclude-filter> 子节点支持多种类型的过滤表达式

<!--

context:exclude-filter 子节点指定排除哪些指定表达式组件

context:include-filter 子节点指定包含哪些表达式组件，该子节点需要 use-default-filters 配合使用

-->

修改一下 beans-annotation.xml配置文件

    <!-- 指定Spring IOC 容器扫描的包-->
    <!--     可以通过resource-pattern指定扫描的资源
        <context:component-scan base-package="com.hualinux.beans.annotation" resource-pattern="repository/*.class" />-->

    <!-- context:exclude-filter子节点指定排除哪些指定表达式组件-->
    <context:component-scan base-package="com.hualinux.beans.annotation"    use-default-filters="false">
        <context:include-filter type="annotation" expression="org.springframework.stereotype.Repository" />
    </context:component-scan>



    <!--    &lt;!&ndash; 指定Spring IOC 容器扫描的包&ndash;&gt;
        <context:component-scan base-package="com.hualinux.beans.annotation" />-->

运行com.hualinux.beans.annotation.Main.java，结果为：

com.hualinux.beans.annotation.repository.UserRepositoryImpl@489115ef

2.4 例3：过滤表达式<context:exclude-filter>

修改beans-annotation.xml配置文件

    <!--
     context:exclude-filter 子节点指定排除哪些指定表达式组件
     context:include-filter 子节点指定包含哪些表达式组件，该子节点需要 use-default-filters 配合使用
     -->
    <context:component-scan base-package="com.hualinux.beans.annotation" >
        <context:exclude-filter type="assignable" expression="com.hualinux.beans.annotation.repository.UserRepository" />
    </context:component-scan>


    <!-- 指定Spring IOC 容器扫描的包-->
    <!--     可以通过resource-pattern指定扫描的资源
        <context:component-scan base-package="com.hualinux.beans.annotation" resource-pattern="repository/*.class" />-->

    <!-- context:exclude-filter子节点指定排除哪些指定表达式组件-->
<!--
    <context:component-scan base-package="com.hualinux.beans.annotation"    use-default-filters="false">
        <context:include-filter type="annotation" expression="org.springframework.stereotype.Repository" />
    </context:component-scan>
-->



    <!--    &lt;!&ndash; 指定Spring IOC 容器扫描的包&ndash;&gt;
        <context:component-scan base-package="com.hualinux.beans.annotation" />-->

com.hualinux.beans.annotation.Main.java修改如下

package com.hualinux.beans.annotation;

import com.hualinux.beans.annotation.controller.UserController;
import com.hualinux.beans.annotation.repository.UserRepository;
import com.hualinux.beans.annotation.service.UserService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Main {
    public static void main(String[] args) {
        ApplicationContext ctx=new ClassPathXmlApplicationContext("beans-annotation.xml");

        TestObject to= (TestObject) ctx.getBean("testObject");
        System.out.println(to);

        UserController userController= (UserController) ctx.getBean("userController");
        System.out.println(userController);

        UserService userService= (UserService) ctx.getBean("userService");
        System.out.println(userService);

//        UserRepository userRepository= (UserRepository) ctx.getBean("userRepository");
//        System.out.println(userRepository);
        
    }
}

运行它，结果如下

com.hualinux.beans.annotation.TestObject@3c9754d8
com.hualinux.beans.annotation.controller.UserController@3bf7ca37
com.hualinux.beans.annotation.service.UserService@79079097

三、组件装配

3.1 知识点

<context:component-scan> 元素还会自动注册 AutowiredAnnotationBeanPostProcessor 实例, 该实例可以自动装配具有 @Autowired 和 @Resource 、@Inject注解的属性.

3.2 没使用组件装配引入的例子

根据：

1、@controller 控制器（注入服务）
2、@service 服务（注入dao）
3、@repository dao（实现dao访问）
4、@component （把普通pojo实例化到spring容器中，相当于配置文件中的<bean id="" class=""/>）

没装配前的代码：beans-annotation.xml 只有下面代码

<context:component-scan base-package="com.hualinux.beans.annotation" />

com.hualinux.beans.annotation.controller.UserController修改为：

package com.hualinux.beans.annotation.controller;

import com.hualinux.beans.annotation.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;

//这个注解一定要写，否则不能自动添加到Ioc容器中，我这里故意先不写
//@Controller
public class UserController {
    @Autowired
    private UserService userService;

    public void execute(){
        System.out.println("UserController execute...");
        userService.save();
    }
}

com.hualinux.beans.annotation.service.UserService.java修改为

package com.hualinux.beans.annotation.service;

import com.hualinux.beans.annotation.repository.UserRepository;
import org.springframework.stereotype.Service;

@Service
public class UserService implements UserRepository{

    @Override
    public void save() {
        System.out.println("UserRepository Save...");
    }
}

com.hualinux.beans.annotation. repository.UserRepository.java不变

com.hualinux.beans.annotation. repository.UserRepositoryImpl.java不变

com.hualinux.beans.annotation.Main.java修改为

package com.hualinux.beans.annotation;

import com.hualinux.beans.annotation.controller.UserController;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Main {
    public static void main(String[] args) {
        ApplicationContext ctx=new ClassPathXmlApplicationContext("beans-annotation.xml");
        UserController userController= (UserController) ctx.getBean("userController");
        System.out.println(userController);
        userController.execute();
    }
}

运行结果，发现报错了：

空指针，UserController类肯定有问题，打开看一下，如下图所示：

3.3 使用 @Autowired 自动装配 Bean

@Autowired 注解自动装配具有兼容类型的单个 Bean属性

构造器, 普通字段(即使是非 public), 一切具有参数的方法都可以应用@Authwired 注解
默认情况下, 所有使用 @Authwired 注解的属性都需要被设置. 当 Spring 找不到匹配的 Bean 装配属性时, 会抛出异常, 若某一属性允许不被设置, 可以设置 @Authwired 注解的 required 属性为 false
默认情况下, 当 IOC 容器里存在多个类型兼容的 Bean 时, 通过类型的自动装配将无法工作. 此时可以在 @Qualifier 注解里提供 Bean 的名称. Spring 允许对方法的入参标注 @Qualifiter 已指定注入 Bean 的名称
@Authwired 注解也可以应用在数组类型的属性上, 此时 Spring 将会把所有匹配的 Bean 进行自动装配.
@Authwired 注解也可以应用在集合属性上, 此时 Spring 读取该集合的类型信息, 然后自动装配所有与之兼容的 Bean.
@Authwired 注解用在 java.util.Map 上时, 若该 Map 的键值为 String, 那么 Spring 将自动装配与之 Map 值类型兼容的 Bean, 此时 Bean 的名称作为键值

例子从上面的代码中修改一下，在属性上添加一个@Authwired注解

com.hualinux.beans.annotation.controller.UserController.java 修改代码如下：

package com.hualinux.beans.annotation.controller;

import com.hualinux.beans.annotation.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;

@Controller
public class UserController {
    @Autowired
    private UserService userService;

    public void execute(){
        System.out.println("UserController execute...");
        userService.add();
    }
}

com.hualinux.beans.annotation.service.UserService.java 代码修改如下：

package com.hualinux.beans.annotation.service;

import com.hualinux.beans.annotation.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserService{
    @Autowired
    private UserRepository userRepository;

    public void add(){
        System.out.println("UserService add...");
        userRepository.save();
    }

}

com.hualinux.beans.annotation. repository.UserRepository.java不变

com.hualinux.beans.annotation. repository.UserRepositoryImpl.java不变

运行com.hualinux.beans.annotation.Main.java，结果如下：

com.hualinux.beans.annotation.controller.UserController@55b0dcab
UserController execute...
UserService add...
UserRepository Save...

3.4 如果类有冲突怎办

com.hualinux.beans.annotation. repository.UserRepositoryImpl.java改一下把

@Repository("userRepository")

改为

@Repository

添加多一个类

src-->com.hualinux.beans.annotation.repository.UserJdbcRepository.java，代码如下：

package com.hualinux.beans.annotation.repository;

import org.springframework.stereotype.Repository;

@Repository
public class UserJdbcRepository implements UserRepository {
    @Override
    public void save() {
        System.out.println("UserJdbcRepository save...");
    }
}

运行com.hualinux.beans.annotation.Main.java，发现报错：

....

..No qualifying bean of type 'com.hualinux.beans.annotation.repository.UserRepository' available: expected single matching bean but found 2: userJdbcRepository,userRepositoryImpl

...

再看一下UserService类idea也自动提示有问题了

原因是上面2个bean继承“userRepository”类，在UserSerice类中不能唯一区分到底是调用哪个bean的save方法

解决：

像之前那个，指定哪个是默认的

@Repository("userRepository")

添加@Qualifier 注解，指定一个类

package com.hualinux.beans.annotation.service;

import com.hualinux.beans.annotation.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Service;

@Service
public class UserService{
    @Autowired
    //注意思第一个字母是小写
    @Qualifier("userRepositoryImpl")
    private UserRepository userRepository;

    public void add(){
        System.out.println("UserService add...");
        userRepository.save();
    }

}

四、使用 @Resource 或 @Inject 自动装配 Bean

Spring 还支持 @Resource 和 @Inject 注解，这两个注解和 @Autowired 注解的功用类似
@Resource 注解要求提供一个 Bean 名称的属性，若该属性为空，则自动采用标注处的变量或方法名作为 Bean 的名称
@Inject 和 @Autowired 注解一样也是按类型匹配注入的 Bean，但没有 reqired 属性
建议使用 @Autowired 注解