Tópicos - ZUP Checkstyle

🔹 Descrição do projeto

🔹 Introdução

🔹 Arquivo de Checkstyle

🔹 Pré-requisitos

🔹 Configurar seu projeto para usar Checkstyle

🔹 Checando seu projeto com maven

🔹 Artigos relevantes

🔹 Outros Checkstyles

Descrição do projeto

Este projeto tem como objetivo servir todos Devs da Zup a implementaremn boas práticas de convenção de código em projetos Java. O checkstyle é uma ferramenta que auxilia seu projeto a seguir uma convenção de código configurada por desenvolvedores. O objetivo é garantir a legibilidade e fácil leitura e manutenção do código.

Introdução

Checkstyle é um analisador estático de código para checar se o código fonte está de acordo com as regras de codificação. Esta ferramenta de código fonte aberto ajuda nas boas práticas de programação na qual melhora-se a qualidade do código, re-usabilidade, clareza, entre outros fatores. O Checkstyle se preocupa com a apresentação do código, portanto não analisa se a lógica do seu código está correta.

É possível verificar, por exemplo:

Comentários Javadoc;
Códigos repetitivos;
Número de Colunas (tamanho da linha);
Cabeçalhos obrigatórios;
Convenções nos nomes dos atributos e métodos;
Limite no número de parâmetros;
A utilização dos pacotes importados nas classes;
Os espaços entre caracteres e entre operadores;
Números mágicos;
Boas práticas no desenvolvimento de classes e métodos;
Código duplicado;
E muitos mais detalhes e padrões.

Portanto, pode-se verificar que o Checkstyle garante que o seu código atende a padrões e que há um bom nível de codificação.

Arquivo de Checkstyle

/src/main/resources/checkstyle.xml

Este é o arquivo que você fará download para seu projeto. Nos próximos tópicos abordaremos como configurar o checkstyle em seu projeto Java.

Pré-requisitos

Java 8+
Maven 3+
Um Projeto Java 😄

Configurar seu projeto para usar Checkstyle

Copie este arquivo para dentro do seu projeto:

https://github.com/ZupIT/zup-checkstyle-java/blob/master/src/main/resources/checkstyle.xml

Este arquivo fornece a configuração padrão de estilo de códigos da Zup.

Segue exemplo de como ele pode ficar dentro do seu projeto.

lembrando que voce pode criar um diretório exclusivo para armazenar o arquivo de checkstyle, contanto que esteja dentro do seu projeto. a localização exata dele será utilizada mais abaixo.

Configurando pom.xml (Maven):

Neste exemplo, vamos explorar a configuração do checkstyle com Maven.

Busque em seu arquivo pom.xml o trecho

<properties>
...
</properties>

É possível que seu projeto não contenha esta tag <properties>, neste caso voce pode adicionar, ele deve ficar na raiz do pom.xml, no mesmo nível do seu <artifactId> que define o id do seu artefato (projeto java).

Dentro de <properties>, adicione a chave para indicar a versão do plugin checkstyle para maven.

<checkstyle-maven-plugin.version>3.1.1</checkstyle-maven-plugin.version>

Em nosso caso, será a versão 3.1.1.

Deverá ficar assim:

<properties>
    <checkstyle-maven-plugin.version>3.1.1</checkstyle-maven-plugin.version>
</properties>

Caso seu projeto já contenha outras configurações no <properties>, esta deverá ser mais uma delas.

Na sequência, procure pela área de do seu pom.xml - Caso não exista, voce pode criar esta na raiz do seu pom.xml e adicionar conforme exemplo abaixo (Já configurando o plugin do checkstyle):

<build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-checkstyle-plugin</artifactId>
                <version>${checkstyle-maven-plugin.version}</version>
                <executions>
                    <execution>
                        <id>validate</id>
                        <phase>validate</phase>
                        <configuration>
                            <configLocation>checkstyle.xml</configLocation>
                            <encoding>UTF-8</encoding>
                            <consoleOutput>true</consoleOutput>
                            <failsOnError>false</failsOnError>
                            <failOnViolation>true</failOnViolation>
                            <violationSeverity>warning</violationSeverity>
                        </configuration>
                        <goals>
                            <goal>check</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

Explicação do plugin checkstyle para maven:

Para quem é chegado no Mave, voce pode notar que o plugin define um novo Goal (mojo) chamado de check, este goal vai ser executado durante a fase de validação do build do projeto, definido na tag validate, ou seja durante a validação, ele fará a checagem do código usando o arquiovo de checkstyle definido pela chave <configLocation>checkstyle.xml</configLocation>.

Note que a chave aponta para o arquivo checkstyle.xml, que em nosso exemplo está na raiz do projeto, se estivesse em um diretório mais interno, devemos usar um caminho relativo (sem barras no inicio) para indicar onde o arquivo checkstyle.xml se encontra em nosso projeto.

Na sequencia do podemos ver outras tags importantes que informam o comportamento do plugin checkstyle ao analisar nosso código:

<consoleOutput>true</consoleOutput>

Informa que ele deve imprimir no console o resultado da chacagem.

<failsOnError>false</failsOnError>

Informa que se caso de Erros durante a checagem de estilo, o plugin deve impedir o build do projeto até que o código seja ajustado.

<failOnViolation>true</failOnViolation>

Informa que se caso de Violações de estilo, o plugin deve impedir o build do projeto até que o código seja ajustado.

<violationSeverity>warning</violationSeverity>

Define qual o nível de severidade para Violações de estilo, e este nível define diretamente se a configuração da tag <failOnViolation>true</failOnViolation> impedirá ou não o build. Outros Níveis

Relátorios do Checkstyle

Na mesma linha do plugin maven, é possível configurar como a execução do plugin deve gerar relatórios no console ou na sua IDE. Para isso, basta incluir na raiz do seu pom.xml a seguinte configuração, note que ela contém a maioria das tags também definidas no plugin do checkstyle maven para o build da aplicação.

<reporting>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-checkstyle-plugin</artifactId>
                <version>3.1.1</version>
                <configuration>
                    <configLocation>${project.basedir}/checkstyle.xml</configLocation>
                    <encoding>UTF-8</encoding>
                    <consoleOutput>true</consoleOutput>
                    <failsOnError>true</failsOnError>
                    <linkXRef>true</linkXRef>
                    <failOnViolation>true</failOnViolation>
                    <enableFilesSummary>true</enableFilesSummary>
                </configuration>
            </plugin>
        </plugins>
    </reporting>

Com isso, voce está pronto para garantir que seu código sempre estará de acordo com a convenção de código adotada por nós Zuppers.

Para mais detalhes sobre o plugin maven, confira aqui

Checando seu projeto com maven

Para rodar a checagem do seu projeto, basta usar este comando maven no shell/console:

# mvn checkstyle:check

Feito isto... se projeto estiver 100% o relatório não trará nenhum resutado além da informação de sucesso.
Em caso de violações do checkstyle por seu código, será exibido um relatório como este:

Perceba que no relatório são apontados quais violações ocorrem, em que arquivos de código e em quais linhas elas ocorrem - facilitando muito a adaptação do seu código à convenção de estilo da Zup.

haderaraujozup/zup-checkstyle-java