Swift 4 JSON 解析进阶

分类：Swift作者：佚名

在前面 JSON 解析指南中，有网友提出了在使用类继承时默认实现存在问题。这个问题触发了更多的思考和学习，对他致以最高的谢意。接下来，我就从这个问题开始进一步介绍 Swift 4 中 JSON 解析。

问题回顾

当我们使用类集成时，子类在解析只有继承而来的属性有值而本身的属性则都为 nil 。

enum BeerStyle: String,Codable {
    case ipa
    case stout
    case kolsch
}

class Wine: Codable {
    var abv: Float?
}

class Beer: Wine {
    var name: String?
    var brewery: String?
    var style: BeerStyle?
}

let jsonDic = ["name":"beer","brewery":"100","abv":10.0,"style":"ipa"] as [String : Any]

let jsonData = try! JSONSerialization.data(withJSONObject: jsonDic,options: .prettyPrinted)
let decode = JSONDecoder()
do {
    let beer = try decode.decode(Beer.self,from: jsonData)
    print("解析成功:\(beer)")
} catch  {
    print("解析失败:\(error)")
}

上面代码运行的最终结果是：解析成功但是 name、brewery、style 三个属性全部为 nil 。显然，这不是我们想要的结果。这是 Swift 4 中一个有待改进的地方，Codable 默认实现无法覆盖继承这种情况。具体代码详解评论部分。其中涉及的主要关键点：自定义编码和自定义解码。

接下来，我就对前文进行一些补充。

深度自定义

虽然 Codable 的默认实现足够应付大多数情形了，但是有时候我们还是存在一些自定义需求。为了处理这类自定义问题，我们就必须自己覆盖默认的 Codable 实现。

自定义编码

接下来，我们看如何进行编码的自定义实现。假设，我们需要对上篇文章中 Beer Model 进行如下拓展：

struct Beer : Codable {
    //...
    let createdAt: Date
    let bottleSizes: [Float]
    let comments: String?
    
    //...
}

但是，我们希望在编码时改变命名风格将 createdAt 映射为 created_at 同时将 bottleSizes 映射为 bottle_sizes，也就是形如以下这种 JSON 格式：

{
  "comments" : null,"style" : "ipa","brewery_name" : "Saint Arnold","created_at" : "524716294.793119","alcohol_by_volume" : 8.8999996185302734,"bottle_sizes" : [
    12,16
  ],"name" : "Endeavor"
}

首先，我们需要对枚举所有的编码健：

struct Beer : Codable {
   // ...
   
    enum CodingKeys: String,CodingKey {
        case name
        case brewery
        case abv
        case style
        case createdAt = "created_at"
        case bottleSizes = "bottle_sizes"
        case comments
    }
}

接下来就是覆盖原有的 encode 方法：

extension Beer {
    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        
        try container.encode(name,forKey: .name)
        try container.encode(abv,forKey: .abv)
        try container.encode(brewery,forKey: .brewery)
        try container.encode(style,forKey: .style)
        try container.encode(createdAt,forKey: .createdAt)
        try container.encode(comments,forKey: .comments)
        try container.encode(bottleSizes,forKey: .bottleSizes)
    }
}

最后，验证编码效果：

let beer = Beer.init(name: "name",brewery: "x",abv: "xx",style: BeerStyle.ipa,createdAt: Date.init(),bottleSizes: [2.3,3.6],comments: "xxx")
        
let encoder = JSONEncoder()
let data = try! encoder.encode(beer)
print(String(data: data,encoding: .utf8)!)

打印结果如下：

