微信公众号

微信公众号沙箱: https://mp.weixin.qq.com/debug/cgi-bin/sandbox?t=sandbox/login

初始化配置

  1. $wechat->officialAccount()->getConfig()->setAppId('your appid')->setAppSecret('your aoo secret')->setToken('your token');

服务端

  1. use EasySwoole\WeChat\WeChat;
  2. use EasySwoole\WeChat\Bean\OfficialAccount\AccessCheck;
  3. use EasySwoole\WeChat\Bean\OfficialAccount\Message\Text;
  4. use EasySwoole\WeChat\Bean\OfficialAccount\RequestMsg;
  5. use EasySwoole\WeChat\Bean\OfficialAccount\RequestedReplyMsg;
  6. use EasySwoole\WeChat\Bean\OfficialAccount\RequestConst;
  7. $wechat = new WeChat();
  8. $wechat->officialAccount()->getConfig()
  9.     ->setAppId('setAppId')
  10.     ->setAppSecret('setAppSecret')
  11.     ->setToken('setToken');
  13. /*
  14.  * 每个请求到达时将会调用 preCall 方法，这是一个前置操作方法，类似 onRequest 如果你返回false，则表示中断后续流程。
  15.  * 如果你返回一个 RequestedReplyMsg 对象，则会响应微信对象中的消息并中断后续流程
  16.  * 如果你什么都不返回，则会继续执行后续流程
  17.  */
  18. $wechat->officialAccount()->server()->preCall(function (RequestMsg $msg){
  19. //    var_dump($msg->__toString());
  20. });
  22. /*
  23.  * onMessage 方法是 注册每个消息到达时的事件处理，你可以通过set(消息类型, 处理方法) 来注册
  24.  */
  25. $wechat->officialAccount()->server()->onMessage()->set('text',function (RequestMsg $msg){
  26.     $reply = new Text();
  27.     $reply->setMsgType(RequestConst::MSG_TYPE_TEXT);
  28.     $reply->setContent('hello from server');
  29.     return $reply;
  30. });
  32. /*
  33.  * 更为精确和规范的方式则是使用 RequestConst 类中提供的类常量来进行注册
  34.  */
  35. $wechat->officialAccount()->server()->onMessage()->set(RequestConst::DEFAULT_ON_MESSAGE,function (RequestMsg $msg){
  36.     $reply = new RequestedReplyMsg();
  37.     $reply->setMsgType(RequestConst::MSG_TYPE_TEXT);
  38.     $reply->setContent('you say :'.$msg->getContent());
  39.     return $reply;
  40. });
  42. /*
  43.  * 与常规消息不同，事件类的则通过 onEvent 方法来进行注册处理机制，这里是一个用户关注事件
  44.  */
  45. $wechat->officialAccount()->server()->onEvent()->onSubscribe(function (RequestMsg $msg){
  46.     var_dump("{$msg->getFromUserName()} has SUBSCRIBE");
  47.     $reply = new RequestedReplyMsg();
  48.     $reply->setMsgType(RequestConst::MSG_TYPE_TEXT);
  49.     $reply->setContent('Welcome to EasySwoole');
  50.     return $reply;
  51. });
  53. /*
  54.  * 用户取消关注事件
  55.  */
  56. $wechat->officialAccount()->server()->onEvent()->onUnSubscribe(function (RequestMsg $msg){
  57.     var_dump("{$msg->getFromUserName()} has UBSCRIBE");
  58. });
  60. /*
  61.  * 也可以注册默认 和自定义事件处理
  62.  */
  63. $wechat->officialAccount()->server()->onEvent()->set(RequestConst::DEFAULT_ON_EVENT,function (){
  64.     $reply = new RequestedReplyMsg();
  65.     $reply->setMsgType(RequestConst::MSG_TYPE_TEXT);
  66.     $reply->setContent('this is event default reply');
  67.     return $reply;
  68. });
  70. /*
  71.  * 下面是一个简单示例，EasySwoole/Wechat 并不依赖EasySwoole框架本身，即时是原生swoole也可以轻易使用。
  72.  * 如果你框架用户，只需要预先注册事件并正确的将微信请求交给Wechat处理即可
  73.  */
  74. $http = new swoole_http_server("127.0.0.1", 9501);
  75. $http->on("request", function ($request, $response)use($wechat){
  76.     if($request->server['request_method'] == 'GET'){
  77.         $bean = new AccessCheck($request->get);
  78.         $verify = $wechat->officialAccount()->server()->accessCheck($bean);
  79.         if($verify){
  80.             $response->write($bean->getEchostr());
  81.         }
  82.     }else{
  83.         $res = $wechat->officialAccount()->server()->parserRequest($request->rawContent());
  84.         if(is_string($res)){
  85.             $response->write($res);
  86.         }
  87.     }
  88.     $response->end();
  89. });
  90. $http->start();

Access Token

  1. // 刷新token  如果成功会返回token
  2. $wechat->officialAccount()->accessToken()->refresh();
  4. // 获取token
  5. $wechat->officialAccount()->accessToken()->getToken();

