| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305 |
- <!DOCTYPE html><html><head>
- <title>集成说明</title>
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
- <link rel="stylesheet" href="file:////Users/Zhuanz/.cursor/extensions/shd101wyy.markdown-preview-enhanced-0.8.20-universal/crossnote/dependencies/katex/katex.min.css">
-
-
-
-
-
- <style>
- code[class*=language-],pre[class*=language-]{color:#333;background:0 0;font-family:Consolas,"Liberation Mono",Menlo,Courier,monospace;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.4;-moz-tab-size:8;-o-tab-size:8;tab-size:8;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none}pre[class*=language-]{padding:.8em;overflow:auto;border-radius:3px;background:#f5f5f5}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal;background:#f5f5f5}.token.blockquote,.token.comment{color:#969896}.token.cdata{color:#183691}.token.doctype,.token.macro.property,.token.punctuation,.token.variable{color:#333}.token.builtin,.token.important,.token.keyword,.token.operator,.token.rule{color:#a71d5d}.token.attr-value,.token.regex,.token.string,.token.url{color:#183691}.token.atrule,.token.boolean,.token.code,.token.command,.token.constant,.token.entity,.token.number,.token.property,.token.symbol{color:#0086b3}.token.prolog,.token.selector,.token.tag{color:#63a35c}.token.attr-name,.token.class,.token.class-name,.token.function,.token.id,.token.namespace,.token.pseudo-class,.token.pseudo-element,.token.url-reference .token.variable{color:#795da3}.token.entity{cursor:help}.token.title,.token.title .token.punctuation{font-weight:700;color:#1d3e81}.token.list{color:#ed6a43}.token.inserted{background-color:#eaffea;color:#55a532}.token.deleted{background-color:#ffecec;color:#bd2c00}.token.bold{font-weight:700}.token.italic{font-style:italic}.language-json .token.property{color:#183691}.language-markup .token.tag .token.punctuation{color:#333}.language-css .token.function,code.language-css{color:#0086b3}.language-yaml .token.atrule{color:#63a35c}code.language-yaml{color:#183691}.language-ruby .token.function{color:#333}.language-markdown .token.url{color:#795da3}.language-makefile .token.symbol{color:#795da3}.language-makefile .token.variable{color:#183691}.language-makefile .token.builtin{color:#0086b3}.language-bash .token.keyword{color:#0086b3}pre[data-line]{position:relative;padding:1em 0 1em 3em}pre[data-line] .line-highlight-wrapper{position:absolute;top:0;left:0;background-color:transparent;display:block;width:100%}pre[data-line] .line-highlight{position:absolute;left:0;right:0;padding:inherit 0;margin-top:1em;background:hsla(24,20%,50%,.08);background:linear-gradient(to right,hsla(24,20%,50%,.1) 70%,hsla(24,20%,50%,0));pointer-events:none;line-height:inherit;white-space:pre}pre[data-line] .line-highlight:before,pre[data-line] .line-highlight[data-end]:after{content:attr(data-start);position:absolute;top:.4em;left:.6em;min-width:1em;padding:0 .5em;background-color:hsla(24,20%,50%,.4);color:#f4f1ef;font:bold 65%/1.5 sans-serif;text-align:center;vertical-align:.3em;border-radius:999px;text-shadow:none;box-shadow:0 1px #fff}pre[data-line] .line-highlight[data-end]:after{content:attr(data-end);top:auto;bottom:.4em}html body{font-family:'Helvetica Neue',Helvetica,'Segoe UI',Arial,freesans,sans-serif;font-size:16px;line-height:1.6;color:#333;background-color:#fff;overflow:initial;box-sizing:border-box;word-wrap:break-word}html body>:first-child{margin-top:0}html body h1,html body h2,html body h3,html body h4,html body h5,html body h6{line-height:1.2;margin-top:1em;margin-bottom:16px;color:#000}html body h1{font-size:2.25em;font-weight:300;padding-bottom:.3em}html body h2{font-size:1.75em;font-weight:400;padding-bottom:.3em}html body h3{font-size:1.5em;font-weight:500}html body h4{font-size:1.25em;font-weight:600}html body h5{font-size:1.1em;font-weight:600}html body h6{font-size:1em;font-weight:600}html body h1,html body h2,html body h3,html body h4,html body h5{font-weight:600}html body h5{font-size:1em}html body h6{color:#5c5c5c}html body strong{color:#000}html body del{color:#5c5c5c}html body a:not([href]){color:inherit;text-decoration:none}html body a{color:#08c;text-decoration:none}html body a:hover{color:#00a3f5;text-decoration:none}html body img{max-width:100%}html body>p{margin-top:0;margin-bottom:16px;word-wrap:break-word}html body>ol,html body>ul{margin-bottom:16px}html body ol,html body ul{padding-left:2em}html body ol.no-list,html body ul.no-list{padding:0;list-style-type:none}html body ol ol,html body ol ul,html body ul ol,html body ul ul{margin-top:0;margin-bottom:0}html body li{margin-bottom:0}html body li.task-list-item{list-style:none}html body li>p{margin-top:0;margin-bottom:0}html body .task-list-item-checkbox{margin:0 .2em .25em -1.8em;vertical-align:middle}html body .task-list-item-checkbox:hover{cursor:pointer}html body blockquote{margin:16px 0;font-size:inherit;padding:0 15px;color:#5c5c5c;background-color:#f0f0f0;border-left:4px solid #d6d6d6}html body blockquote>:first-child{margin-top:0}html body blockquote>:last-child{margin-bottom:0}html body hr{height:4px;margin:32px 0;background-color:#d6d6d6;border:0 none}html body table{margin:10px 0 15px 0;border-collapse:collapse;border-spacing:0;display:block;width:100%;overflow:auto;word-break:normal;word-break:keep-all}html body table th{font-weight:700;color:#000}html body table td,html body table th{border:1px solid #d6d6d6;padding:6px 13px}html body dl{padding:0}html body dl dt{padding:0;margin-top:16px;font-size:1em;font-style:italic;font-weight:700}html body dl dd{padding:0 16px;margin-bottom:16px}html body code{font-family:Menlo,Monaco,Consolas,'Courier New',monospace;font-size:.85em;color:#000;background-color:#f0f0f0;border-radius:3px;padding:.2em 0}html body code::after,html body code::before{letter-spacing:-.2em;content:'\00a0'}html body pre>code{padding:0;margin:0;word-break:normal;white-space:pre;background:0 0;border:0}html body .highlight{margin-bottom:16px}html body .highlight pre,html body pre{padding:1em;overflow:auto;line-height:1.45;border:#d6d6d6;border-radius:3px}html body .highlight pre{margin-bottom:0;word-break:normal}html body pre code,html body pre tt{display:inline;max-width:initial;padding:0;margin:0;overflow:initial;line-height:inherit;word-wrap:normal;background-color:transparent;border:0}html body pre code:after,html body pre code:before,html body pre tt:after,html body pre tt:before{content:normal}html body blockquote,html body dl,html body ol,html body p,html body pre,html body ul{margin-top:0;margin-bottom:16px}html body kbd{color:#000;border:1px solid #d6d6d6;border-bottom:2px solid #c7c7c7;padding:2px 4px;background-color:#f0f0f0;border-radius:3px}@media print{html body{background-color:#fff}html body h1,html body h2,html body h3,html body h4,html body h5,html body h6{color:#000;page-break-after:avoid}html body blockquote{color:#5c5c5c}html body pre{page-break-inside:avoid}html body table{display:table}html body img{display:block;max-width:100%;max-height:100%}html body code,html body pre{word-wrap:break-word;white-space:pre}}.markdown-preview{width:100%;height:100%;box-sizing:border-box}.markdown-preview ul{list-style:disc}.markdown-preview ul ul{list-style:circle}.markdown-preview ul ul ul{list-style:square}.markdown-preview ol{list-style:decimal}.markdown-preview ol ol,.markdown-preview ul ol{list-style-type:lower-roman}.markdown-preview ol ol ol,.markdown-preview ol ul ol,.markdown-preview ul ol ol,.markdown-preview ul ul ol{list-style-type:lower-alpha}.markdown-preview .newpage,.markdown-preview .pagebreak{page-break-before:always}.markdown-preview pre.line-numbers{position:relative;padding-left:3.8em;counter-reset:linenumber}.markdown-preview pre.line-numbers>code{position:relative}.markdown-preview pre.line-numbers .line-numbers-rows{position:absolute;pointer-events:none;top:1em;font-size:100%;left:0;width:3em;letter-spacing:-1px;border-right:1px solid #999;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.markdown-preview pre.line-numbers .line-numbers-rows>span{pointer-events:none;display:block;counter-increment:linenumber}.markdown-preview pre.line-numbers .line-numbers-rows>span:before{content:counter(linenumber);color:#999;display:block;padding-right:.8em;text-align:right}.markdown-preview .mathjax-exps .MathJax_Display{text-align:center!important}.markdown-preview:not([data-for=preview]) .code-chunk .code-chunk-btn-group{display:none}.markdown-preview:not([data-for=preview]) .code-chunk .status{display:none}.markdown-preview:not([data-for=preview]) .code-chunk .output-div{margin-bottom:16px}.markdown-preview .md-toc{padding:0}.markdown-preview .md-toc .md-toc-link-wrapper .md-toc-link{display:inline;padding:.25rem 0}.markdown-preview .md-toc .md-toc-link-wrapper .md-toc-link div,.markdown-preview .md-toc .md-toc-link-wrapper .md-toc-link p{display:inline}.markdown-preview .md-toc .md-toc-link-wrapper.highlighted .md-toc-link{font-weight:800}.scrollbar-style::-webkit-scrollbar{width:8px}.scrollbar-style::-webkit-scrollbar-track{border-radius:10px;background-color:transparent}.scrollbar-style::-webkit-scrollbar-thumb{border-radius:5px;background-color:rgba(150,150,150,.66);border:4px solid rgba(150,150,150,.66);background-clip:content-box}html body[for=html-export]:not([data-presentation-mode]){position:relative;width:100%;height:100%;top:0;left:0;margin:0;padding:0;overflow:auto}html body[for=html-export]:not([data-presentation-mode]) .markdown-preview{position:relative;top:0;min-height:100vh}@media screen and (min-width:914px){html body[for=html-export]:not([data-presentation-mode]) .markdown-preview{padding:2em calc(50% - 457px + 2em)}}@media screen and (max-width:914px){html body[for=html-export]:not([data-presentation-mode]) .markdown-preview{padding:2em}}@media screen and (max-width:450px){html body[for=html-export]:not([data-presentation-mode]) .markdown-preview{font-size:14px!important;padding:1em}}@media print{html body[for=html-export]:not([data-presentation-mode]) #sidebar-toc-btn{display:none}}html body[for=html-export]:not([data-presentation-mode]) #sidebar-toc-btn{position:fixed;bottom:8px;left:8px;font-size:28px;cursor:pointer;color:inherit;z-index:99;width:32px;text-align:center;opacity:.4}html body[for=html-export]:not([data-presentation-mode])[html-show-sidebar-toc] #sidebar-toc-btn{opacity:1}html body[for=html-export]:not([data-presentation-mode])[html-show-sidebar-toc] .md-sidebar-toc{position:fixed;top:0;left:0;width:300px;height:100%;padding:32px 0 48px 0;font-size:14px;box-shadow:0 0 4px rgba(150,150,150,.33);box-sizing:border-box;overflow:auto;background-color:inherit}html body[for=html-export]:not([data-presentation-mode])[html-show-sidebar-toc] .md-sidebar-toc::-webkit-scrollbar{width:8px}html body[for=html-export]:not([data-presentation-mode])[html-show-sidebar-toc] .md-sidebar-toc::-webkit-scrollbar-track{border-radius:10px;background-color:transparent}html body[for=html-export]:not([data-presentation-mode])[html-show-sidebar-toc] .md-sidebar-toc::-webkit-scrollbar-thumb{border-radius:5px;background-color:rgba(150,150,150,.66);border:4px solid rgba(150,150,150,.66);background-clip:content-box}html body[for=html-export]:not([data-presentation-mode])[html-show-sidebar-toc] .md-sidebar-toc a{text-decoration:none}html body[for=html-export]:not([data-presentation-mode])[html-show-sidebar-toc] .md-sidebar-toc .md-toc{padding:0 16px}html body[for=html-export]:not([data-presentation-mode])[html-show-sidebar-toc] .md-sidebar-toc .md-toc .md-toc-link-wrapper .md-toc-link{display:inline;padding:.25rem 0}html body[for=html-export]:not([data-presentation-mode])[html-show-sidebar-toc] .md-sidebar-toc .md-toc .md-toc-link-wrapper .md-toc-link div,html body[for=html-export]:not([data-presentation-mode])[html-show-sidebar-toc] .md-sidebar-toc .md-toc .md-toc-link-wrapper .md-toc-link p{display:inline}html body[for=html-export]:not([data-presentation-mode])[html-show-sidebar-toc] .md-sidebar-toc .md-toc .md-toc-link-wrapper.highlighted .md-toc-link{font-weight:800}html body[for=html-export]:not([data-presentation-mode])[html-show-sidebar-toc] .markdown-preview{left:300px;width:calc(100% - 300px);padding:2em calc(50% - 457px - 300px / 2);margin:0;box-sizing:border-box}@media screen and (max-width:1274px){html body[for=html-export]:not([data-presentation-mode])[html-show-sidebar-toc] .markdown-preview{padding:2em}}@media screen and (max-width:450px){html body[for=html-export]:not([data-presentation-mode])[html-show-sidebar-toc] .markdown-preview{width:100%}}html body[for=html-export]:not([data-presentation-mode]):not([html-show-sidebar-toc]) .markdown-preview{left:50%;transform:translateX(-50%)}html body[for=html-export]:not([data-presentation-mode]):not([html-show-sidebar-toc]) .md-sidebar-toc{display:none}
- /* Please visit the URL below for more information: */
- /* https://shd101wyy.github.io/markdown-preview-enhanced/#/customize-css */
- </style>
- <!-- The content below will be included at the end of the <head> element. --><script type="text/javascript">
- document.addEventListener("DOMContentLoaded", function () {
- // your code here
- });
- </script></head><body for="html-export">
-
-
- <div class="crossnote markdown-preview ">
-
- <h1 id="极光推送集成说明">极光推送集成说明 </h1>
- <h2 id="目录结构">目录结构 </h2>
- <pre data-role="codeBlock" data-info="" class="language-text"><code>capability-push/src/
- └── main/
- ├── AndroidManifest.xml # Android 清单文件(权限声明)
- └── java/
- └── com/narutohuo/xindazhou/push/
- ├── api/ # API 接口层
- │ └── PushService.kt # 推送服务接口定义
- ├── factory/ # 工厂类层
- │ └── PushServiceFactory.kt # 服务工厂(统一入口,单例获取)
- ├── impl/ # 实现层
- │ └── PushServiceImpl.kt # 推送服务具体实现(封装极光推送SDK)
- ├── receiver/ # 接收器层
- │ └── JPushReceiver.kt # 推送消息接收器(完全封装在模块内部)
- └── model/ # 数据模型层
- ├── PushConfig.kt # 推送服务配置模型
- └── PushResponse.kt # 推送相关的数据模型
- ├── PushMessage # 推送消息模型
- └── PushResponse # 推送响应模型
- </code></pre><h2 id="功能说明">功能说明 </h2>
- <h3 id="1-api-层---接口定义">1. api/ 层 - 接口定义 </h3>
- <ul>
- <li><strong>职责</strong>:定义推送服务的公共接口,业务层只依赖接口</li>
- <li><strong>内容</strong>:<code>PushService</code> 接口,包含初始化、别名/标签设置、消息监听、注册/注销等方法</li>
- </ul>
- <h3 id="2-factory-层---工厂类">2. factory/ 层 - 工厂类 </h3>
- <ul>
- <li><strong>职责</strong>:提供统一的服务实例获取和初始化方式</li>
- <li><strong>内容</strong>:<code>PushServiceFactory</code> 单例工厂</li>
- <li><strong>作用</strong>:隐藏实现细节,统一入口,便于替换实现</li>
- </ul>
- <h3 id="3-impl-层---具体实现">3. impl/ 层 - 具体实现 </h3>
- <ul>
- <li><strong>职责</strong>:实现 <code>PushService</code> 接口的具体逻辑</li>
- <li><strong>内容</strong>:<code>PushServiceImpl</code> 单例实现类</li>
- <li><strong>功能</strong>:封装极光推送 SDK 调用,处理推送消息接收,错误处理和日志记录</li>
- </ul>
- <h3 id="31-receiver-层---消息接收器">3.1 receiver/ 层 - 消息接收器 </h3>
- <ul>
- <li><strong>职责</strong>:封装推送消息接收逻辑</li>
- <li><strong>内容</strong>:<code>JPushReceiver</code> BroadcastReceiver</li>
- <li><strong>功能</strong>:
- <ul>
- <li>自动接收极光推送的消息(自定义消息、通知消息、通知点击)</li>
- <li>自动解析消息内容</li>
- <li><strong>完全封装</strong>:在模块的 <code>AndroidManifest.xml</code> 中自动注册,业务层无需处理</li>
- <li><strong>自动跳转</strong>:根据 <code>pageMappings</code> 自动处理通知点击跳转</li>
- </ul>
- </li>
- </ul>
- <h3 id="4-model-层---数据模型">4. model/ 层 - 数据模型 </h3>
- <ul>
- <li><strong>职责</strong>:定义推送相关的数据模型</li>
- <li><strong>内容</strong>:
- <ul>
- <li><code>PushConfig</code> - 推送服务配置模型</li>
- <li><code>PushMessage</code> - 推送消息模型(标题、内容、扩展数据等)</li>
- <li><code>PushResponse</code> - 推送响应模型(成功/失败、错误信息等)</li>
- </ul>
- </li>
- </ul>
- <h2 id="架构设计">架构设计 </h2>
- <ul>
- <li><strong>接口隔离</strong>:业务层只依赖接口,不依赖实现</li>
- <li><strong>ARouter 依赖注入</strong>:通过 ARouter 实现模块间解耦,base-core 定义接口,能力层实现接口</li>
- <li><strong>工厂模式</strong>:统一入口,隐藏创建逻辑(内部使用 ARouter 获取服务)</li>
- <li><strong>单例模式</strong>:全局共享一个服务实例</li>
- <li><strong>分层架构</strong>:base-core (接口) → capability-push (实现) → ARouter (注册) → Factory (获取)</li>
- <li><strong>完全封装</strong>:跳转逻辑封装在模块内部,外部只需配置页面映射规则</li>
- </ul>
- <h3 id="arouter-架构说明">ARouter 架构说明 </h3>
- <ul>
- <li><strong>base-core</strong> 模块定义 <code>IPushService</code> 接口(位于 <code>com.narutohuo.xindazhou.core.push</code>)</li>
- <li><strong>capability-push</strong> 模块实现 <code>IPushService</code> 接口,并通过 <code>@Route(path = "/push/service")</code> 注册到 ARouter</li>
- <li><strong>Factory</strong> 内部使用 <code>ARouter.getInstance().navigation(IPushService::class.java)</code> 获取服务实例</li>
- <li><strong>业务层</strong> 通过 Factory 获取服务,无需直接依赖实现模块</li>
- </ul>
- <h2 id="已完成的工作">已完成的工作 </h2>
- <p>✅ <strong>SDK 依赖已添加</strong></p>
- <ul>
- <li><code>jpush-5.9.0.aar</code> - 极光推送SDK(本地 AAR)</li>
- <li><code>jcore-5.2.0.aar</code> - 极光推送核心库(本地 AAR)</li>
- <li><code>cn.jiguang.sdk.plugin:xiaomi:5.9.0</code> - 小米通道</li>
- <li><code>cn.jiguang.sdk.plugin:huawei:5.9.0</code> - 华为通道</li>
- <li><code>cn.jiguang.sdk.plugin:oppo:5.9.0</code> - OPPO通道</li>
- <li><code>cn.jiguang.sdk.plugin:vivo:5.9.0</code> - vivo通道</li>
- <li><code>cn.jiguang.sdk.plugin:meizu:5.9.0</code> - 魅族通道</li>
- </ul>
- <p>✅ <strong>代码实现已完成</strong></p>
- <ul>
- <li><code>PushServiceImpl</code> 已实现极光推送 SDK 调用,并实现 <code>IPushService</code> 接口</li>
- <li><code>PushServiceImpl</code> 已通过 ARouter 注册(<code>@Route(path = "/push/service")</code>)</li>
- <li><code>PushServiceFactory</code> 已创建,内部使用 ARouter 获取服务</li>
- <li><code>IPushService</code> 接口已在 <code>base-core</code> 模块定义</li>
- <li><code>PushConfig</code> 配置模型已创建</li>
- <li><code>JPushReceiver</code> 消息接收器已封装</li>
- <li><strong>跳转逻辑已封装</strong>:自动跳转功能已实现</li>
- <li><strong>ARouter 集成完成</strong>:模块间解耦,通过 ARouter 进行依赖注入</li>
- </ul>
- <p>✅ <strong>配置已完成</strong></p>
- <ul>
- <li>所有配置都在 <code>capability-push</code> 模块中管理</li>
- <li><code>AndroidManifest.xml</code> 已在 <code>capability-push/src/main/AndroidManifest.xml</code> 中配置</li>
- <li><code>strings.xml</code> 已在 <code>capability-push/src/main/res/values/strings.xml</code> 中配置</li>
- </ul>
- <h2 id="需要您配置的内容">需要您配置的内容 </h2>
- <h3 id="1-在极光推送官网注册应用">1. 在极光推送官网注册应用 </h3>
- <ol>
- <li>访问 <a href="https://www.jiguang.cn/">极光推送官网</a></li>
- <li>注册账号并创建应用</li>
- <li>获取 <strong>AppKey</strong> 和 <strong>AppSecret</strong></li>
- </ol>
- <h3 id="2-配置厂商通道参数可选但推荐">2. 配置厂商通道参数(可选,但推荐) </h3>
- <p>在各厂商开放平台申请参数,并在 <code>capability-push/src/main/res/values/strings.xml</code> 中配置。</p>
- <p><strong>详细步骤请参考</strong>:<a href="./%E5%8E%82%E5%95%86%E9%80%9A%E9%81%93%E6%8E%A5%E5%85%A5%E8%AF%B4%E6%98%8E.md">厂商通道接入说明.md</a></p>
- <h3 id="3-配置资源文件">3. 配置资源文件 </h3>
- <p><strong>所有配置都在 <code>capability-push/src/main/res/values/strings.xml</code> 中管理</strong></p>
- <p>编辑 <code>capability-push/src/main/res/values/strings.xml</code>:</p>
- <pre data-role="codeBlock" data-info="xml" class="language-xml xml"><code><span class="token tag"><span class="token tag"><span class="token punctuation"><</span>resources</span><span class="token punctuation">></span></span>
- <span class="token comment"><!-- 极光推送基础配置(必填) --></span>
- <span class="token tag"><span class="token tag"><span class="token punctuation"><</span>string</span> <span class="token attr-name">name</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">"</span>jpush_app_key<span class="token punctuation">"</span></span><span class="token punctuation">></span></span>您的极光推送 AppKey<span class="token tag"><span class="token tag"><span class="token punctuation"></</span>string</span><span class="token punctuation">></span></span>
- <span class="token tag"><span class="token tag"><span class="token punctuation"><</span>string</span> <span class="token attr-name">name</span><span class="token attr-value"><span class="token punctuation attr-equals">=</span><span class="token punctuation">"</span>push_jpush_channel<span class="token punctuation">"</span></span><span class="token punctuation">></span></span>developer-default<span class="token tag"><span class="token tag"><span class="token punctuation"></</span>string</span><span class="token punctuation">></span></span>
-
- <span class="token comment"><!-- 厂商通道配置(可选,但推荐配置以提升推送到达率) --></span>
- <span class="token comment"><!-- 详细配置请参考 厂商通道接入说明.md --></span>
- <span class="token tag"><span class="token tag"><span class="token punctuation"></</span>resources</span><span class="token punctuation">></span></span>
- </code></pre><h3 id="4-在-application-中初始化统一入口">4. 在 Application 中初始化(统一入口) </h3>
- <p>在您的 <code>XinDaZhouApplication</code> 类中初始化推送服务:</p>
- <pre data-role="codeBlock" data-info="kotlin" class="language-kotlin kotlin"><code><span class="token comment">// app/src/main/java/com/narutohuo/xindazhou/XinDaZhouApplication.kt</span>
- <span class="token keyword keyword-package">package</span> com<span class="token punctuation">.</span>narutohuo<span class="token punctuation">.</span>xindazhou
- <span class="token keyword keyword-import">import</span> android<span class="token punctuation">.</span>app<span class="token punctuation">.</span>Application
- <span class="token keyword keyword-import">import</span> com<span class="token punctuation">.</span>narutohuo<span class="token punctuation">.</span>xindazhou<span class="token punctuation">.</span>push<span class="token punctuation">.</span>factory<span class="token punctuation">.</span>PushServiceFactory
- <span class="token keyword keyword-class">class</span> XinDaZhouApplication <span class="token operator">:</span> <span class="token function">Application</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
-
- <span class="token keyword keyword-override">override</span> <span class="token keyword keyword-fun">fun</span> <span class="token function">onCreate</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
- <span class="token keyword keyword-super">super</span><span class="token punctuation">.</span><span class="token function">onCreate</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
-
- <span class="token comment">// ========== 初始化推送服务(从资源文件读取配置)==========</span>
- PushServiceFactory<span class="token punctuation">.</span><span class="token function">init</span><span class="token punctuation">(</span>
- context <span class="token operator">=</span> <span class="token keyword keyword-this">this</span><span class="token punctuation">,</span>
- <span class="token comment">// 页面映射规则(用于自动跳转)</span>
- pageMappings <span class="token operator">=</span> <span class="token function">mapOf</span><span class="token punctuation">(</span>
- <span class="token string-literal singleline"><span class="token string">"detail"</span></span> <span class="token keyword keyword-to">to</span> DetailActivity<span class="token operator">::</span><span class="token keyword keyword-class">class</span><span class="token punctuation">.</span>java<span class="token punctuation">,</span> <span class="token comment">// 详情页</span>
- <span class="token string-literal singleline"><span class="token string">"home"</span></span> <span class="token keyword keyword-to">to</span> MainActivity<span class="token operator">::</span><span class="token keyword keyword-class">class</span><span class="token punctuation">.</span>java<span class="token punctuation">,</span> <span class="token comment">// 首页</span>
- <span class="token punctuation">)</span>
- <span class="token punctuation">)</span>
- <span class="token punctuation">}</span>
- <span class="token punctuation">}</span>
- </code></pre><p><strong>优势</strong>:</p>
- <ul>
- <li>✅ <strong>最简单</strong>:只需一行代码,配置都在资源文件中</li>
- <li>✅ <strong>统一入口</strong>:通过 <code>PushServiceFactory.init()</code> 统一初始化</li>
- <li>✅ <strong>跳转逻辑封装</strong>:跳转逻辑完全封装在模块内部,外部只需要配置页面映射规则</li>
- <li>✅ <strong>容错处理</strong>:初始化失败不会影响应用启动,只记录日志</li>
- <li>✅ <strong>自动识别设备</strong>:极光推送 SDK 自动识别设备类型并选择对应厂商通道</li>
- <li>✅ 业务层不直接依赖极光推送API</li>
- <li>✅ 如果更换SDK,只需修改实现层,业务层无需改动</li>
- </ul>
- <h2 id="核心功能说明">核心功能说明 </h2>
- <h3 id="1-通知展示系统通知栏">1. 通知展示(系统通知栏) </h3>
- <p>✅ <strong>不需要我们处理,系统自动显示</strong></p>
- <ul>
- <li>极光推送 SDK 会自动在系统通知栏显示通知</li>
- <li>系统会自动处理通知的展示、图标、声音等</li>
- </ul>
- <h3 id="2-通知点击跳转已封装">2. 通知点击跳转(已封装) </h3>
- <p>✅ <strong>跳转逻辑已完全封装在模块内部!</strong></p>
- <p><strong>工作原理</strong>:</p>
- <ol>
- <li>用户点击通知栏通知</li>
- <li>模块内部自动解析 <code>extras["page"]</code></li>
- <li>根据 <code>pageMappings</code> 自动跳转到对应 Activity</li>
- <li>所有 <code>extras</code> 参数自动传递给目标 Activity</li>
- </ol>
- <p><strong>服务器推送格式</strong>:</p>
- <pre data-role="codeBlock" data-info="json" class="language-json json"><code><span class="token punctuation">{</span>
- <span class="token property">"notification"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
- <span class="token property">"title"</span><span class="token operator">:</span> <span class="token string">"新订单"</span><span class="token punctuation">,</span>
- <span class="token property">"alert"</span><span class="token operator">:</span> <span class="token string">"您有一个新订单待处理"</span>
- <span class="token punctuation">}</span><span class="token punctuation">,</span>
- <span class="token property">"extras"</span><span class="token operator">:</span> <span class="token punctuation">{</span>
- <span class="token property">"page"</span><span class="token operator">:</span> <span class="token string">"detail"</span><span class="token punctuation">,</span> <span class="token comment">// 必须匹配 pageMappings 中的 key</span>
- <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"12345"</span> <span class="token comment">// 会自动传递给目标 Activity</span>
- <span class="token punctuation">}</span>
- <span class="token punctuation">}</span>
- </code></pre><h3 id="3-厂商通道自动识别">3. 厂商通道(自动识别) </h3>
- <p>✅ <strong>极光推送 SDK 会自动识别设备类型,无需手动处理!</strong></p>
- <ul>
- <li>✅ <strong>自动识别</strong>:SDK 会自动检测设备品牌(小米、华为、OPPO、vivo、魅族等)</li>
- <li>✅ <strong>自动选择通道</strong>:根据设备类型自动选择对应的厂商通道</li>
- <li>✅ <strong>自动降级</strong>:如果设备不是厂商手机,自动降级到极光通道</li>
- <li>✅ <strong>无需手动处理</strong>:不需要判断手机品牌,不需要手动选择通道</li>
- </ul>
- <h2 id="使用示例">使用示例 </h2>
- <h3 id="初始化在-application-中">初始化(在 Application 中) </h3>
- <pre data-role="codeBlock" data-info="kotlin" class="language-kotlin kotlin"><code><span class="token comment">// 方式1:只配置自动跳转(推荐,最简单)</span>
- PushServiceFactory<span class="token punctuation">.</span><span class="token function">init</span><span class="token punctuation">(</span>
- context <span class="token operator">=</span> <span class="token keyword keyword-this">this</span><span class="token punctuation">,</span>
- pageMappings <span class="token operator">=</span> <span class="token function">mapOf</span><span class="token punctuation">(</span>
- <span class="token string-literal singleline"><span class="token string">"detail"</span></span> <span class="token keyword keyword-to">to</span> DetailActivity<span class="token operator">::</span><span class="token keyword keyword-class">class</span><span class="token punctuation">.</span>java<span class="token punctuation">,</span>
- <span class="token string-literal singleline"><span class="token string">"home"</span></span> <span class="token keyword keyword-to">to</span> MainActivity<span class="token operator">::</span><span class="token keyword keyword-class">class</span><span class="token punctuation">.</span>java<span class="token punctuation">,</span>
- <span class="token punctuation">)</span>
- <span class="token punctuation">)</span>
- <span class="token comment">// 方式2:配置监听器(可选)</span>
- PushServiceFactory<span class="token punctuation">.</span><span class="token function">init</span><span class="token punctuation">(</span>
- context <span class="token operator">=</span> <span class="token keyword keyword-this">this</span><span class="token punctuation">,</span>
- messageListener <span class="token operator">=</span> <span class="token punctuation">{</span> message <span class="token operator">-></span>
- <span class="token comment">// 处理自定义消息(透传消息)</span>
- Timber<span class="token punctuation">.</span><span class="token function">d</span><span class="token punctuation">(</span><span class="token string-literal singleline"><span class="token string">"收到推送: </span><span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span><span class="token expression">message<span class="token punctuation">.</span>title</span><span class="token interpolation-punctuation punctuation">}</span></span><span class="token string"> - </span><span class="token interpolation"><span class="token interpolation-punctuation punctuation">${</span><span class="token expression">message<span class="token punctuation">.</span>content</span><span class="token interpolation-punctuation punctuation">}</span></span><span class="token string">"</span></span><span class="token punctuation">)</span>
- <span class="token punctuation">}</span><span class="token punctuation">,</span>
- notificationClickListener <span class="token operator">=</span> <span class="token punctuation">{</span> message <span class="token operator">-></span>
- <span class="token comment">// 处理通知点击事件(可选,用于统计、埋点等)</span>
- Timber<span class="token punctuation">.</span><span class="token function">d</span><span class="token punctuation">(</span><span class="token string-literal singleline"><span class="token string">"用户点击通知,已自动跳转"</span></span><span class="token punctuation">)</span>
- <span class="token punctuation">}</span><span class="token punctuation">,</span>
- pageMappings <span class="token operator">=</span> <span class="token function">mapOf</span><span class="token punctuation">(</span>
- <span class="token string-literal singleline"><span class="token string">"detail"</span></span> <span class="token keyword keyword-to">to</span> DetailActivity<span class="token operator">::</span><span class="token keyword keyword-class">class</span><span class="token punctuation">.</span>java<span class="token punctuation">,</span>
- <span class="token punctuation">)</span>
- <span class="token punctuation">)</span>
- </code></pre><h3 id="后续使用可选按需调用">后续使用(可选,按需调用) </h3>
- <pre data-role="codeBlock" data-info="kotlin" class="language-kotlin kotlin"><code><span class="token keyword keyword-val">val</span> pushService <span class="token operator">=</span> PushServiceFactory<span class="token punctuation">.</span><span class="token function">getInstance</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
- pushService<span class="token punctuation">.</span><span class="token function">setAlias</span><span class="token punctuation">(</span><span class="token string-literal singleline"><span class="token string">"user123"</span></span><span class="token punctuation">)</span> <span class="token comment">// 设置别名(可选)</span>
- pushService<span class="token punctuation">.</span><span class="token function">setTags</span><span class="token punctuation">(</span><span class="token function">listOf</span><span class="token punctuation">(</span><span class="token string-literal singleline"><span class="token string">"vip"</span></span><span class="token punctuation">,</span> <span class="token string-literal singleline"><span class="token string">"premium"</span></span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token comment">// 设置标签(可选)</span>
- <span class="token keyword keyword-val">val</span> registrationId <span class="token operator">=</span> pushService<span class="token punctuation">.</span><span class="token function">getRegistrationId</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token comment">// 获取注册ID(可选)</span>
- <span class="token keyword keyword-val">val</span> isEnabled <span class="token operator">=</span> pushService<span class="token punctuation">.</span><span class="token function">isPushEnabled</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token comment">// 检查推送状态(可选)</span>
- </code></pre><h2 id="推送消息类型说明">推送消息类型说明 </h2>
- <ol>
- <li>
- <p><strong>自定义消息(透传消息)</strong>:<code>messageListener</code></p>
- <ul>
- <li>不会显示在系统通知栏</li>
- <li>需要在应用内自己处理并显示</li>
- <li>适用于需要应用内自定义显示的推送</li>
- </ul>
- </li>
- <li>
- <p><strong>通知消息(系统通知栏)</strong>:</p>
- <ul>
- <li><strong>展示</strong>:由极光推送 SDK 和系统自动处理,自动显示在通知栏</li>
- <li><strong>点击</strong>:通过 <code>pageMappings</code> 自动跳转(已封装)</li>
- <li>适用于需要系统通知栏显示的推送</li>
- </ul>
- </li>
- </ol>
- <h2 id="配置位置说明">配置位置说明 </h2>
- <p><strong>⚠️ 重要:所有配置都在 <code>capability-push</code> 模块中管理,<code>app</code> 模块不需要任何配置!</strong></p>
- <ul>
- <li>✅ <strong>配置位置</strong>:<code>capability-push/src/main/res/values/strings.xml</code></li>
- <li>✅ <strong>清单文件</strong>:<code>capability-push/src/main/AndroidManifest.xml</code></li>
- <li>✅ <strong>app 模块</strong>:只需要在 <code>Application</code> 中调用 <code>PushServiceFactory.init()</code> 即可</li>
- </ul>
- <p><strong>❌ 禁止在 app 模块中配置:</strong></p>
- <ul>
- <li>❌ <strong>禁止</strong>在 <code>app/src/main/AndroidManifest.xml</code> 中配置极光推送的 <code>meta-data</code></li>
- <li>❌ <strong>禁止</strong>在 <code>app/src/main/res/values/strings.xml</code> 中配置极光推送参数</li>
- <li>❌ <strong>禁止</strong>在 <code>app/build.gradle</code> 中配置极光推送相关参数</li>
- <li>✅ <strong>所有配置都在 <code>capability-push</code> 模块中!</strong></li>
- </ul>
- <h2 id="参考文档">参考文档 </h2>
- <ul>
- <li><a href="https://docs.jiguang.cn/jpush/client/android/android_guide/">极光推送官方文档</a></li>
- <li><a href="https://docs.jiguang.cn/jpush/client/Android/android_3rd_guide">厂商通道 SDK 集成指南</a></li>
- <li><a href="./%E5%8E%82%E5%95%86%E9%80%9A%E9%81%93%E6%8E%A5%E5%85%A5%E8%AF%B4%E6%98%8E.md">厂商通道接入说明.md</a> - 本项目厂商通道配置说明</li>
- </ul>
- </div>
-
-
-
-
-
-
-
-
-
- </body></html>
|