iOSレガシーコード改善ガイド〜マンガボックス開発における事例〜

25. Copyright (C) DeNA Co.,Ltd. All Rights Reserved. Mix and Match ひとつのプロジェクトでObjective-CとSwiftを混合して使うための機能 14 h)ps://developer.apple.com/library/ios/documenta<on/Swi7/Conceptual/BuildingCocoaApps/MixandMatch.html

31. Copyright (C) DeNA Co.,Ltd. All Rights Reserved. Mix and Matchを使ったSwift移行パターン 15 ① 延命パターン ② ご新規パターン ③ 切り出しパターン ④ ブリッジパターン ⑤ extensionパターン ⑥ 暴露パターン ⑦ 乗っ取りパターン ⑧ 写経パターンパターン ≒ 武道における形パターン化する意義 → 迷わず判断できる

32. Copyright (C) DeNA Co.,Ltd. All Rights Reserved. Mix and Matchを使ったSwift移行パターン 15 ① 延命パターン ② ご新規パターン ③ 切り出しパターン ④ ブリッジパターン ⑤ extensionパターン ⑥ 暴露パターン ⑦ 乗っ取りパターン ⑧ 写経パターンパターン ≒ 武道における形パターン化する意義 → 迷わず判断できる

33. Copyright (C) DeNA Co.,Ltd. All Rights Reserved. Mix and Matchを使ったSwift移行パターン 15 ① 延命パターン ② ご新規パターン ③ 切り出しパターン ④ ブリッジパターン ⑤ extensionパターン ⑥ 暴露パターン ⑦ 乗っ取りパターン ⑧ 写経パターンパターン ≒ 武道における形パターン化する意義 → 迷わず判断できる ※各パターン名は私による勝手な命名

40. ①延命パターン Copyright (C) DeNA Co.,Ltd. All Rights Reserved. objcに Nullability, Lightweight Genericsを追加する 17 @interface UserHistory -(Episode*)lastEepisode; -(NSArray*)allEpisodes; @end NS_ASSUME_NONNULL_BEGIN @interface UserHistory -(nullable Episode*)lastEepisode; -(NSArray<Episode*>*)allEpisodes; NS_ASSUME_NONNULL_END @end

41. ①延命パターン Copyright (C) DeNA Co.,Ltd. All Rights Reserved. objcに Nullability, Lightweight Genericsを追加する 17 @interface UserHistory -(Episode*)lastEepisode; -(NSArray*)allEpisodes; @end NS_ASSUME_NONNULL_BEGIN @interface UserHistory -(nullable Episode*)lastEepisode; -(NSArray<Episode*>*)allEpisodes; NS_ASSUME_NONNULL_END @end class UserHistory { func lastEepisode()->Episode? func allEepisodes()->[Episode] }

42. ①延命パターン Copyright (C) DeNA Co.,Ltd. All Rights Reserved. objcに Nullability, Lightweight Genericsを追加する • 既存のobjc資産を安全に使える • ローコスト・ハイリターン • Swift対応への第一歩として最適 17 @interface UserHistory -(Episode*)lastEepisode; -(NSArray*)allEpisodes; @end NS_ASSUME_NONNULL_BEGIN @interface UserHistory -(nullable Episode*)lastEepisode; -(NSArray<Episode*>*)allEpisodes; NS_ASSUME_NONNULL_END @end class UserHistory { func lastEepisode()->Episode? func allEepisodes()->[Episode] }

54. ③切り出しパターン Copyright (C) DeNA Co.,Ltd. All Rights Reserved. ロジックをswiftに切り出す 21 if (num.integerValue == 0) { NSLog(@"num is zero"); } else { NSLog(@"num is non zero"); } - (NSNumber*)getNum { NSNumber* num = ...; return num; } .m

57. ③切り出しパターン Copyright (C) DeNA Co.,Ltd. All Rights Reserved. ロジックをswiftに切り出す 21 - (NSNumber*)getNum { NSNumber* num = ...; return num; } .m + final class NumLogger: NSObject { class func debug(num:NSNumber) { if num.integerValue == 0 { print("num is zero") } else { print("num is non zero") } } } .swi7 [NumLogger debug:num];

58. ③切り出しパターン Copyright (C) DeNA Co.,Ltd. All Rights Reserved. ロジックをswiftに切り出す 21 - (NSNumber*)getNum { NSNumber* num = ...; return num; } .m + final class NumLogger: NSObject { class func debug(num:NSNumber) { if num.integerValue == 0 { print("num is zero") } else { print("num is non zero") } } } .swi7 [NumLogger debug:num]; • 最小限の変更で既存objcメソッドのロジックを追加・修正できる • 使いどころ：ログ出力処理、バリデーション、Util的な処理 • ユニットテストも書きやすい

