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

Copyright (C) DeNA Co.,Ltd. All Rights Reserved.
iOS レガシーコード改善ガイド
1
Jan 29, 2016
松前健太郎
IPプラットフォーム事業部第１部 
DeNA Co., Ltd.
∼マンガボックス開発における事例∼

自己紹介
松前健太郎 (id:kenmaz)
2003.4 日立ソリューションズ (旧・日立ソフトウェアエンジニアリング）
SIer, Java, Ruby, 他
2009.6 ドワンゴ
ニコニコ、他
2013.4 DeNA
マンガボックスリードエンジニア
2

3

4
プロ作家の

描きおろし作品が

毎日更新、無料で読める

マンガ雑誌アプリ

5

6
電子書籍ストアマンガ投稿

本題
7

レガシーコードについて
8

マンガボックスにおけるレガシーコード
•開発スタートから約３年
•iOS6時代のコード多数
•機能追加に伴うコードの複雑化
•レガシーコード化の兆候
9

マンガボックスにおけるレガシーコード
•開発スタートから約３年
•iOS6時代のコード多数
•機能追加に伴うコードの複雑化
•レガシーコード化の兆候
9
iOSレガシーコード改善ガイド
レガシーコード化させないための取り組み

①リリースサイクルの見直し
②Swiftへの移行
③AutoLayoutへの対応
④設計
⑤運用・ログ
10

①リリースサイクルの見直し
②Swiftへの移行
③AutoLayoutへの対応
④設計
⑤運用・ログ
10
後日webで公開できれば・・・

Swiftへの移行
11
iOSレガシーコード改善ガイド
その②

12
h)ps://developer.apple.com/swi7/
Swift移行の意義

12
• Type
Safe

• Op<onal

• Immutable

• Generics

12
• Type
Safe

• Op<onal

• Immutable

• Generics
言語の安全性＝アプリの品質に直結

iOSエンジニア
1.5人
どうする
13

Swift移行への基本戦略
14

1. 既存コードの挙動を破壊しないこと
14

2. 既存objcコードの修正は極力Swiftで行うこと
14

3. 段階的に徐々に移行すすめること
14

4. Swiftらしいコードを書いて確実に品質を高めること
14

5. 局所的な妥協は許容
14

5. 局所的な妥協は許容
14
→Mix-and-Match

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

Mix and Matchを使ったSwift移行パターン
16

16
① 延命パターン
② ご新規パターン
③ 切り出しパターン
④ ブリッジパターン
⑤ extensionパターン
⑥ 暴露パターン
⑦ 乗っ取りパターン
⑧ 写経パターン

16
パターン
≒
武道における形

16
パターン
≒
パターン化する意義

16
パターン
≒
→
迷わず判断できる

16
パターン
≒
→
迷わず判断できる
※各パターン名は私による勝手な命名

①延命パターン
17
Objec<ve-‐C
swi7

17
objc

class
objc

class
objc

class
Objec<ve-‐C
swi7

17
objc

class
objc

class
objc

class
Nullability,
Genericsに関するアノテーションを付加
Objec<ve-‐C
swi7

17
objc

class
objc

class
objc

class
Nullability,
型安全・nil
安全
な世界
Objec<ve-‐C
swi7

17
objc

class
objc

class
objc

class
Nullability,
型安全・nil
安全
な世界
swi7
安全にアクセス
Objec<ve-‐C
swi7

objcに Nullability, Lightweight Genericsを追加する
18
@interface UserHistory
-(Episode*)lastEepisode;
-(NSArray*)allEpisodes;
@end

18
@end
NS_ASSUME_NONNULL_BEGIN
-(nullable Episode*)lastEepisode;
-(NSArray<Episode*>*)allEpisodes;
NS_ASSUME_NONNULL_END
@end

18
@end
@end
class UserHistory {
func lastEepisode()->Episode?
func allEepisodes()->[Episode]
}

• 既存のobjc資産を安全に使える
• ローコスト・ハイリターン
• Swift対応への第一歩として最適
18
@end
@end
class UserHistory {
func lastEepisode()->Episode?
func allEepisodes()->[Episode]
}

