RoadRunner 项目使用教程

1. 项目的目录结构及介绍

RoadRunner 项目的目录结构如下：

roadrunner/
├── .github/
├── assets/
├── bin/
├── configs/
├── docs/
├── internal/
├── pkg/
├── scripts/
├── tests/
├── .gitignore
├── .goreleaser.yml
├── .golangci.yml
├── .pre-commit-config.yaml
├── .roadrunner.yaml
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── go.mod
├── go.sum

目录介绍

• .github/: GitHub 相关配置文件。
• assets/: 项目资源文件。
• bin/: 编译生成的二进制文件。
• configs/: 配置文件目录。
• docs/: 项目文档。
• internal/: 内部包，不对外公开。
• pkg/: 公共包，可对外公开。
• scripts/: 脚本文件。
• tests/: 测试文件。
• .gitignore: Git 忽略文件配置。
• .goreleaser.yml: GoReleaser 配置文件。
• .golangci.yml: GolangCI-Lint 配置文件。
• .pre-commit-config.yaml: pre-commit 配置文件。
• .roadrunner.yaml: RoadRunner 默认配置文件。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证。
• Makefile: Makefile 文件。
• README.md: 项目说明文档。
• go.mod: Go 模块文件。
• go.sum: Go 模块依赖校验文件。

2. 项目的启动文件介绍

RoadRunner 的启动文件主要是 bin 目录下的二进制文件。这些文件是通过编译生成的，可以直接运行。

例如，编译生成的二进制文件 rr 可以直接运行：

./rr serve

这个命令会启动 RoadRunner 服务器，加载配置文件并运行 PHP 应用程序。

3. 项目的配置文件介绍

RoadRunner 的配置文件主要是 .roadrunner.yaml 文件。这个文件包含了 RoadRunner 服务器的所有配置选项。

配置文件示例

http:
  address: ":8080"
  max_request_size: 1024
  workers:
    command: "php worker.php"
    pool:
      num_workers: 10
logs:
  level: debug

配置项介绍

• http: HTTP 服务配置。
  • address: 监听地址和端口。
  • max_request_size: 最大请求大小。
  • workers: 工作进程配置。
    • command: 启动 PHP 工作进程的命令。
    • pool: 工作进程池配置。
      • num_workers: 工作进程数量。
• logs: 日志配置。
  • level: 日志级别。

通过修改配置文件，可以调整 RoadRunner 服务器的行为，以适应不同的应用场景。