Facade Patternで磨く、コードの可読性と分解力 / MIERUNE BBQ #13

by MIERUNE

Slide 1

Slide 1 text

位置情報の新しいイノベーションへ Facade Patternで磨く、コードの可読性と分解力中森紳介

Slide 2

Slide 2 text

©Project PLATEAU / MLIT Japan 中森紳介自己紹介 NAKAMORI Shinsuke 2024年2月 MIERUNE入社　　　　　　　神奈川在住で普段はフルリモート勤務普段のお仕事：QGISプラグイン開発など BBQ参加歴：#10のみ（今日が2回目）（代打系）GISエンジニア

Slide 3

Slide 3 text

Slide 4

Slide 4 text

Slide 5

Slide 5 text

Slide 6

Slide 6 text

©Project PLATEAU / MLIT Japan 諸説あるかもしれませんがコードの可読性とはコードの可読性 = どれだけ読みやすいか

Slide 7

Slide 7 text

©Project PLATEAU / MLIT Japan 諸説あるかもしれませんがコードの可読性とはコードの可読性 = どれだけ読みやすいかコードの可読性 = どれだけ処理内容を追いやすいか

Slide 8

Slide 8 text

©Project PLATEAU / MLIT Japan フードデリバリーで商品を届ける一連のフローについて考えるフードデリバリーの例で考えてみる

Slide 9

Slide 9 text

©Project PLATEAU / MLIT Japan class Delivery: def 商品を届ける(self, 注文先: レストラン, 商品リスト: list, 目的地: str): お店の住所 = 注文先.お店の場所を確認する() 配達員リスト = [配達員A, 配達員B, 配達員C] 最短時間 = float("inf") for 対象者 in 配達員リスト: 現在地 = 対象者.現在地() 所要時間 = お店までの到達時間(現在地, お店の住所) if 所要時間 < 最短時間: 配達する人 = 対象者最短時間 = 所要時間所要時間 = 注文先.所要時間を確認する(商品リスト) レジ袋 = 注文先.商品を作る(商品リスト) 経路 = 配達する人.配達経路を確認する(目的地) 完了報告 = 配達する人.商品を運ぶ(レジ袋, 経路) if 完了報告: print("商品をお届けしました") return True else: print("商品の配達に失敗しました") return False

Slide 10

Slide 10 text

Slide 11

Slide 11 text

©Project PLATEAU / MLIT Japan class DeliveryFacadePattern: def 商品を届ける(self, 注文先: レストラン, 商品リスト: list, 目的地: str): アプリ = Application() お店の住所 = 注文先.お店の場所を確認する() 配達する人: 配達員 = アプリ.近くの配達員を検索する(お店の住所) 所要時間 = 注文先.所要時間を確認する(商品リスト) アプリ.所要時間を表示する(所要時間) レジ袋 = 注文先.商品を作る(商品リスト) 経路 = 配達する人.配達経路を確認する(目的地) 完了報告 = 配達する人.商品を運ぶ(レジ袋, 経路) アプリ.利用者に報告する(完了報告)

Slide 12

Slide 12 text

Slide 13

Slide 13 text

©Project PLATEAU / MLIT Japan コンピュータソフトウェアのデザインパターンの一つ Facade Pattern 参照:https://ja.wikipedia.org/wiki/Facade_%E3%83%91%E3%82%BF%E3%83%BC%E3%83%B3 Facadeクラス ● 複雑な実装を持たない ● 基本、処理を投げるだけ複数のサブシステム ● 具体的な実装を持つ

Slide 14

Slide 14 text

Slide 15

Slide 15 text

©Project PLATEAU / MLIT Japan 単一責任の原則が一般的（なはず単一責任の原則について調べると以下のような記述を見かける ●クラスは変更理由が一つだけであるべき ●クラスの目的は一つだけで、それが変わった場合のみ変更される ●1つのクラスは1つだけの責任を持たなければならない

Slide 16

Slide 16 text

