android快捷开发之Retrofit网络加载框架的简单使用

大家都知道，安卓最大的特点就是开源化，这自然会产生很多十分好用的第三方API，而基本每一个APP都会与网络操作和缓存处理机制打交道，当然，你可以自己通过HttpUrlConnection再通过返回数据进行解析解决，而我们自己学的东西大多数情况下都没有针对网络很糟糕的情况进行优化。下面就给大家带来Square Inc这家有创新精神的公司留下的Retrofit网络加载库的使用！

项目已经同步至github:https://github.com/nanchen2251/retrofitDemo

Retrofit封装了从Web API下载数据，解析成一个普通的java对象（POJO），这里我们就去天狗网使用他们的一个菜谱的API做简单演示，供大家一起学习思考。在天狗网的API文档网站http://www.tngou.net/doc/cook的菜谱API接口：http://www.tngou.net/api/cook/list

详细使用：

1）首先得添加支持包 

compile 'com.squareup.retrofit2:retrofit:2.1.0'

　　

2）然后每一次使用都需要定义一个接口，用于下载网络数据，注意其中的{category}是为了之后更好的扩展性，我们定义一个未知的子目录，通过参数中指定可以访问固定的子目录，这个方式非常棒。

package com.example.nanchen.retrofitdemo;

import com.example.nanchen.retrofitdemo.json.Tngou;

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

/**
 * Created by 南尘 on 16-7-15.
 */
public interface Service {
    @GET("/")//网址下面的子目录
    Call<String> getBaidu();

    @GET("/api/{category}/list")//网址下面的子目录   category表示分类，因为子目录只有一点不一样
    Call<Tngou> getList(@Path("category") String path,@Query("id") int id, @Query("page") int page, @Query("rows") int rows);
}

　　

3）由于我们返回的数据为Json数据，所以我们可以用它本身自带的Gson解析方式进行返回数据的解析，同样先导入支持包

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

　　

4）我们写一个DataBean用于存放返回的数据

package com.example.nanchen.retrofitdemo.json;

import com.google.gson.annotations.SerializedName;

import java.util.List;

/**
 * Created by 南尘 on 16-7-15.
 */
public class Tngou {
    //加上注解
    @SerializedName("status")
    private boolean status;
    @SerializedName("total")
    private int total;
    @SerializedName("tngou")
    private List<Cook> list;

    public boolean isStatus() {
        return status;
    }

    public void setStatus(boolean status) {
        this.status = status;
    }

    public int getTotal() {
        return total;
    }

    public void setTotal(int total) {
        this.total = total;
    }

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

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

　　里面要放List, 是一个类，所以要新建一个类。

package com.example.nanchen.retrofitdemo.json;

import com.google.gson.annotations.SerializedName;

/**
 * 菜谱
 * Created by 南尘 on 16-7-15.
 */
public class Cook {
    @SerializedName("id")
    private int id;
    @SerializedName("name")
    private String name;//名称
    @SerializedName("food")
    private String food;//食物
    @SerializedName("img")
    private String img;//图片
    @SerializedName("images")
    private String images;//图片,
    @SerializedName("description")
    private String description;//描述
    @SerializedName("keywords")
    private String keywords;//关键字
    @SerializedName("message")
    private String message;//资讯内容
    @SerializedName("count")
    private int count;//访问次数
    @SerializedName("fcount")
    private int fcount;//收藏数
    @SerializedName("rcount")
    private int rcount;//评论读数

    public int getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getFood() {
        return food;
    }

    public void setFood(String food) {
        this.food = food;
    }

    public String getImg() {
        return img;
    }

    public void setImg(String img) {
        this.img = img;
    }

    public String getImages() {
        return images;
    }

