微信助手项目使用教程

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

微信助手项目的目录结构如下：

wechat-assistant/
├── config/
│   ├── default.json
│   └── production.json
├── src/
│   ├── bot.js
│   ├── index.js
│   └── utils/
├── package.json
└── README.md

目录结构介绍

• config/: 存放项目的配置文件。
  • default.json: 默认配置文件。
  • production.json: 生产环境配置文件。
• src/: 项目的主要源代码目录。
  • bot.js: 微信机器人的核心逻辑文件。
  • index.js: 项目的入口文件。
  • utils/: 存放一些工具函数或模块。
• package.json: 项目的依赖管理文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

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

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

const main = async () => {
  const botInstance = Wechaty.instance()
  botInstance.on('scan', (qrcode, status) => {
    console.log(`Scan QR Code to login: ${status}\n${qrcode}`)
  })
  botInstance.on('login', user => {
    console.log(`User ${user} logged in`)
  })
  botInstance.on('message', message => {
    console.log(`Message: ${message}`)
  })
  await botInstance.start()
}

main().catch(console.error)

启动文件介绍

• require('wechaty'): 引入 Wechaty 库。
• require('./bot'): 引入 bot.js 文件，该文件包含微信机器人的具体逻辑。
• main 函数：初始化 Wechaty 实例，并监听 scan、login 和 message 事件。
• botInstance.start(): 启动微信机器人。

3. 项目的配置文件介绍

项目的配置文件存放在 config/ 目录下，主要包括 default.json 和 production.json。

default.json

{
  "token": "your_wechaty_token",
  "apiKey": "your_api_key",
  "apiSecret": "your_api_secret"
}

production.json

{
  "token": "your_production_wechaty_token",
  "apiKey": "your_production_api_key",
  "apiSecret": "your_production_api_secret"
}

配置文件介绍

• token: Wechaty 的访问令牌。
• apiKey 和 apiSecret: 第三方 API 的密钥和密钥。

以上是微信助手项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用该项目。