②ご新規パターン
19
Objec<ve-‐C
swi7

19
objc

class
objc

class
objc

class
Objec<ve-‐C
swi7

19
objc

class
objc

class
objc

class
ViewController

.swi7
View
Model

Objec<ve-‐C
swi7

19
objc

class
objc

class
objc

class
instan<ate
ViewController

.swi7
View
Model

Objec<ve-‐C
swi7

新規ViewControllerは基本フルSwiftで書く
「新規開発分はSwiftで書きます」パターン
既存のobjcコードの依存が少なくやりやすい
新しい画面や機能を追加するケースにおすすめ
例）
• ユーザ登録・ログイン
• マイメニュー
• コイン購入処理
• 動画広告
20

21
③切り出しパターン
Objec<ve-‐C
swi7

21
objc
class

method

Objec<ve-‐C
swi7

21
Logic

.swi7
objc
class

method

Objec<ve-‐C
swi7

21
Logic

.swi7
objc
class

method
コール
Objec<ve-‐C
swi7

ロジックをswiftに切り出す
22
- (NSNumber*)getNum {
NSNumber* num = ...;
return num;
}
.m

22
if (num.integerValue == 0) {
NSLog(@"num is zero");
} else {
NSLog(@"num is non zero");
}
return num;
}
.m

22
return num;
}
.m
[NumLogger debug:num];

22
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

22
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
• 最小限の変更で既存objcメソッドのロジックを追加・修正できる
• 使いどころ：ログ出力処理、バリデーション、Util的な処理
• ユニットテストも書きやすい

④ブリッジパターン
23
Objec<ve-‐C
swi7

23
objc

class
objc

class
objc

class
Objec<ve-‐C
swi7

23
Nested
Type
Top-‐level

func<on
Typealias
Tuple
enumenumenum
structstructstruct
objc

class
objc

class
objc

class
Objec<ve-‐C
swi7

23
Nested
Type
Top-‐level

func<on
Typealias
Tuple
enumenumenum
structstructstruct
objc

class
objc

class
objc

class
Bridging

NSObject
Objec<ve-‐C
swi7

objcとswiftの橋渡し
一定規模のswﬁtコンポーネント
objcコードの橋渡し
24
広告枠 Ad
networking
logging
imp
click
display/

event
handling

25
⑤extensionパターン
Objec<ve-‐C
swi7

25
FooClass

method1
method2
Objec<ve-‐C
swi7

25
FooClass

method1
method2
method3
Objec<ve-‐C
swi7

25
FooClass

method1
method2
method3
FooClass

extension

Objec<ve-‐C
swi7

25
FooClass

method1
method2
method3
FooClass

extension

method3
Objec<ve-‐C
swi7

既存objcクラスをextensionする
26
@implement FooClass
- (void)method1 {...}
@end
.m

26
@implement FooClass
@end
.m
+
extension FooClass {
//メソッド追加
func method3() {
…
}
}
.swi7

26
@implement FooClass
@end
.m
+
//メソッド追加
func method3() {
…
}
}
.swi7
• 一番自然で適用させやすいパターン

27
ViewerController
Objec<ve-‐C
swi7

27
ViewerController ViewerController

extension
Objec<ve-‐C
swi7

27
ViewerController ViewerController

extension
func

shareBu)onDidTapped()

Objec<ve-‐C
swi7

28
⑥暴露パターン
Objec<ve-‐C
swi7

28
FooClass

property1
method1
Objec<ve-‐C
swi7

28
FooClass

property1
method1
Objec<ve-‐C
swi7
method2

FooClass

extension

28
FooClass

property1
method1
Objec<ve-‐C
swi7
method2

FooClass

extension

28
FooClass

property1
method1
Objec<ve-‐C
swi7
method2

method2

FooClass

extension

28
FooClass

property1
method1
参照・コール不可
Objec<ve-‐C
swi7
method2

method2

FooClass

extension

28
FooClass

property1
method1
Objec<ve-‐C
swi7
method2

method2
意図的な

カプセル化の破壊！

