Wyjątki w PHP: throw i własne klasy wyjątków

Wyjątek w PHP rzucasz przez throw new Exception('message');. Wykonanie zatrzymuje się w tej linii i przeskakuje do najbliższego bloku catch, który akceptuje typ wyjątku, gdzie $e->getMessage() zwraca komunikat. Używaj konkretnej klasy, takiej jak InvalidArgumentException, aby wywołujący mogli rozróżniać problemy.

<?php
function setQuantity(int $qty): string
{
    if ($qty < 1) {
        throw new InvalidArgumentException("Quantity must be at least 1, got $qty");
    }
    return "Quantity set to $qty";
}

try {
    echo setQuantity(3), "\n";
    echo setQuantity(0), "\n";
} catch (InvalidArgumentException $e) {
    echo 'Rejected: ', $e->getMessage(), "\n";
}

Wyjątek jest obiektem. throw przekazuje go w górę stosu wywołań do pierwszego wywołującego z pasującym catch, a ten decyduje, co zrobić; funkcja, która znalazła problem, nie musi tego wiedzieć. Mechanikę przechwytywania, finally i łapanie kilku typów opisuje strona try catch.

Co zawiera obiekt wyjątku

Każdy wyjątek niesie komunikat, kod całkowity, plik i linię, w której go utworzono, oraz ślad stosu. Konstruktor przyjmuje ($message, $code, $previous), wszystkie opcjonalne:

<?php
function findOrder(int $id): array
{
    throw new RuntimeException("Order $id not found", 404);
}

try {
    findOrder(77);
} catch (RuntimeException $e) {
    echo 'Class:   ', get_class($e), "\n";
    echo 'Message: ', $e->getMessage(), "\n";
    echo 'Code:    ', $e->getCode(), "\n";
    echo 'File:    ', basename($e->getFile()), "\n";
    echo 'Line:    ', $e->getLine(), "\n";
    echo "Trace:\n", $e->getTraceAsString(), "\n";
}

