SwiftyJSON源代码学习(一)

为什么选择SwiftyJSON

要精通一门语言，阅读优秀的源代码是一条非常好的捷径，只凭借着基本的语法和教程学习，然后一点点去试错、去填坑来精进这门语言的修为，不可取也。
要阅读、精研源代码，就要选择优秀的源码来读，“取法乎上仅得其中，取法乎中仅得其下”。除此之外，最好选择实用的、使用频率高的项目，能在此学习中同时精进语言和实际开发水平，才是上上之选。
SwiftyJSON，作为一个13000+star的开源swift项目，在质量和实用性上是毋庸置疑的。并且该项目只有1000多行代码，作为我们阅读分析的第一个项目，我已经找不出更合适的了。

SwiftyJSON有什么功能

当我们从服务端取到数据并序列化为JSON后，从JSON到Model的这一过程是很痛苦的，为了使APP不仅仅因为后台的数据有一点点问题就崩溃掉，我们需要在取每个值的时候都小心翼翼的去进行空值和类型判断，表现在代码上就是一大堆的if...else或者guard...else，不仅繁琐，而且非常容易出现疏忽。
SwiftyJSON可以通过Data或String对象实例化JSON对象，之后对此JSON对象可以以链式语法的形式，一层一层的取数据，并最终转化为我们想要的数据类型。如果没有指定的JSON数据或类型不匹配会返回nil，方便快捷，并且怎么玩都不会crash。

• 不用SwiftyJSON
  let jsonObject : AnyObject! = NSJSONSerialization.JSONObjectWithData(dataFromTwitter, options: NSJSONReadingOptions.MutableContainers, error: nil)
  if let statusesArray = jsonObject as? NSArray{
  if let aStatus = statusesArray[0] as? NSDictionary{
  if let user = aStatus["user"] as? NSDictionary{
  if let userName = user["name"] as? NSDictionary{
  //好累，我就取个数据写了这么多。
  }
  }
  }
  }
• 使用SwiftyJSON
  let json = JSON(data: dataFromNetworking)
  if let userName = json[0]["user"]["name"].string{
  //就这么简单取到了。
  }
  具体功能介绍请看SwiftyJSON github主页

SwiftyJSON源代码结构分析

除了提供各平台适应性的支持文件外，源代码就放在了SwiftyJSON.swift这一个文件里。
其结构为：

1. JSON结构体，定义了JSON的数据结构和构造方法
2. 索引和集合，下标，字面值，控制台打印等基于Swift标准库协议的特性实现
3. 以RowValue的形式把JSON数据转化为用户想要的数据类型
4. 运算符重载实现JSON数据的比较

后面我也将以此为索引，分4篇文章分析，在此之前，我们可以来聊聊一些边边角角的东西。

关于注释

代码其实是写给两类人看的：

• 用户。单纯使用你代码的人，他们不会对源代码进行修改，甚至不在乎代码具体是如何组织的，他们只希望能够从编译器和文档获得足够的信息来使用代码
• 开发者。可以是作者自己，也可能是维护扩展代码的其他人，他们需要快速准确的定位或者读懂你的代码

为了提升代码的可读性，注释无疑是最有效的方法之一，而写出可读性高的代码，不仅仅是一种态度和责任，更是有着现实的收益——阅读你的代码最多的人，肯定是你自己。
swift中的注释格式，有如下5种，我们应该在开发过程中根据情况综合应用：

• //
  普通的单行注释
• /* */
  可嵌套的多行注释
• // MARK: -
  使用Xcode查看方法列表时，会把列表以一条灰色线段分割为分区。如果在后面加上其他文字，这些文字会像标题一样出现在分区的上方
  
  
• ///
  Xcode会添加该注释内容到Quick Help的Description字段
  
  

  右边的Description内容为///注释的"Error code"
• /** */
  和///类似，且可以通过添加parameter、returns等字段为函数的使用提供更多的信息
  
  

  注释中的`- parameter` 等字段会被组织为右边的形式

知识点一：给代码加上必要的注释以提高可读性。用// MARK: -形式的注释划分代码结构，对于开放给用户的接口，更应以///或/** */的形式的注释，使得Xcdoe能提供足够多的接口信息给用户

关于访问权限

当我们在写每一个类、枚举、属性、函数等任何单元时，第一个要考虑的就应该是其访问权限的问题，面向对象思想的基础是封装抽象，如果在外部可以无视对象封装随意访问甚至修改对象内部结构，这种代码将会变得非常难以维护，而且极有可能是随时会爆炸的定时炸弹。
swift中的访问权限有如下5种，我们应该尽量使用最低的权限：

• open和public
  能够让同一模块中的任何文件中访问，也可以通过导入定义的模块让其他模块或者源文件访问。一个Framework是另一个模块，所以供用户使用的接口会被指定为open或public
• internal
  能够让同一模块中的任何文件中访问，但是不能让这个模块以外的文件访问。
• file-private
  只能在自己定义的文件中访问
• private
  只能在声明的实体内部访问

swift的默认访问权限是internal

知识点二：尽量以最低的访问权限来设计接口，更要通过思考访问权限问题，来努力保持抽象的一致性和对象的封装性

关于宏

出于安全性的考虑，swift中并没有加入宏的功能，对于简单的值类型的宏，可以直接通过let定义一个常量代替。实际上在OC开发中，更好的方式也是通过定义一个类似于const NSString * ErrorDomain的常量来获得更多的类型检测。