Retrofit的使用案例

官网地址：Retrofit，注意到：

1. 服务端

由于Retrofit是一个使用RESTful规范的网络请求框架的封装，为了熟悉RESTful的规范，所以这里我们首先在后台的SpringBoot中创建对应的接口，以完成本次的测试工作。

@Controller
public class RetrofitController {

    @GetMapping(value="/test/1.0/users")
    @ResponseBody
    public Set<User> getUsers(){
        return UserMap.getDataBaseUsers();
    }

    @GetMapping(value = "/test/1.0/users/{userid}")
    @ResponseBody
    public User getUserByUserId(@PathVariable(value = "userid") String userId){
        return UserMap.getUserByUserID(userId);
    }

    @PostMapping(value = "/test/1.0/users")
    @ResponseBody
    public void addUser(@RequestParam("name") String userName){
        User user = new User(userName, null);
        UserMap.addUser(user);
    }
}

使用UserMap来模拟数据库。简单测试一个接口：

2. 客户端

添加相关依赖：

implementation "com.squareup.okhttp3:okhttp:4.9.0"
implementation 'com.squareup.retrofit2:retrofit:2.8.0'
implementation 'com.squareup.retrofit2:converter-gson:2.8.0'

添加权限：

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

定义实体类，这里为User，由于只有两个字段，这里不给出。
接着定义请求接口，使用Retrofit来中提供的注解来定义。

public interface RequestInterface {

    @GET(value = "/test/1.0/users")
    Call<List<User>> listUsers();   // retrofit2.Call;

    @GET(value = "/test/1.0/users/{userid}")
    Call<User> getUserById(@Path(value = "userid") char userId);

    @FormUrlEncoded
    @POST(value = "/test/1.0/users")
    Call<Void> addUser(@Field(value = "name") String name);
}

至于注解的写法，在官网中给出的参考例子可以学习。需要注意的是这里的Call对象是Retrofit中的Call而不是OkHttp当中的Call，不要导错包。

最后在Activity中创建Retrofit对象，然后请求即可：

public class MainActivity extends AppCompatActivity {
    private Retrofit retrofit = null;
    private TextView textView;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        Button button = findViewById(R.id.button);

        textView = findViewById(R.id.textView);

        if(retrofit == null){
            retrofit = new Retrofit.Builder()
                    .baseUrl("http://192.168.1.102:90/")
                    .addConverterFactory(GsonConverterFactory.create())
                    .build();
        }

        button.setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View v) {
                    RequestInterface request = retrofit.create(RequestInterface.class);
                    Call<User> call = request.getUserById('1');
                    call.enqueue(new Callback<User>() {
                        @Override
                        public void onResponse(Call<User> call, Response<User> response) {
                            runOnUiThread(new Runnable() {
                                @Override
                                public void run() {
                                    textView.setText(response.body().getName());
                                }
                            });
                        }

                        @Override
                        public void onFailure(Call<User> call, Throwable t) {
                            runOnUiThread(new Runnable() {
                                @Override
                                public void run() {
                                    textView.setText("数据请求失败！");
                                }
                            });
                        }
                    });
                }
            }
        );
    }
}

具体步骤使用起来感觉和OkHttp的类似，但是值得高兴的是，不用自己再去做数据对象的装载。在OkHttp中如果我们的对象所涉及到的字段非常多，就需要很多set代码来设置值，封装对象。

可能在这个案例中，Retrofit的优势没有体现出来，但是当对象的属性比较多的时候，优势还是很明显的。

为了测试请求所有的User，这里使用ListView来实现，比如，定义ListUserAdapter来作为适配器：

// ListUserAdapter.java
public class ListUserAdapter extends ArrayAdapter<User> {
    private int resId;

    public ListUserAdapter(@NonNull Context context, int resource, @NonNull List<User> objects) {
        super(context, resource, objects);
        this.resId = resource;
    }

    @NonNull
    @Override
    public View getView(int position, @Nullable View convertView, @NonNull ViewGroup parent) {
        ViewHolder viewHolder = null;
        View view = null;
        if(convertView == null){
            view = LayoutInflater.from(getContext()).inflate(resId, parent, false);
            viewHolder = new ViewHolder();
            viewHolder.left = (TextView) view.findViewById(R.id.item_left);
            viewHolder.right = (TextView) view.findViewById(R.id.item_right);
            view.setTag(viewHolder);
        }else{
            view = convertView;
            viewHolder = (ViewHolder) view.getTag();
        }
        viewHolder.left.setText(getItem(position).getName());
        viewHolder.right.setText(getItem(position).getUserID());
        return view;
    }

    static class ViewHolder{
        TextView left;
        TextView right;
    }
}

对应的在onClick后加载的内容为：

RequestInterface request = retrofit.create(RequestInterface.class);
Call<List<User>> call = request.listUsers();
call.enqueue(new Callback<List<User>>() {
    @Override
    public void onResponse(Call<List<User>> call, Response<List<User>> response) {
        List<User> body = response.body();
        listview.setAdapter(
                new ListUserAdapter(getApplicationContext(),
                        R.layout.listview_item,
                        body)
        );
        runOnUiThread(new Runnable() {
            @Override
            public void run() {
                textView.setText("数据加载成功！" + body.size());
            }
        });
    }

    @Override
    public void onFailure(Call<List<User>> call, Throwable t) {
        runOnUiThread(new Runnable() {
            @Override
            public void run() {
                textView.setText("数据请求失败！");
            }
        });
    }
});

至于定义的ListView的item布局文件这里不再给出。
效果：

至于最后一个Post请求，这里还是还是给出在onClick点击之后的代码：

RequestInterface request = retrofit.create(RequestInterface.class);
Call<Void> call = request.addUser("王王");
call.enqueue(new Callback<Void>() {
    @Override
    public void onResponse(Call<Void> call, Response<Void> response) {
        runOnUiThread(new Runnable() {
            @Override
            public void run() {
                textView.setText("数据提交成功！");
            }
        });
    }

    @Override
    public void onFailure(Call<Void> call, Throwable t) {
        runOnUiThread(new Runnable() {
            @Override
            public void run() {
                textView.setText("数据请求失败！");
            }
        });
    }
});

最后，我们可以看下服务器中的数据是否有”王王“。

---

Thanks

• Retrofit