Android开发之Retrofit小试牛刀

感觉好久没有写Android的文章了，囧囧囧！因为Retrofit实在是太火了， 火得我一直跃跃欲试，但是由于种种原因吧，一直都没有用过。周末闲来无事，利用一个以前开发中用过的服务器API来小试牛刀一下，非常简单，记录自己的第一次Retrofit之旅。

重要说明：由于涉及到商业机密，所以对请求的数据和服务器地址进行了处理。自己实验时，请换成自己的服务器。

一、添加依赖、配置项目

这一步就不详细说了，会的都会，基本就是添加两个依赖和网络访问权限。

compile 'com.squareup.retrofit2:retrofit:2.1.0'
compile 'com.squareup.retrofit2:converter-gson:2.1.0'

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

二、根据服务器端返回的JSON数据配置自己的JavaBean

在项目中用Retrofit的时候，肯定和服务器端的哥们商量好了如何交互，也就是说已经知晓了服务器端会返回什么样的数据（基本都是JSON，只是内容不一样而已），这些数据你可以直接用字符串接收，然后自己处理，但是这么low的事情，Retrofit肯定可以帮我处理了，用上面的converter-gson就可以自动将JSON转成我们的对象，前提是需要与返回的JSON字段进行映射，默认情况下字段名一样就不会出什么问题，但是我却踩了一个坑，下文会介绍。

• 服务器端返回的JSON数据如下：

{"message":"ok","list":["id":"","abstract":"","title":"","url":""},...]

• 根据上面的JSON数据创建JavaBean

import com.google.gson.annotations.SerializedName;
import java.util.List;

/**
 * Created by yangfan on 2017/1/7.
 */

//与服务器端数据进行字段映射
public class NewsInfo {
  
    private String message;
    private List<News> list;

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public List<News> getList() {
        return list;
    }

    public void setList(List<News> list) {
        this.list = list;
    }


    public static class News {

        private String id;
        //@SerializedName：后面是服务器端返回的数据字段名 可以与本地不一样 该关键字就是用来映射的
        @SerializedName("abstract")
        private String _abstract;
        private String title;
        private String url;

        public String getId() {
            return id;
        }

        public void setId(String id) {
            this.id = id;
        }

        public String get_abstract() {
            return _abstract;
        }

        public void set_abstract(String _abstract) {
            this._abstract = _abstract;
        }

        public String getTitle() {
            return title;
        }

        public void setTitle(String title) {
            this.title = title;
        }

        public String getUrl() {
            return url;
        }

        public void setUrl(String url) {
            this.url = url;
        }
    }
}

踩坑记录：服务器端居然有一个abstract字段，但是这个是Java关键字啊，怎么办？用@SerializedName告诉Retrofit，我想你把该字段映射成我自定义的名字。

配置访问服务器API的接口

这个就是真正的访问服务器的本地API了，我这里只用了GET，其实远不止这个功能，可以参考官方文档。

import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Query;

/**
 * Created by yangfan on 2017/1/7.
 */
public interface NewsInterface {

    //获取服务器的新闻列表，由于新闻类型和分页显示的需要，需要传递三个参数
    @GET("news/list")
    Call<NewsInfo> newsList(@Query("type") String type, @Query("pn") String pn, @Query("ps") String ps);

}

Activity

配置好以上信息以后，就可以开始写Android的程序了。因为我的程序比较简单，所以我很快就成功获取数据了，这一块没怎么踩坑。

public class MainActivity extends AppCompatActivity {

    private TextView tvResult;
    //服务器的基地址 与  @GET("news/list")拼接
    private static final String baseUrl = "http://服务器地址/";

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

        tvResult = (TextView) findViewById(R.id.tvResult);

        initRetrofit();
    }

    private void initRetrofit() {

        Retrofit retrofit = new Retrofit.Builder().baseUrl(baseUrl).addConverterFactory(GsonConverterFactory.create())
                .build();


        NewsInterface newsInterface = retrofit.create(NewsInterface.class);

        Call<NewsInfo> callNewsInfo = newsInterface.newsList("1", "1", "10");

        callNewsInfo.enqueue(new Callback<NewsInfo>() {
            @Override
            public void onResponse(Call<NewsInfo> call, Response<NewsInfo> response) {
                //成功
                if (response.code() == 200) {
                    //将返回的数据转换成自定义的对象
                    NewsInfo newsInfo = response.body();

                    if(newsInfo.getMessage().equals("ok")){
                        //最爽的地方---直接可以进行UI操作
                        tvResult.setText(newsInfo.getList().get(0).get_abstract());
                    }
                } else {
                    //请求失败
                    tvResult.setText("查询失败！响应码为：" + response.code());
                }
            }

            @Override
            public void onFailure(Call<NewsInfo> call, Throwable t) {
                //请求失败
                t.printStackTrace();
                tvResult.setText("查询失败！错误原因：" + t.getCause());
            }
        });

    }
}

运行结果

Retrofit小试牛刀.gif

Retrofit功能非常强大，我也看了很多文档，上面用的只是冰山一角。目前感觉最大的好处就是可以直接在回调中操作主线程的UI，再也不需要用Handler了，其他牛逼的功能和好处待学习、待发掘。