{    
    "comments":"xxx","style":"ipa","brewery":"x","created_at":524716294.793119,"bottle_sizes": [2.3,"abv":"xx","name":"name" 
}

其中编码过程中最重要的概念就是 container。在进行任何编码之前，我们都需要获取一个 container 对象，而该对象又有三种类型：

  1. Keyed Container：键值对字典类型
  2. Unkeyed Container：数值类型
  3. Single Value Container：仅仅输出 raw value

所以上面我们首先就创建了字典类型：

var container = encoder.container(keyedBy: CodingKeys.self)

然后，我们通过下面语句实现赋值：

try container.encode(value,forKey: .key)

另外，我们还可以获取 container 对象嵌套的 container 子对象。例如，我们可以对 bottle_sizes 中的数值进行四舍五入操作：

// 将 try container.encode(bottleSizes,forKey: .bottleSizes) 替换为：
var sizes = container.nestedUnkeyedContainer(
      forKey: .bottleSizes)

try bottleSizes.forEach {
      try sizes.encode($0.rounded())
}

// 结果就是： "bottle_sizes": [2.0,4.0]

自定义解码

与上面自定义编码类似，自定义解码也是通过覆盖默认方法实现。

extension Beer {
    init(from decoder: Decoder) throws {

    }
}

接下来，我们从 decoder 中获取 container 对象并将其赋值到对应属性上：

extension Beer {
    init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)

        name = try container.decode(String.self,forKey: .name)
        abv = try container.decode(String.self,forKey: .abv)
        brewery = try container.decode(String.self,forKey: .brewery)
        style = try container.decode(BeerStyle.self,forKey: .style)
        createdAt = try container.decode(Date.self,forKey: .createdAt)
        comments = try container.decodeIfPresent(String.self,forKey: .comments)
        bottleSizes = try container.decode([Float].self,forKey: .bottleSizes)
    }
}

接下来，验证自定义的实现效果：

let jsonDic = ["comments":"xxx","bottle_sizes":[2.3,"name":"name"] as [String : Any]
        
let jsonData = try! JSONSerialization.data(withJSONObject: jsonDic,from: jsonData)
    print("解析成功:\(beer)")
} catch  {
    print("解析失败:\(error)")
}

打印结果如下：

解析成功:
Beer( name: "name",style: xxx.BeerStyle.ipa,createdAt: 2017-08-18 02:31:34 +0000,bottleSizes: [2.29999995,3.5999999],comments: Optional("xxx") )

当然，我们同样可以对嵌套的 bottleSizes 进行自定义：

init(from decoder: Decoder) throws {
    // ...

    var bottleSizesArray = try container.nestedUnkeyedContainer(forKey: .bottleSizes)
    var sizes: [Float] = []
        
    while (!bottleSizesArray.isAtEnd) {
        let size = try bottleSizesArray.decode(Float.self)
        sizes.append(size.rounded())
    }
    bottleSizes = Array.init(sizes)
}

扁平化对象

有时候，我们的 Model 可能与 JSON 数据的结构不一致。例如，假设 Beer 对象中 abv 和 style 在 JSON 中是嵌套结构，但是我们不想在代码中新建嵌套结构。这时候，我们就可以使用自定义方法进行实现。

假设，JSON 对象形如：

{
   "name": "Lawnmower","info": {
     "style": "kolsch","abv": 4.9
   }
   // ...
}

要实现对象扁平化，首先我们需要定义出该嵌套结构的键值映射关系：

struct Beer : Codable {
  enum CodingKeys: String,CodingKey {
      case name
      case brewery
      case createdAt = "created_at"
      case bottleSizes = "bottle_sizes"
      case comments
      case info // <-- NEW
  }

  enum InfoCodingKeys: String,CodingKey {
      case abv
      case style
  }
}

在编码时候，我们使用 InfoCodingKeys 创建嵌套字典：

func encode(to encoder: Encoder) throws {
      var container = encoder.container(
          keyedBy: CodingKeys.self)

      var info = try encoder.nestedContainer(
          keyedBy: InfoCodingKeys.self)
      try info.encode(abv,forKey: .abv)
      try info.encode(style,forKey: .style)

    // ...
}

同样，在解码时取出其中的嵌套对象并进行赋值：

init(from decoder: Decoder) throws {
    let container = try decoder.container(
          keyedBy: CodingKeys.self)

    let info = try decoder.nestedContainer(
          keyedBy: InfoCodingKeys.self)
    abv = try info.decode(Float.self,forKey: .abv)
    style = try info.decode(BeerStyle.self,forKey: .style)

    // ...
}

对象继承

最后我们回到前面的问题，在 Swift 4 中进行类继承解析的时候到底发生了些什么。

首先，我们定义如下对象和继承关系：

class Person : Codable {
    var name: String?
    
    init() {}
    
    
}

class Employee : Person {
    var employeeID: String?
    
    override init() { super.init() }
}

接下来，我们分布检验 Employee 对象的编码和解码操作：

// 默认编码
let employee = Employee()
employee.employeeID = "emp123"
employee.name = "Joe"

let encoder = JSONEncoder()
encoder.outputFormatting = .prettyPrinted
let data = try! encoder.encode(employee)
print(String(data: data,encoding: .utf8)!)

