Swift 4中的可编码和可解码

在iOS的日常开发中，许多任务涉及调用API和Web服务，将数据保存到磁盘以及使用自定义类型对对象进行建模，这些对象代表应用程序的用例和功能。 这样做时，我们必须将数据与中间格式（JSON，属性列表）之间进行转换。 对于数据编码和解码任务，Swift提供了可编码和可解码协议。 通过确认这些协议，可以将自定义类型编码到外部表示形式（例如JSON和Property List（pList））并从中解码。 在本文中，我将介绍如何使用Encodable和Decodable在JSON和JSON之间转换自定义类型实例，以及使用这两种协议进行编码和解码任务的许多方面。

编码方式

将您的自定义类型实例转换为其他表示形式（例如JSON和pList）的过程称为编码或序列化。 对于编码，自定义类型符合Encodable协议。

解码

将诸如JSON或pList之类的表示形式的数据转换为自定义类型的实例的过程称为解码或反序列化。 对于解码，自定义类型符合可解码协议。

可编码

为了同时支持编码和解码，自定义类型可以符合Codable协议，而后者又符合Encodable和Decodable 。

  typealias可编码=可编码和可解码 

自动编码和解码

默认情况下，Swift Standard Library和Foundation Framework中的许多类型（例如Int，String，Data，URL，Date等）都是可编码的。 若要使任何自定义类型自动变为可编码，它应符合可编码协议，并且其所有存储的属性都应是可编码的。

例如，这是一个表示Movie的结构。

  struct Movie { var movieId：Int？  变量名称：字符串？} 

只需遵循Codable，即可对Movie类型进行编码和解码。

  struct Movie：可编码{ var movieId：Int？  变量名称：字符串？} 

同样，具有自定义类型属性的自定义类型是可编码的，只要其所有属性都是可编码的即可。

例如，假设我们有MovieDetail结构来表示电影细节​​。

  struct MovieDetail：可编码{ var语言：字符串？  var genre：字符串？  var releaseDate：字符串？  var bannerImageUrl：字符串？}结构电影：可编码{ var movieId：整数？  var名称：字符串？  var movieDetails：MovieDetail？} 

由于MovieDetail也符合Codable，因此Movie也可编码。 Swift集合类型（例如Array ， Dictionary和Optional只要包含Codable类型，就变为Codable。

JSONEncoder和JSONDecoder

假设您的自定义类型是Codable，则可以使用JSONEncoder将您的类型编码为其他类型，例如Data ，可以将其发送到服务器或保存到磁盘。

要将电影编码为原始字节（ 数据 ），

  let bannerUrl =“ https://www.imdb.com/title/tt5463162/mediaviewer/rm4291446016"let movieDetails = MovieDetails（语言：“英语”，类型：“动作”，发行日期：“ 18-05-2018”，bannerImageUrl ：bannerUrl）let movie = Movie（movieId：2，name：“ Deadpool 2”，movieDetails：movieDetails）let jsonEncoder = JSONEncoder（）let movieData =尝试jsonEncoder.encode（movie） 

注意：编码函数会抛出并且可能失败，这就是为什么需要使用try的原因。

让我们打印movieData，

 打印（movieData） 

在Xcode调试控制台中，打印movieDate仅显示原始字节数，让我们将其转换为可读的JSON字符串。

 让jsonString =字符串（数据：movieData，编码：.utf8）打印（jsonString） 

现在，要将这些数据转换回Movie类型的实例，您需要使用JSONDecoder 。

  let jsonDecoder = JSONDecoder.init（）if let data = movieData { 
 让movie =试试jsonDecoder.decode（Movie.self，来自：数据） 
  } 

使用编码键

可编码类型定义符合CodingKey协议的嵌套枚举CodingKeys，其情况定义编码或解码时必须包括的属性。 案例的名称应与自定义类型中相应属性的名称匹配。 要在编码表示形式或解码类型中排除某些属性，只需在CodingKeys枚举中省略它们。

例如：

如果您要在编码数据中使用与自定义类型不同的键名，或者您的自定义类型中的某些属性名称与JSON中的某些属性名称不同，则将CodingKeys枚举的原始值类型定义为String并为案例提供原始值。

  struct Movie：可编码{ var movieId：Int？  var名称：字符串？  var movieDetails：MovieDetail？ 
 枚举CodingKeys：字符串，CodingKey { 

  case movieId =“ id” 
  案例名称 
  case movieDetails}} 

手动编码和解码

