【2023】Kotlin教程第三篇 Kotlin进阶第22章网络编程 22.4 数据交换格式 22.4.3 JSON数据编码和解码

小灰灰 2024-03-23 13:11 14阅读 0赞

### 【2023】Kotlin教程 ###

#### 文章目录 ####

*   *  【2023】Kotlin教程
     *   *  第三篇 Kotlin进阶
         *  第22章 网络编程
         *   *  22.4 数据交换格式
             *   *  22.4.3 JSON数据编码和解码
                 *   *  1. 编码
                     *  2. 解码

![在这里插入图片描述][11a3b38e14d2480fbd59d1a28f9f89fd.png_pic_center]

#### 第三篇 Kotlin进阶 ####

#### 第22章 网络编程 ####

现代的应用程序都离不开网络，网络编程是非常重要的技术。Kotlin标准库网络编程源自于Java提供java.net包，其中包含了网络编程所需要的最基础一些类和接口。这些类和接口面向两个不同的层次：

1.  基于Socket的低层次网络编程。Socket采用TCP、UDP等协议，这些协议属于低层次的通信协议，编程过程比较复杂。
2.  基于URL的高层次网编程。URL采用HTTP和HTTPS这些属于高层次的通信协议，相对低层编程过程比较容易。

所谓低层次网络编程并不等于它功能不强大。恰恰相反，正因为层次低，Socket编程与基于URL的高层次网络编程比较，能够提供更强大的功能和更灵活的控制，但是要更复杂一些。

##### 22.4 数据交换格式 #####

数据交换格式就像两个人在聊天一样，采用彼此都能听得懂的语言，你来我往，其中的语言就相当于通信中的数据交换格式。有时候，为了防止聊天被人偷听，可以采用暗语。

同理，计算机程序之间也可以通过数据加密技术防止“偷听”。数据交换格式主要分为纯文本格式、XML格式和JSON格式，其中纯文本格式是一种简单的、无格式的数据交换方式。

例如，为了告诉别人一些事情，我会写下如下图所示的留言条。

![在这里插入图片描述][b8ba4d87f18d463090d6251a224baf4c.png_pic_center]

留言条有一定的格式，共有4部分：称谓、内容、落款和时间

![在这里插入图片描述][41c34153ef9f4f2087f75a113d030697.png_pic_center]

如果用纯文本格式描述留言条，可以按照如下的形式：

"云龙同学"，"你好！\n今天上午，我到你家来想向你借一本《小学生常用成语词典》。可是不巧，你不在。我准备晚上6时再来借书。请你在家里等我，谢谢！"，"关东升"，"2012年12月08日"

留言条中的4部分数据按照顺序存放，各个部分之间用逗号分隔。数据量小的时候，可以采用这种格式。但是随着数据量的增加，问题也会暴露出来，可能会搞乱它们的顺序，如果各个数据部分能有描述信息就好了。而XML格式和JSON格式可以带有描述信息，它们叫做“自描述的”结构化文档。

将上面的留言条写成XML格式，具体如下：

<?xml version="1.0" encoding="UTF-8"?>
    
    <note>
        <to>云龙同学</to>
        <content>你好！\n今天上午，我到你家来想向你借一本《小学生常用成语词典》。可是不巧，你不在。我准备晚上6时再来借书。请你在家里等我，谢谢！</content>
        <from>关东升</from>
        <date>2012年12月08日</date>
    </note>

上述代码中位于尖括号中的内容(<to>…<to>等)就是描述数据的标识，在XML中称为“标签”。

将上面的留言条写成JSON格式，具体如下：

{
        
        to:"云龙同学",
        content:"你好！\n今天上午，我到你家来想向你借一本《小学生常用成语词典》。可是不巧，你不在。我准备晚上6时再来借书。请你在家里等我，谢谢！"
        from:"关东升",
        date:"2012年12月08日"
    }

数据放置在大括号\}之中，每个数据项目之前都有一个描述名字（如to等），描述名字和数据项目之间用冒号(：)分开。

可以发现，一般来讲，JSON所用的字节数要比XML少，这也是很多人喜欢采用JSON格式的主要原因，因此JSON也被称为“轻量级”的数据交换格式。

###### 22.4.3 JSON数据编码和解码 ######

JSON和XML真正在进行数据交换时候，它们存在的形式就是一个很长的字符串，这个字符串在网终中传输或者存储于磁盘等介质中。

在传输和存储之前需要把JSON对象转换成为字符串才能传输和存储，这个过程称之为“编码”过程。接收方需要将接收到的字符串转换成为JSON对象，这个过程称之为“解码”过程。编码和解码过程就像发电报时发送方把语言变成能够传输的符号，而接收时要将符号转换成为能够看懂的语言。

下面具体介绍一下JSON数据编码和解码过程。

###### 1. 编码 ######

如果想获得如下这样JSON字符串：

