Android开发JSONObject的使用

什么是JSON

1、JSON 指的是 JavaScript 对象表示法(JavaScript Object Notation)
2、JSON 是轻量级的文本数据交换格式
3、JSON 独立于语言 (单纯的数据格式,不受语言的约束)
4、JSON 具有自我描述性,更易理解

从官网描述可以看出,JSON本身是JavaScript中对象的描述格式,后来得以推广并慢慢取代xml。

JSON和XML的比较

相比 XML 的不同之处

1、没有结束标签(类似于键值对的形式)
2、更短(没有结束标签,当然短了)
3、读写的速度更快
4、能够使用内建的 JavaScript eval() 方法进行解析
5、使用数组
6、不使用保留字

原生JSON解析

Android原生的解析实际上使用的是JSON的一个官方jar包。
在使用之前我们需要下载org.json的jar包。对于Android 开发环境不需要下载此jar包。因为Android SDK 中已经默认包含了该jar包。
json jar 下载地址
下载完之后导入即可。

JSONObject对象解析

下面看一下数据

{
    "user":{
        "name":"alex",
        "age":"18",
        "isMan":true
    }
}

有一个user字段,其中包含了该user的一些基本属性。那么如何解析呢?
在解析时,有一个很关键的地方:如果是{}包含,则为JSONObject对象,如果为[]则为JSONArray对象。
看到上面的例子,我们看到整个数据为JSONObject,其内部包含了一个user字段,该字段的值也是一个JSONObject对象。

public class OrgJSONTest {
    public static String json = "{\"user\":{\"name\":\"alex\",\"age\":\"18\",\"isMan\":true}}";

    public static void main(String[] args){
        JSONObject obj = new JSONObject(json);//最外层的JSONObject对象
        JSONObject user = obj.getJSONObject("user");//通过user字段获取其所包含的JSONObject对象
        String name = user.getString("name");//通过name字段获取其所包含的字符串
        System.out.println(name);
    }
}

打印结果如下
<alex
可以看到获取到了相应的值。
在JSONObject对象中封装了getXXX()等一系列方法。用以获取字符串,整形等等一系列的值。

对于如上例子,完全解析user对象如下

String name = user.getString("name");//通过name字段获取其所包含的字符串
String age = user.getString("age");
boolean isMan = user.getBoolean("isMan");
System.out.println("name:"+name+"\nage:"+age+"\nisMan:"+isMan);

结果如下
<name:alex
age:18
isMan:true
这种通过getXXX的方式,无疑会出现一些问题,我们开始一一尝试。

getXXX方法获取的类型不符

1、字符串类型转整形

对于上面的例子,我们可以看到age字段虽然其对应的值是双引号括起的字符串,但其实际上是一个整形,那么我们是否能够通过getInt获取整形呢

int age = user.getInt("age");

当然是可以得,同时字符串类型可以转化为布尔类型,整数类型,浮点型等等。但字符串的内容必须符合规范,否则会报异常。如果看其源码可知,其内部实质是调用了对应对象的parseXXX()方法进行转化操作。

    //getInt源码
  public int getInt(String key) throws JSONException {
        Object object = this.get(key);
 
        try {
            //关键点,如果是数值类型,则调用intValue(),否则强转成字符串之后调用parserInt方法()
            return object instanceof Number?((Num,ber)object).intValue():Integer.parseInt((String)object);
        } catch (Exception var4) {
            throw new JSONException("JSONObject[" + quote(key) + "] is not an int.");
        }
    }

2、整形等转字符串类型
按照如上的思维逻辑,直接getString("xxx")就可以了。但事实正好相反,该方法,如果对应值不是双引号括起的,则会抛出异常。

 //getString 源码
 public String getString(String key) throws JSONException {
        Object object = this.get(key);
        //直接判断是否是字符串类型,如果不是,则抛出异常
        if(object instanceof String) {
            return (String)object;
        } else {
            throw new JSONException("JSONObject[" + quote(key) + "] not a string.");
        }
    }

getXXX(“”) 没有对应的键值
通过上面的例子,可以得知getXXX("")方法是通过字段(键)获取对应的值。那么肯定存在一种情况,及没有键的存在。

System.out.println(user.getString("sex"));
报错:
Exception in thread "main" org.json.JSONException: JSONObject["sex"] not found.
    at org.json.JSONObject.get(JSONObject.java:471)
    at org.json.JSONObject.getString(JSONObject.java:717)
    at json.OrgJSONTest.main(OrgJSONTest.java:24)

果断报异常。

那么怎么办呢:使用optXXX()。

这里简单讲解了JSONObject解析字符串,下面具体举一个例子:
Android App 接受服务端通知是非常常见的业务逻辑,比如微信公众号消息推送,推文推送,或者接受聊天信息等

现在有一个业务,需要在App端实时监听订单的状态,这里我使用mqtt协议来时时获取服务端最新的消息
MQ服务消息到达回调方法

