AWS CDKで学ぶGoFデザインパターン〜IaCにもコード設計〜 / aws dev day cdk gof design patterns

© 2023, Amazon Web Services, Inc. or its affiliates. All rights reserved.
AWS CDKで学ぶGoFデザインパターン
〜IaCにもコード設計〜
後藤健太 (k.goto)
2 0 2 3 . 0 6 . 2 2 - 2 3
A W S D E V D A Y 2 0 2 3 T O K Y O
B - 1

View Slide

⾃⼰紹介
• 後藤健太 (k.goto)
§ テックリード
§ AWS Community Builder (DevTools)
§ 365歩のテック (技術ブログ)
§ ⾃作AWSツールのOSS開発
§ AWS CDK コントリビューター
§ Twitter: @365_step_tech
– k.goto(365歩のテック)

View Slide

アジェンダ
• GoFデザインパターンとは
• 本セッションの⽬的と注意
• GoFデザインパターン × AWS CDK実例集
• まとめ

View Slide

GoFデザインパターンとは

View Slide

GoFデザインパターンとは
• オブジェクト指向におけるコード設計のデザインパターン
§ 書籍『オブジェクト指向における再利⽤のためのデザインパターン』 (※)
– 通称『GoF本』
– GoF(Gang of Four) = この共著者の4⼈
– 全23パターン
• 古くからあるが、AWS Cloud Development Kit (AWS CDK) の
内部実装にも⼀部⽤いられている
※『オブジェクト指向における再利⽤のためのデザインパターン』 (ソフトバンクパブリッシング)
著: エーリヒ・ガンマ、ラルフ・ジョンソン、リチャード・ヘルム、ジョン・ブリシディース
監訳: 本位⽥真⼀, 吉⽥和樹

View Slide

本セッションの⽬的と注意

View Slide

本セッションの⽬的
• AWS CDKを通してGoFデザインパターンを学ぶ
• AWS CDKコードを効率的にする
※もちろんCDKコードの効率性に繋がる点もたくさんありますが、あくまで
本セッションではそれらを推奨・⽬的とするものではありません。
AWSユーザに馴染み深いAWS CDKを通して
GoFデザインパターンを学ぼう︕

View Slide

注意
• 本来のGoFデザインパターンと表現が多少異なる場合があります。
§ CDKコードにうまく適⽤するため
• CDKコードを書く上で、通常と⽐べて冗⻑になる場合があります。
§ GoFデザインパターンを適⽤・説明しやすくするため

View Slide

GoFデザインパターン
× AWS CDK実例集

View Slide

GoFデザインパターン × AWS CDK実例集
①
②
③
④
⑤
⑥
⑦
⑧
⑨
⑩

View Slide

①Compositeパターン

View Slide

• ⽊構造を伴う再起的なデータ構造を利⽤した⼿法
§ 容器と中⾝を同⼀視することで再起的な構造の⾛査が可能に

View Slide

【CDKでのシチュエーション】
§ 特定のリソース群に対して⼀元的にパラメータ設定などの操作を適⽤したい
【使⽤例】
§ AWS CDKの特徴であるリソースのツリー構造を利⽤して、
特定のコンストラクト内の全リソース、またはスタック内のすべてのリソースに
対して⼀括で「RemovalPolicy」パラメータを指定する

View Slide

【CDKクラス図】

View Slide

【CDKクラス図簡略版】

View Slide

【⽐較】

View Slide

【コード例】

View Slide

【コード例】
→ResourceならRemovalPolicy適⽤
→Constructなら、さらにその⼦供達に対して同メソッドを再起呼び出し
※applyRemovalPolicy: Resourceに定義されたRemovalPolicy適⽤メソッド
※RetainConstruct:
Retainにしたいリソースを集めた⾃作Construct

View Slide

②
③
④
⑤
⑥
⑦
⑧
⑨
⑩

View Slide

②Facadeパターン

View Slide

• 複数のクラス群を組み合わせて⾏う複雑な⼿順を、⼀つの窓⼝を
設けることで、それを呼び出すだけで簡単に⾏えるようにする⼿法

View Slide

§ 複雑なリソース構築をうまくまとめてシンプルに呼び出したい
【使⽤例】
§ Constructを作成してその中に⼀連のリソース定義をまとめて定義し、
Stackからはそれを呼び出すだけでシンプルなリソース構築を⾏う

View Slide


View Slide

【⽐較】

View Slide

【コード例】
Facade≒Constructみたいなもの
①
①
② ③
②
③