64. Copyright (C) DeNA Co.,Ltd. All Rights Reserved. ④ブリッジパターン 22 Nested Type Top-‐level func<on Typealias Tuple enumenumenum structstructstruct objc class objc class objc class Bridging NSObject Objec<ve-‐C swi7

73. ⑤extensionパターン Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 既存objcクラスをextensionする 25 @implement FooClass - (void)method1 {...} - (void)method2 {...} @end .m + extension FooClass { //メソッド追加 func method3() { … } } .swi7

74. ⑤extensionパターン Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 既存objcクラスをextensionする 25 @implement FooClass - (void)method1 {...} - (void)method2 {...} @end .m + extension FooClass { //メソッド追加 func method3() { … } } .swi7 • 一番自然で適用させやすいパターン

90. FooClass extension ⑤extensionパターン Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 27 ⑥暴露パターン FooClass property1 method1 Bridging-‐ Header.h Objec<ve-‐C swi7 property1 method1 公開 method2 method2 意図的なカプセル化の破壊！

91. FooClass extension ⑤extensionパターン Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 27 ⑥暴露パターン FooClass property1 method1 Bridging-‐ Header.h 参照・コール Objec<ve-‐C swi7 property1 method1 公開 method2 method2 意図的なカプセル化の破壊！

93. ⑥暴露パターン Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 28 @interface FooClass () @property NSString property1; @end @implement FooClass (void)method1 { ... } @end .m #import “xxx.h” #import “yyy.h” #import “zzz.h” ... @interface FooClass (PrivateForSwift) @property (readonly) NSString *property1; (void)method1; @end Xxxx-‐Bridging-‐Header.h + @interface FooClass @end .h

94. ⑥暴露パターン Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 28 @interface FooClass () @property NSString property1; @end @implement FooClass (void)method1 { ... } @end .m extension FooClass { func methods() { property1 = “foo"; method1() } } .swi7 + #import “xxx.h” #import “yyy.h” #import “zzz.h” ... @interface FooClass (PrivateForSwift) @property (readonly) NSString *property1; (void)method1; @end Xxxx-‐Bridging-‐Header.h + @interface FooClass @end .h

95. ⑥暴露パターン Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 28 @interface FooClass () @property NSString property1; @end @implement FooClass (void)method1 { ... } @end .m extension FooClass { func methods() { property1 = “foo"; method1() } } .swi7 + #import “xxx.h” #import “yyy.h” #import “zzz.h” ... @interface FooClass (PrivateForSwift) @property (readonly) NSString *property1; (void)method1; @end Xxxx-‐Bridging-‐Header.h + @interface FooClass @end .h ↑objcは一切変更していない

102. Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 意図的にカプセル化を破壊 ⁃ extensionから本体クラスのプライベート属性へのアクセスが可能に ⁃ 変更箇所はブリッジングヘッダのみ、既存の.h/.mは変更なし妥協が必要な部分 ⁃ 異論の出るところ ⁃ 一時的な対応、という割り切り 29 プライベート属性を部分的に公開する ⑥暴露パターン

103. Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 意図的にカプセル化を破壊 ⁃ extensionから本体クラスのプライベート属性へのアクセスが可能に ⁃ 変更箇所はブリッジングヘッダのみ、既存の.h/.mは変更なし妥協が必要な部分 ⁃ 異論の出るところ ⁃ 一時的な対応、という割り切り ⁃ ここを割り切ればSwift化は一気に進む 29 プライベート属性を部分的に公開する ⑥暴露パターン

118. FooClass extends Bridging-‐ Header.h +⑥暴露パターン Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 31 ⑦乗っ取りパターン FooClass method1 property1 31 method2 property2 Objec<ve-‐C swi7 property1 method1 公開 FooClassBaserename

119. FooClass extends Bridging-‐ Header.h +⑥暴露パターン Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 31 ⑦乗っ取りパターン FooClass method1 property1 31 method2 property2 Objec<ve-‐C swi7 property1 method1 公開参照・コール FooClassBaserename

128. FooClass method1 property1 Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 33 ⑦別解：乗っ取りパターン(カテゴリ拡張) FooClass 33 property2 (Category Extension) Objec<ve-‐C swi7 property1 extensionではなく同名クラスをSwi7で元のFooClassを objcカテゴリ拡張に降格

129. FooClass method1 property1 Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 33 ⑦別解：乗っ取りパターン(カテゴリ拡張) FooClass 33 property2 (Category Extension) Objec<ve-‐C swi7 property1 extensionではなく同名クラスをSwi7で元のFooClassを objcカテゴリ拡張に降格 ☓乗っ取り元objcにプライベート属性がある場合、制限多めなのでNG

130. Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 参考：アンチパターン 34 //ストアドプロパティの追加 var name:String { get { return objc_getAssociatedObject(self, &key) as! String } set { objc_setAssociatedObject(self, &key, newValue, .OBJC_ASSOCIATION_RETAIN_NONATOMIC)} } //プライベートメソッドの実行 if respondsToSelector("_reload") { performSelector("_reload") } //プライベートプロパティの参照 if let titleLabel = valueForKey("TitleLabel") as? UILabel { ... } • カプセル化を破壊せずにプライベート属性を参照・追加可能 • メンテナンス性△ • マンガボックスでは極力使用しないようにしている associatedObject キー値コーディング objcセレクター

137. ⑧写経パターン Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 既存のobjcコードをswiftで書き直す • 最後の手段 • テストの有無でリスク変動 • 元コードがテストで保護されている→◎ • 対象objcコードをまずテストで保護してからSwiftで書き直す→⃝ • 完全書き直し→△ • ある意味シンプルだが、フルQAは必須、コスト大 36

141. Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 参考：写経のお供に • objc→swift コード変換ツール • https://github.com/yahoojapan/objc2swift • https://objectivec2swift.com/?ref=producthunt#/converter/code • http://iswift.org • https://myappconverter.com • https://itunes.apple.com/us/app/o2swift-objective-c-to-swift/id1060352413?ls=1&mt=12 • いずれも機械的な変換なので手直し＆QAは必須 40

145. Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 何かに似ている 43 ① 延命パターン ② ご新規パターン ③ 切り出しパターン ④ ブリッジパターン ⑤ extensionパターン ⑥ 暴露パターン ⑦ 乗っ取りパターン ⑧ 写経パターン h)p://shop.ohmsha.co.jp/shopdetail/000000003881/ リファクタリング

146. Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 何かに似ている 43 ① 延命パターン ② ご新規パターン ③ 切り出しパターン ④ ブリッジパターン ⑤ extensionパターン ⑥ 暴露パターン ⑦ 乗っ取りパターン ⑧ 写経パターン h)p://shop.ohmsha.co.jp/shopdetail/000000003881/ リファクタリング Extract Method Extract Class

148. Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 何かに似ている 44 ① 延命パターン ② ご新規パターン ③ 切り出しパターン ④ ブリッジパターン ⑤ extensionパターン ⑥ 暴露パターン ⑦ 乗っ取りパターン ⑧ 写経パターン h)p://www.sbcr.jp/products/4797311126.html gof デザインパターン

149. Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 何かに似ている 44 ① 延命パターン ② ご新規パターン ③ 切り出しパターン ④ ブリッジパターン ⑤ extensionパターン ⑥ 暴露パターン ⑦ 乗っ取りパターン ⑧ 写経パターン h)p://www.sbcr.jp/products/4797311126.html gof デザインパターン Bridgeパターン

151. Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 何かに似ている 45 ① 延命パターン ② ご新規パターン ③ 切り出しパターン ④ ブリッジパターン ⑤ extensionパターン ⑥ 暴露パターン ⑦ 乗っ取りパターン ⑧ 写経パターン h)p://www.shoeisha.co.jp/book/detail/9784798116839 レガシーコード改善ガイド

152. Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 何かに似ている 45 ① 延命パターン ② ご新規パターン ③ 切り出しパターン ④ ブリッジパターン ⑤ extensionパターン ⑥ 暴露パターン ⑦ 乗っ取りパターン ⑧ 写経パターン h)p://www.shoeisha.co.jp/book/detail/9784798116839 レガシーコード改善ガイド • スプラウトメソッド • スプラウトクラス • 静的メソッドの公開テストコードを書くためのリファクタリング手法

153. Copyright (C) DeNA Co.,Ltd. All Rights Reserved. 46 ① 延命パターン ② ご新規パターン ③ 切り出しパターン ④ ブリッジパターン ⑤ extensionパターン ⑥ 暴露パターン ⑦ 乗っ取りパターン ⑧ 写経パターン Mix-and-Matchを使ったSwift移行パターン既存のソフトウェア開発技法の活用によりスムーズ・安全にSwi7移行可能

iOSレガシーコード改善ガイド〜マンガボックス開発における事例〜

Kentaro Matsumae

iOSレガシーコード改善ガイド〜マンガボックス開発における事例〜

A particular slide catching your eye?