    public void setImages(String images) {
        this.images = images;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getKeywords() {
        return keywords;
    }

    public void setKeywords(String keywords) {
        this.keywords = keywords;
    }

    public String getMessage() {
        return message;
    }

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

    public int getCount() {
        return count;
    }

    public void setCount(int count) {
        this.count = count;
    }

    public int getFcount() {
        return fcount;
    }

    public void setFcount(int fcount) {
        this.fcount = fcount;
    }

    public int getRcount() {
        return rcount;
    }

    public void setRcount(int rcount) {
        this.rcount = rcount;
    }
}

　　

5）我们做一个简单演示，把返回并解析的数据放在ListView里面显示，所以自定义一个显示Item的Xml文件

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
              android:orientation="horizontal"
              android:layout_width="match_parent"
              android:layout_height="wrap_content">

    <ImageView
        android:layout_width="70dp"
        android:layout_height="70dp"
        android:src="@mipmap/ic_launcher"
        android:id="@+id/item_iv"/>
    
    <LinearLayout
        android:layout_gravity="center_vertical"
        android:orientation="vertical"
        android:layout_weight="1"
        android:layout_width="0dp"
        android:layout_height="wrap_content">

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:text="标题"
            android:textAppearance="@android:style/TextAppearance.Large"
            android:id="@+id/item_title"/>
        
        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:maxLines="2"
            android:text="abcabcacbacbacbacbacbacacacacacasdadasd"
            android:ellipsize="end"
            android:id="@+id/item_info"/>
    </LinearLayout>
</LinearLayout>

　　

6）主布局

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context="com.example.nanchen.retrofitdemo.RetrofitJsonActivity">


    <ListView
        android:id="@+id/json_lv"
        android:layout_width="match_parent"
        android:layout_height="match_parent">
    </ListView>
</RelativeLayout>

　　

7）自定义适配器，其中又用到了他们的图片加载框架picasso，我们在一个项目中最好都用一个团队的框架，这样才会让出错的几率大大降低。

当然别忘了添加支持包

compile 'com.squareup.picasso:picasso:2.3.2'

　　再是Adapter

package com.example.nanchen.retrofitdemo.json;

import android.content.Context;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.BaseAdapter;
import android.widget.ImageView;
import android.widget.TextView;

import com.example.nanchen.retrofitdemo.R;
import com.squareup.picasso.Picasso;

import java.util.Collection;
import java.util.List;

/**
 * Created by 南尘 on 16-7-15.
 */
public class MyAdapter extends BaseAdapter {

    private Context context;
    private List<Cook> list;

    public MyAdapter(Context context, List<Cook> list) {
        this.context = context;
        this.list = list;
    }

    @Override
    public int getCount() {
        if (list != null){
            return list.size();
        }
        return 0;
    }

    @Override
    public Object getItem(int position) {
        return list.get(position);
    }

    @Override
    public long getItemId(int position) {
        return position;
    }

    @Override
    public View getView(int position, View convertView, ViewGroup parent) {
        if (convertView == null){
            convertView = LayoutInflater.from(context).inflate(R.layout.list_item,parent,false);
            convertView.setTag(new ViewHolder(convertView));
        }
        ViewHolder holder = (ViewHolder) convertView.getTag();
        Cook cook = list.get(position);
        holder.tv_title.setText(cook.getName());
        holder.tv_info.setText(cook.getDescription());
        //使用同样开发团队的Picasso支持包进行图片加载，由于接口中返回的img路径不是全的，所以需要加上网站前缀
        Picasso.with(context).load("http://tnfs.tngou.net/img"+cook.getImg()).into(holder.iv);
        return convertView;
    }

    public void addAll(Collection<? extends Cook> collection){
        list.addAll(collection);
        notifyDataSetChanged();
    }

    public static class ViewHolder{
        private final ImageView iv;
        private final TextView tv_title;
        private final TextView tv_info;

