Xamarin.Android下获取与解析JSON

时间:2022-07-01 19:32:26

一、新建项目

1.新建一个Android项目,并命名为为NetJsonList

Xamarin.Android下获取与解析JSON

2.右击引用,选择添加引用,引用System.Json.dll

Xamarin.Android下获取与解析JSON

二、同步请求

既然是跨平台,我们自然不能按照java下的方式进行编写,否则如何跨平台呢,所以我们需要使用Syste.Net命名空间下的两个类:HttpWebRequestHttpWebResponse

首先打开Resources/layout/Main.axml文件

Xamarin.Android下获取与解析JSON

删除其他上面的控件,并拖拽一个Text(large)到其中。

接着打开MainActivity.cs文件,并将如下代码写入其中

 namespace NetJsonList
{
[Activity(Label = "NetJsonList", MainLauncher = true, Icon = "@drawable/icon")]
public class MainActivity : Activity
{
TextView tv; protected override void OnCreate(Bundle bundle)
{
base.OnCreate(bundle);
SetContentView(Resource.Layout.Main); tv = FindViewById<TextView>(Resource.Id.textView1); LoadXamarin();
} public void LoadXamarin()
{
//测试用
string url = "http://www.xamarin-cn.com/test.json"; //创建一个请求
var httpReq = (HttpWebRequest)HttpWebRequest.Create(new Uri(url)); //获取响应
var httpRes = (HttpWebResponse)httpReq.GetResponse(); //读取响应的字符串
String text = new StreamReader(httpRes.GetResponseStream()).ReadToEnd();
tv.Text = text;
}
}
}

这里我们通过HttpWebRequestCreate静态方法创建了一个请求,那么下面我们可以获取响应了,笔者这里直接使用StreamReader读取了,以便显示出来。

注:如果要在在短时间内高频率的使用HTTP请改用HttpURLConnection。

最终显示的结果如下所示:

Xamarin.Android下获取与解析JSON

但是我们在编码的过程中绝对不能这么做,因为这样会使UI线程阻塞。意思就是用户使用这个app时会出现卡顿,这样对于任何一个人使用者来说都是很难忍受的,所以下面我们要采用异步的方式来实现。

三、异步请求

首先我们先把异步请求回调的方法写出来:

         //异步回调方法
public void ReadXamarin(IAsyncResult asyn)
{
var httpReq = (HttpWebRequest)asyn.AsyncState; //获取响应
using (var httpRes = (HttpWebResponse)httpReq.EndGetResponse(asyn))
{
//判断是否成功获取响应
if (httpRes.StatusCode == HttpStatusCode.OK)
{
//读取响应
var text = new StreamReader(httpRes.GetResponseStream()).ReadToEnd(); //切换到UI线程,否则无法对控件进行操作
RunOnUiThread(() =>
{
tv.Text = text;
});
}
}
}

通过AsyncState获取HttpWebRequest的引用,然后再调用其EndGetResponse方法获取响应,并将响应的字符串显示,特别需要注意的是我们这里使用了RunOnUiThread方法,因为异步回调的方法不是使用UI线程执行的,这也是为什么这样做就不会阻塞UI线程了。

当然有了异步操作的回调方法,自然在调用的时候需要使用特殊的方法:

         public void LoadXamarin()
{
//测试用
string url = "http://www.xamarin-cn.com/test.json"; //创建一个请求
var httpReq = (HttpWebRequest)HttpWebRequest.Create(new Uri(url));
httpReq.BeginGetResponse(new AsyncCallback(ReadXamarin), httpReq);
}

所有的代码如下所示:

 namespace NetJsonList
{
[Activity(Label = "NetJsonList", MainLauncher = true, Icon = "@drawable/icon")]
public class MainActivity : Activity
{
TextView tv; protected override void OnCreate(Bundle bundle)
{
base.OnCreate(bundle);
SetContentView(Resource.Layout.Main); tv = FindViewById<TextView>(Resource.Id.textView1); LoadXamarin();
} public void LoadXamarin()
{
//测试用
string url = "http://www.xamarin-cn.com/test.json"; //创建一个请求
var httpReq = (HttpWebRequest)HttpWebRequest.Create(new Uri(url));
httpReq.BeginGetResponse(new AsyncCallback(ReadXamarin), httpReq);
} //异步回调方法
public void ReadXamarin(IAsyncResult asyn)
{
var httpReq = (HttpWebRequest)asyn.AsyncState; //获取响应
using (var httpRes = (HttpWebResponse)httpReq.EndGetResponse(asyn))
{
//判断是否成功获取响应
if (httpRes.StatusCode == HttpStatusCode.OK)
{
//读取响应
var text = new StreamReader(httpRes.GetResponseStream()).ReadToEnd(); //切换到UI线程,否则无法对控件进行操作
RunOnUiThread(() =>
{
tv.Text = text;
});
}
}
}
}
}

四、利用await的异步请求

通过c# 5.0 的新特性await我们可以写更少的代码实现异步,我们修改LoadXamarin方法:

         public async void LoadXamarin()
{
//测试用
string url = "http://www.xamarin-cn.com/test.json"; //创建一个请求
var httpReq = (HttpWebRequest)HttpWebRequest.Create(new Uri(url));
var httpRes = (HttpWebResponse)await httpReq.GetResponseAsync();
if (httpRes.StatusCode == HttpStatusCode.OK)
{
var text = new StreamReader(httpRes.GetResponseStream()).ReadToEnd();
tv.Text = text;
}
}

可以看到我们给这个方法加了一个async关键字,如果不加这个关键字,在该方法中是无法使用await的,下面我们就看到了这句代码:

 var httpRes = (HttpWebResponse)await httpReq.GetResponseAsync();

