Como habilitar o módulo Xdebug incluído no ServBay

Como uma poderosa ferramenta de desenvolvimento web integrada, o ServBay vem com o módulo Xdebug pré-instalado, e seu processo de ativação é bastante simples. O Xdebug é uma ferramenta de depuração e análise para PHP que ajuda os desenvolvedores na depuração de código, análise de desempenho e verificação de cobertura de código, sendo uma ferramenta essencial para o desenvolvimento e manutenção de aplicações PHP.

Introdução ao módulo Xdebug

O Xdebug é uma poderosa extensão PHP usada para depuração e análise de código PHP. Ele fornece uma ampla variedade de funções de depuração, incluindo depuração em ponto de interrupção, rastreamento de pilha, monitoramento de variáveis, entre outras. Além disso, o Xdebug suporta análise de desempenho e verificação de cobertura de código, ajudando os desenvolvedores a otimizar o desempenho do código e garantir a qualidade do código.

Principais características

1. Depuração em ponto de interrupção: O Xdebug permite definir pontos de interrupção no código e depurar linha por linha, facilitando a localização e correção de erros.
2. Rastreamento de pilha: Em caso de erro, o Xdebug pode gerar informações detalhadas de rastreamento de pilha, ajudando os desenvolvedores a identificar rapidamente problemas.
3. Análise de desempenho: O Xdebug oferece funções de análise de desempenho que geram relatórios detalhados, ajudando os desenvolvedores a otimizar o desempenho do código.
4. Cobertura de código: O Xdebug suporta verificação de cobertura de código, ajudando os desenvolvedores a garantir que todos os caminhos de código sejam testados.
5. Suporte a ambientes de desenvolvimento integrados: O Xdebug pode ser integrado a variados IDEs, como PHPStorm e Visual Studio Code, proporcionando uma experiência de depuração conveniente.

Versões do módulo Xdebug incluídas no ServBay

O ServBay suporta várias versões do PHP e tem o módulo Xdebug pré-instalado para cada uma delas. As versões específicas são:

• 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

::: aviso Cada versão do PHP tem sua porta Xdebug independente, relacionada ao número da versão, como por exemplo, a porta Xdebug do PHP 7.2 é 39072, e a do PHP 8.3 é 39083. :::

Como habilitar o módulo Xdebug

Por padrão, o módulo Xdebug está desativado. Habilitar o módulo Xdebug é um processo simples que requer apenas a modificação do arquivo de configuração correspondente à versão do PHP. Seguem os passos detalhados:

Passo 1: Localizar o arquivo de configuração

Primeiro, localize o diretório conf.d da versão PHP correspondente. Por exemplo, para habilitar o módulo Xdebug para o PHP 8.3, edite o seguinte arquivo:

/Applications/ServBay/etc/php/8.3/conf.d/xdebug.ini

Passo 2: Editar o arquivo de configuração

Abra o arquivo xdebug.ini e descomente as seguintes linhas:

[Xdebug]
; Descomente a linha abaixo para habilitar o XDebug
zend_extension = xdebug.so

Passo 3: Configurar parâmetros do Xdebug

Para tirar o máximo proveito do Xdebug, pode-se configurar alguns parâmetros comuns no xdebug.ini, como:

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

Passo 4: Reiniciar o serviço PHP

No painel de gerenciamento de serviços do ServBay, reinicie o serviço PHP correspondente. Por exemplo, reinicie o serviço PHP 8.3. Após a reinicialização, o módulo Xdebug será carregado com sucesso.

Como verificar se o módulo Xdebug foi carregado com sucesso

Você pode criar um arquivo PHP simples para verificar se o módulo Xdebug foi carregado com sucesso. Crie um arquivo phpinfo.php no diretório raiz do servidor web com o seguinte conteúdo:

<?php
phpinfo();
?>

Acesse https://servbay.host/phpinfo.php e verifique as informações do módulo Xdebug na página de informações do PHP. Se o Xdebug estiver listado, significa que o módulo foi carregado com sucesso.

Configurando o Xdebug no PHPStorm

Para usar o Xdebug no PHPStorm para depuração, siga os passos de configuração abaixo:

Passo 1: Abra o PHPStorm e vá para as configurações

1. Abra o PHPStorm.
2. Clique em File na barra de menu e selecione Settings (Windows/Linux) ou Preferences (macOS).

Passo 2: Configure o interpretador PHP

1. Na janela de configurações, navegue até Languages & Frameworks -> PHP.
2. Na seção CLI Interpreter, clique no botão ... à direita.
3. Na janela que se abrir, clique no ícone + para adicionar um novo interpretador PHP, escolhendo Local.
4. Define o caminho do interpretador PHP como o caminho correspondente à versão do PHP no ServBay, por exemplo, /Applications/ServBay/package/php/8.3/8.3.7/bin/php.
5. Clique em OK para salvar as configurações.

Passo 3: Configure a depuração com Xdebug

::: aviso Cada versão do PHP tem sua porta Xdebug independente, relacionada ao número da versão, como por exemplo, a porta Xdebug do PHP 7.2 é 39072, e a do PHP 8.3 é 39083. :::

1. Na janela de configurações, navegue até Languages & Frameworks -> PHP -> Debug.
2. Na seção Xdebug, configure Debug Port como 39083, de acordo com a configuração xdebug.client_port.
3. Certifique-se de que a opção Can accept external connections está marcada.
4. Clique em Apply e depois em OK para salvar as configurações.

Passo 4: Configure o servidor web PHP

1. Na janela de configurações, navegue até Languages & Frameworks -> PHP -> Servers.
2. Clique no ícone + à direita para adicionar uma nova configuração de servidor.
3. Defina o nome do servidor, por exemplo, ServBay Localhost.
4. Configure o Host como o host correspondente no ServBay, por exemplo, servbay.new, e a porta como 443 (HTTPS).
5. Defina Debugger como Xdebug.
6. Clique em OK para salvar as configurações.

Passo 5: Iniciar a sessão de depuração

1. No PHPStorm, abra o projeto PHP que você deseja depurar.
2. Defina pontos de interrupção no código (clicando na área em branco à esquerda do número da linha).
3. Clique no botão Start Listening for PHP Debug Connections na barra de ferramentas superior do PHPStorm (ícone de um inseto).
4. No navegador, acesse a sua aplicação PHP, e o Xdebug se conectará automaticamente ao PHPStorm, pausando a execução nos pontos de interrupção.

Conclusão

O ServBay oferece uma maneira conveniente de gerenciar e ativar o módulo Xdebug. Por meio de uma configuração simples e reinicialização, os desenvolvedores podem ativar rapidamente o módulo Xdebug em diferentes versões do PHP, aproveitando suas poderosas funções de depuração e análise para melhorar a eficiência no desenvolvimento e manutenção de aplicações PHP. As funções de depuração em ponto de interrupção, análise de desempenho e verificação de cobertura de código tornam o Xdebug uma ferramenta indispensável para os desenvolvedores PHP.