LoginSignup
1

More than 1 year has passed since last update.

posted at

updated at

Xcodeを使わずUIKitのレイアウトをjsonで書いて複数の実機で同時にHotReloadするライブラリを作った

概要

タイトルの通りです。
SwiftUIが話題になってきている令和の時代にUIKitに焦点を当てたライブラリを作ってみました。
名前はUIKitHotReloadです。
Githubはこちら。

概要

  • レイアウトをjsonで記述します
  • 複数の実機で同時にHotReloadさせることができます
  • 既存のUIKitのレイアウトと組み合わせ可能です
  • Firestoreのsnapshotの機能を使います
  • Releaseビルド時はbundleされたjsonファイルを利用するのでHotReloadしません
  • xibやstoryboardを置き換えるものなのでViewControllerは必要です
  • ボタンタップ時のアクションなどもswiftで記載する必要があります

動き

こんな感じで複数のシミュレータで同時にHotReloadできます。
もちろん複数の実機でも同様にHotReloadします。

より詳細な動画はYouTubeにあげています。
IMAGE ALT TEXT HERE

レイアウトの組み方

以下のような画面の中央に赤丸のviewを表示させるシンプルな画面の例を記します。

ViewController.swift

ViewControllerから読み込みたいViewのjsonを指定します。

ViewController.swift
import UIKit
import UIKitHotReload

final class ViewsViewController: UIViewController {

  override func viewDidLoad() {
    super.viewDidLoad()
    // views/sample.jsonを読み込む場合
    self.view.loadHotReload(dirName: "views", jsonFileName: "sample") { result in
      switch result {
      case .failure(let error):
        //読み込み失敗
        print(error.localizedDescription)
      default:
        //読み込み成功
        break
      }
    }
  }
}

views/sample.json

基本的にUIKitのクラス名やパラメータ名と連動したkeyでjsonを記述します。

views/sample.json
{
  "class": "view",
  "background_color": [
    1,
    1,
    1
  ],
  "subviews": [
    {
      "class": "view",
      "background_color": [
        1,
        0,
        0
      ],
      "circle": {
        "rad": 50
      },
      "layout": {
        "center": {
          "x": {
            "v": 0
          },
          "y": {
            "v": 0
          }
        },
        "size": {
          "width": {
            "v": 100
          },
          "height": {
            "v": 100
          }
        }
      }
    }
  ]
}

HotReloadする仕組み

UIKitHotReloadはjsonからUIKitのViewを構築していくトランスパイラとして機能しています。
VSCodeのRun On Scriptのアドオンなどでjsonを保存したらfirestoreにアップロードさせます。
firestoreのリアルタイムにローカル(スマホアプリ)とサーバーのデータを同期する機能により、即時にアプリ内の画面がリロードさせjsonからUIKitのレイアウトを再構築します。
リリースビルドの場合はbundleされたjsonを読み込むためfirestoreと連携はしません。

SwiftUIと比べて

メリット

・iOS13以前でも動く
・既存のUIKitのソースコードと親和性が高い
・一度インストールしたらXcodeすら立ち上げる必要がないので中古のmacbook airでもレイアウトが組める
・複数の実機で同時にHotReloadでレイアウトを確認できるので、一度チームメンバーに配布したら、再配信することなく全員の意見を即時反映させることができる

デメリット

・firestoreの機能が前提
・VSCodeのRun On Script(保存したらスクリプト実行)が前提
・初期設定に手間がかかる
・オンライン環境でないとHotReloadは機能しない
・jsonで補完が効かない
・サポートしているviewの種類が少ない

サポートしているView

UIView
UIButton
UILabel
UIImageView
UITextField
UIScrollView
UIStackView
UITableView
UITableViewCell

その他の例

UIView

UIViewのパラメータを使った実装例です

ViewsViewController.swift
views.json

UIButton

UIButtonを使った実装例です
jsonからswiftの連携をしたボタンタップ時の処理も記述しています

ButtonsViewController.swift
buttons.json

Twitter風

UITableViewの例としてTwitter風のセルを表示させています。

TwitterTimelineViewController.swift
twitter_timeline.json
twitter_timeline_cell.json

今後

初期設定をシンプルにする
サポートするviewの追加
複数人が同時編集できるようにする
テストコードを入れる

終わり

CocoaPodsの登録も初めてでしたが意外と簡単にできるんだなと思いました。
オープンソースのライブラリの作法なんかもよく分かってもらず、ご意見などいただけると嬉しいです。

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
What you can do with signing up
1