SwiftUI极简教程33:JSON数据的使用

在本章中，你将学会如何引用并解析JSON数据。

JSON，是JavaScript对象表示法的简称，是客户机和服务器应用程序中用于数据交换的一种常见数据格式。我们App客户端发送网络请求，服务端就会返回JSON文本，供App客户端进行解析，解析完成后客户端再把对应数据展现到页面上。

我们学习下JSON数据及其解码方式的相关内容。

项目创建

首先，创建一个新的Playground文件，命名为SwiftUIJSON。

变量声明

我们创建一个简单的json数据。

let json = """
{
"name": "Ricardo",
"country": "China",
"city": "Guangzhou"
}
"""
复制代码

然后，我们定义下需要的参数名称，我们需要新建一个personalInformation个人信息的结构体来定义json数据里的参数。

struct personalInformation: Codable {
    var name: String
    var country: String
    var city: String
}
复制代码

这里，我们使用的personalInformation个人信息结构体需要遵循Codable可编码协议，并且personalInformation个人信息结构体中定义的变量需要与JSON的键一一匹配。

实例化

接下来，我们解析下json数据。

扫描二维码关注公众号，回复： 14165133 查看本文章

let decoder = JSONDecoder()
    if let jsonData = json.data(using: .utf8) {
        do {
            let message = try decoder.decode(personalInformation.self, from: jsonData)
            print(message)
        } catch {
            print(error)
    }
}
复制代码

我们实例化JSONDecoder的一个实例，然后将JSON字符串转换为personalInformation的对象。

运行下代码，我们可以看到，我们获得并展示了json内的数据。

参数映射

在我们从服务器获得JSON数据时，可能会出现我们实例化的参数和JSON数据的参数不匹配的情况。

示例：在JSON数据中，我们把city城市换成cityName城市名称。

这时候，我们就需要映射字段名称，而不需要每次都更改我们定义的字段。

enum CodingKeys: String, CodingKey {
        case name
        case country
        case city = "cityName"
    }
复制代码

我们在personalInformation个人信息结构体增加了一个枚举，然后使用case转换参数进行映射。

对象嵌套

我们再考虑一种情况，如果JSON数据中存在嵌套关系，比如我们新增一个参数location位置，在location位置里放country国家参数。

let json = """
{
"name": "Ricardo",
"location": {
    "country": "China",
},
"cityName": "Guangzhou"
}
"""
复制代码

这个例子很常见，我们可以把省、市、区放在地址里，这种对象中嵌套对象，我们处理也需要建立映射关系。

首先我们需要在CodingKeys中设置切换。

enum CodingKeys: String, CodingKey {
    case name
    case country = "location"
    case city = "cityName"
}
复制代码

同时我们还需要定义了一个枚举LocationKeys，它的参数是被location位置嵌套的country国家参数。

由于我们不能直接映射，那我们需要在Codable协议的初始化器中来解码得到我们想要的值。

enum LocationKeys: String, CodingKey {
    case country
}
复制代码

然后是实现方法。

init(from decoder: Decoder) throws {
        let values = try decoder.container(keyedBy: CodingKeys.self)
        name = try values.decode(String.self, forKey: .name)

        let location = try values.nestedContainer(keyedBy: LocationKeys.self, forKey: .country)
        country = try location.decode(String.self, forKey: .country)

        city = try values.decode(String.self, forKey: .city)
    }
复制代码

我们在init函数方法中，调用decoder的container容器解码器方法来获取CodingKeys枚举的数据，CodingKeys枚举里有name名字。

而由于country国家参数在location位置的容器中，就需要通过调用LocationKeys枚举的nestedContainer方法进一步解码城市的值。

以上就是嵌套对象解码JSON数据的方法。

数据数组

在上面我们了解的都是基于1行数据的解析，如果我们JSON数据是由多行数据组成的数组，我们又该如何解析呢？

let json = """
{
"messages":[

{

"name": "Ricardo",
"location": {
    "country": "China",
},
"cityName": "Guangzhou"

},{

"name": "Ricardo",
"location": {
    "country": "China",
},
"cityName": "Guangzhou"
}]
}
"""
复制代码

我们的JSON有一个messages数组，里面有2个数据行。

要想解析这个messages数组，我们也是需要创建一个遵循Codable可编码协议的结构体，这里命名为MessageArrays。

struct MessageArrays: Codable {
    var messages: [personalInformation]
}
复制代码

我们用messages来接收personalInformation个人信息结构体的数据。

然后在解析这块，我们就不能直接解析personalInformation的数据了，我们改为解析MessageArrays数组的数据。

同时，我们用for循环输出下数据看看效果：

let decoder = JSONDecoder()
if let jsonData = json.data(using: .utf8) {

    do {
        let messageArrays = try decoder.decode(MessageArrays.self, from: jsonData)
        for message in messageArrays.messages {
            print(message)
        }
    } catch {
        print(error)
    }
}
复制代码

恭喜你，我们完成了JSON数据的全部学习！

完整代码

import SwiftUI

//json数据准备
let json = """
{
"messages":[

{
"name": "Ricardo",
"location": {
    "country": "China",
},
"cityName": "Guangzhou"

},{

"name": "Ricardo",
"location": {
    "country": "China",
},
"cityName": "Guangzhou"
}]
}
"""

//定义数组
struct MessageArrays: Codable {
    var messages: [personalInformation]
}

//定义模型
struct personalInformation: Codable {
    var name: String
    var country: String
    var city: String

    //定义参数枚举
    enum CodingKeys: String, CodingKey {
        case name
        case country = "location"
        case city = "cityName"
    }

    //数组枚举
    enum LocationKeys: String, CodingKey {
        case country
    }

    //实例化
    init(from decoder: Decoder) throws {
        let values = try decoder.container(keyedBy: CodingKeys.self)
        name = try values.decode(String.self, forKey: .name)

        let location = try values.nestedContainer(keyedBy: LocationKeys.self, forKey: .country)
        country = try location.decode(String.self, forKey: .country)

        city = try values.decode(String.self, forKey: .city)
    }
}

//解析数据
let decoder = JSONDecoder()
if let jsonData = json.data(using: .utf8) {

    do {
        let messageArrays = try decoder.decode(MessageArrays.self, from: jsonData)
        for message in messageArrays.messages {
            print(message)
        }
    } catch {
        print(error)
    }
}
复制代码

快来动手试试吧！

如果本专栏对你有帮助，不妨点赞、评论、关注～