NoHttp框架

Posted 2020-08-06 星空守候

NoHttp框架

框架简介

开源地址https://github.com/yanzhenjie/NoHttp

• NoHttp实现了Http1.1（RFC2616），一个标准的Http框架。
• 请求和下载都是队列，平均分配每个线程的资源，支持多个请求并发。
• 支持GET、POST、PUT、PATCH、HEAD、DELETE、OPTIONS、TRACE等请求协议。
• 支持基于POST、PUT、PATCH、DELETE的文件上传（html表单原理）。
• 文件下载、上传下载、上传和下载的进度回调、错误回调。
• 提供了五种数据缓存策略供开发者选择使用（详细看下文）。
• 支持取消某个请求、取消指定多个请求、取消所有请求。
• 支持自定义Request，利用NoHttp泛型可以解析成你想要的任何数据格式（String、Json、JavaBean等）。
• 支持Session、Cookie的自动维持，App重启、关开机后还持续维持。
• 支持Https、自签名网站Https的访问、支持双向验证。

使用前配置

项目倒入

1. compile ‘com.yolanda.nohttp:nohttp:1.0.5‘

需要的权限

1. <uses-permissionandroid:name="android.permission.READ_EXTERNAL_STORAGE"/>
2. <uses-permissionandroid:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
3. <uses-permissionandroid:name="android.permission.INTERNET"/>
4. <uses-permissionandroid:name="android.permission.ACCESS_NETWORK_STATE"/>
5. <uses-permissionandroid:name="android.permission.ACCESS_WIFI_STATE"/>

初始化

1. @Override
2. publicvoid onCreate(){
3. super.onCreate();
4. // 初始化NoHttp
5. NoHttp.init(this);
6. // 开启调试模式
7. Logger.setDebug(true);
8. Logger.setTag("NoHttpSample");
9. }

使用详解

使用详情可参考官方文档 http://api.nohttp.net/

Demo示例

• 封装结果回调对象OnResponseListener
  NoHttp的接受结果是用OnResponseListener接口回调，为了方便使用，对它进行做简单封装，请求开始时显示dialog, 请求完成时关闭这个dialog：

1. publicclassHttpResponseListener<T>implementsOnResponseListener<T>{
2. /**
3. * Dialog
4. */
5. privateWaitDialog mWaitDialog;
6. /**
7. * 当前请求
8. */
9. privateRequest<T> mRequest;
10. /**
11. * 结果回调
12. */
13. privateHttpListener<T> callback;
14. /**
15. * 是否显示dialog
16. */
17. privateActivity context;
19. /**
20. * @param context context用来实例化dialog
21. * @param request 请求对象
22. * @param httpCallback 回调对象
23. * @param canCancel 是否允许用户取消请求
24. * @param isLoading 是否显示dialog
25. */
26. publicHttpResponseListener(Activity context,Request<T> request,HttpListener<T> httpCallback,boolean canCancel,boolean isLoading){
27. this.context = context;
28. this.mRequest = request;
29. if(isLoading){// 需要显示dialog
30. mWaitDialog =newWaitDialog(context);
31. mWaitDialog.setCancelable(canCancel);
32. mWaitDialog.setOnCancelListener(newDialogInterface.OnCancelListener(){
33. @Override
34. publicvoid onCancel(DialogInterface dialog){
35. mRequest.cancel();// dialog被用户关闭时, 取消当前请求
36. }
37. });
38. }
39. this.callback = httpCallback;
40. this.isLoading = isLoading;
41. }
42. /**
43. * 开始请求, 这里显示一个dialog
44. */
45. @Override
46. publicvoid onStart(int what){
47. if(!context.isFinishing && mWaitDialog !=null&&!mWaitDialog.isShowing())
48. mWaitDialog.show();
49. }
50. /**
51. * 结束请求, 这里关闭dialog
52. */
53. @Override
54. publicvoid onFinish(int what){
55. if(mWaitDialog !=null&& mWaitDialog.isShowing())
56. mWaitDialog.dismiss();
57. }
58. /**
59. * 成功回调
60. */
61. @Override
62. publicvoid onSucceed(int what,Response<T> response){
63. if(callback !=null)
64. callback.onSucceed(what, response);
65. }
66. /**
67. * 失败回调
68. */
69. @Override
70. publicvoid onFailed(int what,Response<T> response){
71. if(callback !=null)
72. callback.onFailed(what, response);
73. }
74. }

• 定义HttpListener接口, 接受请求结果

1. publicinterfaceHttpListener<T>{
2. /**
3. * 请求失败
4. */
5. void onSucceed(int what,Response<T> response);
6. /**
7. * 请求成功
8. */
9. void onFailed(int what,Response<T> response);
10. }

• 封装请求入口, 单例模式

看到这里有人可能开始有点迷惑了，不是需要OnResponseListener对象嘛，现在HttpListener怎么用啊？可观别急，我们继续看下面请求入口的封装。
因为NoHttp是队列的请求方式，方便开发者控制并发和线程数量，而NoHttp生成队列都是newInstance，每次都是一个新的队列对象，所以生成的Queue都需要做单列，请看：

1. publicclassCallServer{
2. privatestaticCallServer callServer;
4. /**
5. * 请求队列
6. */
7. privateRequestQueue requestQueue;
9. privateCallServer(){
10. requestQueue =NoHttp.newRequestQueue();
11. }
13. /**
14. * 请求队列
15. */
16. publicsynchronizedstaticCallServer getRequestInstance(){
17. if(callServer ==null)
18. callServer =newCallServer();
19. return callServer;
20. }
22. /**
23. * 添加一个请求到请求队列
24. *
25. * @param context context用来实例化dialog
26. * @param what 用来标志请求，在回调方法中会返回这个what，类似handler的what
27. * @param request 请求对象
28. * @param callback 结果回调对象
29. * @param canCancel 是否允许用户取消请求
30. * @param isLoading 是否显示dialog
31. */
32. public<T>void add(Context context,int what,Request<T> request,HttpListener<T> callback,boolean canCancel,boolean isLoading){
33. requestQueue.add(what, request,newHttpResponseListener<T>(context, request, callback, canCancel, isLoading));
34. }
36. /**
37. * 取消这个sign标记的所有请求
38. */
39. publicvoid cancelBySign(Object sign){
40. requestQueue.cancelBySign(sign);
41. }
43. /**
44. * 取消队列中所有请求
45. */
46. publicvoid cancelAll(){
47. requestQueue.cancelAll();
48. }
50. /**
51. * 退出app时停止所有请求
52. */
53. publicvoid stopAll(){
54. requestQueue.stop();
55. }
56. }

• 如何使用

1. /**
2. * 发起请求
3. */
4. privatevoid requestString(){
5. Request<String> request =NoHttp.createStringRequest(Constants.URL_NOHTTP_CACHE_STRING);
6. CallServer.getRequestInstance().add(this,0, request, httpListener,false,true);
7. }
9. /**
10. * 接受响应
11. */
12. privateHttpListener<String> httpListener =newHttpListener<String>(){
13. @Override
14. publicvoid onSucceed(int what,Response<String> response){
15. // 拿到请求结果
16. String result = response.get();
17. ...
18. }
20. @Override
21. publicvoid onFailed(int what,Response<String> response){
22. Toast.show("请求失败");
23. }
24. };

来自为知笔记(Wiz)