update push docs

This commit is contained in:
heavyrian2012
2022-09-23 21:48:01 +08:00
parent e6714d9e44
commit 53b8fa4b65
2 changed files with 39 additions and 17 deletions

47
push.md
View File

@@ -4,13 +4,13 @@
3. 配置和部署推送服务(push-server)
4. IM-Server 配置
5. 推送测试
6. 问题排查
7. 常见问题
6. 调试推送服务
7. 问题排查
### 申请厂商推送服务
### 一,申请厂商推送服务
目前支持小米、华为、vivo、oppo、魅族、苹果等推送需要到各个厂商的开发者后台申请推送相关 key
### 移动端配置
### 二,移动端配置
#### Android 端配置
Android端推送相关的代码都在```push module``` 下面,入口是```PushService```,配置之后,如果能调用```ChatManager#setDeviceToken```,则表示配置成,下面是具体的配置
@@ -36,16 +36,19 @@ Android端推送相关的代码都在```push module``` 下面,入口是`
```
2. 华为推送需要```chat/agconnect-services.json```文件,该文件是华为推送后台生成的
3. FCM推送需要替换```push/google-services.json```文件,该文件是 FCM 推送后台生成的
4. 如果一切正常,启动 App 之后,会打印一行日志,**如果没有打印该日志,则说明配置错误,请查看日志,或者在```PushService```打断点调试**
4. 如果一切正常,启动 App 之后,会打印下面这一行日志,**如果没有打印该日志,则说明配置错误,请查看日志,或者在```PushService```打断点调试**
```
Log.d(TAG, "setDeviceToken" + token + " " + pushType);// 这是打印日志的代码!!
```
```Log.d(TAG, "setDeviceToken" + token + " " + pushType);// 这是打印日志的代码!! ```
5. 如果不需要某些推送类型,可以将其从```push module```删除,保留也不影响
6. 如果需要使用个推,请看```getui```分支
#### iOS 端配置
todo
请参考[ios-chat](https://github.com/wildfirechat/ios-chat)项目```appdelegate.m```文件中的关于推送注册的部分。当调用到```setDeviceToken```方法传入推送token即为客户端接入成功。
### 配置和部署推送服务
### 三,配置和部署推送服务
1. 修改配置
本推送服务有1个工程配置文件和7个推送配置文件都在工程的```config```目录下,请根据实际情况配置服务的端口和各个推送服务配置,推送服务配置一定要和移动端对应上,别配置成不同的 app 去了。
@@ -67,7 +70,7 @@ todo
nohup java -jar push-xxxx.jar 2>&1 &
```
### IM-Server 配置
### 四,IM-Server 配置
修改IM服务的配置文件```wildfirechat.conf```,指向推送服务器的地址,修改完后需要重启
```
#*********************************************************************
@@ -79,7 +82,7 @@ push.android.server.address http://localhost:8085/android/push
push.ios.server.address http://localhost:8085/ios/push
```
### 推送测试
### 五,推送测试
1. 确保双方都在线时,能互发消息
2. Android端为了保证用户能正常收到消息需要进行一些相关设置产品上线之后也需要引导用户进行相关设置不设置会收到不到推送具体设置方式不同手机不一样请参考具体的手机设置也可以参考[这儿](https://docs.rongcloud.cn/im/push/android/message_notification/)
1. 允许后台运行
@@ -89,7 +92,10 @@ push.ios.server.address http://localhost:8085/ios/push
3. 将其中一方杀进程,另外一方向其发送文本消息
4. 查看被杀进程一方,是否收到推送
### 问题排查
### 六,调试推送服务
推送厂商SDK可能随时更新接口也有可能由变更推送服务和客户端推送SDK可能需要更新和调整。也有可能推送厂商开发后台配置错误导致无法推送成功。出现这种情况后请按照对应厂商的最新说明调试推送服务。推送服务收到IM服务推送请求后调用厂商SDK进行推送这部分工作与野火IM无关了请仔细阅读推送厂商的文档或者与联系推送厂商的技术支持。
### 七,问题排查
如果遇到问题请按照以下步骤排查:
1. 请确保上面所有步骤都正确完成之后,再开始问题排查
2. 确保程序是非启动状态,如果退回到桌面,应用还是激活的还会继续收消息,此时就不会走推送服务。应用在后台激活状态时应该走本地通知。
@@ -104,14 +110,23 @@ push.ios.server.address http://localhost:8085/ios/push
```
9. 确认推送服务是否收到了推送信息如果收到token和type是否和步骤1一致推送内容是否和2一致
```
// 对方是 Android
// 目标用户是 Android
LOG.info("Android push {}", new Gson().toJson(pushMessage)); // 这是打印日志的代码
// 对方是 iOS
// 目标用户是 iOS
LOG.info("iOS push {}", new Gson().toJson(pushMessage)); // 这是打印日志的代码
```
10. 如果推送内容正确到达推送服务则后面的排查就跟IM服务完全无关了是推送厂商推送服务的调试需要客户自己按照推送厂商的官方文档进行调试
10. 推送服务收到IM请求的推送信息调用厂商SDK进行推送检查代码确认是透传方式还是通知栏方式
11. 如果推送服务使用的是通知栏方式,后面的工作就全是推送厂商的工作了,请按照推送厂商的官方文档进行调试。
12. 如果推送服务使用的是透传方式请确认客户端对应推送SDK是否收到透传消息如果没有收到透传消息则问题出在推送通道上请按照推送厂商的官方文档进行调试。
13. 如果推送服务使用的是透传方式确认对应推送SDK收到了透传消息请检查应用激活后是否初始化IM SDK并调用connect方法及连接状态是否连接成功是否收到新消息是否弹出本地通知。
### 常见问题
TODO
### 技术支持
按照文档一般情况下都能成功处理推送功能。实际上推送的功能并不复杂,只是涉及到太多的环节,每个环节又是由不同的研发或者公司来负责。请一定要理解整个推送的过程,知道推送过程中每一环节的功能,每个环节由谁来负责或者检查,只有真正的理解了推送的完整流程,才能找到对应的人来处理,才有可能高效地处理推送问题。
当确认是野火负责的环节时可以来给野火提issue或者论坛发帖问。提问时请写清楚下面几个要求
1. 请写出推送的完整流程。
2. 请写出推送的每个环节是那一方来负责比如android端注册推送并调用setDeviceToken由你们android研发来负责。
3. 你认为那个环节出了问题,并给出证据。因为我们没有服务和客户端的任何信息,所以请务必给出全面详细的信息。
4. 上面问题排查中每一步的结果。
只有了解推送的流程和每个环节的功能才能高效地沟通,所以只有写清楚上面四条信息我们才能够提供技术支持。