数回クリックするだけでXcodeのルーチンまたは既製のアプリケーションを打つ方法

経験豊富な各開発者には、使い慣れたツールセットがあり、作業に便利です。 これは、最も単純な環境設定、中間操作用のユーティリティ（たとえば、Postman APIテストアシスタント）、ライブラリの開発者とスニペットによってタイムテストされ、個人的に開発されたものです。



また、多くの開発者は、選択したアーキテクチャの実装に対する独自のアプローチを持っている場合があります。 したがって、新しいモジュール、画面、および機能を追加するだけでよい共通のスケルトンである、武器庫でアプリケーションを空白にすることは非常に便利です。 この記事では、Xcodeで独自のアプリケーションテンプレートを作成する方法を紹介します。

テンプレートの中心はどこですか

どのくらいの頻度でアプリケーションを作成し、同じコードを何度も繰り返して作成し、将来の製品の基盤を作成しますか？ 基本クラスを宣言し、ヘルパーを作成し、アーキテクチャを配置し、ラッパーを作成します...そのような瞬間に、適切に開発されたアーキテクチャとさらなる開発のための記述されたベースを備えた作業アプリケーションを即座に取得するツールが必要です。



そのようなツールが存在し、Xcodeで「シングルビューアプリ」を作成するときに、私たちは常にそれを使用します。



独自のテンプレートを作成するためのAppleからの指示の検索は失敗しました。 ただし、Xcodeでは、すでに準備されたコードを使用して独自のファイルの生成を追加できますが、これは難しくありません。



簡単に始めるために、よく知られているシングルビューアプリを見てみましょう。 Finderに移動して、キーの組み合わせCmd + Shift + G（フォルダーに移動）を押し、パスを指定します。



/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/Library/Xcode/Templates/Project Templates/iOS/Application







そこで「Single View App.xctemplate」を見つけて、たとえばデスクトップにコピーします。

ご覧のとおり、テンプレートは4つのファイルのみで構成されています。

• Main.storyboard。 メインビューコントローラーを含むストーリーボード。
• TemplateIcon.png。 48x48の解像度のアイコン。
• TemplateIcon@2x.png。 96x96の解像度のアイコン。
• TemplateInfo.plist。 テンプレートの構成ファイル。

ここで重要な役割を果たすのは、すべての設定が含まれているため、最後のファイルTemplateInfo.plistだけです。 Main.storyboardは、このテンプレートを使用して作成された各アプリケーションに追加される可能性のあるファイルの1つにすぎません。 このリストに2番目と3番目のファイルがない場合、テンプレートにはデフォルトのアイコンがあります。 したがって、テンプレートの中心はTemplateInfo.plistです。

構成ファイルの基本プロパティ

従来、TemplateInfoプロパティはいくつかのカテゴリに分類できます。



1. テンプレートのマークアップ

Xcode環境で表示するテンプレートと追加フィールドに一意の識別子を割り当てます。



必須フィールド：



- 識別子

一意の識別子。 同じIDを持つ2つのテンプレートは同時に存在できません。 他のテンプレートの継承にも使用されます。



- 種類

テンプレートのタイプ。 プロジェクトの場合、Xcode.Xcode3.ProjectTemplateUnitKindが常に使用されます。



- コンクリート

新しいアプリケーションを作成するときにテンプレートをリストに表示するかどうかを示すフィールド。 別のテンプレートから呼び出され、それ自体が独立していない場合は、NOを設定するのが理にかなっています。 それ以外の場合は、常にYESを設定してください。



オプションのフィールド：



- プラットフォーム

テンプレートを使用するプラットフォームを決定します。 他のプラットフォームのテンプレートの継承を防ぐためにのみ有用です（たとえば、iOSのテンプレートをWatchOSのテンプレートにインポートしようとする場合）。



- 名前

テンプレートの表示名。 デフォルトのディレクトリ名は* .xctemplateです。



-SortOrder

シリアル番号。 そのようなフィールドがない場合、最後と見なされます。



- 説明

テンプレートの説明。 Xcodeでは、最新バージョンは表示されません。



2.継承

Xcodeのテンプレートには非常に便利なプロパティがあります。他のテンプレートのプロパティとファイルを含めることができます。 ファイルを再度コピーしたり、構成ファイルを編集したりせずに、別の機能を追加してテンプレートを拡張する必要がある場合に非常に役立ちます。 直接の例えは、OOPの継承です。



3.先祖

プロパティとファイルがプロジェクトに含まれる識別子テンプレートのリスト。



4.コンテンツ生成

既製のファイルを使用するか、設定で世代を登録することにより、新しいアプリケーションに入力できます。



PSプロジェクトはObjective-CとSwiftの両方を使用して作成できるため、ファイル生成は異なる言語に対して個別に登録する必要があることに留意する必要があります。

