Spring IOC源码阅读(二)-Spring IOC容器使用示例

142 阅读2分钟

前言

概览Spring IOC容器文章中,介绍了Spring IOC容器是什么、它的作用是什么、它的主要组成部分是什么以及各组成部分之间的关系。需要强调的是:Spring IOC容器可以简单理解为BeanFactory或ApplicationContext接口的实现类,为了增加读者的体感,接下来分别使用BeanFactory、AppliactionContext的实现类作为Spring IOC容器。

Spring IOC容器使用示例

环境准备

  1. maven依赖:
<?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">
  <modelVersion>4.0.0</modelVersion>

  <groupId>org.example</groupId>
  <artifactId>spring-source-read</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>

  <name>spring-source-read Maven Webapp</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <spring.version>5.2.4.RELEASE</spring.version>
  </properties>

  <dependencies>
    <!--spring核心包-->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>${spring.version}</version>
    </dependency>
  </dependencies>
  <build>
    <finalName>spring-source-read</finalName>
    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
      <plugins>
        <plugin>
          <artifactId>maven-clean-plugin</artifactId>
          <version>3.1.0</version>
        </plugin>
        <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
        <plugin>
          <artifactId>maven-resources-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>2.22.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-war-plugin</artifactId>
          <version>3.2.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-install-plugin</artifactId>
          <version>2.5.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-deploy-plugin</artifactId>
          <version>2.8.2</version>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>
</project>

  1. 项目结构:

image.png

  1. MyTestBean代码:
package ioc.container.demo;

import org.springframework.stereotype.Component;

@Component
public class MyTestBean {
    public void print() {
        System.out.println("执行 ioc.container.demo.MyTestBean.print");
    }
}

BeanFactory实现类的使用示例

示例代码:
package ioc.container.demo;

import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.context.annotation.ClassPathBeanDefinitionScanner;

public class AppStarter {
    public static void main(String[] args) {
        // 实例化Spring IOC容器
        DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
        // 实例化BeanDefinition扫描器,作用是:
        // 1.定位BeanDefinition的Resource;
        // 2.解析BeanDefinition
        // 3.注册BeanDefinition到BeanFactory中
        ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(beanFactory);
        scanner.scan("ioc.container.demo");
        // 根据类型获取Bean
        MyTestBean myTestBean = beanFactory.getBean(MyTestBean.class);
        myTestBean.print();
    }
}

运行结果:

image.png

代码讲解:
  1. 我们首先示例化了一个DefaultListableBeanFactory对象作为Spring IOC容器,从它的继承结果图来看,DefaultListableBeanFactory不仅实现了BeanFactory接口,还是实现了BeanDefinitionRegitry接口,因此它具备作为Spring IOC容器的基础功能,还具备往Spring IOC容器注册BeanDefinition的能力,由此可以看出:Spring IOC各个组件并不是一个个独立的个体,而是一个有机的整体。 image.png
  2. 实例化ClassPathBeanDefinitionScanner对象,它需要一个BeanDefinitionRegitry对象作为构造参数,由于DefaultListableBeanFactory实现了BeanDefinitionRegitry,所以DefaultListableBeanFactory对象可以作为参数传入。 image.png
  3. 调用ClassPathBeanDefinitionScanner的scann()方法,该方法内部实现是:
    1. 定位BeanDefinition的Resource
    2. 加载BeanDefinition
    3. 注册BeanDefinition到Spring IOC容器
  4. 通过DefaultListableBeanFactory的getBean()成功得到MyTestBean对象,说明Spring IOC容器已经替我们实例化了MyTestBean对象。调用print()日志打印正常。

ApplicationContext接口实现类的使用示例

示例代码:
package ioc.container.demo;

import org.springframework.beans.factory.support.BeanDefinitionReader;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.context.annotation.AnnotatedBeanDefinitionReader;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.ClassPathBeanDefinitionScanner;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.DefaultResourceLoader;

public class AppStarter {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext("ioc.container.demo");
        MyTestBean myTestBean = applicationContext.getBean(MyTestBean.class);
        myTestBean.print();
    }
}

运行结果

image.png

代码讲解
  1. 实例化AnnotationConfigApplicationContext对象作为Spring IOC容器,将包名作为参数传入。可以看到它分别实现了ResourceLoader、BeanFactory、BeanDefinitionRegistry接口,且它内部持有一个ClassPathBeanDefinitionScanner对象,因此AnnotationConfigApplicationContext不仅具备Spring IOC容器的基础功能,同样可以将Resource中的BeanDefinition加载到Spring IOC容器。image.pngimage.png
  2. 直接通过AnnotationConfigApplicationContext的getBean()成功得到MyTestBean对象。

最后

如果这篇文章对你有帮助,可以点赞支持,感谢。近期将更新:Spring IOC源码阅读-Spring IOC容器初始过程源码讲解