getLine() to linia throw new, a nie linia catch. Ślad wymienia wywołania, które tam doprowadziły (#0 /home/index.php(8): findOrder()), i zwykle to pierwsza rzecz do przeczytania, gdy błąd pojawi się w logu. Rzutowanie wyjątku na string (echo $e; albo (string) $e) wypisuje to wszystko w standardowym formacie PHP.

Wbudowane klasy wyjątków

PHP ma rodzinę klas wyjątków w Standard PHP Library (SPL). Rzucanie tej, która nazywa problem, sprawia, że kod czyta się lepiej, a wywołujący mogą łapać wąsko. Wszystkie rozszerzają Exception:

InvalidArgumentException, DomainException, LengthException i OutOfRangeException rozszerzają LogicException; OutOfBoundsException, RangeException i UnexpectedValueException rozszerzają RuntimeException. Rodziców dowolnej klasy możesz sprawdzić sam:

<?php
foreach ([InvalidArgumentException::class, RangeException::class, JsonException::class, TypeError::class] as $class) {
    echo $class, ' -> ', implode(' -> ', class_parents($class)), "\n";
}

$e = new OutOfRangeException('Index 9 is out of range');
var_dump($e instanceof LogicException, $e instanceof RuntimeException, $e instanceof Throwable);

TypeError ma jako rodzica Error, a nie Exception: należy do drugiej rodziny, opisanej niżej.

Błędy rzucane przez samo PHP

Od PHP 7, a jeszcze bardziej od PHP 8, własne funkcje i operatory PHP rzucają podklasy Error dla problemów, które kiedyś były ostrzeżeniami. Łapiesz je tak samo, ale catch (Exception $e) do nich nie pasuje:

<?php
declare(strict_types=1);

$cases = [
    'intdiv by zero'  => fn () => intdiv(10, 0),
    'modulo by zero'  => fn () => 7 % 0,
    'wrong arg type'  => fn () => str_repeat(5, 2),
    'invalid value'   => fn () => array_fill(0, -1, 'x'),
    'too few args'    => fn () => (fn (int $a, int $b) => $a + $b)(1),
    'no match arm'    => fn () => match (99) { 1 => 'one', 2 => 'two' },
    'undefined func'  => fn () => undefined_function(),
];

foreach ($cases as $label => $run) {
    try {
        $run();
    } catch (Error $e) {
        printf("%-16s %-22s %s\n", $label, get_class($e), $e->getMessage());
    }
}

DivisionByZeroError, TypeError, ValueError, ArgumentCountError, UnhandledMatchError i zwykły Error rozszerzają Error. Każdy z nich częściej oznacza błąd w kodzie wywołującym niż złe dane, dlatego leżą poza drzewem Exception. To declare(strict_types=1) sprawia, że str_repeat(5, 2) jest TypeError; bez tego PHP zamieniłoby 5 na "5".

Własna klasa wyjątku

Często wystarczy jednolinijkowa podklasa: sama nazwa klasy niesie znaczenie, a wywołujący mogą łapać dokładnie ten typ. Gdy łapiący potrzebuje danych (jakie zamówienie, jaka kwota), dodaj właściwości i przekaż komunikat wyżej przez parent::__construct():

<?php
class PaymentException extends RuntimeException {}

class InsufficientFundsException extends PaymentException
{
    public function __construct(
        public readonly int $balanceCents,
        public readonly int $neededCents,
    ) {
        parent::__construct(sprintf(
            'Insufficient funds: balance %.2f, needed %.2f',
            $balanceCents / 100,
            $neededCents / 100,
        ), 402);
    }

    public function shortfall(): int
    {
        return $this->neededCents - $this->balanceCents;
    }
}

function pay(int $balance, int $amount): string
{
    if ($amount > $balance) {
        throw new InsufficientFundsException($balance, $amount);
    }
    return 'paid';
}

try {
    echo pay(5000, 1200), "\n";
    echo pay(5000, 8000), "\n";
} catch (InsufficientFundsException $e) {
    echo $e->getMessage(), "\n";
    echo 'Top up at least ', $e->shortfall() / 100, " EUR (code {$e->getCode()})\n";
} catch (PaymentException $e) {
    echo 'Payment failed: ', $e->getMessage(), "\n";
}

Rodzica wybieraj starannie: rozszerzenie RuntimeException (zamiast zwykłego Exception) oznacza, że kod łapiący RuntimeException obsłuży też twój wyjątek. Mała hierarchia, jeden bazowy wyjątek na bibliotekę lub moduł z konkretnymi podklasami pod nim, pozwala wywołującym wybierać między „łap wszystko z płatności” a „łap tylko ten jeden przypadek”.

Łańcuch wyjątków przez previous

Gdy łapiesz niskopoziomowy wyjątek i rzucasz wysokopoziomowy, przekaż oryginał jako trzeci argument. Nic nie ginie: getPrevious() cofa się do pierwotnej przyczyny.

<?php
class ImportException extends RuntimeException {}

function parseRow(string $line, int $n): array
{
    $cols = str_getcsv($line);
    if (count($cols) !== 3) {
        throw new UnexpectedValueException("row $n has " . count($cols) . ' columns, expected 3');
    }
    return $cols;
}

function import(array $lines): int
{
    foreach ($lines as $i => $line) {
        try {
            parseRow($line, $i + 1);
        } catch (UnexpectedValueException $e) {
            throw new ImportException('customers.csv could not be imported', 0, $e);
        }
    }
    return count($lines);
}

try {
    import(['Ada,ada@example.com,UK', 'Linus,linus@example.com']);
} catch (ImportException $e) {
    $level = 0;
    for ($x = $e; $x !== null; $x = $x->getPrevious()) {
        echo str_repeat('  ', $level++), get_class($x), ': ', $x->getMessage(), "\n";
    }
}

Użytkownik widzi „customers.csv could not be imported”; log, przechodząc łańcuch, dostaje też „row 2 has 2 columns”. Jeśli wyjątek z łańcuchem nigdy nie zostanie złapany, krytyczny błąd PHP wypisuje cały łańcuch: najpierw pierwotną przyczynę, potem każde opakowanie pod linią Next.

throw jako wyrażenie

Od PHP 8.0 throw jest wyrażeniem, więc może stać wszędzie tam, gdzie oczekiwana jest wartość: po ??, w operatorze trójargumentowym, w funkcji strzałkowej. Dzięki temu „pobierz to albo zgłoś błąd” mieści się w jednej linii:

<?php
$config = ['host' => 'localhost', 'port' => '5432'];

function setting(array $config, string $key): string
{
    return $config[$key] ?? throw new OutOfBoundsException("Missing setting '$key'");
}

echo setting($config, 'host'), "\n";

$port = (int) $config['port'] ?: throw new DomainException('Port must not be 0');
echo $port, "\n";

$positive = fn (int $n) => $n > 0 ? $n : throw new DomainException("$n is not positive");
echo $positive(8), "\n";

try {
    echo setting($config, 'password'), "\n";
} catch (OutOfBoundsException $e) {
    echo $e->getMessage(), "\n";
}

Kiedy nie rzucać

Wyjątki są na sytuacje, których bieżąca funkcja nie potrafi obsłużyć i których normalny przebieg się nie spodziewa. Wyszukiwanie bez wyników, puste pole opcjonalne czy niezalogowany użytkownik to zwykłe wyniki: zwróć null, false albo pustą tablicę i pozwól wywołującemu to sprawdzić, a wyjątki zostaw na przypadki, w których kontynuowanie byłoby błędem.

<?php
$users = ['ada' => 'Ada Lovelace', 'linus' => 'Linus Torvalds'];

// Ordinary outcome: "not found" is a normal answer, so return null
function findUser(array $users, string $handle): ?string
{
    return $users[$handle] ?? null;
}

// Broken input: an empty handle is a bug in the caller, so throw
function requireHandle(string $handle): string
{
    if ($handle === '') {
        throw new InvalidArgumentException('Handle must not be empty');
    }
    return strtolower($handle);
}

foreach (['ADA', 'grace', ''] as $input) {
    try {
        $name = findUser($users, requireHandle($input));
        echo $input, ': ', $name ?? 'no such user', "\n";
    } catch (InvalidArgumentException $e) {
        echo 'Bug: ', $e->getMessage(), "\n";
    }
}

Dwa kolejne nawyki utrzymują czytelność kodu z wyjątkami: nigdy nie łap wyjątku tylko po to, by go zignorować (puste catch (Exception $e) {} ukrywa następny prawdziwy błąd), i rzucaj konkretne klasy zamiast samego Exception, żeby wywołujący nigdy nie musiał łapać wszystkiego, by obsłużyć jeden przypadek.