index.html 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329
  1. <!doctype html>
  2. <html lang="zh" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <meta name="description" content="Net document">
  7. <meta name="author" content="劉強東">
  8. <link rel="next" href="coroutine-request.html">
  9. <link rel="icon" href="img/book-open.svg">
  10. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">
  11. <title>Net</title>
  12. <link rel="stylesheet" href="assets/stylesheets/main.6f8fc17f.min.css">
  13. <link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
  14. <script src="https://unpkg.com/iframe-worker/shim"></script>
  15. <link rel="stylesheet" href="css/extra.css">
  16. <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  17. </head>
  18. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="white" data-md-color-accent="indigo">
  19. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  20. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  21. <label class="md-overlay" for="__drawer"></label>
  22. <div data-md-component="skip">
  23. <a href="#_1" class="md-skip">
  24. 跳转至
  25. </a>
  26. </div>
  27. <div data-md-component="announce">
  28. </div>
  29. <header class="md-header md-header--shadow" data-md-component="header">
  30. <nav class="md-header__inner md-grid" aria-label="页眉">
  31. <a href="index.html" title="Net" class="md-header__button md-logo" aria-label="Net" data-md-component="logo">
  32. <img src="img/book-open.svg" alt="logo">
  33. </a>
  34. <label class="md-header__button md-icon" for="__drawer">
  35. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
  36. </label>
  37. <div class="md-header__title" data-md-component="header-title">
  38. <div class="md-header__ellipsis">
  39. <div class="md-header__topic">
  40. <span class="md-ellipsis">
  41. Net
  42. </span>
  43. </div>
  44. <div class="md-header__topic" data-md-component="header-topic">
  45. <span class="md-ellipsis">
  46. 使用
  47. </span>
  48. </div>
  49. </div>
  50. </div>
  51. <form class="md-header__option" data-md-component="palette">
  52. <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="white" data-md-color-accent="indigo" aria-hidden="true" type="radio" name="__palette" id="__palette_0">
  53. </form>
  54. <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  55. <label class="md-header__button md-icon" for="__search">
  56. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
  57. </label>
  58. <div class="md-search" data-md-component="search" role="dialog">
  59. <label class="md-search__overlay" for="__search"></label>
  60. <div class="md-search__inner" role="search">
  61. <form class="md-search__form" name="search">
  62. <input type="text" class="md-search__input" name="query" aria-label="搜索" placeholder="搜索" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  63. <label class="md-search__icon md-icon" for="__search">
  64. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
  65. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
  66. </label>
  67. <nav class="md-search__options" aria-label="查找">
  68. <a href="javascript:void(0)" class="md-search__icon md-icon" title="分享" aria-label="分享" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
  69. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
  70. </a>
  71. <button type="reset" class="md-search__icon md-icon" title="清空当前内容" aria-label="清空当前内容" tabindex="-1">
  72. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
  73. </button>
  74. </nav>
  75. <div class="md-search__suggest" data-md-component="search-suggest"></div>
  76. </form>
  77. <div class="md-search__output">
  78. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  79. <div class="md-search-result" data-md-component="search-result">
  80. <div class="md-search-result__meta">
  81. 正在初始化搜索引擎
  82. </div>
  83. <ol class="md-search-result__list" role="presentation"></ol>
  84. </div>
  85. </div>
  86. </div>
  87. </div>
  88. </div>
  89. <div class="md-header__source">
  90. <a href="https://github.com/liangjingkanji/Net" title="前往仓库" class="md-source" data-md-component="source">
  91. <div class="md-source__icon md-icon">
  92. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  93. </div>
  94. <div class="md-source__repository">
  95. GitHub
  96. </div>
  97. </a>
  98. </div>
  99. </nav>
  100. </header>
  101. <div class="md-container" data-md-component="container">
  102. <main class="md-main" data-md-component="main">
  103. <div class="md-main__inner md-grid">
  104. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  105. <div class="md-sidebar__scrollwrap">
  106. <div class="md-sidebar__inner">
  107. <nav class="md-nav md-nav--primary" aria-label="导航栏" data-md-level="0">
  108. <label class="md-nav__title" for="__drawer">
  109. <a href="index.html" title="Net" class="md-nav__button md-logo" aria-label="Net" data-md-component="logo">
  110. <img src="img/book-open.svg" alt="logo">
  111. </a>
  112. Net
  113. </label>
  114. <div class="md-nav__source">
  115. <a href="https://github.com/liangjingkanji/Net" title="前往仓库" class="md-source" data-md-component="source">
  116. <div class="md-source__icon md-icon">
  117. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  118. </div>
  119. <div class="md-source__repository">
  120. GitHub
  121. </div>
  122. </a>
  123. </div>
  124. <ul class="md-nav__list" data-md-scrollfix>
  125. <li class="md-nav__item md-nav__item--active">
  126. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  127. <label class="md-nav__link md-nav__link--active" for="__toc">
  128. <span class="md-ellipsis">
  129. 使用
  130. </span>
  131. <span class="md-nav__icon md-icon"></span>
  132. </label>
  133. <a href="index.html" class="md-nav__link md-nav__link--active">
  134. <span class="md-ellipsis">
  135. 使用
  136. </span>
  137. </a>
  138. <nav class="md-nav md-nav--secondary" aria-label="目录">
  139. <label class="md-nav__title" for="__toc">
  140. <span class="md-nav__icon md-icon"></span>
  141. 目录
  142. </label>
  143. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  144. <li class="md-nav__item">
  145. <a href="#_1" class="md-nav__link">
  146. <span class="md-ellipsis">
  147. 使用
  148. </span>
  149. </a>
  150. </li>
  151. <li class="md-nav__item">
  152. <a href="#_2" class="md-nav__link">
  153. <span class="md-ellipsis">
  154. 返回结果
  155. </span>
  156. </a>
  157. </li>
  158. </ul>
  159. </nav>
  160. </li>
  161. <li class="md-nav__item">
  162. <a href="coroutine-request.html" class="md-nav__link">
  163. <span class="md-ellipsis">
  164. 协程请求
  165. </span>
  166. </a>
  167. </li>
  168. <li class="md-nav__item">
  169. <a href="scope.html" class="md-nav__link">
  170. <span class="md-ellipsis">
  171. 作用域
  172. </span>
  173. </a>
  174. </li>
  175. <li class="md-nav__item">
  176. <a href="sync-request.html" class="md-nav__link">
  177. <span class="md-ellipsis">
  178. 同步请求
  179. </span>
  180. </a>
  181. </li>
  182. <li class="md-nav__item">
  183. <a href="request.html" class="md-nav__link">
  184. <span class="md-ellipsis">
  185. 请求参数
  186. </span>
  187. </a>
  188. </li>
  189. <li class="md-nav__item">
  190. <a href="config.html" class="md-nav__link">
  191. <span class="md-ellipsis">
  192. 全局配置
  193. </span>
  194. </a>
  195. </li>
  196. <li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
  197. <a href="converter.html" class="md-nav__link">
  198. <span class="md-ellipsis">
  199. 请求结果
  200. </span>
  201. <span class="md-nav__icon md-icon"></span>
  202. </a>
  203. </li>
  204. <li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
  205. <a href="auto-dialog.html" class="md-nav__link">
  206. <span class="md-ellipsis">
  207. 自动化
  208. </span>
  209. <span class="md-nav__icon md-icon"></span>
  210. </a>
  211. </li>
  212. <li class="md-nav__item">
  213. <a href="thread.html" class="md-nav__link">
  214. <span class="md-ellipsis">
  215. 切换线程
  216. </span>
  217. </a>
  218. </li>
  219. <li class="md-nav__item">
  220. <a href="view-model.html" class="md-nav__link">
  221. <span class="md-ellipsis">
  222. ViewModel
  223. </span>
  224. </a>
  225. </li>
  226. <li class="md-nav__item">
  227. <a href="track.html" class="md-nav__link">
  228. <span class="md-ellipsis">
  229. 异常追踪
  230. </span>
  231. </a>
  232. </li>
  233. <li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
  234. <a href="error.html" class="md-nav__link">
  235. <span class="md-ellipsis">
  236. 错误处理
  237. </span>
  238. <span class="md-nav__icon md-icon"></span>
  239. </a>
  240. </li>
  241. <li class="md-nav__item">
  242. <a href="okhttp-client.html" class="md-nav__link">
  243. <span class="md-ellipsis">
  244. OkHttpClient
  245. </span>
  246. </a>
  247. </li>
  248. <li class="md-nav__item">
  249. <a href="interceptor.html" class="md-nav__link">
  250. <span class="md-ellipsis">
  251. 拦截器
  252. </span>
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="https.html" class="md-nav__link">
  257. <span class="md-ellipsis">
  258. Https证书
  259. </span>
  260. </a>
  261. </li>
  262. <li class="md-nav__item">
  263. <a href="cookie.html" class="md-nav__link">
  264. <span class="md-ellipsis">
  265. Cookie
  266. </span>
  267. </a>
  268. </li>
  269. <li class="md-nav__item">
  270. <a href="cache.html" class="md-nav__link">
  271. <span class="md-ellipsis">
  272. 缓存
  273. </span>
  274. </a>
  275. </li>
  276. <li class="md-nav__item">
  277. <a href="tag.html" class="md-nav__link">
  278. <span class="md-ellipsis">
  279. 标签/额外
  280. </span>
  281. </a>
  282. </li>
  283. <li class="md-nav__item">
  284. <a href="upload-file.html" class="md-nav__link">
  285. <span class="md-ellipsis">
  286. 上传文件
  287. </span>
  288. </a>
  289. </li>
  290. <li class="md-nav__item">
  291. <a href="download-file.html" class="md-nav__link">
  292. <span class="md-ellipsis">
  293. 下载文件
  294. </span>
  295. </a>
  296. </li>
  297. <li class="md-nav__item">
  298. <a href="progress.html" class="md-nav__link">
  299. <span class="md-ellipsis">
  300. 进度监听
  301. </span>
  302. </a>
  303. </li>
  304. <li class="md-nav__item">
  305. <a href="cancel.html" class="md-nav__link">
  306. <span class="md-ellipsis">
  307. 取消请求
  308. </span>
  309. </a>
  310. </li>
  311. <li class="md-nav__item">
  312. <a href="repeat-request.html" class="md-nav__link">
  313. <span class="md-ellipsis">
  314. 重复请求
  315. </span>
  316. </a>
  317. </li>
  318. <li class="md-nav__item">
  319. <a href="debounce.html" class="md-nav__link">
  320. <span class="md-ellipsis">
  321. 搜索节流
  322. </span>
  323. </a>
  324. </li>
  325. <li class="md-nav__item">
  326. <a href="fastest.html" class="md-nav__link">
  327. <span class="md-ellipsis">
  328. 最快请求结果
  329. </span>
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="log-recorder.html" class="md-nav__link">
  334. <span class="md-ellipsis">
  335. 日志插件
  336. </span>
  337. </a>
  338. </li>
  339. <li class="md-nav__item">
  340. <a href="log-notice.html" class="md-nav__link">
  341. <span class="md-ellipsis">
  342. 日志通知
  343. </span>
  344. </a>
  345. </li>
  346. <li class="md-nav__item">
  347. <a href="timing.html" class="md-nav__link">
  348. <span class="md-ellipsis">
  349. 限时/定时请求
  350. </span>
  351. </a>
  352. </li>
  353. <li class="md-nav__item">
  354. <a href="callback.html" class="md-nav__link">
  355. <span class="md-ellipsis">
  356. Callback
  357. </span>
  358. </a>
  359. </li>
  360. <li class="md-nav__item">
  361. <a href="interval.html" class="md-nav__link">
  362. <span class="md-ellipsis">
  363. 轮询器/倒计时
  364. </span>
  365. </a>
  366. </li>
  367. <li class="md-nav__item">
  368. <a href="https://github.com/liangjingkanji/Net/discussions" class="md-nav__link">
  369. <span class="md-ellipsis">
  370. 社区讨论
  371. </span>
  372. </a>
  373. </li>
  374. <li class="md-nav__item">
  375. <a href="issues.html" class="md-nav__link">
  376. <span class="md-ellipsis">
  377. 常见问题
  378. </span>
  379. </a>
  380. </li>
  381. <li class="md-nav__item">
  382. <a href="updates.html" class="md-nav__link">
  383. <span class="md-ellipsis">
  384. 更新日志
  385. </span>
  386. </a>
  387. </li>
  388. <li class="md-nav__item">
  389. <a href="api/index.html" class="md-nav__link">
  390. <span class="md-ellipsis">
  391. 3.x文档
  392. </span>
  393. </a>
  394. </li>
  395. </ul>
  396. </nav>
  397. </div>
  398. </div>
  399. </div>
  400. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  401. <div class="md-sidebar__scrollwrap">
  402. <div class="md-sidebar__inner">
  403. <nav class="md-nav md-nav--secondary" aria-label="目录">
  404. <label class="md-nav__title" for="__toc">
  405. <span class="md-nav__icon md-icon"></span>
  406. 目录
  407. </label>
  408. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  409. <li class="md-nav__item">
  410. <a href="#_1" class="md-nav__link">
  411. <span class="md-ellipsis">
  412. 使用
  413. </span>
  414. </a>
  415. </li>
  416. <li class="md-nav__item">
  417. <a href="#_2" class="md-nav__link">
  418. <span class="md-ellipsis">
  419. 返回结果
  420. </span>
  421. </a>
  422. </li>
  423. </ul>
  424. </nav>
  425. </div>
  426. </div>
  427. </div>
  428. <div class="md-content" data-md-component="content">
  429. <article class="md-content__inner md-typeset">
  430. <h1>使用</h1>
  431. <p>Net是基于<a href="https://github.com/square/okhttp">OkHttp</a>/协程的非侵入式框架(可使用所有Api), 可升级OkHttp版本保持网络安全</p>
  432. <p><br></p>
  433. <p align="center"><strong>STAR/分享可以让更多人参与到本开源项目</strong></p>
  434. <p><br></p>
  435. <div class="admonition note">
  436. <p class="admonition-title">前言</p>
  437. <ol>
  438. <li>阅读文档, 快速了解</li>
  439. <li>阅读示例, 快速运用</li>
  440. <li>阅读源码, 熟练并拓展</li>
  441. </ol>
  442. </div>
  443. <h2 id="_1">使用<a class="headerlink" href="#_1" title="Permanent link">&para;</a></h2>
  444. <p><br>
  445. 发起网络请求的三个步骤</p>
  446. <ol>
  447. <li>创建作用域</li>
  448. <li>发起请求动作</li>
  449. <li>等待数据返回</li>
  450. </ol>
  451. <div class="tabbed-set tabbed-alternate" data-tabs="1:3"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><input id="__tabbed_1_3" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">简单请求</label><label for="__tabbed_1_2">同步请求</label><label for="__tabbed_1_3">并发请求</label></div>
  452. <div class="tabbed-content">
  453. <div class="tabbed-block">
  454. <div class="language-kotlin highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">scopeNetLife</span><span class="w"> </span><span class="p">{</span>
  455. </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="c1">// 大括号内属于作用域</span>
  456. </span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">data</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Get</span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span><span class="p">(</span><span class="n">Api</span><span class="p">.</span><span class="na">USER</span><span class="p">).</span><span class="na">await</span><span class="p">()</span><span class="w"> </span><span class="c1">// 发起GET请求并返回`String`</span>
  457. </span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">}</span>
  458. </span></code></pre></div>
  459. </div>
  460. <div class="tabbed-block">
  461. <div class="language-kotlin highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="n">scopeNetLife</span><span class="w"> </span><span class="p">{</span>
  462. </span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w"> </span><span class="c1">// B将等待A请求返回结果后发起请求</span>
  463. </span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">userInfo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Get</span><span class="o">&lt;</span><span class="n">UserInfo</span><span class="o">&gt;</span><span class="p">(</span><span class="n">Api</span><span class="p">.</span><span class="na">USER</span><span class="p">).</span><span class="na">await</span><span class="p">()</span><span class="w"> </span><span class="c1">// A</span>
  464. </span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>
  465. </span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">config</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Get</span><span class="o">&lt;</span><span class="n">Config</span><span class="o">&gt;</span><span class="p">(</span><span class="n">Api</span><span class="p">.</span><span class="na">CONFIG</span><span class="p">){</span><span class="w"> </span><span class="c1">// B</span>
  466. </span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w"> </span><span class="n">param</span><span class="p">(</span><span class="s">&quot;userId&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">userInfo</span><span class="p">.</span><span class="na">id</span><span class="p">)</span><span class="w"> </span><span class="c1">// 将上个请求结果作为参数</span>
  467. </span><span id="__span-1-7"><a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w"> </span><span class="p">}.</span><span class="na">await</span><span class="p">()</span>
  468. </span><span id="__span-1-8"><a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="p">}</span>
  469. </span></code></pre></div>
  470. </div>
  471. <div class="tabbed-block">
  472. <div class="language-kotlin highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="n">scopeNetLife</span><span class="w"> </span><span class="p">{</span>
  473. </span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w"> </span><span class="c1">// 两个请求同时发起</span>
  474. </span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">getUserInfoAsync</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Get</span><span class="o">&lt;</span><span class="n">UserInfo</span><span class="o">&gt;</span><span class="p">(</span><span class="n">Api</span><span class="p">.</span><span class="na">USER</span><span class="p">)</span>
  475. </span><span id="__span-2-4"><a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">getConfigAsync</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Get</span><span class="o">&lt;</span><span class="n">Config</span><span class="o">&gt;</span><span class="p">(</span><span class="n">Api</span><span class="p">.</span><span class="na">CONFIG</span><span class="p">)</span>
  476. </span><span id="__span-2-5"><a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a>
  477. </span><span id="__span-2-6"><a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">userInfo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">getUserInfoAsync</span><span class="p">.</span><span class="na">await</span><span class="p">()</span><span class="w"> </span><span class="c1">// 等待数据返回</span>
  478. </span><span id="__span-2-7"><a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">config</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">getConfigAsync</span><span class="p">.</span><span class="na">await</span><span class="p">()</span>
  479. </span><span id="__span-2-8"><a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="p">}</span>
  480. </span></code></pre></div>
  481. </div>
  482. </div>
  483. </div>
  484. <ol>
  485. <li>多个网络请求在同一个作用域内可以统一管理</li>
  486. <li>如果多个网络请求之间毫无关联, 可以创建多个作用域来请求</li>
  487. </ol>
  488. <div class="admonition failure">
  489. <p class="admonition-title">强制初始化</p>
  490. <p>多进程或Xposed项目要求先<a href="config.html#_1">初始化</a></p>
  491. </div>
  492. <p>自动识别<code>Url</code>或者<code>Path</code></p>
  493. <div class="language-kotlin highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="n">scopeNetLife</span><span class="w"> </span><span class="p">{</span>
  494. </span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">userInfo</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Get</span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span><span class="p">(</span><span class="s">&quot;/net&quot;</span><span class="p">).</span><span class="na">await</span><span class="p">()</span><span class="w"> </span><span class="c1">// 等于&quot;${NetConfig.host}/net&quot;</span>
  495. </span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">config</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Get</span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span><span class="p">(</span><span class="s">&quot;https://github.com/liangjingkanji/net&quot;</span><span class="p">).</span><span class="na">await</span><span class="p">()</span>
  496. </span><span id="__span-3-4"><a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="p">}</span>
  497. </span></code></pre></div>
  498. <h2 id="_2">返回结果<a class="headerlink" href="#_2" title="Permanent link">&para;</a></h2>
  499. <p>返回结果支持的数据类型(即Post等函数的<code>泛型</code>)由转换器决定, 默认支持以下类型</p>
  500. <table>
  501. <thead>
  502. <tr>
  503. <th>函数</th>
  504. <th>描述</th>
  505. </tr>
  506. </thead>
  507. <tbody>
  508. <tr>
  509. <td>String</td>
  510. <td>字符串</td>
  511. </tr>
  512. <tr>
  513. <td>ByteArray</td>
  514. <td>字节数组</td>
  515. </tr>
  516. <tr>
  517. <td>ByteString</td>
  518. <td>内部定义的一种字符串对象</td>
  519. </tr>
  520. <tr>
  521. <td>Response</td>
  522. <td>最基础的响应</td>
  523. </tr>
  524. <tr>
  525. <td>File</td>
  526. <td>文件对象, 这种情况其实应当称为<a href="download-file.html">下载文件</a></td>
  527. </tr>
  528. </tbody>
  529. </table>
  530. <div class="language-kotlin highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="n">scopeNetLife</span><span class="w"> </span><span class="p">{</span>
  531. </span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="w"> </span><span class="kd">val</span><span class="w"> </span><span class="nv">file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Get</span><span class="o">&lt;</span><span class="n">File</span><span class="o">&gt;</span><span class="p">(</span><span class="n">Api</span><span class="p">.</span><span class="na">FILE</span><span class="p">).</span><span class="na">await</span><span class="p">()</span>
  532. </span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="p">}</span>
  533. </span></code></pre></div>
  534. <p>详细查看<a href="converter.html">转换器</a>, 非以上类型要求<a href="converter-customize.html">自定义转换器</a></p>
  535. <hr />
  536. <p><a class="md-button" href="https://github.com/liangjingkanji/Net/releases/latest/download/net-sample.apk">下载Apk</a>
  537. <a class="md-button" href="https://github.com/liangjingkanji/Net.git">下载源码</a>
  538. <a class="md-button" href="https://github1s.com/liangjingkanji/Net/blob/HEAD/sample/src/main/java/com/drake/net/sample/ui/fragment/RequestMethodFragment.kt">示例代码</a>
  539. <a class="md-button" href="https://github.com/liangjingkanji/BRV">界面演示</a></p>
  540. </article>
  541. </div>
  542. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  543. </div>
  544. <button type="button" class="md-top md-icon" data-md-component="top" hidden>
  545. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
  546. 回到页面顶部
  547. </button>
  548. </main>
  549. <!-- Footer -->
  550. <footer class="md-footer">
  551. <!-- Link to previous and/or next page -->
  552. <nav class="md-footer__inner md-grid" aria-label="footer.title">
  553. <!-- Link to previous page -->
  554. <!-- Link to next page -->
  555. <a href="coroutine-request.html" class="md-footer__link md-footer__link--next" rel="next">
  556. <div class="md-footer__title">
  557. <div class="md-ellipsis">
  558. <span class="md-footer__direction">
  559. 下一页
  560. </span>
  561. 协程请求
  562. </div>
  563. </div>
  564. <div class="md-footer__button md-icon">
  565. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
  566. </div>
  567. </a>
  568. </nav>
  569. <!-- Further information -->
  570. <div class="md-footer-meta md-typeset">
  571. <div class="md-footer-meta__inner md-grid">
  572. <!-- Copyright and theme information -->
  573. <div class="md-footer-copyright">
  574. <a href="https://github.com/liangjingkanji" target="_blank" rel="noopener">
  575. <div class="md-footer-copyright__highlight">
  576. Copyright &copy; 2018 - 2023 劉強東
  577. </div>
  578. </a>
  579. </div>
  580. <!-- Social links -->
  581. <div class="md-social">
  582. <a href="https://github.com/liangjingkanji" target="_blank" rel="noopener" title="github.com" class="md-social__link">
  583. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
  584. </a>
  585. <a href="https://raw.githubusercontent.com/liangjingkanji/liangjingkanji/master/img/group-qrcode.png" target="_blank" rel="noopener" title="raw.githubusercontent.com" class="md-social__link">
  586. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M433.754 420.445c-11.526 1.393-44.86-52.741-44.86-52.741 0 31.345-16.136 72.247-51.051 101.786 16.842 5.192 54.843 19.167 45.803 34.421-7.316 12.343-125.51 7.881-159.632 4.037-34.122 3.844-152.316 8.306-159.632-4.037-9.045-15.25 28.918-29.214 45.783-34.415-34.92-29.539-51.059-70.445-51.059-101.792 0 0-33.334 54.134-44.859 52.741-5.37-.65-12.424-29.644 9.347-99.704 10.261-33.024 21.995-60.478 40.144-105.779C60.683 98.063 108.982.006 224 0c113.737.006 163.156 96.133 160.264 214.963 18.118 45.223 29.912 72.85 40.144 105.778 21.768 70.06 14.716 99.053 9.346 99.704"/></svg>
  587. </a>
  588. <a href="https://github.com/liangjingkanji/Net/discussions" target="_blank" rel="noopener" title="github.com" class="md-social__link">
  589. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M391.17 103.47h-38.63v109.7h38.63ZM285 103h-38.63v109.75H285ZM120.83 0 24.31 91.42v329.16h115.83V512l96.53-91.42h77.25L487.69 256V0Zm328.24 237.75-77.22 73.12h-77.24l-67.6 64v-64h-86.87V36.58h308.93Z"/></svg>
  590. </a>
  591. </div>
  592. </div>
  593. </div>
  594. </footer>
  595. </div>
  596. <div class="md-dialog" data-md-component="dialog">
  597. <div class="md-dialog__inner md-typeset"></div>
  598. </div>
  599. <script id="__config" type="application/json">{"base": ".", "features": ["navigation.top", "navigation.prune", "navigation.footer", "navigation.instant", "search.highlight", "search.suggest", "search.share", "content.code.copy", "content.code.annotate"], "search": "assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "\u5df2\u590d\u5236", "clipboard.copy": "\u590d\u5236", "search.result.more.one": "\u5728\u8be5\u9875\u4e0a\u8fd8\u6709 1 \u4e2a\u7b26\u5408\u6761\u4ef6\u7684\u7ed3\u679c", "search.result.more.other": "\u5728\u8be5\u9875\u4e0a\u8fd8\u6709 # \u4e2a\u7b26\u5408\u6761\u4ef6\u7684\u7ed3\u679c", "search.result.none": "\u6ca1\u6709\u627e\u5230\u7b26\u5408\u6761\u4ef6\u7684\u7ed3\u679c", "search.result.one": "\u627e\u5230 1 \u4e2a\u7b26\u5408\u6761\u4ef6\u7684\u7ed3\u679c", "search.result.other": "# \u4e2a\u7b26\u5408\u6761\u4ef6\u7684\u7ed3\u679c", "search.result.placeholder": "\u952e\u5165\u4ee5\u5f00\u59cb\u641c\u7d22", "search.result.term.missing": "\u7f3a\u5c11", "select.version": "\u9009\u62e9\u5f53\u524d\u7248\u672c"}}</script>
  600. <script src="assets/javascripts/bundle.83f73b43.min.js"></script>
  601. </body>
  602. </html>