Código Limpo Em Php

Prefácio

PHP evoluiu ao longo de várias décadas de uma linguagem de script simples para criar páginas HTML para uma linguagem rica em recursos com um ecossistema extenso. Como a grande maioria dos sites ainda usa PHP, ele é um dos pilares da Internet.

Embora ainda seja amigável para iniciantes, ele pode ser usado para implementar tudo, desde pequenos sites até aplicativos corporativos usados em todo o mundo. No entanto, as baixas barreiras de entrada do PHP às vezes levam a códigos difíceis de entender e impossíveis de manter.

Com este livro, queremos apresentá-lo ao mundo do Código Limpo. Você aprenderá muito sobre a teoria e também como aplicar o conhecimento que aprendeu no mundo real. Você aprenderá quais ferramentas irão apoiá-lo nessa jornada e quais práticas recomendadas você deve usar para conseguir implementar o Clean Code com sucesso em sua equipe.

Para quem é este livro

Este livro destina-se a desenvolvedores PHP em início de carreira que desejam entender os fundamentos do código PHP de alta qualidade e a desenvolvedores PHP experientes que desejam se atualizar com as práticas recomendadas mais recentes.

O que este livro cobre

Capítulo 1, O que é código limpo e por que você deveria se importar?, apresenta o assunto principal do livro.

Capítulo 2, Quem decide o que são boas práticas?, explica como essas regras são decididas.

Capítulo 3, Code, Don't Do Stunts, mostra por que você deve considerar ser pragmático em vez de tentar exibir habilidades.

Capítulo 4, É mais do que apenas código, explica por que um perímetro de código limpo é maior do que apenas escrever código-fonte.

capítulo 5, Otimizando Seu Tempo e Separando Responsabilidades, explica como se tornar mais produtivo criando novos hábitos.

Capítulo 6, PHP Is Evolving – Deprecations and Revolutions, fornece uma visão geral rápida dos recursos mais esperados introduzidos no PHP, ajudando a escrever código limpo.

Capítulo 7, Code Quality Tools, ensina sobre ferramentas que o ajudarão a escrever código limpo e de fácil manutenção.

Capítulo 8, Code Quality Metrics, analisa todas as métricas que você precisa saber para avaliar a qualidade do seu código.

Capítulo 9, Organizing PHP Quality Tools, mostra como manter suas ferramentas organizadas.

Capítulo 10, Automated Testing, apresenta o teste automatizado e explica por que você deve fazê-lo.

Capítulo 11, Integração Contínua, explora como manter a qualidade do código de forma consistente e ao longo do tempo.

Capítulo 12, Trabalhando em equipe, apresenta as melhores práticas para trabalhar em uma equipe de desenvolvedores.

Capítulo 13, Criando Documentação Eficaz, demonstra como criar documentação útil e viva.

Para obter o máximo deste livro

Você precisará do PHP 8.0 ou superior instalado em seu computador. Todos os exemplos de código foram testados usando PHP 8.1 no Linux e macOS. Com pequenos ajustes, eles devem funcionar no Windows também, dependendo da sua configuração.

Para acompanhar todos os capítulos, você também precisará instalar o Composer. Você encontrará mais informações sobre isso emCapítulo 9, Organizando PHP Quality Tools, ou emhttps://getcomposer.org.

Se você estiver usando a versão digital deste livro, aconselhamos que você mesmo digite o código ou acesse o código do repositório GitHub do livro (um link está disponível na próxima seção). Isso ajudará você a evitar possíveis erros relacionados à cópia e colagem de código.

Baixe os arquivos de código de exemplo

Você pode baixar os arquivos de código de exemplo para este livro do GitHub emhttps://github.com/PacktPublishing/Clean-Code-in-PHP. Se houver uma atualização no código, ela será atualizada no repositório do GitHub.

Também temos outros pacotes de código de nosso rico catálogo de livros e vídeos disponíveis emhttps://github.com/PacktPublishing/. Confira!

Baixe as imagens coloridas

