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就补充到这里了,大家可以自行补充。
android快捷开发之Retrofit网络加载框架的简单使用的更多相关文章
- WebGIS开发之用openlayers加载离线百度地图
因为项目需要,只有内网环境,没有外网环境,所以需要下载地图瓦片. 一.下载瓦片地图 这个可以自行在网上找一些地图瓦片下载器,下好的瓦片地图是分级的.大概如图这种类型. 二.在地图上显示标记 首先使用o ...
- Android 图片加载框架Picasso基本使用和源码完全解析(巨细无比)
写在之前 原本打算是每周更新一篇博文,同时记录一周的生活状态,但是稍微工作忙一点就顾不上写博客了.悲催 还是说下最近的状况,最近两周一直在接公司申请的计费点, 沃商店,银贝壳,微信等等,然后就是不停的 ...
- android 网络加载图片,对图片资源进行优化,并且实现内存双缓存 + 磁盘缓存
经常会用到 网络文件 比如查看大图片数据 资源优化的问题,当然用开源的项目 Android-Universal-Image-Loader 或者 ignition 都是个很好的选择. 在这里把原来 ...
- Android 开发 图片网络缓存加载框架Fresco
简介 Fresco是一个在Android应用程序中显示图像的强大系统. Fresco负责图像的加载和显示.它将从网络.本地存储或本地资源加载图像,图像加载完成前会显示一个占位图片.它有两个级别的缓存: ...
- 【转】Android循环滚动广告条的完美实现,封装方便,平滑过渡,从网络加载图片,点击广告进入对应网址
Android循环滚动广告条的完美实现,封装方便,平滑过渡,从网络加载图片,点击广告进入对应网址 关注finddreams,一起分享,一起进步: http://blog.csdn.net/finddr ...
- Android混合开发之WebView与Javascript交互
前言: 最近公司的App为了加快开发效率选择了一部分功能采用H5开发,从目前市面的大部分App来讲,大致分成Native App.Web App.Hybrid App三种方式,个人觉得目前以Hybri ...
- Android混合开发之WebView使用总结
前言: 今天修改项目中一个有关WebView使用的bug,激起了我总结WebView的动机,今天抽空做个总结. 混合开发相关博客: Android混合开发之WebView使用总结 Android混合开 ...
- Android安全开发之ZIP文件目录遍历
1.ZIP文件目录遍历简介 因为ZIP压缩包文件中允许存在“../”的字符串,攻击者可以利用多个“../”在解压时改变ZIP包中某个文件的存放位置,覆盖掉应用原有的文件.如果被覆盖掉的文件是动态链接s ...
- Android 安全开发之 ZIP 文件目录遍历
1.ZIP文件目录遍历简介 因为ZIP压缩包文件中允许存在"../"的字符串,攻击者可以利用多个"../"在解压时改变ZIP包中某个文件的存放位置,覆盖掉应用原 ...
随机推荐
- JS正则表达式常用总结
正则表达式的创建 JS正则表达式的创建有两种方式: new RegExp() 和 直接字面量. //使用RegExp对象创建 var regObj = new RegExp("(^\\s+) ...
- Linux安装LAMP开发环境及配置文件管理
Linux主要分为两大系发行版,分别是RedHat和Debian,lamp环境的安装和配置也会有所不同,所以分别以CentOS 7.1和Ubuntu 14.04做为主机(L) Linux下安装软件,最 ...
- FREERTOS 手册阅读笔记
郑重声明,版权所有! 转载需说明. FREERTOS堆栈大小的单位是word,不是byte. 根据处理器架构优化系统的任务优先级不能超过32,If the architecture optimized ...
- Security Policy:行级安全(Row-Level Security)
行级安全RLS(Row-Level Security)是在数据行级别上控制用户的访问,控制用户只能访问数据库表的特定数据行.断言是逻辑表达式,在SQL Server 2016中,RLS是基于安全断言( ...
- OpenGL超级宝典笔记----框架搭建
自从工作后,总是或多或少的会接触到客户端3d图形渲染,正好自己对于3d图形的渲染也很感兴趣,所以最近打算从学习OpenGL的图形API出发,进而了解3d图形的渲染技术.到网上查了一些资料,OpenGL ...
- [Android]使用Dagger 2进行依赖注入 - Producers(翻译)
以下内容为原创,欢迎转载,转载请注明 来自天天博客:http://www.cnblogs.com/tiantianbyconan/p/6234811.html 使用Dagger 2进行依赖注入 - P ...
- liunx 磁盘管理命令记录
Linux磁盘管理好坏管理直接关系到整个系统的性能问题. Linux磁盘管理常用三个命令为df.du和fdisk. df:列出文件系统的整体磁盘使用量 du:检查磁盘空间使用量 fdisk:用于磁盘分 ...
- v14.0\AspNet\Microsoft.Web.AspNet.Props 找不到
错误 E:\Github\AutoMapper\src\AutoMapper\AutoMapper.CoreCLR.kproj : error : 未找到导入的项目"C:\Program ...
- .NET基础拾遗(1)类型语法基础和内存管理基础
Index : (1)类型语法.内存管理和垃圾回收基础 (2)面向对象的实现和异常的处理 (3)字符串.集合与流 (4)委托.事件.反射与特性 (5)多线程开发基础 (6)ADO.NET与数据库开发基 ...
- 让ASP.NET接受有“潜在危险”的提交
什么是有“潜在危险”的提交?马上动手写个简单的例子: 用Visual Studio创建一个空白的ASP.NET MVC程序,一切默认即可,添加一个空白的HomeController,增加一个Ind ...