README

微信 SDK for Laravel / Lumen，基于 surpaimb/wechat

交流QQ群：319502940

框架要求

surpaimb/laravel-wechat:^5.1 -> Laravel/Lumen >= 5.1
surpaimb/laravel-wechat:^6.0 -> Laravel/Lumen >= 7.0

安装

# surpaimb/wechat 4.x
composer require "surpaimb/laravel-wechat:^5.1"

# surpaimb/wechat 5.x
composer require "surpaimb/laravel-wechat:^6.0"

配置

Laravel 应用

在 config/app.php 注册 ServiceProvider 和 Facade (Laravel 5.5 + 无需手动注册)

'providers' => [
    // ...
    Surpaimb\LaravelWeChat\ServiceProvider::class,
],
'aliases' => [
    // ...
    'Surpaimb\WeChat' => Surpaimb\LaravelWeChat\Facade::class,
],

创建配置文件：

php artisan vendor:publish --provider="Surpaimb\LaravelWeChat\ServiceProvider"

修改应用根目录下的 config/wechat.php 中对应的参数即可。
每个模块基本都支持多账号，默认为 default。

Lumen 应用

在 bootstrap/app.php 中 82 行左右：

$app->register(Surpaimb\LaravelWeChat\ServiceProvider::class);

如果你习惯使用 config/wechat.php 来配置的话，将 vendor/surpaimb/laravel-wechat/src/config.php 拷贝到项目根目录/config目录下，并将文件名改成wechat.php。

使用

🚨 在中间件 App\Http\Middleware\VerifyCsrfToken 排除微信相关的路由，如：

protected $except = [
    // ...
    'wechat',
];

下面以接收普通消息为例写一个例子：

假设您的域名为 surpaimb.me 那么请登录微信公众平台 “开发者中心” 修改 “URL（服务器配置）” 为： http://surpaimb.me/wechat。

路由：

Route::any('/wechat', 'WeChatController@serve');

注意：一定是 Route::any, 因为微信服务端认证的时候是 GET, 接收用户消息时是 POST ！

然后创建控制器 WeChatController：

<?php

namespace App\Http\Controllers;

use Log;

class WeChatController extends Controller
{

    /**
     * 处理微信的请求消息
     *
     * @return string
     */
    public function serve()
    {
        Log::info('request arrived.'); # 注意：Log 为 Laravel 组件，所以它记的日志去 Laravel 日志看，而不是 Surpaimb\WeChat 日志

        $app = app('wechat.official_account');
        $app->server->push(function($message){
            return "欢迎关注 surpaimb！";
        });

        return $app->server->serve();
    }
}

上面例子里的 Log 是 Laravel 组件，所以它的日志不会写到 Surpaimb\WeChat 里的，建议把 wechat 的日志配置到 Laravel 同一个日志文件，便于调试。

我们有以下方式获取 SDK 的服务实例

使用外观

  $officialAccount = \Surpaimb\WeChat::officialAccount(); // 公众号
  $work = \Surpaimb\WeChat::work(); // 企业微信
  $payment = \Surpaimb\WeChat::payment(); // 微信支付
  $openPlatform = \Surpaimb\WeChat::openPlatform(); // 开放平台
  $miniProgram = \Surpaimb\WeChat::miniProgram(); // 小程序
  
  // 均支持传入配置账号名称
  \Surpaimb\WeChat::officialAccount('foo'); // `foo` 为配置文件中的名称，默认为 `default`
  //...

OAuth 中间件

使用中间件的情况下 app/config/wechat.php 中的 oauth.callback 就随便填写吧(因为用不着了 😄)。

在 app/Http/Kernel.php 中添加路由中间件：

protected $routeMiddleware = [
    // ...
    'wechat.oauth' => \Surpaimb\LaravelWeChat\Middleware\OAuthAuthenticate::class,
];

在路由中添加中间件：

