Discuz iOS應用開發 (BigApp 插件源碼分析 - JPush推送最初的設計)

Discuz的BigApp插件使用JPush來進行推送,但原先的設計,和JPush服務器真正通信的服務器是在游族的,并不在BigApp插件本身。所以BigApp插件源碼里并沒有JPush Php SDK的集成。這也是為什么插件里面有著大量的http://app.youzu.com/ 的配置URL以及需要去游族申請APP ID進行所謂的站長認證功能。

鑒于游族已經不再提供服務器,所以這部分的代碼我們需要集成到BigApp插件本身來實現。

關于推送,在服務器端,我們需要考慮的是,當發送消息,添加好友時,對方得到相應的推送。在代碼中,最終可以發現兩組類似的實現

  1. 第一組
  • bigapp/models/push/JpushClient.php
  • bigapp/pushmessage.inc.php
  • bigapp/pushaccount.inc.php
  • bigapp/pushmsg.inc.php
  1. 第二組
  • bigapp/libs/pushmsg.inc.php
  • bigapp/api/1/addfriend.php
  • bigapp/api/1/sendreply.php
  • bigapp/api/1/sendpm.php

可能理解不深刻,不太清楚為什么會有這兩組實現,而且其中有一個文件名還是一樣的,但是放置的目錄不同且代碼類似但又不通。

最后調試發現,網頁上發送消息時,最終會調用第二組的pushmsg.inc.php的sendMessage函數。

    public static function sendMessage($uid, $title, $content, $msgType, $extra = null, $mask = 3, $jpushAk = null, $jpushSk = null)
        global $_G;
        $tmp = Utils::readLocalAkSk2();
        if(!isset($tmp['app_key']) || !isset($tmp['app_secret'])){
            return false;
        }
        $ak = $tmp['app_key'];
        $sk = $tmp['app_secret'];
        $appInfo = self::getAppInfo($ak, $sk);
        /*
        if(!isset($appInfo['app_id'])){
            return false;
        }
        */
        $appId = $appInfo['app_id'];
        $alias = sprintf('%020lu', $uid);
        $params = array(
                'alias' => $alias,
                'mask' => $mask,
                'message_type' => $msgType,
                'title' => $title, 
                'content' => $content,
                );
        if(is_array($extra)){
            $params['extra'] = BIGAPPJSON::encode($extra);
        }
        if(!is_null($jpushAk) && !is_null($jpushSk)){
            $params['jpush_app_key'] = $jpushAk;
            $params['jpush_master_secret'] = $jpushSk;
        }
        $url = BigAppConf::$pushUrl;
        $obj = new BkSvr($ak, $sk, 30);
        $ret = $obj->getInfo($url, $params, false, false);
        if(!is_array($ret)){
            runlog('bigapp', 'send message failed, invalid return [ ret: ' . $ret . ' ]');
            return false;
        }
        if(0 != $ret['error_code']){
            runlog('bigapp', 'send message failed, error code is not 0 [ ret: ' . BIGAPPJSON::encode($ret) . ' ]');
            return $ret;
        }
        return true;
    }

目前看到的是,當加好友,發送消息以及回復消息,都會調用這個函數。函數的參數可以看到有我們需要的uid(相當于JPush的alias), 以及發送的內容,類型。

代碼里有大量的關于站長認證用的App ID和APP Secret的檢查,但并沒有真正的JPush發送的代碼。

新的設計是,在這個函數里添加自己的JPush發送的代碼。

集成JPush的demo

