Symfony 本地 Web 服务器

安装

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:....
  ...

# Now, browse the given URL, or run this command:
$ symfony open:local

以这种方式运行服务器会在控制台中显示日志消息，因此您将无法同时运行其他命令。如果您愿意，可以在后台运行 Symfony 服务器

1
2
3
4
5
6
7
8
9

$ cd my-project/

# start the server in the background
$ symfony server:start -d

# continue working and running other commands...

# show the latest log messages
$ 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 文件时，将显示 Page not found 页面。

启用 TLS

在本地浏览应用程序的安全版本对于尽早检测混合内容问题以及运行仅在 HTTPS 中运行的库非常重要。传统上，这非常痛苦且设置复杂，但 Symfony 服务器会自动执行所有操作。首先，运行此命令

1

$ symfony server:ca:install

此命令创建一个本地证书颁发机构，将其注册到您的系统信任存储中，将其注册到 Firefox 中（仅该浏览器需要），并为 localhost 和 127.0.0.1 创建默认证书。换句话说，它为您完成了一切。

1

$ explorer.exe `wslpath -w $HOME/.symfony5/certs`

在使用 HTTPS 而不是 HTTP 浏览本地应用程序之前，请重启其服务器，停止并再次启动它。

每个项目不同的 PHP 设置

1
2
3
4
5
6
7

$ cd my-project/

# use a specific PHP version
$ echo 7.4 > .php-version

# use any PHP 8.x version available
$ echo 8 > .php-version

1
2
3
4
5

$ symfony local:php:list

  # You'll see all supported SAPIs (CGI, FastCGI, etc.) for each version.
  # FastCGI (php-fpm) is used when possible; then CGI (which acts as a FastCGI
  # server as well), and finally, the server falls back to plain CGI.

1
2
3
4
5
6

$ cd my-project/

# this project only overrides the default PHP timezone
$ cat php.ini
[Date]
date.timezone = Asia/Tokyo

1
2
3
4
5
6

# runs the command with the default PHP version
$ php -r "..."

# runs the command with the PHP version selected by the project
# (or the default PHP version if the project didn't select one)
$ symfony php -r "..."

本地域名

默认情况下，项目可以通过 127.0.0.1 本地 IP 的某个随机端口访问。但是，有时最好将域名与它们关联起来

• 当您持续在同一项目上工作时，这更方便，因为端口号可能会更改，但域名不会；
• 某些应用程序的行为取决于其域名/子域名；
• 为了拥有稳定的端点，例如 OAuth2 的本地重定向 URL。

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

# Example with curl
$ https_proxy=$(symfony proxy:url) curl https://my-domain.wip

# Example with Blackfire and curl
$ https_proxy=$(symfony proxy:url) blackfire curl https://my-domain.wip

# Example with Cypress
$ https_proxy=$(symfony proxy:url) ./node_modules/bin/cypress open

长时间运行的命令

长时间运行的命令（例如编译前端 Web 资源的命令）会阻塞终端，并且您无法同时运行其他命令。Symfony 服务器提供了一个 run 命令来包装它们，如下所示

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

# compile Webpack assets using Symfony Encore ... but do that in the
# background to not block the terminal
$ symfony run -d npx encore dev --watch

# continue working and running other commands...

# from time to time, check the command logs if you want
$ symfony server:log

# and you can also check if the command is still running
$ symfony server:status
Web server listening on ...
Command "npx ..." running with PID ...

# stop the web server (and all the associated commands) when you are finished
$ symfony server:stop

配置文件

您可以使用 .symfony.local.yaml 配置文件设置多个选项

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

# Sets domain1.wip and domain2.wip for the current project
proxy:
    domains:
        - domain1
        - domain2

http:
    document_root: public/ # Path to the project document root
    passthru: index.php # Project passthru index
    port: 8000 # Force the port that will be used to run the server
    preferred_port: 8001 # Preferred HTTP port [default: 8000]
    p12: path/to/p12_cert # Name of the file containing the TLS certificate to use in p12 format
    allow_http: true # Prevent auto-redirection from HTTP to HTTPS
    no_tls: true # Use HTTP instead of HTTPS
    daemon: true # Run the server in the background
    use_gzip: true # Toggle GZIP compression
    no_workers: true # Do not start workers

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

# .symfony.local.yaml
workers:
    # built-in command that builds and watches front-end assets
    # npm_encore_watch:
    #     cmd: ['npx', 'encore', 'dev', '--watch']
    npm_encore_watch: ~

    # built-in command that starts messenger consumer
    # messenger_consume_async:
    #     cmd: ['symfony', 'console', 'messenger:consume', 'async']
    #     watch: ['config', 'src', 'templates', 'vendor']
    messenger_consume_async: ~

    # you can also add your own custom commands
    build_spa:
        cmd: ['npm', '--cwd', './spa/', 'dev']

    # auto start Docker compose when starting server (available since Symfony CLI 5.7.0)
    docker_compose: ~

Docker 集成

本地 Symfony 服务器为使用 Docker 的项目提供完整的 Docker 集成。要了解有关 Docker 和 Symfony 的更多信息，请参阅 将 Docker 与 Symfony 结合使用。

当 Web 服务器检测到 Docker Compose 正在为项目运行时，它会自动公开一些环境变量。

通过 docker-compose API，它会查找用于常见服务的公开端口。当它检测到它知道的服务时，它会使用服务名称来公开环境变量。

考虑以下配置

1
2
3
4

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

Web 服务器检测到一个公开端口 3306 的服务正在为项目运行。它理解这是一个 MySQL 服务，并相应地创建环境变量，服务名称 (database) 作为前缀：DATABASE_URL、DATABASE_HOST、...

如果服务不在以下支持列表中，则会设置通用环境变量：PORT、IP 和 HOST。

如果 compose.yaml 名称与 Symfony 的约定不匹配，请添加一个标签以覆盖环境变量前缀

1
2
3
4
5
6

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

在此示例中，服务名为 db，因此环境变量将以 DB_ 为前缀，但由于 com.symfony.server.service-prefix 设置为 DATABASE，Web 服务器会创建以 DATABASE_ 开头的环境变量，而不是默认 Symfony 配置所期望的。

这是支持的服务列表，包含它们的端口和默认 Symfony 前缀

您可以为公开 Web 管理界面的服务打开 Web 管理界面

1
2

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

或单击 Web 调试工具栏的“服务器”部分中的链接。

当 Docker 服务正在运行时，浏览 Symfony 应用程序的页面并检查 Web 调试工具栏中的“Symfony 服务器”部分；您会看到“Docker Compose”为“Up”。

1
2
3
4
5
6

# 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

# start your containers:
COMPOSE_FILE=docker/compose.yaml COMPOSE_PROJECT_NAME=project_name docker-compose up -d

# run any Symfony CLI command:
COMPOSE_FILE=docker/compose.yaml COMPOSE_PROJECT_NAME=project_name symfony var:export

Platform.sh 集成

本地 Symfony 服务器提供与 Platform.sh 的完整但可选的集成，Platform.sh 是一项优化的服务，用于在云端运行您的 Symfony 应用程序。它提供诸如创建环境、备份/快照，甚至从本地计算机访问生产数据副本等功能，以帮助调试任何问题。

阅读 Platform.sh for Symfony 技术文档.