Android Retrofit2基础使用
2020-12-19 本文已影响0人
sayeverything
来啊!快活啊
我是个肤浅的人,这里不讲原理,我也不会,这里只有Retrofit2的常规使用
Retrofit2 介绍
Retrofit 是一个对OkHttp网络请求框架的封装,网络请求的工作本质上是 OkHttp 完成,而 Retrofit 仅负责 网络请求接口的封装。
项目中使用
添加依赖
//retrofit网络请求框架
implementation 'com.squareup.retrofit2:retrofit:2.5.0'
//retrofit添加Json解析返回数据
implementation 'com.squareup.retrofit2:converter-gson:2.5.0'
//retrofit添加Rxjava支持
implementation 'com.jakewharton.retrofit:retrofit2-rxjava2-adapter:1.0.0'
常规使用:POST
情景一:不传递参数
Url示例:http://xxx/a/b
@POST("a/b") // 请求地址可以放在这里
Observable<JsonBean> postRequest1();//Json代码数据返回的实体类
情景二:传递少量参数 (用的比较多)
@POST("share/findShare")
@FormUrlEncoded //表示请求是一个Form表单
Observable<JsonBean> queryShareList(@Field("shsId") String shsId);
情景三:传大量文本参数(就普通的String)
@POST("share/findShare")
@FormUrlEncoded
Observable<JsonBean> queryShareList2(@FieldMap Map<String, String> map);
情景四:传json数据(Postman raw形式)
@POST("xx/xxx")
Observable<JsonBean> aaa(@Body RequestBody body);
//将map 集合转为需要的json 数据上传
public static RequestBody postRaw(Map<String, String> map) {
return RequestBody.create(MediaType.parse("application/json;charset=UTF8"),JSON.toJSONString(map));
}
情景五:上传文件
@POST("xxx/xxx")
@Multipart
Observable<JsonBean> upload(@Part MultipartBody.Part file);
//上传调用的方法 传入本地文件路径
public static LiveData<ApiResponse<UploadBean>> upLoadImg(String img) {
if (img.isEmpty()) return null;
File file = new File(img);
RequestBody fileRQ = RequestBody.create(MediaType.parse("image/jpg"), file);
MultipartBody.Part part = MultipartBody.Part.createFormData("file", file.getName(), fileRQ);
return RetrofitHelper.getApi().upload(part);
}
情景六:图片文字混合上传
/**
* 传递单个文件
* //构建请求体 传入上传得格式 文件
* RequestBody fileRQ = RequestBody.create(MediaType.parse("image/*"), file);
* //构建网络请求需要得参数part
* 第一个参数:与后台约定的key
* 第二个参数:文件名称
* 第三个参数:请求体
* MultipartBody.Part part = MultipartBody.Part.createFormData("file", file.getName(), fileRQ);
*
* @param file
* @return
*/
@POST("url")
@Multipart //表示请求体是一个支持文件上传的Form表单
Observable<JsonBean> queryShareList3(@Part MultipartBody.Part file);
//from表单中的参数需要转为RequestBody形式
private static RequestBody toRequestBody(String value) {
RequestBody requestBody = RequestBody.create(MediaType.parse("text/plain"), value);
return requestBody;
}
//文件的形式 这里是多个文件,单个文件可以直接put,不用遍历
Map<String, RequestBody> map = new HashMap<>();
for (File imgUrl : fileList) {
RequestBody requestFile = RequestBody.create(MediaType.parse("image/jpg"), imgUrl);
//注意:file就是与服务器对应的key,后面filename是服务器得到的文件名
map.put("files\"; filename=\"" + imgUrl.getName(), requestFile);
}
情景七:url拼接 List
Url示例:http://xxx/a/b?id=1&id=2&id=3&address_id=1
@GET("url")
Observable<JsonBean> createMutilOrder(@Query("address_id") String address_id,@Query("id") List<String> id);
情景八:url拼接 Map
@GET("url")
Observable<JsonBean> createMutilOrder(@QueryMap Map<String,String> map);
Retrofit 基类封装
/**
* 公司:
* 作者:Android 孟从伦
* 文件名:BaseRetrofit
* 创建时间:2020/7/13
* 功能描述:
*/
public class BaseRetrofit<T> implements RetrofitWrapper<T> {
private static final String TAG = "BaseRetrofit";
private static int DEFAULT_TIME = 1000*60;
private String url = ApiResponse.HOST;
private Retrofit retrofit;
private Class<T> tClass;
private T service;
public BaseRetrofit(Class<T> tClass){
this.tClass = tClass;
initRetrofit(tClass);
}
@Override
public void initRetrofit(Class<T> tClass) {
//调度器
Dispatcher dispatcher = new Dispatcher();
dispatcher.setMaxRequests(10);
dispatcher.setMaxRequestsPerHost(10);
HttpHeaderInterceptor headerInterceptor = new HttpHeaderInterceptor();
OkHttpClient okHttpClient = new OkHttpClient.Builder()
.readTimeout(DEFAULT_TIME, TimeUnit.SECONDS)//设置读取超时时间
.connectTimeout(DEFAULT_TIME, TimeUnit.SECONDS)//设置请求超时时间
.writeTimeout(DEFAULT_TIME, TimeUnit.SECONDS)//设置写入超时时间
.addInterceptor(headerInterceptor)//添加打印拦截器
.dispatcher(dispatcher)
.build();
//创建retrofit实例
retrofit = new Retrofit.Builder()
.client(okHttpClient)
.addConverterFactory(GsonConverterFactory.create())
.addCallAdapterFactory(new LiveDataCallAdapterFactory())
.baseUrl(url)
.build();
//创建请求接口实例
service = retrofit.create(tClass);
}
@Override
public T getService() {
if (null == service){
service = retrofit.create(tClass);
}
return service;
}
}