BaseJson

基于 org.json 的改进型 Json 解析库，快速解析 Json 为 Map 或 List 对象，甚至直接由 JsonList 创建列表可用的适配器。

<a href="https://github.com/kongzue/BaseJson/"> <img src="https://img.shields.io/badge/BaseJson-1.0.7-green.svg" alt="BaseOkHttp"> </a> <a href="https://github.com/kongzue/BaseJson/releases"> <img src="https://img.shields.io/github/v/release/kongzue/BaseJson?color=green" alt="Maven"> </a> <a href="https://jitpack.io/#kongzue/BaseJson"> <img src="https://jitpack.io/v/kongzue/BaseJson.svg" alt="Jitpack.io"> </a> <a href="http://www.apache.org/licenses/LICENSE-2.0"> <img src="https://img.shields.io/badge/License-Apache%202.0-red.svg" alt="License"> </a> <a href="http://www.kongzue.com"> <img src="https://img.shields.io/badge/Homepage-Kongzue.com-brightgreen.svg" alt="Homepage"> </a>

简介

BaseJson 的目标不是能让 json 解析变得多快，而是让开发者能更轻松的完成 json 到 UI 的呈现。

BaseJson 直接将 json 以 Map 和 List 承载能更轻松的符合适配器、序列化的需求，也能更轻松的应对各种奇葩的、不符合规范的 json

尽量减少异常的产生，尽量保证业务能够快速开发，更符合敏捷开发的需要，牺牲一定的性能我觉着也能接受吧😆

• 将 Json 转换为 Map 或 List 的子类，可直接用于 Adapter，省去编写 Bean 的过程。
• JsonMap 也可轻松与 JavaBean 互相转换。
• 高容错设计，使用自定义 get 方法，无论如何绝不会出现空指针，哪怕类型错误，你也无须担心空指针异常；
• 无缝衔接 Map 和 List，可随意通过 Map 或 List 直接转换为 Json 对象；
• 借助 Map 和 List 的优势，.isEmpty()判空，KeySet()遍历、Collections.sort()排序等操作帮助你轻松完成解析。

Maven仓库或Gradle的引用方式

jitPack

在项目根目录的 build.gradle(Project) 添加:

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

最新版本：

<a href="https://jitpack.io/#kongzue/BaseJson"> <img src="https://jitpack.io/v/kongzue/BaseJson.svg" alt="Jitpack.io"> </a>

在 build.gradle(app) 添加:

dependencies {
        implementation 'com.github.kongzue:BaseJson:1.2.0'
}

jCenter（已停止服务）：

在dependencies{}中添加引用：

implementation 'com.kongzue.basejson:basejson:1.0.7'

概念

本组件对 Json 的定义如下：

对于 Json 对象，为 JsonMap，对于 Json 集合，为 JsonList。

JsonMap 是 Map 的子类，JsonList 是 List 的子类，本身各自具备 Map、List 的特点，适用于一切 Map、List 的使用场景。

可通过 JsonBean 工具类，实现 JavaBean 与 JsonMap 之间的互相转换，这里使用了反射技术。

在 get 值时，建议使用 JsonMap 和 JsonList 定义的 getString(key)、getBoolean(key) 等方法，使用 Map、List 原本的 get 依然可能获得空对象（null）。

使用 JsonMap 和 JsonList 定义的 get 类方法不会有返回空对象的情况。

由 String 创建 JsonMap/JsonList

使用以下代码将 Json 文本解析为 JsonMap：

JsonMap data = new JsonMap("{\"key\":\"DFG1H56EH5JN3DFA\",\"token\":\"124ASFD53SDF65aSF47fgT211\"}");

使用以下代码将 Json 文本解析为 JsonList：

JsonList list = new JsonList("[{\"answerId\":\"98\",\"questionDesc\":\"否\"},{\"answerId\":\"99\",\"questionDesc\":\"是\"}]");

若 Json 文本不合法，或内容有错误，则可能返回 空内容 的 JsonMap/JsonList。

读取值

使用 JsonMap 和 JsonList 定义的 getString(key)、getBoolean(key) 等方法不会读取空指针。

即，对于以下 Json：

{
    "key":"DFG1H56EH5JN3DFA",
    "token":"124ASFD53SDF65aSF47fgT211"
}

若执行：

JsonMap data = JsonMap.parse("{\"key\":\"DFG1H56EH5JN3DFA\",\"token\":\"124ASFD53SDF65aSF47fgT211\"}");

String key = data.getString("key");                     //获得“key”的值
String name = data.getString("name");                   //显然，这段 json 并没有“name”字段
JsonMap data = data.getJsonMap("data");                 //这段 json 中没有名为“data”的子 json 对象
String age = data.getJsonMap("data").getInt("age");     //更不可能有“data”下的值“age”

上述 get 方法均不会报空指针错误，而是会获得该类型的默认空值，即：

