框架安装

框架使用 Composer 作为依赖管理工具，在开始安装框架前，请确保已经按上一章节的要求配置好环境并安装好了Composer 工具，在安装过程中，会释放框架的文件到项目目录，请保证项目目录有可写入权限

关于 Composer 的安装可以参照 Composer中国全量镜像 的安装教程

快速安装

  1. # 创建项目
  2. composer create-project easyswoole/app easyswoole
  4. # 进入项目目录并启动
  5. cd easyswoole
  6. php easyswoole start

执行上面的命令，会在执行命令的目录创建 easyswoole 文件夹，创建好的项目已经拥有基本的目录结构，可以直接启动项目，访问浏览器 http://127.0.0.1:9501 即可访问到控制器

如果在命令执行过程中遇到报错 或者无法启动等问题 请继续往下阅读查看解决方案 或尝试手动安装 如果仍不能解决问题，请加入左上角目录上方的在线交流群 寻求帮助

报错处理

在一些环境中，特别是使用集成面板安装的 PHP 环境，会出现以下报错：

  1. dir=$(d=${0%[/\\]*}; cd "$d" > /dev/null; cd '../easyswoole/easyswoole/bin' && pwd)
  3. # See if we are running in Cygwin by checking for cygpath program
  4. if command -v 'cygpath' >/dev/null 2>&1; then
  5.     # Cygwin paths start with /cygdrive/ which will break windows PHP,
  6.     # so we need to translate the dir path to windows format. However
  7.     # we could be using cygwin PHP which does not require this, so we
  8.     # test if the path to PHP starts with /cygdrive/ rather than /usr/bin
  9.     if [[ $(which php) == /cygdrive/* ]]; then
  10.         dir=$(cygpath -m "$dir");
  11.     fi
  12. fi
  14. dir=$(echo $dir | sed 's/ /\ /g')
  15. "${dir}/easyswoole" "$@"

关于该问题，搜索了几回谷歌，都说是composer问题。不信执行以下代码也有同样问题

  1. > php vendor/bin/php-parser

暂时解决方案就是用 yum 或者是以手动编译的形式重新安装你的 PHP 环境，或者也可以直接指向easySwoole的脚本，若有解决该报错的方案，请与我联系

  1. # 直接指向easySwoole的管理脚本
  2. php vendor/easyswoole/easyswoole/bin/easyswoole install

手动安装

按下面的步骤进行手动安装

  1. composer require easyswoole/easyswoole=2.x-dev
  2. php vendor/bin/easyswoole install

如果第二步的 install 操作报错 请查看上方的报错处理

在项目根目录下创建如下的目录结构，这个目录是编写业务逻辑的应用目录，编辑 Index.php 文件，添加基础控制器的代码

  1. project              项目部署目录
  2. ----------------------------------
  3. ├─App        应用目录
  4. │  └─HttpController      应用的控制器目录
  5. │     └─Index.php    默认控制器文件
  6. ----------------------------------
  1. <?php
  2. namespace App\HttpController;
  3. use EasySwoole\Core\Http\AbstractInterface\Controller;
  4. class Index extends Controller
  5. {
  6.     function index()
  7.     {
  8.         // TODO: Implement index() method.
  9.         $this->response()->write('hello world');
  10.     }
  11. }

然后编辑根目录下的 composer.json 文件，注册应用的命名空间

  1. {
  2.     "autoload": {
  3.         "psr-4": {
  4.             "App\\": "App/"
  5.         }
  6.     },
  7.     "require": {
  8.         "easyswoole/easyswoole": "2.x-dev"
  9.     }
  10. }

最后执行 composer dumpautoload 命令更新命名空间，框架已经可以自动加载 App 目录下的文件了，此时框架已经安装完毕，可以开始编写业务逻辑

  1. # 更新命名空间映射
  2. composer dumpautoload
  3. # 启动框架
  4. php easyswoole start

中途没有报错的话，框架就安装完成了，此时可以访问 http://localhost:9501 看到框架的欢迎页面，表示框架已经安装成功

关于IDE助手

由于 Swoole 的函数并不是PHP标准函数，IDE无法进行自动补全，为了方便开发，可以执行以下命令引入IDE助手，在IDE下即可自动补全 Swoole 相关的函数

  1. composer require easyswoole/swoole-ide-helper

常见问题

安装后第一次启动 报错协程 ID 只能为 int 或 null

请确保 swoole 拓展版本大于 1.9.23 或者是大于 2.1.0，并且使用了easyswoole仓库提供的IDE助手

composer require easyswoole/swoole-ide-helper:dev-master

原因在于其他仓库的IDE助手未及时更新，协程函数默认返回1，实际上应该是-1

启动后无法加载首页 一直处于加载中的状态

请检查当前 swoole 拓展版本是否为 2.1.2 ，该版本存在 BUG ，如果使用了该版本，升级到 2.1.3 或更高版本即可解决，可以从以下几个地址的任意一个获取到 2.1.3 版本的拓展

  1. 官方 GitHub 仓库 : 点我直达
  2. 官方 PECL 仓库 : 点我直达

示例项目

框架准备了一个示例项目，内有框架大部分功能的示例代码，直接克隆下方的 GitHub 仓库到本地并安装依赖，即可开始体验

仓库地址: https://github.com/easy-swoole/demo

  1. # 克隆仓库
  2. git clone https://github.com/easy-swoole/demo.git easyswoole
  3. cd easyswoole
  5. # 初始化依赖并启动
  6. composer install
  7. php vendor/bin/easyswoole install
  8. php easyswoole start