如果自定义类型的结构与JSON的结构不同，则可以实现自己的编码和解码逻辑。

  let movieDetails = MovieDetails（语言：“英语”，类型：“动作”，发行日期：“ 18-05-2018”，bannerImageUrl：bannerUrl）let movie = Movie（movieId：2，名称：“ Deadpool 2”，movieDetails：movieDetails ） 

要使用以下结构将此电影对象编码为JSON，

  {“ movieId”：2，“ name”：“ Deadpool 2”，“ language”：“ English”，“ genre”：“ Action”，“ releaseDate”：“ 18-05-2018”，“ bannerUrl”：“ https ：//www.imdb.com/title/tt5463162/mediaviewer/rm4291446016“} 

在这里，我们可以在上面的JSON中看到电影详细信息不像Movie中那样是嵌套结构，我们可以使用编码功能将电影对象手动编码为上面的表示形式。

 编码（至：编码器） 

让我们使用CodingKeys更新Movie结构，如下所示：

  struct Movie { var movieId：Int？  var名称：字符串？  var movieDetails：MovieDetail？ 枚举CodingKeys：字符串，CodingKey { 

  案例语言 
  案例类型 
  案例发布日期 
  案例 bannerUrl 
  }} 

现在让我们实现Encodable和 描述编码函数内部的编码逻辑。

在这里，我将Movie结构的符合性更改为Encodable，而不是Codable，以仅演示编码。 如果只需要对自定义类型执行编码，则可以使用Encodable ，仅解码可以使用Decodable ，如果需要对自定义类型执行编码和解码，则可以使用Codable 。

 扩展影片：可编码{函数编码（编码器：编码器）抛出{ 
  var container = encoder.container（keyedBy：CodingKeys.self） 
 尝试container.encode（movieId，forKey：.movi​​eId） 
 尝试container.encode（name，forKey：.name）尝试container.encode（movieDetails.language，forKey：.language）尝试container.encode（movieDetails.genre，forKey：.genre）尝试container.encode（movieDetails.releaseDate，forKey ：.releaseDate）试试container.encode（movieDetails.bannerImageUrl，forKey：.bannerUrl） 
  }} 

在此，容器提供了对编码器存储的视图，可通过键访问该视图。

现在，如果您编码并打印JSON字符串，您将获得

  {“ movieId”：2，“ name”：“ Deadpool 2”，“ language”：“ English”，“ genre”：“ Action”，“ releaseDate”：“ 18-05-2018”，“ bannerUrl”：“ https ：//www.imdb.com/title/tt5463162/mediaviewer/rm4291446016“} 

如果我们必须将此JSON字符串转换为Movie类型的实例，则可以通过实现以下必需的初始化程序来手动解码。

  init（来自解码器：解码器） 

现在让我们将符合性更改为Decodable和 描述init内部的解码逻辑（来自解码器：Decoder）。

 扩展电影：可解码{初始化（来自解码器：解码器）抛出{ 

  var容器=尝试解码器。容器（keyedBy：CodingKeys.self） 
  movieId =试试container.decode（Int.self，forKey：.movi​​eId） 

 名称=尝试container.decode（String.self，forKey：.name）让语言=尝试container.decode（String.self，forKey：.language）让体裁=尝试container.decode（String.self，forKey：.genre） 
 让releaseDate =尝试container.decode（String.self，forKey：.releaseDate）让bannerUrl =尝试container.decode（String.self，forKey：.bannerUrl）movieDetails = MovieDetail（语言：语言，类型：体裁，releaseDate：releaseDate， bannerImageUrl：bannerUrl）}} 

在这里，我们所做的与在编码函数中所做的相反。

错误处理

JSONDecoder和JSONEncoder对象都配备了适当的错误处理机制，并且在编码和解码失败时会引发错误，这些错误为开发人员提供了明确的反馈，告知他们代码中到底出了什么问题。

JSONDecoder抛出DecodingError ，其中包含不同的错误情况，例如.dataCorrupted，.keyNotFound，.typeMismatch，.valueNotFound。 类似地，JSONEncoder会引发EncodingError以及编码期间可能出现的各种错误情况。

结论

可编码和可解码是快速标准库中的强大功能，可轻松处理数据编码和解码任务。 快速标准库和Foundation框架中的许多类型（例如日期，URL）都是开箱即用的可编码的，这使得可编码和可解码的数据序列化/反序列化引人注目。 此外，JSONDecoder和JSONEncoder提供正确和准确的错误处理，这是许多第三方JSON序列化/反序列化库所缺少的。