Stack View でパスコードロック画面風ナンバーパッドをつくる

大阪のお好み焼屋です。今年も店に新メニューは増えませんでしたが、App Storeでは[Watch app](https://appsto.re/jp/KT699.i)と[iMessage Stickers pack](https://appsto.re/jp/ht6Veb.i)をリリースできました！ でもステッカーに関しては「そもそもiMessageを使っていない」というiPhoneユーザーが多くて、[「フェデリギさん、話がちがうじゃないですか！」](http://www.imore.com/our-full-transcript-talk-show-wwdc-2016-phil-schiller-and-craig-federighi)とけっこう驚きました。

さて[以前RubyMotion+AutoLayooutでパスコードロック画面風ナンバーパッドをつくりました](http://qiita.com/OkonomiyakiYuki/items/d6f12d092837efc8c755)。当時はダイナミック言語＋Terminal＋Vimな環境で、UIからなにから全てスニペットもコードコンプリーションも使わずごりごり書いていてそれはそれで楽しかったのですが、あれから3年、いまはすっかりスタティック言語＋Xcode＋Storyboardな生活です。住めば都です。

# 最終目的

![qiita_2016_goal.jpg](https://qiita-image-store.s3.amazonaws.com/0/32738/fce31d2d-1cdd-92aa-4f9d-4ab74baa2c58.jpeg)

みなさんご存知パスコードロック画面です。完コピ、というわけにはいきませんがこれを目指します。

# UIのトレース

### Sketch

より再現度を高めるため画面の測定をするなら[ドローイングソフトのSketch](https://www.sketchapp.com)が便利です。Sketchはすごく使いやすいのでここ数年機会があるごとにつかっています(AppやステッカーのグラフィックはすべてSketch)。

しかし、残念ながらというべきか、僕が購入したときとくらべると、[App Storeから抜けたり](http://bohemiancoding.tumblr.com/post/134322691555/leaving-the-mac-app-store)、値上げしたり、[ついには年課金アップデートシステムに移行したり](https://blog.sketchapp.com/versioning-licensing-and-sketch-4-0-8ad98783e9ba#.y8m0pmr44)と、正直導入の敷居が上がってしまった感じです。でもいいソフトであることは間違いないと思います。

ねぎがべらぼうに高騰して苦しい時も、Sketchがあれば簡単にねぎを描くことができます。
おすすめしておきます。

![green_leek.png](https://qiita-image-store.s3.amazonaws.com/0/32738/e448b15a-8a0b-5e1f-0f1c-303a2c9f2c85.png)

### UIトレースの手順

1. iPhone実機でスクリーンショットを撮る
2. 1をSketchにインポート
3. [A]を押してその機種のサイズに合ったアートボードをつくる
4. スクリーンショットをアートボードのサイズにリサイズ
5. 測りたい箇所に線を引いたり描いたりしてそのサイズや距離を測る（Xcodeと同じようにoptionキーが使える）

ということになります。実例が以下。

![qiita_advcal_2016_2_comparison.png](https://qiita-image-store.s3.amazonaws.com/0/32738/d4d698ca-4b61-3f40-e504-e2c0f0b83a54.png)

明るい紫色がサイズ測定のためにSketchで描いたものです。

いろいろ線を引いていて気がついたことは、

- 画面の中央には（ナンバーパッドのセンターではなく）数字の5が来ていること（スクリーンショットの薄いグレイのレクタングルがナンバーパッドをセンタリングした場合の枠です）
- ステータスバーを除いて、ナンバーパッドの周囲には同じ程度の大きさの箱が5つ入る
- ナンバーパッドのリーディングから線を引くと、"Emergency"はすこしはみ出し、Cancelは逆にすこし内に入り過ぎのように見える
- 当たり前のようですが、ちゃんと計算されてデザインされているのだなあ、ということ。見習いたい。

必要な情報を集めたら、さっそく再現にとりかかりましょう！

# Stack View とは

Stack ViewはAuto Layoutを補完するものとしてiOS9から加えられました。レイアウト上で共通の特性を持つエレメントをStack Viewへとその特性ごとに小さいものから大きいものへとスタックしてまとめていき、全体のレイアウトをよりシンプルに、簡単にしようという仕組みです。要するに「Divide and conquer」です。 

最近たびたび耳にする[LinkedInのLayoutKit](https://realm.io/news/slug-nick-snyder-layoutkit/)もStackベースのようで、流行りのソリューションなのかもしれません。

従来の方法でナンバーパッドのような沢山のView（とそのサブクラス）が必要なUIをレイアウトしようとすると、なにか新しい部品をくわえるたびにいちいちXcodeからやれどこに置くのかわからないだの（ambiguity）、前に言ったことと相反しているだの（conflicts）ブーブー文句を言われたものですが、Stack Viewだととにかく一度スタックしてしまえば文句をいわれる的（マト）は絞れるようになる（Stack Viewをスケープゴートにできる）ので、だいぶ気が楽になります。

下が今回パスコード入力画面の再現のために使ったStack Viewを図示したものです。

![qiita_2016_v_h.png](https://qiita-image-store.s3.amazonaws.com/0/32738/d1c1593f-abd2-6ddf-f6b2-8402b87438bb.png)

画面内のすべての要素をスタックしました。NSMatrixと格闘した世代が見たら卒倒するんじゃないかというぐらいViewてんこ盛り状態ですが、UIStackViewはUIViewのサブクラスでありながらrenderの必要がないために特別な最適化が働いていて、動作は軽いんだそうです（[参考](http://asciiwwdc.com/2015/sessions/218)）。[NSCellもdeprecated](http://stackoverflow.com/questions/26643445/why-is-nscell-deprecating-and-why-was-it-introduced-in-the-first-place)らしいので、これも時代の流れと割り切っていきましょう。


## プロパティ

プロパティに関しては[図解付きで丁寧にまとめられたものがある](https://www.techotopia.com/index.php/Working_with_the_iOS_9_Stack_View_Class)ので、詳しくはそちらをご参照ください。[日本語ならこちら。](http://qiita.com/yucovin/items/ff58fcbd60ca81de77cb)

ここでは大雑把な話だけ。

### Axis
従来のAuto Layoutの作法とくらべてStack Viewがもっともちがう点はどこかというとそれはこのAxisの存在だと思います。

もちろんいままでも`horizontal`と`vertical`は重要な概念だったわけですが、Stack Viewでは「このStack Viewはhorizontalです」と決めると、とにかくそこに加えられた要素はすべて横並びにされます。そのStack View内での微妙な位置決めには`alignment`や`distribution`が使われるものの、**横並びである**ことは変わりません。

![qiita_advcal_2016_1_hor_ver.png](https://qiita-image-store.s3.amazonaws.com/0/32738/21492115-0bc6-1a62-7368-28e58b3460d6.png)

```swift:UIStackView
var axis: UILayoutConstraintAxis

/*
enum UILayoutConstraintAxis: Int {
    case horizontal = 0
    case vertical
}
*/
```

ナンバーパッドではボタンが11個、左最下部を除いて綺麗に3x4で並んでいます。そこで今回は、まずは`horizontal`でボタンを3つスタックし、次にそのスタックを計4つに複製したら、最後にそれらすべてをまとめて`vertical`でスタックすることにしました。

Storyboardでの実際の作業は以下のようになります。積み重なった（スタックされた）箱に下矢印がついたものが`stack`ボタンです。

![qiita_advcal_2016_2_stack_buttons.gif](https://qiita-image-store.s3.amazonaws.com/0/32738/97faa410-a9e5-1138-f874-e865038d1b07.gif)

たくさんあった警告の赤いラインが、その場しのぎとはいえスタックで一瞬にして消えるのは見ていてとても気持ちがいい😊

あと、あらかじめオリジンとなるボタンのプロパティ（aspect ratioやclass）をカスタマイズしてから複製すると、後の作業がすごく楽になります。

### Alignment, Distribution

AlignmentとDistributionはすごーくややこしいのですが、今回はボタンの大きさおよび列などすべて同じディメンションのため、verticalもhorizontalもそれぞれ`UIStackViewAlignment.fill`と`UIStackViewDistribution.fillEqually`で大丈夫でした。

実現したいレイアウトがもっと複雑な場合は、先ほど紹介したサイトに図付きが解説がとても参考になると思います。

### Spacing

上のgifを見ていただくとわかるように、最初にViewをスタックすると、まずはそれぞれの`intrinsicContentSize`に基づいているであろうと思われるサイズに部品がリサイズされ、隙間もなくピタッとくっつけられます。

```swift
var spacing: CGFloat
```

`spacing`はそれぞれ`arrangedSubviews`を`axis`の方向にその値分だけ間をあけてやる、というプロパティです。これらの値はSketchを利用して測量済みなので、そのまま適用してやります。この際、共通の値を共通のaxisを持つStack Viewに渡したければ、複数選択した状態にすると一括で入力ができます。

![qiita_2016_spacing_x640.gif](https://qiita-image-store.s3.amazonaws.com/0/32738/e5105773-9b25-a588-823b-e11bc7f00d8b.gif)

これだけで、すでに3年前に実現したことはほぼ達成できています！ すばらしい。

## Button

### ボタンをレイアウト

せっかくなのでボタンの数字の下に英文字をプリントします。`UIButton`に新たにレーベルを足したいんですが、StoryboardでUIButtonのインスタンスにlabelをsubviewとして加えようとしても**なぜか**うまくいきません（原因はわかりませんでした。ハードコードすれば普通にできるはず）。


仕方がないのでUIViewをベースにして、以下のような構造にすることにします。

最背面から順に

- ベース（コンテナ）となるview
    - 以下2つのlabelをverticalに束ねるstack view
        - 大きいキーの番号用のlabel
        - 小さい英文字用のlabel
    - ボーダー（枠）だけ表示された最前面のbutton

![qiita_button_1_base_view.png](https://qiita-image-store.s3.amazonaws.com/0/32738/c77d8c0b-6e6d-68f4-f1f2-94096ead457d.png)

# 仕上げ

入力のインディケーターlabel4つをhorizontalにスタックし、"Enter Passcode"labelとverticalでスタックしたら、最後にナンバーパッドとまとめてverticalにスタックします。

それっぽいエフェクトをくわえたのがこちら。

![qiita_advcal_2016_1_results_2.gif](https://qiita-image-store.s3.amazonaws.com/0/32738/d980683e-b08c-54c8-a5d0-daa0cdf7ed60.gif)



# まとめ

[参考プロジェクト](https://github.com/haruhikoM/MyNumberPad)

おまけとしてStack Viewで簡単に実現できるアニメーションも実装しました[（参考）](https://medium.com/@nrewik/easy-animation-with-uistackview-8878b2856ae2#.phdt5tctj)。秘密のパスコードを入力した方だけが見ることができます！ ヒントは『屋号』ですが、じつはコードに直書き（！）だったりもします。

![qiita_2016_stackview_animation.gif](https://qiita-image-store.s3.amazonaws.com/0/32738/5f3b4d92-8039-b40b-0cbe-74adb1caf877.gif)



そもそもの話として Auto Layoutは難しい！ というのはあると思います。でもその難しさを軽減する手段としてStack Viewは十分期待に応える出来になっていると思います。

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