iWF: Golang全功能业务流程开发平台插件

iWF(Industrial Workflow)是一个基于Golang的全功能业务流程编排引擎，它提供了一种简单高效的方式来构建复杂的业务流程。下面我将详细介绍iWF的使用方法，并提供相关示例代码。

iWF核心概念

iWF基于工作流模式，主要包含以下核心组件：

1. 工作流定义(Workflow Definition)：描述业务流程的结构
2. 活动(Activity)：业务流程中的具体执行单元
3. 决策器(Decider)：控制工作流流转逻辑
4. 持久化(Persistence)：工作流状态存储

安装iWF

go get github.com/indeedeng/iwf-golang-sdk

基本使用示例

1. 定义工作流

package main

import (
	"context"
	"fmt"
	"github.com/indeedeng/iwf-golang-sdk/iwf"
)

type MyWorkflow struct {
	iwf.DefaultWorkflowType
}

// 定义工作流ID
func (b MyWorkflow) GetWorkflowId() string {
	return "my-workflow"
}

// 定义工作流状态
func (b MyWorkflow) GetWorkflowStates() []iwf.StateDef {
	return []iwf.StateDef{
		{State: &StartState{}},
		{State: &ProcessingState{}},
		{State: &CompleteState{}},
	}
}

2. 定义状态

type StartState struct {
	iwf.DefaultState
}

func (s StartState) WaitUntil(ctx context.Context, input iwf.Object, commandResults iwf.CommandResults, persistence iwf.Persistence, communication iwf.Communication) (*iwf.CommandRequest, error) {
	// 初始化工作流数据
	var workflowInput string
	input.Get(&workflowInput)
	
	persistence.SetDataAttribute("input", workflowInput)
	
	// 进入下一个状态
	return iwf.EmptyCommandRequest(), nil
}

func (s StartState) Execute(ctx context.Context, input iwf.Object, commandResults iwf.CommandResults, persistence iwf.Persistence, communication iwf.Communication) (*iwf.StateDecision, error) {
	// 决定下一个状态是ProcessingState
	return iwf.ForceCompleteWorkflow("processing"), nil
}

3. 处理状态

type ProcessingState struct {
	iwf.DefaultState
}

func (s ProcessingState) WaitUntil(ctx context.Context, input iwf.Object, commandResults iwf.CommandResults, persistence iwf.Persistence, communication iwf.Communication) (*iwf.CommandRequest, error) {
	// 执行一些异步操作
	return iwf.AllCommandCompletedRequest(
		iwf.NewTimerCommand("timer1", time.Now().Add(10*time.Second)),
	), nil
}

func (s ProcessingState) Execute(ctx context.Context, input iwf.Object, commandResults iwf.CommandResults, persistence iwf.Persistence, communication iwf.Communication) (*iwf.StateDecision, error) {
	// 检查定时器是否完成
	if commandResults.TimerCommands[0].Status != iwf.COMPLETED {
		return iwf.DeadEnd, nil
	}
	
	// 处理业务逻辑
	var inputData string
	persistence.GetDataAttribute("input", &inputData)
	
	processedData := "processed_" + inputData
	persistence.SetDataAttribute("result", processedData)
	
	// 进入完成状态
	return iwf.ForceCompleteWorkflow("complete"), nil
}

4. 完成状态

type CompleteState struct {
	iwf.DefaultState
}

func (s CompleteState) WaitUntil(ctx context.Context, input iwf.Object, commandResults iwf.CommandResults, persistence iwf.Persistence, communication iwf.Communication) (*iwf.CommandRequest, error) {
	return iwf.EmptyCommandRequest(), nil
}

func (s CompleteState) Execute(ctx context.Context, input iwf.Object, commandResults iwf.CommandResults, persistence iwf.Persistence, communication iwf.Communication) (*iwf.StateDecision, error) {
	// 工作流完成
	return iwf.ForceCompleteWorkflow(""), nil
}

5. 启动工作流

func main() {
	// 创建iWF客户端
	client := iwf.NewClient(iwf.NewWorkflowClient(), iwf.NewWorkerService())
	
	// 注册工作流
	registry := iwf.NewRegistry()
	registry.AddWorkflow(&MyWorkflow{})
	
	// 启动工作流
	workflowId := "example-workflow-1"
	input := "test-input"
	runId, err := client.StartWorkflow(
		context.Background(),
		&MyWorkflow{},
		workflowId,
		10*time.Second, // 工作流超时
		input,
	)
	if err != nil {
		panic(err)
	}
	
	fmt.Printf("Workflow started: %s, runId: %s\n", workflowId, runId)
}

高级功能

1. 信号处理

// 在状态中等待信号
func (s SomeState) WaitUntil(ctx context.Context, input iwf.Object, commandResults iwf.CommandResults, persistence iwf.Persistence, communication iwf.Communication) (*iwf.CommandRequest, error) {
	return iwf.AllCommandCompletedRequest(
		iwf.NewSignalCommand("signal1"),
	), nil
}

// 发送信号
err := client.SignalWorkflow(
	context.Background(),
	workflowId,
	runId,
	"signal1",
	"signal-data",
)

2. 查询工作流状态

result, err := client.QueryWorkflow(
	context.Background(),
	workflowId,
	runId,
	"get-result", // 查询类型
	nil,          // 查询参数
)

3. 错误处理

func (s SomeState) Execute(ctx context.Context, input iwf.Object, commandResults iwf.CommandResults, persistence iwf.Persistence, communication iwf.Communication) (*iwf.StateDecision, error) {
	// 业务逻辑
	if err := someBusinessLogic(); err != nil {
		// 重试逻辑
		return iwf.GracefulCompleteWorkflow(
			iwf.NewStateDef(&ErrorHandlingState{}),
			iwf.NewStateInput(err.Error()),
		), nil
	}
	
	return iwf.ForceCompleteWorkflow("next-state"), nil
}

最佳实践

1. 状态设计：将业务流程分解为离散的状态，每个状态职责单一
2. 幂等性：确保状态处理逻辑是幂等的，可以安全重试
3. 超时设置：为长时间运行的操作设置合理的超时
4. 错误处理：设计专门的错误处理状态
5. 测试：为每个状态和工作流编写单元测试

iWF提供了强大的业务流程编排能力，通过合理设计工作流状态和流转逻辑，可以构建复杂的业务系统。以上示例展示了iWF的基本用法，实际使用时可以根据业务需求进行扩展。