View Slide

③
④
⑤
⑥
⑦
⑧
⑨
⑩

View Slide

③Adapterパターン

View Slide

• 既存のクラスに⼿を加えられない時に、そのクラスを変更すること
なく機能拡張をするための⼿法
§ ライブラリの拡張など後⽅互換性を損ないたくないケースで有効

View Slide

• 継承でなく委譲(コンポジションを利⽤した技法)する形も可
§ AdapterがAdapteeをプロパティとして持ち、Adapterのメソッド内部でAdapteeの
メソッドを呼び出す
• 本セッション例ではCDKとの相性の理由で継承を使⽤しているが、
本来は継承より委譲の⽅が望ましい
§ “クラス継承よりもオブジェクトコンポジションを多⽤すること”
– GoF本第1章『概論』より

View Slide

§ CDK提供のリソース定義(BucketやQueue等)に、新たなメソッドを追加したい
【使⽤例】
§ あるリソースに複数のリソースポリシーを⼀度の呼び出しで⼀気に付けたいが、
単⼀ポリシーを付けるメソッド(addToResourcePolicy)しか⽤意されていない
§ そこで、それらのリソースクラスを拡張する新たなクラスを作り、そのクラスに
⾃作のメソッド(addManyToResourcePolicy)を定義する

View Slide


View Slide

【⽐較】

View Slide

【コード例】
※Bucketをextendsしているので、⾃⾝(this)が
addToResourcePolicyメソッドを持っている →それをループで回すことで⼀気にポリシーをアタッチするように⾒せる
①
②
①
②

View Slide

【コード例】

View Slide

④
⑤
⑥
⑦
⑧
⑨
⑩

View Slide

④Decoratorパターン

View Slide

• 基となるオブジェクトに動的に飾りつけを重ねていき、柔軟に機能の
拡張を⾏うための⼿法
§ オブジェクトをラップすることで、飾りつけ(機能追加)が可能に

View Slide

§ リソースを作成するときに、あらかじめ特定の設定が適⽤されたものが
作られるようにしたい
【使⽤例】
§ リソースを作成する際にいちいちapplyRemovalPolicyメソッドを呼び出さずに
RemovalPolicyが適⽤できるようなラップクラスを定義する

View Slide


View Slide

【⽐較】

View Slide

【コード例】
※若⼲無理やりパターンを実現をしています
constructor内で、サブクラスのgetOwnRemovalPolicyでRETAIN|DESTROYを呼び、
それを⾃⾝のapplyRemovalPolicyに渡している。
これによってnewと同時にRemovalPolicyの適⽤ができるようになる。
①
② ③
①
② ③

View Slide

【コード例】

View Slide

⑤
⑥
⑦
⑧
⑨
⑩

View Slide

⑤Singletonパターン

View Slide

• あるクラスのコンストラクタが、何度呼び出されても⼀つしか
インスタンスが作成されないことを保証する⼿法
§ ⼀度作られたインスタンスを使い回す
※今はあまり推奨されていないパターン

View Slide

§ あるスタック内で何度呼び出されても作られるリソースは⼀つであって欲しい
– Custom ResourceのハンドラーとしてLambda関数を使う場合など
【使⽤例】
§ CDK提供のSingletonFunctionクラスを使う
※CDK提供のSingletonFunctionは、挙動はいわゆるSingletonパターンと同じ
ですが内部の実装がCDK⾊強いため、今回は⾃前のSingleton実装を出します。
※参考: 『AWS CDK コンストラクトライブラリ開発に関する5つのTips』
https://tmokmss.hatenablog.com/entry/20220517/1652755027

View Slide


View Slide

【⽐較】

View Slide

【コード例】
constructorがprivateなのでクラス内部からしか呼び出せない
①
①

View Slide

【コード例】

View Slide

https://github.com/aws/aws-cdk/blob/a2c633f1e698249496f11338312ab42bd7b1e4f0/packages/aws-cdk-lib/aws-lambda/lib/singleton-lambda.ts
【参考: SingletonFunctionコード】

View Slide

⑥
⑦
⑧
⑨
⑩

View Slide

⑥Strategyパターン

View Slide

• クライアントと独⽴してアルゴリズムを定義し、かつクライアントが
意識せず動的に振る舞いを変更可能にする⼿法
§ 戦略(アルゴリズム)/型(クラス)ごとの分岐処理いらず

View Slide

【使⽤例】
§ CDKで提供されるValidation機能の内部実装において使⽤されている

View Slide

