1 Star 2 Fork 0

pichs / xhttp

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

XHttp

引入控件

最新版本:

    // 引入方案 一 (推荐)
    // 1、完全体 (直接全引入)
    implementation 'com.gitee.pichs:xhttp:4.0.0'

    或者
    // 引入方案 二, 用了方案一就不要再用二了。
    // 2.1 只要http (必选)
    implementation 'com.gitee.pichs.xhttp:http:4.0.0'
    // 2.2 添加downloader下载管理器(可选)
    implementation 'com.gitee.pichs.xhttp:downloader:4.0.0'

理由

  • 为啥基于okgo
  1. 用过市面上所有的网络开源框架,最终选择了okgo,
  2. 主要是稳定性和易用性:架构的非常妙,值得学习!
  3. 支持的请求非常全,ssl自定义等还支持下载管理器(一条龙),可见作者花了很大的心思,值得借鉴。

声明

  • 想用的话自己去使用okgo吧,请尊重(okgo)作者,虽然多年未更新该库,但是框架确是很优秀。
  • 吾不想如果优秀的框架沉沦,所以在源码中修改(包括更改api包名路径,类名等。)
  • 升级okhttp网络库版本至最新。
  • okgo本身稳定性兼容性极好,非常适合在大型项目中使用。
  • 但是本身api的调用当时相对于retrofit2又显得过于臃肿,需要写过多代码,
  • 很难配合协程做到很优雅的实现。
  • 所以突发奇想,结合retrofit2的设计思想在 okgo的基础上进行二次开发
  • retrofit2随使用做到极简,但稳定性,错误回调等(虽说可以统一json,但是不是所有api都是同一套json格式,有些项目后端api很杂,很不统一)处理却没那么友好。
  1. 保证稳定性,兼容性
  2. 使用方式变得想retrofit2那么简单
  3. 支持协程,更轻松的调用。像retrofit2那样
  4. xxx其他待思考。
  • 总之以稳定,兼容为主,简单易用,接口易维护为辅,形成一套舒服的框架。
  • 我观察了其他框架rxhttp,easyhttp等,总有那么一点不尽人意的地方。
  • 索性自己搞一套得了。企业开发,还是得注重一下基础库的选择,搞不好就是屎山代码。

介绍

  • 此框架支持 get,post,delete,patch,put,options,trace,head八中请求方式,
  • 额外封装了upload,download 两个方式,更方便精准使用,带进度回调
  • 链式调用爽翻天
  • params("key","value") 添加请求体
  • header("key","value") 添加请求头
  • asJson() 是否作为json格式上传,默认xxx-form-urlencoder格式
  • 开起asJson, 请求参数 为 application/json; utf-8 格式

用法,普通请求

     // 在application的onCreate中初始化
      // 第二个参数是否开启日志,默认false            
      XHttp.init(this, true);

    // 设置全局公共参数,请求头,和请求参数
    // 利用接口实现,每次都会执行commonHeaders(),commonParams()这俩方法,不用担心token更新不到的情况
    // 可以放在application中初始化,也可以放到喜欢的地方,该方法也可以调用多次,以最后一次为准。
    XHttp.addHttpCommons(new IHttpCommons() {
        @Override
        public Map<String, String> commonHeaders() {
            Log.d("啊啊啊啊啊", "commonHeaders----6666");
            return null;
        }

        @Override
        public Map<String, Object> commonParams() {
            Log.d("啊啊啊啊啊", "commonParams----7777");
            return null;
        }
    });
    
    // post请求
    XHttp
            .post("https://www.qq.com")
            .header("aaa","aaa")
            .param("key", "我是大神仙")
            .cacheTime(100000)
            .cacheKey("阿萨德解放啦圣诞节福利")
            .cacheMode(HttpCacheMode.REQUEST_FAILED_READ_CACHE)
            .asJson()
            .execute(new StringCallBack() {
                @Override
                public void onSuccess(int status, String result) {
                    ToastUtils.toast(mActivity, "status:" + status + ", result:" + result);
                }

                @Override
                public void onFailure(HttpError error) {
                    ToastUtils.toast(mActivity, "error:" + error.toString());
                }
            });
      XHttp
            .upload("")
            .upFile(new File(""))
            .execute(new FileCallBack() {

                @Override
                public void onComplete(@Nullable File file) {

                }

                @Override
                public void onProgress(HttpProgress progress) {

                }

                @Override
                public void onFailure(HttpError error) {

                }
            });

    XHttp
        .download("")
        .fileFolder("")
        .fileName("")
        .execute(new FileCallBack() {
                @Override
                public void onComplete(@Nullable File file) {

                }

                @Override
                public void onProgress(HttpProgress progress) {

                }

                @Override
                public void onFailure(HttpError error) {

                }
            });

断点续传下载,上传

```kotlin
      //  上传文件伪代码
        XUpload.upload<String>("tag", "", File(""))
            .register(object : UploadListener<String>("a") {
                override fun onProgress(progress: Progress?) {
                }

                override fun onFinish(t: String?, progress: Progress?) {
                }

                override fun onStart(progress: Progress?) {

                }

                override fun onError(progress: Progress?) {
                }

                override fun onRemove(progress: Progress?) {
                }
            })
            .save() 
            .start()

        // 下载文件代码
        XDownload
            .download(url, url)
            .fileName("哔哩哔哩.apk")
            .register(object : DownloadListener(url) {
                override fun onStart(progress: Progress?) {
                }

                override fun onProgress(progress: Progress?) {
                    progress?.let {
                        binding.tvResult.text = "下载进度:${((progress.currentSize.toFloat() * 100) / progress.totalSize)}%"
                    }
                }

                override fun onError(progress: Progress?) {
                }

                override fun onFinish(t: File?, progress: Progress?) {
                    binding.tvResult.text = "下载完成:文件路径:${t?.absolutePath}"
                }

                override fun onRemove(progress: Progress?) {
                }

            })  
            .save() 
            .start()



```

升级日志

  1. v4.0.0 上传下载api修改,网络请求api修改(破坏性升级) (推荐)

  2. v3.0.1 代码合入,自己维护。

  3. v2.0.0 优化兼容,升级okhttp

  4. v1.0 基于OkHttp3进行的封装

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

网络请求库 展开 收起
Java 等 2 种语言
Apache-2.0
取消

发行版 (8)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/pichs/xhttp.git
git@gitee.com:pichs/xhttp.git
pichs
xhttp
xhttp
master

搜索帮助