key = "DFG1H56EH5JN3DFA"
name = ""
data = new JsonMap()    //返回空的 JsonMap 对象，可使用 isEmpty() 判空
age = 0

对于默认状态可能为 0 的 int 类型的值，或本身可能为 "" 的 String 类型的值，可以使用如下方法来设置 defaultValue：

String name = data.getString("name", "zhangsan");           //若该字段为空，则返回 “zhangsan”
String age = data.getJsonMap("data").getInt("age", -1);     //若该字段为空，则返回 -1

弹性设计是为了避免不必要的空指针问题，但同时也兼顾判空的麻烦情况，减少代码所需要对空指针的额外判断。

在 JsonList 中查找

对于 JsonList，要寻找其中含有已知 key=value 的 JsonMap，可使用 .findJsonMap(key, value) 来寻找其中符合结果的 JsonMap，例如：

//查找某个符合 key=value 的结果：
JsonMap result = jsonList.findJsonMap("key", "value");
// result 不会为 null，若需要判空请使用 result.isEmpty()

//查找某个符合 key=value 的结果，并对其内容进行修改：
        jsonList.findJsonMap("key", "value")
        .set("age", 3);

JsonList 数据预处理

当 JsonList 的数据全都是 JsonMap，且需要对 JsonMap 的数据内容进行预处理，那么可以通过以下方法实现：

JsonList list = ...;
        list.preprocessedJsonMapData(new JsonMapPreprocessingEvents() {
@Override
public JsonMap processingData(JsonMap originData) {
        originData.set("goods_price_str", "¥" + originData.getString("goods_price"));
        return originData;
        }
        });
        System.out.println(list.toString());

上述代码会将 JsonList 中每个 JsonMap 的 goods_price 字段读取，并设置一个新的字段：goods_price_str ，使其值等于 "¥" + goods_price。

当 Json 存在问题

对于如下异常情况，也可以放心使用：

{
    "key":"DFG1H56EH5JN3DFA",
    "token":"124ASFD53SDF65aSF47fgT211",
    "name":null,
    "data":[],
    "list":"[{"limitMoney\":\"26\",\"discountMoney\":\"3\"},{\"limitMoney\":\"40\",\"discountMoney\":\"4\"}]"
    "age":"3",
    "signed":"true",
}

对于上述 Json，与服务端约定 data 应为 Json 对象而非集合、name 应该有值但给出为 null、age 和 signed 的类型不对，使用本框架按照以下代码，依然能够正常解析：

String name = data.getString("name");       //返回 “” 空值
JsonMap data = data.getJsonMap("data");     //返回空的 JsonMap 对象，可使用 isEmpty() 判空
int age = data.getInt("age");               //返回 3
boolean signed = data.getBoolean("signed"); //返回 true
JsonList list = data.getList("list");       //返回解析为 JsonList 的对象
String list = data.getList("list")
                  .getJsonMap(0)
                  .getInt("limitMoney");    //返回 26

可见，在 BaseJson 中，类型并不是绝对的，不同类型可以进行“软”转换，以获得最符合预期的解析结果。

你无需担心任何来自后端的异常情况，使用 BaseJson 解析都可以保证绝对不会出现空指针异常。

输出 Json 文本

你可以手动创建 JsonMap 或 JsonList，或使用现有的 Map、List 对象构建 JsonMap、JsonList。

使用相应的set(...)方法添加值，然后使用toString()方法构建 Json 文本。

JsonMap data = ...;
String jsonObj = data.toString();

Bean 支持

BaseJson 支持将 json 转换为 JavaBean 对象，只需要在 JavaBean 对象中使用 @JsonValue(key) 注解标注与 json 对应字段，然后使用 jsonMap.toBean(Bean.class) 进行转换。

例如如下的 SentencesBean ：

public class SentencesBean{

    @JsonValue("code")
    private int code;

    @JsonValue("message")
    private String message;

    @JsonValue("result")
    private ResultModel result;

    @Override
    public String toString() {
        return "SentencesBean{" +
                "code=" + code +
                ", message='" + message + '\'' +
                ", result=" + result +
                '}';
    }
}

将 jsonMap 转换为 Bean：

SentencesBean bean = jsonMap.toBean(SentencesBean.class);

要将 Bean 反向转为 JsonMap，可以使用：

JsonMap jsonData = JsonMap.toJsonMap(bean);

JavaBean 支持(旧版)

使用 JsonBean 工具类，实现 JavaBean 与 JsonMap 之间的互相转换，这里使用了反射技术。

请注意编译为 release 时的混淆设置，必须 keep 所有项目中用到的 JavaBean 及 com.kongzue.baseokhttp.util 下的工具类，否则可能在运行时出现问题。

由 JsonMap 转换为 JavaBean

例如现在已经有一个 JavaBean 对象 User，以及对应的数据 jsonMap，则：

User user = JsonBean.getBean(jsonMap, User.class);

即可将 jsonMap 中的数据对应到 User 类中。