当Ui线程执行到这句后,直接就会跳过去,不会等待。当然下面的方法也不会去执行了,只有当这个方法返回了结果之后,UI线程才会回到这句代码,并继续执行下面的方法。当然这些只是障眼法,其实c#已经把下面的代码作为了异步回调执行的方法了:

             if (httpRes.StatusCode == HttpStatusCode.OK)
{
var text = new StreamReader(httpRes.GetResponseStream()).ReadToEnd();
tv.Text = text;
}

并且执行的线程依然是之前执行该方法的线程,如果你创建一个新的线程去执行。那么就必须使用RunOnUiThread方法了。还有一个缺点就是不能在其中进行复杂的运算,否则还是会造成UI线程的阻塞。

五、解析JSON

在开始本节前,必须确保引用了正确的System.Json类库,否则无法使用。

首先我们先看看json数据的格式:

 {
"T": [
"T1",
"T2",
"T3",
"T4"
]
}

知道了json数据格式了,我们还要理解下System.Json中有哪些类:

JsonValue:是基础类,代表一个Json值

JsonObject:继承JsonValue,代表一个Json对象

JsonArray:继承JsonValue,代表一个Json数组

JsonPrimitive:继承JsonValue,组织Json数据时用

JsonType:枚举,区分是什么类型

而我们今天只需要使用到JsonObjectJsonArray,首先是JsonObject代表整个Json对象,我们可以通过它的静态方法Load直接读取流,比如下面的方式:

 var text = JsonObject.Load(httpRes.GetResponseStream());

但是Load返回的是JsonValue,但是大多数情况都是代表一个Json对象,所以我们需要将它强制转换成JsonObject类型,这样我们就可以读取其中的T了:

                 var text = (JsonObject)JsonObject.Load(httpRes.GetResponseStream());
var array = (JsonArray)text["T"];

当然我们还需要使用Linq读取这个数组(注意要using System.Linq命名空间

                 var text = (JsonObject)JsonObject.Load(httpRes.GetResponseStream());
var result = (from item in (JsonArray)text["T"]
select item.ToString()).ToArray();

这样我们获取了一个字符串组了,result类型为string[]。为了显示这个数组,我们需要将当前的活动继承自ListActivity:

Xamarin.Android下获取与解析JSON

然后将代码修改成如下所示:

 namespace NetJsonList
{
[Activity(Label = "NetJsonList", MainLauncher = true, Icon = "@drawable/icon")]
public class MainActivity : ListActivity
{
protected override void OnCreate(Bundle bundle)
{
base.OnCreate(bundle);
LoadXamarin();
} public async void LoadXamarin()
{
//测试用
string url = "http://www.xamarin-cn.com/test.json"; //创建一个请求
var httpReq = (HttpWebRequest)HttpWebRequest.Create(new Uri(url));
var httpRes = (HttpWebResponse)await httpReq.GetResponseAsync();
if (httpRes.StatusCode == HttpStatusCode.OK)
{
var text = (JsonObject)JsonObject.Load(httpRes.GetResponseStream());
var result = (from item in (JsonArray)text["T"]
select item.ToString()).ToArray();
ListAdapter = new ArrayAdapter<string>(this, Android.Resource.Layout.SimpleListItem1, result);
}
}
}
}

六、解决翻转后重复执行

做到这步的可以在LoadXamarin中下一个断点,当你点击模拟器并按下Ctrl+F12翻转后你会发现LoadXamarin又重新执行了一次。这样就带来了一个问题,有时候我们仅仅只需要第一次获取即可,该翻转则会导致重复执行,那么就会浪费用户的流量同时也会浪费资源,所以我们这里就需要能够将这种状态维持,这里我们就需要重写OnRetainNonConfigurationInstance事件,当然该方法需要返回一个Java.Lang.Object类型的返回值,而这个返回值就是我们需要保存的状态,当然这个状态不会存在于OnCreate的bundle中,还是有一个专门的属性LastNonConfigurationInstance,这样我们可以将上面的代码改写成如下:

 namespace NetJsonList
{
[Activity(Label = "NetJsonList", MainLauncher = true, Icon = "@drawable/icon")]
public class MainActivity : ListActivity
{
class Test : Java.Lang.Object
{
public string[] Results { get; set; }
} Test t; protected override void OnCreate(Bundle bundle)
{
base.OnCreate(bundle);
LoadXamarin();
} //重写该方法
public override Java.Lang.Object OnRetainNonConfigurationInstance()
{
return t;
} public async void LoadXamarin()
{
t = LastNonConfigurationInstance as Test;
//判断是否存在之前的状态
if (t != null)
{
ListAdapter = new ArrayAdapter<string>(this, Android.Resource.Layout.SimpleListItem1, t.Results);
}
else
{ //测试用
string url = "http://www.xamarin-cn.com/test.json"; //创建一个请求
var httpReq = (HttpWebRequest)HttpWebRequest.Create(new Uri(url));
var httpRes = (HttpWebResponse)await httpReq.GetResponseAsync();
if (httpRes.StatusCode == HttpStatusCode.OK)
{
var text = (JsonObject)JsonObject.Load(httpRes.GetResponseStream());
var result = (from item in (JsonArray)text["T"]
select item.ToString()).ToArray();
t = new Test()
{
Results = result
};
ListAdapter = new ArrayAdapter<string>(this, Android.Resource.Layout.SimpleListItem1, result);
}
}
}
}
}

七、小结

通过上面的学习我们仅仅掌握了在跨平台下最基础的网络访问以及Json数据解析的方法,还有在活动如何保存当前的状态。