模块依赖管理【续1】- 依赖循环检测的实现

这篇是承接《轻量级 Java 开发框架设计》系列Blog文的后续文章，同时为《模块依赖管理》博文的续，本文专门用以讲解循环依赖检查在 Hasor 中是如何实现的。

依赖循环引发最严重的问题就是死循环，想必绝大部分开发者深有体会，这具体表现在 A -> B,B -> C,C ->A。通常软件程序中出现循环依赖都是设计不周全所导致。

在 Hasor 中，通过Module 接口定义模块，并且通过调用接口参数的方法来声明其第三方引用依赖。首先 Hasor 的设计目标是作为轻量级模块化开发，因此它在核心部分省去了繁重了类加载机制，同时也省去了复杂的模块配置文件。正因为如此 Hasor 在定义模块上才可以变得十分轻巧。

同样的 Hasor 虽然不用考虑类会被不同的类加载器反复加载多次。但是仍然会面对模块依赖出现循环的现象。Hasor 在处理这件事采用的是如下步骤：

1.加载 Mode 并调用 Mode 的 init方法已触发对应的生命周期阶段，在期间 Mode1 可以通过代码的形式显示的告诉容器它会依赖谁。
(这一过程会在所有模块上进行。注意：这一过程不会保证调用的顺序，模块的顺序可能是随机的)
2.如果模块在执行 init 阶段中出现了问题，那么容器会标记这个模块。
3.将所有模块放到“反应器”中进行处理。“反应器”会负责模块的循环依赖检查和排序。
4.如果 A -> B，B -> C。“反应器”会打印出依赖树，并且按照依赖情况对模块集合进行排序。
5.按照最终的顺序依次调用模块的 Start 方法。

下面是模块在 init 阶段声明依赖的代码片段：

public void init(ApiBinder apiBinder) {
    DependencySettings dep = apiBinder.dependency();
    /*弱依赖，目标模块即使没有成功启动也不影响当前模块*/
    dep.weak(Mode2.class);
    /*强依赖，当前模块的启动必须依靠目标模块*/
    dep.forced(Mode3.class);
}

“反应器”需要负责两件：
1.进行依赖循环检查。当遇到依赖循环时抛出异常，并且定位出现问题的模块依赖位置。
2.根据依赖关系对依赖树进行排序以得到正确的启动顺序。（将在下一篇Blog文中介绍。）

循环检测算法：
1.准备一个空的集合，用于保存模块包括自己在内所有依赖的模块。
2.将模块自身加入到集合中。
3.将模块的依赖依次加入到集合，每次加入都从集合中检查依赖是否等于自身。
4.当处理完模块本身依赖之后递归处理依赖模块，并且重复（步骤3）的检测。
5.当（步骤3）判断成立即发现循环依赖，抛出异常即可。

下面这段代码是负责循环依赖检测的关键代码：
ModuleInfo接口：通过该接口可以获取模块的依赖信息，和模块本身元信息。
AbstractModulePropxy类：是Module接口的代理类，该类实现了ModuleInfo 接口，
ReactorModuleInfoElement类：该类是负责保存记录，检查过程中的信息。
Dependency接口：是用来表示依赖的模块。

/**检查模块的依赖是否正确。*/
public void checkModule(ModuleInfo info) {
    AbstractModulePropxy infoBean = (AbstractModulePropxy) info;
    List<ReactorModuleInfoElement> stackArray = new ArrayList<ReactorModuleInfoElement>();
    try {
        //放到栈顶【ReactorModuleInfoElement(深度 0，被检测的模块，检测状态)】
        stackArray.add(new ReactorModuleInfoElement(0,infoBean,"[OK]    "));
        checkModuleInDependency(infoBean,1,infoBean.getDependency(),new ArrayList<ModuleInfo>(),stackArray);
    } catch (RuntimeException e) {
        String treeInfo = getTreeInfo(stackArray,"[Other] ......");
        Hasor.error("%s module depend on the loop.\n%s",infoBean.getDisplayName(),treeInfo);
        throw e;
    }
}
private void checkModuleInDependency(AbstractModulePropxy info,int depth,List<Dependency> depList,List<ModuleInfo> depArray,List<ReactorModuleInfoElement> stackArray) {
    for (Dependency dep : depList) {
        AbstractModulePropxy depInfo = (AbstractModulePropxy) dep.getModuleInfo();
        ReactorModuleInfoElement infoLog = new ReactorModuleInfoElement(depth,depInfo);
        depArray.add(depInfo);
        stackArray.add(infoLog);
        //
        if (depArray.contains(info)) {
            /*这里遇到循环依赖，应该是出现了自己依赖自己的现象。*/
            infoLog.setMark("[Error] ");
            throw new RuntimeException(depInfo.getDisplayName() +
                                       " modules depend on the loop.");
        } else {
            infoLog.setMark("[OK]    ");
            this.checkModuleInDependency(info,depth + 1,depInfo.getDependency(),depArray,stackArray);
        }
    }
}

我们知道依赖一旦出现循环，就意味着在环中任意一点向前走最后都会走回自己。因此借助这一特点，依赖循环检测可以从任意一个模块开始。

第 04 行：准备了一个空集合，用于保存模块包括自己在内所有依赖的模块。
第 07 行：将模块自身加入到集合中，【深度0，状态OK】
第 08 行：调用私有方法检查模块的依赖。checkModuleInDependency方法各个参数的意义如下：
1.AbstractModulePropxy info：正在检测的模块
2.int depth：当前所处深度
3.List<Dependency> depList：要检查的依赖模块集合
4.List<ModuleInfo> depArray：已经检查过的依赖集
5.List<ReactorModuleInfoElement> stackArray：检查过程中产生的路径数据，当遇到错误时用于打印问题模块发生位置。
第 11 行：当出现循环依赖时将记录的stackArray信息，转换成日志。
第 20 行：依次检测depList 集合中所表示的依赖模块。
第 22 行：创建检测的日志信息，后面多余的空格是为了打印美观。
如果成功检测会被标记为“[OK] ”，如果失败检测会被标记为“[Error]”。
第 23,24 行：将所依赖的项目添加到依赖集合中，然后交给第 26 行的 if 判断是否遇到循环依赖。
这里的逻辑是一旦依赖出现环状，那么被检测的模块一定会出现在其依赖的模块中。
因此 23 行先记录下依赖的模块供 26 行判断使用。第 24 行则仅仅是将日志记录到堆栈中。
第 33 行：则是递归检测被依赖的依赖。

下面这个日志是当出现依赖循环时控制台会打印出的信息。(提示：缩进就是通过深度实现的)

以上就是 Hasor 中依赖排序的具体实现代码，反应器类名为：“ModuleReactor”。读者可以通过创建一个 Maven 工程加入下面代码：

<dependency>
    <groupId>net.hasor</groupId>
    <artifactId>hasor-core</artifactId>
    <version>0.0.1</version>
</dependency>

通过命令获取到 Hasor-core 的源码： mvn eclipse:eclipse -DdownloadSources=true

----------------------------------------------------------------
目前的开发代码存放于（包括Demo程序）：
Github： https://github.com/zycgit/hasor
git@OSC：http://git.oschina.net/zycgit/hasor

非常感谢您百忙之中抽出时间来看这一系博文。可以通过Maven 中央仓库网站http://search.maven.org/搜索 Hasor 下载 hasor 的相关代码。

模块依赖管理【续1】- 依赖循环检测的实现

相关推荐