Como ser eficiente no PhpStorm: um IDE que realmente importa

O que significa ser um bom desenvolvedor de software?

Primeiro, requer um conhecimento profundo da pilha de tecnologia específica em que você está trabalhando. Se você é um desenvolvedor LAMP, sem dúvida precisa ser um especialista em PHP e MySQL, conhecer estruturas modernas e ter algumas habilidades decentes em administração Linux.

Em segundo lugar, mas não menos importante, é o conhecimento prático das ferramentas complementares que você usa todos os dias em seu fluxo de trabalho.

Você precisa ser capaz de trabalhar adequadamente com sistemas de controle de versão, ferramentas de integração contínua, serviços de gerenciamento de máquinas virtuais (como Vagrant) e, obviamente, seu ambiente de desenvolvimento integrado (IDE).

Este artigo aborda o popular e robusto IntelliJ IDEA IDE PhpStorm e como, com um pouco de esforço, você pode facilmente dobrar sua eficiência e até mesmo evitar bugs enquanto codifica.

Treine-se com atalhos de teclado

Vamos começar com a habilidade mais simples e talvez mais importante para qualquer IDE: o uso adequado do teclado.

Se você comparar um programador experiente e um usuário comum de PC, a primeira coisa que notará é que o programador passa quase todo o tempo usando um teclado e quase nunca toca no mouse. Há uma razão para isso: é muito mais eficiente.

Primeiro, torne-se um bom digitador

Embora a digitação não esteja conectada diretamente às habilidades do IDE, os atalhos são inúteis se você precisar olhar para o teclado para encontrar todas as teclas.

Se você ainda não estiver digitando pelo menos 50 palavras por minuto (WPM), encontre um site de treinamento de digitação por toque, como TypingClub.com, e aumente sua velocidade.

Existem também sites de digitação competitivos, como TypingRaces.com, onde você pode competir com outras pessoas na digitação. Minha recomendação? Participe de uma corrida como aquecimento matinal todos os dias.

Treine-se para usar os atalhos do PhpStorm

A maneira mais rápida de aprender é não dar a si mesmo uma alternativa aos atalhos de teclado.

Quando eu estava estudando atalhos, desliguei todos os menus, abas, barras de navegação, etc.

Meu IDE agora está assim:

Como você pode ver, não posso evitar usar atalhos, mesmo que eu quisesse.

Levei cerca de três ou quatro dias de sofrimento para superar os estágios esmagadores de ajuste do laptop.

Se você achar que sua motivação está diminuindo, o PhpStorm possui um guia de produtividade integrado. Ele contém uma lista de recursos e estatísticas de uso para cada um deles. Basta clicar em 'Ajuda', depois em 'Guia de Produtividade' e você verá algo assim:

Como você pode ver, os atalhos me impediram de digitar mais de 20.000 caracteres adicionais (ao longo de seis meses) e evitaram cerca de 1.000 bugs. Bem motivador!

Também me diz quais recursos não estou usando com muita frequência, identificando lugares onde posso melhorar minhas habilidades de atalho. Revise suas estatísticas e use o conhecimento com sabedoria.

Principais atalhos de teclado

Jetbrains fornece um PDF útil com todos os atalhos disponíveis listados em sua documentação oficial e, além disso, possui uma lista de 'Atalhos de teclado que você não pode perder'. Comece a aprender isso imediatamente, até que você possa fazê-lo em seu sono.

De longe, meus atalhos favoritos são:

• Ctrl+ E - alterna entre arquivos usados ​​recentemente
• Ctrl + / - comentar/descomentar um bloco de código
• Ctrl + B - vá para a declaração de classe
• Ctrl + N - navegar para a classe
• Ctrl + R - pesquisar e substituir
• Ctrl +Alt + L - reformatar código
• Alt + Enter - mostra ações de intenção e correções rápidas
• Ctrl + Shift + Enter - declaração completa

Alguns deles são auto-explicativos, outros poderiam usar um pouco mais de cobertura.

Alternando arquivos com Ctrl + E e Enter

Imagine que você precisa alternar frequentemente entre dois arquivos, por exemplo, entre uma classe PHP com lógica de negócios do seu aplicativo e um modelo, que é usado para renderizá-lo e produzi-lo.

