前言

  • 本系列教程力求简洁明了，务必保证你的环境以及所有依赖的版本跟教程保持一致。

目标

  • 使用TypeScript完成一个微信机器人，即给一个微信号发送一个"ding"，此微信号自动回复一个"dong"

项目介绍

  • 看过前面教程的同学应该都了解了如果想用wechaty搭建一个微信机器人必须要有一个puppet的支持，而目前来说最稳定的puppet当属padlocal，但是需要收费且价格不算便宜，对于那些只是想尝鲜或者做测试的同学来说很不友好。今天要介绍的是一个免费的puppet—UOS微信，其实也就是一款桌面版微信。
  • UOS版的优点就是免费，且搭建也很简单；缺点也很明显：不稳定、功能少。但是对于想尝鲜或做测试的同学来说已经足够了
  • 重要说明：UOS版随时有可能因为官方某些原因无法使用，所以如果你是恰巧过了很长时间看到这篇教程且运行失败的话，那可能就是已经失效而不是你的原因

前置条件

  • 安装node

正式开始

编写package.json代码

在根目录下建立main.ts, package.json，
package.json代码如下

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

{
    "name": "wechaty-puppet-uos-demo",
    "version": "0.1.2",
    "description": "Demo for wechaty-puppet-uos",
    "author": "haoda",
    "license": "Apache-2.0",
    "dependencies": {
        "qrcode-terminal": "^0.12.0",
        "wechaty": "^1.19.10",
        "wechaty-puppet": "^1.19.6",
        "wechaty-puppet-wechat": "^1.18.4"
    },
    "devDependencies": {
        "cross-env": "^7.0.3",
        "ts-node": "^10.7.0",
        "typescript": "^4.6.4"
    },
    "scripts": {
        "init": "npx ts-node main.ts",
        "demo-esm": "cross-env NODE_OPTIONS=\"--no-warnings --loader=ts-node/esm\" node main.ts"
    },
    "engines": {
        "node": ">= 16",
        "npm": ">=7"
    }
}

在根目录下运行npm i安装相关依赖（如果之前没有用过npm的同学可能会因为网络环境的问题安装失败，可以换成国内源尝试）

编写main.ts代码

main.ts代码如下

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

// main.ts
import {
    log,
    ScanStatus, 
    WechatyBuilder,
    Message
} from 'wechaty'



async function onMessage(message: Message) {
    try {
        const room = message.room()
        const sender = message.talker()
        const content = message.text()

        if (message.self()) {
            return
        }

        if (content === 'ding') {
            await message.say('dong')
        }
    } catch (e) {
        console.error(e)
    }
}

const bot = WechatyBuilder.build({
    name: "UosDemo",
    puppetOptions: {
        uos: true  // 重要，开启uos协议
      },
    puppet: 'wechaty-puppet-wechat',
  })
    .on("scan", (qrcode, status) => {
      if (status === ScanStatus.Waiting && qrcode) {
        const qrcodeImageUrl = [
          'https://wechaty.js.org/qrcode/',
          encodeURIComponent(qrcode),
        ].join('')
  
        log.info(`onScan: ${ScanStatus[status]}(${status}) - ${qrcodeImageUrl}`);
  
        require('qrcode-terminal').generate(qrcode, {small: true})  // show qrcode on console
      } else {
        log.info(`onScan: ${ScanStatus[status]}(${status})`);
      }
    })
  
    .on("login", (user) => {
      log.info(`${user} login`);
    })
  
    .on("logout", (user, reason) => {
      log.info(`${user} logout, reason: ${reason}`);
    })
  
    .on('message', onMessage)
  
  
  bot.start().then(() => {
    log.info("started.");
  });

测试

之后运行npm run init，一切正常的情况下会在终端出现一个二维码，使用做微信机器人的微信号扫码登陆，之后使用别的微信向此微信发送ding，微信机器人回复dong即代表成功。