PHPでResult型を なるべく使いやすい形で実装する

Transcript

1. PHPでResult型を なるべく使いやすい形で実装する @PHPカンファレンス福岡2025 ひがき
2. 話すこと • Result型とは • PHPStanについて本当に簡単に説明します • PHPで実装したコードの説明 • 僕がやった失敗
3. Result型とは？？
4. Result型 ある処理が「成功」したこと、あるいは「失敗」したことを表現する 関数結果にアクセスする前に、成功 or 失敗のチェックが必要 try-catchの例外処理に頼らないエラーハンドリングができる PHPではデフォルトで実装されていない
5. fn divide(a: f64, b: f64) -> Result<f64, String> { if b == 0.0 { Err("ゼロで割ることはできません ".to_string()) } else { Ok(a / b) } } // 呼び出し側 let result = divide(10.0, 0.0); if result.is_ok() { println!("結果: {:?}", result.unwrap()); } else { println!("エラー: {:?}", result.unwrap_err()); } /** * @return Result<float, string> */ function divide(float $a, float $b): Result { if ($b == 0.0) { return new Err("ゼロで割ることはできません "); } return new Ok($a / $b); } // 呼び出し側 $result = divide(10.0, 0.0); if ($result->isOk()) { echo "結果: " . $result->unwrap() . "\n"; } else { echo "エラー: " . $result->unwrapErr() . "\n"; } Rust PHP（僕の実装）
6. fn divide(a: f64, b: f64) -> Result<f64, String> { if b == 0.0 { Err("ゼロで割ることはできません ".to_string()) } else { Ok(a / b) } } // 呼び出し側 let result = divide(10.0, 0.0); if result.is_ok() { println!("結果: {:?}", result.unwrap()); } else { println!("エラー: {:?}", result.unwrap_err()); } /** * @return Result<float, string> */ function divide(float $a, float $b): Result { if ($b == 0.0) { return new Err("ゼロで割ることはできません "); } return new Ok($a / $b); } // 呼び出し側 $result = divide(10.0, 0.0); if ($result->isOk()) { echo "結果: " . $result->unwrap() . "\n"; } else { echo "エラー: " . $result->unwrapErr() . "\n"; } Rust PHP（僕の実装）
7. fn divide(a: f64, b: f64) -> Result<f64, String> { if b == 0.0 { Err("ゼロで割ることはできません ".to_string()) } else { Ok(a / b) } } // 呼び出し側 let result = divide(10.0, 0.0); if result.is_ok() { println!("結果: {:?}", result.unwrap()); } else { println!("エラー: {:?}", result.unwrap_err()); } /** * @return Result<float, string> */ function divide(float $a, float $b): Result { if ($b == 0.0) { return new Err("ゼロで割ることはできません "); } return new Ok($a / $b); } // 呼び出し側 $result = divide(10.0, 0.0); if ($result->isOk()) { echo "結果: " . $result->unwrap() . "\n"; } else { echo "エラー: " . $result->unwrapErr() . "\n"; } Rust PHP（僕の実装）
8. 各種エラーハンドリングの例 ※説明のために愉快なコードも出てきますが🙏
9. 1. try-catch 2. nullable 3. union型 4. Result 4つの例
10. 1. try-catch 2. nullable 3. union型 4. Result 4つの例
11. function completePayment(ProcessingPayment $payment): CompletedPayment { if ($payment->amount <= 0) { throw new PaymentAmountRuleError("Payment amount must be positive"); } return new CompletedPayment($payment->amount); } // 呼び出し側 try { $result = completePayment($payment); // ... 支払い完了時の処理 } catch (PaymentAmountRuleError $e) { // ... 支払金エラー時の処理 }
12. function completePayment(ProcessingPayment $payment): CompletedPayment { if ($payment->amount <= 0) { throw new PaymentAmountRuleError("Payment amount must be positive"); } return new CompletedPayment($payment->amount); } // 呼び出し側 try { $result = completePayment($payment); // ... 支払い完了時の処理 } catch (PaymentAmountRuleError $e) { // ... 支払金エラー時の処理 }
13. よくあるPHPの例外処理 • 複数のエラーパターンを例外で表現可能 • フローが複雑になりがち（GOTOみたい） try-catch
14. 1. try-catch 2. nullable 3. union型 4. Result 4つの例
15. function completePayment(ProcessingPayment $payment): ?CompletedPayment { if ($payment->amount <= 0) { return null; } return new CompletedPayment($payment->amount); } // 呼び出し側 $result = completePayment($payment); if ($result === null) { // ... 支払金エラー時の処理 } // ... 支払い完了時の処理
16. function completePayment(ProcessingPayment $payment): ?CompletedPayment { if ($payment->amount <= 0) { return null; } return new CompletedPayment($payment->amount); } // 呼び出し側 $result = completePayment($payment); if ($result === null) { // ... 支払金エラー時の処理 } // ... 支払い完了時の処理
17. 稀によく見る • シンプルで軽量 • PHP 7.1〜 • エラーの詳細情報が得られない • 複数のエラーパターンを区別できない nullable
18. 1. try-catch 2. nullable 3. union型 4. Result 4つの例
19. function completePayment(ProcessingPayment $payment): CompletedPayment|PaymentAmountRuleError { if ($payment->amount <= 0) { return new PaymentAmountRuleError("Payment amount must be positive"); } return new CompletedPayment($payment->amount); } // 呼び出し側 $result = completePayment($payment); if ($result instanceof PaymentAmountRuleError) { // ... 支払金エラー時の処理 } // ... 支払い完了時の処理
20. function completePayment(ProcessingPayment $payment): CompletedPayment|PaymentAmountRuleError { if ($payment->amount <= 0) { return new PaymentAmountRuleError("Payment amount must be positive"); } return new CompletedPayment($payment->amount); } // 呼び出し側 $result = completePayment($payment); if ($result instanceof PaymentAmountRuleError) { // ... 支払金エラー時の処理 } // ... 支払い完了時の処理
21. 成功も失敗も同列で扱う • 複数のエラーパターンを型で表現可能 • PHP 8.0 〜 • どの型が成功か失敗の判断が必要 union型
22. 1. try-catch 2. nullable 3. union型 4. Result 4つの例
23. /** * @return Result<CompletedPayment, PaymentAmountRuleError> */ function completePayment(ProcessingPayment $payment): Result { if ($payment->amount <= 0) { return new Err(new PaymentAmountRuleError("Payment amount must be positive")); } return new Ok(new CompletedPayment($payment->amount)); } // 呼び出し側 $result = completePayment($payment); if ($result->isErr()) { return match (true) { $result->unwrapErr() instanceof PaymentAmountRuleError::class => // ... 支払金エラー時の処理 } } // ... 支払い完了時の処理
24. /** * @return Result<CompletedPayment, PaymentAmountRuleError> */ function completePayment(ProcessingPayment $payment): Result { if ($payment->amount <= 0) { return new Err(new PaymentAmountRuleError("Payment amount must be positive")); } return new Ok(new CompletedPayment($payment->amount)); } // 呼び出し側 $result = completePayment($payment); if ($result->isErr()) { return match (true) { $result->unwrapErr() instanceof PaymentAmountRuleError::class => // ... 支払金エラー時の処理 } } // ... 支払い完了時の処理
25. 関数結果にアクセスする前に、成功 or 失敗のチェックが必要 • 複数のエラーパターンを型で表現可能 • 成功と失敗が明示的 • PHPStanなどの静的解析がないと辛い Result
26. PHPStanについて簡単に説明します
27. • PHPの静的解析ツール ◦ 未使用の変数や型の不一致などを発見してくれる ◦ @templeteでジェネリクスも使用できる • CLIで実行できる ◦ CIでチェックできる • レベルがある（0~10） ◦ 10になるほど型が厳密になっていく • baselineで既存のエラーを一旦無視もできる PHPStan
28. まずは触れて見たい人に本当におすすめ！！ tadsanのPHPStan型付けチュートリアル： [https://github.com/zonuexe/phpstan-typing-tutorial] PHPStan
29. PHPで実装したコードの説明
30. /** * @template T * @template E */ interface Result { // 各関数 } /** * @template E * @implements Result<never, E> */ final readonly class Err implements Result { /** * @param E $value */ public function __construct( private mixed $value, ) {} // エラー時の関数 } /** * @template T * @implements Result<T, never> */ final readonly class Ok implements Result { /** * @param T $value */ public function __construct( private mixed $value, ) {} // 成功時の関数 }
31. /** * @template E * @implements Result<never, E> */ final readonly class Err implements Result { // … public function isOk(): false { return false; } } /** * @template T * @implements Result<T, never> */ final readonly class Ok implements Result { // … public function isOk(): true { return true; } } /** * @template T * @template E */ interface Result { public function isOk(): bool; }
32. /** * @template E * @implements Result<never, E> */ final readonly class Err implements Result { // … public function isErr(): true { return true; } } /** * @template T * @implements Result<T, never> */ final readonly class Ok implements Result { // … public function isErr(): false { return false; } } /** * @template T * @template E */ interface Result { // … public function isErr(): bool; }
33. /** * @template E * @implements Result<never, E> */ final readonly class Err implements Result { // … } /** * @template T * @implements Result<T, never> */ final readonly class Ok implements Result { // … /** * @return T */ public function unwrap() { return $this->value; } } /** * @template T * @template E */ interface Result { // … }
34. /** * @template E * @implements Result<never, E> */ final readonly class Err implements Result { // ... /** * @return E */ public function unwrapErr() { return $this->value; } } /** * @template T * @implements Result<T, never> */ final readonly class Ok implements Result { // … } /** * @template T * @template E */ interface Result { // … }
35. /** * @template E * @implements Result<never, E> */ final readonly class Err implements Result { // ... /** * @template D * @param D $default * @return D */ public function unwrapOr(mixed $default) { return $default; } } /** * @template T * @implements Result<T, never> */ final readonly class Ok implements Result { // ... /** * @template D * @param D $default * @return T */ public function unwrapOr(mixed $default) { return $this->value; } } /** * @template T * @template E */ interface Result { // ... /** * @template D * @param D $default * @return ($this is Result<T, E> ? T|D : ($this is Result<never, E> ? D : T)) */ public function unwrapOr(mixed $default); }
36. /** * @return Result<CompletedPayment, PaymentAmountRuleError> */ function completePayment(ProcessingPayment $payment): Result { if ($payment->amount <= 0) { return new Err(new PaymentAmountRuleError("Payment amount must be positive")); } return new Ok(new CompletedPayment($payment->amount)); } // 呼び出し側 $result = completePayment($payment); if ($result->isErr()) { return match (true) { $result->unwrapErr() instanceof PaymentAmountRuleError::class => // ... 支払金エラー時の処理 } } // ... 支払い完了時の処理 使い方
37. /** * @return Result<CompletedPayment, PaymentAmountRuleError> */ function completePayment(ProcessingPayment $payment): Result { if ($payment->amount <= 0) { return new Err(new PaymentAmountRuleError("Payment amount must be positive")); } return new Ok(new CompletedPayment($payment->amount)); } // 呼び出し側 $result = completePayment($payment); if ($result->isErr()) { return match (true) { $result->unwrapErr() instanceof PaymentAmountRuleError::class => // ... 支払金エラー時の処理 } } // ... 支払い完了時の処理 使い方
38. 僕がやった失敗（こうすればよりいい感じ）
39. • エラーが一つしか返せない • 型のNarrowingできてなかった • IDEがメソッドを補完してくれない 僕がやった失敗
40. • エラーが一つしか返せない • 型のNarrowingできてなかった • IDEがメソッドを補完してくれない 僕がやった失敗
41. エラーが一つしか返せない ❌ 一つのエラーしか返却できない 失敗時のジェネリクスで @templateを使用 ⭕ 複数のエラーを返却できる 失敗時のジェネリクスで @template-covariantを使用 /** * @template E * @implements Result<never, E> */ final readonly class Err implements Result /** * @template-covariant E * @implements Result<never, E> */ final readonly class Err implements Result
42. エラーが一つしか返せない /** * @template E */
43. エラーが一つしか返せない /** * @template-covariant E */
44. エラーが一つしか返せない https://phpstan.org/blog/whats-up-with-template-covariant
45. エラーが一つしか返せない https://phpstan.org/blog/whats-up-with-template-covariant @templateでは、 返り値に部分集合は返せない @return Result<*, FugaException|HogeException> ⭕Result<*, FugaException|HogeException> ❌Result<*, FugaException> ❌Result<*, HogeException>
46. エラーが一つしか返せない @template 非変 @template-contravariant 反変 引用：PHPDocを使ったPHPのジェネリクス[https://www.phper.ninja/entry/2020/03/01/054833] 引数の型は反変(contravariant)でなくてはならない 戻り値は共変(covariant)でなくてはならない @template-covariant 共変 引用： PHPマニュアル[https://www.php.net/manual/ja/language.oop5.variance.php] 共変性とは、子クラスのメソッドが、親クラスの戻り値よりも、より特定の、狭い型を返すことを許すことです。 反変性とは、親クラスのものよりも、より抽象的な、広い型を引数に指定することを許すものです。
47. • エラーが一つしか返せない • 型のNarrowingできてなかった • IDEがメソッドを補完してくれない 僕がやった失敗
48. 型のNarrowingできてなかった ❌ 型のNarrowingできない ⭕ 型のNarrowingできる interface Result { public function isOk(): bool; } interface Result { /** * @phpstan-assert-if-true Ok<T> $this * @phpstan-assert-if-false Err<E> $this */ public function isOk(): bool; }
49. 型のNarrowingできてなかった ❌ 型のNarrowingできない ⭕ 型のNarrowingできる
50. 型のNarrowingできてなかった ❌ 型のNarrowingできない ⭕ 型のNarrowingできる Result<TaskTitle, InvalidTaskTitleException> Ok<TaskTitle>
51. • エラーが一つしか返せない • 型のNarrowingできてなかった • IDEがメソッドを補完してくれない 僕がやった失敗
52. 前提 IDEを前提とします。 vimとかemacsとかワイ使えないので🙏 IDEがメソッドを補完してくれない
53. IDEがメソッドを補完してくれない 推論してくれない interface Result { public function isOk(): bool; public function isErr(): bool; public function unwrapOr(mixed $default); } PHPDocは 省略してます
54. IDEがメソッドを補完してくれない
55. IDEがメソッドを補完してくれない キーボード カタカタ
56. Okクラスにunwrap()が実装されているので正しく動く （PHPStanのエラーもない） 今のままでも良いが、 😖 補完してくれないと個人的に使いにくい Resultとunwrapが結びつかない人は大変、、、 IDEがメソッドを補完してくれない
57. IDEがメソッドを補完してくれない 推論してくれない interface Result { public function isOk(): bool; public function isErr(): bool; public function unwrapOr(mixed $default); } PHPDocは 省略してます
58. IDEがメソッドを補完してくれない 推論してくれない 推論してくれる interface Result { public function isOk(): bool; public function isErr(): bool; public function unwrapOr(mixed $default); } interface Result { public function isOk(): bool; public function isErr(): bool; public function unwrap(); public function unwrapErr(); public function unwrapOr(mixed $default); } PHPDocは 省略してます PHPDocは 省略してます
59. /** * @template E * @implements Result<never, E> */ final readonly class Err implements Result { // … } /** * @template T * @implements Result<T, never> */ final readonly class Ok implements Result { // … /** * @return T */ public function unwrap() { return $this->value; } } /** * @template T * @template E */ interface Result { // … }
60. /** * @template E * @implements Result<never, E> */ final readonly class Err implements Result { // … /** * @return never */ public function unwrap() { throw new LogicException('called Result->unwrap() on an err value'); } } /** * @template T * @implements Result<T, never> */ final readonly class Ok implements Result { // … /** * @return T */ public function unwrap() { return $this->value; } } /** * @template T * @template E */ interface Result { // … public function unwrap() }
61. /** * @template E * @implements Result<never, E> */ final readonly class Err implements Result { // ... /** * @return E */ public function unwrapErr() { return $this->value; } } /** * @template T * @implements Result<T, never> */ final readonly class Ok implements Result { // … } /** * @template T * @template E */ interface Result { // … }
62. /** * @template E * @implements Result<never, E> */ final readonly class Err implements Result { // ... /** * @return E */ public function unwrapErr() { return $this->value; } } /** * @template T * @implements Result<T, never> */ final readonly class Ok implements Result { // … /** * @return never */ public function unwrapErr() { throw new LogicException('called Result->unwrapErr() on an ok value'); } } /** * @template T * @template E */ interface Result { // … public function unwrapErr() }
63. IDEがメソッドを補完してくれない 補完してくれるようになった
64. ☺ IDEが補完してくれるようになった 😖 isOk()の中でunwarpErr()を呼び出すのはマズイ 使いやすさと正しさのいいところどりしたい • 補完できる • 適切でない使い方をしたら知らせてくれる IDEがメソッドを補完してくれない
65. ☺ IDEが補完してくれるようになった 😖 isOk()の中でunwarpErr()を呼び出すのはマズイ 使いやすさと正しさのいいところどりしたい • 補完できる • 適切でない使い方をしたら知らせてくれる IDEがメソッドを補完してくれない
66. IDEがメソッドを補完してくれない いい感じにしたい！ interface Result { // … public function unwrap(); }
67. IDEがメソッドを補完してくれない いい感じにしたい！ interface Result { // … /** * @return ($this is Result<T, never> ? T : never) */ public function unwrap(); }
68. IDEがメソッドを補完してくれない いい感じにしたい！ interface Result { // … /** * @return ($this is Result<T, never> ? T : never) */ public function unwrap(); } Okの時 Tが返却される
69. IDEがメソッドを補完してくれない いい感じにしたい！ interface Result { // … /** * @return ($this is Result<T, never> ? T : never) */ public function unwrap(); } Ok以外の時 neverが返却される （throwされる）
70. IDEがメソッドを補完してくれない 成功時に成功時の値を取り出す 適切な使い方の時 何もエラーが 表示されていない
71. IDEがメソッドを補完してくれない 成功時に失敗時の値を取り出す 適切な使い方でない時 PHPStanがエラーで知 らせてくれる
72. IDEがメソッドを補完してくれない 適切な使い方でない時 PHPStanがエラーで知 らせてくれる 成功 or 失敗をチェックしないで成功時の値を取り出す
73. ⚠⚠⚠注意点⚠⚠⚠ neverによる不到達チェックなので、 不適切な使い方の行でなく、その次の行がエラーとして表示される IDEがメソッドを補完してくれない
74. ⚠⚠⚠注意点⚠⚠⚠ neverによる不到達チェックなので、 不適切な使い方の行でなく、その次の行がエラーとして表示される IDEがメソッドを補完してくれない 返り値はResultを期待してい る
75. ⚠⚠⚠注意点⚠⚠⚠ neverによる不到達チェックなので、 不適切な使い方の行でなく、その次の行がエラーとして表示される IDEがメソッドを補完してくれない phpstan的にneverが返る 返り値はResultを期待してい る
76. ⚠⚠⚠注意点⚠⚠⚠ neverによる不到達チェックなので、 不適切な使い方の行でなく、その次の行がエラーとして表示される IDEがメソッドを補完してくれない phpstan的にneverが返る 返り値はResultを期待してい る しかし、警告は出てくれない
77. neverが返却されても警告出してくれないんだ！ 全ての他の型の部分型だから警告ださないのね IDEがメソッドを補完してくれない never は、 型理論の用語で言うと、ボトム型にあたります。 つまり、全ての他の型の部分型であり、 継承する際に他の戻り値の型を置き換える ことができます。 引用：PHPマニュアル[https://www.php.net/manual/ja/language.types.never.php]
78. 😖妥協案（IDE依存でコードが嘘をつくから個人的にNotLike） 「基本的に返り値になりえないもの（ LogicExceptionなど） も返却の型に含める」 ※もっと良いやり方など懇親会でお話したいです🙏 IDEがメソッドを補完してくれない
79. IDEがメソッドを補完してくれない interface Result { // … /** * @return ($this is Result<T, never> ? T : never) */ public function unwrap(); }
80. IDEがメソッドを補完してくれない interface Result { // … /** * @return ($this is Result<T, never> ? T : LogicException&never) */ public function unwrap(); }
81. IDEがメソッドを補完してくれない 成功 or 失敗をチェックしないで成功時の値をそのまま返却する IDEが指摘してくれる
82. まとめ
83. Result型 ある処理が「成功」したこと、あるいは「失敗」したことを表現する 関数結果にアクセスする前に、成功 or 失敗のチェックが必要 PHPStanを使えば、PHPでも実装できる 個人的に型のNarrowing や 複数のエラーを返せる形で実装すると使いや すい
84. 自己紹介 ひがき 愛媛 → 兵庫 → 福岡 → 東京 福岡は約2年住んでました！！ 大好きな街！！！ カンファレンス初参加は 「PHPカンファレンス福岡2023」 人生変わりました（本当に！！）
85. ひがき 🍊PHPConference愛媛2026 実行委員長🐘 PHPConference愛媛2026開催！！ • 2026年10月3日 • 愛媛県松山市 自己紹介
86. ご静聴ありがとうございました