Muitos desenvolvedores mudariam do teclado para o mouse, navegariam até uma guia com o arquivo, clicariam nele e encontrariam a parte necessária com uma roda de rolagem. O problema: é extremamente lento!

Não é melhor apenas pressionar Ctrl + E e depois Enter?

Ctrl+E mostrará uma lista de arquivos usados ​​recentemente, e se você pressionar Enter imediatamente, você mudará para o arquivo usado antes do atual.

Se você quiser voltar, basta pressionar a mesma sequência novamente.

Esta é a maneira mais rápida de alternar entre dois arquivos, com apenas três pressionamentos de tecla! Imagine quanto tempo você economizará, quando tiver que fazer isso centenas de vezes por dia.

Mostrar ações de intenção e correções rápidas com Alt+Enter

Qualquer IDE moderno destaca erros e fornece algumas sugestões para melhoria de código. Se você mover o cursor para qualquer parte incompleta ou não documentada de um código, verá um ícone de lâmpada e, se clicar nele, verá um menu pop-up de ações possíveis.

A mesma ação pode ser feita pressionando Alt+Enter , o que é muito mais conveniente.

No caso da captura de tela acima, o PhpStorm oferece duas opções: Adicionar uma especificação PHPDoc à função (que é um conselho muito bom, fique atento) e remover um parâmetro não utilizado.

O mesmo atalho pode ser usado para muitas outras ações comuns: criar getters e setters para propriedades de classe, inicializar campos em construtores, adicionar métodos e propriedades indefinidas, etc.

Completar Declarações com Ctrl+Shift+Enter

Este atalho é muito simples e extremamente útil ao mesmo tempo, fazendo exatamente o que diz.

Por exemplo, se você digitar $i = 0 e pressionar Ctrl+Shift+Enter imediatamente depois, PhpStorm adicionará um ponto e vírgula à sua expressão. Se você digitar if e o atalho depois dele, o PhpStorm adicionará colchetes e assim por diante.

Use este atalho com a maior frequência possível. Isso economizará muito tempo, pois todo o código consiste em estruturas padrão. Qualquer aumento de velocidade nas estruturas de escrita torna a escrita do código muito mais rápida também!

O plugin IdeaVim

Usar atalhos pode aumentar drasticamente sua produtividade, mas se não for suficiente para você, o próximo nível é o plugin IdeaVim.

Como você provavelmente sabe, o Vim é um editor de texto de console amplamente utilizado por geeks e engenheiros de devops do Linux, para administrar servidores remotos via linha de comando.

Vim tem duas características importantes.

Primeiro, é difícil aprender. Em segundo lugar, se você conhece bem, vale a pena. Sua produtividade na edição de texto se tornará muito melhor do que com qualquer editor de GUI. Também haverá situações em sua carreira em que você não terá escolha a não ser usar um editor de console, como o Vim, (se você precisar corrigir algo em um servidor web remoto e tiver acesso apenas ao console, por exemplo).

Mas como o Vim está relacionado ao PhpStorm?

Bem, muitos desenvolvedores querem combinar a eficiência do Vim com recursos de um IDE moderno (por exemplo, conclusão de código, pesquisa de classe, pesquisa avançada e navegação). Para isso foi criado o plugin IdeaVim.

Nota importante: De agora em diante, presumo que você conheça o básico do Vim. Caso contrário, você pode começar a usar o Vim com vimtutor, que é acessível em quase todas as distribuições Linux ou openvim.

Instalação do plug-in

1. Navegue até 'Arquivo', depois 'Configurações', depois 'Plugins' e digite IdeaVim na caixa de pesquisa do plug-in. Marque a caixa de seleção à direita do nome do plugin e clique em “Aplicar”. 2. Reinicie o PhpStorm. 3. Ligue o plugin marcando 'Ferramentas' e depois 'Vim Emulator'

4. Os atalhos originais do PhpStorm e os atalhos do Vim (habilitados pelo plugin) podem entrar em conflito uns com os outros, então você precisa resolver esses conflitos manualmente. Navegue até 'Arquivo', 'Configurações', 'Outras configurações' e depois 'Emulação do Vim'. Você verá a lista de atalhos conflitantes. Nesta lista, você pode escolher se deseja usar o atalho PhpStorm ou o atalho Vim vinculado a essa sequência de teclas. Você pode ver minhas escolhas atuais na captura de tela abaixo. Se você não pode tomar uma decisão, apenas deixe um atalho indefinido; O PhpStorm pedirá que você escolha quando usá-lo pela primeira vez.

