update push docs

README.md

@@ -2,7 +2,7 @@
 作为野火IM的推送服务的演示，支持小米、华为、魅族、OPPO、Vivo、苹果apns和谷歌FCM。并且可以添加更多的推送厂商和自定义推送模式。
 
 ## 工作原理
-推送功能对于所有IM来说都是非常重要的功能，然而android系统又没有统一的推送服务，对接起来难度很大。另外一方面客户有不同对接需求，有的要求使用第三方，有的要求使用厂商推送，有的需要在海外添加谷歌推送，有的对推送的格式有不同的要求。
+推送功能对于所有IM来说都是非常重要的功能，然而手机系统又没有统一的推送服务，对接起来难度很大。另外一方面客户有不同对接需求，有的要求使用第三方，有的要求使用厂商推送，有的需要在海外添加谷歌推送，有的对推送的格式有不同的要求。
 
 为了满足各种各样的需求，提供足够好的灵活性，野火IM把推送子系统独立出来，客户只要理解了推送子系统运行的原理，就能做好各种自定义处理。
 ![架构图](https://docs.wildfirechat.cn/architecture/wildfire_architecture.png)
@@ -13,7 +13,14 @@
 2. SDK被调用setDeviceToken后，会把推送token和类型传入到IM服务，IM服务为对应手机保存下来以备后用。事实上IM服务不需要理解token和type的含义，只需要透传给推送服务即可。
 3. IM服务处理消息时发现用户不在线或者下发消息失败，则会启动是否要推送的决策，比如消息是否需要推送（预制消息已经支持，自定义消息需要传入push content），用户是否全局静音，会话是否被静音，客户有多少天没有登录（超过7天没登录就不推送）。达到推送条件后，跟把所有推送需要的内容打包发给推送服务。
 4. 推送服务接收到IM服务的请求，把推送数据放到消费队列中并立即返回（IM服务不能被阻塞），然后逐步处理推送事件。每个推送事件中都包含了所有需要处理的数据，其中包括1步骤中的推送Token和类型，然后根据类型来调用对用推送厂商的服务，比如华为/小米/苹果/第三方厂商/谷歌/OPPO/Vivo等，调用他们的SDK进行推送。
+5. 系统厂商或第三方推送厂商利用他们的通道推送到客户端，一般有2种形式：一种是通知栏，不激活应用只弹出通知栏；另外一种形式是透传，把应用激活并把数据传递到客户端的推送相关代码种，应用激活后有一段活跃时间，在这个活跃时间连接IM服务，接收下来消息，并弹出本地通知。
 
+## 通知类型
+一般情况下有2种推送，一种是本地通知，另外一种是远程推送。
+1. 本地通知：指应用在后台处于激活状态，当有此用户的新消息时，消息会被收下来，然后本地弹出通知。
+2. 远程推送：指应用处于冻结或者杀死状态，当有此用户的新消息时，消息无法被收下来，需要借助推送服务通知到用户。
+
+本地通知和远程推送在手机上的表现很接近，都是应用放到后台，然后有人给此账号发送消息，通知栏弹出通知。实际上处理流程完全不同。本项目处理的是远程推送。***在处理通知问题时，首先要确认的是本地通知还是远程推送***。
 
 ## 接入推送
 接入推送并不是简单得将推送服务跑起来即可，请详细阅读[接入推送流程](./push.md)

push.md

@@ -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. 上面问题排查中每一步的结果。
 
+只有了解推送的流程和每个环节的功能才能高效地沟通，所以只有写清楚上面四条信息我们才能够提供技术支持。