A android http library
类库开发目的主要是以下三点
- 1.使用接口的方式定义API接口, 思路来源于Retrofit
- 2.实现Http结果的自动解析（使用ResponseParser接口）
- 3.隔离对Http具体实现类库的依赖，方便替换（目前类库中有OkLite,URLConnectionLite两种实现，对应okhttp和系统URLConnection实现）
- Gradle
使用okhttp 2.7.5作为http实现
compile 'alexclin.httplite:httplite-okhttp2:1.0.1'
使用okhttp 3.2.0作为http实现
compile 'alexclin.httplite:httplite-okhttp3:1.0.1'
使用系统URLConnection作为http实现
compile 'alexclin.httplite:httplite-url:1.0.1'
或者直接使用releaselib中的jar包
- 1 okhttp2: httplite1.0.1.jar+httplite-ok2lite1.0.1.jar+okhttp 2.x.x版本jar包
- 2 okhttp3: httplite1.0.1.jar+httplite-ok3lite1.0.1.jar+okhttp 3.x.x版本jar包
- 3 url: httplite1.0.1.jar+httplite-urlite1.0.1.jar
使用接口+注解的方式来定义API接口, 思路来源于Retrofit，具体实现稍有不同
Demo中的API接口定义
@BaseURL("http://192.168.99.238:10080/")
public interface ApiService {
@POST("/login")
void login(
@JsonField("username") String userName,
@JsonField("password")String password,
@JsonField("token") String token,
@Tag Object tag,
Callback<Result<UserInfo>> callback
);
@GET("http://www.baidu.com")
void testBaidu(Callback<String> callback);
@GET("http://news-at.zhihu.com/api/4/news/latest")
void testZhihu(Callback<ZhihuData> callback);
@GET("/download/{test_holder}")
DownloadHandle downdloadFile(
@Path("test_holder") String holder,
@Param("param1") String param1,
@Param("param2") String param2,
@IntoFile String path,
@Progress ProgressListener progressListener,
@Retry RetryListener retryListener,
Callback<File> callback
);
@GET( "http://news-at.zhihu.com/api/4/news/latest")
ZhihuData syncZhihu(Clazz<ZhihuData> clazz) throws Exception;
@HTTP(method = Method.POST,path = "/dosomething/{some_path}")
void doSomething(
@Path("some_path") String holder,
@Param("param1") String param1,
@Param("param2") String param2,
@Form("form_f1") String form_f1,
@Tag Object tag,
Callback<Result<RequestInfo>> callback
);
@HTTP(method = Method.POST,path = "/dosomething/{some_path}")
Result<RequestInfo> doSomethingSync(
@Path("some_path") String holder,
@Param("param1") String param1,
@Param("param2") String param2,
@Form("form_f1") String form_f1,
@Tag Object tag,
Clazz<Result<RequestInfo>> clazz
) throws Exception;
@HTTP(method = Method.PUT,path = "put/{holde_test}")
void putJsonBody(
@Path("holde_test") String holder,
@JsonField("field1") String field1,
@JsonField("field2") String field2,
@JsonField("field3") String field3,
Callback<ExRequestInfo> callback
);
@GET("/download/{test_holder}")
DownloadHandle downdloadFile(
@Path("test_holder") String holder,
@Param("param1") String param1,
@Param("param2") String param2,
@IntoFile String path,
@Progress @Retry MergeCallback<File> callback
);
}
替换依赖只用替换如下部分即可
HttpLiteBuilder builder = Ok2Lite.create(); //okhttp2作为http实现类库，推荐
//或者
HttpLiteBuilder builder = Ok3Lite.create(); //okhttp3作为http实现类库，推荐
//或者
HttpLiteBuilder builder = URLite.create(); //使用URLConnection实现的http配置并创建HttpLite
builder = builder.setConnectTimeout(3, TimeUnit.SECONDS) //设置连接超时
.setWriteTimeout(3, TimeUnit.SECONDS) //设置写超时
.setReadTimeout(3, TimeUnit.SECONDS) //设置读超市
.setMaxRetryCount(2) //设置失败重试次数
.setFollowRedirects(true) //设置是否sFollowRedirects,默认false
.setFollowSslRedirects(true) //设置是否setFollowSslRedirects
.setProxy(...)
.setProxySelector(...)
.setSocketFactory(...)
.setSslSocketFactory(...)
.setHostnameVerifier(..)
.baseUrl("http://xxx.xxx.xxx") //BaseUrl,用于拼接完整的Url
.useCookie(...) //设置CookieStore,设置则启用Cookie,不设置则不启用
.setRelease(false) //设置是否是Release状态，是Release状态会关闭对接口函数定义的检查，提升效率
.addResponseParser(new JacksonParser()); //添加ResponseParser实现结果解析
.requestFilter(new RequestFilter() {
@Override
public void onRequest(HttpLite lite,Request request, Type type) {
request.header("handle","misc");
}
})； //对所有请求进行监听，做某些处理
//正常使用状态
Httplite httpLite = builder.build();
//本地模拟模式
httpLite = builder.mock(new MockHandler() {
@Override
public <T> void mock(Request request, Mock<T> mock) throws Exception {
// mock.mockProgress(long current,long total); //模拟进度调用
// mock.mockRetry(long current,long max); //模拟重试调用
//TODO 模拟网络数据
// mock.mock(Response response);//模拟原生Response
// mock.mockJson(....);
// mock.mock(new File("...."))；
// mock.mock(T result,Map<String, List<String>> headers);//直接模拟解析结果
}
@Override
public boolean needMock(Request request) {
//TODO 判断该请求是否需要Mock
return true;
}
});创建API接口实例
ApiService apiService = httpLite.retrofit(ApiService.class);
//然后就可以使用API接口了，比如
apiService.testBaidu(new Callback<String>() {
@Override
public void onSuccess(String result, Map<String, List<String>> headers) {
LogUtil.e("BaiduResult:" + result);
}
@Override
public void onFailed(Request req, Exception e) {
LogUtil.e("OnFailed", e);
}
});
具体测试代码详见代码中RetrofitFrag类
- 1.使用注解定义的API接口函数在调用时，会忽略掉所有传入的null参数，建议develop时对方法调用和参数做监听，可以通过设置MethodListener来实现
httplite.getRetrofit().setMethodListener(MethodListener methodListener);
- 2.Release版本请设置HttpLiteBuilder.setRelease(true)，创建的HttpLite和对应的Retrofit会关闭接口Annotation的定义检查（develop时请打开），减少因对接口注解使用正确性检查行带来的性能消耗
ParameterProcessor/ParamMiscProcessor 实现对参数注解的检查和处理
MethodProcessor 实现对方法注解的检查和处理
AnnotationRule 定义对整个方法的注解和参数的检查处理
Retrofit.registerParamterProcessor(ParameterProcessor processor)；
Retrofit.registerParamMiscProcessor(ParamMiscProcessor processor);
Retrofit.registerMethodProcessor(MethodProcessor processor);
Retrofit.registerAnnotationRule(AnnotationRule rule);
具体自定义使用请参考BasicAnnotationRule/BasicProcessors/ProcessorFactory源码
解析String返回结果
httpLite.url("http://www.baidu.com").get().execute(new Callback<String>() {
@Override
public void onSuccess(String result) {
mInfoTv.setText(result);
}
@Override
public void onFailed(Request req, Exception e) {
mInfoTv.setText("Error:"+e);
}
});解析类对象
httpLite.url("http://news-at.zhihu.com/api/4/news/latest").get().execute(new Callback<ZhihuData>() {
@Override
public void onSuccess(ZhihuData result) {
LogUtil.e("Result:"+result);
mInfoTv.setText("Rsult:"+result);
}
@Override
public void onFailed(Request req, Exception e) {
e.printStackTrace();
mInfoTv.setText("Error:"+e);
}
});- 1.默认支持String的解析，但是类对象结果的解析需要使用httpLite.addResponseParser()提供至少一个解析器
- 2.当传入Callback<Response>时，Callback的调用是工作线程，其他情况下均为主线程，可以直接进行设置View显示等操作
ResponseParser接口定义如下：
public interface ResponseParser {
boolean isSupported(Type type);
<T> T praseResponse(Response response, Type type) throws Exception;
}可以通过实现此接口解析Json,XML或者二进制流为对象的功能
demo模块app中分别有使用Jackson,FastJson,Gson实现Json解析，通过继承StringParser实现。
public abstract class StringParser implements ResponseParser{
@Override
public final <T> T praseResponse(Response response, Type type) throws Exception{
return praseResponse(HttpCallback.decodeResponseToString(response),type);
}
public abstract <T> T praseResponse(String content, Type type) throws Exception;
}