Uso do plug-in

Depois de ativar o plugin, você notará imediatamente que a área de edição se torna semelhante ao Vim:

• O cursor mudou sua forma e ficou retangular, como no Vim.
• Se você tentar digitar algo no editor, nada acontecerá.

A partir deste ponto, você pode começar a editar seus arquivos exatamente como faria no Vim, usando as teclas h , j , k , l para navegação e a tecla i para alternar entre o modo normal e o modo de inserção, etc.

Quase todos os atalhos do Vim são suportados pelo plugin.

Simultaneamente, todos os recursos do IDE ainda estão presentes, então você pode editar o texto extremamente rápido, usando apenas o teclado (como no Vim), e ainda pular entre classes, arquivos, usos e definições (como em um fluxo de trabalho moderno do PhpStorm).

Busca Avançada

Uma das melhores vantagens de qualquer IDE sobre os editores de texto comuns é a capacidade de implementar uma pesquisa avançada.

Pode parecer redundante, se você trabalhou apenas com projetos pequenos, mas quando começar a trabalhar com uma base de código grande, com relações OOP complicadas entre classes, você entenderá o quanto isso é indispensável.

É fácil encontrar uma string específica em um arquivo por pesquisa comum ( Ctrl + F ) ou pesquisar e substituir ( Ctrl + R ), mas e se você precisar encontrar uma definição de uma classe específica em milhares de arquivos? Ou se você deseja encontrar um método específico em uma classe contendo milhares de linhas de código? Ou talvez você queira excluir todos os comentários dos resultados da recuperação? É aí que um IDE moderno como o PhpStorm ajuda.

Nesta seção, mostrarei as variantes mais úteis de pesquisa no PhpStorm.

Localizar no caminho

Após a pesquisa comum, a pesquisa mais fácil é por uma determinada string em todos os arquivos em alguma subpasta do projeto. É tão facilmente implementado no PhpStorm que eu o uso com muito mais frequência do que qualquer outra opção de pesquisa.

Por exemplo, procure por usos de uma classe User em meu aplicativo de exemplo.

1. Pressione Ctrl + Shift + F . Você verá uma janela pop-up com opções de pesquisa. Digite ' User ' na string de consulta. Você verá vários resultados em uma guia de visualização:

2. Agora, podemos alternar para a guia Visualizar e encontrar manualmente os resultados necessários, mas temos mais de 100 correspondências. Tedioso! Vamos ser mais específicos.

Em primeiro lugar, estamos pesquisando os usos da classe, então vamos marcar a opção “somente palavras inteiras”. Isso nos ajudará a evitar resultados como E_USER_ERROR .

Em seguida, vamos excluir a pesquisa em comentários e literais de string e limitar nossos resultados apenas a arquivos .php .

Às vezes, também faz sentido especificar uma subpasta mais concreta do projeto. Nesse caso, todo o código específico do projeto está localizado na pasta do app .

Então, vamos alterar o diretório de escopo para example-app/app .

Agora, temos uma janela de pesquisa como esta:

Apenas por ser mais específico em nossos parâmetros de pesquisa, reduzimos o número de resultados de centenas para apenas 24!

Agora, é muito fácil examinar cada um deles manualmente. Além disso, nem precisamos abrir cada arquivo separadamente porque temos uma guia de visualização muito conveniente:

Na prática diária, a pesquisa de busca de caminho cobre cerca de 80% de todas as pesquisas que faço. É tão útil que, mesmo que você não use mais nada para suas recuperações, ainda será bastante eficiente.

Ir para Declaração

Outra habilidade extremamente importante do PhpStorm (como em todos os IDEs modernos) é pular entre usos e declarações de classes e funções.

Vamos supor que temos uma função, que cria um novo User . Obviamente, não nos lembramos de todos os métodos e propriedades da classe User , portanto, precisamos examinar a declaração da classe para decidir como executar todas as ações necessárias. Há várias maneiras para se fazer isso.