©Project PLATEAU / MLIT Japan いやいや、その「単一」が分からんのじゃ「配達員」は単一なの？それとも「配達する」が単一なの？配達員のクラスでまとめていいの？「配達する」ってクラスを作るの？細かすぎない？まあシステムの大きさとかに寄るよねそこはセンスの問題かな

Slide 17

Slide 17 text

©Project PLATEAU / MLIT Japan 「単一」の迷路に迷い込んでしまったら私はセンスがないので、以下の手順をよく踏みます 1)とにかく思いついた「単一」っぽいものをバラバラに列挙する 2)同程度の粒度のものをグルーピングする 3)構造化して並べ直す 4)抜け漏れがないか、チェックする 5)具体的な処理を必要とする一つ上の粒度を「単一」と考えてみる 6)しっくりこなければ、粒度を一段変更してみる

Slide 18

Slide 18 text

Slide 19

Slide 19 text

©Project PLATEAU / MLIT Japan 思いついたやつをバラバラに列挙する商品代を算出するお代を受け取る近くの配達員を探す商品を袋に詰める調理する調理時間を確認するお店の場所を確認する現在地を取得する配達する利用者に報告する所要時間を表示するレストラン配達員

Slide 20

Slide 20 text

©Project PLATEAU / MLIT Japan 同程度のものをグルーピングレストラン配達員お店の場所を確認する調理時間を確認する調理する近くの配達員を探す所要時間を表示する利用者に報告する商品を袋に詰める現在地を取得する配達経路を確認する配達する商品を渡すお代を受け取る商品代を算出する粒度：大粒度：小

Slide 21

Slide 21 text

©Project PLATEAU / MLIT Japan 構造化して並べ直すシステムレストラン配達員お店の場所を確認する調理時間を確認する調理する商品を袋に詰める商品代を算出する現在地を取得する配達経路を確認する配達する商品を渡すお代を受け取る近くの配達員を探す所要時間を表示する利用者に報告する

Slide 22

Slide 22 text

©Project PLATEAU / MLIT Japan 抜け漏れがないか確認するシステムレストラン配達員お店の場所を確認する調理時間を確認する調理する商品を袋に詰める商品代を算出する現在地を取得する配達経路を確認する配達する商品を渡すお代を受け取る近くの配達員を探す所要時間を表示する利用者に報告するシステムから伸びる対象の粒度があってないな処理内容をグルーピングできないかな？

Slide 23

Slide 23 text

©Project PLATEAU / MLIT Japan 抜け漏れがないか確認するシステムレストラン配達員アプリケーションデータ登録実務お店の場所を確認する商品代を算出する調理時間を確認する調理する商品を袋に詰める待機状態配達会計処理表示処理現在地を取得する配達経路を確認する配達する商品を渡すお代を受け取る所要時間を表示する利用者に報告する近くの配達員を探す

Slide 24

Slide 24 text

©Project PLATEAU / MLIT Japan 具体的な処理を書く一段上を単一とするシステムレストラン配達員アプリケーションデータ登録実務お店の場所を確認する商品代を算出する調理時間を確認する調理する商品を袋に詰める待機状態配達会計処理表示処理現在地を取得する配達経路を確認する配達する商品を渡すお代を受け取る所要時間を表示する利用者に報告する近くの配達員を探す

Slide 25

Slide 25 text

Slide 26

Slide 26 text

Slide 27

Slide 27 text

Slide 28

Slide 28 text

©Project PLATEAU / MLIT Japan （余談）なお、個人的には今回の例なら、配達員やレストランのFacadeクラスを用意する方が好きシステムFacade アプリFacade 配達員Facade レストランFacade 配達モジュール会計モジュール

Slide 29

Slide 29 text

Slide 30

Slide 30 text

©Project PLATEAU / MLIT Japan 「分解力」高めるなら、キーボードも適切な粒度に分解せねばオススメしたいもの②：分割キーボードキーボード右手用キーボード左手用キーボード Q W E Y U I … … ↑先週手に入れたやつ