HandyJSON简单使用

一、HandyJSON简介

HandyJSON 是阿里开发的一个在swift上把JSON数据转化为对应model的框架。与其他流行的Swift JSON库相比，HandyJSON的特点是，它支持纯swift类，使用也简单。它反序列化时(把JSON转换为Model)不要求Model从NSObject继承(因为它不是基于KVC机制)，也不要求你为Model定义一个Mapping函数。只要你定义好Model类，声明它服从HandyJSON协议，HandyJSON就能自行以各个属性的属性名为Key，从JSON串中解析值。不过因为HandyJSON是基于swift的metadata来做的，如果swift的metadata的结构改了，HandyJSON可能就直接不能用了。当然阿里一直在维护这个框架，swift的源码有变化，相信框架也是相对于有改变的。github地址。

二、HandyJSON导入项目

1、当然最简单的方式用cocoapod的方式导入啦

      podfile文件里加入：pod 'HandyJSON', '~> 5.0.2'
      然后执行pod install

2、如果使用的是Carthage，也很简单

     github "alibaba/HandyJSON" ~> 5.0.2

三、HandyJSON简单使用

1、这里主要有几种简单的json字符串转对应model的情况。先直接展示model类的代码

import UIKit
import HandyJSON

class Person: HandyJSON {
    var doubleOptional: Double?
    var stringImplicitlyUnwrapped: String = ""
    var int:Int?
    var name: String?
    
    required init(){} // 必须实现一个空的初始化方法
}

class Component: HandyJSON {
    var num: Int?
    var comp1: SubComponent?
    var comp2: SubComponent?
    
    required init(){}
}

class ComponentArr: HandyJSON {
    var num: Int?
    var compArr: [SubComponent]?
    
    required init(){}
}

class SubComponent: HandyJSON {
    var aInt: Int?
    var aString: String = ""
    
    required init(){}
}

//let jsonString = "{\"cat_id\":12345,\"name\":\"Kitty\",\"friend\":{\"id\":54321,\"name\":\"Lily\"}}"

class Cat: HandyJSON {
    var id: Int64!
    var name: String!
    var friendName: String?

    required init() {}
    
    func mapping(mapper: HelpingMapper) {
        // 把id转换为json数据里的key：cat_id，friendName转化为读json数据里的friend字典中的name字段。
        mapper <<<
            self.id <-- "cat_id"
    
        mapper <<<
            self.friendName <-- "friend.name"
    }
}

2、对应使用的HandyJSON的代码例子

1、简单的解析，包括model中有json里不存在的，json中也有model里不存在的内容

func parse1() {
        // 简单的解析
        let jsonString = "{\"doubleOptional\":1.1,\"stringImplicitlyUnwrapped\":\"hello\",\"int\":1,\"msg\":\"world\"}"
        if let p: Person = Person.deserialize(from: jsonString){
            print(p.doubleOptional!)
            print(p.stringImplicitlyUnwrapped)
            print(p.int!)
            //print(p.name)
        }else{
            print("解析失败")
        }
    }

2、包含对象嵌套的解析

func parse2() {
        let jsonString = "{\"num\":12345,\"comp1\":{\"aInt\":1,\"aString\":\"aaaaa\"},\"comp2\":{\"aInt\":2,\"aString\":\"bbbbb\"}}"
        if let mainCom: Component = Component.deserialize(from: jsonString)  {
            print(mainCom.num!)
        }
    }

3、包含数组对象的解析

func parse3 () {
        let jsonString = "{\"num\":12345,\"compArr\":[{\"aInt\":1,\"aString\":\"aaaaa\"},{\"aInt\":2,\"aString\":\"bbbbb\"}]}"
        if let mainCom: ComponentArr = ComponentArr.deserialize(from: jsonString)  {
            print(mainCom.num!)
            for com in mainCom.compArr! {
                print(com.aInt!)
                print(com.aString)
            }
        }
    }

4、把字典转成对象

func parse4 () {
        var dict = [String: Any]()
        dict["doubleOptional"] = 1.1
        dict["stringImplicitlyUnwrapped"] = "hello"
        dict["int"] = 1
        
        if let p: Person = Person.deserialize(from: dict) {
            print(p.doubleOptional!)
            print(p.stringImplicitlyUnwrapped)
            print(p.int!)
            print(p.name) // 字典里没有对应的值，为nil
        }
    }

5、包含自定义解析：当model的属性名和json里的对应不上的时候，model里实现mapping函数去对应key。

func parse5() {
        let jsonString = "{\"cat_id\":12345,\"name\":\"Kitty\",\"parent\":\"Tom/Lily\",\"friend\":{\"id\":54321,\"name\":\"Lily\"}}"
        
        if let cat: Cat = Cat.deserialize(from: jsonString) {
            print(cat);
        }
    }

推荐一下文章
https://www.jianshu.com/p/0f060be5c35a