サービス

技能：エンジニア

技能：デザイナー

技能：ビジネス職

技能：バックオフィス

ジャンル

<h2 style="line-height: 1.38; margin-top: 32px; margin-bottom: 8px;">はじめに</h2>

<p>オンラインサロン開発部 開発グループ iOSエンジニアの鳥嶋(<a href="https://twitter.com/k_torishima">@k_torishima</a>)です。</p>

<p>現在、DMMオンラインサロンiOSアプリではReactNativeからSwift製アプリに完全移行を進めています。</p>

<p>その中の取り組みの一つとして、アプリのプロジェクト管理をSwift Package Managerを使って管理する方法を採用しました。今回は採用した理由や現状の構成、結果などを紹介させていただけたらと思います。</p>

<h2>背景</h2>

<p>ReactNative製アプリからSwift製アプリに完全移行を進めていく中で、現状の課題や今後を考えた結果として、新しくアプリを作成することとなり、今まで課題となっていたものなどを一新する判断をしました。</p>

<p>その中の一つの取り組みとして、今まで開発していたアプリではXcodeGenを使ったプロジェクト管理方法をとっていましたが、新たにアプリを作成するということもありSwift Package Manager（以下SwiftPM）を使ったプロジェクト管理方法を採用しました。</p>

<h3>採用した理由</h3>

<p>採用した理由としては、XcodeGenを使わずSwiftPMを使った方法でも本質的な課題を解決できることができたためです。</p>

<p>本質的な課題としては以下のような課題が挙げられています。</p>

<ul>
	<li>プロジェクトファイル(xcodeproj)がコンフリクトしてしまう</li>
	<li>プロジェクトツリーが散らばってしまう</li>
	<li>プロジェクトの設定がしづらい</li>
</ul>

<p>また、XcodeGenを使った管理方法でもいくつか課題がありました。</p>

<ul>
	<li aria-level="1">プロジェクトファイルの中身を知っていないとyamlをメンテナンスすることが難しい</li>
	<li aria-level="1">XcodeGenが導入されているプロジェクトでの開発経験があるエンジニアじゃないと学習コストが高い</li>
	<li aria-level="1">XcodeGenはOSSということもあり、メンテナンスの活動が保証されているわけではないため機能追加やバグ修正が遅れる可能性があったりメンテナンスが止まってしまうというリスクがある</li>
</ul>

<p>このような課題はSwiftPMを使ったプロジェクト管理方法であれば、おおかた解決するのではないかと思っています。</p>

<ul>
	<li aria-level="1">昨今のiOSエンジニアであればSwiftPMを導入したプロジェクトでの開発経験はありそう</li>
	<li aria-level="1">Swift言語を使ってPackage.swiftを書くので、そもそもハードルが低い</li>
	<li aria-level="1">Appleで公式にサポートしているため、メンテナンスの保証もされている。定期的なアップデートも行われているためXcodeGenに比べて使用するリスクが低い</li>
</ul>

<p>こういった観点からSwiftPMを使ったプロジェクト構成の管理を採用することにしました。</p>

<h2>プロジェクトの全体構成</h2>

<p>ここでは現状のプロジェクト全体構成をサンプルアプリを使って紹介します。</p>

<p>ワークスペースの中に環境ごとのProjectを作っています。.plistやResourceなどはProjectごとに存在しています。Google Service info.pilstなどもこちらに入っています本体アプリを参照するApp.swiftを実装しています。</p>

<p style="text-align:center"><img alt="" height="461" src="https://lh7-us.googleusercontent.com/29gEjYCV15Lrgm07G2Fq2jqR5CBlYmvE-_Yki192gZ0DH3TYhSGC1Hiqm5FxF9pEfQQdapaxVEYwVFRjt2FX5x5P4qyp75lOYiRPFofqrGw5wKjRyV1aCs5LeaxTopwiOTCgHWoiWCyDyFarVWLSou3YJ-_KhkMDS8kYtqZwmIB1Xm8HLyjacUtX0H_fqQ" width="200" /></p>

<p style="list-style-type:disc">アプリ本体を一つのライブラリとし、Package.swiftに依存関係を記載します。</p>

<p>各レイヤーごとの依存関係を記述します。</p>

<p style="text-align:center"><img alt="" height="826" src="https://lh7-us.googleusercontent.com/Hl4P4WVDdT0oLH_CfJDbO7IAJzuoKhSmUi6tg-J774Jxd4ZayYJF3KCPKQh-mooBPYustMft5zQE2FKpivQRyks20NtIEci5kqojhMPm0K_Pl2zLVBSWP_y-1r89rZ3aHFoBF_RP9mAFhYR9thWmDOENpLJpX_04grkTE5mqb9aG5PIOf4UIh6v6GZPORw" width="600" /></p>

