Retrofit2.0 使用教程——MVP查快递

使用准备

• build.gradle中配置引用

  implementation 'com.squareup.retrofit2:retrofit:2.6.2'
  implementation 'com.google.code.gson:gson:2.8.2'
  implementation 'com.squareup.retrofit2:converter-gson:2.6.2'
  

  需要导入的包除了retrofit外还需要导入gson用来转化json数据，导入converter-gson来使gson可以和retrofit配套使用。

  这里是三个包的git地址，用的时候可以从这里引用最新的包和获取文档支持：

  retrofit gson converter-gson

• 加入网络权限

  <uses-permission android:name="android.permission.INTERNET"></uses-permission>
  

建立数据模型

我们这里使用的是Gson解析，需要事先和接口约定好对应的json样式，然后在本地写好对应的数据模型。这里以快递100的返回数据为例，可以构造如下模型：

public class ExpressBean {
    public String message;
    public String nu;
    public String ischeck;
    public String com;
    public String status;
    public String condition;
    public String state;
    public List<DataBean> data;
    public static class DataBean {
        public String time;
        public String context;
        public String ftime;
    }
}

在构建本地数据模型时，我推荐一个好用的插件，可以一键转化json数据为java类：

GsonFormat

网络接口设置

retrofit的请求是通过接口加注解的形式来实现的，这里我写了个查询圆通快递的简单例子：

public interface ExpressQuestionService {
    @GET("query?type=yuantong")
    Call<ExpressBean> queryExpress(@Query("postid") String expressCode);
}

这个方法在调用后，会拼接postid到请求的后面，组成query?type=yuantong&postid=expressCode;

搭建mvp接口

MVP的第一步就是写接口，接口书写的过程也就是流程梳理的过程，当接口书写完后，只需要依次填补各个实现类就完成了，我们这个小需求很简单，所以接口也不复杂。

这里我把三个 接口放到一起，方便调整。

public interface ExpressQueryContract {
    interface View {
        /**
         * 绑定返回数据到页面
         */
        void bindView(ExpressBean bean);

        /**
         * 显示提示信息
         */
        void showToast(String message);
    }

    interface Presenter {
        /**
         * 处理查询逻辑
         */
        void queryExpress(String expressCode);
    }

    interface Model {
        /**
         * 调用接口查询信息
         */
        void queryExpress(String expressCode, Callback<ExpressBean> callback);
    }
}

实现MVP接口

接口定义好了，接下来依次写各个接口的实现类就好了

• 实现Model

  public class ExpressQueryModel implements ExpressQueryContract.Model {
      @Override
      public void queryExpress(String expressCode, Callback<ExpressBean> callback) {
          Retrofit retrofit = new Retrofit.Builder()
                  .baseUrl("http://www.kuaidi100.com/")
                  .addConverterFactory(GsonConverterFactory.create())
                  .build();
          ExpressQuestionService service = retrofit.create(ExpressQuestionService.class);
          Call<ExpressBean> repos = service.queryExpress(expressCode);
          repos.enqueue(callback);
      }
  }
  

• 实现Presenter

  public class ExpressQueryPresenter implements ExpressQueryContract.Presenter {
      private ExpressQueryContract.View view;
      private ExpressQueryContract.Model model;
  
      public ExpressQueryPresenter(ExpressQueryContract.View view) {
          this.view = view;
          model = new ExpressQueryModel();
      }
  
      @Override
      public void queryExpress(String expressCode) {
          model.queryExpress(expressCode, new Callback<ExpressBean>() {
              @Override
              public void onResponse(Call<ExpressBean> call, Response<ExpressBean> response) {
                  if (response != null && response.body() != null) {
                      view.bindView(response.body());
                  } else {
                      onFailure(null, null);
                  }
              }
  
              @Override
              public void onFailure(Call<ExpressBean> call, Throwable t) {
                  if (t != null && t.getMessage() != null) {
                      view.showToast(t.getMessage());
                  } else {
                      view.showToast("槽糕,服务开小差了,稍后再试吧");
                  }
              }
          });
      }
  }
  

• 实现View

  public class ExpressQuestionActivity extends AppCompatActivity implements ExpressQueryContract.View {
      private Button button;
      private TextView textView;
      private EditText editText;
      private ExpressQueryContract.Presenter presenter;
  
      @Override
      protected void onCreate(Bundle savedInstanceState) {
          super.onCreate(savedInstanceState);
          setContentView(R.layout.activity_express_question);
          findView();
          presenter = new ExpressQueryPresenter(this);
          button.setOnClickListener(new View.OnClickListener() {
              @Override
              public void onClick(View v) {
                  if (TextUtils.isEmpty(getExpressCode())) {
                      showToast("单号不能为空");
                  } else {
                      presenter.queryExpress(getExpressCode());
                  }
              }
          });
      }
  
      private String getExpressCode() {
          String code = editText.getText().toString().trim();
          return code;
      }
  
      private void findView() {
          button = findViewById(R.id.button_get);
          textView = findViewById(R.id.net_result);
          editText = findViewById(R.id.express_code);
      }
  
      @Override
      public void bindView(ExpressBean bean) {
          textView.setText(bean.toString());
      }
  
      @Override
      public void showToast(String message) {
          Toast.makeText(this, message, Toast.LENGTH_LONG);
      }
  }
  

• 总体包结构

在这里插入图片描述

可能遇到的问题

• IllegalArgumentException

  运行时出现如下异常信息：

  java.lang.IllegalArgumentException: Unable to create converter for class ****

  这类异常是由于没有添加对应的ConverterFactory造成的，retrofit必须配套对应的类型解析器才能使用，具体的代码就是下面的第三行语句

  Retrofit retrofit = new Retrofit.Builder()
                  .baseUrl("http://www.kuaidi100.com/")
                  .addConverterFactory(GsonConverterFactory.create())
                  .build();
  

• CLEARTEXT

  请求一直失败，直接走onFailure回调，错误信息类似下面这样：

  CLEARTEXT communication to www.kuaidi100.com not permitted by network security policy

  这是由于android9.0开始，对http请求的限制造成的，具体的解决方法可以参考这篇文章Android9.0 http网络请求解决方案

总结

好了，结束。