Também fornecemos um arquivo PDF com imagens coloridas das capturas de tela e diagramas usados neste livro. Você pode baixá-lo aqui:https://packt.link/b08Jl.

Convenções usadas

Há uma série de convenções de texto usadas ao longo deste livro.

Código em texto: indica palavras de código em texto, nomes de tabelas de banco de dados, nomes de pastas, nomes de arquivos, extensões de arquivos, nomes de caminho, URLs fictícios, entrada do usuário e identificadores do Twitter. Aqui está um exemplo: Então, criaremos naturalmente um serviço como o UserRemover, que executará essas duas tarefas seguidas.

Um bloco de código é definido da seguinte forma:

exemplo de classe

{

public function doSomething() bool

{

retornar verdadeiro;

}

}

Quando queremos chamar sua atenção para uma parte específica de um bloco de código, as linhas ou itens relevantes são colocados em negrito:

{

...

scripts: {

analisar: [

ferramentas/fornecedor/bin/php-cs-fixer fix src,

ferramentas/fornecedor/bin/phpstan analise --level 1 src

],

post-update-cmd: ferramentas -d de atualização do compositor,

post-install-cmd: ferramentas de atualização do compositor -d

}

}

Qualquer entrada ou saída de linha de comando é escrita da seguinte forma:

$ php phploc src

Audacioso: indica um novo termo, uma palavra importante ou palavras que você vê na tela. Por exemplo, palavras em menus ou caixas de diálogo aparecem em negrito. Aqui está um exemplo: Passar o ponteiro do mouse sobre TestClass mostrará uma janela pop-up com uma explicação dizendo TestClass de tipo indefinido.

Parte 1 - Apresentando o Código Limpo

O objetivo desta primeira parte é apresentar os conceitos de código limpo e a teoria por trás dele. Esta parte pretende ser bastante teórica, embora exemplos concretos sejam discutidos à medida que os capítulos avançam. A primeira abordagem do código limpo é proposta para explicar sua utilidade e porque ele é necessário na vida de um desenvolvedor.

Esta seção compreende os seguintes capítulos:

1

O que é código limpo e por que você deve se importar?

Se você é novo em PHP: Hypertext Preprocessor (PHP) e desenvolvimento de software em geral, há uma boa chance de você ainda não ter encontrado um código limpo. Todos nós começamos aqui; todos devem estar cientes disso. O código limpo é mais do que apenas um conjunto de regras. É uma mentalidade real - uma maneira de pensar sobre o que você está criando.

Muitas vezes encontramos desenvolvedores que estão em tecnologia da informação (TI) há muitos anos, até décadas, e nunca tiveram que se preocupar com código limpo. Isso pode ser por vários motivos: trabalhar sozinho em um projeto por muitos anos ou desenvolver em uma base de código legado são alguns dos muitos motivos pelos quais o código limpo não chegou aos seus ouvidos ou não foi uma de suas preocupações.

Fique atento ao código limpo — quanto mais cedo melhor. Como acontece com muitos outros hábitos, uma vez que você adota uma forma de trabalhar com código, é difícil mudar isso. Pode ser porque você não está nem um pouco convencido sobre o que é o código limpo, não tem certeza se ele se aplica a você ou pode ser preguiçoso em aplicar novas regras porque as suas já estão funcionando para você (tenha certeza de que todos já passou por isso). Mas se você se preocupa com isso e está tomando nota - bem, você já fez a parte mais difícil, porque isso significa que você está pronto para mudar seus hábitos. Não nos entenda mal — o objetivo não é mudar tudo o que você aprendeu até agora; é mais um caso de melhorar as habilidades que você já possui.

Você pode não estar ciente disso, mas é certo que você já possui alguns hábitos que se adequam totalmente aos princípios do código limpo e que são naturais para você e completamente novos para outros desenvolvedores. Você deve observar que o objetivo dos princípios de código limpo não é ser controverso.

Os principais tópicos que abordaremos neste capítulo estão listados aqui:

O que este livro abordará