@Override
        public void messageArrived(String topic, final MqttMessage message) throws Exception {
            try{
                // 读取本地保存用户的登录信息
                SharedPreferences sp = getSharedPreferences("token_data", Context.MODE_PRIVATE);
                String token = sp.getString("token","");
                if(TextUtils.isEmpty(token)){
                    return;
                }
                String msg = new String(message.getPayload());
                Gson gson = new Gson();
                JSONObject jsonObject = new JSONObject(msg);
            
                JSONObject taskList = (JSONObject)jsonObject.get("agv_task_list");
                Map<String, ArrayList<StockTaskBean>> map = new HashMap<>();
                Iterator<String> taskKeysIterator = taskList.keys();
                while (taskKeysIterator.hasNext()) {
                    String next = taskKeysIterator.next();
                    ArrayList<StockTaskBean> beans = new ArrayList<>();
                    JSONArray array = taskList.getJSONArray(next);
                    for (int i=0; i<array.length(); i++){
                        JSONObject object = array.getJSONObject(i);//遍历得到数组中的各个对象
                        StockTaskBean bean = gson.fromJson(object.toString(), StockTaskBean.class);
                        beans.add(bean);
                    }
                    map.put(next,beans);
                }
                ArrayList<StockTaskBean> beans = map.get(token);
                if(beans != null){
                    intentAgvTaskListBroadcast.putExtra("agv_task_list",beans);
                    sendBroadcast(intentAgvTaskListBroadcast);
                }


                JSONObject freeShelList = (JSONObject)jsonObject.get("freeShelfPoint");
                ArrayList<SpinnerBean> freeShelBeans = new ArrayList<>();
                Iterator<String> freeShelfIterator = freeShelList.keys();
                while (freeShelfIterator.hasNext()) {
                    String next = freeShelfIterator.next();
                    String value = freeShelList.getString(next);
                    SpinnerBean bean = new SpinnerBean(next,value);
                    freeShelBeans.add(bean);
                }

                intentAgvShelfPointBroadcast.putExtra("freeShelfPoint",freeShelBeans);
                sendBroadcast(intentAgvShelfPointBroadcast);
            }catch (Exception e){
                Log.d(TAG, "消息到达处理异常:"+e.getMessage());
            }
        }

接收到服务端的json消息格式如下:

{
    "freeShelfPoint": {
        "10101020": "f03fb1e9de19422cb9ec82b9cd37a1c8"
    }, 
    "agv_task_list": {
        "9bdfbae87f4441d4b0176ee042dc3cd4": [
            {
                "taskId": "a46f3c66d28b48c78996a4290138db00", 
                "taskState": "3", 
                "taskCode": "20230616384163", 
                "taskOrder": "10000468259", 
                "taskBatch": "CO2300732", 
                "line": "包装-1线", 
                "shelfPoint": "10701175", 
                "stockPoint": "09901065,09601065", 
                "transferPoint": "10101315", 
                "callPoint": "", 
                "releasePoint": "", 
                "productTime": "2023-06-14", 
                "carposition": ""
            }, 
            {
                "taskId": "d16c17859b2143b58c427f478b14fcf4", 
                "taskState": "3", 
                "taskCode": "20230616881205", 
                "taskOrder": "10000468259", 
                "taskBatch": "CO2300732", 
                "line": "包装-1线", 
                "shelfPoint": "10701270", 
                "stockPoint": "09501065", 
                "transferPoint": "10101220", 
                "callPoint": "", 
                "releasePoint": "", 
                "productTime": "2023-06-14", 
                "carposition": ""
            }, 
            {
                "taskId": "f871ab15a847442bbbb82809d2268198", 
                "taskState": "0", 
                "taskCode": "202306168857", 
                "taskOrder": "10000468259", 
                "taskBatch": "CO2300732", 
                "line": "包装-1线", 
                "shelfPoint": "10701515", 
                "stockPoint": "09301065", 
                "transferPoint": "", 
                "callPoint": "", 
                "releasePoint": "", 
                "productTime": "2023-06-14", 
                "carposition": ""
            }
        ], 
        "ac7e0361a712474cb18b9e4913f0d1c2": [
            {
                "taskId": "ee0e282895fe4963b556dc096190b0c2", 
                "taskState": "1", 
                "taskCode": "20230615669165", 
                "taskOrder": "10000468259", 
                "taskBatch": "CO2300732", 
                "line": "包装-1线", 
                "shelfPoint": "10701360", 
                "stockPoint": "09901420", 
                "transferPoint": "", 
                "callPoint": "", 
                "releasePoint": "", 
                "productTime": "2023-06-13", 
                "carposition": ""
            }
        ]
    }
}

因为接受的是字符串,所以直接将字符串作为参数传入JSONObject构造函数实例化一个JSONObject对象

JSONObject jsonObject = new JSONObject(msg);

接下去就是对jsonObject 进行操作
可以看到上面的json消息分为两部分

freeShelfPoint的key/value都是字符串,这很简单,使用freeShelList.keys()生成一个key的迭代器,然后遍历每个key获取对应的value转换成对象,保存在集合中

JSONObject freeShelList = (JSONObject)jsonObject.get("freeShelfPoint");
                ArrayList<SpinnerBean> freeShelBeans = new ArrayList<>();
                Iterator<String> freeShelfIterator = freeShelList.keys();
                while (freeShelfIterator.hasNext()) {
                    String next = freeShelfIterator.next();
                    String value = freeShelList.getString(next);
                    SpinnerBean bean = new SpinnerBean(next,value);
                    freeShelBeans.add(bean);
                }

agv_task_list的值中,key/value变成 字符串/集合的方式,就要多处理一下
jsonObject.get("agv_task_list")获取到agv_task_list里面jsonObject对象,和上面一样生成key的迭代器,遍历每个key获取对应的value,这里的value是数组自然就要使用 getJSONArray(key)的方式获取到 JSONArray array 对象,for循环遍历JSONArray 后利用Gson的fromJson(String json, Class<T> classOfT)方法直接将json对象转换成Javabean对象。

OK 以上就是我的一些分享~

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容