        public ViewHolder(View item){
            iv = ((ImageView) item.findViewById(R.id.item_iv));
            tv_title = ((TextView) item.findViewById(R.id.item_title));
            tv_info = ((TextView) item.findViewById(R.id.item_info));
        }
    }
}

8）再看看Activity的代码

package com.example.nanchen.retrofitdemo;

import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.widget.ListView;

import com.example.nanchen.retrofitdemo.json.Cook;
import com.example.nanchen.retrofitdemo.json.MyAdapter;
import com.example.nanchen.retrofitdemo.json.Tngou;

import java.util.List;

import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.Response;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;

public class RetrofitJsonActivity extends AppCompatActivity implements Callback<Tngou> {


    private ListView lv;

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

        Retrofit retrofit = new Retrofit.Builder().baseUrl("http://www.tngou.net")
                .addConverterFactory(GsonConverterFactory.create()).build();
        Service service = retrofit.create(Service.class);
        Call<Tngou> call = service.getList("cook",0, 1, 20);
        call.enqueue(this);
        lv = (ListView) findViewById(R.id.json_lv);

    }

    @Override
    public void onResponse(Call<Tngou> call, Response<Tngou> response) {
        List<Cook> list = response.body().getList();
        lv.setAdapter(new MyAdapter(this,list));
    }

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

    }
}

最后上一波运行图

2016年8月1日补充

————————————————————————————————————————————————

下面带来一些2.0版本后需要注意的问题。

1）Retrofit  2.0版本后趋向于在baseUrl中以“/”结尾，@Url不要以“/”开头，这样更专业。额，其实你还可以把整个地址放在接口中去，这样baseUrl就忽略了。

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

2）Retrofit的事务可以在之后立即取消，只需要调用call.cancel（）即可，好简单哈哈。

3）官方提供了好几种ConverterFactory，适合你的才是最好的，自己去选择吧~

Gson: com.squareup.retrofit:converter-gson

Jackson: com.squareup.retrofit:converter-jackson

Moshi: com.squareup.retrofit:converter-moshi

Protobuf: com.squareup.retrofit:converter-protobuf

Wire: com.squareup.retrofit:converter-wire

Simple XML: com.squareup.retrofit:converter-simplexml

4）额，你还可以选择实现Converter.Factory接口来自定义一个converter，啦啦啦。

5）oh，no，遇到服务器返回的时间格式很奇葩怎么办？哈哈，其实你完全可以通过GsonBuilder().create()创建一个gson对象作为Converter的参数来实现自定义Gson对象呀。

 //需要使用的时候放到GsonConverterFactory.create(gson)中作为参数即可。
        Gson gson = new GsonBuilder().setDateFormat("yyyy-MM-dd  HH:mm:ss").create();
        
        
        
        Retrofit retrofit = new Retrofit.Builder().baseUrl("http://www.tngou.net/")
                .addConverterFactory(GsonConverterFactory.create(gson)).build();

6）之前有的小伙伴会问为什么我们在Demo中用call.enqueue而没有用execute，这是因为我们一般都选择用enqueue，这样会默认在异步线程中执行，少写一个线程，何乐而不为呢？

7）额，之前Demo没有对Retrofit 2.0 的注解方式进行完善的整理，这里给大家带来一些更详细的东西。

8）首先带来http的请求方法：

我们一般常用的就是GET请求和POST请求，当然你或许会用到http的其他注解方式，值得注意的是HTTP注解方式可以涵盖上面的任意一种注解。

而它有三个属性：method,path,hasBody。

9）再带来标记类

额，上面的这个表单请求，我相信在post请求中用的不少吧，你值得尝试。

10）当然就少不了我们的参数类咯，图片来源于网络。

这里值得注意的是：

{占位符}和path都尽量出现在Url的path部分，url中的参数使用Query和QueryMap代替，保证接口定义的简洁。

另外，Query，Field和Part都支持数组和实现了Iterable接口的类型，如List，Set等，方便向后台传递数组。

好了，这个强大的Retrofit就补充到这里了，大家可以自行补充。