Swiftパッケージ：リソースとローカリゼーション

Swiftパッケージ：リソースとローカリゼーション

Swiftパッケージを使ってSwiftコードをシェアする際、リソースも一緒にシェアしましょう。画像やストーリーボードといったアセットをパッケージに含める方法、それらをコードからアクセスする方法をお伝えします。また、ローカライズされたストリングを追加することで、世界中のユーザーがコードにアクセスできるようにする方法をご説明します。このセッションを最大限に活用するには、Swiftとパッケージングコードの知識があることが望ましいです。概略については、WWDC19の"Creating Swift Packages"をご覧ください。

リソース
関連ビデオ

WWDC22
WWDC20
WWDC19
ダウンロード

こんにちはWWDCへようこそ “Swiftパッケージ:リソースとローカライズ” 私はアンダースと申します今日は Swiftパッケージのリソースとローカライズについてお話させていただきますまず最初に Swiftパッケージにリソースを追加する方法を調べてみますそれに続いてパッケージがビルドされたときに何が起こるのかまたパッケージ内のコードは実行時にどのようにリソースを利用するのかについて説明します最後にパッケージ内のリソースをローカライズする方法についても触れていきます
それではパッケージへのリソースの追加からスタートします Xcode 11はSwiftパッケージをサポートするようになりましたからあなたのXcodeプロジェクトにすでに存在するパッケージを利用できるばかりでなくパッケージの作成もできるようになりましたパッケージをSwiftばかりでなく任意のＣ系言語に実装することができます Xcode 12では画像やStoryboardなどのリソース以外の他のファイルもパッケージに追加でき
これらのリソースもローカライズ可能なため国際化対応アプリケーションはあなたのパッケージが提供する機能を活用することができますリソースをパッケージに追加する作業では既存の APIを使用できますからあなたのパッケージが OSバージョンに依存する要件を持っていたとしても影響を受けません
実際どのように機能するのか調べてみましょうここに SwiftUIビューを実装したパッケージがありますこのパッケージはサイコロの側面を示しててサイコロを回転させるためのボタンが１つあります Xcode 12で新に導入された機能がパッケージが持つSwiftUIビューをプレビューする機能でこれを実行するのに同一ワークスペース内にクライアントアプリケーションは不要ですご覧になると何かが欠けていることに気付かれるでしょうサイコロ上のドットではなく黒色のボックスを表示していますボタンを押してサイコロを回転させようとすると新しいドットの数を取り込みますがそれを表示しませんこの問題を修正してみます DiceUIターゲットのソースコードの隣にアセットカタログを作成します
Xcodeはファイル名についたサフィックスからこれがアセットカタログであることを認識してその処理方法を知ります最初アセットカタログは空になっていますが私がこれに数の異なる何種類ものドットを示す画像を追加します解像度が３段階に分かれていることに注意してください
それではビューの実装を開始して Rectangleビューを画像で置き換えます
ここでは画像の名前がドットの数と一致するように選択してありますしたがって名前をイニシャライザーへ引き渡すだけです
これらの画像が私のコードが組み込まれたモジュールのリソースバンドルから来たものであることを示すために１つのバンドルパラメータを指定します
パッケージリソースは該当するバンドルタイプの中から既存のFoundation APIを使用してリソースへアクセスしますそのためバンドルパラメータを受け取れるどのAPIへもそれを引き渡すことができますこれが一瞬の間にどのように実行されるのか詳しく見てみましょうご覧のようにサイコロの画像が画面に現れました
“roll”ボタンをクリックするとサイコロ上に表示されるドットの数が変わりますここまでくればバンドル部分を削除できるようになりますなぜなら Swiftタイプインファレンスでは .moduleしか保持できないからです
ここまで Swiftパッケージへのリソースの追加とプレビューの表示が Xcode上で作業すれば非常に簡単であることを見てきましたパッケージ内のファイルはファイルタイプに応じて処理されそれぞれのタイプはファイル名サフィックスによって識別されますアセットカタログやストーリーボード Core Dataモデルなどある種のファイルには明確な使用目的が存在します Xcodeはこれらのファイルの処理法を知っていますから単純にパッケージに追加するだけで十分です
それ以外の種類のファイルは様々な使用目的を持っことがありますプレインテキストファイルは実行時に必要となることがありますが開発時にのみ必要である場合もあります画像やシェルスクリプトその他の一般的なタイプのファイルについても同じことが言えます
これらのファイルではそのファイルの使用目的をパッケージマニフェストの中で宣言しなければなりません実例を使って調べてみましょうここに示すのは MyGameと呼ぶパッケージのファイルシステム構成例ですこのパッケージは“GameLogic”という名前の単一ターゲットを持ちすべてのターゲットのソースファイルはSources ディレクトリの下に置かれていますこのディレクトリはターゲットと同じ名前を持つディレクトリのサブディレクトリの１つです
パッケージマニフェストファイルの内容を見てみると GameLogicに対応する製品定義とターゲット定義が書かれています
使用目的が不明瞭なターゲットファイルがある場合はそのファイルを何に使用するのかをここに宣言します
パッケージマニフェストの構文とファイルシステム構成との関係についてさらに詳しく知りたいお客様は WWDC 19セッションの “Adopting Swift Packages in Xcode”をご覧ください
ターゲットディレクトリに注目してみましょうすべてのターゲットのソースとリソースがこのディレクトリの下に配置されています Swiftのソースファイルもすでにそこに置かれていますパッケージをビルドする際にソースファイルも一緒にコンパイルする必要があるからですマニフェストにこれ以外のものは必要ありませんそれではアセットカタログを追加しましょうアセットカタログは明確に定義された構造を持つディレクトリでありファイルは特定の拡張子を持っていますこのディレクトリはビルド時に処理されてパッケージのクライアントに含まれますマニフェストに特別なものは必要ありませんストーリーボードを追加する場合も事情は同じですストーリーボードも明確な目的を持っており Xcodeプロジェクトに含まれる他のオブジェクトと同じ方法でコンパイルされます
次にプレインテキストファイルを追加しましょう
ここで話がやや複雑になってきますテキストファイルは多くの異なる目的に使用される可能性がありますから Xcodeがそれをどのように処理するかは明らかではありません実行時に参照するのかも知れませんし単なる開発時の内部メモなのかも知れませんこの例で取り扱うのは Xcodeがリソースとして取り扱わないファイルですパッケージのビルド時に無視されるようにするためこのファイルをマニフェストの除外対象ファイルのリストに追加します
ファイルやフォルダが多数書き込まれたディレクトリを追加することも可能ですたとえばゲームのアートワークを作成するためのスケッチや設計ドキュメントが置かれていますファイルを除外リストへ追加するのと同じようにマニフェストの除外リストへディレクトリのサブパスを追加することも可能ですその下に置かれたすべてのオブジェクトとともにパッケージのビルド時にスキップされます
次に単独で存在する画像ファイルを追加してみましょうこの場合は実行時に必要となるファイルですからリソースとしてマニフェストへ追加しますこのファイルに対する処理操作を指定します
大部分のリソースはビルド時に適切な形態へ変換するための処理操作を必要とします実際に実施される処理の正確なタイプはパッケージをビルドする対象となるプラットフォームに依存します
サンプルゲームが実行時に必要とする多数のファイルを含むディレクトリを追加してみますこのケースでは問題のディレクトリの下に階層化されたファイルとフォルダ全体が対象です
ディレクトリ構成を含むすべてが実行時に使用できなければなりませんそれをリソースとして宣言するのですが今回は “copy”アクションを指定しますこれによりディレクトリ構造を保存しながら現在の状態が正確にコピーされます
ここまでに何種類かのファイルをパッケージターゲットへ追加する方法を見てきましたまたファイルタイプだけからは用途が分からない場合には意図を宣言する方法についても調べてきました
これまで見てきたようにリソースは処理されることもありバイト単位でコピーされることもあります一般的に好ましいのは “プロセス”アクションを選択することですその理由は対象とするプラットフォーム用に組み込まれた正しい規則が適用されるからですこのプロセスにはストーリーボードやアセットカタログを実行に適した形への変換も含まれます画像圧縮などの処理も含まれます
ファイルのタイプが分からない場合または該当するプラットフォーム向けに特別な処理を行う必要がない場合そのファイルはコピーされます
処理規則はディレクトリの下にあるすべてのファイルに再帰的に適用されその結果生ずる個々の出力ファイルは別なリソースとして製品にインクルードされます
“copy”アクションを使用するのが適しているのはファイルタイプを問わずにリソースの正確なコピーを作成したい場合です
コピー自体は何の変換操作も行いませんからたとえば通常であればコンパイルされていたであろうソースファイルを実行時にテンプレートとして使用したい場合などにコピー機能を使用することができます
ディレクトリ全体をその階層構造を維持しながらインクルードしたい場合にもコピーを使用できますビルドを実行したときターゲット内のファイルには何が起こるのでしょう？たとえばここに示すのは１つのパッケージとこのパッケージを使用するアプリケーションですこのパッケージはリソースファイルばかりでなくソースファイルも含んでいます個々のターゲットのソースはコンパイルされてコードモジュールに編入されクライアントアプリケーションにリンクされます個々のターゲットのリソースは処理されてから当該モジュールのリソースバンドルに編入されアプリケーションに埋め込まれます
Appleプラットフォームの場合はアプリケーションとアプリエクステンションはバンドルですからそれ以上の作業を行う必要はありません個々のパッケージモジュールに対応するリソースバンドルはアプリケーションバンドルの一部となりますからしたがって実行時に使用することができます
コマンドラインツールのような非バンドル製品をビルドするときはそのツールに併せてリソースバンドルをインストールすることが必要になります
パッケージバンドルについてはあと１つ触れておく必要がありますそれがミニマムツールバージョンです Swift Package Managerは Swiftツールチェーンの一部ですパッケージリソースがサポートされるようになったのはSwift 5.3からですからパッケージマニフェストは 5.3を必要なツールのバージョンとして宣言しなければなりませんこれとXcodeのバージョンとの関係はどうなるのでしょう？
すべてのリリースのXcodeはいずれかのバージョンのSwiftツールチェインを含みます Swiftパッケージをサポートする最初のバージョンはXcode 11でしたそのときのSwiftツールチェインのバージョン番号は5.1です Xcode 12には Swiftツールチェインのバージョン5.3が含まれていますこのツールのバージョン番号はパッケージが必要とする機能をサポートするバージョンの中で最も低い番号を設定しなければなりませんそのツールを使用するパッケージやプロジェクトがパッケージをビルドできるためにはそのバージョン以降のツールを必要とするからですこれでリソースをパッケージに追加しましたから次にコードからリソースへアクセスする方法を説明しますこれまで見てきたように実行時にパッケージリソースへアクセスするためにFoundationのBundle APIを使用します
Foundationは Swiftパッケージをサポートするプラットフォームであればどのプラットフォームからでも利用できますリソースへアクセスする方法として最も一貫性がありかつプラットフォーム依存が少ない方法ですつまりビルドシステムが特定のプラットフォーム上で作成する特有な生成物の影響を受けません
Xcodeがリソースを内包するパッケージターゲットをビルドするとき Xcodeは該当するリソースバンドルのためにアクセッサーを生成してそれをターゲット向けに作成するコードモジュールへインクルードします実装に用いたのがSwiftであるか Objective-Cであるかにかかわらずモジュールからリソースバンドルへのアクセスが可能となります
返されるバンドルオブジェクトはそれぞれのコードモジュールに固有ですがソースコードに記述するアクセス方法は常に同じです
ここに示すのは Bundle APIを使用してリソースバンドル内のファイルにアクセスする例です SwiftとObjective-Cの両方の例を示しています
どちらの言語でもアクセッサーは Foundation Bundleオブジェクトを返しこれを使用してリソースを名前で検索することができます
しかし任意のシステムAPIを使用してリソースバンドルを引き渡すことも可能ですこの場合 APIはバンドルをパラメータとして受け取ります
ここに示す例ではパッケージリソースバンドルから画像を探索する機能を持つUI-Imageメソッドへ引き渡しています
リソースをパッケージに追加するときはそれを使用するコードモジュールに対応するターゲットへ追加しなければなりませんリソースバンドルアクセッサーはリソースと同じモジュール内のコードのみから認識可能なのです他のモジュールへリソースを提供する必要がある場合は個々のリソースにベンドできるように特定の型付けを持つアクセッサーを追加するのが最も良い方法ですリソースバンドル全体を他のモジュールへベンドしようとするのは一般的にはお薦めできません何故ならばリソースの名前に関連して外部との依存関係が発生してしまうからです
Xcode 12 ではローカライズされたリソースをあなたのパッケージに追加することも可能ですそれでは前に見たサンプルパッケージ内のテキストのローカライズ方法について説明します
まず最初にデフォルトのLocalizationパラメータを私のパッケージマニフェストに追加します
これによって開発中に使用する言語を宣言するとともに実行時にはより良いマッチングが得られない場合のフォールバックローカリゼーションとしても使用されますリソースをパッケージを含むのであればどの場合においてもこれが必要です
私のデフォルトローカリゼーションの英語用にローカリゼーションディレクトリを作成します
それに“en.lproj”という名前と付けます
そのディレクトリ内に“Localizable.strings” というファイルを作成します
この文字列ファイルに１つの項目を追加しますこの項目は私がコード内で使用したローカライズ文字列キーを Englishの単語“roll”へマッピングします
次に Frenchに対して同じ作業を行います “fr.lproj”という名前のディレクトリを作りその中に“Localizable.strings” ファイルを作成します
このファイルに English文字列キーから
その単語のFrench訳へのマッピングを追加しますここで Imageビューに行ったのと同じ操作を Textビューに対して実施します具体的には私のコードを内包するモジュールへリソースバンドルを引き渡しますこの作業のために Foundationのローカリゼーションサポートを使用してユーザーの選択に対応した正しいローカライズコンテンツを見つけなければなりません
私のシステム言語はEnglishですからプレビューはまだ英語表示のままですしかし SwiftUIを使用すればプレビューをカスタマイズすることができますたとえば環境オーバーライドを追加すればフランス語にローカライズされたプレビューを見ることができます作成されたリソースバンドルからのローカライズされた文字列を使用しています
このデモで見てきたようにローカリゼーションディレクトリは“.lproj” というファイル名拡張子を持っていますローカリゼーションディレクトリはマニフェストに記述しなくてもパッケージターゲットへインクルードすることが可能ですなぜならば拡張子“.lproj”を見れば目的が分かるからです
通常ローカリゼーションディレクトリには文字列ファイルとテキスト翻訳のための文字列辞書ファイルが置かれていますパッケージ内の個々のリソースのカスタム化バージョンが置かれることもあります
アセットカタログのコンテンツをローカライズすることも可能です特定のローカリゼーションごとに異なるアートワークを提示するのが適切と思われる場合はそれも可能となります
この作業についてさらに詳しくは WWDC 19の“Creating Great Localized Experiences”セッションをご覧ください
ローカライズされたリソースをパッケージに追加するときはパッケージマニフェスト内でデフォルトローカリゼーションを宣言する必要があります
この作業では Appleプラットフォーム上でのすべてのローカリゼーションで使用したのと同じ種類の言語IDを使用するとともに希望するどの言語も利用できない場合に代替として使用する言語を指定します
このトピックスについて詳しい情報をご希望の場合は developer.apple.comにて“Language and Locale IDs”ドキュメントをご覧ください
Swiftパッケージにリソースを追加する方法と Xcodeが実行時にそれらのリソースにアクセスできるようにするリソースバンドルをビルドする方法を見てきましたまたパッケージ内のリソースをローカライズする方法についても調べてきました
Xcodeを使用すればSwiftパッケージを作成できるばかりでなく既存のパッケージの日々成長し続けるエコシステムを有効活用することができます Xcode 12を使用すると SwiftUIビューを内包するパッケージの開発が簡単になりますクライアントアプリケーションが存在しなくてもあなたのビューと相互作用させられるからですローカライズされたパッケージリソースへのサポートも強化されていますから世界中のユーザーニーズに対応できる機能を備えたパッケージの作成が容易になりましたご覧頂きまことに有難うございました残りのWWDC 20もお楽しみください

// swift-tools-version:5.3
import PackageDescription

let package = Package(name: "MyGame",
    products: [
        .library(name: "GameLogic",
            targets: ["GameLogic"])
    ],
    targets: [
        .target(name: "GameLogic",
            excludes: [
                "Internal Notes.txt",
                "Artwork Creation"],
            resources: [
                .process("Logo.png"),
                .copy("Game Data")]
        )
    ]
)

特定のトピックをお探しの場合は、上にトピックを入力すると、関連するトピックにすばやく移動できます。

クエリの送信中にエラーが発生しました。インターネット接続を確認して、もう一度お試しください。

リソース

関連ビデオ

WWDC22

WWDC20

WWDC19