Temporal 项目教程

1. 项目目录结构及介绍

Temporal 项目的目录结构如下：

temporal/
├── api/
├── build/
├── client/
├── cmd/
├── common/
├── components/
├── config/
├── develop/
├── docker/
├── docs/
├── environment/
├── internal/
├── proto/
├── schema/
├── service/
├── temporaltest/
├── tests/
├── tools/
├── .dockerignore
├── .gitattributes
├── .gitignore
├── .gitmodules
├── .golangci.yml
├── .goreleaser.yml
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── README.md
├── go.mod
└── go.sum

目录介绍：

• api/: 包含与 API 相关的代码和文件。
• build/: 包含构建相关的脚本和配置文件。
• client/: 包含客户端相关的代码和文件。
• cmd/: 包含命令行工具的代码和文件。
• common/: 包含通用代码和工具函数。
• components/: 包含项目组件的代码和文件。
• config/: 包含配置文件和配置相关的代码。
• develop/: 包含开发相关的工具和脚本。
• docker/: 包含 Docker 相关的文件和配置。
• docs/: 包含项目的文档。
• environment/: 包含环境相关的配置和脚本。
• internal/: 包含内部使用的代码和文件。
• proto/: 包含 Protocol Buffers 相关的文件。
• schema/: 包含数据库模式和相关的文件。
• service/: 包含服务相关的代码和文件。
• temporaltest/: 包含测试相关的代码和文件。
• tests/: 包含测试用例和测试工具。
• tools/: 包含项目使用的工具和脚本。
• .dockerignore: Docker 忽略文件。
• .gitattributes: Git 属性文件。
• .gitignore: Git 忽略文件。
• .gitmodules: Git 子模块配置文件。
• .golangci.yml: GolangCI-Lint 配置文件。
• .goreleaser.yml: Goreleaser 配置文件。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• Makefile: 项目构建文件。
• README.md: 项目介绍和使用说明。
• go.mod: Go 模块文件。
• go.sum: Go 模块依赖校验文件。

2. 项目启动文件介绍

Temporal 项目的启动文件主要位于 cmd/ 目录下。以下是一些关键的启动文件：

• cmd/temporal-server/: 包含 Temporal 服务器的启动代码。
• cmd/temporal-cli/: 包含 Temporal CLI 工具的启动代码。

启动命令示例：

# 启动 Temporal 服务器
temporal server start-dev

# 使用 Temporal CLI
temporal workflow list

3. 项目配置文件介绍

Temporal 项目的配置文件主要位于 config/ 目录下。以下是一些关键的配置文件：

• config/development.yaml: 开发环境配置文件。
• config/production.yaml: 生产环境配置文件。
• config/test.yaml: 测试环境配置文件。

配置文件示例：

# config/development.yaml
server:
  rpc:
    port: 7233
  persistence:
    defaultStore: default
    visibilityStore: visibility
    dataStores:
      default:
        sql:
          user: temporal
          password: temporal
          host: localhost
          port: 5432
          database: temporal

以上是 Temporal 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用 Temporal 项目。