README_CN.md

English | 中文

🧑🏼‍💻 为 ObjectMapper 使用者提供 JSON 转 Swift Model 的 Xcode 插件。

⏬ 点击下载

功能

• JSON 转 Mappable
• JSON 转 ImmutableMappable
• 自动补全 mapping 等方法
  • 支持使用 @map 关键字实现自定义映射
• 支持内嵌结构
• 自动生成符合小驼峰命名规范的变量名
• 自动对名为 xxx(ID|Id|id) 的变量使用 Int64

安装

• macOS 10.15+
• 将 MappingCoder.app 拖到 应用程序 目录下
• 运行 App。第一次运行会将插件安装到 Xcode 上。
• 在 系统设置 > 扩展 > Xcode Source Editor 中，选中 MappingCoder 来将其激活。

卸载

将 MappingCoder.app 移入 垃圾桶。

如果出现“扩展正在被使用”的弹窗，可以尝试退出 Xcode 进程。

使用方法

在 Xcode 中，在源码编辑区域选中 JSON 或 Class/Struct 的定义代码。点击 Editor > MappingCoder > ... 来运行。

示例

JSON 转 Mappable

JSON 转 ImmutableMappable

自动补全 mapping 等方法

有时我们并不需要将整个 JSON 都转成 Model。所以你可以只把 Model 内的属性定义好，然后执行 Auto Complete Mapping Methods 来自动生成 init(map:) 和 mapping(map:) 的代码。如果你想自定义映射关系，可以使用 @map() 关键字为每个属性指定 key 和 default。

以下是 Swift 风格的 @map 方法定义。

@map(key: String? = nil, default: Any? = nil)

你可以这样使用它。

// 输入你的类声明，并且在属性的行注释里使用 @map

struct Person: ImmutableMappable {

    // @map(key: "all_skills", default: [])
    let skills: [Any]
    // @map(key: "user-name", default: "")
    let name: String
    // @map(default: [:])
    let profile: [String : Any]
    // @map(key: "math score")
    let mathScore: Int
}

// 执行 Auto Complete Mapping Methods

struct Person: ImmutableMappable {

    // @map(key: "all_skills", default: [])
    let skills: [Any]
    // @map(key: "user-name", default: "")
    let name: String
    // @map(default: [:])
    let profile: [String : Any]
    // @map(key: "math score")
    let mathScore: Int

    init(map: Map) throws {
        skills = (try? map.value("all_skills")) ?? []
        name = (try? map.value("user-name")) ?? ""
        profile = (try? map.value("profile")) ?? [:]
        mathScore = (try? map.value("math score")) ?? <#defaultValue#>
    }

    func mapping(map: Map) {
        skills >>> map["all_skills"]
        name >>> map["user-name"]
        profile >>> map["profile"]
        mathScore >>> map["math score"]
    }
}

这个功能基于 SwiftSyntax 实现。

驼峰命名 & Int64

MappingCoder 自动使用小驼峰命名法命名所有变量。而且，会将名为 xxx(ID|Id|id) 的变量类型定义为 Int64。

//{
//    "user_name": "jack",
//    "user-id": 123456789
//}

class <#name#>: Mappable {

    var userId: Int64 = <#defaultValue#>
    var userName: String = <#defaultValue#>

    required init?(map: Map) {}

    func mapping(map: Map) {
        userId <- map["user-id"]
        userName <- map["user_name"]
    }
}

设置

在 Xcode 中，点击 Editor > MappingCoder > Settings... 来打开设置。

灵感源头

• JSON-to-Swift-Converter
• SwiftSyntax
• SwiftSemantics

开源协议

MIT