Você já deve ter ouvido falar de livros sobre criação de software, livros sobre código limpo e assim por diante. Qual é a diferença entre este livro e os outros? Bem, percebemos que quando somos um neófito em desenvolvimento e descobrimos novas linguagens de programação, ou mesmo entrando em programação e código-fonte pela primeira vez, pode ser difícil entender como aplicar esses princípios sobre os quais você lê em todos os lugares. As linguagens de programação não oferecem todos os mesmos recursos – algumas estão evoluindo rapidamente, enquanto outras não estão mais evoluindo. As noções e a maneira como as coisas são nomeadas em um idioma podem não ser válidas em outros idiomas. É por isso que este livro se concentra especialmente no código limpo em PHP.

Você não terá que pensar em como implementar esses princípios e regras em PHP, o que é algo a menos para se lembrar na hora de absorver conhecimento. Você encontrará exemplos e ferramentas que se aplicam diretamente a você, usados em projetos profissionais e comprovados pelo setor. Assim, podemos ir direto aos pontos importantes que gostaríamos que você entendesse. Você pode colocar seu conhecimento em prática imediatamente enquanto lê este livro e, como resultado, aprender mais rápido. Além disso, você não precisa de mais de 10 anos de experiência para entender o que será mostrado. Apenas conhecimento básico de PHP é necessário para entender completamente o que será exposto.

Este livro é uma compilação de anos de experiência - anos de prática no campo, confrontados com problemas reais que tiveram de ser resolvidos de acordo com restrições técnicas, funcionais e de tempo e dinheiro. Este não será mais um livro cheio de princípios utópicos que não podem ser aplicados na vida real.

Mais do que se adequar diretamente ao seu ambiente falando apenas de PHP, este livro pode ser lido na ordem que você quiser. Está dividida em duas partes distintas. A primeira (que você está lendo no momento) vai expor um pouco da teoria sobre o que é código limpo e quais são os princípios básicos dele, aplicados diretamente na linguagem PHP até a versão 8.2, e assim por diante. A segunda parte será focada em ferramentas práticas que você pode usar para garantir que está seguindo as regras certas da maneira correta, configurando um ambiente e seu ambiente de desenvolvimento integrado (IDE) para ser o mais eficiente e limpo possível e obtendo métricas em seu código, testes automatizados, redação de documentação e muito mais. Isso significa que você pode pular partes, pegá-las na ordem que quiser e aprender na velocidade que quiser.

Você não terá que ler toda a parte teórica antes de entrar na prática – você pode mergulhar em ferramentas e exemplos concretos agora mesmo. Você também pode se concentrar na primeira parte antes de entrar nos aspectos práticos para ter certeza de entender completamente o que será explicado mais tarde. É com você.

Entendendo o que é código limpo

Código limpo é o ato de escrever código pensando no futuro, ou seja, pensando nas pessoas que colaborarão com você ou no projeto sem você. E quando estamos falando de as pessoas que vão colaborar com você, pode até ser você mesmo. Se nunca o fez, você deve tentar ler e manter o código-fonte que escreveu alguns meses (ou anos) atrás. Não é desafiador? Bem, não se preocupe - é difícil para todos. Você certamente achará isso complicado por muitos anos, e não há solução rápida para isso. É o mesmo processo para todos.

Há muitas razões para isso, conforme descrito aqui:

Falando sobre PHP, é extremamente interessante ver que a linguagem está evoluindo muito e rapidamente nos últimos anos. Muitos pediram a morte do PHP alguns anos atrás. É verdade que antes do PHP 7, a linguagem realmente não ia bem. PHP 7 e versões mais recentes são uma grande lufada de ar puro para nós. Novas versões estão sendo lançadas com frequência e recursos estão sendo adicionados ao PHP (basta olhar para a expressão de correspondência e o suporte de enumerações no PHP 8.1!). A digitação estrita também foi introduzida, o que também é um gigantesco passo à frente. Iremos mergulhar nas evoluções do PHP que facilitam a escrita de código limpo posteriormente.

