新大洲 Android 项目结构文档.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454
  1. <!DOCTYPE html><html><head>
  2. <title>PROJECT_STRUCTURE</title>
  3. <meta charset="utf-8">
  4. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  5. <link rel="stylesheet" href="file:////Users/Zhuanz/.cursor/extensions/shd101wyy.markdown-preview-enhanced-0.8.20-universal/crossnote/dependencies/katex/katex.min.css">
  6. <style>
  7. 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}
  8. /* Please visit the URL below for more information: */
  9. /* https://shd101wyy.github.io/markdown-preview-enhanced/#/customize-css */
  10. </style>
  11. <!-- The content below will be included at the end of the <head> element. --><script type="text/javascript">
  12. document.addEventListener("DOMContentLoaded", function () {
  13. // your code here
  14. });
  15. </script></head><body for="html-export">
  16. <div class="crossnote markdown-preview ">
  17. <h1 id="新大洲-android-项目结构文档">新大洲 Android 项目结构文档 </h1>
  18. <h2 id="一-项目结构图">一、项目结构图 </h2>
  19. <pre data-role="codeBlock" data-info="" class="language-text"><code>xdz_android/
  20. ├── app/ # 应用主模块(业务层)
  21. │ ├── src/main/
  22. │ │ ├── java/ # 业务代码(Activity、Fragment、ViewModel等)
  23. │ │ └── res/ # 资源文件(布局、图片、字符串等)
  24. │ └── build.gradle
  25. ├── base-core/ # 基础核心模块(最底层)
  26. │ └── src/main/
  27. │ └── java/ # 核心工具类和接口定义
  28. ├── base-common/ # 基础通用模块
  29. │ └── src/main/
  30. │ └── java/ # 通用组件(Dialog、网络请求封装等)
  31. ├── capability-ble/ # BLE 蓝牙能力模块
  32. │ └── src/main/
  33. │ └── java/ # BLE 相关功能实现
  34. ├── capability-socketio/ # SocketIO 实时通信能力模块
  35. │ └── src/main/
  36. │ └── java/ # SocketIO 客户端封装
  37. ├── capability-push/ # 推送能力模块
  38. │ └── src/main/
  39. │ └── java/ # 推送功能封装(极光推送等)
  40. ├── capability-qrcode/ # 二维码能力模块
  41. │ └── src/main/
  42. │ └── java/ # 二维码扫描/生成功能
  43. ├── capability-share/ # 分享能力模块
  44. │ └── src/main/
  45. │ └── java/ # 微信、QQ等分享功能
  46. ├── capability-nfc/ # NFC 能力模块
  47. │ └── src/main/
  48. │ └── java/ # NFC 读写功能
  49. ├── build.gradle # 项目根 build.gradle
  50. ├── settings.gradle # 模块配置
  51. └── gradle/ # Gradle 配置
  52. └── libs.versions.toml # 依赖版本管理
  53. </code></pre><h2 id="二-模块说明">二、模块说明 </h2>
  54. <h3 id="21-应用层">2.1 应用层 </h3>
  55. <table>
  56. <thead>
  57. <tr>
  58. <th>模块</th>
  59. <th>命名空间</th>
  60. <th>说明</th>
  61. </tr>
  62. </thead>
  63. <tbody>
  64. <tr>
  65. <td><strong>app</strong></td>
  66. <td><code>com.narutohuo.xindazhou</code></td>
  67. <td>应用主模块,包含所有业务代码和UI</td>
  68. </tr>
  69. </tbody>
  70. </table>
  71. <h3 id="22-基础层">2.2 基础层 </h3>
  72. <table>
  73. <thead>
  74. <tr>
  75. <th>模块</th>
  76. <th>命名空间</th>
  77. <th>说明</th>
  78. </tr>
  79. </thead>
  80. <tbody>
  81. <tr>
  82. <td><strong>base-core</strong></td>
  83. <td><code>com.narutohuo.xindazhou.core</code></td>
  84. <td>核心基础模块,提供最基础的接口和工具类</td>
  85. </tr>
  86. <tr>
  87. <td><strong>base-common</strong></td>
  88. <td><code>com.narutohuo.xindazhou.common</code></td>
  89. <td>通用基础模块,提供通用组件和网络封装</td>
  90. </tr>
  91. </tbody>
  92. </table>
  93. <h3 id="23-能力层sdk层">2.3 能力层(SDK层) </h3>
  94. <table>
  95. <thead>
  96. <tr>
  97. <th>模块</th>
  98. <th>命名空间</th>
  99. <th>说明</th>
  100. </tr>
  101. </thead>
  102. <tbody>
  103. <tr>
  104. <td><strong>capability-ble</strong></td>
  105. <td><code>com.narutohuo.xindazhou.ble</code></td>
  106. <td>蓝牙BLE功能封装</td>
  107. </tr>
  108. <tr>
  109. <td><strong>capability-socketio</strong></td>
  110. <td><code>com.narutohuo.xindazhou.socketio</code></td>
  111. <td>SocketIO实时通信封装</td>
  112. </tr>
  113. <tr>
  114. <td><strong>capability-push</strong></td>
  115. <td><code>com.narutohuo.xindazhou.push</code></td>
  116. <td>推送功能封装(极光推送等)</td>
  117. </tr>
  118. <tr>
  119. <td><strong>capability-qrcode</strong></td>
  120. <td><code>com.narutohuo.xindazhou.qrcode</code></td>
  121. <td>二维码扫描/生成功能</td>
  122. </tr>
  123. <tr>
  124. <td><strong>capability-share</strong></td>
  125. <td><code>com.narutohuo.xindazhou.share</code></td>
  126. <td>分享功能封装(微信、QQ等)</td>
  127. </tr>
  128. <tr>
  129. <td><strong>capability-nfc</strong></td>
  130. <td><code>com.narutohuo.xindazhou.nfc</code></td>
  131. <td>NFC读写功能封装</td>
  132. </tr>
  133. </tbody>
  134. </table>
  135. <h2 id="三-依赖关系图">三、依赖关系图 </h2>
  136. <h3 id="31-模块依赖关系">3.1 模块依赖关系 </h3>
  137. <pre data-role="codeBlock" data-info="" class="language-text"><code>┌─────────────────────────────────────────────────────────┐
  138. │ app │
  139. │ (应用主模块 - 业务层) │
  140. └────────────┬────────────────────────────────────────────┘
  141. │ 依赖所有模块
  142. ┌────────┼────────┬────────┬────────┬────────┬────────┐
  143. │ │ │ │ │ │ │
  144. ▼ ▼ ▼ ▼ ▼ ▼ ▼
  145. ┌───────┐ ┌───────┐ ┌───────┐ ┌───────┐ ┌───────┐ ┌───────┐
  146. │base- │ │base- │ │cap- │ │cap- │ │cap- │ │cap- │
  147. │common│ │core │ │socket │ │ble │ │push │ │qrcode │
  148. └───┬───┘ └───────┘ │io │ └───────┘ └───────┘ └───────┘
  149. │ └───────┘
  150. │ ┌───────┐
  151. │ │cap- │
  152. │ │share │
  153. │ └───────┘
  154. │ ┌───────┐
  155. │ │cap- │
  156. │ │nfc │
  157. │ └───────┘
  158. │ 依赖
  159. ┌───────┐
  160. │base- │
  161. │core │
  162. └───────┘
  163. │ 所有 capability-* 模块都依赖
  164. ┌───┴───────────────────────────────────────────┐
  165. │ capability-ble │
  166. │ capability-socketio │
  167. │ capability-push │
  168. │ capability-qrcode │
  169. │ capability-share │
  170. │ capability-nfc │
  171. └───────────────────────────────────────────────┘
  172. </code></pre><h3 id="32-详细依赖关系">3.2 详细依赖关系 </h3>
  173. <h4 id="app-模块依赖">app 模块依赖 </h4>
  174. <pre data-role="codeBlock" data-info="yaml" class="language-yaml yaml"><code><span class="token key atrule">app</span><span class="token punctuation">:</span>
  175. <span class="token key atrule">基础模块</span><span class="token punctuation">:</span>
  176. <span class="token punctuation">-</span> base<span class="token punctuation">-</span>core
  177. <span class="token punctuation">-</span> base<span class="token punctuation">-</span>common
  178. <span class="token key atrule">能力模块</span><span class="token punctuation">:</span>
  179. <span class="token punctuation">-</span> capability<span class="token punctuation">-</span>ble
  180. <span class="token punctuation">-</span> capability<span class="token punctuation">-</span>socketio
  181. <span class="token punctuation">-</span> capability<span class="token punctuation">-</span>push
  182. <span class="token punctuation">-</span> capability<span class="token punctuation">-</span>qrcode
  183. <span class="token punctuation">-</span> capability<span class="token punctuation">-</span>share
  184. <span class="token punctuation">-</span> capability<span class="token punctuation">-</span>nfc
  185. <span class="token key atrule">第三方库</span><span class="token punctuation">:</span>
  186. <span class="token punctuation">-</span> AndroidX Core KTX
  187. <span class="token punctuation">-</span> AppCompat
  188. <span class="token punctuation">-</span> Material Design
  189. <span class="token punctuation">-</span> ConstraintLayout
  190. <span class="token punctuation">-</span> Lifecycle (ViewModel<span class="token punctuation">,</span> LiveData)
  191. <span class="token punctuation">-</span> Kotlin Coroutines
  192. <span class="token punctuation">-</span> Navigation
  193. <span class="token punctuation">-</span> Retrofit &amp; OkHttp
  194. <span class="token punctuation">-</span> Glide
  195. <span class="token punctuation">-</span> Room
  196. <span class="token punctuation">-</span> Jetpack Compose
  197. <span class="token punctuation">-</span> Timber (日志)
  198. <span class="token punctuation">-</span> Hyperion (调试工具)
  199. <span class="token punctuation">-</span> Chuck (网络调试)
  200. </code></pre><h4 id="base-common-模块依赖">base-common 模块依赖 </h4>
  201. <pre data-role="codeBlock" data-info="yaml" class="language-yaml yaml"><code><span class="token key atrule">base-common</span><span class="token punctuation">:</span>
  202. <span class="token key atrule">项目模块</span><span class="token punctuation">:</span>
  203. <span class="token punctuation">-</span> base<span class="token punctuation">-</span>core <span class="token comment"># 依赖基础核心模块</span>
  204. <span class="token key atrule">第三方库</span><span class="token punctuation">:</span>
  205. <span class="token punctuation">-</span> AndroidX Core KTX
  206. <span class="token punctuation">-</span> Fragment KTX
  207. <span class="token punctuation">-</span> Material Design
  208. <span class="token punctuation">-</span> Gson
  209. <span class="token punctuation">-</span> Retrofit &amp; Gson Converter
  210. </code></pre><h4 id="base-core-模块依赖">base-core 模块依赖 </h4>
  211. <pre data-role="codeBlock" data-info="yaml" class="language-yaml yaml"><code><span class="token key atrule">base-core</span><span class="token punctuation">:</span>
  212. <span class="token key atrule">第三方库</span><span class="token punctuation">:</span>
  213. <span class="token punctuation">-</span> AndroidX Core KTX <span class="token comment"># 仅依赖最基础的 AndroidX</span>
  214. </code></pre><h4 id="capability-socketio-模块依赖">capability-socketio 模块依赖 </h4>
  215. <pre data-role="codeBlock" data-info="yaml" class="language-yaml yaml"><code><span class="token key atrule">capability-socketio</span><span class="token punctuation">:</span>
  216. <span class="token key atrule">项目模块</span><span class="token punctuation">:</span>
  217. <span class="token punctuation">-</span> base<span class="token punctuation">-</span>core <span class="token comment"># 依赖基础核心模块</span>
  218. <span class="token key atrule">第三方库</span><span class="token punctuation">:</span>
  219. <span class="token punctuation">-</span> AndroidX Core KTX
  220. <span class="token punctuation">-</span> Socket.IO Client (io.socket<span class="token punctuation">:</span>socket.io<span class="token punctuation">-</span>client<span class="token punctuation">:</span>2.1.0)
  221. <span class="token punctuation">-</span> Gson
  222. <span class="token punctuation">-</span> Kotlin Coroutines
  223. </code></pre><h4 id="capability-ble-模块依赖">capability-ble 模块依赖 </h4>
  224. <pre data-role="codeBlock" data-info="yaml" class="language-yaml yaml"><code><span class="token key atrule">capability-ble</span><span class="token punctuation">:</span>
  225. <span class="token key atrule">项目模块</span><span class="token punctuation">:</span>
  226. <span class="token punctuation">-</span> base<span class="token punctuation">-</span>core <span class="token comment"># 依赖基础核心模块</span>
  227. <span class="token key atrule">第三方库</span><span class="token punctuation">:</span>
  228. <span class="token punctuation">-</span> AndroidX Core KTX
  229. </code></pre><h4 id="capability-push-模块依赖">capability-push 模块依赖 </h4>
  230. <pre data-role="codeBlock" data-info="yaml" class="language-yaml yaml"><code><span class="token key atrule">capability-push</span><span class="token punctuation">:</span>
  231. <span class="token key atrule">项目模块</span><span class="token punctuation">:</span>
  232. <span class="token punctuation">-</span> base<span class="token punctuation">-</span>core <span class="token comment"># 依赖基础核心模块</span>
  233. <span class="token key atrule">第三方库</span><span class="token punctuation">:</span>
  234. <span class="token punctuation">-</span> AndroidX Core KTX
  235. <span class="token comment"># 极光推送SDK(待添加)</span>
  236. </code></pre><h4 id="capability-qrcode-模块依赖">capability-qrcode 模块依赖 </h4>
  237. <pre data-role="codeBlock" data-info="yaml" class="language-yaml yaml"><code><span class="token key atrule">capability-qrcode</span><span class="token punctuation">:</span>
  238. <span class="token key atrule">项目模块</span><span class="token punctuation">:</span>
  239. <span class="token punctuation">-</span> base<span class="token punctuation">-</span>core <span class="token comment"># 依赖基础核心模块</span>
  240. <span class="token key atrule">第三方库</span><span class="token punctuation">:</span>
  241. <span class="token punctuation">-</span> AndroidX Core KTX
  242. <span class="token comment"># 华为扫码SDK(待添加)</span>
  243. </code></pre><h4 id="capability-share-模块依赖">capability-share 模块依赖 </h4>
  244. <pre data-role="codeBlock" data-info="yaml" class="language-yaml yaml"><code><span class="token key atrule">capability-share</span><span class="token punctuation">:</span>
  245. <span class="token key atrule">项目模块</span><span class="token punctuation">:</span>
  246. <span class="token punctuation">-</span> base<span class="token punctuation">-</span>core <span class="token comment"># 依赖基础核心模块</span>
  247. <span class="token key atrule">第三方库</span><span class="token punctuation">:</span>
  248. <span class="token punctuation">-</span> AndroidX Core KTX
  249. <span class="token comment"># 微信分享SDK(待添加)</span>
  250. <span class="token comment"># QQ分享SDK(待添加)</span>
  251. </code></pre><h4 id="capability-nfc-模块依赖">capability-nfc 模块依赖 </h4>
  252. <pre data-role="codeBlock" data-info="yaml" class="language-yaml yaml"><code><span class="token key atrule">capability-nfc</span><span class="token punctuation">:</span>
  253. <span class="token key atrule">项目模块</span><span class="token punctuation">:</span>
  254. <span class="token punctuation">-</span> base<span class="token punctuation">-</span>core <span class="token comment"># 依赖基础核心模块</span>
  255. <span class="token key atrule">第三方库</span><span class="token punctuation">:</span>
  256. <span class="token punctuation">-</span> AndroidX Core KTX
  257. </code></pre><h2 id="四-依赖关系总结">四、依赖关系总结 </h2>
  258. <h3 id="41-依赖层级">4.1 依赖层级 </h3>
  259. <pre data-role="codeBlock" data-info="" class="language-text"><code>层级 1: base-core
  260. └─ 最底层,不依赖任何项目模块,只依赖 AndroidX Core
  261. 层级 2: base-common + 所有 capability-* 模块
  262. └─ 都依赖 base-core
  263. 层级 3: app
  264. └─ 依赖所有基础模块和能力模块
  265. </code></pre><h3 id="42-依赖原则">4.2 依赖原则 </h3>
  266. <ol>
  267. <li>
  268. <p><strong>base-core</strong>:</p>
  269. <ul>
  270. <li>最底层模块,不依赖任何项目内部模块</li>
  271. <li>只依赖 AndroidX Core KTX</li>
  272. <li>提供最基础的接口和工具类</li>
  273. </ul>
  274. </li>
  275. <li>
  276. <p><strong>base-common</strong>:</p>
  277. <ul>
  278. <li>依赖 base-core</li>
  279. <li>提供通用组件(Dialog、网络请求封装等)</li>
  280. </ul>
  281. </li>
  282. <li>
  283. <p><em><em>capability-</em> 模块</em>*:</p>
  284. <ul>
  285. <li>所有能力模块都依赖 base-core</li>
  286. <li>每个模块独立封装特定功能</li>
  287. <li>不相互依赖,保持模块独立性</li>
  288. </ul>
  289. </li>
  290. <li>
  291. <p><strong>app 模块</strong>:</p>
  292. <ul>
  293. <li>依赖所有基础模块和能力模块</li>
  294. <li>包含业务代码和UI</li>
  295. <li>通过能力模块提供的接口使用功能</li>
  296. </ul>
  297. </li>
  298. </ol>
  299. <h3 id="43-模块独立性">4.3 模块独立性 </h3>
  300. <ul>
  301. <li>✅ <em><em>capability-</em> 模块之间不相互依赖</em>*,保持独立</li>
  302. <li>✅ <em><em>所有 capability-</em> 模块都依赖 base-core</em>*,统一基础</li>
  303. <li>✅ <strong>app 模块依赖所有模块</strong>,整合所有功能</li>
  304. </ul>
  305. <h2 id="五-主要第三方依赖">五、主要第三方依赖 </h2>
  306. <h3 id="51-网络请求">5.1 网络请求 </h3>
  307. <ul>
  308. <li><strong>Retrofit</strong>: <code>2.9.0</code> - HTTP 客户端</li>
  309. <li><strong>OkHttp</strong>: <code>4.12.0</code> - HTTP 网络库</li>
  310. <li><strong>Gson</strong>: <code>2.10.1</code> - JSON 解析</li>
  311. </ul>
  312. <h3 id="52-ui-框架">5.2 UI 框架 </h3>
  313. <ul>
  314. <li><strong>Jetpack Compose</strong>: 现代 UI 框架</li>
  315. <li><strong>Material Design</strong>: <code>1.11.0</code> - Material 组件</li>
  316. <li><strong>Navigation</strong>: <code>2.7.6</code> - 导航组件</li>
  317. </ul>
  318. <h3 id="53-异步处理">5.3 异步处理 </h3>
  319. <ul>
  320. <li><strong>Kotlin Coroutines</strong>: <code>1.7.3</code> - 协程支持</li>
  321. </ul>
  322. <h3 id="54-数据存储">5.4 数据存储 </h3>
  323. <ul>
  324. <li><strong>Room</strong>: <code>2.6.1</code> - 本地数据库</li>
  325. </ul>
  326. <h3 id="55-图片加载">5.5 图片加载 </h3>
  327. <ul>
  328. <li><strong>Glide</strong>: <code>4.16.0</code> - 图片加载库</li>
  329. </ul>
  330. <h3 id="56-实时通信">5.6 实时通信 </h3>
  331. <ul>
  332. <li><strong><a href="http://Socket.IO">Socket.IO</a> Client</strong>: <code>2.1.0</code> - SocketIO 客户端</li>
  333. </ul>
  334. <h3 id="57-调试工具">5.7 调试工具 </h3>
  335. <ul>
  336. <li><strong>Hyperion</strong>: <code>0.9.34</code> - 应用内调试工具</li>
  337. <li><strong>Chuck</strong>: <code>4.0.0</code> - 网络请求拦截器(调试用)</li>
  338. <li><strong>Timber</strong>: <code>5.0.1</code> - 日志库</li>
  339. </ul>
  340. <h2 id="六-项目配置">六、项目配置 </h2>
  341. <h3 id="61-编译配置">6.1 编译配置 </h3>
  342. <ul>
  343. <li><strong>compileSdk</strong>: 36</li>
  344. <li><strong>minSdk</strong>: 26</li>
  345. <li><strong>targetSdk</strong>: 36</li>
  346. <li><strong>Java Version</strong>: 17</li>
  347. <li><strong>Kotlin JVM Target</strong>: 17</li>
  348. </ul>
  349. <h3 id="62-构建特性">6.2 构建特性 </h3>
  350. <ul>
  351. <li><strong>ViewBinding</strong>: 启用</li>
  352. <li><strong>DataBinding</strong>: 部分启用</li>
  353. <li><strong>Jetpack Compose</strong>: 启用</li>
  354. <li><strong>BuildConfig</strong>: 启用</li>
  355. </ul>
  356. <h2 id="七-模块职责划分">七、模块职责划分 </h2>
  357. <table>
  358. <thead>
  359. <tr>
  360. <th>模块</th>
  361. <th>职责</th>
  362. <th>可被谁依赖</th>
  363. </tr>
  364. </thead>
  365. <tbody>
  366. <tr>
  367. <td><strong>base-core</strong></td>
  368. <td>提供最基础的接口和工具类</td>
  369. <td>所有模块</td>
  370. </tr>
  371. <tr>
  372. <td><strong>base-common</strong></td>
  373. <td>提供通用组件和网络封装</td>
  374. <td>app</td>
  375. </tr>
  376. <tr>
  377. <td><strong>capability-ble</strong></td>
  378. <td>BLE 功能封装</td>
  379. <td>app</td>
  380. </tr>
  381. <tr>
  382. <td><strong>capability-socketio</strong></td>
  383. <td>SocketIO 功能封装</td>
  384. <td>app</td>
  385. </tr>
  386. <tr>
  387. <td><strong>capability-push</strong></td>
  388. <td>推送功能封装</td>
  389. <td>app</td>
  390. </tr>
  391. <tr>
  392. <td><strong>capability-qrcode</strong></td>
  393. <td>二维码功能封装</td>
  394. <td>app</td>
  395. </tr>
  396. <tr>
  397. <td><strong>capability-share</strong></td>
  398. <td>分享功能封装</td>
  399. <td>app</td>
  400. </tr>
  401. <tr>
  402. <td><strong>capability-nfc</strong></td>
  403. <td>NFC 功能封装</td>
  404. <td>app</td>
  405. </tr>
  406. <tr>
  407. <td><strong>app</strong></td>
  408. <td>业务代码和UI</td>
  409. <td>无(应用入口)</td>
  410. </tr>
  411. </tbody>
  412. </table>
  413. <hr>
  414. <p><strong>文档版本</strong>: v1.0<br>
  415. <strong>最后更新</strong>: 2024年</p>
  416. </div>
  417. </body></html>