// 默认解码
let jsonDic = ["employeeID":"emp123","name":"Joe"] as [String : Any]
        
let jsonData = try! JSONSerialization.data(withJSONObject: jsonDic,options: .prettyPrinted)
let decode = JSONDecoder()
do {
    let employee = try decode.decode(Employee.self,from: jsonData)
    print("解析成功:\(employee)")
} catch  {
    print("解析失败:\(error)")
}

运行代码你会发现编码打印的结果为：

{
  "name" : "Joe"
}

同样的，解码操作也只有 name 属性被赋值了，employeeID 属性为 nil 。这显然与我们想要的理想结果相差甚远。所以，我们需要对上面的对象编码和解码方法进行自定义实现：

class Person : Codable {
    var name: String?

    private enum CodingKeys : String,CodingKey {
        case name
    }
    
    init() {}

    required init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        name = try container.decode(String.self,forKey: .name)
    }
    
    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(name,forKey: .name)
    }
}

class Employee : Person {
    var employeeID: String?

    private enum CodingKeys : String,CodingKey {
        case employeeID
    }
    
    override init() { super.init() }

    required init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        employeeID = try container.decode(String.self,forKey: .employeeID)
    }
    
    override func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(employeeID,forKey: .employeeID)
    }
}

但是，如果你再次运行上面的测试代码的话会发现这次竟然是另一个极端。只有 employeeID 有值而继承得到的 name 属性则为 nil 。这是因为，上面子类在编解码过程中没有调用父类的方法。所以，我们需要将 Employee 中的方法修改为：

class Employee : Person {
    //...
    
    required init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        
        try super.init(from: decoder)
        employeeID: = try container.decode(String.self,forKey: .employeeID:)
    }
    
    override func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        
        try super.encode(to: encoder)
        try container.encode(employeeID,forKey: .employeeID)
    }
}

这样，我们就完美解决了之前的问题了。

另外，这里还有一个问题值得注意。上面进行父项编码操作的时直接使用了子类参数，而实际上我们可以使用更合适的参数进行编码操作：

// 替换  try super.encode(to: encoder)
try super.encode(to: container.superEncoder())

打印结果为：

{
  "super" : {
    "name" : "Joe"
  },"emp_id" : "emp123"
}

当然，我们可以对默认键 super 进行替换：

enum CodingKeys : String,CodingKey {
  case employeeID = "emp_id"
  case person
}

override func encode(to encoder: Encoder) throws {
   // ...
   try super.encode(to:container.superEncoder(forKey: .person))
}

修改后的打印结果为：

{
  "employeeID" : "emp123","person" : {
    "name" : "Joe"
  }
}

当然，我们同样可以在解码时进行类似操作：

required init(from decoder: Decoder) throws {
    let container = try decoder.container(keyedBy: CodingKeys.self)
    
     try super.init(from: container.superDecoder(forKey: .person))
    employeeID = try container.decode(String.self,forKey: .employeeID)
}

// 解码检测
let jsonDic = ["employeeID":"emp123","person":["name" : "Joe"] ] as [String : Any]
        
let jsonData = try! JSONSerialization.data(withJSONObject: jsonDic,from: jsonData)
    print("解析成功:\(employee)")
} catch  {
    print("解析失败:\(error)")
 }

总结

除了使用 Codable 的默认实现处理数据解析外，对于特殊情形我们完全可以通过自定义实现加以解决。虽然 Swift 还有一些地方有待完善，但是这不影响 Codable 功能的强大。希望未来 Swift 能给我们带来更多的惊喜，毕竟下个版本 ABI 就稳定了。

欢迎来站点交流讨论。

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 dio@foxmail.com 举报，一经查实，本站将立刻删除。

相关推荐

