hyperf/hyperf-skeleton

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

安装量: 158,681

依赖项: 0

建议者: 0

安全: 0

星标: 269

关注者: 13

分支: 131

开放问题: 3

类型:项目

v3.1.2 2024-03-26 03:13 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,在您的php.ini中将swoole.use_shortname设置为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文件中的内容,使其适合您的项目描述。