こんにちは。カイザーです。Swiftでのコードジェネレータでは、SwiftGenやRSwiftが有名ですね。
今回は、SwiftGenを紹介します。
SwiftGenとは、stringsやStoryboard、Asset Catalog等のリソースから、Swiftファイルをジェネレートする、CLIツールです。
iOSでのリソース使用にありがちな、文字列での名前指定では無く、ジェネレートされた定数定義や構造体を使用することにより、typoを無くすことができます。
今回は、簡単なスライドショーアプリをサンプルに、SwiftGenを使っていきたいと思います。
先に、SwiftGenの特徴を説明しておきましょう。
様々なリソースの中から、必要な種類、ファイル、ディレクトリなどに絞り込む設定が可能です。
そのため、コードジェネレートに余計な時間はかかりません。
(R.swiftでは対応するすべてのリソースが自動的に含まれます。)
自前でリソースファイルをパースし、コードジェネレートします。そのため、ビルドは発生しません。
swiftgen.ymlファイルをプロジェクトファイルと同じ階層に配置し、設定を記載することができます。
この設定ファイルさえGitで共有すれば、誰でも同じルールでコードがジェネレートされます。
Cocoapods, Homebrew, Mintからインストール可能ですが、今回はCocoapodsを使用します。プロジェクトごとに、SwiftGenのバージョンを管理したいためです。
Podfileにpod 'SwiftGen'を追記し、$ pod installすれば、インストール完了です。
利用するには、プロジェクトルートまで移動し、$ Pods/SwiftGen/bin/swiftgenで実行可能です。
多言語アプリでは必須のファイルですね。
以下の設定を行います。
strings:
inputs: swiftgen-ex/Base.lproj/Localizable.strings
outputs:
- templateName: structured-swift4
output: swiftgen-ex/Generated/strings.swift なお swiftgen-exはサンプルプロジェクト名なので、皆さんのプロジェクト名に読み替えてください。
1番初めのstringsはリソースの種類を表します。SwiftGenが対応しているもののみ、指定可能です。
inputsは、リソースファイルそのものを示します。ファイル単体を指定することもできますし、ディレクトリを指定することもできます。
指定は単数でも、複数でも可能です。
ディレクトリの場合、その中の全てのファイルが対象となりますが、別途filterを設定することで、正規表現でファイル名を指定することもできます。(Interface Builderで説明します)
outputsはコードジェネレータの出力方法や、出力先を設定します。
SwiftGenでは「テンプレート」によって、ジェネレートされたSwiftコードの構造が決まります。それを指定するのがtemplateNameです。
stringsでは、structured-swift4とflat-swift4が使用可能です。
stringsファイルで、キーをドット区切りにすると、その指定に沿って構造化された定数がジェネレートされます。(実際はenumです)
例えば、以下のようなstringsファイルを作ると
"cities.italy.name" = "Italy"; "cities.london.name" = "London"; "cities.paris.name" = "Paris";
Swift側からは、以下のように呼び出せます。
L10n.Cities.London.name L10n.Cities.Paris.name L10n.Cities.Italy.name
さらに、L10nでピンと来たかもしれませんが、この呼び出しによりLocalizable.stringsでの多言語も反映されます。
今回は使用しませんが、structured-swift4とは対象的に、構造的にならず、フラットな構造でコードジェネレートされます。
ジェネレートされたSwiftファイルの出力先です。今回はGeneratedディレクトリ配下にします。
このディレクトリ配下は、コンフリクト防止のため、gitignoreしておくと良いでしょう。
リソースファイルの準備と、swiftgen.ymlの編集が完了したら、プロジェクトルートで$ Pods/SwiftGen/bin/swiftgenを実行します。
すると、outputで指定したディレクトリにSwiftファイルが出てきます。
これらをプロジェクトに追加し、使用します。
Storyboardには様々な「Identifier」という設定項目があり、全て文字列のため、誰しも間違えたことはあるでしょう。SwiftGenではStoryboardとSegueを定数化することができます。
以下を追記します。
ib:
inputs: swiftgen-ex/Base.lproj
filter: .+\.storyboard$
outputs:
- templateName: scenes-swift4
output: swiftgen-ex/Generated/Storyboard Scenes.swift
- templateName: segues-swift4
output: swiftgen-ex/GEnerated/Storyboard Segues.swift 1番初めはibとなります。
filterでは、inputsのディレクトリの内容を、正規表現で絞り込むことができます。今回は、拡張子がstoryboardのものを絞り込んでいます。
今回はoutputsが2つあります。scenes-swift4はStoryboardや画面、segues-swift4はSegueを定数化します。
StoryboardのViewControllerなどをインスタンス化するには、以下のようにします
// Main.storyboardのInitial Sceneのインスタンスを生成
let initialViewController = StoryboardScene.Main.initialScene.instantiate()
// Main.storyboardのIdentifier"viewController"のインスタンスを生成
let viewController = StoryboardScene.Main.viewController.instantiate() Storyboardのファイル名や、Identifierを文字列として渡す必要が無いので、すっきりとしています。
コードからSegueで画面遷移するときに、とても便利です。
// Main.storyboardのSegue Identifier"toPhoto" で遷移する。 perform(segue: StoryboardSegue.Main.toPhoto)
値を渡すときは、これまで通りprepare(for segue:)を実装しますが、Segueの判定にSwiftGenが使えます。
override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
// UIStoryboardSegueからStoryboardSegue.Mainのインスタンス生成
switch StoryboardSegue.Main(segue) {
case .toPhoto?: // "toPhoto" Segueの遷移
if let photoViewController = segue.destination as? PhotoViewController {
photoViewController.imageAsset = photos[index].asset
}
break
default:
break
}
} このコードは、サンプルアプリで写真がタップされたときに、写真画面に遷移する内容です。
残念な点が1つだけあり、destinationのキャストが従来通り発生してしまうことです。ここは、R.Swiftの方が、一枚上手かなと思います。
最近のXcodeでは、#imageLeteralなどを使用することによって簡単にAsset Catalogにアクセスできるようになりましたが、SwiftGenでもAsset Catalogの定数化が可能なので、紹介します。
普段のIDEにAppCodeを使用している場合は重宝します。
以下を追記します。
xcassets:
inputs:
- swiftgen-ex/Assets.xcassets
outputs:
- templateName: swift4
output: swiftgen-ex/Generated/assets-images.swift 1番初めはxcassetsとなります。AssetCatalogの設定はシンプルですね。ちなみに、複数のAssetCatalogを使用している場合は、inputsに書き足したり、複数のAssetCatalogが入っているディレクトリごとまとめて指定してしまっても構いません。
今回は、Assets.xcassets直下に、”london”, “paris”, “italy” の3つの画像を配置しました。そのため、それぞれの呼び出しは以下となります。
let londonImage = Asset.london.image let parisImage = Asset.paris.image let italyImage = Asset.italy.image
これで、UIImageを取得することができます。
ここで紹介した以外にも、様々なリソースに対応しています。以下にそれぞれのジェネレート仕様が記載されています。
https://github.com/SwiftGen/SwiftGen/tree/master/Documentation/SwiftGenKit%20Contexts
また、出力テンプレート仕様については、以下に記載されています。
https://github.com/SwiftGen/SwiftGen/tree/master/Documentation/templates
今回は、SwiftGenを試しましたが、同種であるR.Swiftも調べながら調査しました。どちらにも、長所短所があるため、R.Swiftとの比較記事も書いてみたいと思います!