dnrops/JSONPreview

JSONPreview 继承自 UIView，并基于 UITextView 实现功能。您可以通过它来格式化您的 JSON 数据，并高亮展示。

同时 JSONPreview 还提供折叠与展开功能，您可以折叠那些您暂时不关注的节点，并在任意时刻重新展示它。

JSONPreview 的全部功能都使用原生方法编写，这意味着您可以在 Apple 平台获得较好的使用体验。

预览

下面是一个大约25秒的gif（大约2.5M），它展示了使用本库预览 JSON 时的效果。

screenshot

基本要求

运行 iOS 10 及以上版本的设备。
使用 Xcode 10 及以上版本编译。
Swift 5.0 及以上版本。

安装

CocoaPods

pod 'JSONPreview'

Swift Package Manager

依次选择 File > Swift Packages > Add Package Dependency
输入 https://github.com/rakuyoMo/JSONPreview.git
选择 “Up to Next Major” 并填入 “2.0.0”

或者将下面的内容添加到 Package.swift 文件中：

dependencies: [
  .package(url: "https://github.com/rakuyoMo/JSONPreview.git", from: "2.0.0")
]

功能

在 1.3.0 版本中，我们删除了斜向滑动的功能。现在如果JSON一行展示不开，那么它将折行展示，而不是超出屏幕。如果您希望使用该功能，请使用 1.2.3 版本

支持格式化显示 JSON 数据。
支持高亮 JSON 数据，提供多种颜色与字体配置选项。
针对 Array 与 Object 提供折叠与展开功能。
基于 UITextView 实现功能。意味着您可以复制 JSONPreview 中的任意内容。
JSONPreview 提供有限的，不完整的格式检查功能，故该功能不作为主要功能提供。详情可以参考：格式检查

使用

下载项目后，ViewController.swift 文件中包含部分测试代码，运行项目即可查看对应的效果。

首先创建 JSONPreview 对象，并添加到界面上：

let previewView = JSONPreview()

view.addSubview(previewView)

调用 preview(_:style:) 方法，以默认样式预览数据：

let json = "{\"key\":\"value\"}"

previewView.preview(json)

如果您想要自定义高亮样式，可通过 HighlightStyle 与 HighlightColor 类型进行设置：

其中，ConvertibleToColor 是一个用于提供颜色的协议。通过该协议，您可以直接使用 UIColor 对象，或轻松的将诸如 0xffffff、#FF7F20 以及 [0.72, 0.18, 0.13] 转换为 UIColor 对象。

let highlightColor = HighlightColor(
    keyWord: ConvertibleToColor,
    key: ConvertibleToColor,
    link: ConvertibleToColor,
    string: ConvertibleToColor,
    number: ConvertibleToColor,
    boolean: ConvertibleToColor,
    null: ConvertibleToColor,
    unknownText: ConvertibleToColor,
    unknownBackground: ConvertibleToColor,
    jsonBackground: ConvertibleToColor,
    lineBackground: ConvertibleToColor,
    lineText: ConvertibleToColor
)

let style = HighlightStyle(
    expandIcon: UIImage?,
    foldIcon: UIImage?,
    color: highlightColor,
    lineFont: UIFont?,
    jsonFont: UIFont?,
    lineHeight: CGFloat
)

previewView.preview(json, style: style)