Symfonyの特性(設計思想)を手軽に活かす特性(trait)

Transcript

1. Symfonyの特性(設計思想)を 手軽に活かす特性(trait) 同人ソフトサークル Project ICKX 若葉 章 @effy_staffs (EFFY開発チーム)
2. 自己紹介 • 若葉 章（わかば あきら） • 2010年～ 同人ソフトサークル Project ICKX • プロデューサー / 営業 / インフラ / サーバサイド... / ゲームの実開発以外全部 • 本職はスタッフエンジニアっぽいこともするphpエンジニア • PHP続けて26年 PHP3の頃からお世話になっています • 最近の趣味は自転車とコーヒーとアマチュア無線 • Tyrell iveで京阪や徳島から高松まで走ったり、icom ic-705やID-52で移動運用試したり • ボトルゲージ用のアルミステーやドリッパーホルダの自作を始めましたもうだめだ • Nintendo Switch で『VERTICAL STRIKE ENDLESS CHALLENGE』販売中 • Qiitaで『phpで高速に・省メモリ・確実に日本語csvを扱う方法』公開中 https://qiita.com/wakabadou/items/84b48ca12f25fb2fb69c 「composer require fw3/streams」をよろしくね。 「composer require tacddd/tacddd」もよろしくね。 「composer require bypassflow/crypt」もよろしくね。
5. 5 サンプルコード • 実際に起動して、画面を触り、コードを追いながら 確認できます https://github.com/wakabadou/phperkaigi2026
6. 初めに
7. • 本登壇では特に断りがない場合 次のバージョンを前提にお話しします • PHP：8.5.4 • Symfony：8.0.7
8. trait(特性)
9. • 2012年リリースのPHP5.4から導入された機能 • 単一継承言語でコードを再利用する仕組みの一つ • 単にいくつかの機能をまとめるためだけのもの • プロパティやメソッド、定数(8.2以降)を定義できる • インスタンスは作れない • 縦軸の再利用が継承、横軸の再利用が特性として整理できる • 適用できる先はクラス、特性、列挙型(Enum) • 疑似的に多重継承っぽいことができる • 継承が許されないEnumに対して共通処理を持ち込める
10. traitの使い方
11. trait宣言の後にプロパティやメソッド、 定数を書き適用先でuseするだけでOK 我は特性であると宣言 好きに書くが良い (但し制約があります)
12. trait宣言の後にプロパティやメソッド、 定数を書き適用先でuseするだけでOK 12 sample sample sample traitで定義した内容を 適用先全てで利用できます 出力はこうなります useしたものをuseする ことで更に派生できます
13. 再利用上の特性
14. class A extends AC use TraitA use TraitB class C extends B use TraitB class D extends B trait TraitB abstract class AC class B extends AC use TraitA trait TraitA 継承と特性で実現する再利用
15. abstract class AC class A extends AC use TraitA use TraitB class B extends AC use TraitA class C extends B use TraitB class D extends B 旧来の継承で実現する再利用範囲
16. abstract class AC class A extends AC use TraitA use TraitB class B extends AC use TraitA class C extends B use TraitB class D extends B trait TraitA 特性Aで実現する再利用範囲
17. abstract class AC class A extends AC use TraitA use TraitB class B extends AC use TraitA class C extends B use TraitB class D extends B trait TraitB 特性Bで実現する再利用範囲
18. traitで許されないこと
19. インスタンスの生成 19 Fatal error: Uncaught Error: Cannot instantiate trait SampleTrait
20. traitからの定数直呼び出し 20 Fatal error: Uncaught Error: Cannot access trait constant SampleTrait::HOGE directly
21. traitからの静的プロパティ 直呼び出し 21 Deprecated: Accessing static trait property SampleTrait::$fuga is deprecated, it should only be accessed on a class using the trait Fatal error: Cannot redeclare trait SampleTrait
22. traitからの静的メソッド 直呼び出し 22 Deprecated: Calling static trait method SampleTrait::foo is deprecated, it should only be called on a class using the trait
23. 8.2未満でのconst 23 Fatal error: Traits cannot have constants
24. traitで定義した定数を クラスで上書き 24 Fatal error: SampleClass and SampleTrait define the same constant (HOGE) in the composition of SampleClass. However, the definition differs and is considered incompatible. Class was composed
25. traitで定義した定数を クラスで上書き 25 string(10) "class hoge" interface同様、別クラスに 適用しそのクラスを継承すれば 回避できる
26. traitで定義した定数を クラスで上書き 26 string(10) "trait hoge" ちなみにtraitとinterfaceを 同時に実装、適用した場合 traitの定数が優先されます
27. traitで出来ないこと 未実装
28. 抽象プロパティ 28 Fatal error: SampleClass and SampleTrait define the same hooked property ($public) in the composition of SampleClass. Conflict resolution between hooked properties is currently not supported. Class was composed
29. 抽象プロパティフック 29 Fatal error: SampleClass and SampleTrait define the same hooked property ($public) in the composition of SampleClass. Conflict resolution between hooked properties is currently not supported. Class was composed
30. プロパティフック 30 Fatal error: SampleClass and SampleTrait define the same hooked property ($public) in the composition of SampleClass. Conflict resolution between hooked properties is currently not supported. Class was composed
31. • trait側に抽象プロパティ記述自体はできますが SampleTraitに記述した抽象プロパティや 抽象フックドプロパティ、プロパティフックに対して、 SampleClassの実装が「要件を満たす/実装する」 関係として扱われず、同名のプロパティフック定義の 衝突として扱われます。 • 現状のPHPではこの衝突解決は未実装
32. traitで書けること 書けないこと
33. Enumに適用する trait
34. Enumに適用するtraitに 書けること・書けないこと • (書けない)静的プロパティ • (書けない)動的プロパティ • 静的メソッド • 動的メソッド • 抽象メソッド • 定数(8.2以降) 34
35. Enumに適用するtraitで 書けないプロパティ 35 Fatal error: Enum SampleEnum cannot include properties
36. Enumに適用するtraitで 書けないプロパティ 36 • trait以前にEnumにはプロパティを書けません • そのためFatalになります
37. Enumに適用するtraitで 書ける動的メソッド 37 string(7) "Sample1"
38. Enumに適用するtraitで 書ける静的メソッド 38 string(4) "fuga" string(4) "fuga"
39. Enumに適用するtraitで 書ける抽象メソッド 39 string(4) "hoge" string(4) "hoge" string(7) "Sample1"
40. Enumに適用するtraitで 書ける定数 40 string(6) "public" string(6) "public" string(9) "protected" string(7) "private"
41. traitに適用するtrait
42. traitに適用するtraitに 書けること・書けないこと 42 • 静的プロパティ • 動的プロパティ • 静的メソッド • 動的メソッド • 抽象メソッド • 定数(8.2以降)
43. プロパティに適用するtraitで 書ける静的プロパティ 43 string(13) "static public" string(16) "static protected" string(14) "static private"
44. プロパティに適用するtraitで 書ける動的プロパティ 44 string(6) "public" string(9) "protected" string(7) "private"
45. classに適用するtrait
46. classに適用するtraitに 書けること・書けないこと 46 • 静的プロパティ • 動的プロパティ • 静的メソッド • 動的メソッド • 抽象メソッド • 定数(8.2以降)
47. Enumとtraitで 書いたこと全部 できるので省略
48. traitの特性 (今日使うところだけ)
49. 複数のtraitで定義した 同名プロパティの 属性(attribute)適用順
50. 複数のtraitで定義した(略 50
51. 複数のtraitで定義した(略 51
52. 複数のtraitで定義した(略 52
53. 複数のtraitで定義した(略 53 object(class@anonymous)#3 (2) { ["instance"]=> object(SampleClass)#8 (1) { ["id"]=> int(1) } ["attributes"]=> array(2) { [0]=> object(Id)#5 (0) { } [1]=> object(Validate)#6 (1) { ["rule"]=> enum(ValidateRuleEnum::PositiveIntA) } } }
54. • 同一プロパティ名に設定されたattributeは 先行する行が優先されます • これが後のSymfonyの話で活きてくる 複数のtraitで定義した(略 54
55. ドメインから見る trait
56. 決済ドメインに 適用してみます
57. 57 決済ドメインの定義 • 決済を代行する会社を決済代行会社とする • 決済代行会社の英名をGatewayとする • 具体的な決済手段を決済方法とする • 決済方法の英名をMethodとする
58. 58 カードマ～ン 決済代行会社 • 対応決済方法 • クレジットカード • IC払い • QR払い • 銀行払い • 後払い ビューン 決済代行会社 • 対応決済方法 • クレジットカード • IC払い • QR払い
59. 定義を特性として切り出すと 59
60. 60 特性を適用すると
61. 61 特性を適用すると
62. 62 実用シーンでは ViewNだけの ポイント発行処理を実施 クレジットカード共通として 月次に洗い替えを実施 決済代行会社、決済方法が 混在していても簡便に処理できる
63. 実用ではtraitと interfaceはセットで 扱ったほうがよいです
64. Symfonyとは
65. • DIコンテナを中心にHTTP処理をイベントで組み立てる フレームワーク • Laravelのようなフルスタック一体ではなく HTTP / CLI / DI / Event / Config を束ねる 実行環境がコアとしてふるまう • フレームワークを使うではなく、 DIコンテナ上にアプリを構築するイメージ • パフォーマンスの担保をruntimeではなく buildタイミングで最適化
66. Symfonyにおける コントローラと アクションの特徴
67. 階層的メタデータ 合成ができる
68. 68 階層的メタデータ 合成とはなにか • ここでは複数の階層に分散定義されたメタデータを 親→子の順に収集・統合、最終的な意味を構築する 手法と定義します
69. 69 pathやnameの定義 • pathやnameは次の順でメタデータが収集され 合成されます • Root（routes.yaml） • └ Controller • └ Action
70. 70 次の構成の場合… Root Controller Actions
71. 71 pathやnameの定義 • Root（routes.yaml） name:sample、path:/sample • └ Controller name: _sales_log、path:/sales-log • └ Action name: _index、path:
72. 72 これを合成すると…？ • name:sample_sales_log_index • path:/sample/sales-log
73. 73 オプションも合成できる • [ ‘title_root’ => ‘サンプル’, ‘title_section’ => ‘売り上げ’, ‘title_page’ => ‘一覧’, ] • title:サンプル – 売り上げ – 一覧
74. なるほど？？？
75. traitで切り出せるな？
76. 76 切り出してみた
77. あまりにも容易く動いた
78. 78 そう、こいつはtraitです
79. あま容易
80. I/Fが安定している ならば、以降traitの 使いまわしで終わる
81. それができれば 苦労はしねェ!!!
82. それはお前が やるんだよ！
83. 83 ということで ご用意したものがこちらです
84. • ControllerはHTTP I/O Controllerの仕事だけして いればいいと思うの • StorageアクセスなどはConfigクラスに丸投げ • 責務と特性を切り離すことにより柔軟性を確保
85. Symfony¥Bundle¥FrameworkBundle¥Controller¥ AbstractController ※必須：これを継承しないと何もできない class SalesLogController extends AbstractController ※ここで余計なものを挟み込めない Symfony Controllerの継承制約 abstract class AbstractAppController extends AbstractController ※一見共通化できたように見える abstract class SalesLogControllerr extends AbstractAppController ※特化共通基盤が必要になったら 特化ごとにAbstractが必要になる 特化が入れ子になったら…？
86. 86 Controllerの責務 HTTP I/O だけ面倒を見る
87. 87 Configの責務 Entityの操作やURLパラメータの構築など ページ固有のものだけ面倒見る
88. • 管理画面向けCRUDなどではI/Oは比較的安定する • そして固有の調整はまぁ要らない • ならば1テーブル、 1画面で割り切れば ConfigとTraitの使いまわしで開発終了 • しかも、今、動いているそのものなので、 当然不具合など出るよしもない
89. とはいっても？
90. updateやdelete どうするの？
91. 91 特性として切り出し さすがにaction引数は どうにもならん
92. 92 特性として切り出し ここだけはどうにも出来ません その代わり他を自動化
93. その自動化は 過剰では？
94. 手早く安定して 出せりゃいいので それ以上は適切に 特化してください
95. パス抽象化
96. • {{ config.current_path }}で現在のページのパスを得られます • つまり{{ path(config.current_path) }}で終わる もうこれでいちいちページごとにnameを書き換えることはない… • 同様に{{ path(config.getTemplatePathByAction(‘index’) }} • 更には{{ path( config.getPathByAction(‘update‘), param.from(entity).criteria ) }}などもできます Configの恩恵
97. • config.current_path => sample_sales_log • config.getTemplatePathByAction(‘read’) => sample_sales_log_read • config.getTemplatePath(‘payment_log’) => sample_payment_log_read • path( config.getPathByAction(‘update‘), param.from(entity).criteria ) => /sample/sales-log/1 /sample/sales-log(sample_sales_log) の場合
98. カラム特性
99. 99 どストレートに書くとこう プロパティ書いて アクセサー書いて
100. え、同じ意味を持つ 同じ定義をあとn回 書くんですか？？？
101. 101 カラムを特性として捉えたら？ ID定義 標準のColumn型と アクセサ
102. 102 全く同じ意味と意図を持つカラムを 安全かつ確実に定義 全く同じカラムであることを 言語レベルで保証 増設・撤去も容易
103. 103 特性と属性の特性 前述の通り、attributeは先勝ちです IDなどの特化attributeのみを先行して 読み込み 汎用的なカラム設定を後で読ませる ことで柔軟性を確保しています こちらが活きる なかったことになる こちらが活きる
104. 104 特性の集約 特性なので特性を集めて集約することも できます 結果、ひとまとまりで意味を持つものも 適切かつ簡便確実に扱うことができます
105. エンティティ アクセサ特性
106. 106 ドメインエンティティも めんどくさいですよね 共通化できるところを見つけてtraitへﾎﾟｲｰ
107. 最後に
108. • traitは構造で組み立てる言語機能 • Symfonyは構成で組み立てるフレームワーク
109. • 構成要素を特性として部品化でき • 枯れた部品の横展開として • 安全に再利用できるようになります この2つの特性を活かすと
110. “書かないことで品質を上げる”
111. • PHP Playgroundに大変助けられました。 https://php-play.dev/ • この環境がなければ色々厳しかったです。 この場を借りて御礼申し上げます。 • いつの間にかコード解析からの補完まで効くように なってた。最近触ってない人は触ってみましょう。 • というかCtrl + Shift + Lが使えるのが地味に強力過ぎる
112. • 2026年5月9日(土)にまたしても重文で開催される PHPカンファレンス香川2026に登壇します。 • 今度のネタはAI。 • 高松でお会いしましょう！