Retrofit简介
Retrofit是Square公司开发的一个Android和Java的REST客户端库,官方的解释是一个针对Android和Java类型安全的http客户端,通俗的来说Retrofit是一个应用在Android中,用来请求网络的第三方库,它的本质是对okhttp进行了封装,使我们的开发更为简便高效.
环境搭建
- 官网地址:http://square.github.io/retrofit/
- GitHub地址:https://github.com/square/retrofit
- 相关jar包的下载:https://github.com/square/retrofit/tree/master/retrofit-converters到各自对应目录下进行下载
- jar包导入
compile 'com.squareup.retrofit2:retrofit:2.2.0'
compile 'com.squareup.retrofit2:converter-gson:2.2.0'
compile 'com.squareup.retrofit2:converter-scalars:2.2.0'
- 导入后确保有以下jar包即可
converter-gson-2.2.0.jar、 converter-scalars-2.2.0.jar、 gson-2.7.jar、
okhttp-3.7.0.jar、 okio-1.12.0.jar、 retrofit-2.2.0.jar
使用步骤
1.创建用于接收的返回JSON数据的实体类:Entity
2.创建一个接口来管理请求的URL:EntityService
3.通过创建Retrofit类来帮我们自动实现接口的实现类
4.调用实现类里的方法可以同步或异步HTTP请求到远程服务器,并得到Call对象
5.调用Call里的方法去获取响应数据
入门案例
请求的url:http://10.8.29.49:8080/test/user!getUser
请求参数:loginCode
返回的json数据:
{"username":"小明","password":"1234","address":"地球"}
创建实体类User
public class User {
private String name;
private String password;
private String address;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
}
解释:创建这个实体类就是用来把接收到的json数据转成对象的,用过Gson的都知道,这里就不过多赘述了...
创建用于获取数据的UserService
public interface UserService {
@GET("user!getData")
Call<User> getUser(@Query("loginCode") String loginCode);
}
解释:@GET("user!getData"),表示以get方式请求,里面传入一个相对或绝对路径;@Query("loginCode"),附加到url的查询参数,loginCode表示key;
String loginCode即是value
用Retrofit来请求网络
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://10.8.29.49:8080/test/")
.addConverterFactory(GsonConverterFactory.create())
.build();
//用retrofit来创建UserService的实现类
UserService userService = retrofit.create(UserService.class);
//传入我们请求的参数值
Call<User> data = UserService.getUser("xiaoming");
//异步发送请求
data.enqueue(new Callback<User>() {
@Override
public void onResponse(Call<User> call, Response<User> response) {
//获取返回数据
Log.e("response",response.body().getName());
}
@Override
public void onFailure(Call<User> call, Throwable throwable) {
throwable.printStackTrace();
}
});
解释:baseUrl设置基本url,这里的url和service中的@get里的值组成完整的访问路径;
addConverterFactory添加转换器,可以让返回值以此类型进行解析,这里添加的是以Gson方式解析,可以添加多个转换器