Realmente não importa qual linguagem de programação você está usando - inegavelmente, você ficará assustado toda vez que olhar para algum código antigo que você mesmo criou. Escrever seu código de maneira limpa ajudará você a minimizar esse efeito e a entendê-lo melhor, instantaneamente, anos depois. Ao fazer isso, você está se dando um presente, porque estará codificando de uma maneira que está cada vez mais acostumado - uma maneira de escrever com a qual muitas pessoas estão acostumadas.

Pode ser a coisa mais impressionante sobre o código limpo: não importa qual tecnologia você está usando, qual biblioteca ou mesmo qual idioma. Não depende do país em que você mora e não depende dos seus anos de experiência, ou mesmo se você está programando para ganhar a vida ou como hobby sem intenções financeiras por trás disso. O código limpo é uma habilidade que, em algum momento, todo desenvolvedor aprimorará e enfrentará em sua vida. Claro, você ficará melhor nisso se focar nisso, mas apenas aprender com sua experiência sobre o que funciona e o que não funciona em um projeto de TI já é, de certa forma, aprender código limpo. Mais do que as regras, ferramentas e dicas que você encontrará neste livro, o código limpo é uma questão de experiência e anos de prática. Durante sua carreira de desenvolvedor,

Você deve sempre lembrar que a codificação é um trabalho de equipe. Agora é raro trabalhar sozinho em um projeto sem a intervenção de outros desenvolvedores - se é que isso ainda acontece. Pode ser um projeto profissional, um projeto de código aberto ou até mesmo um projeto pessoal privado. Dizer que outros desenvolvedores ajudarão em seu projeto não significa necessariamente que eles escreverão algum código. Eles também podem tentar encontrar soluções com você para os desafios técnicos que você enfrentará, e isso se aplica a todos os tipos de projeto.

De qualquer forma, fazer as coisas corretamente facilitará uma etapa crucial pela qual todos passamos ao entrar em um novo projeto: o processo de integração.

A importância do código limpo nas equipes

O processo de integração nunca é fácil. Você está entrando em um novo projeto e muitas pessoas ao seu redor já o conhecem. Você deve aprender tudo: quem faz o quê na equipe, quais são os requisitos exatos, os desafios técnicos pelos quais a equipe passou e o que está por vir. Esse processo pode durar várias semanas e até vários meses em alguns casos (também pode durar mais de um ano em alguns projetos legados gigantescos, mas isso é outro assunto). Se você pode economizar o processo de aprender as convenções de codificação porque já as conhece graças aos princípios de código limpo, então é uma coisa em que você não terá que pensar e poderá se concentrar em outras coisas.

Ser capaz de escrever um código limpo é como falar fluentemente o mesmo idioma que as outras pessoas da equipe: facilita a comunicação e a escrita do código da mesma forma, sem perceber quem escreveu qual parte.

O código limpo ajudará você com a longevidade do código. Ao trabalhar em equipe em um projeto, há grandes chances de o código-fonte ser mantido por pelo menos alguns anos. O código continuará a ser mantido anos após a sua partida. É importante fazer as coisas direito porque você não vai ficar aqui para sempre para explicar tudo o que você fez para a pessoa que ainda está trabalhando no projeto.

Escrever código de forma limpa evitará o aparecimento do que chamamos de pontos únicos de falha (SPOFs). Esses SPOFs são o pior pesadelo para qualquer projeto. Eles também são sintomáticos de projetos legados. Eles podem ser descritos como uma entidade (um desenvolvedor, uma tecnologia, uma biblioteca e assim por diante) que detém todo o projeto por si só. Se esta entidade falhar, tudo desmorona.

Um exemplo concreto de falha de uma entidade é a saída de um desenvolvedor. Se ele é a única pessoa que entende completamente como o projeto funciona e é considerado o super-herói do projeto, então é um grande problema. Isso significa que o projeto não poderá continuar sem eles e será uma dor absoluta manter o projeto após sua partida.

