【PHP8.x】LengthException::getTraceAsString()メソッドの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ユーザー名の長さを検証するクラス
7 */
8class UserValidator
9{
10    private const MIN_LENGTH = 8;
11    private const MAX_LENGTH = 20;
12
13    /**
14     * ユーザー名の長さが有効かどうかをチェックします。
15     * 無効な場合は LengthException をスローします。
16     *
17     * @param string $username 検証するユーザー名
18     * @return void
19     * @throws LengthException ユーザー名の長さが範囲外の場合
20     */
21    public function validateUsernameLength(string $username): void
22    {
23        $length = strlen($username);
24        if ($length < self::MIN_LENGTH || $length > self::MAX_LENGTH) {
25            // 文字列の長さが不正なため、LengthExceptionをスローする
26            throw new LengthException(
27                sprintf(
28                    "ユーザー名は %d 文字以上 %d 文字以下である必要があります。",
29                    self::MIN_LENGTH,
30                    self::MAX_LENGTH
31                )
32            );
33        }
34    }
35
36    /**
37     * ユーザー登録処理を開始し、内部で検証を呼び出します。
38     *
39     * @param string $username 登録するユーザー名
40     * @return void
41     */
42    public function processRegistration(string $username): void
43    {
44        echo "ユーザー登録処理を開始します: " . $username . PHP_EOL;
45        $this->validateUsernameLength($username);
46        echo "ユーザー登録が成功しました。" . PHP_EOL;
47    }
48}
49
50$validator = new UserValidator();
51
52try {
53    // 例外が発生する短いユーザー名を渡す
54    $validator->processRegistration('bad');
55} catch (LengthException $e) {
56    echo "----------------------------------------" . PHP_EOL;
57    echo "エラーが発生しました。" . PHP_EOL;
58    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
59    echo "----------------------------------------" . PHP_EOL;
60    
61    // getTraceAsString() を使用して、例外発生箇所までの呼び出し履歴（スタックトレース）を文字列で取得し、表示する
62    // デバッグ時に、どこで、どのようにして例外が発生したかを追跡するのに役立ちます。
63    echo "スタックトレース:" . PHP_EOL;
64    echo $e->getTraceAsString();
65    echo PHP_EOL;
66    echo "----------------------------------------" . PHP_EOL;
67}
68

このPHPサンプルコードは、文字列の長さに関するエラーが発生した際に、その原因を追跡する方法を示しています。中心となるのは、LengthExceptionクラスのgetTraceAsString()メソッドです。

コード内のUserValidatorクラスは、ユーザー名の文字数が指定の範囲内（8文字以上20文字以下）であるかを検証します。もし範囲外の長さの文字列が渡されると、validateUsernameLengthメソッドはLengthExceptionという種類の例外（エラー）を意図的に発生させます。

プログラムの後半ではtry...catch構文を使用しています。tryブロック内でわざと短いユーザー名（'bad'）を検証させることで例外を発生させ、続くcatchブロックでその例外を捕捉しています。

catchブロックで受け取った例外オブジェクト（変数$e）に対して$e->getTraceAsString()を呼び出しています。このメソッドは引数を必要とせず、戻り値として「スタックトレース」を文字列形式で返します。スタックトレースとは、例外が発生するまでにプログラムがどのような順番で関数やメソッドを呼び出してきたかの履歴情報です。この情報を確認することで、エラーがどのファイルの何行目で、どのような呼び出し経路をたどって発生したのかを正確に知ることができ、デバッグ作業を効率的に進めるのに役立ちます。