效率成吨提升之代码生成器-蓝湖工具神器iOS,Android,Swift,Flutter
软件简介:蓝湖辅助工具,减少移动端开发中控件属性的复制和粘贴.待开发的功能:1.支持自动生成约束2.开发设置页面3.做一个浏览器插件,支持不需要下载整个工程,可即时操作当前蓝湖浏览页面4.支持Flutter语言模板生成5.支持更多平台,如Sketch等6.支持用户自定义语言模板
【Audio音频开发】音频基础知识及PCM技术详解
现实生活中，我们听到的声音都是时间连续的，我们称为这种信号叫模拟信号。模拟信号需要进行数字化以后才能在计算机中使用。目前我们在计算机上进行音频播放都需要依赖于音频文件。那么音频文件如何生成的呢？音频文件的生成过程是将声音信息采样、量化和编码产生的数字信号的过程，我们人耳所能听到的声音频率范围为（20Hz~20KHz），因此音频文件格式的最大带宽是20KHZ。根据奈奎斯特的理论，音频文件的采样率一般在40~50KHZ之间。奈奎斯特采样定律，又称香农采样定律。...............
见过仙女蹦迪吗？一起用python做个小仙女代码蹦迪视频
前言最近在B站上看到一个漂亮的仙女姐姐跳舞视频，循环看了亿遍又亿遍，久久不能离开！看着小仙紫姐姐的蹦迪视频，除了一键三连还能做什么？突发奇想，能不能把舞蹈视频转成代码舞呢？说干就干，今天就手把手教大家如何把跳舞视频转成代码舞，跟着仙女姐姐一起蹦起来~视频来源：【紫颜】见过仙女蹦迪吗 【千盏】一、核心功能设计总体来说，我们需要分为以下几步完成：从B站上把小姐姐的视频下载下来对视频进行截取GIF，把截取的GIF通过ASCII Animator进行ASCII字符转换把转换的字符gif根据每
【Android App】实战项目之仿抖音的短视频分享App附源码和演示视频 超详细必看
【Android App】实战项目之仿抖音的短视频分享App（附源码和演示视频 超详细必看）
自定义ava数据集及训练与测试 完整版 时空动作/行为 视频数据集制作 yolov5, deep sort, VIA MMAction, SlowFast
前言这一篇博客应该是我花时间最多的一次了，从2022年1月底至2022年4月底。我已经将这篇博客的内容写为论文，上传至arxiv：https://arxiv.org/pdf/2204.10160.pdf欢迎大家指出我论文中的问题，特别是语法与用词问题在github上，我也上传了完整的项目：https://github.com/Whiffe/Custom-ava-dataset_Custom-Spatio-Temporally-Action-Video-Dataset关于自定义ava数据集，也是后台
【视频+源码】登录鉴权的三种方式：token、jwt、session实战分享
因为我既对接过session、cookie，也对接过JWT，今年因为工作需要也对接了gtoken的2个版本，对这方面的理解还算深入。尤其是看到官方文档评论区又小伙伴表示看不懂，所以做了这期视频内容出来：视频在这里：本期内容对应B站的开源视频因为涉及的知识点比较多，视频内容比较长。如果你觉得看视频浪费时间，可以直接阅读源码：goframe v2版本集成gtokengoframe v1版本集成gtokengoframe v2版本集成jwtgoframe v2版本session登录官方调用示例文档jwt和sess
【Android App】实战项目之仿微信的私信和群聊App附源码和演示视频 超详细必看
【Android App】实战项目之仿微信的私信和群聊App（附源码和演示视频 超详细必看）
零基础用Android Studio实现简单的本地视频播放器
用Android Studio的VideoView组件实现简单的本地视频播放器。本文将讲解如何使用Android视频播放器VideoView组件来播放本地视频和网络视频，实现起来还是比较简单的。VideoView组件的作用与ImageView类似，只是ImageView用于显示图片，VideoView用于播放视频。...
采用MATLAB对正弦信号，语音信号进行生成、采样和恢复，利用MATLAB工具箱对混杂噪声的音频信号进行滤波
采用MATLAB对正弦信号，语音信号进行生成、采样和内插恢复，利用MATLAB工具箱对混杂噪声的音频信号进行滤波
Keras深度学习实战40——音频生成
随着移动互联网、云端存储等技术的快速发展，包含丰富信息的音频数据呈现几何级速率增长。这些海量数据在为人工分析带来困难的同时，也为音频认知、创新学习研究提供了数据基础。在本节中，我们通过构建生成模型来生成音频序列文件，从而进一步加深对序列数据处理问题的了解。
视频实时行为检测——基于yolov5+deepsort+slowfast算法
基于yolov5+deepsort+slowfast算法的视频实时行为检测。1. yolov5实现目标检测，确定目标坐标 2. deepsort实现目标跟踪，持续标注目标坐标 3. slowfast实现动作识别，并给出置信率 4. 用框持续框住目标，并将动作类别以及置信度显示在框上
数电实验 数字电子钟设计 基于quartus 实现计时校时闹钟秒表稍复杂音频 分享电路图设计以及工程文件
数字电子钟设计本文主要完成数字电子钟的以下功能1、计时功能（24小时）2、秒表功能（一个按键实现开始暂停，另一个按键实现清零功能）3、闹钟功能（设置闹钟以及到时响10秒）4、校时功能5、其他功能（清零、加速、星期、八位数码管显示等）前排提示：前面几篇文章介绍过的内容就不详细介绍了，可以看我专栏的前几篇文章。PS.工程文件放在最后面总体设计本次设计主要是在前一篇文章 数字电子钟基本功能的实现 的基础上改编而成的，主要结构不变，分频器将50MHz分为较低的频率备用；dig_select
腾讯会议使用OBS虚拟摄像头
1.进入官网下载OBS stdioOpen Broadcaster Software | OBS (obsproject.com)2.下载一个插件,拓展OBS的虚拟摄像头功能链接：OBS 虚拟摄像头插件.zip_免费高速下载|百度网盘-分享无限制 (baidu.com)提取码：6656--来自百度网盘超级会员V1的分享**注意**该插件必须下载但OBS的根目录(应该是自动匹配了的)3.打开OBS,选中虚拟摄像头选择启用在底部添加一段视频录制选择下面,进行录制.
文本生成视频Make-A-Video，根据一句话就能一键生成视频 Meta新AI模型
Meta公司在9月29日首次推出一款人工智能系统模型：Make-A-Video，可以从给定的文字提示生成短视频。基于**文本到图像生成技术的最新进展**，该技术旨在实现文本到视频的生成，可以仅用几个单词或几行文本生成异想天开、独一无二的视频，将无限的想象力带入生活
信号处理——MATLAB音频信号加噪、滤波
音频信号叠加噪声及滤波一、前言二、信号分析及加噪三、滤波去噪四、总结一、前言之前一直对硬件上的内容比较关注，但是可能是因为硬件方面的东西可能真的是比较杂，而且需要渗透的东西太多了，所以学习进展比较缓慢。因为也很少有单纯的硬件学习研究，总是会伴随着各种理论需要硬件做支撑，所以还是想要慢慢接触理论学习。但是之前总找不到切入点，不知道从哪里开始，就一直拖着。最近稍微接触了一点信号处理，就用这个当作切入点，开始接触理论学习。二、信号分析及加噪信号处理选用了matlab做工具，选了一个最简单的语音信号处理方
【新知实验室 - TRTC 实践】音视频互动 Demo、即时通信 IM 服务搭建
腾讯云 TRTC 实时音视频服务体验，从认识 TRTC 到 TRTC 的开发实践，Demo 演示& IM 服务搭建。
Keras深度学习实战39——音乐音频分类
音乐音频分类技术能够基于音乐内容为音乐添加类别标签,在音乐资源的高效组织、检索和推荐等相关方面的研究和应用具有重要意义。传统的音乐分类方法大量使用了人工设计的声学特征，特征的设计需要音乐领域的知识，不同分类任务的特征往往并不通用。深度学习的出现给更好地解决音乐分类问题提供了新的思路，本文对基于深度学习的音乐音频分类方法进行了研究。首先将音乐的音频信号转换成声谱作为统一表示，避免了手工选取特征存在的问题，然后基于一维卷积构建了一种音乐分类模型。
C++游戏game | 井字棋游戏坤坤版配资源+视频【赋源码，双人对战】
C++知识精讲16 | 井字棋游戏（配资源+视频）【赋源码，双人对战】
基于FFmpeg的Java视频Mp4转GIF初探
本文主要讲解如何在Java中，使用FFmpeg进行视频的帧读取，并最终合并成Gif动态图。
深入浅出 Swift 中的 some、any 关键字以及主关联类型primary associated types
在本篇博文中，我们谈及了 Swift 中 some、any 关键字以及主关联类型（primary associated types）的前世今生，并由浅及深用简明的示例向大家讲解了它们之间的奥秘玄机。
pythonJavaScriptjavaHTMLPHPreactjsC#AndroidCSSNode.jssqlrpython-3.xMysqLjQueryc++pandasFlutterangularIOSdjangolinuxswifttypescript路由器JSON路由器设置无线路由器h3c华三华三路由器设置华三路由器电脑软件教程arraysdocker软件图文教程Cvue.jslaravelspring-boot