Práticas recomendadas do SQL - Como digitar código de forma limpa e perfeitamente organizada

Código Limpo

Neste post, prestaremos atenção ao estilo de codificação. Existem várias maneiras de escrever seu código, mas existem apenas algumas consideradas profissionais.

O cumprimento das regras de estilo de codificação é crucial. Quando você avança na programação, não apenas no SQL, mas em qualquer idioma, nunca trabalha sozinho. Você sempre trabalhará em equipe. Mesmo se você for um freelancer trabalhando on-line, sempre haverá alguém que lerá seu código em algum momento. Então, você descobrirá que existe uma noção que não lhe dará uma folga - a noção de código limpo.

Código limpo é um código focado e compreensível, o que significa que deve ser legível, lógico e mutável. Lembre-se - código bom não é aquele que os computadores entendem; é o que os humanos podem entender.

Geralmente, um programa pode ser criado de várias maneiras, e o código, em geral, pode ser organizado de várias maneiras. A boa prática implica que você escolherá a versão que será mais fácil de ler e entender e que não impedirá que seus colegas a atualizem quando necessário. Eles provavelmente funcionarão com base no seu código, por isso é melhor se eles não perderem tempo descobrindo idéias sob linhas de código complexas. É por isso que a suposição é que, no seu local de trabalho, você sempre digitará o código de maneira limpa - o mais simples possível, perfeitamente organizado, mantendo um fluxo lógico constante.

Bom estilo

Agora, vamos nos concentrar em outro aspecto da codificação com bom estilo. Ao atribuir nomes a variáveis ​​ou objetos SQL, sempre escolha nomes mais curtos e significativos, transmitindo informações específicas. Por "significativo", queremos dizer nomes pronunciáveis, onde uma palavra por conceito foi escolhida. Por exemplo, foi por esse motivo que escolhemos “número da compra”, não “número exclusivo da compra do cliente” na tabela “Vendas”.

Por essa razão, você não precisa se apressar em escolher nomes, pois eles devem refletir o máximo possível da funcionalidade do objeto. Os nomes constituirão mais de 80% do seu código, portanto, com quais você trabalha!

É discutido frequentemente se letras maiúsculas ou minúsculas devem ser usadas na codificação. A verdade é: depende do seu estilo ou do estilo da empresa em que você está trabalhando. Na maioria das vezes, os profissionais capitalizam as palavras-chave SQL e escrevem os nomes dos objetos de uma maneira diferente.

Quando um nome compreende mais de uma palavra, como "número da compra", as palavras geralmente são separadas por um sublinhado ou anexadas uma à outra, e cada palavra começa com uma letra maiúscula. Ambas as abordagens são encontradas na codificação profissional. Uma coisa é certa: você não pode deixar um espaço em branco entre as palavras. O MySQL mostrará uma mensagem de erro se você tentar fazer isso.

Legibilidade do código

A terceira faceta em que vamos focar neste post é a legibilidade do seu código. Por um lado, isso diz respeito à organização horizontal e vertical do código, por outro, à cor com a qual as palavras são exibidas.

Tecnicamente, qualquer consulta SQL pode ser gravada em uma única linha. No entanto, muitas consultas são muito longas e se tornarão difíceis de ler se fizermos isso. O que precisa ser feito nesses casos é organizar o código, não apenas horizontalmente, mas também verticalmente.

Dependendo do significado em uma consulta e da maneira como queremos que sejam lidas, as palavras podem ser escritas em cores diferentes. As palavras-chave SQL são escritas em azul, nomes de objetos em preto, números em laranja e assim por diante.

Mantenha seu código

À medida que avançamos no post, você desenvolverá um olho na organização impecável do código que escreve. Por enquanto, lembre-se de que existem três maneiras principais de manter seu código bem:

1. Profissionais usam software ad-hoc que reorganiza código e cores diferentes palavras de forma consistente. Em um ambiente de codificação mais dinâmico, o tempo será um fator e a unificação do estilo de codificação será uma prioridade. É impossível ter 50 programadores em sua empresa, todos escrevendo no mesmo estilo. Não é profissional mesclar código escrito no mesmo idioma, mas em um estilo diferente. Assim, quando concluídas, partes do código de trabalho passam pela verificação de um software assim, e seu chefe terá uma pilha de códigos todos escritos no mesmo estilo.

2. Use a ferramenta analógica relevante fornecida no Workbench. Este pequeno pincel embeleza seu código. A combinação de teclas de atalho para aplicar esta função à consulta em que seu cursor está localizado é Ctrl e B. Você vê? Impressionante!

3. Se preferir limpar seu código de maneira diferente, você deve intervir manualmente e ajustá-lo conforme desejar.

Exercício

Nesta linha simples, criaremos uma tabela de teste com duas colunas - "Números" e "Palavras".

Escrevemos o código em uma linha com letras minúsculas. Observe como o MySQL mudou a cor das palavras-chave, tipos de dados e números. Agora, não estaremos lidando com um software ad-hoc, pois estamos focando no Workbench. Depois de colocar o cursor em algum lugar desta consulta, você pode pressionar o pequeno ícone de pincel para reformatar o script. Para fazer a mesma operação mais rapidamente, lembre-se do atalho Ctrl e B.

Uau! Funcionou.

As palavras-chave estão em letras maiúsculas e os dados para cada coluna da tabela começam em uma nova linha. Ótimo!

Estilo de indentação

Imagine que você tem uma preferência adicional em relação à organização horizontal desse código e ao alinhamento de todos os tipos de dados. Usando o botão tab do teclado, você pode definir INT e VARCHAR para começar no mesmo ponto horizontal. Segundo alguns usuários, esse truque melhora ainda mais a legibilidade do código.

O termo técnico é chamado de recuo. Dizemos que os nomes das colunas e seus tipos de dados foram recuados à direita.

Comentários

Outro aspecto da manutenção de um bom estilo de codificação é o uso de comentários. Essas são linhas de texto que o Workbench não executará como código; eles transmitem uma mensagem para alguém que lê nosso código. Tecnicamente, no MySQL, você pode iniciar um comentário digitando uma barra e uma estrela e fechá-lo reciprocamente com uma estrela e uma barra. Essa abordagem é usada principalmente para comentários grandes.
Para comentários de uma linha, você pode usar dois traços ou um ou mais sinais de hash. Além disso, para diferenciá-los do mero código, o MySQL Workbench marca todos os comentários em cinza.

Fantástico!

Código de execução

Por fim, gostaria de elaborar o símbolo de raio, que ajuda você a executar seu código.

Vamos começar pelo fato de seu código ser separado em blocos, conforme marcado pelo separador de ponto e vírgula. Está bem.

Portanto, se você posicionar o cursor em um bloco e pressionar o ícone de raio ou a combinação Ctrl, Shift, Enter, o SQL executará as consultas selecionadas e todas as demais.

É por isso que, se eu clicar em FROM e executar o código dessa maneira, verei a saída da instrução SELECT e descartarei a tabela de teste.

Se você deseja executar apenas a instrução sob o cursor, pressione o ícone adjacente, onde um raio e um cursor estão representados. A combinação de teclado correspondente é Ctrl e Enter.

Posso prometer que você não vai parar de usar essa combinação de teclado, pois permite ver a saída de uma determinada consulta rapidamente, sem a necessidade de executar todo o código SQL.

Bem ... espero que você tenha gostado deste post! O objetivo era conscientizá-lo da noção de codificação limpa e de codificação em bom estilo. Consideramos essas ferramentas essenciais para uma boa codificação profissional; portanto, ficaríamos felizes se você sentir que começou a criar bons hábitos de estilo de codificação.