PhpStorm&Dockerで最強のphp開発環境を作ろう！（前半）

13619 ワード
Docker xdebug PhpStorm PhpStorm テキストリンク

はじめに

う〇この次に幼稚園児に人気の最強という単語を使っている時点でなんともこっぱずかしいタイトルですが、PhpStormをこよなく愛する自分としてはどうしても書きたかった内容なので、恥を忍んで投稿します。

オールドタイプな自分でもPhpStormを乗りこなしていくことで、いっぱしのペチパーになれた気がしました。
最近のPHPの開発現場では必須の

  • dockerなどの仮想化技術を使った開発環境
  • PHPUnitなどを使ったユニットテスト
  • Gitなどを使ったソース管理
  • Redmineなどを使ったタスク管理

がPhpStormの力で簡単に使いこなせるようになりますよ～
今回はMacで一度試したものをWindows10で実施した内容になっていますので、WindowsユーザもMacユーザもお試しあれ。

この記事を読んで身につくこと

  • Dockerをちょっと操作できる
  • PhpStormを使ってxdebugによるステップ実行ができる
    • もうなんでもかんでもprint_rしなくてもいーんだよ
  • PhpStormを使ってPHPUnitでのテスト実行＆カバレッジ計測ができる
    • テストの実行やカバレッジ計測もPhpStormの力で効率的でわかりやすくなる！
    • テストコードもxdebugと連携してSTEP実行できちゃうぞ
  • PhpStormを使ってdatabaseの操作ができる
    • なんだかんだ他のDBツールを使わなくなっちゃうYO!
  • PhpStormを使ってGitでのソース管理＆Redmineでのタスク管理ができる
    • もうgitのややっこしいコマンド覚えなくても、なんとかなっちゃうYO!
    • Redmineのチケットとブランチを関連付けて複数タスクの並列対応も怖くない！

前提のスキル

一応下記のスキルがあるといいです。

  • PHPでなんか作ったことがある
  • ソフトのインストールや起動は一人でできる
  • terminal（コマンドプロンプト 黒い画面）をちょっとは触ったことがある
  • Gitってなにかなんとなく知ってる

必要なソフトをインストールしよう

今回下記のソフトを使いますので、面倒でもインストールしてください。

  • PhpStorm (現バージョン：2017.3)
    • 30日間トライアルできますが、その後手放せなくなり購入してしまうでしょう。
  • Docker (現バージョン：17.09.1-ce-win42)
    • windowsの人はHyper-Vが使えないとインストールできないようです。
    • Storm＆Dockerへの愛があれば、私のようにwindow10 HomeをProにアップグレードしてしまうでしょう。
    • windowsの人はDockerの下記の設定にチェックが入っているか確認してください。
    • windowsの場合xdebugの設定で必要なdockerで使用するIPも確認しておきましょう。


  • git Widows版(git-for-windows)、Mac版
    • バージョン管理のソフトを初めて使う人にとってはとっつきにくいかもだけど、PhpStormさえあれば楽々使いこなせる！？

Docker環境を整えよう

オールインワンなDocker環境を用意したので、terminal(Windowsの人はGitBashがいいです)を起動してPhpStormの作業ディレクトリに移動してgit cloneしましょう。
（頭に＄がついてるのがコマンドなので、＄を取り除いてコピペして実行してね！）

githubから最強を取ってくる
$ cd /c/Users/your_account/PhpstormProjects
$ git clone https://github.com/albyte/php7-all-in-one.git

※ your_accountのところは、書き換えてね！

Macの人は、下記のようにdocker-composeの該当の行をコメントアウトしてください。
Windowsの人は、Dockerの確認のところでSubnet addressが10.0.75.0以外だったなら変更してください。

/c/Users/your_account/PhpstormProjects/php7-all-in-one/docker-compose.yml
...
  php-web:
...
    environment: [ xdebug_remote_host=10.0.75.1 ] # for windows
       ↓
#    environment: [ xdebug_remote_host=10.0.75.1 ] # for windows

cloneしたDockerを起動してみます。

Docker起動
$ cd /c/Users/your_account/PhpstormProjects/php7-all-in-one
$ docker-compose build
....いろいろ出力される
Successfully tagged php7allinone_php-cli:latest
mysql uses an image, skipping
$ docker-compose up -d
....いろいろ出力される
Creating php-cli ... done

windowsのかたでこんなエラーが出て起動しない場合はGit Bashを起動して、そこで上記を実行したら動くかもです。
下記のコマンドで、php-webとmysqlが起動（State=Up）してたらOKです。

dockerの状態確認
$ docker-compose ps
  Name               Command             State             Ports
