Boas-vindas à Alura. Eu sou Vinicius Dias e vou guiar você neste curso sobre boas práticas com PHP.
Audiodescrição: Vinícius é um homem branco com olhos castanhos, cabelo escuro e curto, bigode e cavanhaque. Usa uma camiseta preta com a frase "Make PHP Great Again" (Faça o PHP Grande Novamente), com um elefante no meio. Ao fundo, parede lisa sem decorações com uma iluminação rosa.
Se você já sabe PHP e conhece orientação a objetos, mas quer aprender sobre boas práticas para escrever um código mais interessante e fácil de dar manutenção, este curso é para você.
Neste curso, vamos aprender a tornar o código mais legível, mais fácil de manter e mais simples de implementar novas funcionalidades.
Para isso, abordaremos temas como:
Vamos explorar um pouco sobre esses assuntos e, durante cada aula, deixaremos referências para você se aprofundar.
Para aproveitar este curso, é necessário que você já tenha alguma familiaridade com o terminal. Vamos trabalhar com uma aplicação pela linha de comando, então, apesar de não precisar saber vários comandos, a tela de comandos não pode ser um obstáculo.
Também é importante que você já conheça PHP com a sintaxe de orientação a objetos. Não é necessário dominar orientação a objetos, mas é essencial entender e conhecer os conceitos.
Além disso, é fundamental saber o que é Composer e já o tenha instalado em sua máquina, pois o utilizaremos para duas finalidades: gerar um autoloader e instalar uma ferramenta de testes. Não utilizaremos nenhuma ferramenta externa ou componente externo para executar o código, mas para os testes, sim.
É necessário que você tenha, pelo menos, a versão
8.3do PHP instalada na sua máquina. Qualquer versão mais recente também serve.
Isso porque o que faremos nesse curso será com o código moderno do PHP.
Depois de dar esses recados sobre o que vamos aprender e o que você já precisa saber, te esperamos no próximo vídeo, onde conheceremos a aplicação que está com um código bem peculiar para que possamos melhorá-lo bastante.
Vamos conhecer a aplicação cujo código vamos modificar e melhorar. Trata-se de uma aplicação chamada Adopet, destinada a abrigos de adoção de animais de estimação.
Nessa aplicação, vamos cadastrar abrigos e animais nesses abrigos. Ela é uma aplicação que roda na linha de comando, no console. Dessa forma, ela será executada nos computadores de algumas pessoas voluntárias nos abrigos.
Para que esses dados não fiquem salvos nos computadores de cada uma das pessoas, utilizaremos um serviço externo, uma API externa. Disponibilizamos uma atividade de "Para Saber Mais" para você criar essa API utilizando o site mockapi.io. Em cinco minutos, será possível ter uma API pronta.
No código já disponibilizado, você deve entrar no
projeto-inicial.phpe substituir o endereço referente aomockapi.iopelo endereço da API que você criar.
Ao fazer uma busca no código pelo endereço https://66f610a1436827ced975d41f.mockapi.io com o atalho "Ctrl + F", encontraremos quatro ocorrências que precisam ser alteradas: nas variáveis $responseBody, $curl, $response e $curl.
O sistema roda na linha de comando e possui algumas funcionalidades. Vamos executá-lo para verificar se está tudo funcionando e, em seguida, analisaremos o código para identificar o que precisa ser melhorado. Já adiantamos que há bastante a ser feito.
Abrimos o terminal na pasta do projeto e digitamos o comando php seguido do nome do arquivo PHP do projeto:
php projeto-inicial.php
BOAS VINDAS AO SISTEMA ADOPET CONSOLEDIGITE O NÚMERO DA OPERAÇÃO DESEJADA:
1 -> Listar abrigos cadastrados
2 -> Cadastrar novo abrigo
3 -> Listar pets do abrigo
4 -> Importar pets do abrigo
5 -> Sair
No terminal, recebemos uma saudação e uma indicação que precisamos digitar o número da opção desejada.
Primeiramente, listaremos os abrigos cadastrados, que é a primeira opção. Então, digitamos 1 e pressionamos "Enter".
1
Abrigos cadastrados:
O sistema exibe os abrigos cadastrados, mas não há nenhum, então apenas um espaço vazio é mostrado.
Novamente, precisamos digitar o número da opção desejada. Dessa vez, selecionamos a segunda opção para cadastrar um abrigo. Digitamos 2 e pressionamos "Enter" novamente.
2
Digite o nome do abrigo:
Dias de PetDigite o telefone do abrigo:
21999999999Digite o email do abrigo:
email@example.org
O sistema pede para digitar o nome, telefone e e-mail do abrigo. Nesse caso, passamos o nome Dias de Pet e depois um telefone e e-mail fictícios.
Abrigo cadastrado com sucesso!
O sistema confirma que o abrigo foi cadastrado com sucesso e pede para digitar a próxima opção.
Agora, verificamos se o abrigo foi realmente cadastrado, digitando novamente 1.
1
Abrigos cadastrados:
1 - Dias de Pet
Na lista, aparece o número 1, que é o ID do abrigo, e o nome Dias de Pet.
Em seguida, listamos os animais do abrigo, que é a terceira opção. Digitamos o número 3 e pressionamos "Enter".
3
Digite o id do abrigo:
1
O sistema pede para digitar o ID do abrigo. Ao digitar o ID 1, o sistema exibe os animais cadastrados, mas não há nenhum no momento.
Pets cadastrados:
Por isso, importaremos um arquivo de animais para esse abrigo. No projeto inicial, disponibilizamos uma planilha, um arquivo CSV com alguns animais para importação. O nome do arquivo é pets.csv e está na mesma pasta do projeto.
No terminal, digitamos 4 para poder importar os animais.
4
Digite o id do abrigo:
1Digite o nome do arquivo CSV:
pets.csv
O sistema pede o ID do abrigo, que é 1, e o nome do arquivo CSV. Se o arquivo estiver na mesma pasta do projeto, podemos digitar apenas o nome, pets.csv. Caso contrário, será necessário digitar o caminho do arquivo.
Após pressionar "Enter", o sistema começa a cadastrar cada um dos animais no abrigo.
Pet cadastrado com sucesso: Rex
Pet cadastrado com sucesso: Mia
Pet cadastrado com sucesso: Luna
Pet cadastrado com sucesso: Felix
Pet cadastrado com sucesso: Bella
Pet cadastrado com sucesso: Lucy
Pet cadastrado com sucesso: Apollo
Pet cadastrado com sucesso: Leopoldo
Finalizada a importação, podemos selecionar a opção 3 novamente para listar os animais do abrigo.
3
Digite o id do abrigo:
1
Depois, digitamos o ID 1 e verificamos que todos os animais estão cadastrados.
Pets cadastrados:
1 - cachorro - Rex - Poodle - 5 ano(s)
2 - gato - Mia - Siamês - 3 ano(s)
3 - cachorro - Luna - Bulldog Francês - 2 ano(s)
4 - gato - Felix - Persa - 4 ano(s)
5 - cachorro - Bella - Labrador Retriever - 6 ano(s)
6 - gato - Lucy - Sphynx - 2 ano(s)
7 - cachorro - Apollo - Husky Siberiano - 3 ano(s)
8 - gato - Leopoldo - Siamês - 4 ano(s)
Com isso, pressionamos a opção 5 para encerrar o programa.
5
Finalizando o programa...
Vamos entender o código do arquivo projeto-inicial.php. O código começa com um try-catch para verificar se há algum erro. A primeira instrução dentro do try é um loop do-while.
Dentro desse do, temos 7 comandos echo para exibir as opções iniciais e uma variável $opcaoEscolhida para recuperar o número que foi digitado com um fgets() do STDIN.
Usamos um trim() no fgets() para remover a quebra de linha. Por exemplo, quando digitamos 1 e pressionamos "Enter", o Enter também seria capturado. O trim() remove o "Enter".
projeto-inicial.php:
<?php
echo '##### BOAS VINDAS AO SISTEMA ADOPET CONSOLE #####' . PHP_EOL;
try {
do {
echo "\nDIGITE O NÚMERO DA OPERAÇÃO DESEJADA:" . PHP_EOL;
echo "1 -> Listar abrigos cadastrados" . PHP_EOL;
echo "2 -> Cadastrar novo abrigo" . PHP_EOL;
echo "3 -> Listar pets do abrigo" . PHP_EOL;
echo "4 -> Importar pets do abrigo" . PHP_EOL;
echo "5 -> Sair" . PHP_EOL;
$opcaoEscolhida = trim(fgets(STDIN));
// código omitido…
}
}
Se a $opcaoEscolhida for 1, o sistema faz uma requisição HTTP do tipo GET com file_get_contents() para /abrigos.
Com isso, é retornado um JSON, que é um formato de arquivo. O PHP possui a função json_decode(), que transforma o JSON em um array associativo do PHP, permitindo fazer um foreach e exibir os abrigos cadastrados.
if ($opcaoEscolhida == 1) {
$responseBody = file_get_contents('https://66f610a1436827ced975d41f.mockapi.io/abrigos');
$jsonArray = json_decode($responseBody, true);
echo "Abrigos cadastrados:" . PHP_EOL;
foreach ($jsonArray as $abrigo) {
$id = $abrigo['id'];
$nome = $abrigo['nome'];
echo "$id - $nome" . PHP_EOL;
}
}
// código omitido…
Se selecionamos a opção 2, o sistema pergunta o $nome, $telefone e $email do abrigo para realizar um cadastro. Desse modo, cria-se um array associativo chamado $abrigo com a função compact(), que basicamente cria um array associativo com as chaves e valores das variáveis. A chave nome terá o valor da variável $nome, e assim por diante.
Em seguida, o sistema faz uma requisição HTTP de outra forma, utilizando a extensão cURL, uma forma conhecida de realizar requisições HTTP em várias linguagens, incluindo PHP. Não é muito amigável, mas é funcional e flexível.
A requisição do tipo POST é feita para /abrigos, passando todos os detalhes do abrigo com json_encode(), ou seja, passando todas as informações como JSON para o endpoint.
Ao executar isso com curl_exec(), verificamos se o $statusCode, ou seja, o código de resposta, é menor que 400, indicando que não houve erro. Nesse caso, o sistema informa que o abrigo foi cadastrado com sucesso. Caso contrário, informa que houve um erro e mostra a resposta em $responseBody para poder entender o que aconteceu de errado.
else if ($opcaoEscolhida == 2) {
echo "Digite o nome do abrigo:" . PHP_EOL;
$nome = trim(fgets(STDIN));
echo "Digite o telefone do abrigo:" . PHP_EOL;
$telefone = trim(fgets(STDIN));
echo "Digite o email do abrigo:" . PHP_EOL;
$email = trim(fgets(STDIN));
$abrigo = compact('nome', 'telefone', 'email');
$curl = curl_init('https://66f610a1436827ced975d41f.mockapi.io/abrigos');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($abrigo));
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$responseBody = curl_exec($curl);
$statusCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
if ($statusCode < 400) {
echo "Abrigo cadastrado com sucesso!" . PHP_EOL;
} else {
echo "Erro ao cadastrar o abrigo:" . PHP_EOL;
echo $responseBody . PHP_EOL;
}
}
// código omitido…
Se a $opcaoEscolhida for a 3, o processo é semelhante à opção 1. Utilizando o ID do abrigo armazenado em $idOuNome, fazemos uma requisição do tipo GET para /abrigos/$idOuNome/pets.
Se não houver resposta, fazemos um if para indicar que o ID não foi cadastrado. Caso contrário, fazemos o json_decode() e o foreach para percorrer e exibir todos os animais.
else if ($opcaoEscolhida == 3) {
echo "Digite o id do abrigo:" . PHP_EOL;
$idOuNome = trim(fgets(STDIN));
$response = @file_get_contents("https://66f610a1436827ced975d41f.mockapi.io/abrigos/$idOuNome/pets");
if (!$response) {
echo "Id não cadastrado!" . PHP_EOL;
continue;
}
$jsonArray = json_decode($response, true);
echo "Pets cadastrados:" . PHP_EOL;
foreach ($jsonArray as $pet) {
extract($pet);
echo "$id - $tipo - $nome - $raca - $idade ano(s)" . PHP_EOL;
}
}
// código omitido…
Na opção 4, pegamos o ID do abrigo e o nome do arquivo CSV e armazenamos em $idOuNome e $nomeArquivo. Em seguida, abrimos o arquivo com fopen() e fazemos outro loop while.
Para cada linha do arquivo, pegamos os $campos já parseados como CSV, criamos um array associativo de $pet com todas as informações de um animal e fazemos a requisição POST para /abrigos/$idOuNome/pets.
Depois, armazenamos o corpo da requisição em $responseBody e vericamos o $statusCode novamente com um if. Se for 201, o animal foi criado com sucesso. Se for 404, o abrigo não foi encontrado. Caso contrário, exibimos algum erro e mostramos a resposta.
else if ($opcaoEscolhida == 4) {
echo "Digite o id do abrigo:" . PHP_EOL;
$idOuNome = trim(fgets(STDIN));
echo "Digite o nome do arquivo CSV:" . PHP_EOL;
$nomeArquivo = trim(fgets(STDIN));
$arquivo = fopen($nomeArquivo, 'r');
while ($campos = fgetcsv($arquivo)) {
$pet = [
'tipo' => $campos[0],
'nome' => $campos[1],
'raca' => $campos[2],
'idade' => $campos[3],
'cor' => $campos[4],
'peso' => $campos[5],
];
$curl = curl_init("https://66f610a1436827ced975d41f.mockapi.io/abrigos/$idOuNome/pets");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($pet));
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$responseBody = curl_exec($curl);
$statusCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
if ($statusCode == 201) {
echo "Pet cadastrado com sucesso: $pet[nome]" . PHP_EOL;
} else if ($statusCode == 404) {
echo "Id do abrigo não encontrado!" . PHP_EOL;
break;
} else {
echo "$statusCode - Erro ao cadastrar o pet: $pet[nome]" . PHP_EOL;
echo $responseBody . PHP_EOL;
break;
}
}
}
// código omitido…
Se a $opcaoEscolhida for 5, simplesmente saímos do loop. Se a opção escolhida for outra, informamos que o número é inválido.
else if ($opcaoEscolhida == 5) {
break;
} else {
echo "NÚMERO INVÁLIDO!" . PHP_EOL;
$opcaoEscolhida = 0;
}
Mais uma vez, saímos do loop e usamos um echo para exibir a frase "Finalizando o programa...". Se algum $erro ocorrer durante a execução, exibimos no catch.
try {
do {
// código omitido…
} while ($opcaoEscolhida != 5);
echo "Finalizando o programa..." . PHP_EOL;
} catch (Throwable $erro) {
echo $erro->getMessage() . PHP_EOL;
}
O código está concentrado em um único arquivo. É um sistema simples, sem muita lógica, mas tudo está em um arquivo só.
Imagine que alguém precise implementar uma nova funcionalidade na lista de abrigos, como exibir o e-mail além do nome. Essa pessoa teria que ler parte por parte, entender que a opção 1 faz parte da listagem de abrigos e ainda não saberia se em outro ponto do sistema também listamos abrigos.
Esse código está de difícil leitura e manutenção. Por isso, vamos começar a fazer uma primeira refatoração.
Refatorar é modificar o código sem alterar o comportamento.
Por que mexer no código se o comportamento não muda? Se não vamos adicionar uma funcionalidade ou melhorar a performance? O objetivo é tornar o código mais legível e fácil de manter.
Existem várias técnicas de refatoração, inclusive, há um catálogo que disponibilizaremos para você conhecer essas várias técnicas.
Nesse momento, vamos aplicar uma das técnicas: pegar um pedaço de código e extrair para uma função. Dessa forma, podemos dar um nome para esse pedaço de código. Se em outros lugares precisarmos desse mesmo pedaço, já teremos uma função criada.
No primeiro if, onde verificamos se a $opcaoEscolhida é igual a 1, vamos selecionar todo o bloco de código, do $responseBody na linha 17 até o foreach na linha 24. Em seguida, pressionamos "Ctrl + X" para recortar esse pedaço de texto.
No final do arquivo, criamos uma nova função chamada function listarAbrigos(). Ela não recebe parâmetros e não tem retorno, então é void. Abrimos o corpo da função e colamos o pedaço de código removido com o atalho "Ctrl + V".
function listarAbrigos(): void
{
$responseBody = file_get_contents('https://66f610a1436827ced975d41f.mockapi.io/abrigos');
$jsonArray = json_decode($responseBody, true);
echo "Abrigos cadastrados:" . PHP_EOL;
foreach ($jsonArray as $abrigo) {
$id = $abrigo['id'];
$nome = $abrigo['nome'];
echo "$id - $nome" . PHP_EOL;
}
}
Feito isso, voltamos à linha 17 e chamamos a função listarAbrigos() dentro do if.
if ($opcaoEscolhida == 1) {
listarAbrigos();
}
// código omitido…
Salvamos o arquivo e executamos o programa para garantir que tudo continua funcionando, que a listagem de abrigos está correta.
No terminal, executamos novamente php projeto-inicial.php para exibir o menu do sistema Adopet Console. Como queremos verificar se a primeira opção continua funcionando, pressionamos 1 e damos "Enter". A listagem de abrigos é exibida corretamente. Portanto, podemos pressionar 5 para sair.
Com isso, temos um código mais enxuto para ler na primeira opção. Inclusive, esse código tem um nome. Assim, rapidamente sabemos que ao digitar 1, listaremos abrigos. Não precisamos ler um bloco de código inteiro. Sabemos o que ele faz, mesmo sem saber como. Isso ajuda na leitura.
Essa é uma das técnicas de refatoração: extrair uma função (ou método, no caso de orientação a objetos).
Desafio: Faça o mesmo processo de refatoração para as outras opções do menu. Extrai o código de cada um dos
ifpara uma nova função, comocadastrarAbrigo(),cadastrarPet(),listarPet(), etc.
No próximo vídeo, implementaremos exatamente essa extração de funções. Se você estiver confiante, pode pular o próximo vídeo. Caso contrário, confira para garantir que a extração foi feita da mesma forma.
Vamos aplicar a técnica de extração de função, uma técnica de refatoração, nas demais opções do sistema da Adopet. Temos quatro opções, e uma já foi extraída. Falta extrair as outras três funções.
A segunda opção serve para cadastrar o abrigo de animais de estimação. Selecionamos o trecho de código, que está dentro do else if onde verificamos se a $opcaoEscolhida é igual a 2. No nosso caso, recortamos da linha 19 até a linha 41.
No else if, já chamamos a função que será denominada cadastrarAbrigo().
projeto-inicial.php:
else if ($opcaoEscolhida == 2) {
cadastrarAbrigo();
}
No final do arquivo, vamos criar uma nova function chamada cadastrarAbrigo() que não retornará nada, ou seja, void. Nela, colamos todo o código.
function cadastrarAbrigo(): void
{
echo "Digite o nome do abrigo:" . PHP_EOL;
$nome = trim(fgets(STDIN));
echo "Digite o telefone do abrigo:" . PHP_EOL;
$telefone = trim(fgets(STDIN));
echo "Digite o email do abrigo:" . PHP_EOL;
$email = trim(fgets(STDIN));
$abrigo = compact('nome', 'telefone', 'email');
$curl = curl_init('https://66f610a1436827ced975d41f.mockapi.io/abrigos');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($abrigo));
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$responseBody = curl_exec($curl);
$statusCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
if ($statusCode < 400) {
echo "Abrigo cadastrado com sucesso!" . PHP_EOL;
} else {
echo "Erro ao cadastrar o abrigo:" . PHP_EOL;
echo $responseBody . PHP_EOL;
}
}
Existem várias abordagens que poderíamos seguir. Uma delas, seria fazer a exibição das frases e recuperação dos dados do terminal no programa principal, enquanto a função cadastrarAbrigo() poderia receber esses parâmetros.
Isso seria até mais interessante, mas vamos por partes. Primeiro, vamos extrair todo o código para fazer refatorações menores. Caso você tenha feito dessa forma no desafio, saiba que preferimos a forma que você fez e você pode mantê-la.
Continuando, agora vamos para a parte de listagem de pets do abrigo. Para isso, recortamos todo o código do else if, onde verificamos se $opcaoEscolhida é igual a 3. Vamos extrai-lo para listarPetsDeAbrigo().
else if ($opcaoEscolhida == 3) {
listarPetsDeAbrigo();
}
No final do arquivo, vamos criar uma nova função, listarPetsDeAbrigo(), que também não retorna nada, e incluímos todo o código.
Note que haverá um erro no if. Se o abrigo não for encontrado, temos um continue dentro do código, que seria para continuar o loop. Mas agora essa função não está dentro de um loop.
Então, vamos comentar essa linha para que o código não gere erro de compilação. No entanto, isso pode gerar um erro na execução, mas lidaremos com isso mais adiante.
function listarPetsDeAbrigo(): void
{
echo "Digite o id do abrigo:" . PHP_EOL;
$idOuNome = trim(fgets(STDIN));
$response = @file_get_contents("https://66f610a1436827ced975d41f.mockapi.io/abrigos/$idOuNome/pets");
if (!$response) {
echo "Id não cadastrado!" . PHP_EOL;
// continue;
}
$jsonArray = json_decode($response, true);
echo "Pets cadastrados:" . PHP_EOL;
foreach ($jsonArray as $pet) {
extract($pet);
echo "$id - $tipo - $nome - $raca - $idade ano(s)" . PHP_EOL;
}
}
Estamos fazendo uma refatoração inadequada, pois estamos modificando o comportamento e causando um erro, mas é proposital. Mais adiante no curso, entenderemos o motivo disso.
Também vamos extrair uma função para fazer a importação dos animais de estimação. Basta recortar o código do else if, onde verificamos se $opcaoEscolhida é igual a 4. Chamaremos essa função de importarPets().
else if ($opcaoEscolhida == 4) {
importarPets();
}
No final do arquivo, vamos criar a function importarPets(), que não retorna nada. Dentro dela, colamos o código recortado.
function importarPets(): void
{
echo "Digite o id do abrigo:" . PHP_EOL;
$idOuNome = trim(fgets(STDIN));
echo "Digite o nome do arquivo CSV:" . PHP_EOL;
$nomeArquivo = trim(fgets(STDIN));
$arquivo = fopen($nomeArquivo, 'r');
while ($campos = fgetcsv($arquivo)) {
$pet = [
'tipo' => $campos[0],
'nome' => $campos[1],
'raca' => $campos[2],
'idade' => $campos[3],
'cor' => $campos[4],
'peso' => $campos[5],
];
$curl = curl_init("https://66f610a1436827ced975d41f.mockapi.io/abrigos/$idOuNome/pets");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($pet));
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$responseBody = curl_exec($curl);
$statusCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
if ($statusCode == 201) {
echo "Pet cadastrado com sucesso: $pet[nome]" . PHP_EOL;
} else if ($statusCode == 404) {
echo "Id do abrigo não encontrado!" . PHP_EOL;
break;
} else {
echo "$statusCode - Erro ao cadastrar o pet: $pet[nome]" . PHP_EOL;
echo $responseBody . PHP_EOL;
break;
}
}
}
Com isso, vamos ler novamente a parte principal do nosso programa. No loop do-while, temos o menu inicial com os comandos echo. Inclusive, poderíamos extrair isso para uma função chamada menu(). Fica a critério de cada um fazer isso ou não.
Em seguida, recuperamos a $opcaoEscolhida. Se a opção escolhida for 1, chamamos a função listarAbrigos(). Se for 2, chamamos cadastrarAbrigo(). Se for 3, listarPetsDeAbrigo(). E se for 4, importarPets(). As demais opções não precisam ser refatoradas, pois são apenas uma ou duas linhas.
try {
do {
echo "\nDIGITE O NÚMERO DA OPERAÇÃO DESEJADA:" . PHP_EOL;
echo "1 -> Listar abrigos cadastrados" . PHP_EOL;
echo "2 -> Cadastrar novo abrigo" . PHP_EOL;
echo "3 -> Listar pets do abrigo" . PHP_EOL;
echo "4 -> Importar pets do abrigo" . PHP_EOL;
echo "5 -> Sair" . PHP_EOL;
$opcaoEscolhida = trim(fgets(STDIN));
if ($opcaoEscolhida == 1) {
listarAbrigos();
} else if ($opcaoEscolhida == 2) {
cadastrarAbrigo();
} else if ($opcaoEscolhida == 3) {
listarPetsDeAbrigo();
} else if ($opcaoEscolhida == 4) {
importarPets();
} else if ($opcaoEscolhida == 5) {
break;
} else {
echo "NÚMERO INVÁLIDO!" . PHP_EOL;
$opcaoEscolhida = 0;
}
} while ($opcaoEscolhida != 5);
echo "Finalizando o programa..." . PHP_EOL;
} catch (Throwable $erro) {
echo $erro->getMessage() . PHP_EOL;
}
Note que, ao observar o loop do programa principal, que seria uma função main em outras linguagens, temos um código mais sucinto e fácil de ler. Mesmo que o comportamento não tenha sido alterado, fica mais fácil dar manutenção em um sistema com essa organização.
Caso desejemos, podemos extrair cada função para um arquivo ou ter um arquivo de funções. Isso seria interessante e organizaria ainda mais. Não faremos isso porque, em algum momento, essas funções serão movidas para outro lugar de outra forma.
Mas, se você quiser, pode extrair cada função para um arquivo ou todas para um único arquivo, utilizando o autoloader do Composer para fazer um único require. Isso é opcional.
Sempre que realizamos uma refatoração, precisamos executar o código para garantir que não mudamos o comportamento. Por isso, vamos executar o projeto-inicial.php no terminal:
php projeto-inicial.php
Usamos a opção 1 para listar os abrigos e a opção 3 para listar os pets desse abrigo.
Poderíamos testar o cadastro de novo abrigo e a importação de animais com as opções 2 e 4, respectivamente, mas isso geraria dados duplicados. Se você quiser fazer isso, uma dica é zerar os dados da API.
Para isso, vamos acessar o site mockapi.io onde criamos nossa API e atualizar a página. Na API Abrigos, temos apenas um abrigo cadastrado e oito pets, exatamente o que cadastramos e importamos anteriormente. Podemos zerar todos os dados, clicando no botão "Reset all".
Ou, se você preferir, pode cadastrar um novo abrigo e importar os mesmos pets em outro abrigo.
Dessa forma, nos asseguramos que a aplicação está funcionando após a refatoração. Por fim, podemos apertar 5 para sair do sistema.
Dica: Você pode usar o atalho "Ctrl + clique" na chamada de uma função para ser redirecionado ao código de declaração dessa função.
Na função cadastrarAbrigo(), temos um trecho de código que faz uma requisição do tipo POST. Essa requisição pode ter um corpo e um status code. Em importarPets(), temos várias requisições do tipo POST dentro de um loop, também com um corpo de requisição e um status code.
Note que isso é um código duplicado. A cURL, uma extensão para realizar requisições HTTP, tanto com PHP quanto com outras linguagens, não é muito amigável. Precisamos chamar uma função para iniciar, outra para definir opções e outra para executar. Como isso não é muito claro, é preciso consultar a documentação para entender cada parte.
Existem componentes em PHP que tornam isso mais interessante. Se quisermos usar um desses componentes com o PHP Composer, por exemplo, precisaríamos modificar tanto em importarPets() quanto em cadastrarAbrigos().
Sempre que precisamos mudar algo em vários lugares, isso é conhecido como bad smell ou code smell, ou seja, um mau cheiro no código.
Um mau cheiro indica que algo pode ser melhorado. É comum realizar uma refatoração e identificar um novo bad smell no código.
Assim como existe um catálogo de técnicas de refatorações, há um catálogo de bad smells. Um desses indicativos de que algo pode ser melhorado no código é ter código duplicado, ou seja, código que está em mais de um lugar.
No próximo vídeo, vamos lidar com esse mau cheiro com uma técnica de refatoração. Para isso, vamos extrair uma nova função para fazer requisições do tipo POST.
O curso PHP: aplicando boas práticas de código possui 144 minutos de vídeos, em um total de 43 atividades. Gostou? Conheça nossos outros cursos de PHP em Programação, ou leia nossos artigos de Programação.
Matricule-se e comece a estudar com a gente hoje! Conheça outros tópicos abordados durante o curso:
Impulsione a sua carreira com os melhores cursos e faça parte da maior comunidade tech.
1 ano de Alura
Assine o PLUS e garanta:
Formações com mais de 1500 cursos atualizados e novos lançamentos semanais, em Programação, Inteligência Artificial, Front-end, UX & Design, Data Science, Mobile, DevOps e Inovação & Gestão.
A cada curso ou formação concluído, um novo certificado para turbinar seu currículo e LinkedIn.
No Discord, você tem acesso a eventos exclusivos, grupos de estudos e mentorias com especialistas de diferentes áreas.
Faça parte da maior comunidade Dev do país e crie conexões com mais de 120 mil pessoas no Discord.
Acesso ilimitado ao catálogo de Imersões da Alura para praticar conhecimentos em diferentes áreas.
Explore um universo de possibilidades na palma da sua mão. Baixe as aulas para assistir offline, onde e quando quiser.
Acelere o seu aprendizado com a IA da Alura e prepare-se para o mercado internacional.
1 ano de Alura
Todos os benefícios do PLUS e mais vantagens exclusivas:
Luri é nossa inteligência artificial que tira dúvidas, dá exemplos práticos, corrige exercícios e ajuda a mergulhar ainda mais durante as aulas. Você pode conversar com a Luri até 100 mensagens por semana.
Aprenda um novo idioma e expanda seus horizontes profissionais. Cursos de Inglês, Espanhol e Inglês para Devs, 100% focado em tecnologia.
Transforme a sua jornada com benefícios exclusivos e evolua ainda mais na sua carreira.
1 ano de Alura
Todos os benefícios do PRO e mais vantagens exclusivas:
Mensagens ilimitadas para estudar com a Luri, a IA da Alura, disponível 24hs para tirar suas dúvidas, dar exemplos práticos, corrigir exercícios e impulsionar seus estudos.
Envie imagens para a Luri e ela te ajuda a solucionar problemas, identificar erros, esclarecer gráficos, analisar design e muito mais.
Escolha os ebooks da Casa do Código, a editora da Alura, que apoiarão a sua jornada de aprendizado para sempre.