Primeiro, você pode abrir uma declaração de classe como uma janela pop-up rápida somente leitura.

Basta mover o cursor para qualquer uso de classe e pressionar Ctrl + Shift + I . A janela somente leitura será exibida:

Você pode examinar todos os dados necessários e retornar ao arquivo inicial. É extremamente rápido; você nem precisa alternar entre os arquivos!

Mas, como mencionei, a janela pop-up é somente leitura, portanto, se você decidir alterar algo na classe User enquanto a examina, precisará de outro atalho: Ctrl + Shift + B .

Isso leva você diretamente para a classe. Ao fazer suas alterações, você pode retornar facilmente ao arquivo inicial, usando Ctrl + E, Enter que abordamos anteriormente.

Listar todos os métodos da classe atual

A última variante da funcionalidade de pesquisa, que eu uso todos os dias é 'pesquisar por estrutura de classe'. Às vezes, as classes PHP são muito longas e é difícil encontrar uma propriedade ou método específico.

Se você pressionar Ctrl + F12 enquanto o arquivo de classe estiver aberto, você verá uma janela pop-up com uma estrutura da classe:

Se você começar a digitar o nome do método, verá apenas os métodos que correspondem ao padrão digitado:

Imagine que você tem cerca de 100 métodos (o que não é uma boa prática, mas você pode se deparar com esse código) e precisa alternar frequentemente entre dois deles. Pode deixá-lo louco usando a pesquisa comum!

Ao usar a pesquisa de estrutura de arquivos, cada opção levará cerca de cinco pressionamentos de tecla. Basta digitar Ctrl + F12 , começar a digitar o nome do método desejado, pressionar Enter e chegará à sua declaração.

A propósito, Ctrl + F12 não é um atalho conveniente, então você pode querer considerar alterá-lo para outra coisa. Pessoalmente, eu uso Alt + R .

Existem muitos outros métodos de pesquisa no PhpStorm, mas esses três podem cobrir quase todas as tarefas de pesquisa diárias.

Uma recapitulação das funcionalidades de pesquisa

• Se você precisar pesquisar algo encontrado em vários arquivos, use a pesquisa de localização no caminho ( Ctrl + Shift + F ) e tente tornar as opções de pesquisa (filtragem) o mais específicas possível.
• Se você precisar ver rapidamente a fonte de uma classe ou método, use Ctrl + Shift + I e examine-o através da janela pop-up rápida (se precisar editá-lo, navegue até a declaração via Ctrl + Shift + B ).
• Se você tiver uma classe grande e precisar inspecionar sua estrutura ou alternar rapidamente entre métodos, use um atalho de estrutura de arquivos, Ctrl + F12 por padrão.

Uso de modelos dinâmicos para todas as estruturas básicas de linguagem

Embora os atalhos permitam escrever e navegar no código rapidamente, há uma maneira de melhorá-lo ainda mais – preenchimento automático e modelos dinâmicos.

O preenchimento automático básico é bastante fácil e você certamente deve saber sobre isso.

Se você começar a digitar o nome de uma classe, método ou variável, qualquer bom IDE mostrará uma lista de possíveis finais. Você pode escolher qualquer um deles, e evite digitar até o final.

Dito isso, você pode ir muito mais longe com modelos dinâmicos.

Nesta seção, você aprenderá quais modelos dinâmicos eu uso no meu trabalho diário. Eu as divido em três grupos: construções básicas de linguagem, funções com nomes longos e partes HTML.

Construções básicas de linguagem

Desnecessário dizer que os desenvolvedores usam construções de linguagem padrão, como while , for , foreach , if muitas vezes por dia, então é extremamente ineficiente digitá-las do zero todas as vezes. É por isso que existem modelos dinâmicos integrados para eles no PhpStorm.

Para uma mágica de modelo ao vivo que muda sua vida, abra o PhpStorm e digite forek na área de edição e pressione Enter . Você verá isso:

O PhpStorm substituiu um modelo por um ciclo completo de foreach e preparou stubs para todas as variáveis ​​necessárias. Você só precisa preencher os nomes corretos das variáveis.

Se você pressionar Ctrl + J , verá a lista de modelos dinâmicos atualmente suportados, aplicáveis ​​ao local atual do código. Você pode escolher qualquer um deles.

