What We Can Learn From OSS

『OSSから学ぶ技術』

PHPカンファレンス小田原
2024-04-13 18:00〜 かま
https://phpcon-odawara.jp/

Transcript

1. OSSから学ぶ技術 2024/04/13 PHPカンファレンス小田原 2024 LT
2. 2 • Hiroki Inoue • Software Engineer • Engineering Manager @ WHITEPLUS, Inc. About Me
3. 3 トーク概要 このトークでは、OSSから学べることの具体例を共有します。留意事項を添えて。 このトークではOSSから学ぶということの解像度をあげることを目指します。スキルアップへの引き出 しが一つ増えれば幸いです。 https://fortee.jp/phpconodawara-2024/proposal/134c1420-4a6a-40e0-b3d7-afd527c1168f
4. 4 誰向けのトーク？
5. 5 あなた （お約束）
6. 6 あるいは • 技術の学び方を模索されている方 • “OSSに触れるとよい”的な言説にピンとこない方、懐疑的な方 • OSSについて語りたい方（懇親会で聞かせて下さい！！）
7. 7 あるいは • 技術の学び方を模索されている方 • “OSSに触れるとよい”的な言説にピンとこない方、懐疑的な方 • OSSについて語りたい方（懇親会で聞かせて下さい！！）
8. 8 免責事項
9. 9 趣味・趣向・知識 が 静的解析に偏っています
10. 10 私見に満ちたトークです
11. 11 前置き
12. 12 “読む”に向かう 2つのスタイル
13. 13 1. 目的読み
14. 14 2. 衝動読み
15. 15 1. 目的読み 明確な目的を持って読むパターン
16. 16 1. 目的読み 例えば • 作り手の視点 ◦ 〇〇という機能を作る参考にしたい • 使用者の視点 ◦ 挙動（仕様）を確かめたい
17. 17 2. 衝動読み 気になるOSSをなんとなしに読みふけるパターン
18. 18 学びの例
19. 19 デザインパターン の実用例
21. 21 概念はわかった気がする
22. 22 でもどうやって使うの？
23. 23 💡具体例から学ぼう💡
24. 24 Object-Oriented Conference 2024公式ガイドブック（https://booth.pm/ja/items/5596314）第13章 • ストラテジパターン@PHPUnit • オブザーバパターン@Laravel • ビジターパターン@PHP-Parser etc.
25. 25 理論、原則、基礎の類は 教科書から
26. 26 実践知はプロダクトから
27. 27 ちなみに • 〇〇パターンを探そうとして見つけたわけではない。 • 色々読んでるうちに偶然見つけた。
28. 28 目的読みには 目的外の収穫もある
29. 29 PHPでも並列処理したい
30. 30 ReactPHPがあるじゃない
31. 31 でもどうやって使うの？
32. 32 チュートリアルだけじゃ 心許ない
33. 33 PHPStanがあるじゃない
34. 34 生きた事例
35. 35 稼働実績のある信頼感
36. 36 といいつつ盲信するなかれ
37. 37 CLIツールが作りたい
38. 38 作りたい物の既存実装を探す という視点
39. 39 コマンドライン入力 一つとっても実はちょっと奥が深い
40. 40 PHP Parser $ ./vendor/bin/php-parse file.php -r --var-dump
41. 41 PHP Parser $ ./vendor/bin/php-parse file.php -r --var-dump $argv[1] $argv[2] $argv[3] $argv[0]
42. 42 PHP Parser $ ./vendor/bin/php-parse file.php -r --var-dump $argv[1] $argv[2] $argv[3] $argv[0] 配列という名のフリーダム
43. operations、ファイル名、PHPのコード（テキスト）が入力される。 • 形式は様々 ◦ php-parse ◦ -d ◦ --dump ◦ file.php ◦ "<?php code" • 複数入力されうるし入力されないこともある • 順不同 43 コマンドラインインタフェースが持つ複雑さとは
44. 44 様々な入力パターンを 想定する必要がある 要するに
45. 45 PHP Parser list($operations, $files, $attributes) = parseArgs($argv); https://github.com/nikic/PHP-Parser/blob/46be4560c4cd4bab2b74882c0da39a4548a5cfbe/bin/php-parse
46. 46 PHP Parser － parseArgs() function parseArgs($args) { // 略 foreach ($args as $arg) { // 引数を評価（後述） } return [$operations, $files, $attributes]; } https://github.com/nikic/PHP-Parser/blob/46be4560c4cd4bab2b74882c0da39a4548a5cfbe/bin/php-parse
47. 47 PHP Parser － parseArgs() function parseArgs($args) { // 略 foreach ($args as $arg) { // 引数を評価（後述） } return [$operations, $files, $attributes]; } https://github.com/nikic/PHP-Parser/blob/46be4560c4cd4bab2b74882c0da39a4548a5cfbe/bin/php-parse
48. 48 PHP Parser － parseArgs() function parseArgs($args) { // 略 foreach ($args as $arg) { // 引数を評価（後述） } return [$operations, $files, $attributes]; } https://github.com/nikic/PHP-Parser/blob/46be4560c4cd4bab2b74882c0da39a4548a5cfbe/bin/php-parse
49. 49 PHP Parser － parseArgs() switch ($arg) { case '--dump': case '-d': $operations[] = 'dump'; break; case '--with-column-info': case '-c'; $attributes['with-column-info'] = true; break; https://github.com/nikic/PHP-Parser/blob/46be4560c4cd4bab2b74882c0da39a4548a5cfbe/bin/php-parse
50. 50 PHP Parser － parseArgs() default: if (preg_match('/^--version=(.*)$/', $arg, $matches)) { $attributes['version'] = PhpParser\PhpVersion::fromString($matches[1]); } elseif ($arg[0] === '-' && \strlen($arg[0]) > 1) { showHelp("Invalid operation $arg."); } else { $files[] = $arg; } https://github.com/nikic/PHP-Parser/blob/46be4560c4cd4bab2b74882c0da39a4548a5cfbe/bin/php-parse
51. 51 ちなみに PHPStan の場合 https://symfony.com/doc/current/components/console.html Symfony Console Componentを使用している。
52. 52 PHPStan － bin/phpstan $application = new \Symfony\Component\Console\Application( 'PHPStan - PHP Static Analysis Tool', ComposerHelper::getPhpStanVersion() ); // 略 $application->run();
53. 53 巨人も巨人の肩に乗っている
54. 54 巨人を通じて別の巨人を知る
55. 55 プログレスバー
57. 57 ところで 人は安心を得るために生きる らしい
58. 58 進捗報告は安心の素 という説があるらしい
59. 59 PHPStan $preFileCallback = null; $postFileCallback = static function (int $step) use ($errorOutput): void { $errorOutput->getStyle()->progressAdvance($step); }; $errorOutput->getStyle()->progressStart($allAnalysedFilesCount); $errorOutput->getStyle()->progressAdvance($allAnalysedFilesCount - $filesCount); // 略 if (!$debug) { $errorOutput->getStyle()->progressFinish(); } https://github.com/phpstan/phpstan-src/blob/9bb4ef961960a1056060209b3ed7e09b93c06f36/src/Command/AnalyseApplication.php
60. 60 PHPStan $preFileCallback = null; $postFileCallback = static function (int $step) use ($errorOutput): void { $errorOutput->getStyle()->progressAdvance($step); }; $errorOutput->getStyle()->progressStart($allAnalysedFilesCount); $errorOutput->getStyle()->progressAdvance($allAnalysedFilesCount - $filesCount); // 略 if (!$debug) { $errorOutput->getStyle()->progressFinish(); } https://github.com/phpstan/phpstan-src/blob/9bb4ef961960a1056060209b3ed7e09b93c06f36/src/Command/AnalyseApplication.php
61. 61 プログレスバーの実装方法 1. progressStart() して 2. progressAdvance() を繰り返して 3. progressFinish() する
62. 62 実はこれも
63. 63 Symfony https://symfony.com/doc/current/console/style.html#symfony-style-progressbar きょじん
64. 64 其れ、PHPUnitにもあるよね プログレスバー
66. 66 実装の違いを愉しむ という道もある
67. 67 実装の違いから学ぶ
68. 68 autoload の実装の違い
69. 69 autoloadが持つ複雑性とは 開発環境 . ├─ bin │ └─ my-cli └─ vendor └─ autoload.php プロダクション環境 . └─ vendor ├─ autoload.php └─ repository-name └─ package-name └─ bin └─ my-cli __DIR__ . '/../vendor/autoload.php' __DIR__ . '/../../../autoload.php'
70. 70 PHP Parser https://github.com/nikic/PHP-Parser/blob/46be4560c4cd4bab2b74882c0da39a4548a5cfbe/bin/php-parse foreach ([__DIR__ . '/../../../autoload.php', __DIR__ . '/../vendor/autoload.php'] as $file) { if (file_exists($file)) { require $file; break; } }
71. 71 Rector public function includeDependencyOrRepositoryVendorAutoloadIfExists() : void { $this->loadIfExistsAndNotLoadedYet(__DIR__ . '/../vendor/autoload.php'); } public function autoloadProjectAutoloaderFile() : void { $this->loadIfExistsAndNotLoadedYet(__DIR__ . '/../../../autoload.php'); } public function autoloadRectorInstalledAsGlobalDependency() : void { $this->loadIfExistsAndNotLoadedYet('vendor/autoload.php'); } https://github.com/rectorphp/rector/blob/11b9220a05ee3c1bcaa75d76c8b5e5baa8d01484/bin/rector.php ※大部分を省略しています
72. 72 getNodeTypes() の実装の違い
73. 73 getNodeTypes() is 何？ とある静的解析ツールにおいて 解析対象のノードを特定するメソッド
74. 74 getNodeTypes() • PHPStanとRectorが同じコンセプトの機構を持っているが、詳細が異なる。
75. 75 getNodeTypes()の違い PHPStan public function getNodeType(): string { return ClassMethod::class; } Rector public function getNodeTypes(): array { return [ClassMethod::class]; }
76. 76 getNodeTypes()の違い PHPStan[1] public function getNodeType(): string { return ClassMethod::class; } Rector[2] public function getNodeTypes(): array { return [ClassMethod::class]; } 1. https://github.com/phpstan/phpstan-src/blob/3d43198f80f47da6fee60fb3d86ae004eee41f13/src/Rules/Methods/MethodAttributesRule.php 2. https://github.com/rectorphp/rector/blob/0e57251e460fb68e7ad8e1fdd0467e9db6ca82c8/rules/Php80/Rector/ClassMethod/SetStateToStaticRector.php PHPStanは1つ、Rectorは複数のノードを指定できるが、この裏側にあるメカニズムに違いがある。 （詳細はリンク先のコードを辿るなどして下さいmm）
77. 77 getNodeTypes()の違い超概要 • PHPStanはノード毎にルールを対応づける。 $rules[$rule->getNodeType()][] = $rule; • Rectorはトラバース中にノードをスキップする。 private function isMatchingNodeType(string $nodeClass) : bool { foreach ($this->getNodeTypes() as $nodeType) { if (\is_a($nodeClass, $nodeType, \true)) { return \true; } } return \false; }
78. 78 トラバースって何？？ 参考資料 • 『PHP Parserで学ぶPHP』[1] • 『PHP Parserで学ぶPHPと静的解析』[2] • 『木を見て！森を見て！目で見てわかるAST（抽象構文木）』[3] 1. https://speakerdeck.com/inouehi/php-parserdexue-buphp 2. https://speakerdeck.com/inouehi/learning-php-and-static-analysis-with-php-parser 3. https://speakerdeck.com/inouehi/understanding-ast-by-looking
79. 79 ところで トラーバスでノードを総当たりしつつも不要なノードはスキップするという機構が 個人的にはなるほどポイントでもありました。 public final function enterNode(\PhpParser\Node $node) { $nodeClass = \get_class($node); if (!$this->isMatchingNodeType($nodeClass)) { // スキップ return null; } // 略 $node = $this->refactor($node); // リファクタを実行
80. 80 名もなき断片にも学びがある
81. 81 イディオムを引き出しにしまう
82. 82 インタフェースのデフォルト実装 というイディオム
83. 83 PHP Parserのビジター • トラバーサ… ノードを一つずつ辿る。 • ビジター … ノードを処理する。
84. 84 ビジターって何？？ 参考資料 • 『PHP Parserで学ぶPHP』[1] • 『PHP Parserで学ぶPHPと静的解析』[2] • 『木を見て！森を見て！目で見てわかるAST（抽象構文木）』[3] 1. https://speakerdeck.com/inouehi/php-parserdexue-buphp 2. https://speakerdeck.com/inouehi/learning-php-and-static-analysis-with-php-parser 3. https://speakerdeck.com/inouehi/understanding-ast-by-looking
85. 85 PHP Parserのビジター ビジターはNodeVisitorを実装する。 ※メソッドを抜粋 interface NodeVisitor { public function beforeTraverse(array $nodes); public function enterNode(Node $node); public function leaveNode(Node $node); public function afterTraverse(array $nodes); }
86. 86 PHP Parserのビジター ビジターはNodeVisitorを実装する。あるいはNodeVisitorAbstractを拡張する。 デフォルト実装 を担っている
87. 87 PHP Parserのビジター － NodeVisitorAbstract abstract class NodeVisitorAbstract implements NodeVisitor { public function beforeTraverse(array $nodes) { return null; } public function enterNode(Node $node) { return null; } public function leaveNode(Node $node) { return null; } public function afterTraverse(array $nodes) { return null; } }
88. 88 PHP Parserのビジター － NodeVisitorAbstract 抽象クラスにデフォルト実装を宣言しておくことで、 例えばenterNode()だけを実装したい時、その他のメソッドの実装を省ける。
89. 89 （再）目的読みには 目的外の収穫もある
90. 90 目的外の収穫を求めて 目的を作ってみてはどうか？！
91. 91 留意事項
92. 92 1. OSSにただ触れるだけで技術が身につくわけではない。
93. 93 1. OSSにただ触れるだけで技術が身につくわけではない。 ◦ 設計の技法、コンセプトに気づくにも教養的なものが必要。
94. 94 1. OSSにただ触れるだけで技術が身につくわけではない。 ◦ 設計の技法、コンセプトに気づくにも教養的なものが必要。 ◦ 技術書や、人との議論等からナレッジを摂取しておくことで、抽象や概念と具体が繋がる。 その時腹落ちして使いこなせる状態に近づく。
95. 95 2. 実践知と言ったものの、その実装が常に最適とは限らない。 ◦ 1次情報で裏取りする、学びをアップデートするなど、基盤となる所作は忘れずに。
96. 96 3. 誰かにとっての学びが他の誰かにとっても学びであるとは限らない。逆も真。
97. 97 3. 誰かにとっての学びが他の誰かにとっても学びであるとは限らない。逆も真。 ◦ 自分の目でも確かめることに価値がありそう。
98. 98 まとめ
99. 99 • OSSは、デザインパターンやイディオムの宝箱 • あるいは、理論、原則、基礎の実践的事例 • 同じコンセプトにも異なる実装がありえる • ただし、その実装が常に最適とは限らない • 実践知に気づくには、ベースとなる教養を育むことも重要 • 目的があるととっつきやすく、目的外の収穫もある • 目的外の収穫≒セレンデピティ（偶然得られた幸運）を増やすには機会を増やすこと
100. 100 目的外の収穫を求めて 目的を作ってみてはどうか？！
101. 101 おわりに
102. 102 自分なんかはむしろOSSとの関わりがまだ浅い方だと自認しています。 今回、OSS初心者目線で学びについてお話しました。 目線が違えば視界も変わると思います。
103. 103 • このトークが物足りないと感じた方へ
104. 104 • このトークが物足りないと感じた方へ ◦ あなたの学び、気づき（の流儀）を教えて下さい！！
105. 105 • いいね👍と感じた方へ ◦ 推しのOSS（からの学び）を教えて下さい！！
106. ご清聴ありがとうございました