【addValidation / IValidation】
※https://docs.aws.amazon.com/cdk/api/v2/docs/constructs.Node.html#addwbrvalidationvalidation
addValidationによりバリデーションルール(IValidation)を登録し、
cdk synth時にvalidationメソッドが発⽕しバリデーションが⾛る

View Slide

【addValidation / IValidation】
※https://docs.aws.amazon.com/cdk/api/v2/docs/constructs.IValidation.html
validate()というメソッドを
実装すれば良い

View Slide


View Slide

【⽐較】

View Slide

【コード例】
①
①
addValidationにより登録されたバリデーション処理
(validationメソッド)がcdk synth時に発⽕する

View Slide

https://github.com/aws/constructs/blob/10.x/src/construct.ts
【validateコード】
IValidationというinterfaceであればvalidate()を持っているので
_validationsの各要素が何の実クラスなのか気にしなくて良い。
validate()の中⾝がどんな処理かも知らずに実⾏できる。
= ポリモーフィズム

View Slide

⑦
⑧
⑨
⑩

View Slide

⑦Template Methodパターン

View Slide

• 処理の⼤枠の⼿順を組んでおき、各ステップの具体的な内容は
サブクラスで実装する⼿法

View Slide

§ Validation機能(⑥Strategyパターン参照)において、各環境(dev | prod)ごとで
バリデーションの内容を変えたい
【使⽤例】
§ IValidationを実装するValidatorを抽象クラスとし、
そこでバリデーションロジックの⼤枠を組む
§ それを継承するdev | prod⽤サブクラスを作成し、上記⼤枠の中の
各ステップでのロジックをそれぞれのサブクラスごとで組む

View Slide


View Slide

【⽐較】

View Slide

【コード例】
①
①
②
②
③
③

View Slide

【コード例】

View Slide

⑧
⑨
⑩

View Slide

⑧Factory Methodパターン

View Slide

• 操作の中でオブジェクト⽣成部分は抽象的に定義しておき、実際に
どのクラスをインスタンス化するかはサブクラスが決める⼿法

View Slide

§ あるリソースを⽣成する際に、あらかじめ特定の設定が適⽤されたものが
作られるようにしたい
– ④Decoratorパターン章とほぼ同じシチュエーション
– Decoratorでは「どのリソースも」、こちらは「あるリソースを」
【使⽤例】
§ あるリソースの⽣成処理だけ抽象的に定義しておき、それによって⽣成された
オブジェクトに対して特定の設定(RemovalPolicy)を適⽤する処理を定義する
§ 抽象定義した⽣成部分は、サブクラスで実装する

View Slide


View Slide

【⽐較】

View Slide

【コード例】
①
①
②
②
③
③
何が作られるかはサブクラス次第だが、作られるものはResource型である。
Resource型はapplyRemovalPolicyを持つので、作られるものが何だろうと実⾏できる

View Slide

【コード例】

View Slide

⑨
⑩

View Slide

⑨Abstract Factoryパターン

View Slide

• 特定の組み合わせのオブジェクト群を⽣成するためのインターフェー
ス(受け⼝)を提供する⼿法

View Slide

§ 環境ごとでコンポーネントの組み合わせの違う、環境特有のセットを作りたい
【使⽤例】
§ 細かいコンポーネント(App群, Batch群, WAF等)を各Constructで定義する
§ Dev | Prodでそれぞれ使⽤するコンポーネント(Construct)の組み合わせを
さらにConstructとして定義し、環境ごとに個別で構築できるようにする
– 例︓Devはアプリだけでいいが、Prodは管理⽤バッチやWAFなどもつけたい

View Slide


View Slide

【⽐較】

View Slide

【コード例】
①
② ③
③
①
②

View Slide

【コード例】
④
⑤ ⑥
⑥
④
⑤
AppModule, BatchModule, WafModuleはそれぞれConstruct。
例︓AppModuleにはLambdaがn個、BatchにはLambdaが1個、WAFにはWAFやIPSetなど・・・
※ProductBもほぼ同様コード

View Slide

【コード例】
これを呼んでconfigを作り、Stack呼び出しで渡す
これだけで、dev | prdで違うセットのリソースが作れ、
条件分岐の数も最⼩(余計な分岐が出てこない)
さらにパラメータも違うものが作れる(以下参照)

View Slide

⑩

View Slide

⑩Visitorパターン

View Slide

• データ構造から操作を分離することで、既存のオブジェクトに対する
新しい操作をデータ構造に変更を加えずに追加できる⼿法