-------------------------------------------------------------------------
mysql      docker-entrypoint.sh mysqld   Up       0.0.0.0:13306->3306/tcp
php-cli    php -v                        Exit 0
php-web    apache2-foreground            Up       0.0.0.0:10080->80/tcp

docker-composeのコマンドの詳細は、こちらを参考にしてみてください。

下記コマンドを使い、composerでphpのパッケージを取得しておきます。(PHPUnitの実行で必要になります)

composer実行
$ docker-compose run php-cli composer install

Docker上のwebページを表示してみよう

ブラウザで下記URLにアクセスして、こんな画面がでればOKです。
http://localhost:10080/test.php

Docker上のphpを実行してみよう

terminalで実行して、こんな結果でたらOKです。

php-cliのphp動作確認
$ docker-compose run php-cli php -v
PHP 7.0.9 (cli) (built: Jul 29 2016 20:54:37) ( NTS )
Copyright (c) 1997-2016 The PHP Group
Zend Engine v3.0.0, Copyright (c) 1998-2016 Zend Technologies
    with Zend OPcache v7.0.9, Copyright (c) 1999-2016, by Zend Technologies
    with Xdebug v2.4.0, Copyright (c) 2002-2016, by Derick Rethans

PhpStormを起動しよう

インストールしたPhpStormを起動したらこんな画面がでるので、先ほどgit cloneしたphp7-all-in-oneフォルダを開いてやりましょう。

PhpStormの設定を行おう

こんな画面がでてきますので、まずSettingsを開きます。

Dockerの設定

Dockerの設定がこんな感じになっているのを確認しましょう。

※（追記）docker-composeがIDE上から起動しない場合は、Certificated folderを空にしてください！

設定するとDockerをPhpStorm上で扱えるようになります。
コンテナのログを見たり、Execでbashを指定して、コンテナの中にログインするのに使うと便利です。

Serversの設定

赤枠に注意して、Dockerのphp-webのポートである10080を設定して、プロジェクトルートが/var/wwwにマウントされていることを記載してやりましょう。

PHP Interpreter & xdebug & PHPUnitの設定

ちょっと長いですが、ここがうまくいけば今後がとても楽ですので、我慢して設定してみてください。
[Languages & Framework] -> [PHP] を選択して、[PHP Language level]に[7]を選んでやりましょう。
CLI Interpreterの横の[...]をクリックします。

[CLI Interpreters]で[＋]をクリックし、[From Docker ....]を選びます。

下の赤い枠を注意して、入力します。

Environment...の[...]をクリックすると入力ダイアログがでるので、こちらも下記のように設定します。（CLIでxdebugを使う時重要な設定です）

すると、このようにPHP versionとXdebugバージョンが表示されるはずです。表示しない場合はリロードボタンをクリックしてみてください。
それからConfigration optionの[...]をクリックして設定してください。(これもCLIでxdebugを実行する時重要です)

入力の時は、-dをつけないように！
Windowsユーザは、「Value」に「10.0.75.1」(Dockerの確認のところでSubnet addressが10.0.75.0だったなら)
Macユーザは、「Value」に「 docker.for.mac.localhost docker.for.mac.host.internal 」
と入力してください。

最終的にphpの設定画面でこのようになるはずです。

DBGp Proxyでは下記のように設定します。

Test Frameworksでは、[PHPUnit by Remote Interpreter]を追加します。

以前に設定したphp-cliを選ぶと下記のようにPHPUnitのバージョン表示されるはずですので、[Default configration file]にチェックをつけて[/var/www/phpunit.xml]を入力してください。

PhpStormでPHPスクリプトを実行&デバッグしてみよう

設定がうまくいっているか確認します。
テスト用のスクリプトpublic/test.phpを下記のように実行します。

すると、こんな感じで実行結果が表示されます。

では、このソースにbreak pointを設定してデバッグしてみましょう。

このようにbreak pointで止めることができました。

PhpStormでブラウザで実行したスクリプトをデバッグしてみよう

まずGoogleChromeに[Xdebug helper]を追加します。

PhpStorm側でデバッグ接続リスナーをONにします。

GoogleChromeでURLにアクセスして、Debugを有効にしてリロードしてください。

すると先ほどと同じようにbreak pointで止めることができます。
止まらない人は、ファイヤーウォールのせいかもしれないので、とりあえずOFFにしてブラウザをリロードしてみましょう。
logs/xdebug.logにログを出力しているので、ちゃんとホストOSの9000ポートにアクセスされているか確認してみてください。

次回の内容は？

  • PhpStormでPHPUnitを実行してみよう
  • PhpStormでDocker上のMySQLにアクセスしてみよう
  • PhpStormでGit＆Redmineの連携をしてみよう

の3本です！

お楽しみに～