在日常的Android开发,我们经常要获取网络上的数据，最常用的两种请求方式-GET POST，对自己的Project进行数据更新.安卓为我们提供了一个流行的网络请求框架---Retrofit.那什么是Retrofit呢?
Retrofit实际上是对OkHttp的一个封装,底层请求网络利用的还是OkHttp,经过Retrofit的封装,可以使网络请求变得更加简便,只需要利用相应的Retrofit的注解,就可以进行对网络的访问.
那么,要怎样使用retrofit呢?话不多说,直接上代码.
1. 先引入相应的依赖
implementation 'com.google.code.gson:gson:2.8.0'(gson生成和解析库)
implementation 'com.squareup.okhttp3:okhttp:3.9.1'(开源的网络请求库)
implementation 'com.squareup.okhttp3:logging-interceptor:3.9.1'(支持okhttp跟踪到一个网络请求的所有状态，包括请求头、请求体、响应行、 响应体,方便调试)
implementation 'com.squareup.retrofit2:retrofit:2.3.0'(实现将HTTP请求转换为Java接口)
implementation 'com.squareup.retrofit2:adapter-rxjava:2.1.0'(配合Rxjava 使用)
implementation 'com.squareup.retrofit2:converter-gson:2.1.0'(转换器，请求结果转换成Model)
implementation 'io.reactivex:rxandroid:1.2.1'
implementation 'io.reactivex:rxjava:1.2.1'(一种帮助你做异步的框架. 类似于 AsyncTask. 但其灵活性和扩展性远远强于前者. 从能力上讲, 如果说 AsycnTask 是 DOS 操作系统, RxJava 是 Window 操作系统。
2. 封装Retrofit
import retrofit2.Retrofit;
import retrofit2.adapter.rxjava3.RxJava3CallAdapterFactory;
import retrofit2.converter.gson.GsonConverterFactory;
public class RetrofitClient {
private static volatile RetrofitClient mInstance;
private Retrofit retrofit;
private static final String BASE_URL="修改自己的请求地址"; //此处是网络请求的基本url,便于后续加入url的参数,请求不一样的数据,需要从开发者文档中查询
private RetrofitClient(){
}
public static RetrofitClient getInstance() {
if(mInstance==null){ //如果该类对象为空,则创建各类对象
synchronized (RetrofitClient.class){ //锁,防止线程问题
if(mInstance==null){
mInstance=new RetrofitClient();
}
}
}
return mInstance; //返回该类对象,此方法用于外界调用
}
//创建RetrofitClient对象后调用,参数传对应的Service,即可调用Service中的方法,Service在下文会讲到
public <T> T getService(Class<T> cls){
return getRetrofit().create(cls);
}
//私有方法,在外界调用getService的时候,如果retrofit为空,则创建对象
private synchronized Retrofit getRetrofit() {
if(retrofit==null){
retrofit = new Retrofit.Builder().baseUrl(BASE_URL)
.addConverterFactory(GsonConverterFactory.create()) //添加Gson转化器,方便数据转为JavaBean
.addCallAdapterFactory(RxJava3CallAdapterFactory.create()) //添加Rxjava适配器
.build(); //创建
}
return retrofit; //返回retrofit
}
}
3. 创建对应的Service
public interface Service {
@GET("get") //这里是基本网址拼接上GET中的字符串
//Flowable: 自动转化器,会将服务器响应的数据自动转化为标准的JavaBean
//JavaBean需要自己写,可以通过bejson工具自动生成
//GET请求传参数需要加入@Query注解,参数会以拼接的方式连接起来
//示例: username=?&password=?
//基本用法,还有更多注解在这里就不一一介绍
Flowable<JavaBean> get(@Query("username") String username, @Query("password") String password);
@POST("post")
@FormUrlEncoded //表示请求体是一个Form表单
//post传递单个参数需要加入@Field注解
//示例: username=?&password=?
//post请求如需传入一段json数据,可以将一个map传入,然后加上@Body注解,底层会将map自动转化为json数据
Flowable<JavaBean> post(@Field("username") String username, @Field("password") String password);
}
4. 在Activity中进行网络请求
import androidx.appcompat.app.AppCompatActivity;
import android.util.Log;
public class MainActivity extends AppCompatActivity {
private String TAG="tag";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
//retrofit请求网络是异步请求
RetrofitClient.getInstance.
getService(Service.class).
get("111","111") //此处参数应由用户传输进来
.subscribeOn(Schedulers.io()) //利用io线程进行网络请求
.observeOn(AndroidSchedulers.mainThread()) //请求回调到Android主线程
.subscribe(new Consumer<JavaBean>() { //提交请求
@Override
public void accept(JavaBean bean) throws Throwable {
//请求成功,返回的json数据被Gson转化为JavaBean
//如果进到此方法,则网络请求成功
Log.d(TAG, "accept1: "+bean);//此处在控制台打印请求返回的结果
}
}, new Consumer<Throwable>() {
@Override
public void accept(Throwable throwable) throws Throwable {
//如果进到此方法,则网络请求失败
Log.d(TAG, "accept2: "+throwable);//此处在控制台打印请求失败的异常
}
});
}
}
Retrofit可以节省老一套网络请求写那么多代码的冗杂
为开发者提供了相对简单的请求方案
作为安卓目前最流行的网络请求框架,确实名不虚传.
