Go-Wecom 项目使用教程

Go-Wecom 项目使用教程

go-wecom Wechat Work/Wecom/企业微信 Golang SDK 项目地址: https://gitcode.com/gh_mirrors/go/go-wecom

1. 项目目录结构及介绍

Go-Wecom 项目的目录结构如下：

go-wecom/
├── cmd/
│   └── ...
├── commons/
│   └── gorms/
│       └── ...
├── wecom/
│   └── ...
├── wwcrypt/
│   └── ...
├── github/
│   └── workflows/
│       └── ...
├── WeWorkFinanceSDK/
│   └── ...
├── .dockerignore
├── .editorconfig
├── .env.example
├── .gitignore
├── .golangci.yml
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── TODO.md
├── go.mod
├── go.sum
└── ...

目录介绍

• cmd/: 包含项目的命令行工具和启动脚本。
• commons/gorms/: 包含与 GORM 相关的通用代码。
• wecom/: 包含企业微信 SDK 的核心代码。
• wwcrypt/: 包含企业微信回调加密的实现。
• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• WeWorkFinanceSDK/: 包含企业微信会话存档 SDK 的相关代码。
• .dockerignore: Docker 构建时忽略的文件列表。
• .editorconfig: 编辑器配置文件。
• .env.example: 环境变量配置示例文件。
• .gitignore: Git 忽略的文件列表。
• .golangci.yml: GolangCI-Lint 配置文件。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证文件。
• Makefile: 项目构建和任务管理文件。
• README.md: 项目介绍和使用说明。
• TODO.md: 项目待办事项列表。
• go.mod: Go 模块依赖管理文件。
• go.sum: Go 模块依赖校验文件。

2. 项目启动文件介绍

项目的启动文件通常位于 cmd/ 目录下。以下是一个典型的启动文件示例：

package main

import (
    "fmt"
    "os"
    "github.com/wenerme/go-wecom/wecom"
)

func main() {
    // 初始化客户端配置
    client := wecom.NewClient(wecom.Conf{
        CorpID:     os.Getenv("CORP_ID"),
        AgentID:    100001,
        CorpSecret: os.Getenv("CORP_SECRET"),
    })

    // 获取 AccessToken
    token, err := client.AccessToken()
    if err != nil {
        panic(err)
    }
    fmt.Println("Token:", token)

    // 获取 JsAPITicket
    ticket, err := client.JsAPITicket()
    if err != nil {
        panic(err)
    }
    fmt.Println("Ticket:", ticket)
}

启动文件说明

• main.go: 项目的入口文件，负责初始化客户端配置并调用企业微信 SDK 的相关接口。
• wecom.NewClient: 初始化企业微信客户端，传入必要的配置参数，如 CorpID、AgentID 和 CorpSecret。
• client.AccessToken(): 获取企业微信的 AccessToken。
• client.JsAPITicket(): 获取企业微信的 JsAPITicket。

3. 项目的配置文件介绍

项目的配置文件通常是一个 .env 文件，用于存储环境变量。以下是一个示例配置文件：

# 企业微信配置
CORP_ID=your_corp_id
CORP_SECRET=your_corp_secret
AGENT_ID=100001

# 其他配置
DEBUG=true

配置文件说明

• CORP_ID: 企业微信的企业 ID。
• CORP_SECRET: 企业微信的应用密钥。
• AGENT_ID: 企业微信的应用 ID。
• DEBUG: 调试模式开关，设置为 true 时启用调试模式。

通过加载 .env 文件，项目可以在不同的环境中使用不同的配置，确保灵活性和可维护性。

go-wecom Wechat Work/Wecom/企业微信 Golang SDK 项目地址: https://gitcode.com/gh_mirrors/go/go-wecom