FooClass

extension

28
FooClass

property1
method1
Bridging-‐
Header.h

Objec<ve-‐C
swi7
method2

method2
意図的な


FooClass

extension

28
FooClass

property1
method1
Bridging-‐
Header.h

Objec<ve-‐C
swi7
property1
method1
公開
method2

method2
意図的な


FooClass

extension

28
FooClass

property1
method1
Bridging-‐
Header.h

参照・コール
Objec<ve-‐C
swi7
property1
method1
公開
method2

method2
意図的な


29
@interface FooClass ()
@property NSString property1;
@end
@implement FooClass
(void)method1 {
...
}
@end
.m
@interface FooClass
@end
.h

29
@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

29
@end
@implement FooClass
(void)method1 {
...
}
@end
.m
func methods() {
property1 = “foo";
method1()
}
}
.swi7
+
#import “xxx.h”
#import “yyy.h”
#import “zzz.h”
...
(void)method1;
@end
+
@interface FooClass
@end
.h

29
@end
@implement FooClass
(void)method1 {
...
}
@end
.m
func methods() {
property1 = “foo";
method1()
}
}
.swi7
+
#import “xxx.h”
#import “yyy.h”
#import “zzz.h”
...
(void)method1;
@end
+
@interface FooClass
@end
.h
↑objcは一切変更していない

30
プライベート属性を部分的に公開する

意図的にカプセル化を破壊
30

⁃ extensionから本体クラスのプライベート属性へのアクセスが
可能に
30

可能に
⁃ 変更箇所はブリッジングヘッダのみ、既存の.h/.mは変更なし
30

可能に
妥協が必要な部分
30

可能に
⁃ 異論の出るところ
30

可能に
⁃ 一時的な対応、という割り切り
30

可能に
⁃ 一時的な対応、という割り切り
⁃ ここを割り切ればSwift化は一気に進む
30

31
⑦乗っ取りパターン
FooClass

method1
property1
31
Objec<ve-‐C
swi7
property2
method2

31
FooClass

method1
property1
31
Objec<ve-‐C
swi7
property2
method2
FooClass

extension

method2

property2

⑤extensionパターン???

32
32
Objec<ve-‐C
swi7

32
FooClass

method1
property1
32
Objec<ve-‐C
swi7

32
FooClass

method1
property1
32
Objec<ve-‐C
swi7
property2
method2

32
FooClass

method1
property1
32
Objec<ve-‐C
swi7
property2
method2
FooClassBaserename

FooClass

32
FooClass

method1
property1
32
Objec<ve-‐C
swi7
property2
method2
FooClassBaserename

FooClass

extends
32
FooClass

method1
property1
32
Objec<ve-‐C
swi7
property2
method2
FooClassBaserename

FooClass

extends
32
FooClass

method1
property1
32
method2

property2

Objec<ve-‐C
swi7
property2
method2
FooClassBaserename

FooClass

extends
32
FooClass

method1
property1
32
method2

property2

Objec<ve-‐C
swi7
FooClassBaserename

FooClass

extends
32
FooClass

method1
property1
32
method2

property2

Objec<ve-‐C
swi7
参照・コール?
FooClassBaserename

FooClass

extends
Bridging-‐
Header.h

+⑥暴露パターン
32
FooClass

method1
property1
32
method2

property2

Objec<ve-‐C
swi7
FooClassBaserename

FooClass

extends
Bridging-‐
Header.h

32
FooClass

method1
property1
32
method2

property2

Objec<ve-‐C
swi7
property1
method1
公開
FooClassBaserename

FooClass

extends
Bridging-‐
Header.h

32
FooClass

method1
property1
32
method2

property2

Objec<ve-‐C
swi7
property1
method1
公開
参照・コール
FooClassBaserename

33
objクラスをswiftで継承し名前を乗っ取る

⁃ 継承して乗っ取る
33

• クラス本体をSwiftに移し替え、既存objcクラスは親
クラス化
33

クラス化
• プロパティやメソッドは自由に追加可能
33

クラス化
• ⑥暴露パターンの併用可能
33

