微信机器人项目使用教程

微信机器人项目使用教程

wechat-bot带二次开发接口的PC微信聊天机器人项目地址:https://gitcode.com/gh_mirrors/wec/wechat-bot

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

wechat-bot/
├── config/
│   ├── default.json
│   ├── development.json
│   └── production.json
├── src/
│   ├── commands/
│   ├── handlers/
│   ├── services/
│   ├── utils/
│   └── index.js
├── .env
├── .gitignore
├── package.json
└── README.md

• config/: 存放项目的配置文件，包括默认配置、开发环境配置和生产环境配置。
• src/: 项目的源代码目录，包含命令处理、事件处理、服务和工具函数等。
  • commands/: 存放各种命令处理逻辑。
  • handlers/: 存放事件处理逻辑。
  • services/: 存放服务层逻辑。
  • utils/: 存放工具函数。
  • index.js: 项目的入口文件。
• .env: 环境变量配置文件。
• .gitignore: Git忽略文件配置。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js。该文件负责初始化项目，加载配置，启动微信机器人服务。以下是 index.js 的主要内容：

const { Wechaty } = require('wechaty')
const config = require('../config')

async function main() {
  const bot = new Wechaty()

  bot.on('scan', (qrcode, status) => {
    console.log(`Scan QR Code to login: ${status}\n${qrcode}`)
  })

  bot.on('login', user => {
    console.log(`User ${user} logged in`)
  })

  bot.on('message', message => {
    console.log(`Message: ${message}`)
  })

  await bot.start()
}

main().catch(console.error)

• Wechaty 是微信机器人的核心库。
• config 模块加载项目的配置文件。
• bot.on 方法用于监听微信的各种事件，如扫码登录、用户登录和消息接收等。
• bot.start 方法启动微信机器人服务。

3. 项目的配置文件介绍

项目的配置文件存放在 config/ 目录下，包括 default.json、development.json 和 production.json。以下是 default.json 的示例内容：

{
  "port": 3000,
  "wechaty": {
    "token": "your_wechaty_token",
    "name": "wechat-bot"
  }
}

• port: 服务监听的端口号。
• wechaty: 微信机器人的配置，包括 token 和 name。

development.json 和 production.json 可以覆盖 default.json 中的配置，以适应不同的环境需求。例如：

// development.json
{
  "port": 3001
}

// production.json
{
  "port": 8080
}

通过这些配置文件，可以灵活地调整项目的运行参数，以适应不同的开发和生产环境。

wechat-bot带二次开发接口的PC微信聊天机器人项目地址:https://gitcode.com/gh_mirrors/wec/wechat-bot