ServBayに組み込まれたXdebugモジュールの有効化方法
ServBayは強力な統合Web開発ツールであり、Xdebugモジュールが組み込まれており、その有効化プロセスは非常に簡単です。XdebugはPHPのデバッグと分析ツールで、開発者がコードのデバッグ、性能分析、コードカバレッジ検出を行うのに役立ち、PHPアプリケーションの開発と保守の必須ツールです。
Xdebugモジュールの概要
XdebugはPHPコードのデバッグと分析に用いる強力なPHP拡張機能です。デバッグ機能(ブレークポイントデバッグ、スタックトレース、変数監視など)を豊富に提供します。加えて、性能分析やコードカバレッジ検出のサポートもあり、開発者がコードの性能を最適化し、コード品質を保証するのに役立ちます。
主な特徴
- ブレークポイントデバッグ:Xdebugはコード中にブレークポイントを設定し、逐行デバッグを可能にし、エラーの特定と修正を容易にします。
- スタックトレース:エラーが発生した際に、詳細なスタックトレース情報を生成し、開発者が問題を迅速に特定するのに役立ちます。
- 性能分析:性能報告書を生成し、開発者がコード性能を最適化するのに役立ちます。
- コードカバレッジ:コードカバレッジの検出をサポートし、テストがすべてのコードパスをカバーしていることを確認するのに役立ちます。
- 統合開発環境のサポート:PHPStorm、Visual Studio Codeなどの統合開発環境(IDE)と連携し、便利なデバッグ機能を提供します。
ServBayにプリインストールされたXdebugモジュールのバージョン
ServBayは複数のPHPバージョンをサポートし、各バージョンに適したXdebugモジュールをプリインストールしています。具体的なバージョンは以下の通りです:
- PHP 5.6、7.0、7.1:Xdebug 2.5.5
- PHP 7.2、7.3、7.4:Xdebug 3.1.6
- PHP 8.0、8.1、8.2、8.3:Xdebug 3.3.1
- PHP 8.4:Xdebug 3.4.0-dev
提示
各PHPバージョンのXdebugポートは独立しており、バージョン番号に関連しています。例えば、PHP 7.2
のXdebugポートは39072
、PHP 8.3
のXdebugポートは39083
です。
Xdebugモジュールの有効化方法
デフォルトでは、Xdebugモジュールは無効化されています。有効化する手順は非常に簡単で、言語
-PHP
に移動し、有効化したいPHPバージョンを選択し、例えばPHP 8.4
、右側の拡張
をクリックし、Xdebug
モジュールの左側のスイッチをオンにして保存するだけです。
ユーザーはモジュールの設定を手動で開くか変更することもできます。以下は詳細な手順です:
手順一:設定ファイルを見つける
まず、対応するPHPバージョンのconf.d
ディレクトリに移動します。例えば、PHP 8.3のXdebugモジュールを有効にするには、以下のファイルを編集する必要があります:
/Applications/ServBay/etc/php/8.3/conf.d/xdebug.ini
手順二:設定ファイルを編集
xdebug.ini
ファイルを開き、以下の内容のコメントを解除します:
[Xdebug]
; 以下の行のコメントを解除してXDebugを有効化
zend_extension = xdebug.so
2
3
手順三:Xdebugパラメータを設定
Xdebugの機能を十分に活用するために、xdebug.ini
でいくつかの一般的なパラメータを設定できます。例えば:
xdebug.mode=debug,develop
xdebug.start_with_request=yes
xdebug.client_host=localhost
xdebug.client_port=39083
xdebug.log=/Applications/ServBay/logs/xdebug/8.3/xdebug.log
2
3
4
5
手順四:PHPサービスを再起動
ServBayのサービス管理パネルで、対応するPHPサービスを再起動します。例えば、PHP 8.3のサービスを再起動します。再起動が完了すると、Xdebugモジュールが正常にロードされます。
Xdebugモジュールが正常にロードされたか確認
簡単なPHPファイルを作成して、Xdebugモジュールが正常にロードされたか確認できます。Webサーバーのルートディレクトリにphpinfo.php
というファイルを作成し、以下の内容を記述します:
<?php
phpinfo();
?>
2
3
https://servbay.host/phpinfo.php
を訪問し、出力されたPHP情報ページでXdebugモジュールの関連情報を探してください。Xdebugに関連する情報が見つかれば、モジュールが正常にロードされたことを意味します。
PHPStormでのXdebugの設定
PHPStormでXdebugを使用してデバッグを行うため、以下の設定を行う必要があります:
手順一:PHPStormを開いて設定に入る
- PHPStormを開きます。
- メニューバーの
File
をクリックし、Settings
(Windows/Linux)またはPreferences
(macOS)を選択します。
手順二:PHPインタープリターを設定
- 設定ウィンドウで、
Languages & Frameworks
->PHP
に進みます。 CLI Interpreter
にて、右側の...
ボタンをクリックします。- ポップアップウィンドウで、
+
マークをクリックして新しいPHPインタープリターを追加し、Local
を選択します。 - PHPインタープリターのパスをServBayで対応するPHPバージョンのパスに設定します。例:
/Applications/ServBay/package/php/8.3/8.3.7/bin/php
。 OK
をクリックして設定を保存します。
手順三:Xdebugデバッグの設定
提示
各PHPバージョンのXdebugポートは独立しており、バージョン番号に関連しています。例えば、PHP 7.2
のXdebugポートは39072
、PHP 8.3
のXdebugポートは39083
です。
- 設定ウィンドウで、
Languages & Frameworks
->PHP
->Debug
に進みます。 Xdebug
部分で、Debug Port
を39083
に設定し、xdebug.client_port
設定と一致します。Can accept external connections
オプションがチェックされていることを確認します。Apply
をクリックし、OK
をクリックして設定を保存します。
手順四:PHP Webアプリケーションサーバーの設定
- 設定ウィンドウで、
Languages & Frameworks
->PHP
->Servers
に進みます。 - 右側の
+
マークをクリックして新しいサーバー構成を追加します。 - サーバー名を設定します。例:
ServBay Localhost
。 Host
をServBayホストに対応するホストに設定します。例:servbay.new
、ポートは443(HTTPS)です。Debugger
をXdebug
に設定します。OK
をクリックして設定を保存します。
手順五:デバッグセッションを開始
- PHPStormでデバッグしたいPHPプロジェクトを開きます。
- コードにブレークポイントを設定します(行番号の左側の空白領域をクリック)。
- PHPStormの上部ツールバーにある
Start Listening for PHP Debug Connections
ボタン(小さな虫のアイコン)をクリックします。 - ブラウザでPHPアプリケーションにアクセスすると、Xdebugが自動的にPHPStormに接続され、ブレークポイントで実行が一時停止します。
結論
ServBayはXdebugモジュールを管理し有効化する便利な方法を提供しています。簡単な設定と再起動操作によって、開発者は異なるPHPバージョンでXdebugモジュールを迅速に有効にし、その強力なデバッグと分析機能を最大限に活用し、PHPアプリケーションの開発と保守効率を向上させることができます。Xdebugのブレークポイントデバッグ、性能分析、コードカバレッジ検出機能はPHP開発者にとって不可欠なツールです。