使用Padlocal协议
使用Padlocal协议
一、介绍
本节与上一篇章的Web协议相比,区别只是在启动服务的环节:Token Gateway。
二、为什么需要网关
2.1 TOKEN 协议
在之前的付费微信协议中,通常是需要将服务部署在商家的集群上面,所有的消息接受与发送都是经过商家集群来管理,集中式管理固然能够监控意外bug,可是也带来了一个很严重的问题:所有的消息发送和接受的IP都是来自于一个IP池。
这个问题会加重账号的风险系数,毕竟官方是具备有一定的账号风控机制,让用户的账号处于一个危险的境地,担心消息接受的过多,发送的过多会不会让自己封号等等,而且这些因素的考虑也是合理的。
2.2 PadLocal
当然也有一定的解决方案:商家可以换对应的IP池,通过不定期的购买新的IP来减少消息扎堆的问题。这种方法虽然是缓解了这个问题,可是羊毛出在羊身上,维护成本大了,TOKEN
肯定就贵了,对于双方来说都不太好。于是社区就基于Pad协议提出了Local
的概念:wechaty-puppet-padlocal.
要使用此协议,必须在本地开启一个Gateway来发送和接受官方服务器发送过来的消息,这样消息的来源和发送目的地都是由开发者自己决定,就类似于电脑的客户端接受和发送消息,这样就极大程度上减小了账号风险系数,这也是协议中Local
的原因。
2.3 使用步骤
即使是这样,使用起来与web协议区别不大,整体步骤也分为两步:
- 使用Docker启动Padlocal网关服务
- 使用python-wechaty连接服务
三、启动Padlocal网关服务
3.1 脚本
# 设置环境变量
export WECHATY_LOG="verbose"
export WECHATY_PUPPET="wechaty-puppet-padlocal"
export WECHATY_PUPPET_PADLOCAL_TOKEN="puppet_padlocal_XXXXXX"
export WECHATY_PUPPET_SERVER_PORT="9001"
# 可使用代码随机生成UUID:import uuid;print(uuid.uuid4());
export WECHATY_TOKEN="1fe5f846-3cfb-401d-b20c-XXXXX"
docker run -ti \
--name wechaty_puppet_service_token_gateway \
--rm \
-e WECHATY_LOG \
-e WECHATY_PUPPET \
-e WECHATY_PUPPET_PADLOCAL_TOKEN \
-e WECHATY_PUPPET_SERVER_PORT \
-e WECHATY_TOKEN \
-p "$WECHATY_PUPPET_SERVER_PORT:$WECHATY_PUPPET_SERVER_PORT" \
wechaty/wechaty:0.56
3.2 参数说明
- WECHATY_PUPPET: 标识使用的哪个协议,一般和
token
类型的一一对应。比如当使用padlocal
协议的话,那这个就是wechaty-puppet-padlocal
,如果使用web
协议的话,那这个就是wechaty-puppet-wechat
。 - WECHATY_PUPPET_PADLOCAL_TOKEN: 这个协议是用来连接Padlocal的服务,目前是付费的。
- WECHATY_PUPPET_SERVER_PORT: 网关服务的接口,提供给
python-wechaty
来连接调用,如果服务部署在云服务器上,则需要保证该端口的可访问性。 - WECHATY_TOKEN: 当开发者在自己机器上启动一个网关服务时,需要通过
TOEKN
来做身份验证,避免服务被他人窃取。
以上代码只需要修改三个参数:WECHATY_PUPPET_PADLOCAL_TOKEN
, WECHATY_PUPPET_SERVER_PORT
, WECHATY_TOKEN
即可成功启动Token网关服务。
那网关服务启动成功之后,只需要编写python-wechaty
的代码来连接即可。
四、连接服务
4.1 本地测试和远端部署
当启动网关服务时,Padlocal
会根据WECHATY_TOKEN
来在Wechaty服务接口上注册部署机器的IP
和端口
,然后python-wechaty会根据WECHATY_TOKEN
在Wechaty服务接口上获取对应的IP和端口。
可是很多小伙伴在实际开发的过程中,通常会出现endpoint is not invalid
等错误信息,那是因为开发者有可能在本地启动网关服务或者服务器端口没有开放。
网关服务的部署通常是分为本地测试和远端部署,前者通常只是为了初学测试,后者是为了生产部署。如果是在生产部署时,只需要设置环境变量:
export WECHATY_PUPPET_SERVICE_TOKEN=1fe5f846-3cfb-401d-b20c-XXXXX
# or
export TOKEN=1fe5f846-3cfb-401d-b20c-XXXXX
# or
export token=1fe5f846-3cfb-401d-b20c-XXXXX
可是如果是在本地测试时,则通过ENDPOINT来找到启动的网关服务。
export WECHATY_PUPPET_SERVICE_TOKEN=1fe5f846-3cfb-401d-b20c-XXXXX
# or
export TOKEN=1fe5f846-3cfb-401d-b20c-XXXXX
# or
export token=1fe5f846-3cfb-401d-b20c-XXXXX
export WECHATY_PUPPET_SERVICE_ENDPOINT=127.0.0.1:9001
# or
export ENDPOINT=127.0.0.1:9001
# or
export endpoint=127.0.0.1:9001
4.2 TOKEN的作用
总而言之:
- 如果是公网环境下,可只需要设置
TOKEN
即可(因为你的token已经注册在chatie server上,故可以获取到目标资源服务器的ip和port) - 如果是内网环境下,可只需要使用
ENDPOINT
(localhost:port
)来让python-wechaty连接目标资源服务器。
如果是token是padlocal类型,则在python-wechaty程序内部可直接设置
export endpoint=localhost:port
来连接Gateway Server。
当然,以上的写法是使用Bash的方式来设置环境变量,也是可以通过python代码来设置环境变量,详细可看:
import os
os.environ['token'] = "1fe5f846-3cfb-401d-b20c-XXXXX"
os.environ['endpoint'] = "127.0.0.1:9001"
五、示例代码
talke is cheep, show you the code
import asyncio, os
from typing import List, Optional, Union
from wechaty_puppet import FileBox # type: ignore
from wechaty import Wechaty, Contact
from wechaty.user import Message, Room
class MyBot(Wechaty):
async def on_message(self, msg: Message):
"""
listen for message event
"""
from_contact: Optional[Contact] = msg.talker()
text = msg.text()
room: Optional[Room] = msg.room()
if text == 'ding':
conversation: Union[
Room, Contact] = from_contact if room is None else room
await conversation.ready()
await conversation.say('dong')
file_box = FileBox.from_url(
'https://ss3.bdstatic.com/70cFv8Sh_Q1YnxGkpoWK1HF6hhy/it/'
'u=1116676390,2305043183&fm=26&gp=0.jpg',
name='ding-dong.jpg')
await conversation.say(file_box)
os.environ['TOKEN'] = "1fe5f846-3cfb-401d-b20c-XXXXX"
os.environ['WECHATY_PUPPET_SERVICE_ENDPOINT'] = "127.0.0.1:9001"
asyncio.run(MyBot().start())
欢迎各位品尝以上代码 🥳