获取微信公众号服务器 ip 列表

如果公众号基于安全等考虑，需要获知微信服务器的IP地址列表，以便进行相关限制，可以通过该接口获得微信服务器IP地址列表或者IP网段信息。

  1. $wechat->officialAccount()->ipList()

NetWork Check

为了帮助开发者排查回调连接失败的问题，提供这个网络检测的API。它可以对开发者URL做域名解析，然后对所有IP进行一次ping操作，得到丢包率和耗时。

  1. use EasySwoole\WeChat\Bean\OfficialAccount\NetCheckRequest;
  2. $req = new NetCheckRequest();
  3. $wechat->officialAccount()->netCheck($req);

生成二维码

  1. namespace EasySwoole\WeChat;
  3. use EasySwoole\WeChat\Bean\OfficialAccount\QrCodeRequest;
  4. $qrRequest = new QrCodeRequest;
  5. $qrRequest->setActionName($qrRequest::QR_LIMIT_SCENE);
  6. $qrRequest->setSceneId(1);
  8. $qrCode = $wechat->officialAccount()->qrCode();
  9. $tick = $qrCode->getTick($qrRequest);
  10. $url = $qrCode::tickToImageUrl($tick);

微信菜单

  1. $buttons = [
  2.         [
  3.             "type" => "click",
  4.             "name" => "今日歌曲",
  5.             "key"  => "V1001_TODAY_MUSIC"
  6.         ],
  7.         [
  8.             "name"       => "菜单",
  9.             "sub_button" => [
  10.                 [
  11.                     "type" => "view",
  12.                     "name" => "搜索",
  13.                     "url"  => "http://www.soso.com/"
  14.                 ],
  15.                 [
  16.                     "type" => "view",
  17.                     "name" => "视频",
  18.                     "url"  => "http://v.qq.com/"
  19.                 ],
  20.                 [
  21.                     "type" => "click",
  22.                     "name" => "赞一下我们",
  23.                     "key" => "V1001_GOOD"
  24.                 ],
  25.             ],
  26.         ],
  27.     ];
  29.     $matchRule = [
  30.         "tag_id" => "2",
  31.         "sex" => "1",
  32.         "country" => "中国",
  33.         "province" => "广东",
  34.         "city" => "广州",
  35.         "client_platform_type" => "2",
  36.         "language" => "zh_CN"
  37.     ];
  39.     // 创建菜单
  40.     $wechat->officialAccount()->menu()->create($buttons);
  41.     // 创建个性化菜单
  42.     $menuId = $wechat->officialAccount()->menu()->create($buttons, $matchRule);
  43.     // 查询现在生效的菜单
  44.     $wechat->officialAccount()->menu()->query();
  45.     // 测试个性化菜单
  46.     $wechat->officialAccount()->menu()->match('openid OR wechat ID');
  47.     // 删除全部菜单
  48.     $wechat->officialAccount()->menu()->delete();
  49.     // 删除指定的个性化菜单
  50.     $wechat->officialAccount()->menu()->delete($menuId);

JSAPI

  1.     // 获取JsApi对象
  2.     $jsApi = $wechat->officialAccount()->jsApi();
  4.     // 创建微信授权跳转连接
  5.     $jsAuthRequest = new JsAuthRequest;
  6.     // 设置授权后回调地址
  7.     $jsAuthRequest->setRedirectUri('http://m.evalor.cn');
  8.     // 设置 state
  9.     $jsAuthRequest->setState('test');
  10.     // 设置授权类型
  11.     $jsAuthRequest->setType($jsAuthRequest::TYPE_USER_INFO);
  12.     // 返回生成地址 需要开发者自行重定向用户
  13.     $link = $jsApi->auth()->generateURL($jsAuthRequest);
  15.     /* 使用微信回调时提供的 code 获取AccessToken
  16.      * 从微信回调时 附带在 url的get参数上 前端或者后端获取都可以
  17.      */
  18.     $code = ''
  19.     $snsAuthBean  = $jsApi->auth()->codeToToken($code);
  20.     $snsAuthBean->getScope();
  21.     $snsAuthBean->getOpenid();
  22.     $snsAuthBean->getAccessToken();
  23.     $snsAuthBean->getRefreshToken();
  25.     // 使用上面提供的 $snsAuthBean对象 获取用户信息
  26.     $user = $jsApi->auth()->tokenToUser($snsAuthBean);
  27.     $user->getOpenid();
  28.     $user->getHeadimgurl();
  29.     $user->getNickname(); 
  30.     // 更多信息自行阅读源码
  32.     // 直接使用 code 获取用户信息，是上述操作的快捷封装
  33.     $user = $jsApi->auth()->codeToUser($code);
  35.     // 刷新 AccessToken，refresh token  需要自行存储
  36.     $token = $snsAuthBean->getRefreshToken();
  37.     $snsAuthBean = $jsApi->auth()->refreshToken($token);
  39.     // ckeck token (openid and access token is required)
  40.     $snsAuthBean->setOpenid();
  41.     $snsAuthBean->setAccessToken();
  42.     $check = $jsApi->auth()->authCheck($snsAuthBean);
  44.     $url = '';  // current request url given by yourself
  45.     // jsApi signature (this is the information wx.config needs)
  46.     $jsApiSignaturePack = $jsApi->jsApi()->sdk()->signature($url);
  47.     $jsApiSignaturePack->getAppId();
  48.     $jsApiSignaturePack->getNonceStr();
  49.     $jsApiSignaturePack->getSignature();
  50.     $jsApiSignaturePack->getTimestamp();