View Slide

【使⽤例】
§ “Aspects employ the visitor pattern.”(※)
§ スコープ内の全ての要素に操作の適⽤・検証する機能
– コンプライアンス・セキュリティのガードレールなどのために使われることが多い
※https://docs.aws.amazon.com/cdk/v2/guide/aspects.html

View Slide


View Slide

【⽐較】

View Slide

【コード例】
①
①
データ構造と操作を分離することが
Visitorパターンの本質
データ構造: ResourceやConstruct
構造に対する操作: Aspect(visit)

View Slide

【コード例】
② ③
②
③
※これはただのAspectsの使い⽅ (Visitorパターンにあまり関係ない)
例︓Bucketを定義したスタック(③)に対してAspectを当てる

View Slide

https://github.com/aws/aws-cdk/blob/a2c633f1e698249496f11338312ab42bd7b1e4f0/packages/aws-cdk-lib/core/lib/aspect.ts
【参考: Aspectsコード】
④
④

View Slide

【参考: synthesizeコード】
https://github.com/aws/aws-cdk/blob/a2c633f1e698249496f11338312ab42bd7b1e4f0/packages/aws-cdk-lib/core/lib/private/synthesis.ts
データ構造に対して⾛査し
分離して定義した操作を当てる
=Visitorパターンの本質
再起呼び出し
(データ構造の⾛査)
visit(操作)
Aspectsを取得
してループ

View Slide

• ※補⾜︓よく使われるVisitorパターンのセオリー(以下例)とは細かい実装⽅法が異なる
§ ①構造⾃体(CDKで⾔うconstruct) がacceptというメソッドを持つ
§ ②visitor側がデータ構造の各サブクラスごとの型の引数のメソッドを全て⽤意
§ ③acceptメソッドの引数でvisitorを渡し、その中でvisitor.visit(this)呼び出し
– ⾃分⾃⾝を渡すことで(動的に)メソッド/型の選択を⾏うダブルディスパッチ
§ ④ObjectStructure(構造保持オブジェクト)により構造を⾛査
(これはデータ構造の種類が限られている前提であり、CDKの様に構造の種類が膨⼤・かつ可変なケースでは現実的に難しい。
そのためCDK(Aspects)ではダブルディスパッチでなく抽象を受け取るvisitメソッドでinstanceofでの分岐が必要になる)
② ①
③

View Slide


View Slide

まとめ

View Slide

まとめ
• GoFデザインパターン × AWS CDKの実例紹介
§ 10パターン / 全23パターン
• 本セッションの⽬的
§ AWS CDKを通してGoFデザインパターンを学ぶ
§ AWS CDKコードを効率的にする
AWSユーザに馴染み深いAWS CDKを通して
GoFデザインパターンを学ぼう︕

View Slide

参考︓ GitHub(参考コード・クラス図)
• 本セッションで挙げたCDKコード実例・クラス図など全てGitHubにて
公開しています。
– https://github.com/go-to-k/cdk-gof-design-pattern

View Slide

宣伝︓⾃作AWSツールOSS
• delstack: AWS CloudFormationスタック強制削除ツール
– https://go-to-k.hatenablog.com/entry/delstack
• cls3: S3バケット⾼速削除・空にするツール(バージョニング対応)
– https://go-to-k.hatenablog.com/entry/cls3
• lamver: Lambdaランタイム/バージョン検索ツール(リージョン横断)
– https://go-to-k.hatenablog.com/entry/lamver

View Slide

Thank you!
後藤健太
Twitter: @365_step_tech

View Slide

AWS CDKで学ぶGoFデザインパターン〜IaCにもコード設計〜 / aws dev day cdk gof design patterns

AWS CDKで学ぶGoFデザインパターン〜IaCにもコード設計〜 / aws dev day cdk gof design patterns

k.goto

More Decks by k.goto

Other Decks in Programming

Featured

Transcript

AWS CDKで学ぶGoFデザインパターン 〜IaCにもコード設計〜 / aws dev day cdk gof design patterns

AWS CDKで学ぶGoFデザインパターン 〜IaCにもコード設計〜 / aws dev day cdk gof design patterns

k.goto

More Decks by k.goto

Other Decks in Programming

Featured

Transcript

AWS CDKで学ぶGoFデザインパターン〜IaCにもコード設計〜 / aws dev day cdk gof design patterns

AWS CDKで学ぶGoFデザインパターン〜IaCにもコード設計〜 / aws dev day cdk gof design patterns