Установка

Сервер Symfony является частью бинарности symfony, созданной, когда вы устанавливаете Symfony, и имеет поддержку для Linux, macOS и Windows.

Начало работы

Сервер Symfony запускается один раз в проекте, поэтому у вас может получиться несколько экземпляров (каждый из них будет слушать разные порты). Вот типичный рабочий процесс обслуживания проекта Symfony:

1
2
3
4
5
6
7
8

$ cd my-project/
$ symfony server:start

  [OK] Web server listening on http://127.0.0.1:....
  ...

# Теперь, перейдите по заданному URL, или выполните эту команду:
$ symfony open:local

Запуск сервера таким образом может отобразить сообщение лога в консоли, поэтому вы не сможете выполнять другие команды одновременно. Если вы хотите, вы можете запустить сервер Symfony фоново:

1
2
3
4
5
6
7
8
9

$ cd my-project/

# запустите сервер фоново
$ symfony server:start -d

# продолжайте работать и выполнять другие команды...

# покажите последние сообщения лога
$ symfony server:log

1

$ sudo codesign --force --deep --sign - $(whereis -q symfony)

Подключение PHP-FPM

Когда сервер запускается, он проверяет web/index_dev.php, web/index.php, public/app_dev.php, public/app.php в таком порядке. Если найден один из них, сервер автоматически запустится с подключенным PHP-FPM. В других случаях, сервер запустится без PHP-FPM, и отобразит страницу Страница не найдена, при попытке получить доступ к файлу .php в браузере.

Подключение TLS

Локальный просмотр безопасной версии ваших приложений важен для того, чтобы обануржить проблемы со смешанным содержанием как можно раньше, и чтобы запускать библиотеки, работающие только на HTTPS. По традиции это было больно и сложно настраивать, но сервер Symfony автоматизирует все. Для начала, выполните команду:

1

$ symfony server:ca:install

Эта команда создает локальный авторитет сертификата, регистрирует его в вашем хранилище доверия системы, в Firefox (необходимо только для этого браузера), и создает сертификат по умолчанию для localhost и 127.0.0.1. Другими словами, она все делает за вас.

До просмотра вашего локального приложения с HTTPS вместо HTTP, перезапустите его сервер, остановив и запустив его снова.

Разные PHP-настройки для каждого проекта

1
2
3
4
5
6
7

$ cd my-project/

# использовать конкретную версию PHP
$ echo 7.4 > .php-version

# использовать любую доступную версию PHP 8.x
$ echo 8 > .php-version

1
2
3
4
5

$ symfony local:php:list

  # Вы увидите все поддерживаемые SAPI (CGI, FastCGI, и др.) для каждой версии.
  # FastCGI (php-fpm) используется там, где это возможно; затем CGI (который также действует,
  # как сервер FastCGIserver), и, наконец, сервер откатывается до обычного CGI.

1
2
3
4
5
6

$ cd my-project/

# этот проект переопределяет только часовой пояс PHP по умолчанию
$ cat php.ini
[Date]
date.timezone = Asia/Tokyo

1
2
3
4
5
6

# выполняет команду с версией PHP по умолчанию
$ php -r "..."

# выполняет команду с версией PHP, выбранной проектом
# (или версией PHP по умолчанию, если проект не выбрал версию)
$ symfony php -r "..."

Имена локальных доменов

По умолчанию, проекты доступны с произвольного порта локального IP 127.0.0.1. Однако, иногда лучше ассоциировать с ними имя домена:

• Это более удобно, когда вы беспрерывно работаете над одним проектом, так как номера портов могут изменяться, а домены - нет;
• Поведение некоторых приложений зависит от их доменов/субдоменов;
• Наличие стабильных конечных точек, вроде локального перенаправления URL для OAuth2.

1

$ symfony proxy:start

1
2

$ cd my-project/
$ symfony proxy:domain:attach my-domain

1

$ symfony proxy:domain:attach "*.my-domain"

1
2
3
4
5
6
7
8

# Пример с curl
$ https_proxy=$(symfony proxy:url) curl https://my-domain.wip

# Пример с Blackfire и curl
$ https_proxy=$(symfony proxy:url) blackfire curl https://my-domain.wip

# Пример с Cypress
$ https_proxy=$(symfony proxy:url) ./node_modules/bin/cypress open

Долгосрочные команды

Долгосроные команды, такие как те, что компилируют форнтэнд веб-ресурсы, блокируют терминал, и вы не можете выполнять другие команды в то же время. Сервер Symfony предоставляет команду run, чтобы обернуть их следующим образом:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# скомпилируйте ресурсы Webpack, используя Symfony Encore ... но сделайте это
# фоново, чтобы не блокировать терминал
$ symfony run -d yarn encore dev --watch

# продолжайте работать и выполнять другие команды...

# время от времени, проверяйте логи команд, если хотите
$ symfony server:log

# и вы также можете проверить, выполняется ли еще команда
$ symfony server:status
Web server listening on ...
Command "yarn ..." running with PID ...

# остановите веб-сервер (и все ассоциированные команды), когда вы закончите
$ symfony server:stop

Файл конфигурации

Существует несколько опций, которые вы можете установить, используя файл конфигурации

