Cyclops.Qingflow

项目概述

Cyclops.Qingflow是企服版框架中与轻流(Qingflow)工作流平台的集成组件，提供了轻流API的封装和简化调用。该组件使企业应用能够轻松与轻流平台进行交互，实现工作流数据的读取、创建、更新和管理，为企业数字化转型提供了灵活的工作流集成方案。

核心功能模块

1. 轻流API客户端

• 提供轻流平台API的统一访问接口
• 支持API认证和授权管理
• 提供请求封装和响应解析
• 支持API错误处理和重试机制

2. 表单数据管理

• 支持表单数据的查询、创建、更新和删除
• 提供表单字段的解析和映射
• 支持表单数据的批量操作
• 提供表单数据的筛选和排序

3. 流程实例管理

• 支持流程实例的创建和跟踪
• 提供流程状态的查询和更新
• 支持流程节点的操作和管理
• 提供流程日志的记录和查询

4. 用户权限管理

• 提供用户认证和授权集成
• 支持用户信息的同步和管理
• 提供权限映射和访问控制

5. 数据转换和映射

• 提供数据格式转换工具
• 支持自定义数据映射规则
• 提供数据验证和清洗功能

6. 事件通知集成

• 支持轻流事件的订阅和处理
• 提供事件触发的工作流集成
• 支持自定义事件处理器

技术栈

• .NET 8.0：基础开发框架
• RESTful API：与轻流平台交互
• Cyclops.Common：公共库依赖
• Cyclops.HttpClient：HTTP客户端依赖（如果有）

环境依赖

• .NET 8.0或更高版本
• 有效的轻流平台账户和API密钥
• 网络连接到轻流平台API

安装配置

安装

通过NuGet包管理器安装：

Install-Package TJC.Cyclops.Qingflow

或通过.NET CLI安装：

dotnet add package TJC.Cyclops.Qingflow

配置

在应用程序启动时配置轻流API连接信息：

// 配置轻流API连接信息 Cyclops.Qingflow.Config.Setup(new QingflowOptions { ApiBaseUrl = "https://api.qingflow.com/v1", AppKey = "your_app_key", AppSecret = "your_app_secret", AccessToken = "your_access_token" // 或配置获取AccessToken的方式 });

使用示例

1. 表单数据查询

// 初始化轻流客户端 var client = new QingflowClient(); // 查询表单数据 var query = new FormDataQuery { FormId = "your_form_id", PageSize = 20, PageNumber = 1, Filters = new List<Filter> { new Filter { Field = "status", Operator = "eq", Value = "active" } } }; var result = await client.QueryFormDataAsync(query); // 处理查询结果 foreach (var data in result.Data) { Console.WriteLine($"ID: {data.Id}, 标题: {data.Title}"); }

2. 创建表单数据

// 初始化轻流客户端 var client = new QingflowClient(); // 创建表单数据 var formData = new FormDataCreate { FormId = "your_form_id", Fields = new Dictionary<string, object> { { "title", "新的申请" }, { "applicant", "张三" }, { "amount", 1000 }, { "reason", "项目需要" } } }; var result = await client.CreateFormDataAsync(formData); Console.WriteLine($"创建成功，数据ID: {result.DataId}");

3. 流程实例操作

// 初始化轻流客户端 var client = new QingflowClient(); // 创建流程实例 var process = new ProcessCreate { FormId = "your_form_id", DataId = "your_data_id", StartNodeId = "start_node_id" }; var result = await client.CreateProcessAsync(process); Console.WriteLine($"流程创建成功，实例ID: {result.ProcessId}"); // 执行流程节点操作 await client.ExecuteNodeAsync(new NodeExecute { ProcessId = result.ProcessId, NodeId = "next_node_id", Action = "approve", Comment = "同意此申请" });

4. 用户信息管理

// 初始化轻流客户端 var client = new QingflowClient(); // 获取用户信息 var userInfo = await client.GetUserInfoAsync("user_id"); Console.WriteLine($"用户姓名: {userInfo.Name}, 部门: {userInfo.Department}"); // 同步用户信息 var syncResult = await client.SyncUserAsync(new UserSync { UserId = "user_id", Name = "李四", Department = "技术部", Email = "lisi@example.com" });

5. 事件订阅

// 订阅轻流事件 Cyclops.Qingflow.Events.Subscribe("form_data_created", (sender, args) => { Console.WriteLine($"表单数据已创建: {args.DataId}"); // 处理事件... }); // 订阅流程完成事件 Cyclops.Qingflow.Events.Subscribe("process_completed", (sender, args) => { Console.WriteLine($"流程已完成: {args.ProcessId}"); // 处理事件... });

版本信息

• 当前版本
• 作者：yswenli
• 描述：企服版框架中轻流(Qingflow)平台集成组件

贡献者

• yswenli

许可证

保留所有权利