sendMessage($uid, $title, $content, $msgType, $extra = null, $mask = 3, $jpushAk = null, $jpushSk = null)
    {
        require __DIR__ . '/../autoload.php';
        $client = new \JPush\Client('56acc62e21172eafa0c54091', '8b5f02d9e80f4c7b46b878e3');
        $push_payload = $client->push()
            ->setPlatform('all')
            ->addAllAudience()
            ->options(array(
                'apns_production' => true
            ))
            ->setNotificationAlert('收到請微信我');
        try {
            $response = $push_payload->send();
            print_r($response);
        } catch (\JPush\Exceptions\APIConnectionException $e) {
            // try something here
            print $e;
        } catch (\JPush\Exceptions\APIRequestException $e) {
            // try something here
            print $e;
        }

        try {
            $response = $client->push()
                ->setPlatform(array('ios', 'android'))
                // 一般情況下,關于 audience 的設置只需要調用 addAlias、addTag、addTagAnd  或 addRegistrationId
                // 這四個方法中的某一個即可,這里僅作為示例,當然全部調用也可以,多項 audience 調用表示其結果的交集
                // 即是說一般情況下,下面三個方法和沒有列出的 addTagAnd 一共四個,只適用一個便可滿足大多數的場景需求

                // ->addAlias('alias')
                ->addTag(array('tag1', 'tag2'))
                // ->addRegistrationId($registration_id)

                ->setNotificationAlert('Hi, JPush')
                ->iosNotification('Hello IOS', array(
                    'sound' => 'sound.caf',
                    // 'badge' => '+1',
                    // 'content-available' => true,
                    // 'mutable-content' => true,
                    'category' => 'jiguang',
                    'extras' => array(
                        'key' => 'value',
                        'jiguang'
                    ),
                ))
                ->androidNotification('Hello Android', array(
                    'title' => 'hello jpush',
                    // 'builder_id' => 2,
                    'extras' => array(
                        'key' => 'value',
                        'jiguang'
                    ),
                ))
                ->message('message content', array(
                    'title' => 'hello jpush',
                    // 'content_type' => 'text',
                    'extras' => array(
                        'key' => 'value',
                        'jiguang'
                    ),
                ))
                ->options(array(
                    // sendno: 表示推送序號,純粹用來作為 API 調用標識,
                    // API 返回時被原樣返回,以方便 API 調用方匹配請求與返回
                    // 這里設置為 100 僅作為示例

                    // 'sendno' => 100,

                    // time_to_live: 表示離線消息保留時長(秒),
                    // 推送當前用戶不在線時,為該用戶保留多長時間的離線消息,以便其上線時再次推送。
                    // 默認 86400 (1 天),最長 10 天。設置為 0 表示不保留離線消息,只有推送當前在線的用戶可以收到
                    // 這里設置為 1 僅作為示例

                    // 'time_to_live' => 1,

                    // apns_production: 表示APNs是否生產環境,
                    // True 表示推送生產環境,False 表示要推送開發環境;如果不指定則默認為推送生產環境

                    'apns_production' => false,

                    // big_push_duration: 表示定速推送時長(分鐘),又名緩慢推送,把原本盡可能快的推送速度,降低下來,
                    // 給定的 n 分鐘內,均勻地向這次推送的目標用戶推送。最大值為1400.未設置則不是定速推送
                    // 這里設置為 1 僅作為示例

                    // 'big_push_duration' => 1
                ))
                ->send();
            print_r($response);

        } catch (\JPush\Exceptions\APIConnectionException $e) {
            // try something here
            print $e;
        } catch (\JPush\Exceptions\APIRequestException $e) {
            // try something here
            print $e;
        }

先測試把Demo集成進來,注意BigApp插件源碼里有很多手機檢測

if (!defined('IN_MOBILE_API')) {
    exit('Access Denied');
}

在測試時,先把這些代碼注釋掉。

還有,注意JPush SDK的autoload.php中定義的classLoader使用了spl_autoload_register,和Discuz的class_core.php定義的autoload沖突,因此需要把autoload文件中的discuz_error::exception_error($exc);刪除。

暫時不清楚這些改動的負面作用。

最終的測試結果是,當通過論壇網頁,A用戶向B用戶發送消息是,手機端確實能收到一條消息推送(ALL User)的推送測試。證明修改的地方和方案是可行的。

接下來就是定向推送的事情了,這需要服務器和客戶端針對alias進行定制。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容