半个轮子：微信模板消息推送

随着微信小程序、手机APP项目的愈发普遍。单一的轮子会造成项目愈发臃肿。很多时候我们为了图方便都是直接引入别人的类库，很少关心自己是否实现一个类库。

今天波波分享的半个轮子属于一个半成品。其想法是将微信模板消息推送、阿里云移动推送、个推（集成这个主要原因是uni-app中移动端有此插件，集成后可以让前端技术更方便）、邮件、短信这几个功能放到一个PHP文件中。使用时只需要一句话进行调用。

调用代码片段：

  1. /**
  2.      * 工单提醒
  3.      */
  4.     public function reminder(){
  5.         $msg = ["touser"=>1,"method"=>"wechat","scene"=>"remind","msg_type"=>"text",
  6.             "content"=>["first"=>["value"=>"您有一条工单即将到期","color"=>"#173177"],
  7.                 "keyword1"=>["value"=>"GD2018080133420","color"=>"#173177"],"keyword2"=>["value"=>"保养任务","color"=>"#173177"],
  8.                 "keyword3"=>["value"=>"2021-03-30 12:30:00","color"=>"#173177"],"remark"=>['value'=>"这是一条测试提醒"]],'title'=>"工单提醒",'openid'=>"oytM-6Y_oTomRkXPjxHJsIdMhVP0"];
  9.         $res = NotifyService::send($msg);
  10.         $code = $res['code'] || 200;
  11.         $this->result([],$code,$res['msg'],'json');
  12.     }

关键在于使用时仅需要在调用的PHP文件上方引入NotifyService，直接使用send()方法即可。

