自制IOC容器(1)

小样样样样样样 2021-05-04

展开全文

本系列文章介绍ByxContainer的实现思路。

ByxContainer是一个简单的轻量级IOC容器，具有以下特性：

使用JSON格式的配置文件
支持构造函数注入、静态工厂注入、实例工厂注入、属性注入、setter注入、条件注入
组件的延迟加载和单例组件
根据id注册、获取容器中的组件

ByxContainer的设计借鉴了ajoo大神的博客。

项目地址：github 码云

本篇文章介绍ByxContainer中的核心概念、接口和类。

组件(Component)

ByxContainer使用组件(Component)来管理系统中的所有对象。组件代表了系统中的一个对象，并封装了该对象的创建过程。下面是Component接口的定义：

public interface Component
{
    Object create();
}

假设类A的定义如下：

public class A
{
    private final String msg;
    private final int val;

    public A(String msg, int val)
    {
        this.msg = msg;
        this.val = val;
    }
    ...
}

如果我们希望按照如下方式创建一个A的对象：

A a = new A("hello", 123);

那么，可以写如下Component实现类来把这个创建过程封装成一个对象：

public class AComponent implements Component
{
    @Override
    public Object create()
    {
        return new A("hello", 123);
    }
}

AComponent封装了a对象的创建过程，可以使用以下代码来创建这个对象：

A a = (A) new AComponent().create();

那么，这种方式与前面直接new的方式相比，有什么优势呢？主要有两点：

职责分离：由于Component封装了对象的创建，因此容器只需要对所有Component进行管理，而无需再关心具体对象的创建过程
延迟初始化：当某个具体的Component创建出来之后，相应的对象其实还没有被创建，只有当Component的create方法被调用时，相应的对象才会被真正创建

容器(Container)

容器(Container)是一个对象工厂，Container接口的定义如下：

public interface Container
{
    void addComponent(String id, Component component);
    <T> T getComponent(String id);
}

容器里面的每个组件都使用id唯一标识。addComponent用于向容器中注册组件，注册时需要给出组件的id和定义。getComponent用于从容器中获取指定id的组件所生成的对象。

ByxContainer实现类

ByxContainer是Container的实现类，实现了基本的组件管理：

public class ByxContainer implements Container
{
    private final Map<String, Component> components = new ConcurrentHashMap<>();

    @Override
    public void addComponent(String id, Component component)
    {
        components.put(id, component);
    }

    @Override
    @SuppressWarnings("unchecked")
    public <T> T getComponent(String id)
    {
        return (T) components.get(id).create();
    }
}

ByxContainer实现了基本的组件管理，使用Map保存id与Component的对应关系，addComponent将键值对(id, component)插入Map，getComponent首先从Map中获取id对应的Component，然后返回Component的create方法创建的对象。

ContainerFactory接口

有时候，我们希望从不同的地方（如配置文件、注解）读取容器配置，并初始化容器，所以需要抽象出一个ContainerFactory接口：

public interface ContainerFactory
{
    Container create();
}

ByxContainer中已经实现了一个JsonContainerFactory用于从Json文件中读取容器配置。用户可以按照如下方式使用ByxContainer：

// 初始化容器
InputStream inputStream = Thread.currentThread().getContextClassLoader().getResourceAsStream("container.json");
ContainerFactory factory = new JsonContainerFactory(inputStream);
Container container = factory.create();

// 使用容器
SomeType myObject = container.getComponent("myObject");

在接下来的文章中不会介绍与配置文件解析有关的内容，而只会介绍支持将配置文件翻译成ByxContainer组件定义的基础设施。

使用ByxContainer

实际上，有了上面介绍的这几个接口和类，我们就能把这个IOC容器用起来了，具体使用步骤如下：

为每一个希望被IOC容器管理的对象都实现一个Component子类，封装该对象的创建细节

public class AComponent implements Component {...}
public class BComponent implements Component {...}
public class CComponent implements Component {...}

在程序初始化代码中，创建一个ByxContainer，使用addComponent注册所有组件

Container container = new ByxContainer();
container.addComponent("c1", new AComponent(...));
container.addComponent("c2", new BComponent(...));
container.addComponent("c3", new CComponent(...));

在程序使用过程中，如果需要用某个组件，则调用container的getComponent方法，并传递对应的id
```
A a = container.getComponent("c1");
B b = container.getComponent("c2");
C c = container.getComponent("c3");
```

这样使用虽然能完成需求，但是非常不方便，因为对每个不同的对象，都需要创建一个不同的实现类。有没有一种方法，能够无需实现任何子类就能定义不同对象的创建方式呢？