前言
在我之前博客自定义retrofit框架（三） 讲解了使用编译时注解处理请求的实现，这篇博客介绍通过这种方法所封装的库L-Http
gradle方式引入
implementation 'com.lu.lib:lhttp:1.0'
annotationProcessor 'com.lu.lib:lhttp-processor:1.0'
简单使用
- 初始化
okhttpclient
public class BaseApp extends Application {
@Override
public void onCreate() {
super.onCreate();
//在这里可以自定义OkHttpClient的实现，OkHttpClient的配置可自行百度
OkClient.getInstance().init(new OkHttpClient());
}
}
- 定义接口
- 每个网络请求都要用
@ApiService注解标注 - 每个方法都需要使用
@LRequest("login")标注
@ApiService
public interface UserService {
@LRequest("login")
Observable<HttpResult<UserInfo>> login(
@Param("name") String name,
@Param("password") String password);
//get请求
@LRequest(value = "login",method = LMethod.GET)
Observable<HttpResult<User>> getLogin(@Param("username") String username
, @Param("password") String password);
}
- build工程会在目录
/build/generated/source/apt下生成实现类UserServiceImpl,实现类的构造方法需要一个String类型参数baseurl，即接口的基础地址，实现类的具体代码不贴出，可以自行查看
代码中使用
//实例化一个对象，通常这个可以设计为单例模式
UserService service = new UserServiceImpl("basr-url");//入参填写域名
//默认的post方式
service.login("luqihua","123456")
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Consumer<HttpResult<UserInfo>>() {
@Override
public void accept(HttpResult<UserInfo> userInfoHttpResult) throws Exception {
}
});
//get方式请求
service.getLogin("luqihua", "hello")
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Consumer<HttpResult<UserInfo>>() {
@Override
public void accept(HttpResult<UserInfo> userInfoHttpResult) throws Exception {
}
});
API介绍
@ApiService
作用在接口之上，只有标记了该注解，注解处理器才会去处理生成实现类
-
@LRequest注解
该注解是用来标注方法是一个网络请求，它有三个参数
-
value（必须填写） 网络请求路径，可以是全路径如http://www.baidu.com/login，也可以是相对路径login,在这种情况下,初始化的baseurl应该是http://www.baidu.com/, -
type（默认值为ContextType.FORM）网络请求的类型 ，可选值为1:ContextType.FORM表单请求，ContextType.JSONjson请求，ContextType.MULTIPART文件类型表单，可以上传键值对和文件 -
method(默认LMethod.POST)请求方法，可选值LMethod.GET和LMethod.POST
-
@Param和@ParamMap
@Param用于注解单个String参数@ParamMap用于注解Map<String,String>的键值对集合
@Header
标注参数为请求头信息
@Body
该注解需要配合
ContextType.JSON才有效，标注参数对象为请求体
-
@FileParam和@FileMap
@FileParam用于标记单个的File对象，@FileMap用于标记Map<String,File>的文件集合，要传入这两个参数，必须配合``ContextType.MULTIPART`才有效
拓展性
自定义请求的实现
@RequestWrapper
这个注解很重要，如果仔细看过代码生成的实现类会发现实现类内部有一个
HttpRequest,每个请求实际上都是通过这个类发起的，该类的代码如下
public class HttpRequest implements IRequestWrapper<Observable<?>> {
private static Gson sGson = new Gson();
@Override
public Observable<?> form(final String url,
final Enum<LMethod> method,
Map<String, String> headers,
Map<String, String> params,
final Type type) {
return new FormRequest()
.url(url)
.params(params)
.headers(headers)
.method(method)
.observerResponseBody()
.map(new Function<ResponseBody, Object>() {
@Override
public Object apply(ResponseBody responseBody) throws Exception {
Object o = sGson.fromJson(responseBody.string(), type);
return o;
}
});
}
@Override
public Observable<?> json(final String url,
Map<String, String> headers,
Map<String, String> params,
Object jsonBody,
final Type type) {
return new JsonRequest()
.url(url)
.headers(headers)
.params(params)
.addJsonBody(jsonBody)
.observerResponseBody()
.map(new Function<ResponseBody, Object>() {
@Override
public Object apply(ResponseBody responseBody) throws Exception {
Object o = sGson.fromJson(responseBody.string(), type);
return o;
}
});
}
@Override
public Observable<?> multipart(final String url,
Map<String, String> headers,
Map<String, String> params,
Map<String, File> files,
IProgressListener listener,
final Type type) {
return new MultiPartRequest()
.url(url)
.headers(headers)
.params(params)
.files(files)
.progress(listener)
.observerResponseBody()
.map(new Function<ResponseBody, Object>() {
@Override
public Object apply(ResponseBody responseBody) throws Exception {
Object o = sGson.fromJson(responseBody.string(), type);
return o;
}
});
}
}
具体的请求我用自己
封装的okhttp进行请求，如果不想使用我封装的这种格式，可以自定义:
- 创建一个类
MyHttpRequest
//必须打上这个注解，同时必须实现接口IRequestWrapper，这是为了实现方法的统一性
@ RequestWrapper
public class MyHttpRequest implements IRequestWrapper<Observable<?>> {
private static Gson sGson = new Gson();
@Override
public Observable<?> form(final String url,
final Enum<LMethod> method,
Map<String, String> headers,
Map<String, String> params,
final Type type) {
//自己实现具体的form表单请求，但必须结合rxjava返回
}
@Override
public Observable<?> json(final String url,
Map<String, String> headers,
Map<String, String> params,
Object jsonBody,
final Type type) {
//自己实现具体的json请求，但必须结合rxjava返回
}
@Override
public Observable<?> multipart(final String url,
Map<String, String> headers,
Map<String, String> params,
Map<String, File> files,
IProgressListener listener,
final Type type) {
//自己实现具体的multipart表单请求，但必须结合rxjava返回
}
}