これを行うために、Optionsフィールドが作成されます。これは配列です。 最初の要素として、辞書を作成し、2つのキーを作成します。 最初は、値が「languageChoice」のString型の識別子です。 2番目はUnitsです。これは辞書です。 Unitsでは、それぞれ「Objective-C」と「Swift」という名前の2つの辞書を作成します。 後続のすべての定義とノードは、これらのディレクトリ内に配置されます。 言語バインディングがない場合（たとえば、xib、ストーリーボードを追加する、またはファイルにコンテンツを書き込む場合）、定義とノードを他のパラメーターを使用して同じレベルで宣言できます。







5.定義

ここで、コード生成が宣言され、アプリケーションに追加されるファイルへのパスが登録されます。



定義は連想配列で、ファイルまたは変数のリストが含まれています。 同様に、各ファイルは連想配列でもあり、ファイルへのパスが含まれています。 パスとグループの2つのプロパティで構成できます。



Path-.xctemplateディレクトリにあるファイルへの直接パス。

グループ-配列。各要素は指定されたパスのディレクトリです。 ファイル自体は指定されていません。



たとえば、ファイルにはパスがあります。



Presentation/Common/ViewController/Base/ViewController.swift







次に、その定義は次のようになります。







したがって、ファイルにネストがなく、直接.xctemplate /にある場合、グループ配列は作成されません。



6.ノード

ファイルの場所のパスを指定したら、作成したファイルまたはコンテンツのいずれかを指すリンクを作成する必要があります。 Nodesは、その要素がDefinitionsのキーである通常の配列です。 上記の例では、ノードは次のようになります。

TemplateInfo.plist内のコード生成

TemplateInfo.plistで作成されたファイルにコードを追加するには、Definitionsで記述し、Nodesでポイントします。 これは、ファイルを指定した後に「：」演算子を使用して行われ、その後にコードが書き込まれます。 たとえば、標準の「ページベースのアプリ」テンプレートでは、多くのコード生成が定義で説明されていることがわかります。







ファイル内のコードの順序は、Nodes配列内のリンクの順序によって異なります。 指定されたファイルが存在しない場合、作成されます。



次の定数は、事前に作成されたファイルおよびTemplateInfo.plist内で機能します。



___著作権___著作権の行

___DATE___プロジェクトの作成日（ファイル）

___DIRECTORY___ファイルへのフルパス

___FILEBASENAME___拡張子なしのファイル名

___FILEEXTENSION___ファイル拡張子

___FILENAME___完全なファイル名

___FULLUSERNAME___システムで許可されているユーザーの名前

___ORGANIZATIONNAME___プロジェクトの作成時に指定された組織の名前

___PACKAGENAME___ / ___PROJECTNAME___プロジェクトの作成時に指定された製品名

___TIME___プロジェクトが作成された時刻（ファイル）

___USERNAME___許可ユーザーアカウント名

アプリケーション設定の編集ウィンドウ

テンプレートを作成するとき、アプリケーション設定ウィンドウを編集することもできます。このウィンドウは、このテンプレートが呼び出されたときに表示されます。



たとえば、「シングルビューアプリ」の場合、Appleは開発者の名前と組織の名前を入力するためのいくつかのテキストフィールド、単体テストプロジェクトまたはCoreDataに含めるためのいくつかのチェックボックス、およびプログラミング言語を選択するためのドロップダウンリストを提供します。 これらはすべて、オプションフィールド（辞書からの配列）によって規制されます。 次の機能のリストは、各オプションで使用できます。



- 識別子

オプションフィールドに格納されている値を変更または使用できる識別子。



- デフォルト

このフィールドにデフォルトで使用される値。



-SortOrder

このオプションがウィンドウに表示されるシリアル番号。



- なえ

オプションのタイトル。



- タイプ

作成するフィールドのタイプ。 次のフィールドタイプを使用できます。

• 静的 静的で編集できないテキスト。 意味の面では-ラベルにすぎません。
• チェックボックス 通常のチェックボックス。 これは基本的にBoolフィールドであるため、trueおよびfalseの値に対応するアクションのセットを含むUnitsを定義することも必要です。 使用例は、コアテンプレート「Core Data Cocoa Touch App.xctemplate」にあります。これについては、テンプレートの作成に関するセクションで説明します。
• テキスト テキストを入力するためのフィールド。
• ポップアップ。 値配列で定義する必要があるドロップダウンリストから選択を提供します。

アプリケーションテンプレートを作成する

始める前に、テンプレートに従って作成されたアプリケーションで表示したいコードを記述したファイルを準備する必要があります。 まだ自分の在庫を持っていない場合は、私のものを取ることができます。 これは、ライブラリを使用しないMVVMの最も単純な実装です。 ここには多くのファイルはありませんが、例としては十分です。 それらの例を使用して、テンプレートのさらなる作成を分析します。



まず、作成したテンプレートが保存されるディレクトリを作成します。 これを行うには、コンソールでコマンドを実行します



$ mkdir -p ~/Library/Developer/Xcode/Templates/Project\ Templates/Private







