飞书自定义机器人使用教程

飞书自定义机器人使用教程

feishu-robot 飞书机器人，每日定时发送测试团队缺陷情况 项目地址: https://gitcode.com/gh_mirrors/fe/feishu-robot

1. 项目的目录结构及介绍

feishu-robot/
├── LICENSE
├── README.md
├── base/
│   ├── base.go
│   └── base_test.go
├── client/
│   ├── client.go
│   └── client_test.go
├── go.mod
├── go.sum
└── internal/
    └── internal.go

目录结构介绍

• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍文档，通常包含项目的基本信息、安装步骤和使用说明。
• base/: 包含项目的基础功能实现文件 base.go 和对应的测试文件 base_test.go。
• client/: 包含客户端相关的实现文件 client.go 和对应的测试文件 client_test.go。
• go.mod: Go 模块文件，定义了项目的依赖关系。
• go.sum: Go 模块的校验文件，确保依赖的完整性和安全性。
• internal/: 包含项目的内部实现文件 internal.go，通常用于存放不对外公开的代码。

2. 项目的启动文件介绍

项目的启动文件通常是 main.go，但在本项目中，启动逻辑可能分散在不同的文件中。以下是主要的启动逻辑文件：

client/client.go

package client

import (
    "os"
    "github.com/liyinchigithub/feishu-robot/base"
)

func NewClient() *Client {
    return &Client{
        Webhook: os.Getenv("webhook"),
        Secret:  os.Getenv("secret"),
    }
}

func (c *Client) SendMessage(message base.Message) error {
    // 发送消息的逻辑
}

启动步骤

1. 设置环境变量: 在启动项目之前，确保设置了 webhook 和 secret 环境变量。
2. 创建客户端: 使用 NewClient() 函数创建一个客户端实例。
3. 发送消息: 调用 SendMessage 方法发送消息。

3. 项目的配置文件介绍

项目中没有显式的配置文件，但可以通过环境变量进行配置。以下是主要的配置项：

环境变量

• webhook: 飞书机器人的 Webhook URL，用于发送消息。
• secret: 飞书机器人的密钥，用于消息的安全验证。

配置示例

export webhook="https://open.feishu.cn/open-apis/bot/v2/hook/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
export secret="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

配置文件的使用

在启动项目之前，确保这些环境变量已经设置。可以通过 .env 文件或在启动脚本中设置这些变量。

source .env
go run main.go

通过以上步骤，您可以成功启动并配置飞书自定义机器人项目。

feishu-robot 飞书机器人，每日定时发送测试团队缺陷情况 项目地址: https://gitcode.com/gh_mirrors/fe/feishu-robot