space-platform/space-skeleton

一个专注于超高速和灵活的协程框架,专门用于构建微服务和中间件。

0.1.2 2024-01-18 04:32 UTC

This package is not auto-updated.

Last update: 2024-09-27 06:15:01 UTC


README

这是一个使用 Hyperf 框架的骨架应用程序。该应用程序旨在作为那些想要开始接触 Hyperf 框架的人的起点。

要求

Hyperf 对系统环境有一些要求,它只能在 Linux 和 Mac 环境下运行,但鉴于 Docker 虚拟化技术的发展,Docker for Windows 也可以作为 Windows 下的运行环境。

hyperf/hyperf-docker 项目中为您准备了各种版本的 Dockerfile,或者可以直接基于已构建的 hyperf/hyperf 镜像来运行。

当您不希望将 Docker 作为运行环境的基础时,您需要确保您的操作环境满足以下要求

  • PHP >= 8.1
  • 以下任何一个网络引擎
    • Swoole PHP 扩展 >= 5.0,将 swoole.use_shortname 在您的 php.ini 中设置为 Off
    • Swow PHP 扩展 >= 1.3
  • JSON PHP 扩展
  • Pcntl PHP 扩展
  • OpenSSL PHP 扩展(如果您需要使用 HTTPS)
  • PDO PHP 扩展(如果您需要使用 MySQL 客户端)
  • Redis PHP 扩展(如果您需要使用 Redis 客户端)
  • Protobuf PHP 扩展(如果您需要使用 gRPC 服务器或客户端)

使用 Composer 安装

创建新的 Hyperf 项目的最简单方法是使用 Composer。如果您尚未安装,请根据文档进行安装。

创建您的新 Hyperf 项目

composer create-project hyperf/hyperf-skeleton path/to/install

如果您的开发环境基于 Docker,您可以使用官方的 Composer 镜像来创建新的 Hyperf 项目

docker run --rm -it -v $(pwd):/app composer create-project --ignore-platform-reqs hyperf/hyperf-skeleton path/to/install

入门

安装后,您可以使用以下命令立即运行服务器。

cd path/to/install
php bin/hyperf.php start

或者在基于 Docker 的环境中,您可以使用模板提供的 docker-compose.yml

cd path/to/install
docker-compose up

这将启动端口 9501 上的 cli-server,并将其绑定到所有网络接口。您可以通过访问 https://:9501/ 来查看网站,这将显示 Hyperf 默认首页。

提示

  • 一个好的提示是将文件如 composer.jsondocker-compose.yml 中的 hyperf-skeleton 重命名为您实际的项目名称。
  • 查看 config/routes.phpapp/Controller/IndexController.php 以了解 HTTP 入口的示例。

记住:您始终可以替换此 README.md 文件的内容,使其适合您项目的描述。