在thinkphp框架里封装百度云推送的一个尝试

百度云推送，地址：http://push.baidu.com/，优点挺多，大平台，稳定灵活，安全，免费，应用广。

最近的公司项目需要后端给移动端发送通知，第一次接触这种需求，同事推荐我了解下个推，后来又推荐了百度云，比较起来选择了百度云。

于是在官方SDK中心下载了 php服务端SDK，地址：http://push.baidu.com/sdk/push_server_sdk_for_php。

起初看着SDK一头雾水，结构比较复杂，后来发现最终程序使用了通用的curl请求方式，想想推送模块可以单独一块，也可以封装。

因为项目使用的thinkphp框架，在基本熟悉SDK后，有了把几个类型接口封装到框架一个模型里的想法。

 模型代码如下:

class BdPushModel extends Model {
    const TAG_TYPE_LBS_LABEL = 2;       // LBS 推送
    const TAG_TYPE_INTEREST_LABEL = 3;  // 兴趣组
    const TAG_TYPE_AGE_LABEL = 4;       // 年龄组
    const TAG_TYPE_SEX_LABEL = 5;       // 性别组
    const TAG_TYPE_OP_LABEL = 6;        // 组合运算


    public $apikey     = "Vek7uG4nhplvh3cpg2H5Ut50";//测试用
    public $secret_key = "NdxoxNykVrH6qA3CV33kzK7lsSTTvZA9";//测试用
    public $restHostUrl = 'http://api.tuisong.baidu.com/rest/3.0/';
    /*$timestamp : 用户发起请求时的unix时间戳。本次请求签名的有效时间为该时间戳+10分钟。*/
    public $timestamp  = '';
    public function _initialize(){
        $this->timestamp = NOW_TIME + 600;//初始化用户发起请求时的unix时间戳
    }
     /**
     * 单播, 推送一条消息到指定设备
     * $channel_id 目标客户端设备所属的唯一id;
     * $msg 消息内容.可参见<u>消息体格式说明</u> 当消息体类型为一个array时,将自动调用json_encode方法来将array转换为一个string;
     * $opts 可选参数列表, 包含 msg_type, msg_expires, deploy_status, msg_topic几项可选内容;
     *
     */
    public  function pushMsgToSingleDevice($channel_id,$device_type,$messages){
        if(empty($channel_id))
            return array('error_code'=>C('RES_PARAM_ERR'),'error_msg'=>'');
        $api     = 'push/single_device';//API的资源操作方法名
        $msg_type  = 1;//取值如下：0：消息；1：通知。默认为0
        $url = $this->restHostUrl.$api;
        $arrContent = array(
            'apikey'     => $this->apikey,
            'timestamp'  => NOW_TIME,
            'device_type'  => $device_type,//3：android；4：ios
            'channel_id'  => $channel_id,
            'msg'   => $messages,
            'msg_type'  => $msg_type
        );
        $sign  = $this->getSign('POST',$url,$arrContent);
        $arrContent['sign'] = $sign;
        $return = $this->curlPost($arrContent,$url);
        $rs = $this->object_array(json_decode($return));
        if($rs['error_code']>0){
            return false;
        }
        return true;
    }   

