本文使用登录场景来简单介绍 Android 应用中使用 OkHttp + Retrofit 访问网络的用法。

• 数据交换协议 HTTP
• 数据交换格式 JSON
• HTTP 请求方法 POST

使用 HTTP 访问网络的准备工作，参见Android 访问网络：方案一 OkHttp一文访问网络的准备工作部分。

使用 OkHttp + Retrofit 访问网络

---

1.引入依赖

build.gradle(:app)

dependencies {
    ...
    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
    implementation 'com.squareup.retrofit2:converter-gson:2.9.0'

    implementation 'com.squareup.okhttp3:logging-interceptor:3.14.9'
}

2.定义网络访问接口

创建 UserService 接口，用来提供 User 模块的网络访问服务。除了登录 login() , 还可以在这里定义获取用户信息，修改用户名，更换头像等功能对应的方法。
UserService.java

public interface UserService {

    @POST("user/login")
    Call<Result<String>> login(@Body LoginParam loginParam);

    // getUserDetail()

    // modifyUserName()

    // replaceAvatar()

}

方法注解 @POST

1. 方法注解用于描述该请求的 HTTP 方法，@POST 表示该请求的方法为 POST 。
2. "user/login" 是请求的相对路径，Retrofit 会将其和 baseUrl 拼接起来，构成完整的 URL 。
3. 比较常用的其他方法注解
   @GET
   @PUT
   @DELETE

方法参数注解 @Body

1. 方法参数注解用于描述方法参数作为请求的什么内容，@Body 表示把方法参数的序列化结果作为请求体。
2. 比较常用的其他方法参数注解
   @Field 表示采用键值对的形式组织请求参数，作为请求体。使用该注解时，需要为方法添加 @FormUrlEncoded 注解，设置 MIME type 为 application/x-www-urlencoded 。

@Field 使用示例

方法定义
@FormUrlEncoded
@POST("/")
Call<ResponseBody> example(
@Field("name") String name,
@Field("occupation") String occupation);

方法调用 foo.example("Bob Smith", "President")

请求体 name=Bob+Smith&occupation=President
注：多个请求参数使用 & 分隔，每个参数的名和值使用 = 连接。"Bob Smith" 的空格替换为 + 。

LoginParam

LoginParam 是简单的登录请求参数类，包含用户名和密码两个属性。
LoginParam.java

public class LoginParam {

    public String userName;
    public String password;

    public LoginParam(String userName, String password){
        this.userName = userName;
        this.password = password;
    }

}

Result

Result 是网络访问结果类，包含 code, message, data 三个属性。
Result.java

public class Result<DATA> {

    private static final int HTTP_REQUEST_SUCCESS_CODE = 600;

    public int code;
    public String message;
    public DATA data;

    public boolean isSuccessful() {
        return code == HTTP_REQUEST_SUCCESS_CODE;
    }

    @NonNull
    @Override
    public String toString() {
        return "Result{" +
                "code=" + code +
                ", message='" + message + '\'' +
                ", data=" + data +
                '}';
    }

}

3. 创建 Retrofit 实例

1. 创建 OkHttp 实例，添加日志拦截器，以便调试。

OkHttpClient client = new OkHttpClient.Builder()
    .addInterceptor(new HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.BODY))
    .build();

2. 创建 Retrofit 实例，配置 baseUrl, 添加 ConverterFactory。

Retrofit retrofit = new Retrofit.Builder().
    baseUrl("http://192.168.43.218:8080/")
    .addConverterFactory(GsonConverterFactory.create())
    .client(client)
    .build();

4. 创建 Service 实例

UserService userService = retrofit.create(UserService.class);

5. 创建 Call 实例

Call<Result<String>> loginCall = userService.login(new LoginParam(userName, password));

假如这里 userName 的值为 "xumeng"，password 的值为 "123456"，Retrofit 会使用 GsonConverter 将 LoginParam 对象转为 JSON 字符串作为请求体。

请求体
{"password":"123456","userName":"xumeng"}

由于这一步比较简单，通常的写法是和下一步连起来，将 Call 的实例作为匿名对象来使用。

userService.login(new LoginParam(userName, password)).enqueue(new Callback<Result<String>>(){...});

6. 向服务端发送 HTTP 请求

• Call 可以调用 execute() 发起同步请求，也可以调用 enqueue(Callback<T>) 发起异步请求。本文采用异步方式发送请求。
  Call 实例入队，创建 Callback 实例，用于处理网络访问结果

loginCall.enqueue(new Callback<Result<String>>() {
    @Override
    public void onResponse(@NonNull Call<Result<String>> call, @NonNull Response<Result<String>> response) {
                
    }

    @Override
    public void onFailure(@NonNull Call<Result<String>> call, @NonNull Throwable t) {

    }
});

7. 在 Callback 的 onResponse() 中处理网络访问结果

• Retrofit 会为我们从后台线程切换到主线程，所以在 onResponse() 方法中无需考虑线程切换的问题。
• Retrofit 会使用我们配置的 ConverterFactory 将响应体的 JSON 数据转换为 Result<> 类的实例，调用 response.body() 方法即可获取。

@Override
public void onResponse(@NonNull Call<Result<String>> call, @NonNull Response<Result<String>> response) {
    Result<String> result = response.body();
    if (result == null) {
        onFailure(call, new Throwable("body is null"));
        return;
    }
    Toast.makeText(LoginActivity.this, result.message, Toast.LENGTH_SHORT).show();
    if (result.isSuccessful()) {
        Log.i(TAG, "token : " + result.data);
        // save token
        // start activity
    }
}

附

---

测试设备参数

• 型号：vivo Y66L
• 操作系统：Funtouch OS 3.0（Android 6.0.1）

参考资料

1. Square : Retrofit
2. MDN : HTTP request methods POST

代码

XuMeng-0 / android-study