Android Retrofit的基本用法

前言:

各位同学大家好，有段时间没有给大家更新文章。因为最近比较忙 个人私事比较多，所有也不在状态。今天要给大家讲一下安卓中Retrofit 网络请求框架的使用，相信在这里之前大家肯定看过其他博主的。或者也是非常熟练的使用这个库，我这边也是做一个笔记记录分享。废话不多说，我们正式开始。

准备工作

添加依赖 在项目build.gradle里面添加如下依赖

    implementation 'com.squareup.retrofit2:retrofit:2.3.0'
    implementation 'com.squareup.retrofit2:converter-gson:2.3.0'//ConverterFactory的Gson依赖包
    implementation 'com.squareup.retrofit2:converter-scalars:2.3.0'//ConverterFactory的String依赖包
    implementation("com.squareup.okhttp3:okhttp:4.9.1")

因为Retrofit 是基于okhttp二次封装的网络请求库 所以这里要导入okhttp的依赖

具体实现

1 创建 Retrofit 实例

Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(Config.baseUrl)
                //增加返回值为Gson的支持(以实体类返回)
                .addConverterFactory(GsonConverterFactory.create())
                .build();

我们调用 Retrofit.Builder 然后添加baseURL （一般是接口协议头和域名部分）然后添加gson解析器来格式化我们返回的数据

• 编写 Retrofit 单例

当然我们在实战中开发 写一个 Retrofit 的单例 然后供外部调用即可

package com.example.retrofit_demo;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;
public class RetrofitUtils {
    private static RetrofitUtils retrofitUtils;
    private RetrofitUtils() {
    }
    public static RetrofitUtils getInstance() {

        if (retrofitUtils == null) {
            synchronized (RetrofitUtils.class) {
                if (retrofitUtils == null) {
                    retrofitUtils = new RetrofitUtils();
                }
            }
        }
        return retrofitUtils;
    }
    //返回Retrofit
    public Retrofit getRetrofit() {
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(Config.baseUrl)
                .addConverterFactory(GsonConverterFactory.create())
                .build();
        return retrofit;
    }
}

• 创建 model

将服务端返回json数据格式化成我们需要用到实体类

package com.example.retrofit_demo;

public class UserModel {

    private  int code;
    private String msg;

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

}

• 创建service

在 service 我们提供了 loginGet loginPost 两个方法供外部调用

package com.example.retrofit_demo;
import retrofit2.Call;
import retrofit2.http.Field;
import retrofit2.http.FormUrlEncoded;
import retrofit2.http.GET;
import retrofit2.http.POST;
import retrofit2.http.Query;
public interface UserService {
    @GET("boss/user/validlogin")
    Call<UserModel> loginGet (@Query("username") String username, @Query("password") String password);

    @POST("boss/user/validlogin")
    @FormUrlEncoded
    Call<UserModel> loginPost (@Field("username") String username, @Field("password") String password);
}

具体调用

• get同步请求

   private  void  getMethod(){
        UserService service=RetrofitUtils.getInstance().getRetrofit().create(UserService.class);
        Call<UserModel>call=service.loginGet(username,password);
        //  同步调用
        new Thread(new Runnable() {
            @Override
            public void run() {
                try {
                    Response<UserModel>response=call.execute();
                    Log.e(TAG, "run: get同步请求 "+ "code --- > "+response.body().getCode()+"msg  --- >"+response.body().getMsg());
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }).start();

    }

我们拿到call 对象之后 调用 execute 同步方法 我们返回一个 response 对象 然后我们可以通过response来获取我们从后端请求返回的数据 因为gson解析器帮我们做好了
我们只需要

response.body().getCode()
response.body().getMsg());

很简单的代码就能获取服务端返回的json数据里面key对应value 值
这里有个地方要注意 因为是同步方法 所以我们是不能直接在ui线程里面操作· 不然会造成线程阻塞 直接报出anr 所以在使用 call 同步方法适合我们要自己开启一个线程 new Thread 再去操作

• get异步请求

     UserService service=RetrofitUtils.getInstance().getRetrofit().create(UserService.class);
        Call<UserModel>call=service.loginGet(username,password);
        //异步调用
        call.enqueue(new Callback<UserModel>() {
            @Override
            public void onResponse(Call<UserModel> call, Response<UserModel> response) {
                Log.e(TAG, "onResponse: get异步请求 "+"code --- > "+
                        response.body().getCode()+"msg  --- >"+response.body().getMsg() );
            }

            @Override
            public void onFailure(Call<UserModel> call, Throwable t) {

            }
        });

我们调用call 里面 enqueue 异步方法 我们是需要实现Callback 接口里面的回调方法 因为是异步操作 所以我们不需要再另外开启线程来处理 框架已经帮我们处理好了

同理post 用法也类似我就不展开讲了

• post同步请求

UserService service=RetrofitUtils.getInstance().getRetrofit().create(UserService.class);
        Call<UserModel>call=service.loginPost(username,password);
        //  同步调用
        new Thread(new Runnable() {
            @Override
            public void run() {
                try {
                    Response<UserModel>response=call.execute();
                    Log.e(TAG, "run: post同步请求 "+ "code --- > "+response.body().getCode()+"msg  --- >"+response.body().getMsg());
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }).start();

• post异步请求

  UserService service=RetrofitUtils.getInstance().getRetrofit().create(UserService.class);
        Call<UserModel>call=service.loginPost(username,password);
         //异步调用
        call.enqueue(new Callback<UserModel>() {
            @Override
            public void onResponse(Call<UserModel> call, Response<UserModel> response) {


                Log.e(TAG, "onResponse: post异步请求 "+"code --- > "+
                        response.body().getCode()+"msg  --- >"+response.body().getMsg() );
            }


            @Override
            public void onFailure(Call<UserModel> call, Throwable t) {

            }

        });

get 和post 区别是我们在传参的时候

• GET

    @GET("boss/user/validlogin")
    Call<UserModel> loginGet (@Query("username") String username, @Query("password") String password);

get 请求使用了GET主机还有加上 @Query 注解来表示请求的key

• POST

    @POST("boss/user/validlogin")
    @FormUrlEncoded
    Call<UserModel> loginPost (@Field("username") String username, @Field("password") String password);

post 请求我们要用到 @POST 和 @FormUrlEncoded 注解 这两个注解是打包出现的
然后使用 @Field 来表示请求的key

测试效果

image.png

代码里面接口地址是我本地启动的一个java项目

最后总结

Retrofit 还有更多好用方便用法 配合mvp mvvm可以是我们网络请求模块代码充分的解构 逻辑更清晰
方便管理 由于篇幅问题我这里就不展开讲了 有兴趣的同学可以私下研究 最后希望我的文章能帮助到各位解决问题 ，以后我还会贡献更多有用的代码分享给大家。各位同学如果觉得文章还不错 ，麻烦给关注和star，小弟在这里谢过啦!

项目地址

客户端项目（Android） ： https://gitee.com/qiuyu123/retrofit_demo
服务端地址（springboot): https://github.com/xq19930522/bosstabservice