EasyWeChat for Laravel
微信 SDK EasyWeChat for Laravel， 基于 w7corp/easywechat
7.x 起不再默认支持 Lumen。
框架要求
- overtrue/laravel-wechat:^7.0 -> Laravel >= 8.0
- overtrue/laravel-wechat:^6.0 -> Laravel/Lumen >= 7.0
- overtrue/laravel-wechat:^5.1 -> Laravel/Lumen >= 5.1
安装
composer require overtrue/laravel-wechat:^7.2配置
- 创建配置文件：
php artisan vendor:publish --provider="Overtrue\\LaravelWeChat\\ServiceProvider"- 可选，添加别名
'aliases' => [
// ...
'EasyWeChat' => Overtrue\LaravelWeChat\EasyWeChat::class,
],- 每个模块基本都支持多账号，默认为
default。
使用
App\Http\Middleware\VerifyCsrfToken 排除微信相关的路由，如：
protected $except = [
// ...
'wechat',
];下面以接收普通消息为例写一个例子。
路由：
Route::any('/wechat', 'WeChatController@serve');注意：一定是
Route::any, 因为微信服务端认证的时候是GET, 接收用户消息时是POST！
然后创建控制器 WeChatController：
<?php
namespace App\Http\Controllers;
use Log;
class WeChatController extends Controller
{
public function serve()
{
Log::info('request arrived.');
$server = app('easywechat.official_account')->getServer();
$server->with(function($message){
return "欢迎关注 overtrue！";
});
return $server->serve();
}
}OAuth 中间件
使用中间件的情况下 app/config/easywechat.php 中的 oauth.callback 就随便填写吧(因为用不着了
- 在
app/Http/Kernel.php中添加路由中间件：
protected $routeMiddleware = [
// ...
'easywechat.oauth' => \Overtrue\LaravelWeChat\Middleware\OAuthAuthenticate::class,
];- 在路由中添加中间件：
//...
Route::group(['middleware' => ['web', 'easywechat.oauth']], function () {
Route::get('/user', function () {
$user = session('easywechat.oauth_user.default'); // 拿到授权用户资料
dd($user);
});
});中间件支持指定配置名称：'easywechat.oauth:default'，当然，你也可以在中间件参数指定当前的 scopes:
Route::group(['middleware' => ['easywechat.oauth:snsapi_userinfo']], function () {
// ...
});
// 或者指定账户的同时指定 scopes:
Route::group(['middleware' => ['easywechat.oauth:default,snsapi_userinfo']], function () {
// ...
});上面的路由定义了 /user 是需要微信授权的，那么在这条路由的回调 或 控制器对应的方法里， 你就可以从 session('easywechat.oauth_user.default') 拿到已经授权的用户信息了。
模拟授权
有时候我们希望在本地开发完成后线上才真实的走微信授权流程，这将减少我们的开发成本，那么你需要做以下两步：
- 准备模拟授权资料：
use Illuminate\Support\Arr;
use Overtrue\Socialite\User as SocialiteUser;
$user = new SocialiteUser([
'id' => 'mock-openid',
'name' => 'overtrue',
'nickname' => 'overtrue',
'avatar' => 'http://example.com/avatars/overtrue.png',
'email' => null,
'original' => [],
'provider' => 'WeChat',
]);以上字段在 scope 为
snsapi_userinfo时尽可能配置齐全哦，当然，如果你的模式只是snsapi_base的话只需要openid就好了。
- 将资料写入 session：
注意：一定要在调用 OAuth 中间件之前写入，比如你可以创建一个全局中间件来完成这件事儿，只在开发环境启用即可。
session(['easywechat.oauth_user.default' => $user]); // 同理，`default` 可以更换为您对应的其它配置名事件
你可以监听相应的事件，并对事件发生后执行相应的操作。
- OAuth 网页授权：
Overtrue\LaravelWeChat\Events\WeChatUserAuthorized
// 该事件有以下属性
$event->user; // 同 session('easywechat.oauth_user.default') 一样
$event->isNewSession; // 是不是新的会话（第一次创建 session 时为 true）
$event->account; // 当前中间件所使用的账号，对应在配置文件中的配置项名称开放平台支持
您可以适用内置的 Overtrue\LaravelWeChat\Traits\HandleOpenPlatformServerEvents 来快速完成开放平台的服务端验证工作：
routes/web.php:
Route::any('/open-platform/server', OpenPlatformController::class);app/Http/Controllers/OpenPlatformController.php:
<?php
namespace App\Http\Controllers;
use Overtrue\LaravelWeChat\Traits\HandleOpenPlatformServerEvents;
class OpenPlatformController extends Controller
{
use HandleOpenPlatformServerEvents;
public function __invoke(Application $application): \Psr\Http\Message\ResponseInterface
{
$app = app('easywechat.open_platform');
return $this->handleServerEvents($app);
}
}Tips: 默认会根据微信开放平台的推送内容触发如下事件，你可以监听相应的事件并进行处理：
- 授权方成功授权：
Overtrue\LaravelWeChat\Events\OpenPlatform\Authorized - 授权方更新授权：
Overtrue\LaravelWeChat\Events\OpenPlatform\AuthorizeUpdated - 授权方取消授权：
Overtrue\LaravelWeChat\Events\OpenPlatform\Unauthorized - 开放平台推送 VerifyTicket：
Overtrue\LaravelWeChat\Events\OpenPlatform\VerifyTicketRefreshed
// 事件有如下属性
$message = $event->payload; // 开放平台事件通知内容配置后 http://example.com/open-platform/server 则为开放平台第三方应用设置的授权事件接收 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