PHP 微信機器人 Vbot 結合 Laravel 基礎入門及實例

新來了項目，需要能監聽指定微信群的消息並進行轉發。基於 PHP 7 的 web 微信機器人 Vbot 可以滿足需求。Vbot 本質上就是實現了登錄網頁版微信來進行自動回復、群管理等等操作。

github 地址：https://github.com/hanson/vbot，官網地址：http://create.hanc.cc/vbot/。

 

安裝

環境要求：

PHP >= 7.0.0

PHP fileinfo 擴展

PHP gd 擴展

PHP SimpleXML 擴展

 安裝命令：

composer require hanson/vbot

 

基本使用

接下來是干貨了。由於項目需求較簡單，沒有涉及到高深的東西，讀者各取所需就行。

項目框架是 Laravel，從指定群中監聽消息，如果符合格式，則自動轉發到目標群中。

 

Vbot 的使用一般分為四步：初始化 Vbot 實例；設置消息處理器；設置監聽器；啟動 Vbot 服務。

初始化 Vbot 實例

Vbot 初始化配置只是修改指定了下載、日志、緩存文件等等的存儲路徑。

config/vbot.conf：

<?php

$path = storage_path('wechat');
return [
    'path' => $path,
    /*
     * swoole 配置項（執行主動發消息命令必須要開啟，且必須安裝 swoole 插件）
     */
    'swoole' => [
        'status' => false,
        'ip' => '127.0.0.1',
        'port' => '8866',
    ],
    /*
     * 下載配置項
     */
    'download' => [
        'image' => true,
        'voice' => true,
        'video' => true,
        'emoticon' => true,
        'file' => true,
        'emoticon_path' => $path . '/emoticons', // 表情庫路徑（PS：表情庫為過濾后不重復的表情文件夾）
    ],
    /*
     * 輸出配置項
     */
    'console' => [
        'output' => true, // 是否輸出
        'message' => true, // 是否輸出接收消息 （若上面為 false 此處無效）
    ],
    /*
     * 日志配置項
     */
    'log' => [
        'level' => 'debug',
        'permission' => 0777,
        'system' => $path . '/log', // 系統報錯日志
        'message' => $path . '/log', // 消息日志
    ],
    /*
     * 緩存配置項
     */
    'cache' => [
        'default' => 'file', // 緩存設置 （支持 redis 或 file）
        'stores' => [
            'file' => [
                'driver' => 'file',
                'path' => $path . '/cache',
            ],
            'redis' => [
                'driver' => 'redis',
                'connection' => 'default',
            ],
        ],
    ],
    /*
     * 拓展配置
     * ==============================
     * 如果加載拓展則必須加載此配置項
     */
    'extension' => [
        // 管理員配置（必選），優先加載 remark(備注名)
        'admin' => [
            'remark' => '',
            'nickname' => '',
        ],
        // 'other extension' => [ ... ],
    ],
];

app/Console/Commands/SendVbot.php：

public function handle()
{
    $vbot = new Vbot(config('vbot_conf'));
}

設置消息處理器

app/Console/Commands/SendVbot.php：

public function handle()
{
    ...
    $myvbot = app(MyVbot::class);

    // 獲取消息處理器實例
    $messageHandler = $vbot->messageHandler;

    // 收到消息時觸發
    $messageHandler->setHandler([$myvbot, 'messageHandler']);
}

app/Handlers/MyVbot：

<?php

namespace App\Handlers;

use Hanson\Vbot\Message\Text;
use Illuminate\Support\Collection;

class MyVbot
{
    public function messageHandler(Collection $message)
    {
        // 消息發送者類型
        $fromType = $message['fromType'] ?? null;
        // 消息類型
        $type = $message['type'] ?? null;
        // 經過處理顯示在控制台的消息
        $content = $message['content'] ?? null;
        // 轉格式后的消息
        $message_in = $message['message'] ?? null;
        // 發送者的 Username，當為群消息時此值為 sender 的 username
        $username = $message['username'] ?? null;

        // 消息來源
        $fromUserName = $message['from']['UserName'] ?? null;
        $fromNickName = $message['from']['NickName'] ?? null;

        // 群消息發送者
        $senderUserName = $message['sender']['UserName'] ?? null;
        $senderNickName = $message['sender']['NickName'] ?? null;

        ...
        
        vbot('console')->log("【轉發消息】：{$content}");
        Text::send($group_username, $content);

        ...
    }
}

設置監聽器

app/Console/Commands/SendVbot.php：

public function handle()
{
    ...
    $myobserver = app(MyObserver::class);

    // 獲取監聽器實例
    $observer = $vbot->observer;

    // 二維碼監聽器
    $observer->setQrCodeObserver([$myobserver, 'setQrCodeObserver']);

    $observer->setLoginSuccessObserver([$myobserver, 'setLoginSuccessObserver']);

    $observer->setExitObserver([$myobserver, 'setExitObserver']);
}

app/Observers/MyObserver.php：

<?php

namespace App\Observers;

use App\Repositories\Ding2Repository;

class MyObserver
{
    protected $ding2Repository;
    protected $uri;
    protected $console;

    public function __construct(Ding2Repository $ding2Repository)
    {
        $this->ding2Repository = $ding2Repository;
        $this->console =  vbot('console');
        $this->uri = 'https://oapi.dingtalk.com/robot/send?access_token=xxx';
    }

    public function setQrCodeObserver($qrCodeUrl)
    {
        $qrcode_url = str_replace('/l/', '/qrcode/', $qrCodeUrl);
        $this->ding2Repository->robotQrSend($this->uri, $qrcode_url);
    }

    public function setLoginSuccessObserver()
    {
        $this->ding2Repository->robotLoginSuccessSend($this->uri);

        $this->console->log('登錄成功');
    }

    public function setExitObserver()
    {
        $this->ding2Repository->robotExitSend($this->uri);

        $this->console->log('程序退出');
    }
}

啟動 Vbot 服務

public function handle()
{
    ...
    try {
        $vbot->server->serve();
    } catch (Exception $e) {
        $this->error($e->getMessage());
    }
}

編碼完成之后就可以運行 PHP 命令來啟動 Vbot 進程。