Исключения PHP: throw и собственные классы исключений

Исключение в PHP выбрасывается через throw new Exception('message');. Выполнение останавливается на этой строке и переходит к ближайшему блоку catch, который принимает тип исключения, где $e->getMessage() возвращает сообщение. Используйте конкретный класс, например InvalidArgumentException, чтобы вызывающий код мог различать проблемы.

<?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";
}

Исключение это объект. throw передаёт его вверх по стеку вызовов первому вызывающему коду с подходящим catch, и уже он решает, что делать; функция, которая обнаружила проблему, знать этого не обязана. Механика перехвата, finally и перехват нескольких типов описаны на странице try catch.

Что содержит объект исключения

Каждое исключение несёт сообщение, целочисленный код, файл и строку, где оно создано, и трассировку стека. Конструктор принимает ($message, $code, $previous), все аргументы необязательны:

<?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() это строка с throw new, а не строка с catch. Трассировка перечисляет вызовы, которые туда привели (#0 /home/index.php(8): findOrder()), и обычно её читают первой, когда ошибка появляется в логе. Приведение исключения к строке (echo $e; или (string) $e) выводит всё это в стандартном формате PHP.

Встроенные классы исключений

В PHP есть семейство классов исключений в стандартной библиотеке PHP (SPL). Если выбрасывать тот, который называет проблему, код читается лучше, а вызывающий код может перехватывать узко. Все они наследуют Exception:

InvalidArgumentException, DomainException, LengthException и OutOfRangeException наследуют LogicException; OutOfBoundsException, RangeException и UnexpectedValueException наследуют RuntimeException. Родителей любого класса можно проверить самим:

<?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 это Error, а не Exception: он принадлежит второму семейству, о нём ниже.

Ошибки, которые выбрасывает сам PHP

Начиная с PHP 7, а с PHP 8 гораздо чаще, собственные функции и операторы PHP выбрасывают подклассы Error для проблем, которые раньше были предупреждениями. Перехватываются они так же, но catch (Exception $e) с ними не совпадёт:

<?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 и простой Error все наследуют Error. Каждая из них чаще отмечает ошибку в вызывающем коде, чем плохие данные, поэтому они живут вне дерева Exception. Именно declare(strict_types=1) делает str_repeat(5, 2) ошибкой TypeError; без него PHP привёл бы 5 к "5".

Собственный класс исключения

Часто хватает подкласса в одну строку: смысл несёт само имя класса, и вызывающий код может перехватывать именно этот тип. Когда перехватчику нужны данные (какой заказ, какая сумма), добавьте свойства и передайте сообщение наверх через 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";
}

Родителя выбирайте внимательно: наследование RuntimeException (а не простого Exception) означает, что код, перехватывающий RuntimeException, обработает и ваше исключение. Небольшая иерархия, одно базовое исключение на библиотеку или модуль с конкретными подклассами под ним, позволяет вызывающему коду выбирать между "перехватить всё из платежей" и "перехватить только этот случай".

Цепочки исключений через previous

Когда вы перехватываете низкоуровневое исключение и выбрасываете более высокоуровневое, передайте исходное третьим аргументом. Ничего не теряется: getPrevious() ведёт назад к первопричине.

<?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";
    }
}

Пользователь видит "customers.csv could not be imported"; лог, пройдя по цепочке, получает ещё и "row 2 has 2 columns". Если исключение из цепочки так и не перехвачено, фатальная ошибка PHP выводит всю цепочку: сначала исходную причину, затем каждую обёртку под строкой Next.

throw как выражение

Начиная с PHP 8.0 throw это выражение, поэтому он может стоять везде, где ожидается значение: после ??, в тернарном операторе, в стрелочной функции. С ним "получи это или упади" записывается одной строкой:

<?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";
}

Когда не нужно выбрасывать исключение

Исключения нужны для ситуаций, с которыми текущая функция не может справиться и которых не ожидает обычный ход работы. Поиск, который ничего не нашёл, пустое необязательное поле или пользователь, который не вошёл в систему, это обычные исходы: возвращайте null, false или пустой массив и дайте вызывающему коду проверить, а исключения оставьте для случаев, когда продолжать было бы неправильно.

<?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";
    }
}

Ещё две привычки делают код с исключениями читаемым: никогда не перехватывайте исключение лишь для того, чтобы его проигнорировать (пустой catch (Exception $e) {} скрывает следующую настоящую ошибку), и выбрасывайте конкретные классы, а не голый Exception, чтобы вызывающему коду не приходилось ловить всё ради одного случая.