Como você deve ter notado, algumas construções muito frequentes estão faltando aqui. Por exemplo, sempre sinto falta de um modelo ao vivo para o ciclo while , então vamos criá-lo!

Navegue até 'Configurações', depois 'Editor', depois 'Modelos ao vivo', escolha 'PHP' e clique no '+' verde no canto superior direito da janela pop-up:

Preencha o campo 'abbreviation' com 'wh' e o campo 'description' com 'while(bool_expr){…}'. O campo 'texto do modelo' deve ter o seguinte:

 while($EXPR$) { $END$ }

Clique no link 'definir' abaixo da área de texto 'texto do modelo' e escolha 'PHP' na lista, para saber em que contexto usar este modelo.

Agora, vamos discutir como funciona.

Quando você digitar wh, Enter na sua área de edição, ele será substituído pelo texto do modelo.

O cursor será movido para a primeira variável de template, $EXPR$ no nosso caso, então você pode digitar qualquer expressão (ex. $i > 0 ) e pressionar Enter novamente.

Depois disso, o cursor será movido para a próxima variável (só temos uma neste exemplo), e assim por diante. $END$ é uma variável especial que denota o lugar onde o cursor deve se mover depois que todas as variáveis ​​forem preenchidas.

Temos apenas uma variável, então ela será movida para $END$ logo após preenchermos $EXPR$ e estaremos prontos para inserir um corpo de ciclo.

Crie seus próprios modelos dinâmicos para todas as construções de linguagem que você usa com frequência. É muito melhor investir algum tempo antecipadamente do que gastá-lo todos os dias digitando essas construções do zero.

Funções PHP

Infelizmente, o PHP tem a reputação de ser uma linguagem com nomes de funções longos e inconsistentes.

A boa notícia é que você pode substituí-los por abreviações curtas usando modelos dinâmicos. Por exemplo, se você deseja verificar corretamente se alguma chave existe em um array, você precisa chamar a função array_key_exists($my_key, $my_array) .

É extremamente tedioso digitá-lo todas as vezes, mesmo com o preenchimento automático padrão, portanto, basta criar modelos dinâmicos para todos esses casos.

Pessoalmente, prefiro 'ake' para array_key_exists, você pode escolher qualquer outro. Veja como criar o modelo ao vivo 'ake':

Partes HTML

Por último, mas certamente não menos popular, o uso de modelos dinâmicos é o manuseio de partes HTML.

Se você ainda não está usando modelos dinâmicos, aposto que tem feito muito trabalho tedioso (e basicamente inútil), criando elementos de marcação HTML padrão. Os modelos ao vivo mudam isso fazendo o que fizemos acima, mas com o campo 'texto do modelo' sendo seu HTML.

Evite Bugs com PHPDocs

Até agora, você aprendeu dicas e truques de eficiência do PhpStorm, mas espere, há mais. A eficiência não é a única área em que pode ajudar, mas também pode ajudar a evitar bugs, mesmo antes da primeira execução do seu programa.

Fora da caixa, o PhpStorm informa sobre erros óbvios.

Por exemplo, se você esqueceu um ponto e vírgula depois de uma instrução, ele será marcado em vermelho, mas essa funcionalidade é trivial, então não vou descrevê-la.

O que é interessante é quando o PhpStorm fala sobre bugs muito mais complexos, quando você fornece as informações necessárias via PHPDocs.

Idealmente, as especificações do PHPDoc são obrigatórias em sua equipe para todos os métodos e feitas o mais rigorosas possível. Considere um exemplo com nossa classe User novamente. Suponha que temos uma função, que retorna um array de objetos User :

Por padrão, não é documentado, portanto, outros desenvolvedores podem não saber o tipo do valor retornado e podem usá-lo de forma inadequada.

Por exemplo, algum outro desenvolvedor deseja recuperar uma lista de nomes de usuário. Por alguma razão, ela pensa, que o objeto User tem um método getName(). Mas na realidade isso não acontece, então o desenvolvedor comete um erro:

PhpStorm não trata isso como um bug porque não sabe nada sobre a variável $user. Assim, passa despercebido, e acabamos com um erro muito desagradável.

