HHVM4.0以降？
ご存知の通り、HHVM4.0以降PHPのコードを実行させることができなくなり、
HHVM/Hackの開発環境周りも大きく変化しています。
今回は最新のHHVM4.8(LTS) が動く環境をDockerで構築する方法を紹介します。
ネット上多くの記事はHHVM3系で、
しかも3.15などの古い記事が多く現在のバージョンとは大きく異なりますので、
注意してください。
現在はCentOSなどへのインストールはサポートされていません。
(CentOSベースで構築している記事は、ほとんどすべてが古いHHVM環境です)
AWSやオンプレ環境で構築する場合は、Ubuntu18.04などで構築してください。
Dockerで環境構築
今回紹介する環境はHHVM4.0以降のみ対応になっています。
せっかくなので新しいバージョンで構築しましょう。
fastcgi or proxygen
HHVMの動作方法として、fastcgiかproxygenを選択できます。
PHP-FPMと変わらないような使い勝手が良い場合は、fastcgiを利用すると良いですが、
HHVMで用意されている多くの機能が利用できません。
proxygenを利用すると、
NginxなどのWeb Serverを利用せずに、
Goなどと同じようにアプリケーションサーバライクにHackを実行することができます。
こちらを利用すると、HHVMのAdminサーバ機能や、
Hackのコードをコンパイルして動かすモードが利用できます。
フロントにNginxを配置してproxygenにupstreamするなども対応できます。
上記の違いを踏まえてHHVMで提供されているDockerコンテナも二種類あります。
hhvm/hhvmはUbuntuベースのコンテナで、
Nginxなどのコンテナを組み合わせて利用する場合はこちらを選択できます。
hhvm/hhvm-proxygen は
NginxがなくてもWebアクセスで、Hackのコードが実行できますので、
特にWebサーバが必要なければこちらだけで環境構築が整います。
今回は、hhvm-proxygenを使って環境構築をしてみましょう。
Dockerfileでcomposerインストールを記述しておくと、スムーズです。
FROM hhvm/hhvm-proxygen:4.8-latest
RUN apt-get update
RUN DEBIAN_FRONTEND=noninteractive
RUN apt install -y dnsutils iputils-ping net-tools
RUN hhvm --version && php --version
RUN cd $(mktemp -d) \
&& curl https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
RUN rm -rf /var/www
HHVMのphp.iniは下記の設定にしておきましょう。
hhvm-proxygenコンテナのデフォルトでは80ポートでアクセすると、
proxygenと通信することができるようになっていますが、
ポートを変えたい場合は、下記にある通り hhvm.server.port で変更します。
xdebug.enable = 1
date.timezone = Asia/Tokyo
hhvm.log.header = true
hhvm.debug.server_error_message = true
display_errors = On
html_errors = On
error_reporting = 22527
hhvm.server.fix_path_info = true
hhvm.server.type = proxygen
hhvm.server.port = 18080
hhvm.log.use_log_file = true
hhvm.server.source_root = /var/www/public
hhvm.php_file.extensions[hack]=1
hhvm.jit=1
hhvm.server.default_document = "index.hack"
hhvm.server.error_document404 = "index.hack"
hhvm.server.utf8ize_replace = true
hhvm.log.file=stderr
hhvm.admin_server.port=19001
hhvm.admin_server.password=SomePassword
hhvm.admin_server.portはAdmin Server利用時のポートで、
hhvm.admin_server.passwordはAdmin Server利用時に必要なパスワードです。
それぞれ環境に合わせたものを設定します。
次にいくつかのミドルウェアを組み合わせてみる、などを行いたい場合は
docker-composeで利用できるようにしておくと良いでしょう。
下記はdocker-compose.yml例です。
version: '3'
services:
hhvm:
build:
context: ./docker/hhvm
volumes:
- .:/var/www
- ./docker/hhvm/hh.conf:/etc/hh.conf
- ./docker/hhvm/php.ini:/etc/hhvm/php.ini
- ./docker/hhvm/server.ini:/etc/hhvm/server.ini
command: hhvm --mode server -vServer.AllowRunAsRoot=1
restart: always
tty: true
container_name: hhvm
ports:
- 18080:18080
- 19001:19001
docker-compose.ymlが置いてあるディレクトリを /var/www に配置し、
HHVMのphp.iniに hhvm.server.source_rootで /var/www/public にしていますので、
publicディレクトリにindex.hackファイルがあれば、
アプリケーションスクリプトのファイルとしてproxygenで実行されます。
HHVM4.0からは、Hackのファイルに .hack が利用できるようになり、
これまでの <?hh タグと続けて記述していた // strict と同じ厳格モードがデフォルトとなります。
.hack を利用する場合は、 <?hh タグは記載せずにソーソコードを記述しましょう。
これで開発・動作環境が整ったのでコンテナを起動することで、
Hackの開発環境が整います。
エディタ
Hackを開発する時のエディタは
現在Visual Studio Code + Hack Pluginの組み合わせがデファクトスタンダードです。
code.visualstudio.com
marketplace.visualstudio.com
HHVMにはLanguage Serverあり、この Hack for Visual Studio Codeと連携してサポートしてくれます。
PHPStormの様にuse文(import)を自動で書いてくれたり、などはありませんが、
コードジャンプは当然ながら、
引数のチェックやメソッド・関数のリファレンスなども当然あり、
コード補完やLintなども対応してくれます。
開発のためのLinterやCheck Styleなどのライブラリの使い方や、
実行方法がわからなくても代わりに実行してくれますので、
設定以外のタスクを記述したり、PHPDocを書いたり、
といった準備をすることはあまりありません。
HackではPHPDocを大量に記述せずとも、
静的言語のコンパイラなみの厳格さでコードを記述する必要がありますので、
PHPDocの書き方で補完のされ方が異なる、という事は一切ありません。
ライブラリ
とはいえエディタをフル活用するにはASTなどのライブラリを事前に入れておく必要がありますので、
下記のライブラリをcomposer.jsonに含めておきましょう。
HHVM-AutoloadとHack Standard Library(hsl)は、
ほとんど必須のライブラリと云ってもいいくらいものです。
オプショナルなものとして、下記のものも利用することが多いです。
hsl-experimentalは、将来的にhsl、またはHHVM本体で実装・追加予定のもの、
という立ち位置が強く、ファイルシステム・リソース操作などはhsl-experimentalにあります。
商用などでは利用せずに開発時に利用するものとしては以下のものが一般的です。
- HackTest / A unit testing framework for Hack
- FBExpect / A Hack library for writing unit tests expressively
- HHAST / Mutable AST library for Hack with linting and code migrations
HackTestは、PHPサポートが切れる前にPHPUnitから移行ができる様に準備されていたもので、
FBExpectはアサーションなどが含まれます。
HackTestを使ってFBExpectでアサートをする、という組み合わせになります。
asyncでテストメソッドが実行されますので、
ひと昔前のHackUnitなどの利用は必要ありません。
HHASTはLinterなどの機能を提供しているもので、
Visual Studio Code + Hack Pluginと連携して利用できます(単体でも可)
Hack専用のhh_autoload.jsonなども事前に用意しておく必要があります。
2018年の情報ですが、
前提の知識として下記のものを読んでおくと良いでしょう。
qiita.com
Composer
ここまでのものを踏まえ、
開発初期時の composer.json は次のものを利用すると、
エディタとの組み合わせや、開発時に必要なテストライブラリなど一式が導入できます。
{
"name": "vendor/your-project-name",
"type": "library",
"minimum-stability": "stable",
"require": {
"hhvm": "^4.0",
"hhvm/hsl": "^4.0",
"hhvm/hsl-experimental": "^4.0",
"hhvm/hhvm-autoload": "^2.0.0",
"facebook/hh-clilib": "^2.1.0"
},
"require-dev": {
"hhvm/hacktest": "^1.5",
"facebook/fbexpect": "^2.5.2",
"hhvm/hhast": "^4.0.0"
}
}
hhvm-autoload で利用する hh_autoload.json は次の通りです。
{
"roots": [
"src/"
],
"devRoots": [
"tests/"
]
}
次に hhvm/hhast で利用する hhast-lint.json です
{
"roots": [
"src/",
"tests/"
],
"builtinLinters": "all"
}
Hackを動かすために必要な .hhconfig ファイルは、
次の記述を記載しておくのが一般的かもしれません
assume_php = false
enable_experimental_tc_features = no_fallback_in_namespaces
ignored_paths = [ "vendor/.+/tests/.+" ]
safe_array = true
safe_vector_array = true
disallow_assign_by_ref = false
unsafe_rx = false
あとは $ composer install だけで
すぐに開発をはじめることができます。
エディタで補完されないな？という時に
エディタで補完が効かない、
タイプエラーで真っ赤なファイルがある、
という場合には、hh_clientを再起動してください。
再起動は次のコマンドで実行できます。
$ hh_client restart
Travisを使ってテストしたい
TravisCIを使って自動テストなどを実行したい場合は、
Travis上でDockerを利用すると様々なバージョンでテストできます。
ただし、TravisでもPHP実行環境のバージョン提供と同じ様にHHVMも多数のバージョンが用意されています。
コンテナ内でテスト実行などを行う様に下記のシェルスクリプトファイルを用意します。
set -ex
apt update -y
DEBIAN_FRONTEND=noninteractive apt install -y php-cli zip unzip
hhvm --version
php --version
(
cd $(mktemp -d)
curl https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
)
composer install
hh_client
hhvm ./vendor/bin/hacktest.hack tests/
上記に合わせて.travis.ymlを次の通りにします。
sudo: required
language: generic
services:
- docker
env:
matrix:
- HHVM_VERSION=4.0.0
- HHVM_VERSION=4.0.1
- HHVM_VERSION=4.0.2
- HHVM_VERSION=4.0.3
- HHVM_VERSION=4.0.4
- HHVM_VERSION=4.1.0
- HHVM_VERSION=4.2.0
- HHVM_VERSION=4.3.0
- HHVM_VERSION=4.4.0
- HHVM_VERSION=4.5.0
- HHVM_VERSION=4.6.0
- HHVM_VERSION=4.7.0
- HHVM_VERSION=4.8.0
- HHVM_VERSION=latest
install:
- docker pull hhvm/hhvm:$HHVM_VERSION
script:
- docker run --rm -w /var/source -v $(pwd):/var/source hhvm/hhvm:$HHVM_VERSION ./.travis.sh
例では4.0系以降のバージョンのみですが、
記載したHHVMバージョンのコンテナを起動してをテストなどを実行できますので、
柔軟に様々な要件に応えることができます。
これで最新のHHVM/Hackの開発環境を準備することができました。
これまでの、PHPがちょっと速く動く環境 という知識をアップデートして、
Hackにチャレンジしてみましょう！
事前準備が面倒な方は、下記のものを再利用すると良いでしょう。
github.com