    /**
     * 批量单播, 向指定的一组channel_id发送一条消息.
     * $channel_ids; 一个数组, 每项为一个channel_id
     * $msg 消息内容.可参见<u>消息体格式说明</u> 当消息体类型为一个array时,将自动调用json_encode方法来将array转换为一个string;
     *  $opts 可选参数, 包含
     */
    public function pushBatchUniMsg($channel_ids,$messages,$device_type){
        if(empty($channel_ids))
            return array('error_code'=>C('RES_PARAM_ERR'),'error_msg'=>'');
        $api     = 'push/batch_device';//API的资源操作方法名
        $msg_type  = 1;//取值如下：0：消息；1：通知。默认为0
        $url = $this->restHostUrl.$api;
        $arrContent = array(
            'apikey'     => $this->apikey,
            'timestamp'  => NOW_TIME,
            'device_type'  => $device_type,//3：android；4：ios
            'channel_ids'  => $channel_ids,
            'msg'   => $messages,
            'msg_type'  => $msg_type
        );
        $sign  = $this->getSign('POST',$url,$arrContent);
        $arrContent['sign'] = $sign;
        $return = $this->curlPost($arrContent,$url);
        if($return['error_code']>0){
            return false;
        }
        return true;
    }
    /**
 *@var      curl模拟post提交数据
 *@param    $data          提交的所有参数
 *@param    $url           请求的地址
 *@return   json           百度页面返回的结果
 */
function curlPost($data,$url){
    $data = $this->encodePostBody($data);
    $port = parse_url($url, PHP_URL_PORT);
    $header = array(
        'Content-Type: application/x-www-form-urlencoded;charset=utf-8',
        'User-Agent: '. $this->makeUA()
    );
    $ch = curl_init ();
    curl_setopt ( $ch, CURLOPT_URL, $url );
    curl_setopt ( $ch, CURLOPT_PORT, empty($port)?80:$port );
    curl_setopt ($ch, CURLOPT_HTTPHEADER, $header);
    curl_setopt ( $ch, CURLOPT_POST, 1 );
//    curl_setopt ( $ch, CURLOPT_HEADER, 0 );
//    curl_setopt ( $ch, CURLOPT_SSL_VERIFYPEER, false );
    curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, 1 );
    curl_setopt ( $ch, CURLOPT_POSTFIELDS, $data );
    $return = curl_exec ( $ch );
    curl_close ( $ch );
    return $return;
}

function encodePostBody($body) {
    if ($body === null) {
        return '';
    }

    if (! is_array($body)) {
        return urlencode(strval($body));
    }

    $result = array ();
    foreach ( $body as $k => $v ) {
        $result [ ] = urlencode($k) . '=' . urlencode($v);
    }

    return join('&', $result);
}


function makeUA(){
    $sdkVersion = '3.0.0';//百度推送版本
    $sysName = php_uname('s');
    $sysVersion = php_uname('v');
    $machineName = php_uname('m');

    $systemInfo = "$sysName; $sysVersion; $machineName";

    $langName = 'PHP';
    $langVersion = phpversion();

    $serverName = php_sapi_name();
    $serverVersion = "Unknown";

    $sendInfo = 'ZEND/' . zend_version();

    $serverInfo = "$serverName/$serverVersion";

    if(isset($_SERVER['SERVER_SOFTWARE'])){
        $serverInfo .= '(' . $_SERVER['SERVER_SOFTWARE'] . ')';
    }


    $tpl = "BCCS_SDK/3.0 ($systemInfo) $langName/$langVersion (Baidu Push SDK for PHP v$sdkVersion) $serverInfo $sendInfo";

    return $tpl;
}
//object转数组
function object_array($array){
    if(is_object($array)){
        $array = (array)$array;
    }
    if(is_array($array)){
        foreach($array as $key=>$value){
            $array[$key] = object_array($value);
        }
    }
    return $array;
}
/**
     * 计算请求迁名
     *
     * @param string $method
     *        GET|POST
     * @param string $url
     *        请求的完整url, 不含query部份
     * @param array $arrContent
     *        提交的数据项,包含get及post,但不包含签名项
     * @return string
     */
    function getSign($method, $url, $arrContent) {
        $secret_key = $this->secret_key;
        $baseStr = strtoupper($method) . $url;
        ksort($arrContent);
        foreach ( $arrContent as $key => $value ) {
            $baseStr .= $key . '=' . $value;
        }
        $sign = md5(urlencode($baseStr . $secret_key));

        return $sign;
    }

}

限于篇幅，这里只写单播和批量单播这个例子

控制器调用代码：

class IndexController extends Controller {
    public function index(){
        $channelId = '3785562685113372034';//测试用
        $title = 'Hi!';
        $description = 'hello, this message from baidu push service.';
        $push = new BdPushModel('user_member');
        $messages = json_encode(array('title'=>$title,'description'=>$description));
        $device_type = 3;//3:android,4:ios
        $rs = $push->pushMsgToSingleDevice($channelId,$device_type,$messages);
        // 判断返回值,当发送失败时,  , 可以通过getError来获得错误信息.
        if(!$rs){
           $this->ajaxReturn(false, "JSON");
           exit();
        }
        $this->ajaxReturn(true, "JSON");
        exit();
    }
}