Como habilitar o módulo Xdebug integrado do ServBay

Como uma poderosa ferramenta integrada de desenvolvimento web, o ServBay vem com o módulo Xdebug, que é fácil de ativar. O Xdebug é uma ferramenta de depuração e análise para PHP, que ajuda desenvolvedores a realizar depuração de código, análise de performance e detecção de cobertura de código, sendo uma vantagem para o desenvolvimento e manutenção de aplicações PHP.

Introdução ao módulo Xdebug

O Xdebug é uma extensão poderosa para PHP utilizada na depuração e análise de código PHP. Ele oferece funcionalidades de depuração abrangentes, incluindo depuração com breakpoints, rastreamento de pilha, monitoramento de variáveis, entre outros. Além disso, o Xdebug suporta análise de performance e detecção de cobertura de código, ajudando desenvolvedores a otimizar o desempenho do código e a garantir a qualidade do código.

Características principais

1. Depuração com breakpoints: O Xdebug suporta a configuração de breakpoints no código, permitindo a depuração linha a linha para localizar e corrigir erros facilmente.
2. Rastreamento de pilha: Em caso de erro, o Xdebug pode gerar informações detalhadas sobre o rastreamento de pilha, ajudando os desenvolvedores a localizar rapidamente o problema.
3. Análise de performance: O Xdebug fornece funcionalidades de análise de performance, gerando relatórios detalhados de performance para ajudar os desenvolvedores a otimizar o desempenho do código.
4. Cobertura de código: O Xdebug suporta a detecção de cobertura de código, garantindo que os testes cubram todos os caminhos de código.
5. Suporte a ambientes integrados de desenvolvimento: O Xdebug pode ser integrado a vários ambientes de desenvolvimento integrados (IDE), como PHPStorm e Visual Studio Code, proporcionando uma experiência de depuração conveniente.

Versões do módulo Xdebug no ServBay

O ServBay suporta várias versões do PHP e vem pré-instalado com o módulo Xdebug correspondente para cada versão. 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

Dica

Cada porta do Xdebug para a versão do PHP é independente e está associada ao número da versão, por exemplo, a porta do Xdebug para PHP 7.2 é 39072 e para PHP 8.3 é 39083.

Como habilitar o módulo Xdebug

Por padrão, o módulo Xdebug está desativado. Os passos para ativar o módulo Xdebug são simples: basta navegar até Linguagem - PHP, selecionar a versão do PHP para a qual quer habilitar o módulo, como PHP 8.4, clicar em Extensões à direita, e ativar o Xdebug através do interruptor à esquerda, depois salvar.

Os usuários também podem abrir ou modificar manualmente a configuração do módulo. Aqui estão os passos detalhados:

Passo 1: Localizar o arquivo de configuração

Primeiro, localize o diretório conf.d para a versão correspondente do PHP. Por exemplo, para habilitar o módulo Xdebug para 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]
; Uncomment the following line to enable XDebug
zend_extension = xdebug.so

Passo 3: Configurar os parâmetros do Xdebug

Para aproveitar ao máximo as funcionalidades do Xdebug, você pode configurar alguns parâmetros comuns no xdebug.ini. Por exemplo:

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.

Verificar se o módulo Xdebug foi carregado com sucesso

Você pode verificar se o módulo Xdebug foi carregado com sucesso criando um arquivo PHP simples. No diretório raiz do servidor web, crie um arquivo chamado phpinfo.php com o seguinte conteúdo:

<?php
phpinfo();
?>

Acesse https://servbay.host/phpinfo.php e procure informações relacionadas ao módulo Xdebug na página de informações do PHP gerada. Se as informações do Xdebug aparecerem, o módulo foi carregado com sucesso.

Configurando o Xdebug no PHPStorm

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

Passo 1: Abrir o PHPStorm e acessar as configurações

1. Abra o PHPStorm.
2. Clique em File, depois selecione Settings (Windows/Linux) ou Preferences (macOS).

Passo 2: Configurar 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 surgir, clique no botão + para adicionar um novo interpretador PHP, selecione Local.
4. Configure o caminho do interpretador PHP para o caminho correspondente 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: Configurar a depuração do Xdebug

Dica

Cada porta do Xdebug para a versão do PHP é independente e está associada ao número da versão, por exemplo, a porta do Xdebug para PHP 7.2 é 39072 e para PHP 8.3 é 39083.

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

Passo 4: Configurar o servidor de aplicativo PHP

1. Na janela de configurações, navegue até Languages & Frameworks -> PHP -> Servers.
2. Clique no botão + à direita para adicionar uma nova configuração de servidor.
3. Defina o nome do servidor, por exemplo, ServBay Localhost.
4. Defina o Host como o host correspondente no ServBay, por exemplo, servbay.new, e a porta como 443 (HTTPS).
5. Defina o 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 deseja depurar.
2. Configure breakpoints 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 (ícone de um inseto) na barra de ferramentas superior do PHPStorm.
4. Acesse seu aplicativo PHP no navegador, e o Xdebug conectará automaticamente ao PHPStorm, pausando a execução nos breakpoints configurados.

Conclusão

O ServBay oferece uma forma conveniente de gerenciar e habilitar o módulo Xdebug. Com configurações simples e reinicializações, os desenvolvedores podem rapidamente ativar o módulo Xdebug para diferentes versões do PHP, utilizando suas poderosas funcionalidades de depuração e análise para melhorar a eficiência no desenvolvimento e manutenção de aplicações PHP. As funcionalidades de depuração com breakpoints, análise de performance e detecção de cobertura do Xdebug tornam-no uma ferramenta essencial para desenvolvedores PHP.