请注意，JavaBean 对象中必须包含每个属性的对应 get、set 方法，且必须使用驼峰命名规则。

支持 boolean 类型的数据获取方法以“is”开头的命名方式，例如“boolean isVIP()”或者“boolean getVIP()”都可以。

由 JavaBean 转换为 JsonMap

此时已经有一个设置好数据的 User 对象 user，要转换为 JsonMap：

JsonMap userJson = JsonBean.setBean(user);

转换后即可获得 JsonMap 对象。

Tips:

旧版方案是直接通过查找 json 中变量对应的 set/get 方法调用赋值或者获取值的，因此它需要配置 Bean 的反混淆以避免方法名因混淆导致无法调用。

由 JsonList 直接生成适配器 Adapter

可以使用 JsonList 的方法 .createAdapter(context, layoutResId) 直接生成可用于列表等组件的适配器 JsonListAdapter，也可以通过构造方法构建。

JsonListAdapter 旨在帮助开发者快速并轻松的完成网络请求下来的 json 数据集到界面 UI 构建的过程，只需要对应好 json 数据集（JsonList）中每个 json 数据（JsonMap）中的键值对中的键（key），与制作布局时为其对应的 View 设置好一样的 android:tag 属性，即可完成数据对应绑定显示到 UI。

JsonListAdapter adapter = new JsonListAdapter(me, R.layout.item_my_order_list, orderList);
listView.setAdapter(adapter);

JsonListAdapter 只需要指定上下文（context）、列表项布局资源ID（layoutResId）以及数据集（JsonList）即可自动根据 JsonList 的元素 JsonMap 中 key 对应在列表项布局中对应 tag 的 View 进行关系绑定，并直接为其赋值。

TextView 自动绑定: 当数据为 String 时自动设置 setText；当数据为 int 时自动调用并设置为文本资源 ImageView 自动绑定: 当数据为 int 时自动调用并设置为图像资源；当数据为 String 时自动设置图像 Uri；

其它 View 或者具有自定义方法的情况可以使用重写 JsonListAdapter#bindEvents、或者使用 jsonListAdapter.setEvents(JsonListAdapterEvents#bindEvents) 来实现，例如：

JsonListAdapter adapter = new JsonListAdapter(me, R.layout.item_my_order_list, orderList) {
    /**
     * 绑定事件
     * 除非你要在列表项中处理某些控件的事务，例如单独指定 setOnClickListener，不然不建议使用
     * 原则就是能尽量少的干涉执行过程就尽量少干涉，能提前预处理好就提前预处理好，
     * 别搁运行过程中呼啦啦搞一大堆的逻辑处理，不然不卡你卡谁
     *
     * @param context    上下文
     * @param itemView   列表项根布局
     * @param viewHolder 所有子布局
     * @param data       数据
     * @param index      索引
     * @param dataList   数据集
     */
    @Override
    public void bindEvents(Context context, View itemView, JsonListAdapter.ViewHolder viewHolder, JsonMap data, int index, JsonList dataList) {
      //...
    }
};

还有两个事件可供重写：

/**
 * 预处理数据
 * 但不建议使用，更推荐在数据加载后，在网络请求或异步线程中完成所有数据的预处理，
 * 否则可能带来列表滑动过程的卡顿和性能问题。
 *
 * @param context    上下文
 * @param itemView   列表项根布局
 * @param viewHolder 所有子布局
 * @param data       数据
 * @param index      索引
 * @param dataList   数据集
 * @return 处理完的数据
 */
JsonMap preprocessedData(Context context, View itemView, JsonListAdapter.ViewHolder viewHolder, JsonMap data, int index, JsonList dataList);

/**
 * 设置数据
 * 我们已经预设了两种数据自动绑定的场景：例如，TextView 自动绑定:
 * {当数据为 String 时自动设置 setText；当数据为 int 时自动调用并设置为文本资源}
 * ImageView 自动绑定:
 * {当数据为 int 时自动调用并设置为图像资源；当数据为 String 时自动设置图像 Uri；}
 * 上述过程都是自动支持的，如果你有特殊需求或者其它组件需要设置，可以重写以下方法进行处理
 *
 * @param context  上下文
 * @param tag      子布局 view 的标签
 * @param view     子布局
 * @param data     数据
 * @param index    索引
 * @param dataList 数据集
 */
void setData(Context context, String tag, View view, JsonMap data, int index, JsonList dataList);

上述方法也可以通过 adapter.setEvents(JsonListAdapterEvents) 接口来完成设置。

一点骚操作

假设 json 原文是这样的：

[
  {
    "extra_info": {
      "content_name": "test name"
    },
    "data": "this is real data"
  }
]

要适配 extra_info 里的 content_name 给一个 TextView，在 xml 中设置对应的数据 tag，可直接设置为：

<TextView
    ...
    android:tag="extra_info.content_name"
/>

开源协议

Copyright Kongzue BaseJson

Licensed under the Apache License, Version 2.0 (the "License");
you may n