<p style="list-style-type:disc">各Projectはライブラリ化されたアプリ本体を参照します。</p>

<p style="text-align:center"><img alt="" height="201" src="https://lh7-us.googleusercontent.com/2ZYF5_aZhPlpnm8vPurFSMSFF65qbMKZtx4nV-SmPsP0O_xj2wnBcSFgeveTkSVnXs0nlmzW0SLfUzOWsyEuTNCdHnPibd_jXh3DlB2RASsU_0ItoKAlaILhCFWpzyS0vR4c1GdOKLi8Zg9mWh1vgv1W6dnDnd8zhnGY5FNv4IZL8s3NSJKegJrUqqzaaQ" width="602" /></p>

<p style="list-style-type:disc">具体的な機能の実装などはライブラリ化されたアプリの中で実装していきます。</p>

<p style="text-align:center"><img alt="" height="233" src="https://lh7-us.googleusercontent.com/ro-wKiGPwTgkvUdxY1SPOP0lrOaWHaLXJ3p2DDruqJAUtCzYeF_8NMXBUPPWYNixY_Mp82v8wMO3u8NNCiEj3cSwL0ebj5JUKq_0MZzK1X7DJacBW0qhjoBB0IfpcvQYKq5TWvg0m1E_k68sq33mQwxLTlbYFddOcmDYM8YQn3KLDZ8_Qsg34kUiuua-qQ" width="276" /></p>

<p style="list-style-type:disc">現状このような構成で開発を行っています。</p>

<h2 style="list-style-type: disc;">導入後の効果と考慮事項</h2>

<p style="list-style-type: disc;">SwiftPMを使ったプロジェクト管理にしたことによっての効果と考慮事項紹介します。</p>

<h3 style="list-style-type: disc;"><strong>効果</strong></h3>

<p style="list-style-type: disc;">Package.swiftファイルに記載することによって依存関係がよりわかりやすくなりました。日々Swift言語を使って開発しているので管理ファイルもSwift言語で記述できるのは非常に良いですし、何より読みやすいと感じております。</p>

<p>本アプリで使用するライブラリも全てSwiftPMで配布されているものを使用しています。よってPackage.swiftに記載することでライブラリ管理も統一することができ、非常にスマートです。</p>

<p>プロジェクトファイルごとに必要な設定や必要なファイルをセットしておくだけで良くなるので、本体のライブラリ化されたアプリを参照するだけでアプリを実行できます。各プロジェクトごとに適した設定にしておくことで、とてもシンプルに扱えます。用意した環境ごとのプロジェクトにinfo.plistの設定を行えば良いです。</p>

<p>環境ごとに管理するのが地味に面倒だったBuild Settingや、Build Phasesなども、その環境ごとに適したように設定しておけば良いので、一つのプロジェクトに複数の環境設定が混在することから解放されます。</p>

<p>アプリ側で使うものはアプリに内包するだけで良いのでプロジェクトに依存しません。なので、別のプロジェクトを何個も作ることができます。</p>

<h3 style="list-style-type: disc;"><strong>考慮事項</strong></h3>

<p style="list-style-type: disc;">SwiftPMを使った方法にしたことで考慮すべき点です。</p>

<p style="line-height:1.38">ビルド設定などを確認する際、Xcode上で確認するには問題ないですが、Codeで確認する場合はproject.pbxprojで確認しないといけないです</p>

<p>一部のライブラリをFrameworksに追加しないとSwiftUIPreviewが上手く表示されないという現象が発生しました。PreviewのBild時に出てくるErrorの内容を確認し、該当するライブラリをFrameworksに追加することでPreviewが正常に動くことを確認しました。</p>

<p style="text-align:center"><img alt="" height="248" src="https://lh7-us.googleusercontent.com/QpZQ0RsbZ9-efZmCHYUmWE-u-wwJrH8yM1dw4-7ERr-IlPB27cwb8YWBnT3BvuDeKNuzpmMfdGibNqOVqagSX8mJ2EHAiiUPkL881ZCPz8HqzIsciO4REojYjfDuyiDyCgQa8Ue71Gdd-0fH54OK4tR3US5uA3n7h8KQCWgAjdYzqrRD5B90He18aEhmAw" width="800" /></p>

<h2 style="list-style-type: disc;">まとめ</h2>

<p style="list-style-type: disc;">今回はDMMオンラインサロンのプロジェクト構成の管理方法に関して紹介させていただきました。Swift Package Managerを使用することで管理方法がシンプルになることで、よりプロダクト開発に時間をかけれるようになっていけると思っています。皆様もぜひ参考にしてみてください。</p>

<h3></h3>

Swift Package Managerを使ったプロジェクト管理方法を紹介します

シェア

関連する求人

関連する記事

関連するサービス