//...
Route::group(['middleware' => ['web', 'wechat.oauth']], function () {
    Route::get('/user', function () {
        $user = session('wechat.oauth_user.default'); // 拿到授权用户资料

        dd($user);
    });
});

中间件支持指定配置名称：'wechat.oauth:default'，当然，你也可以在中间件参数指定当前的 scopes:

Route::group(['middleware' => ['wechat.oauth:snsapi_userinfo']], function () {
  // ...
});

// 或者指定账户的同时指定 scopes:
Route::group(['middleware' => ['wechat.oauth:default,snsapi_userinfo']], function () {
  // ...
});

上面的路由定义了 /user 是需要微信授权的，那么在这条路由的回调或控制器对应的方法里，你就可以从 session('wechat.oauth_user.default') 拿到已经授权的用户信息了。

模拟授权

有时候我们希望在本地开发完成后线上才真实的走微信授权流程，这将减少我们的开发成本，那么你需要做以下两步：

准备假资料：

以下字段在 scope 为 snsapi_userinfo 时尽可能配置齐全哦，当然，如果你的模式只是 snsapi_base 的话只需要 openid 就好了。

use Illuminate\Support\Arr;
use surpaimb\Socialite\User as SocialiteUser;

$user = new SocialiteUser([
                'id' => Arr::get($user, 'openid'),
                'name' => Arr::get($user, 'nickname'),
                'nickname' => Arr::get($user, 'nickname'),
                'avatar' => Arr::get($user, 'headimgurl'),
                'email' => null,
                'original' => [],
                'provider' => 'WeChat',
            ]);

将资料写入 session：

注意：一定要在 OAuth 中间件之前写入，比如你可以创建一个全局中间件来完成这件事儿，当然了，只在开发环境启用即可。

session(['wechat.oauth_user.default' => $user]); // 同理，`default` 可以更换为您对应的其它配置名

事件

你可以监听相应的事件，并对事件发生后执行相应的操作。

OAuth 网页授权：Surpaimb\LaravelWeChat\Events\WeChatUserAuthorized

// 该事件有以下属性
$event->user; // 同 session('wechat.oauth_user.default') 一样
$event->isNewSession; // 是不是新的会话（第一次创建 session 时为 true）
$event->account; // 当前中间件所使用的账号，对应在配置文件中的配置项名称

开放平台路由支持

在配置文件 route 处取消注释即可启用。

'open_platform' => [
    'uri' => 'serve',
    'action' => Surpaimb\LaravelWeChat\Controllers\OpenPlatformController::class,
    'attributes' => [
        'prefix' => 'open-platform',
        'middleware' => null,
    ],
],

Tips: 默认的控制器会根据微信开放平台的推送内容触发如下事件，你可以监听相应的事件并进行处理：

授权方成功授权：Surpaimb\LaravelWeChat\Events\OpenPlatform\Authorized
授权方更新授权：Surpaimb\LaravelWeChat\Events\OpenPlatform\UpdateAuthorized
授权方取消授权：Surpaimb\LaravelWeChat\Events\OpenPlatform\Unauthorized
开放平台推送 VerifyTicket：Surpaimb\LaravelWeChat\Events\OpenPlatform\VerifyTicketRefreshed

// 事件有如下属性
$message = $event->payload; // 开放平台事件通知内容

配置后 http://example.com/open-platform/serve 则为开放平台第三方应用设置的授权事件接收 URL。

更多 SDK 的具体使用请参考：https://www.easywechat.com

❤️ Sponsor me

如果你喜欢我的项目并想支持它，点击这里 ❤️

Project supported by JetBrains

Many thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects.

PHP 扩展包开发

想知道如何从零开始构建 PHP 扩展包？

请关注我的实战课程，我会在此课程中分享一些扩展开发经验 —— 《PHP 扩展包实战教程 - 从入门到发布》

License

MIT

surpaimb / laravel-wechat

Maintainers

Details