openwechat 项目使用教程

openwechat 项目使用教程

openwechatgolang微信SDK项目地址:https://gitcode.com/gh_mirrors/op/openwechat

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

openwechat 项目的目录结构如下：

openwechat/
├── README.md
├── LICENSE
├── go.mod
├── go.sum
├── main.go
├── bot/
│   ├── bot.go
│   ├── handler.go
│   ├── login.go
│   └── message.go
├── user/
│   ├── user.go
│   ├── friend.go
│   ├── group.go
│   └── mp.go
├── utils/
│   ├── logger.go
│   └── utils.go
└── examples/
    ├── basic_example.go
    └── advanced_example.go

目录介绍

• README.md: 项目介绍文档。
• LICENSE: 项目许可证文件。
• go.mod 和 go.sum: Go 模块文件，用于管理项目依赖。
• main.go: 项目的启动文件。
• bot/: 包含与 Bot 相关的核心逻辑文件。
  • bot.go: Bot 对象的定义和基本操作。
  • handler.go: 消息处理逻辑。
  • login.go: 登录相关逻辑。
  • message.go: 消息处理相关逻辑。
• user/: 包含用户、好友、群组和公众号相关的逻辑文件。
  • user.go: 用户对象的定义和操作。
  • friend.go: 好友对象的定义和操作。
  • group.go: 群组对象的定义和操作。
  • mp.go: 公众号对象的定义和操作。
• utils/: 包含一些工具函数和日志记录。
  • logger.go: 日志记录工具。
  • utils.go: 其他工具函数。
• examples/: 包含一些示例代码，展示如何使用该项目。
  • basic_example.go: 基本示例。
  • advanced_example.go: 高级示例。

2. 项目的启动文件介绍

项目的启动文件是 main.go，其主要功能是初始化 Bot 对象并启动微信机器人。

main.go 文件内容

package main

import (
    "fmt"
    "github.com/eatmoreapple/openwechat"
)

func main() {
    bot := openwechat.DefaultBot(openwechat.Desktop) // 桌面模式

    // 注册消息处理函数
    bot.MessageHandler = func(msg *openwechat.Message) {
        if msg.IsText() && msg.Content == "ping" {
            msg.ReplyText("pong")
        }
    }

    // 注册登陆二维码回调
    bot.UUIDCallback = openwechat.PrintlnQrcodeUrl

    // 登陆
    if err := bot.Login(); err != nil {
        fmt.Println(err)
        return
    }

    // 获取登陆的用户
    self, err := bot.GetCurrentUser()
    if err != nil {
        fmt.Println(err)
        return
    }

    // 阻塞主程序
    bot.Block()
}

启动文件功能介绍

• 初始化 Bot 对象并设置为桌面模式。
• 注册消息处理函数，处理特定消息并回复。
• 注册登录二维码回调函数，输出二维码链接。
• 执行登录操作。
• 获取登录用户信息。
• 阻塞主程序，保持 Bot 运行。

3. 项目的配置文件介绍

openwechat 项目没有显式的配置文件，所有的配置都是通过代码进行设置的。例如，可以在 main.go 中设置 Bot 的模式、消息处理函数等。

配置示例

bot := openwechat.DefaultBot(openwechat.Desktop) // 设置为桌面模式

// 注册消息处理函数
bot.MessageHandler = func(msg *openwechat.Message) {
    if msg.IsText() && msg.Content == "ping" {
        msg.ReplyText("pong")
    }
}

// 注册登陆二维码回调
bot.UUIDCallback = openwechat.PrintlnQrcodeUrl

配置功能介绍

• `openwechat

openwechatgolang微信SDK项目地址:https://gitcode.com/gh_mirrors/op/openwechat