Um excelente exemplo de prevenção de SPoF foi dado por Fabien Potencier, o criador do framework Symfony, durante a convenção SymfonyWorld Online 2021 Winter Edition. Mesmo que o Symfony seja um projeto de código aberto, ele tem sido a pessoa que mais trabalhou nele desde a sua criação. Ele explicou durante uma conferência que uma de suas principais tarefas agora é transmitir o máximo de conhecimento sobre o framework para o máximo de pessoas para que o Symfony não dependa mais exclusivamente dele. Ele absolutamente quer evitar ser o SPOF do Symfony, e naturalmente quer que o Symfony seja mantido e desenvolvido, mesmo depois que ele não estiver mais trabalhando nele.

Uma das várias maneiras de evitar esse problema é escrever um código claro, conciso e compreensível - escrever código de forma que todos possam entender facilmente o que está acontecendo. Depois de entrar neste livro, você pode ter uma ideia melhor de como conseguir isso.

Falando em trabalho em equipe, outro ponto crítico são as revisões de código. Mesmo que entraremos em detalhes sobre isso mais adiante neste livro, vamos falar sobre eles rapidamente aqui. Se você nunca ouviu falar de revisão de código, é simplesmente um processo em que outros desenvolvedores dos projetos estão revisando, lendo e comentando as alterações que você deseja trazer para a base de código. Este processo é obrigatório na maioria dos projetos de código aberto e altamente recomendado para qualquer projeto, dados os benefícios que traz. Agora você pode imaginar facilmente que, se cada um tiver sua própria maneira de escrever código, essas revisões levarão muito mais tempo. Isso vai desde a maneira como você formata seu código ou como separa arquivos, classes e assim por diante. Se todos falarmos a mesma linguagem, podemos focar no que realmente importa durante a revisão do código: se a necessidade funcional for respeitada,

Veremos nos próximos capítulos que a definição de código limpo geralmente depende da equipe com a qual você está trabalhando. Mesmo que existam algumas regras gerais, depende principalmente do que os desenvolvedores com os quais você está trabalhando estão acostumados. Novamente, o motivo são os hábitos, mas também a consistência. Dessa forma, a equipe pode trabalhar mais rápido e melhor em conjunto.

Se por acaso você trabalha em uma área onde várias equipes estão reunidas no mesmo local, inevitavelmente notará que cada equipe tem seu próprio conjunto de regras que funcionam bem para elas, mas também regras comuns que permitirão que você converse com todos em a mesma língua. Como as soluções para seus problemas nem sempre são encontradas em sua equipe direta, mas às vezes também em pessoas ao seu redor sem trabalhar diretamente com você no mesmo projeto, será muito mais fácil ajudar uns aos outros se as regras básicas forem compartilhadas entre grupos de pessoas.

A importância do código limpo em projetos pessoais

Você pode pensar que o código limpo é menos importante para projetos pessoais, mesmo que seja apenas um pouquinho. Você estaria errado se pensasse assim por muitas razões, conforme estabelecido aqui:

Como mencionado anteriormente, tente ler o código que você escreveu há alguns anos. Há uma grande chance de você não conseguir entender brevemente o que queria fazer naquele momento. Você pode pensar que os comentários que você colocou (se você fizer isso) estão aqui para ajudar, mas vamos fazer duas perguntas, a seguir:

É disso que se trata: ser capaz de ler o código-fonte como frases simples sem ter que parar em uma linha para entendê-lo. Além disso, para repetir o que foi dito sobre código limpo em equipes: só porque você está criando um projeto por conta própria, não significa que não precisará de ajuda externa. Na verdade, é quase certo que um dia você precisará da ajuda de alguém para alguma coisa. Novamente, se você compartilhar o mesmo conjunto de regras comuns, será muito mais fácil para o ajudante trazer suas ideias. Mesmo em momentos e projetos pessoais, o trabalho do desenvolvedor é o trabalho em equipe. Sempre.

O código limpo é uma mentalidade, e essa mentalidade