Декларативная разработка на PHP: от кода к конфигурациям

Когда я начинал свой путь в PHP-разработке, большую часть времени я тратил на написание бесконечных строк императивного кода. Каждый класс, маршрут или форма требовали ручной настройки. Со временем я осознал, что такой подход не только замедляет работу, но и усложняет поддержку проектов. Тогда я открыл для себя декларативную разработку. Парадигму, где вы описываете «что» нужно сделать, а не «как».

В этой статье я поделюсь своим опытом перехода от классического программирования к декларативным конфигурациям, генерации кода через аннотации и автоматизации с помощью инструментов вроде PHP-Parser. Мы разберем реальные примеры из Symfony, OpenAPI и других технологий, а также сравним разные подходы в таблицах.

Конфигурации на YAML/XML в Symfony

Зачем использовать YAML/XML?

Раньше настройка сервисов или маршрутов в Symfony требовала правки PHP-файлов. Теперь же конфигурации вынесены в отдельные файлы, что упрощает:

• Читаемость: Все параметры собраны в одном месте.
• Масштабируемость: Легко добавлять новые правила без изменения кода.
• Безопасность: Конфиги можно хранить отдельно (например, в .env).

Пример: маршрутизация в YAML и XML

Допустим, мы хотим создать эндпоинт /api/posts.

YAML (config/routes.yaml):

api_posts:
  path: /api/posts
  controller: App\Controller\PostController::index
  methods: GET

XML (config/routes.xml):

<?xml version="1.0" encoding="UTF-8" ?>
<routes xmlns="http://symfony.com/schema/routing"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/routing
        https://symfony.com/schema/routing/routing-1.0.xsd">

    <route id="api_posts" path="/api/posts" controller="App\Controller\PostController::index" methods="GET"/>
</routes>

Плюсы YAML:

• Лаконичный синтаксис.
• Поддержка многомерных массивов.

Плюсы XML:

• Строгая валидация через XSD.
• Удобство для сложных структур (например, SOAP).

Генерация кода через аннотации

Аннотации позволяют описывать поведение прямо в классах и методах. Это особенно удобно в Doctrine ORM или при определении маршрутов.

Пример: сущность Doctrine с аннотациями

use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * @ORM\Entity(repositoryClass="App\Repository\PostRepository")
 * @ORM\Table(name="posts")
 */
class Post
{
    /**
     * @ORM\Id
     * @ORM\GeneratedValue
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @ORM\Column(type="string", length=255)
     * @Assert\NotBlank
     */
    private $title;
}

Преимущества:

• Вся метаинформация находится рядом с кодом.
• Не нужно переключаться между файлами.

Минусы:

• Аннотации могут «раздуть» класс.
• Нет автоавтоподдержки в IDE без плагинов.

PHP-Parser: автоматизируем рутину

Библиотека PHP-Parser позволяет генерировать и модифицировать PHP-код программно. Я использую её для создания шаблонных классов или даже целых CRUD-интерфейсов.

Пример: генерация класса через PHP-Parser

use PhpParser\BuilderFactory;
use PhpParser\PrettyPrinter;

$factory = new BuilderFactory;
$node = $factory->namespace('App\Entity')
    ->addStmt($factory->class('User')
        ->addStmt($factory->property('id')
            ->makePrivate()
            ->addAttribute('\ORM\Id')
            ->addAttribute('\ORM\GeneratedValue')
            ->addAttribute('\ORM\Column', ['type' => 'integer'])
        )
    )->getNode();

$printer = new PrettyPrinter\Standard;
echo $printer->prettyPrintFile([$node]);

Результат:

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;

class User
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column(type: 'integer')]
    private $id;
}

Совет: Интегрируйте PHP-Parser в консольные команды Symfony для автоматической генерации кода.

OpenAPI: декларативное описание API

OpenAPI (Swagger) это стандарт для описания REST-API через YAML или JSON. Я использую его для:

• Автогенерации документации.
• Валидации запросов и ответов.
• Тестирования через Postman.

Пример: описание эндпоинта /api/posts

openapi: 3.0.0
info:
  title: Blog API
  version: 1.0.0

paths:
  /api/posts:
    get:
      summary: Get all posts
      responses:
        '200':
          description: List of posts
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Post'
components:
  schemas:
    Post:
      type: object
      properties:
        id:
          type: integer
        title:
          type: string

Интеграция с Symfony:
Установите бандл nelmio/api-doc-bundle, чтобы связать OpenAPI с вашими контроллерами.

Сравнительный анализ подходов

Рекомендации

1. Выбирайте инструмент под задачу:
   • Для простых проектов — аннотации.
   • Для сложных конфигов — YAML/XML.
   • Для кодогенерации — PHP-Parser.
2. Комбинируйте подходы: Например, описывайте API через OpenAPI, а маршруты генерируйте автоматически.
3. Не забывайте про документацию: Декларативный код должен быть самодокументируемым.

Декларативная разработка изменила мой подход к программированию. Теперь я трачу меньше времени на написание кода и больше на проектирование архитектуры. Попробуйте внедрить эти практики в свои проекты и вы заметите, как сократится количество ошибок и вырастет скорость разработки.