MOBFHttpService.h 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222
  1. //
  2. // MOBFHttpService.h
  3. // MOBFoundation
  4. //
  5. // Created by vimfung on 15-1-20.
  6. // Copyright (c) 2015年 MOB. All rights reserved.
  7. //
  8. #import <Foundation/Foundation.h>
  9. @class MOBFHttpService;
  10. /**
  11. * GET方式
  12. */
  13. extern NSString *const kMOBFHttpMethodGet;
  14. /**
  15. * POST方式
  16. */
  17. extern NSString *const kMOBFHttpMethodPost;
  18. /**
  19. * DELETE方式
  20. */
  21. extern NSString *const kMOBFHttpMethodDelete;
  22. /**
  23. * HEAD方式
  24. */
  25. extern NSString *const kMOBFHttpMethodHead;
  26. /**
  27. * HTTP返回事件
  28. *
  29. * @param response 回复对象
  30. * @param responseData 回复数据
  31. */
  32. typedef void(^MOBFHttpResultEvent) (NSHTTPURLResponse *response, NSData *responseData);
  33. /**
  34. * HTTP错误事件
  35. *
  36. * @param error 错误信息
  37. */
  38. typedef void(^MOBFHttpFaultEvent) (NSError *error);
  39. /**
  40. * HTTP上传数据事件
  41. *
  42. * @param totalBytes 总字节数
  43. * @param loadedBytes 上传字节数据
  44. */
  45. typedef void(^MOBFHttpUploadProgressEvent) (int64_t totalBytes, int64_t loadedBytes);
  46. /**
  47. * HTTP服务类
  48. */
  49. @interface MOBFHttpService : NSObject
  50. /**
  51. * @brief 提交方式,默认为GET
  52. */
  53. @property (nonatomic, copy) NSString *method;
  54. /**
  55. 超时时间
  56. */
  57. @property (nonatomic) NSTimeInterval timeout;
  58. /**
  59. * @brief 是否缓存回复对象,默认为YES
  60. */
  61. @property (nonatomic) BOOL isCacheResponse;
  62. /**
  63. * 自动填充请求表单,默认为YES,如果为NO则表示使用自定义的方式发起请求。
  64. */
  65. @property (nonatomic) BOOL autoFillRequestForm;
  66. /**
  67. * 初始化HTTP服务
  68. *
  69. * @param urlString URL地址字符串
  70. *
  71. * @return HTTP服务对象
  72. */
  73. - (id)initWithURLString:(NSString *)urlString;
  74. /**
  75. * 初始化HTTP服务
  76. *
  77. * @param URL URL地址对象
  78. *
  79. * @return HTTP服务对象
  80. */
  81. - (id)initWithURL:(NSURL *)URL;
  82. /**
  83. * 初始化HTTP服务
  84. *
  85. * @param request 请求对象
  86. *
  87. * @return HTTP服务对象
  88. */
  89. - (id)initWithRequest:(NSURLRequest *)request;
  90. /**
  91. * 添加HTTP头
  92. *
  93. * @param header 名称
  94. * @param value 值
  95. */
  96. - (void)addHeader:(NSString *)header value:(NSString *)value;
  97. /**
  98. * 添加HTTP头集合
  99. *
  100. * @param headers 头集合
  101. */
  102. - (void)addHeaders:(NSDictionary *)headers;
  103. /**
  104. * 添加参数
  105. *
  106. * @param value 参数值
  107. * @param key 参数名字
  108. */
  109. - (void)addParameter:(id)value forKey:(NSString *)key;
  110. /**
  111. * 添加多个参数
  112. *
  113. * @param parameters 参数集合
  114. */
  115. - (void)addParameters:(NSDictionary *)parameters;
  116. /**
  117. * 添加上传文件参数
  118. *
  119. * @param fileData 文件数据
  120. * @param fileName 文件名称
  121. * @param mimeType MIME类型
  122. * @param transferEncoding 传输编码
  123. * @param key 参数名字
  124. */
  125. - (void)addFileParameter:(NSData *)fileData
  126. fileName:(NSString *)fileName
  127. mimeType:(NSString *)mimeType
  128. transferEncoding:(NSString *)transferEncoding
  129. forKey:(NSString *)key;
  130. /**
  131. * 设置请求体数据,可以为NSData或者NSInputStream
  132. *
  133. * @param body 请求体数据
  134. */
  135. - (void)setBody:(id)body;
  136. /**
  137. * 发送请求
  138. *
  139. * @param resultHandler 返回回调
  140. * @param faultHandler 错误回调
  141. * @param uploadProgressHandler 上传数据进度回调
  142. */
  143. - (void)sendRequestOnResult:(MOBFHttpResultEvent)resultHandler
  144. onFault:(MOBFHttpFaultEvent)faultHandler
  145. onUploadProgress:(MOBFHttpUploadProgressEvent)uploadProgressHandler;
  146. /**
  147. * 取消请求
  148. */
  149. - (void)cancelRequest;
  150. /**
  151. * 发送HTTP请求
  152. *
  153. * @param urlString 请求地址
  154. * @param method 请求方式
  155. * @param parameters 请求参数
  156. * @param headers 请求头集合
  157. * @param resultHandler 返回回调
  158. * @param faultHandler 错误回调
  159. * @param uploadProgressHandler 上传数据进度回调
  160. *
  161. * @return HTTP服务对象
  162. */
  163. + (MOBFHttpService *)sendHttpRequestByURLString:(NSString *)urlString
  164. method:(NSString *)method
  165. parameters:(NSDictionary *)parameters
  166. headers:(NSDictionary *)headers
  167. onResult:(MOBFHttpResultEvent)resultHandler
  168. onFault:(MOBFHttpFaultEvent)faultHandler
  169. onUploadProgress:(MOBFHttpUploadProgressEvent)uploadProgressHandler;
  170. /**
  171. * 发送HTTP请求
  172. *
  173. * @param urlString 请求地址
  174. * @param method 请求方式
  175. * @param parameters 请求参数
  176. * @param headers 请求头集合
  177. * @param timeout 请求超时
  178. * @param resultHandler 返回回调
  179. * @param faultHandler 错误回调
  180. * @param uploadProgressHandler 上传数据进度回调
  181. *
  182. * @return HTTP服务对象
  183. */
  184. + (MOBFHttpService *)sendHttpRequestByURLString:(NSString *)urlString
  185. method:(NSString *)method
  186. parameters:(NSDictionary *)parameters
  187. headers:(NSDictionary *)headers
  188. timeout:(NSTimeInterval)timeout
  189. onResult:(MOBFHttpResultEvent)resultHandler
  190. onFault:(MOBFHttpFaultEvent)faultHandler
  191. onUploadProgress:(MOBFHttpUploadProgressEvent)uploadProgressHandler;
  192. @end