Xcodeは、このパスに沿ってアプリケーションテンプレートを検索します。 プライベートフォルダーに自由に名前を付けることができます。主なことは、このパスに沿って配置されることです。 このようなディレクトリは複数存在する場合がありますが、それらに含まれるテンプレートには異なる識別子が必要です。 それ以外の場合、1つを除くすべてのディレクトリにあるテンプレートの存在は無視されます。



以前にコピーした「Single View App.xctemplate」は「MVVM Application.xctemplate」に名前が変更され、プライベートフォルダーにコピーされます。 Xcodeを起動して新しいアプリケーションを作成するメニューに移動すると、1つの「MVVMアプリケーション」テンプレートがある最下部に新しいプライベートセクションが既に表示されています。 まだ何も変更していないので、使用すると同じシングルビューアプリが取得されます（ちなみに、これは同じ識別子を持つため、基本的なアプリのリストから消えました）。



次のステップでは、プレゼンテーションフォルダーと2つのアイコンファイルTemplateIcon.pngおよびTemplateIcon@2x.pngを移動します。 次に、Xcodeがテンプレートをまったく新しいものとして認識できるように、識別子を変更する必要があります。 たとえば、識別子を「MVVMTemplate」として定義します。 Xcodeで新しいアプリケーションを作成すると、「Single View App」が元の場所に戻り、Privateセクションで「MVVM Application」がアイコン表示に戻ります。



次に、Single Viewアプリがどのテンプレートから継承するかを見てみましょう。 TemplateInfo.plistを開き、先祖に移動します。



com.apple.dt.unit.storyboardApplication

com.apple.dt.unit.coreDataCocoaTouchApplication







「シングルビューアプリ」と同じ場所に、これらの識別子を持つテンプレートがあります。 順番に整理しましょう。



最初の「Storyboard App.xctemplate」テンプレートには、定義ファイルとノードフィールドを表示できる構成ファイルのみが含まれています。 Main.storyboardがメインストーリーボードとして使用され、そのパスが示されることが規定されています。 これは必要ありません、なぜなら メインスクリーンとして使用するMainScreen.storyboardファイルが既にあります。 したがって、「Storyboard App.xctemplate」テンプレートを祖先から削除します。



次に、「Core Data Cocoa Touch App.xctemplate」テンプレートが登場します。 CoreDataを使用するためのオプションにチェックボックスフィールドが追加され、Unitsフィールドにはすべての必要なコード生成と___ PACKAGENAMEASIDENTIFIER ___。Xcdatamodeldファイルのインポートが含まれます。 CoreDataも必要ないと仮定し、この親も削除します。



しかし、ここに問題があります。テンプレートに従ってアプリケーションを作成しようとすると、リストに表示されなくなります。 事実、削除した親には、祖先リストもありました。これには、com.apple.dt.unit.cocoaTouchApplicationBaseという識別子を持つ必要なCocoa Touch App Baseテンプレートが含まれていました。 それをテンプレートの祖先リストに追加すると、利用可能なもののリストに再び戻ります。 この基本的なテンプレートを慎重に検討したので、なぜそれが必要なのかを理解できます。



次に、コピーしたファイルのすべてのパスとリンクを書き留めましょう。 コードはSwift向けに書かれているため、これは彼のみに行います。



[オプション]-> [languageChoice（アイテム0）]-> [ユニット]-> [Swift]に移動し、定義と呼ばれるディクショナリを作成します。 次に、持っているファイルへのすべてのパスを書き出します。



Presentation/Common/View Controller/Base/ViewController.swift

Presentation/Common/View Model/Base/ViewModel.swift

Presentation/Common/View Model/ViewModelHolder.swift

Presentation/Main Screen/MainScreen.storyboard

Presentation/Main Screen/View Controller/MainViewController.swift

Presentation/Main Screen/View Model/MainViewModel.swift







次のリストを取得します。







Nodesリンクに入力すると、次のようになります。







最後の仕上げを追加するために残っています-MainScreen.storyboardをメインの1つとして置きます。 ファイル全体の定義とノードを作成し、次のフィールドをそれらに追加します。



定義：

キー

Info.plist：UIMainStoryboardFile



価値

 <key>UIMainStoryboardFile</key> <string>MainScreen</string>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ノード：

Info.plist：UIMainStoryboardFile



次のものが得られます。







添付の例では、TemplateInfo.plistファイルの既製バージョンがあります。



この記事では、テンプレートとファイルを作成するためのすべての機能については説明しません。 ここに収まるように、各パラメーターの説明は単に不可能です。 そのため、サンプルが含まれるリポジトリにドキュメント（非公式）を配置します。リポジトリには、すべての機能が記述され、既存のパラメーターがすべてリストされています（Xcode 4の存在時点）。 ほとんどの機能は、Appleの基本的なテンプレートを掘り下げて理解すると同時に、実装を確認できます。 単純なテンプレートを簡単に作成するために必要な最小値について説明しました。



コメントや追加がある場合は、その有用性を高めるために、それらを聞いて記事を補足することを嬉しく思います。