CGraph 说明文档

一. 简介

本工程实现了一套跨平台图流程计算框架。通过GPipeline(流水线)底层调度，实现了依赖元素依次顺序执行、非依赖元素并发执行的调度功能。

使用者只需继承GNode（节点）类，实现子类的run()方法，并根据需要设定依赖关系，即可实现任务的图化执行。

同时，使用者还可以通过设定各种包含多节点信息的GGroup（组），自行控制图的条件判断、循环和并发执行逻辑。

此外，还可以通过添加GAspect(切面)的方式，实现以上各种元素功能的横向扩展，或是通过引入GAdapter（适配器）对单个节点功能进行加强。

二. 编译说明

• 本工程支持MacOS、Linux和Windows系统，无任何第三方依赖。使用CLion作为IDE的开发者，打开CMakeLists.txt文件作为工程，即可编译通过。

• Linux环境开发者，在命令行模式下，输入以下指令，即可编译通过

  $ git clone https://github.com/ChunelFeng/CGraph.git
  $ cd CGraph/
  $ cmake . -Bbuild
  $ cd build/
  $ make

三. 使用Demo

MyNode1.h

#include "../../src/CGraph.h"

class MyNode1 : public CGraph::GNode {
public:
    CSTATUS run () override {
        CSTATUS status = STATUS_OK;
        CGraph::CGRAPH_ECHO("[%s], enter MyNode1 run function. Sleep for 1 second ... ", this->getName().c_str());
        CGRAPH_SLEEP_SECOND(1)
        return status;
    }
};

MyNode2.h

#include "../../src/CGraph.h"

class MyNode2 : public CGraph::GNode {
public:
    CSTATUS run () override {
        CSTATUS status = STATUS_OK;
        CGraph::CGRAPH_ECHO("[%s], enter MyNode2 run function. Sleep for 2 second ... ", this->getName().c_str());
        CGRAPH_SLEEP_SECOND(2)
        return status;
    }
};

demo.cpp

#include "MyGNode/MyNode1.h"
#include "MyGNode/MyNode2.h"

using namespace CGraph;

void tutorial_simple() {
    /* 创建一个流水线，用于设定和执行流图信息 */
    GPipelinePtr pipeline = GPipelineFactory::create();

    CSTATUS status = STATUS_OK;
    GElementPtr a, b, c, d = nullptr;

    /* 注册节点，其中MyNode1和MyNode2必须为GraphNode的子类，否则无法通过编译。
     * MyNode1中run()执行内容为sleep(1s)
     * MyNode2中run()执行内容为sleep(2s) */
    status = pipeline->registerGElement<MyNode1>(&a, {}, "nodeA");    // 将名为nodeA，无执行依赖的node信息，注册入pipeline中
    if (STATUS_OK != status) {
        return;    // 使用时，请对所有CGraph接口的返回值做判定。本例子中省略
    }
    status = pipeline->registerGElement<MyNode2>(&b, {a}, "nodeB");    // 将名为nodeB，依赖a执行的node信息，注册入pipeline中
    status = pipeline->registerGElement<MyNode1>(&c, {a}, "nodeC");
    status = pipeline->registerGElement<MyNode2>(&d, {b, c}, "nodeD");    // 将名为nodeD，依赖{b,c}执行的node信息，注册入pipeline中

    /* 执行流图框架 */
    status = pipeline->process();
    GPipelineFactory::destroy(pipeline);
}

如上图所示，图结构执行的时候，首先执行a节点。a节点执行完毕后，并行执行b和c节点。b和c节点全部执行完毕后，再执行d节点。

---

附录-1. 版本信息

[2021.05.04 - v1.0.0 - Chunel]

• 提供图化执行功能，支持非依赖节点并行计算

[2021.05.09 - v1.1.0 - Chunel]

• 优化图执行过程中的并发度

[2021.05.18 - v1.1.1 - Chunel]

• 添加节点name和session信息

[2021.05.23 - v1.2.0 - Chunel]

• 提供单节点循环执行功能

[2021.05.29 - v1.3.0 - Chunel]

• 提供cluster（簇）和region（区域）划分和循环执行功能
• 提供tutorial内容，包含多种使用样例

[2021.06.14 - v1.4.0 - Chunel]

• 提供param（参数）传递机制
• 提供group（组）功能，多节点模块统一继承自group模块
• 添加对Linux系统的的支持

[2021.06.20 - v1.4.1 - Chunel]

• 提供condition（条件）功能
• 添加对Windows系统的支持

[2021.06.24 - v1.5.0 - Chunel]

• 提供pipeline工厂创建方法
• 更新tutorial内容

[2021.07.07 - v1.5.1 - Chunel]

• 优化线程池功能。实现任务盗取机制

[2021.07.11 - v1.5.2 - Chunel]

• 优化线程池功能。实现线程数量自动调节机制

[2021.07.31 - v1.5.3 - Chunel]

• 优化线程池功能。实现任务批量获取功能，优化任务盗取机制

[2021.08.29 - v1.6.0 - Chunel]

• 提供多pipeline功能，优化底层逻辑
• 更新tutorial内容

[2021.09.19 - v1.6.1 - Chunel]

• 提供Lru算子、Trie算子和模板节点功能，优化底层逻辑
• 更新tutorial内容

[2021.09.29 - v1.7.0 - Chunel]

• 提供aspect(切面)功能，用于横向扩展node或group功能
• 更新tutorial内容

[2021.10.07 - v1.7.1 - Chunel]

• 优化aspect(切面)实现逻辑，提供切面参数功能，提供批量添加切面功能
• 更新tutorial内容

[2021.11.01 - v1.8.0 - Chunel]

• 提供adapter（适配器）功能，提供singleton适配器
• 优化pipeline执行逻辑
• 更新tutorial内容

---

附录-2. 推荐阅读

• 纯序员给你介绍图化框架的简单实现——执行逻辑
• 纯序员给你介绍图化框架的简单实现——循环逻辑
• 纯序员给你介绍图化框架的简单实现——参数传递
• 纯序员给你介绍图化框架的简单实现——条件判断
• 纯序员给你介绍图化框架的简单实现——面向切面
• 纯序员给你介绍图化框架的简单实现——线程池优化（一）
• 纯序员给你介绍图化框架的简单实现——线程池优化（二）
• 纯序员给你介绍图化框架的简单实现——线程池优化（三）
• 纯序员给你介绍图化框架的简单实现——线程池优化（四）
• 纯序员给你介绍图化框架的简单实现——线程池优化（五）

---

附录-3. 联系方式

• 微信： ChunelFeng
• 邮箱： chunel@foxmail.com
• 源码： https://github.com/ChunelFeng/CGraph
• 论坛： www.chunel.cn