A primeira opção é apenas ativar a tipagem estrita, que se tornou possível no PHP7, mas vamos supor que não podemos fazer isso por algum motivo. Talvez estejamos trabalhando com código legado. Nesse caso, o PhpStorm nos ajudará, se permitirmos.

Para que isso funcione, você precisará gerar um PHPDoc para cada função. É comumente considerado um bom hábito e ajudará você a evitar bugs, se dar bem com outros desenvolvedores e até mesmo passar em entrevistas nas quais os empregadores examinam seu código-fonte.

Para gerar um PHPDoc, mova o cursor para o nome da função, pressione Alt + Enter , escolha o item “Gerar PHPDoc para função” no menu pop-up e pressione Enter novamente.

O modelo básico do PHPDoc aparecerá:

Você pode ver que o PhpStorm adivinhou que o valor de retorno é uma matriz, mas não conseguiu adivinhar que é uma matriz de objetos User , então vamos estipular isso explicitamente alterando 'array' para ler 'User[]':

Agora que dissemos ao PhpStorm o que ele precisa saber sobre o método, vamos retornar à chamada do método getUserNames() :

Agora que o PhpStorm pode analisar a declaração do tipo de retorno do PHPDoc, ele pode nos apontar para o erro e até mesmo sugerir o que exatamente está errado. PhpStorm, em combinação com PHPDocs, pode tornar o PHP uma linguagem muito rigorosa! Um resultado incrível!

PhpStorm não é apenas para desenvolvedores PHP

Embora todos os tópicos abordados se concentrem no desenvolvimento PHP, o PhpStorm é baseado em uma plataforma IntelliJ muito poderosa, tornando possível o uso com várias linguagens, estruturas e pilhas de tecnologia, que estão longe do mundo PHP.

Desenvolvimento front-end

Mesmo se você for um desenvolvedor de back-end, precisará resolver alguns problemas de front-end de tempos em tempos. Pode ser uma simples correção na marcação HTML, adicionando um parâmetro ao cliente REST, escrito em AngularJS, etc. A boa notícia é que tudo isso pode ser feito em PhpStorm.

A regra básica é: Verifique se ele é compatível imediatamente. Se não, tente encontrar um plugin.

Por exemplo, Javascript, CSS e pré-processadores CSS populares, como LESS e SASS, são suportados imediatamente. O suporte AngularJS é facilmente adicionado como um plugin (o caminho de instalação é o mesmo do plugin IdeaVim). Com essa mentalidade, você poderá resolver quase todas as tarefas possíveis de front-end.

Trabalhando com Bancos de Dados

Normalmente, os bancos de dados de aplicativos são gerenciados via linha de comando ou ferramentas especiais, como MySQL Workbench, mas o PhpStorm também pode ajudá-lo aqui.

Basta clicar em Banco de dados na margem direita da tela, e você verá uma lista de bancos de dados disponíveis (inicialmente vazios) e uma janela de consulta, que possui preenchimento automático, como a área de edição comum, tornando-o muito conveniente.

PhpStorm suporta quase todos os bancos de dados modernos. MySQL, PostgreSQL, Oracle Database e SQLite são suportados imediatamente, enquanto o MongoDB é suportado através da instalação de plugins.

Pilha MÉDIA

O último e mais incrível exemplo não PHP é o desenvolvimento de pilha MEAN.

MEAN significa MongoDB, ExpressJS, AngularJS, Node.js.

É uma pilha de tecnologia de tendências, sendo usada em quase todos os lugares. É muito rápido e extremamente bom para serviços web rápidos e leves.

Mesmo como desenvolvedor PHP, às vezes crio serviços Node.js como ferramentas complementares para projetos PHP (por exemplo, serviços websocket, back-ends simples de chatbot, etc).

Como você provavelmente adivinhou, todos os componentes da pilha MEAN são suportados no PhpStorm, portanto, sempre que você precisar criar um projeto de pilha MEAN, lembre-se de que não precisa de outro IDE. PhpStorm fará o trabalho perfeitamente.

O poder do PhpStorm está em suas mãos

Usando o poder do PhpStorm e os principais conjuntos de habilidades abordados neste artigo, você também pode aumentar sua eficiência e evitar erros antes mesmo de terminar de digitar.