.symfony.local.yaml:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# Устанаваливает domain1.wip и domain2.wip для текущего проекта
proxy:
    domains:
        - domain1
        - domain2

http:
    document_root: public/ # Путь к корню документа проекта
    passthru: index.php # Индекс прохождения проекта
    port: 8000 # Форсировать порт, который будет использоваться для запуска сервера
    preferred_port: 8001 # Preferred HTTP port [default: 8000]
    p12: path/to/p12_cert # Имя файла, содержащего сертификат TLS для использования, в формате p12
    allow_http: true # Предотвратить автоматическое перенаправление с HTTP на HTTPS
    no_tls: true # Использовать HTTP вместо HTTPS
    daemon: true # Запустить сервер фоново
    use_gzip: true # Включить сжатие GZIP

Конфигурация работников

Если вы хотите, чтобы какие-то процессы начинались автоматически вместе с веб-сервером (symfony server:start), добавьте файл конфигурации в ваш проект:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# .symfony.local.yaml
workers:
    # встроенная команда, которая создает и следит за ресурсами фронт-энда
    # yarn_encore_watch:
    #     cmd: ['yarn', 'encore', 'dev', '--watch']
    yarn_encore_watch: ~

    # встроенная команда, которая запускает потребителя мессенджера
    # messenger_consume_async:
    #     cmd: ['symfony', 'console', 'messenger:consume', 'async']
    #     watch: ['config', 'src', 'templates', 'vendor']
    messenger_consume_async: ~

    # вы также можете добавить ваши пользовательские команды
    build_spa:
        cmd: ['yarn', '--cwd', './spa/', 'dev']

    # автоматический запуск Docker compose при запуске сервера (доступно с Symfony CLI 5.7.0)
    docker_compose: ~

Интеграция Docker

Локальный сервер Symfony предоставляет полную интеграцию Docker для проектов, которые ее используют. Чтобы узнать больше о Docker и Symfony, см. Использование Docker с Symfony.

Когда веб-сервер определяет, что для проекта запущен Docker Compose, он автоматически демонстрирует некоторые переменные окружения.

Через API docker-compose, он ищет раскрытые порты, используемые для распространенных сервисов. Когда он обнаруживает тот, о котором знает, он использует имя сервиса, чтобы продемонстрировать переменные окружения.

Рассмотрите следующую конфигурацию:

1
2
3
4

# docker-compose.yaml
services:
    database:
        ports: [3306]

Веб-сервер определяет, что сервис, раскрывающий порт 3306 работает для проекта. Он понимает, что это - сервис MySQL, и создает переменные окружения в соответствии с именем сервиса (database) в качестве префикса: DATABASE_URL, DATABASE_HOST, ...

Если сервис не находится в списке поддерживаемых ниже, устанавливаются общие переменные окружения: PORT, IP, и HOST.

Если имена docker-compose.yaml не совпадают с соглашениями Symfony, добавьте ярлык, чтобы переопределить префикс переменных окружения:

1
2
3
4
5
6

# docker-compose.yaml
services:
    db:
        ports: [3306]
        labels:
            com.symfony.server.service-prefix: 'DATABASE'

В этом примере, сервис называется db, поэтому переменные окружения будут иметь префикс DB_, но так как com.symfony.server.service-prefix установлен, как DATABASE, веб-сервер создает переменные окружения, начинающиеся с DATABASE_ вместо того, что ожидается конфигурацией Symfony по умолчанию.

Вот список всех поддерживаемых сервисов с их портами, и префиксов Symfony по умолчанию:

Вы можете открыть интерфейсы веб-управления для сервисов, которые их демонстрируют:

1
2

$ symfony open:local:webmail
$ symfony open:local:rabbitmq

Или нажать на ссылки в разделе "Server" в панели инструментов веб-отладки.

Когда запущены сервисы Docker, перейдите на страницу вашего приложения Symfony, и проверьте раздел "Symfony Server" в панели инструментов веб-отладки; вы увидите, что "Docker Compose" - "Up".

1
2
3
4
5
6

# docker-compose.yaml
services:
    db:
        ports: [3306]
        labels:
            com.symfony.server.service-ignore: true

Если ваш файл Docker Compose не находится в корне проекта, используйте переменные окружения COMPOSE_FILE и COMPOSE_PROJECT_NAME, чтобы определить его местоположение, так же, как для docker-compose:

1
2
3
4
5

# запустите ваши контейнеры:
COMPOSE_FILE=docker/docker-compose.yaml COMPOSE_PROJECT_NAME=project_name docker-compose up -d

# запустите любую команду Symfony CLI:
COMPOSE_FILE=docker/docker-compose.yaml COMPOSE_PROJECT_NAME=project_name symfony var:export

Интеграция Platform.sh

Локальный сервер Symfony обеспечивает полную, но необязательную интеграцию с Platform.sh, сервисом, оптимизированным для запуска приложений Symfony в облаке. Он предоставляет такие возможности, как создание окружений, резервных копий/снапшотов, и даже доступ к копии рабочих данных с вашей локальной машины, чтобы помочь отладить любые проблемы.

Прочтите техническую документацию Platform.sh для Symfony.