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
  2. 第二组

    • bigapp/libs/pushmsg.inc.php
    • bigapp/api/1/addfriend.php
    • bigapp/api/1/sendreply.php
    • bigapp/api/1/sendpm.php

可能理解不深刻,不太清楚为什么会有这两组实现,而且其中有一个文件名还是一样的,但是放置的目录不同且代码类似但又不通。

最后调试发现,网页上发送消息时,最终会调用第二组的pushmsg.inc.php的sendMessage函数。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
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插件源码里有很多手机检测

1
2
3
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进行定制。