Retrofit的简单介绍与简单使用
使用Retrofit步骤
Retrofit是什么?
Retrofit其实我们可以理解为OkHttp的加强版,是一个网络加载框架。底层是使用OKHttp。它的一个特点是包含了特别多注解,方便使用。支持很多的开源库(著名例子:Retrofit + RxJava)。
如何使用?
使用 Retrofit 的步骤共有7个:
1:添加Retrofit库的依赖
2:创建 接收服务器返回数据的Bean类
3:定义用于描述网络请求的接口
4:创建 Retrofit 实例
5:创建网络请求实现第三步网络接口的实例。
6:发送网络请求(异步 / 同步)
7:处理服务器返回的数据
步骤详细介绍:
步骤1:
导包:
implementation ‘com.squareup.retrofit2:retrofit:2.2.0’
implementation ‘com.squareup.retrofit2:converter-gson:2.2.0’
添加网络权限:
步骤2:创建 接收服务器返回数据的Bean类:
步骤3:定义网络请求的接口.例如下图:
public interface IPostInterface {
@FormUrlEncoded//表示表单形式键值对的参数.
@POST("splash/splashList")
Call<PostBean> getDataByPostRequest(@Field("platform") String platform, @Field("appVersion") String appVersion, @Field("osType") String osType);
@POST("login.php")
Call<ResponseBody> login(@Body LogBean logBean);//body 注解它会把实例给转成json字符串.
}
步骤4:创建 Retrofit 实例:
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(“http://fanyi.youdao.com/”) //设置网络请求的Url地址
.addConverterFactory(GsonConverterFactory.create()) // 设置Gson数据解析器,将字符串转换成Bean类
.build();
步骤5:通过Retrofit创建用于网络请求的接口实例。
DataInterface IDataInterface = retrofit.create(DataInterface.class);
步骤6:发送网络请求。
Call< DataInfo > call = IDataInterface. getDataInfo ();//调用接口返回Call.
//发送网络请求(异步)
call.enqueue(new Callback< DataInfo >() {
//请求成功时回调
@Override
public void onResponse(Call call, Response< DataInfo > response) {
//请求处理,输出结果
response.body().show();
}
//请求失败时候的回调
@Override
public void onFailure(Call< DataInfo > call, Throwable throwable) {
System.out.println(“连接失败”);
}
});
步骤7:处理返回数据
通过response类的 body()对返回的数据进行处理
//发送网络请求(异步)
call.enqueue(new Callback< DataInfo >() {
//请求成功时回调
@Override
public void onResponse(Call< DataInfo > call, Response< DataInfo > response) {
// 对返回数据进行处理
response.body().show();
}
//请求失败时候的回调
@Override
public void onFailure(Call< DataInfo > call, Throwable throwable) {
System.out.println("连接失败");
}
});
// 发送网络请求(同步)
Response< DataInfo > response = call.execute();
// 对返回数据进行处理
response.body().show();
public interface DataInterface {
//公共地址 http://www.moviebase.cn/uread/app/
// values splash/splashList
// 参数: platform=2&appVersion=1.7.0&osType=2
@POST("splash/splashList")
Call<DataInfo> getDataInfo(@QueryMap ArrayMap<String,String> map);
/**
@GET Get请求
@POST Psot 请求
@QueryMap 请求的参数 ArrayMap<Key,Value>
@Query() 请求参数 int String
@Path() 拼接的地址
*/
@POST("splash/{url}")
Call<DataInfo> getDataInfo(@Path("url") String list);
@Streaming
@GET
Call<ResponseBody> retrofitDownloadFile(@Url String fileUrl);
}
Retrofit将Http请求抽象成 Java接口:
Java 接口中的注解说明.
注解类型:
1,网络请求方法:
@GET
@POST
@PUT
@DELETE
@PATH
@HEAD
@OPTIONS
@HTTP
2,标记类
@FormUrlEncoded
@MultiPart
@Streaming
3,网络请求参数
@Header
@Headers
@URL
@Body
@Path
@Filed
@FiledMap
@Part
@PartMap
@Query
@QueryMap
@Path 路径当中某一部分是可变的,可以使用占位符
@QueryMap 键值对
@Query(“xxx”) 查询参数的设置
注释占位符的好处:解耦解析接口和网络请求,如果返回的结果相似,那么可以通过向方法中传递参数,来改变网址。
POST请求体的方式向服务器传入json字符串 @Body
有两种requestBody,一个是FormBody(表单的提交),一个是MultipartBody(文件的提交),前者以表单的方式传递
简单的键值对,
后者以POST表单的方式上传文件可以携带参数,retrofit也二者也有对应的注解
nohttp:http://doc.nohttp.net/240400
String downloadUrl = “http://169.254.230.253:8088/downloadTest/download?filename=a.jpg”;
“https://www.qubaobei.com/ios/cf/dish_list.php?stage_id=1&limit=20&page=1”
Retrofit–Get
//定义Retrofit Get接口的方法
package com.example.retrofit.Retrofitinterface;
import com.example.retrofit.DataBean.Bean;
import java.util.Map;
import retrofit2.Call;
import retrofit2.http.FieldMap;
import retrofit2.http.FormUrlEncoded;
import retrofit2.http.GET;
import retrofit2.http.Path;
import retrofit2.http.Query;
import retrofit2.http.QueryMap;
import retrofit2.http.Url;
public interface IGetByNetData {
//http://www.qubaobei.com/ios/cf/dish_list.php?stage_id=1&limit=20&page=1
//Get\请求 后面 的 参数声明 只要拼接到我们的BaseUri上 之后就会获取一个完整的路径
@GET("ios/cf/{path}")
Call<Bean> getData(@Path("path")String path, @Query("stage_id")String stage_id,@Query("limit")String limit,@Query("page")String page);
@GET("ios/cf/{path}")
Call<Bean> getDataByMap(@Path("path")String path, @QueryMap Map<String,String> map);
@GET
Call<Bean> getDataByurl(@Url String url);
}
package com.example.retrofit;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.ArrayMap;
import android.util.Log;
import com.example.retrofit.DataBean.Bean;
import com.example.retrofit.Retrofitinterface.IGetByNetData;
import java.util.HashMap;
import java.util.Map;
import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.Response;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;
public class GetActvity extends AppCompatActivity {
private String BaseUri = "http://www.qubaobei.com/";
private String ss="http://www.qubaobei.com/ios/cf/dish_list.php?stage_id=1&limit=20&page=1";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_get_actvity);
// initRetorfit();
// initmap();
initUrl();
}
private void initUrl() {
new Retrofit.Builder().baseUrl(BaseUri).addConverterFactory(GsonConverterFactory.create()).
build().create(IGetByNetData.class)
.getDataByurl(ss).enqueue(new Callback<Bean>() {
@Override
public void onResponse(Call<Bean> call, Response<Bean> response) {
Log.d("请求成功后获取的数据=", response.body().toString());
}
@Override
public void onFailure(Call<Bean> call, Throwable t) {
}
});
}
private void initmap() {
Map<String, String> map = new HashMap<>();
map.put("stage_id", "1");
map.put("limit", "10");
map.put("page", "1");
new Retrofit.Builder().
baseUrl(BaseUri).
addConverterFactory(GsonConverterFactory.create()).
build().
create(IGetByNetData.class)
.getDataByMap("dish_list.php", map).enqueue(new Callback<Bean>() {
@Override
public void onResponse(Call<Bean> call, Response<Bean> response) {
Log.d("请求成功后获取的数据=", response.body().toString());
}
@Override
public void onFailure(Call<Bean> call, Throwable t) {
}
});
}
private void initRetorfit() {
//获得RetorFit的构建者
Retrofit.Builder builder = new Retrofit.Builder();
//传入BaseUri
builder.baseUrl(BaseUri);
//给我们通过网络请求的Json转换成我们的javabean
builder.addConverterFactory(GsonConverterFactory.create());
//获取我们Retotfit的实例
Retrofit build = builder.build();
IGetByNetData iGetByNetData = build.create(IGetByNetData.class);
Call<Bean> data = iGetByNetData.getData("dish_list.php", "1", "20", "1");
data.enqueue(new Callback<Bean>() {
@Override
public void onResponse(Call<Bean> call, Response<Bean> response) {
//请求成功后获取的数据
Log.d("请求成功后获取的数据=", response.body().toString());
}
@Override
public void onFailure(Call<Bean> call, Throwable t) {
//请求失败获取的数据
}
});
}
}
Retrofit–Post
//定义 Retrofit Post接口的方法
package com.example.retrofit.Retrofitinterface;
import com.example.retrofit.DataBean.Bean;
import com.example.retrofit.DataBean.BoByBean;
import java.util.Map;
import retrofit2.Call;
import retrofit2.http.Body;
import retrofit2.http.Field;
import retrofit2.http.FormUrlEncoded;
import retrofit2.http.GET;
import retrofit2.http.POST;
import retrofit2.http.Path;
import retrofit2.http.Query;
import retrofit2.http.QueryMap;
import retrofit2.http.Url;
public interface IPostByNetData {
//http://www.qubaobei.com/ios/cf/dish_list.php?stage_id=1&limit=20&page=1
//Get\请求 后面 的 参数声明 只要拼接到我们的BaseUri上 之后就会获取一个完整的路径
@FormUrlEncoded
@POST("ios/cf/{path}")
Call<Bean> getData(@Path("path") String path, @Field("stage_id") String stage_id, @Field("limit") String limit, @Field("page") String page);
@POST("ios/cf/{path}")
Call<Bean> getBoby(@Path("path") String path, @Body BoByBean boByBean);
@POST
Call<Bean> getDataByurl(@Url String url);
}
package com.example.retrofit;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import com.example.retrofit.DataBean.Bean;
import com.example.retrofit.DataBean.BoByBean;
import com.example.retrofit.Retrofitinterface.IPostByNetData;
import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.Response;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;
public class PostActivity extends AppCompatActivity {
private String BaseUri = "http://www.qubaobei.com/";
private String url = "ios/cf/dish_list.php?stage_id=1&limit=20&page=1";
private String ss="http://www.qubaobei.com/ios/cf/dish_list.php?stage_id=1&limit=20&page=1";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_post);
initRetorfit();
initBoby();
}
private void initBoby() {
BoByBean boByBean=new BoByBean();
boByBean.setStage_id("1");
boByBean.setPage("1");
boByBean.setLimit("10");
new Retrofit.Builder().baseUrl(BaseUri).addConverterFactory(GsonConverterFactory.create()).build().create(IPostByNetData.class)
.getBoby("dish_list.php",boByBean).enqueue(new Callback<Bean>() {
@Override
public void onResponse(Call<Bean> call, Response<Bean> response) {
// Log.d("请求成功后获取的数据=",response.body().toString());
Log.d("Post+++++", response.body().toString());
}
@Override
public void onFailure(Call<Bean> call, Throwable t) {
}
});
}
private void initRetorfit() {
new Retrofit.Builder().baseUrl(BaseUri).addConverterFactory(GsonConverterFactory.create()).build().create(IPostByNetData.class)
.getData("dish_list.php","1","10","1").enqueue(new Callback<Bean>() {
@Override
public void onResponse(Call<Bean> call, Response<Bean> response) {
// Log.d("请求成功后获取的数据=",response.body().toString());
Log.d("Post+++++", response.body().toString());
}
@Override
public void onFailure(Call<Bean> call, Throwable t) {
}
});
}
}
=