素材管理(临时)

  1.     use Swoole\Coroutine;
  2.     use EasySwoole\WeChat\Bean\OfficialAccount\MediaRequest;
  3.     use EasySwoole\WeChat\Bean\OfficialAccount\MediaResponse;
  5.     // 上传文件路径
  6.     $path = 'image.jpg';
  7.     // 上传文件类型
  8.     $type = MediaRequest::TYPE_IMAGE;
  10.     // 你也可以使用new 时候传递关联数组来直接完成创建 new MediaRequest(['path' => $path, 'type' => $type);
  11.     $mediaBean = new MediaRequest(); 
  12.     $mediaBean->setPath($path);
  13.     $mediaBean->setType($type);
  14.     $response = $wechat->officialAccount()->media()->upload($mediaBean);
  16.     // 或者也可以直接通过 流来进行上传
  17.     $stream = Coroutine::readFile($path);
  18.     $mediaBean = new MediaRequest();
  19.     $mediaBean->setType($type);
  20.     $mediaBean->setData($stream);
  21.     $response = $wechat->officialAccount()->media()->upload($mediaBean);
  23.     // 使用mediaId 获取素材 
  24.     $response = $wechat->officialAccount()->media()->get($mediaId);
  25.     if($response instanceof MediaResponse) {
  26.         // Response对象提供了快捷保存方法 只需要传递存储文件目录地址即可名字会自动通过文件获取
  27.         $response->save($directory); 
  28.         // 如果你想自定义文件名称， 可以使用这个方法
  29.         $response->saveAs($directory, $filename)
  30.     }
  32.     // 如果是 video 素材则需要开发者自行下载
  33.     $response = [
  34.         'video_url': $downUrl
  35.     ]

素材管理(永久)

  1.     // upload
  2.     use EasySwoole\WeChat\Bean\OfficialAccount\MediaRequest;
  3.     use EasySwoole\WeChat\Bean\OfficialAccount\MediaArticle;
  5.     $mediaBean = new MediaRequest();
  6.     $mediaBean->setPath('thumb.jpg');
  7.     $mediaBean->setType(MediaRequest::TYPE_THUMB);
  9.     // 如果你的素材类型是 video 必须设置标题和简介
  10.     // $mediaBean->setTitle('title');
  11.     // $mediaBean->setIntroduction('introduction');
  13.     $mediaUploadResponse = $wechat->officialAccount()->material()->upload($mediaBean)['media_id'];
  14.     $thumbMediaId = $mediaUploadResponse['media_id'];
  16.     // 上传图文消息
  17.     $article = [
  18.         'title' => 'EasySwoole/Wechat！',
  19.         'thumb_media_id' => $thumbMediaId,
  20.         'author' => 'EasySwoole/Wechat',
  21.         'show_cover' => 1,
  22.         'digest' => 'digest',
  23.         'content' => 'content',
  24.         'source_url' => 'https://www.easyswoole.com',
  25.     ];
  27.     $mediaArticle_0 = new MediaArticle($article);
  28.     $mediaArticle_1 = new MediaArticle($article);
  29.     // uploadArticle 方法的参数是一个 可变参数，但是每一个参数都必须是MediaArticle类的实例 [可变参数](https://www.php.net/manual/zh/functions.arguments.php#functions.variable-arg-list)
  30.     $uploadArticleResponse = $wechat->officialAccount()->material()->uploadArticle($mediaArticle_0, $mediaArticle_1);
  32.     // 获取素材
  33.     $materialGetResponse = $wechat->officialAccount()->material()->get($uploadArticleResponse['media_id']);
  35.     // 上传图文素材的图片
  36.     $mediaBean = new MediaRequest();
  37.     $mediaBean->setPath('image.jpg');
  38.     $mediaBean->setType(MediaRequest::TYPE_IMAGE);
  39.     // uploadArticleImage 方法并不会返回 media_id 而是url
  40.     $imageUrl = $wechat->officialAccount()->material()->uploadArticleImage($mediaBean)['url'];
  42.     // 上传图文素材
  43.     $newMediaArticle_0 = new MediaArticle($materialGetResponse['news_item'][0]);
  44.     $newMediaArticle_0->setContent("<img src='{$imageUrl}' alt='image alt'>");
  45.     $updateArticleResponse = $wechat->officialAccount()->material()->updateArticle($uploadArticleResponse['media_id'], $newMediaArticle_0, 0);
  47.     // 删除素材
  48.     $materialDeleteResponse = $wechat->officialAccount()->material()->delete($uploadArticleResponse['media_id']);