# 安裝

## 服務器要求

Hyperf 對系統環境有一些要求，僅可運行於 Linux 和 Mac 環境下，但由於 Docker 虛擬化技術的發展，在 Windows 下也可以通過 Docker for Windows 來作為運行環境，通常來説 Mac 環境下，我們更推薦本地環境部署，以避免 Docker 共享磁盤緩慢導致 Hyperf 啟動速度慢的問題。   

[hyperf\hyperf-docker](https://github.com/hyperf/hyperf-docker) 項目內已經為您準備好了各種版本的 Dockerfile ，或直接基於已經構建好的 [hyperf\hyperf](https://hub.docker.com/r/hyperf/hyperf) 鏡像來運行。   

當您不想採用 Docker 來作為運行的環境基礎時，您需要確保您的運行環境達到了以下的要求：   

 - PHP >= 7.3
 - Swoole PHP 擴展 >= 4.5，並關閉了 `Short Name`
 - OpenSSL PHP 擴展
 - JSON PHP 擴展
 - PDO PHP 擴展 （如需要使用到 MySQL 客户端）
 - Redis PHP 擴展 （如需要使用到 Redis 客户端）
 - Protobuf PHP 擴展 （如需要使用到 gRPC 服務端或客户端）


## 安裝 Hyperf

Hyperf 使用 [Composer](https://getcomposer.org) 來管理項目的依賴，在使用 Hyperf 之前，請確保你的運行環境已經安裝好了 Composer。

### 通過 `Composer` 創建項目

[hyperf/hyperf-skeleton](https://github.com/hyperf/hyperf-skeleton) 項目是我們已經為您準備好的一個骨架項目，內置了一些常用的組件及相關配置的文件及結構，是一個可以快速用於業務開發的 Web 項目基礎，在安裝時，您可根據您自身的需求，對組件依賴進行選擇。   
執行下面的命令可以於當前所在位置創建一個 hyperf-skeleton 項目
```
composer create-project hyperf/hyperf-skeleton 
```

### Docker 下開發

假設您的本機環境並不能達到 Hyperf 的環境要求，或對於環境配置不是那麼熟悉，那麼您可以通過以下方法來運行及開發 Hyperf 項目：

- 啟動鏡像

可以根據實際情況，映射到宿主機對應的目錄，以下以 `/workspace/skeleton` 為例

> 如果 docker 啟動時開啟了 selinux-enabled 選項，容器內訪問宿主機資源就會受限，所以啟動容器時可以增加 --privileged -u root 選項

```shell
docker run --name hyperf \
-v /workspace/skeleton:/data/project \
-p 9501:9501 -it \
--privileged -u root \
--entrypoint /bin/sh \
hyperf/hyperf:7.4-alpine-v3.11-swoole
```

- 將 Composer 鏡像設置為阿里雲鏡像，加速國內下載速度

> 視情況而定

```shell
composer config -g repo.packagist composer https://mirrors.aliyun.com/composer
```

- 創建項目

```shell
cd /data/project
composer create-project hyperf/hyperf-skeleton
```

- 啟動項目

```shell
cd hyperf-skeleton
php bin/hyperf.php start
```

接下來，就可以在宿主機 `/workspace/skeleton/hyperf-skeleton` 中看到您安裝好的代碼了。
由於 Hyperf 是持久化的 CLI 框架，當您修改完您的代碼後，通過 `CTRL + C` 終止當前啟動的進程實例，並重新執行 `php bin/hyperf.php start` 啟動命令即可。

## 存在兼容性問題的擴展

由於 Hyperf 基於 Swoole 協程實現，而 Swoole 4 帶來的協程功能是 PHP 前所未有的，所以與不少擴展都仍存在兼容性的問題。   
以下擴展（包括但不限於）都會造成一定的兼容性問題，不能與之共用或共存：

- xhprof
- xdebug
- blackfire
- trace
- uopz
