Swift Package中心のプロジェクト構成とその実践 - iOSDC JAPAN 2021 https://www.youtube.com/watch?v=e_T1-XrYf4A
Swift Packageத৺ͷϓϩδΣΫτߏͱͦͷ࣮ફiOSDC JAPAN 2021Daiki Matsudate@d_date
View Slide
ٻΉ! Feedback#iosdc #c
🍣#iosdc #c
લఏͷ֬ೝSwift Package ManagerXcode Package.swiftMulti Module Multi ProjectSwiftUI UIKitBundleTest Target
લఏͷ֬ೝSwift Package ManagerXcode Package.swiftMulti Module Multi ProjectSwiftUI UIKitBundleTest TargetFundamentalAdvanced
લఏͱͳΔࣝͷ֬ೝ
લఏͱͳΔࣝͷ֬ೝ• Buildʹ͍ͭͯ• Target• Configuration• Scheme• Module / Framework• Import / Link• Static / Dynamic• XCFramework
BuildSource Code Object Code Executable BinaryCompilerCompile LinkLinker.oBuildxcodebuild
BuildObject CodeDerivedData/*/Build/Intermediates.noindex/*.build//*.build/Object-normal//
Build Target• Buildʹ༻͍ΔϑΝΠϧʢInput) ੜʢOutput)Λఆٛͨ͠ͷ• Input: Source code, Framework, Resource• Output: App, App Extension, Framework
Build Configuration• Build SettingsʢϏϧυʹؔ͢Δมͷू߹ʣͷϓϦηοτ
Build SchemeTarget ConfigurationX
Build Scheme• Build5छྨ• Analyze• Test• Run• Profile• ArchiveDebugRelease
BuildSchemeTargetConfigurationDebugReleaseXBuildAnalyzeRunTestProfileArchive
Module? Framework?
Moduleimport͕Ͱ͖Δ୯Ґ
Module
Module• Derived Dataʹ.swiftmoduleͱ͍͏Bundle͕ଘࡏ͢Δ͜ͱ ※Bundle … σΟϨΫτϦ͚ͩͲϑΝΠϧͷΑ͏ʹৼΔ͏ܗࣜ• ιʔείʔυ͕ίϯύΠϧ·Ͱ͞ΕΔͱར༻ՄೳʹͳΔ
Module• Import͕Ͱ͖Δ୯Ґ (࣮ମ.swiftmodule)• moduleʹpublic APIؚ͕·ΕΔ• Module Stability (swift 5.1~)• ҟͳΔSwiftͰੜ͞ΕͨϞδϡʔϧΛimportͰ͖Δʢ.swiftinterface)
FrameworkBuild TargetͱϦϯΫ͢Δ࣮ߦՄೳόΠφϦ
Framework• Build TargetͱLink͢Δ࣮ߦՄೳόΠφϦ• FrameworkBuild Targetʹ͢Δ͜ͱ͕Ͱ͖ΔʢModuleͰ͖ͳ͍ʣ →Build SchemeΛઃఆͰ͖Δ
FrameworkͷLink• ίϯύΠϧ͞ΕͨObject CodeΛΈ߹Θ͍ͤͯ͘࡞ۀ• Έ߹ΘͤΔࡍʹɺsymbolͷॏෳΛ֬ೝ͢Δ• Linkͷํʹ2छྨ• Static Link -> Static Framework• Dynamic Link -> Dynamic Framework
Static LinkϏϧυ࣌ʹObject codeΛͻͱͭʹ·ͱΊ͍ͯ͘LinkLinkLinkLink.o .o .o
Load on LaunchDynamic LinkΞϓϦͷόΠφϦͱผʹੜ͠ɺΞϓϦ࣮ߦ࣌ʹಡΈࠐΉLinkLinkLink.o .o .o
Static Link vs Dynamic LinkΞϓϦͱͷLink ىಈ࣌ؒStatic Framework Ϗϧυͷͱ͖ ͍Dynamic Framework ΞϓϦىಈ࣌ ͍
Link in ModuleLinkModule୯ҐͰߦΘΕΔLink.o .o .o.o .o.o.o .o.o
XCFramework• ՄೳͳBundleܗࣜ• ෳͷFramework (ϏϧυࡁΈόΠφϦʣؚ͕·ΕΔ• Platform (iOS, macOS, tvOS and watchOS)• Simulator / Device• Static / Dynamic• Build Architecture (x86_64, arm64, …)
͜ͷτʔΫͰ͞ͳ͍͜ͱ• Objective-CͷFramework• Module map• Bridging-Header• Library (Frameworkͱݫີʹ۠ผ͠ͳ͍ʣ• .a• .dylib
https://www.youtube.com/watch?v=FZoYyAEPJ8wiOSDC Japan 2019: ϥΠϒϥϦͷΠϯϙʔτͱϦϯΫͷΈΛ୳Δ / Kishikawa KatsumiSee also
Homeworkhttps://twitter.com/kateinoigakukun/status/1405130382656163840?s=20A, B, Cをアプリターゲット、静的ライブラリ、動的ライブラリのいずれかとする。A, B, Cの依存関係が、 A -> B, A -> C, C -> Bとなるとき、Aのリンク時にSymbolが重複するかを考える。A, B, Cが以下の場合、それぞれSymbolが重複するかを答えなさい。( 1 ) A: アプリターゲット, B: 静的ライブラリ, C: 動的ライブラリ( 2 ) A: アプリターゲット, B: 静的ライブラリ, C: 静的ライブラリ( 3 ) A: アプリターゲット, B: 動的ライブラリ, C: 静的ライブラリhttps://twitter.com/kateinoigakukun/status/1405844501680197636?s=20ग़యɿղɿABC
͜Ε·Ͱ֬ೝͨ͜͠ͱ• Build• CompileͱLink• Build Target, Configuration, Schemeͷؔ• Moduleͱimport• FrameworkͱLink• Static / Dynamic• XCFramework
Swift Package Manager
Swift Package Manager• Pros• swiftʹಉࠝ͞Ε͍ͯΔʢಛʹCIͰؔΘͬͯ͘Δʣ• Xcodeʹ౷߹͞Ε͍ͯΔ• macOS / Linux྆ରԠ• ࣗಈͰґଘؔͷղܾɺߋ৽• Cons• Compatible with Swift 5 and Xcode 11
Swift Package Manager in Xcode
8.1.1PatchMinorSemantic VersioningMajorBug FixCompatible AdditionsBreaking Changeshttps://semver.org
8.1.1 9.0.0<Up to Next Major8.1.1 8.2.0<Up to Next Minor
Package.swiftͰ࢝ΊΔϓϩδΣΫτϑΝΠϧμΠΤοτ
Package.swift• Products• Library: Build TargetͱLink͢Δ࣮ߦՄೳόΠφϦ (=Framework)• Dependencies• Targets• Target = Module• Sources/, Tests/ͷαϒσΟϨΫτϦ͕Ϟδϡʔϧ
AppFeatureFeatureAFirebaseFeatureBLinkAppImportLinkLinkImportAppFeature
Package.swift• 3rd partyͷϥΠϒϥϦΛཧ͢Δ͚ͩͰͳ͍• ModuleFrameworkΛࣗࡏʹߏͰ͖Δ → Multi Modules• ϓϩδΣΫτϑΝΠϧ͕ܰྔʹ → Multi Projects
XCFramework in Package.swift
XCFramework in Package.swift• ιʔείʔυͰͳ͘όΠφϦܗࣜͰ͍ͯ͠Δ• e.g.) ࠂSDK, AnalyticsͳͲ• targetʹ.binaryTargetΛ͏• xcframeworkͦ͘͠ΕΛؚΉzipϑΝΠϧ• ϩʔΧϧͰϦϞʔτͰՄʢϦϞʔτchecksum͕ඞཁʣ
Swift PMʹରԠ͍ͯ͠ͳ͍߹
Swift PMʹରԠ͍ͯ͠ͳ͍߹• Package.swift͕ͳ͍ → ιʔείʔυ͕ެ։͞Ε͍ͯΕϏϧυ͕ՄೳͳͷͰɺPull RequestΛग़ͯ͠Package.swiftΛՃɻ͘͠Forkͯ͠Ճ• ιʔείʔυඇެ։ɺXCFrameworkͳ͍ʢFramework͔͠ͳ͍ʣ → CocoaPodsΛซ༻͢Δͷ͕खͬऔΓૣ͍ → Apple M1 (arm64) ͷ߹ Intel Mac (x86_64) ͰϏϧυ͞ΕͨFrameworkѻ͑ͳ͍ͷͰ͢Δʢޙʹհʣ
Resources in Swift PM
Resources in Swift PM• Swift PMͰAssetsLocalizable.stringऔΓѻ͑Δ• Localize͢Δ߹Package.swiftʹdefaultLocalizationΛ͚ͭΔ
Resources in Swift PM• Bundle.moduleΛͬͯΞΫηε͢Δ
resource_bundle_accessor.swift
Localization in Swift PMLocalization for Xcode Preview
Localization in Swift PMLocalization for Build Target
Resources in Swift PMBest Practice✅ϦιʔεϞδϡʔϧຖʹཧ͢Δ• Resource Bundle Accessor (Bundle.module) ಉ͡ϞδϡʔϧͷϦιʔεʹରͯ͠༗ޮ⚠ ͠ଞͷϞδϡʔϧʹఏڙ͢Δඞཁ͕͋Δ߹ݸʑͷϦιʔεʹରͯ͠TypedPublic AccessorΛఏڙ͢Δ• Ϧιʔεͷ໊લ͕֎෦ͱͷґଘؔͱͳͬͯ͠·͏ͨΊਪ͞Εͳ͍🚫 Resource BundleͷΞΫηεΛAPIʹ͠ͳ͍https://developer.apple.com/videos/play/wwdc2020/10169
Resources in Swift PMBest Practicehttps://developer.apple.com/videos/play/wwdc2020/10169
Resources in Swift PMBundleͲ͜ʁ
Swift PM with UIKit
Swift PM with UIKit• Xib, Storyboard͕Ϧιʔεѻ͍ʹͳΔ• Xib, StoryboardͰModuleΛࢦఆ͢Δ• ࢦఆ͠ͳ͍ͱΫϥογϡ͢Δ• xibStoryboard͔ΒViewΛੜ͢ΔςετΛॻ͘• IBLinterΛ͏
Swift PM with UIKitUse IBLinterhttps://github.com/IBDecodable/IBLinter
Multi module in Swift PM
Multi module in Swift PMPros• ίϯύΠϧ࣌ؒͷॖ• Xcode Previewͷ҆ఆԽ• App ClipͷΑ͏ͳ༰ྔ੍ݶ• Mini-Application
Mini-Application• ಛఆͷػೳModuleΛબͼɺFrameworkΛߏ• Build TargetʹFrameworkΛՃ͢Δ• ೝূը໘OnboardͳͲɺද͕ࣔ݅͋Δͷʹಛʹ༗ޮ
Multi module in Swift PMBest Practice• Common / Misc moduleΛ࡞Βͳ͍• ࡞Γͨ͘ͳͬͨΒͰ͖Δ͚ͩ࠷খ୯Ґʹׂ͢Δ• ResourceͷॏෳΛ͋·ΓڪΕͳ͍• େ͖ͳը૾Λ৭ΜͳϞδϡʔϧͰ͍͍ͨ߹ͦΕࣗମΛϞδϡʔϧʹ͢Δ
Multi projects in Swift PM
Multi projects in Swift PM• ϓϩδΣΫτͷׂ͕ബ͘ͳͬͨͷͰEnvironmentͷઃఆʹશৼΓͰ͖Δ• Staging.xcodeproj• Production.xcodeproj• (Staging-M1.xcodeproj)
Multi projects in Swift PMBuild Configuration vs Multi Project• Build ConfigurationͰཧͰ͖ΔͷBuild Settingsͷม Build SettingsͷUser-DefinedʹΧελϜͳมΛೖΕΔ• Info.plist͔ΒऔΓग़ͤΔΑ͏ʹ͢Δ
Multi projects in Swift PMBuild Configuration vs Multi Project• Xcode ProjectͰཧ͢ΔϑΝΠϧ͔͔ͨͩछྨ• ࢀর͢ΔϑΝΠϧಉ͡ͰҧͬͯΑ͍ • Project͕ҧ͏ͱϑΝΠϧ໊ॏෳͯ͠େৎ• e.g.) GoogleService-info.plist• Build Configurationซ༻Ͱ͖Δ
Multi ProjectsCase Study• ARM64༻Xcode ProjectΛผͰ࡞Δ• CocoaPodsΛ͜ͷϓϩδΣΫτ͚ͩೖΕͳ͍Α͏ʹ͢Δ• CocoaPodsʹೖ͍ͬͯΔϥΠϒϥϦimportͰ͖ͳ͘ͳΔͷͰ #if canImportͰճආ͢Δ
ࠓͷ·ͱΊ• ݴ༿ͷఆٛΛઆ໌Ͱ͖ΔΑ͏ʹ• PackageͰιʔείʔυΛཧ͠ɺϓϩδΣΫτϑΝΠϧΛܰ͘͢Δ• ϚϧνϞδϡʔϧͳߏͰϏϧυ࣌ؒͷॖMini Application• ෳͷϓϩδΣΫτϑΝΠϧͷӡ༻Ͱڥઃఆ͕؆୯ʹ
Case Study
GANMA! / FLINTERS, Inc.• UIKit based• CocoaPods / Carthageͷซ༻ → CocoaPods / SwiftPMͷซ༻• Ұ෦ͰXCFrameworkʹରԠ͍ͯ͠ͳ͍Pre built binary• Embedded FrameworkΛΊͨͷͰϓϩδΣΫτϑΝΠϧ͕খ͘͞ͳͬͨ• ΞϓϦαΠζ: 23.5MB → 20.6MBCase Study
Timee / Timee, inc.• UIKit based• CocoaPods / Carthageͷซ༻ → CocoaPods / SwiftPMͷซ༻• Ұ෦ͰXCFrameworkʹରԠ͍ͯ͠ͳ͍Pre built binary• ϓϩδΣΫτϑΝΠϧ͕খ͘͞ͳΓɺXcodeGenΛണ͕ͨ͠• ηοτΞοϓ͕༰қʹ• ΞϓϦαΠζ: 30.3 MB → 26.9MBCase Study
NOT A HOTEL, Inc.• SwiftUI• Multi modules (16 → 32 and more !)• Preview Apps• Multi projects• Staging• Production• (Staging-M1 Archived)Case Study
Case StudyAnd you !!
Resources• https://github.com/pointfreeco/isowords• https://www.pointfree.co/episodes/ep142-a-tour-of-isowords-part-1 ʢpart 4·Ͱ͋Δʣ• https://date.notion.site/isowords-8f8982eb3a9a4665b2fa688b06791b70• https://date.notion.site/Swift-PM-Build-Configuration-4f14ceac795a4338a5a44748adfeaa40
ٻΉ! Feedback
d_date
tagomoris
sr2mg4
kumamotone
m_coder
yamotuki
eihigh
murabayashi
yatasunshine
ari_mharada
ohmae
philipschwarz
umsys
philnash
mclloyd
destraynor
kneath
eileencodes
lara
philhawksworth
sachag
colly
chrislema
shpigford
searls