クラス化
⁃ 妥協ポイント
33

クラス化
• 継承関係が変更される
33

クラス化
• 継承関係が変更される
⁃ 別解→
33

FooClass

method1
property1
34
⑦別解：乗っ取りパターン(カテゴリ拡張)
FooClass

34
property2

(Category
Extension)
Objec<ve-‐C
swi7
property1
extensionではなく

同名クラスをSwi7で
元のFooClassを

objcカテゴリ拡張に降格

FooClass

method1
property1
34
⑦別解：乗っ取りパターン(カテゴリ拡張)
FooClass

34
property2

(Category
Extension)
Objec<ve-‐C
swi7
property1
extensionではなく

同名クラスをSwi7で
元のFooClassを

objcカテゴリ拡張に降格
☓乗っ取り元objcにプライベート属性がある場合、制限多めなのでNG

参考：アンチパターン
35
//ストアドプロパティの追加
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セレクター

36
⑧写経パターン
Objec<ve-‐C
swi7

36
FooClass

method1
method2
Objec<ve-‐C
swi7

写経
36
FooClass

method1
method2
Objec<ve-‐C
swi7

FooClass

method1
method2
写経
36
FooClass

method1
method2
Objec<ve-‐C
swi7

FooClass

method1
method2
写経
36
Objec<ve-‐C
swi7

FooClass

method1
method2
36
Objec<ve-‐C
swi7

既存のobjcコードをswiftで書き直す
• 最後の手段
• テストの有無でリスク変動
• 元コードがテストで保護されている→◎
• 対象objcコードをまずテストで保護してからSwiftで書き直す→⃝
• 完全書き直し→△
• ある意味シンプルだが、フルQAは必須、コスト大
37

参考：写経のお供に
38
• Generated Interface

39

40

• 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は必須
41

42
Mix-and-Matchを使ったSwift移行パターンリスク

トリッキー度

Swi7移行度
小
大

何かに似ている
43

44

44
h)p://shop.ohmsha.co.jp/shopdetail/000000003881/
リファクタリング

44
h)p://shop.ohmsha.co.jp/shopdetail/000000003881/
リファクタリング
Extract
Method

Extract
Class

45

45
h)p://www.sbcr.jp/products/4797311126.html
gof
デザインパターン

45
h)p://www.sbcr.jp/products/4797311126.html
gof
デザインパターン
Bridgeパターン

46

46
h)p://www.shoeisha.co.jp/book/detail/9784798116839
レガシーコード改善ガイド

46
h)p://www.shoeisha.co.jp/book/detail/9784798116839
レガシーコード改善ガイド
• スプラウトメソッド

• スプラウトクラス

• 静的メソッドの公開
テストコードを書くためのリファクタリング手法

47
Mix-and-Matchを使ったSwift移行パターン
既存のソフトウェア開発技法の活用により

スムーズ・安全にSwi7移行可能

まとめ
48

まとめ
49

まとめ
Objective-CからSwift化への移行は大変？
49

まとめ
→まずは簡単なパターンから試してみる
49

まとめ
• 延命パターン
49

まとめ
• ご新規パターン
49

まとめ
慣れてきたらいろんなパターンを試す
49

まとめ
パターンについてあれこれ考えるのも楽しい
49

まとめ
⁃ 他にも良いパターンがありそう
49

まとめ
⁃ 他にも良いパターンがありそう
⁃ かっこいい名前希望
49

50
objc

swi7
50
objc

swi7
51
objc

swi7
52
objc
swi7

swi7
swi7
swi7
swi7
53
objc
swi7
swi7

objc
swi7
swi7
54
swi7swi7
swi7
swi7swi7
swi7

55
swi7

56
進
捗
ど
う
で
す
か

マンガボックスの現在のSwift化率
17%程度
まだまだこれから
57

今後の予測（雑）
58
2020年
ver5.6
にてSwi7化率100%到達予定（雑）！！！

59
Let’s Objc to Swift !

ありがとうございました。
60

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

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Viewers also liked

Viewers also liked (20)

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

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

Recently uploaded

Recently uploaded (8)

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