{
        "name":"tony","age":30,"sex":false,"a":[1,3]}

应该如何实现编码过程，参考代码如下：

import com.beust.klaxon.json
    
    /**
     * @Projectname: HelloJson
     * @Classname: Hello
     * @Author: Ding Jiaxiong
     * @Data:2023/4/5 18:46
     */
    
    fun main() {
        
    
        val jsonObject = json {
        
            obj("name" to "tony", "age" to 30)
        }
    
        jsonObject.put("sex", false)
    
        val list = listOf(1, 3)
        val jsonArray1 = json {
        
            array(list)
        }
    
        jsonObject.put("a", jsonArray1)
        val jsonArray2 = json {
        
            array(jsonArray1)
        }
    
        // 编码完成
        println(jsonObject.toJsonString(prettyPrint = true))
        println(jsonArray2.toJsonString())
    }

运行结果

![在这里插入图片描述][6ea3f7f7f60b4e24b601975325e07341.png_pic_center]

代码中通过json 函数创建JSON 对象，`obj("name" to "tony", "age" to 30)` 指定了JSON 对象的内容，JSON 对象是一种Map 结构。 json 函数不仅可以创建JSON 对象，还可以创建JSON 数组。

json 函数中定义了4个函数：

*  obj(vararg args: Pair<String,\*>): JsonObject //指定JSON对象
 *  array(vararg args: Any?): JsonArray<Any?> //指定JSON数组，参数是可变参数
 *  array(args: List<Any?>): JsonArray<Any?> //指定JSON数组，参数是List集合
 *  array(subArray: JsonArray<T>): JsonArray<JsonArray<T>> //指定JSON数组，参数是子JSON数组

另外，向JSON对象中添加键值对，可以使用put函数。

###### 2. 解码 ######

解码过程是编码反向操作，如果有如下JSON字符串：

{
        "name":"tony","age":30,"a":[1,3]}

那么如何把这个JSON字符串解码成JSON对象或数组，参考代码如下：

import com.beust.klaxon.JsonArray
    import com.beust.klaxon.JsonObject
    import com.beust.klaxon.Parser
    import com.beust.klaxon.json
    import java.lang.StringBuilder
    
    /**
     * @Projectname: HelloJson
     * @Classname: Hello
     * @Author: Ding Jiaxiong
     * @Data:2023/4/5 18:46
     */
    
    fun main() {
        
    
        val jsonString = """{"name":"tony","age":30,"a":[1,3]}"""
    
        val parser = Parser()
        val jsonObj = parser.parse(StringBuilder(jsonString)) as JsonObject
    
        val name = jsonObj.string("name")
        println("name: ${
          name}")
    
        val age = jsonObj.int("age")
        println("age : ${
          age}")
    
        val jsonAry = jsonObj.array<Int>("a") as JsonArray<Int>
        val n1 = jsonAry[0]
        println("数组a 的第一个元素: ${
          n1}")
        val n2 = jsonAry[1]
        println("数组a 的第二个元素: ${
          n2}")
    
    }

运行结果

![在这里插入图片描述][5e666adb840e40069f9a1ed8b3ac1ea0.png_pic_center]

网络通信过程中JSON字符串是从服务器返回的。

代码通过JSON字符串创建JSON对象，这个过程事实上就是JSON字符串解析过程，如果能够成功地创建JSON对象，说明解析成功，如果发生异常则说明解析失败。

之后从JSON对象中按照名称取出JSON中对应的数据，取出一个JSON数组对象，取出JSON数组第一个元素。

【注意】

如果按照规范的JSON文档要求，**每个JSON数据项目的“名称”必须使用双引号括起来**，不能使用单引号或没有引号。在下面的代码文档中，“名称”省略了双引号，该文档在进行使用Klaxon库进行解析时会出现异常，而有些库却可以解析，但这并不是规范的做法。在进行数据交换时，采用这种不规范的JSON文档进行数据交换，那么很有可  
能会导致严重的问题发生。

{
        
        ResultCode:0,
        Record:[
            {
        ID:'1',CDate:'2012-12-23',Content:'发布IOSBook0',UserID:'tony'},
            {
        ID:'2',CDate:'2012-12-24',Content:'发布IOSBook1',UserID:'tony'},
        ]
    }

[11a3b38e14d2480fbd59d1a28f9f89fd.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/ee48c91b163e4ce3b5a0172bcbb79b86.png
[b8ba4d87f18d463090d6251a224baf4c.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/cbd20af6db3d4e2680b7be6df6f3a2b0.png
[41c34153ef9f4f2087f75a113d030697.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/9e639feef44a47b8b67783a7706533fd.png
[6ea3f7f7f60b4e24b601975325e07341.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/807a970326f7414297f2f7cad5769dd8.png
[5e666adb840e40069f9a1ed8b3ac1ea0.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/ec7b0580b3b64d319448c60806d48c7e.png