Durable Task Framework for Go 使用指南

Durable Task Framework for Go 使用指南

durabletask-goThe Durable Task Framework is a lightweight, embeddable engine for writing durable, fault-tolerant business logic (orchestrations) as ordinary code.项目地址:https://gitcode.com/gh_mirrors/du/durabletask-go

项目概述

Durable Task Framework for Go（GitHub）是一个轻量级的可嵌入引擎，它允许开发者以常规代码形式书写持久化且容错的业务逻辑（即“编排”）。该框架采用Go语言实现，并设计用于集成到其他基于Go的应用中。它通过提供gRPC端点支持跨语言编写持久流程，已有.NET和Java的SDK来访问此gRPC服务，而直接在Go中编写和运行编排也是一种选择。本框架灵感源自微软的.NET版本Durable Task Framework，广泛应用于构建可靠的控制平面和管理基础设施。

目录结构及介绍

durabletask-go/
├── api                 # 定义API接口相关的代码。
├── client              # 包含客户端逻辑，用于与框架交互。
├── internal            # 内部使用的模块，对外部通常不公开。
│   └── helpers         # 辅助函数或工具类。
├── orchestrator        # 编排逻辑的相关实现。
├── tests               # 单元测试和集成测试代码。
│   ├── mocks           # 用于测试的模拟对象。
│   └── ...             # 更多测试相关子目录。
├── examples            # 示例应用，展示如何使用框架。
├── protos              # gRPC协议缓冲区定义文件，用于服务间的通信。
├── README.md           # 项目快速入门和基本信息。
├── LICENSE             # 许可证文件，遵循Apache 2.0。
└── ...

说明：

• api: 包含与任务编排和服务交互的接口定义。
• client: 实现与Durable Task Framework交互的客户端类。
• internal: 提供内部使用的组件，对于最终用户不直接可见。
• orchestrator: 用户实现具体业务逻辑的地方。
• tests: 包括单元测试和可能的集成测试，确保功能完整。
• examples: 示例代码，帮助理解如何整合到实际项目中。
• protos: gRPC服务定义文件，重要于跨语言通信。

启动文件介绍

虽然本项目鼓励通过调用库函数的方式来启动和管理编排，没有明确的“单一启动文件”，但开发人员应该从创建一个主入口点开始，通常是main.go。在这个文件中，初始化框架环境，连接到必要的服务（如数据库或其他存储后端），并触发初始的编排执行。

示例伪代码启动流程：

package main

import (
    "context"
    "your/path/to/durabletask-go/client"
)

func main() {
    // 初始化客户端，配置连接参数
    dtClient, err := client.NewClient("YourConnectionString")
    if err != nil {
        panic(err)
    }

    // 触发编排
    ctx := context.Background()
    dtClient.ScheduleNewOrchestration(ctx, "YourOrchestratorFunctionName")

    // 等待事件循环或者设置守护程序以保持应用运行
}

配置文件介绍

Durable Task Framework for Go本身并不强制要求外部配置文件，其配置通常通过代码中设置参数完成。然而，在部署到生产环境时，推荐的做法是将诸如存储连接字符串等敏感信息或特定环境设置放在环境变量或外部配置文件中。

例如，若要配置连接至Azure Storage用于状态存储，你可能会使用环境变量或类似.env的文件来管理这些信息：

# 假想的.env 文件内容
TASK_HUB_NAME=MyHubName
STORAGE_ACCOUNT_CONNECTION_STRING=YourStorageConnectionStringHere

然后在应用启动时读取这些变量进行配置：

import (
    "os"
)

func initializeClient() (*client.Client, error) {
    connectionString := os.Getenv("STORAGE_ACCOUNT_CONNECTION_STRING")
    if connectionString == "" {
        return nil, errors.New("storage connection string not set")
    }
    
    return client.NewClient(connectionString), nil
}

总结来说，配置方式灵活多样，关键在于根据你的部署环境合理组织和读取配置数据。

durabletask-goThe Durable Task Framework is a lightweight, embeddable engine for writing durable, fault-tolerant business logic (orchestrations) as ordinary code.项目地址:https://gitcode.com/gh_mirrors/du/durabletask-go