NotifyService源码（半成品）：

  1. <?php
  2. namespace service;
  4. /**
  5.  * 消息推送服务
  6.  * Class NotifyService.php
  7.  * @package app\admin\controller
  8.  * @author 繁华如梦 <[email protected]>
  9.  * @desc:基于阿里移动推送、邮件、个推、微信公众号做消息推送
  10.  * @date 2021/3/8 9:33
  11.  */
  12. class NotifyService{
  14.     private static $content = [];
  15.     /** 发送消息对象 */
  16.     private static $_send = [];
  18.     /**NotifyService Constructor
  19.      * @param array $msg  初始化消息数据
  20.      * $msg eg.["touser":uid,"method":all,"scene":register,"msg_type":text,"content":XXX ...];
  21.      * method:all表示全部推送，wechat表示微信推送，alipush表示阿里推送,mail表示邮件,getui表示个推
  22.      */
  24.     public static function send($msg){
  25.         $v = self::verify($msg);
  26.         if($v['code'] !== 200){
  27.             return ['code'=>$v['code'],'msg'=>$v['msg']];
  28.         }
  29.         emptyempty($msg['msg_type']) && $msg['msg_type'] = "text";  //默认文本消息,后期根据通道可以丰富推送消息类型，但微信仅支持文本！！！
  30.         self::$content = $msg;
  31.         self::buildMsg();
  32.         switch (self::$content['method']){
  33.             case "wechat":
  34.                 self::wechat_push(self::$_send);
  35.                 break;
  36.             case "alipush":
  37.                 self::mpush(self::$_send);
  38.                 break;
  39.             case "all":
  40.                 self::wechat_push(self::$_send['wechat']);
  41.                 self::mpush(self::$_send['alipush']);
  42.                 break;
  43.             default:
  44.                 break;
  45.         }
  46.         return ['code'=>"200",'msg'=>"消息发送成功"];
  47.     }
  49.     /**
  50.      * 发送微信模板消息
  51.      * @param array $msg buildMsg
  52.      */
  53.     private static function wechat_push($msg){
  54.         $wechat = &load_wechat('Receive');
  55.         $res = $wechat->sendTemplateMessage($msg);
  56.         return $res;
  57.     }
  59.     /**发送阿里移动推送
  60.      * @param array $msg buildMsg
  61.      */
  62.     private function mpush($msg){
  63.         $api = "cloudpush.aliyuncs.com";
  64.         date_default_timezone_set("GMT");
  65.         $dateTimeFormat = 'Y-m-d\TH:i:s\Z'; // ISO8601规范
  66.         $accessKeyId = sysconf('sms_aliyun_appid');
  67.         $accessKeySecret = sysconf('sms_aliyun_appsecret');
  68.         $msg['AccessKeyId'] = $accessKeyId;
  69.         $msg['SignatureMethod'] = "HMAC-SHA1";
  70.         $msg['Timestamp'] = date($dateTimeFormat);
  71.         $msg['SignatureVersion'] = "1.0";
  72.         $msg['SignatureNonce'] = uniqid();
  73.         $msg['Signature'] = self::getSignature($msg,$accessKeySecret);
  74.         //推送消息
  75.         $res = simplexml_load_string(HttpService::get($api,$msg));
  76.         $res = json_decode(json_encode($res),true);
  77.         //返回数据仅有RequestId，MessageId
  78.         if(!emptyempty($res['MessageId'])){
  79.             return ['code'=>200,'msg'=>"移动推送消息成功",'content'=>$res];
  80.         }else{
  81.             return ['code'=>500,'msg'=>$res['Message']];
  82.         }
  84.     }
  87.     /**
  88.      * 根据类型构建消息
  89.      */
  90.     private static function buildMsg(){
  91.         if(emptyempty(self::$content['method']) || !in_array(self::$content['method'],['wechat','alipush','mail','getui'])) {
  92.             return false;
  93.         }
  94.         switch (self::$content['method']){
  95.             case "wechat":
  96.                 self::$_send = ['touser'=>self::$content['openid'],'template_id'=>self::getTemplateId("wechat",self::$content['scene']),'url'=>"",'data'=>self::$content['content']];
  97.                 break;
  98.             case "alipush":
  99.                 self::$_send = [
  100.                     'Action'=>"Push",
  101.                     'RegionId' => "cn-hangzhou",
  102.                     'Version'=>"2016-08-01",
  103.                     'AppKey' => self::$content['app_key'],//创建的应用
  104.                     'PushType' => "NOTICE",
  105.                     'DeviceType' => "ALL",
  106.                     'Target' => "DEVICE",
  107.                     'TargetValue' => self::$content['device_id'],
  108.                     'Body' => self::$content['content'],
  109.                     'Title' => self::$content['title'],
  110.                     'JobKey' => self::$content['job_key'],  //如果需要后台记录推送消息状态
  111.                     'StoreOffline' => "true",
  112.                 ];
  113.                 break;
  114.             case "all":
  115.                 self::$_send['wechat'] = ['touser'=>self::$content['openid'],'template_id'=>self::getTemplateId("wechat",self::$content['scene']),'url'=>"",'data'=>self::$content['content']];
  116.                 self::$_send['alipush'] = [
  117.                     'Action'=>"Push",
  118.                     'RegionId' => "cn-hangzhou",
  119.                     'Version'=>"2016-08-01",
  120.                     'AppKey' => self::$content['app_key'],//创建的应用
  121.                     'PushType' => "NOTICE",
  122.                     'DeviceType' => "ALL",
  123.                     'Target' => "DEVICE",
  124.                     'TargetValue' => self::$content['device_id'],
  125.                     'Body' => self::$content['content'],
  126.                     'Title' => self::$content['title'],
  127.                     'JobKey' => self::$content['job_key'],  //如果需要后台记录推送消息状态
  128.                     'StoreOffline' => "true",
  129.                 ];
  130.                 break;
  131.             default:
  132.                 self::$_send = [];
  133.                 break;
  134.         }
  135.         return true;
  136.         //return self::$_send;
  137.     }
  139.     /**获取消息模板ID
  140.      * @param $chanel string 推送通道
  141.      * @param $scene string 消息场景
  142.      */
  143.     private static function getTemplateId($chanel,$scene){
  144.         //alarm:设备报警；remind：任务提醒；
  145.         $temp_wechat = ['register'=>"kFuKXjJlSWWeLj1MQelT7E0BRIf3H1gDBfm-5yF9Q30",'auth'=>"3jCOuTcVyfyb7bOJSm6HCO8kZaRdA8lnS0MQ_54QpEE","repass"=>"VOgt3a1SEKAeB8yN8f-hIFSRwMRM6W-TqvLPPTRLoMk","alarm"=>"hH7MhPQn5Bg3Kkc1DT4bMiqU38PrBryYTKUKyDjtlYU","remind"=>"Wm9TlfstyPMfqqmXiw0bOR-Mrw4qk8IKD6zlCBGKbhU"];
  146.         $temp_alipush = ['register'=>"",'auth'=>"","repass"=>"","alarm"=>"","remind"=>""];
  147.         $temp_getui = ['register'=>"",'auth'=>"","repass"=>"","alarm"=>"","remind"=>""];
  148.         return ${"temp_".$chanel}[$scene];
  149.     }
  151.     /** 阿里云签名
  152.      * @param array $parameters 请求参数
  153.      * @param string $accessKeySecret 接入密钥
  154.      * @return string
  155.      */
  156.     private static function getSignature($parameters, $accessKeySecret){
  157.         ksort($parameters);
  158.         $canonicalizedQueryString = '';
  159.         foreach($parameters as $key => $value) {
  160.             $canonicalizedQueryString .= '&' . self::percentEncode($key)
  161.                 . '=' . self::percentEncode($value);
  162.         }
  163.         // 生成用于计算签名的字符串 stringToSign
  164.         $stringToSign = 'GET&%2F&' . self::percentencode(substr($canonicalizedQueryString, 1));
  165.         // 计算签名，注意accessKeySecret后面要加上字符'&'
  166.         $signature = base64_encode(hash_hmac('sha1', $stringToSign, $accessKeySecret . '&', true));
  167.         return $signature;
  168.     }
  170.     /** percent加密
  171.      * @param $str
  172.      * @return string|null
  173.      */
  174.     private static function percentEncode($str){
  175.         // 使用urlencode编码后，将"+","*","%7E"做替换即满足ECS API规定的编码规范
  176.         $res = urlencode($str);
  177.         $res = preg_replace('/\+/', '%20', $res);
  178.         $res = preg_replace('/\*/', '%2A', $res);
  179.         $res = preg_replace('/%7E/', '~', $res);
  180.         return $res;
  181.     }
  183.     /** 数据验证
  184.      * @param array $arr 待验证数据
  185.      */
  186.     private static function verify($arr){
  187.         //验证的规则--备忘用
  188.         $rule = ['touser'=>"integer",'method'=>"in.all|alipush|wechat|mail|getui",'msg_type'=>"alpha",
  189.             'content'=>"require",'title'=>"require",'openid'=>"wechat.require",'device_id'=>"alipush.require",'app_key'=>"alipush.require",
  190.             'push_type'=>"alipush.MESSAGE|NOTICE"];
  191.         if(emptyempty($arr['touser']) || !is_numeric($arr['touser'])){return ['code'=>400197,'msg'=>"touser参数错误"];}
  192.         if(emptyempty($arr['method']) || !in_array($arr['method'],['all','alipush','wechat','mail','getui'])){return ['code'=>400201,'msg'=>"method参数错误"];}
  193.         if(emptyempty($arr['scene']) || !in_array($arr['scene'],["register","auth","repass","alarm","remind"])){return ['code'=>400202,'msg'=>"scene参数错误"];}
  194.         if(emptyempty($arr['content']) || !is_array($arr['content'])){return ['code'=>400203,'msg'=>"content参数错误"];}
  195.         if(emptyempty($arr['title']) || !is_string($arr['title'])){return ['code'=>400204,'msg'=>"title参数错误"];}
  196.         //String类型没有判断，开发时注意传入正确参数
  197.         if(in_array($arr['method'],['all','wechat']) && emptyempty($arr['openid'])){return ['code'=>400206,'msg'=>"openid参数错误"];}
  198.         if(in_array($arr['method'],['all','alipush']) && emptyempty($arr['device_id'])){return ['code'=>400207,'msg'=>"device_id参数错误"];}
  199.         if(in_array($arr['method'],['all','alipush']) && emptyempty($arr['app_key'])){return ['code'=>400208,'msg'=>"app_key参数错误"];}
  200.         if(in_array($arr['method'],['all','alipush']) && emptyempty($arr['push_type'])){return ['code'=>400209,'msg'=>"push_type为空"];}
  201.         if(in_array($arr['method'],['all','alipush']) && !in_array($arr['push_type'],['MESSAGE','NOTICE'])){return ['code'=>400210,'msg'=>"push_type参数错误"];}
  203.         return ['code'=>200,'msg'=>"参数校验成功"];
  204.     }
  206. }

上述源码仅测试了微信模板消息。阿里移动推送虽然集成了，但是并未进行测试。个推、邮件、短信是尚未开发的部分。

上述源码支持在波波thinkPHP开发的后端框架TP-admin中直接使用，也支持zoujingli的项目ThinkAdmin。

 

你想把广告放到这里吗？

发表评论

您必须 登录 才能发表留言！