DEV Community

Cover image for Aumente a Qualidade do seu Código Java: Um Guia para Utilizar o JaCoCo em sua API REST
Diego de Sousa Brandão
Diego de Sousa Brandão

Posted on

16 1

Aumente a Qualidade do seu Código Java: Um Guia para Utilizar o JaCoCo em sua API REST

O Jacoco (Java Code Coverage) é uma ferramenta de análise de cobertura de código que ajuda os desenvolvedores a medir o quanto do código-fonte Java foi testado. Ele gera relatórios detalhados que indicam as porcentagens de código coberto por testes unitários e integração, bem como as linhas específicas que foram ou não executadas durante a execução dos testes.

Configurando o Jacoco em uma API REST

Aqui está um guia passo a passo sobre como configurar o Jacoco em uma API REST:

Passo 1: Configuração do Ambiente

Antes de começar, certifique-se de que você tenha o seguinte configurado no seu ambiente de desenvolvimento:

JDK (Java Development Kit) instalado.
Um projeto Java com uma API REST configurada.
Um sistema de gerenciamento de construção como o Apache Maven ou o Gradle configurado no projeto.

Passo 2: Adicionar o Plugin JaCoCo ao seu Projeto

Primeiro, você precisa adicionar o plugin JaCoCo ao seu projeto. Abra o arquivo de configuração do seu sistema de construção (pom.xml para o Maven ou build.gradle para o Gradle) e adicione as seguintes dependências:

Para Maven:

<build>
    <plugins>
        <plugin>
            <groupId>org.jacoco</groupId>
            <artifactId>jacoco-maven-plugin</artifactId>
            <version>0.8.7</version> <!-- Verifique a versão mais recente -->
            <executions>
                <execution>
                    <goals>
                        <goal>prepare-agent</goal>
                    </goals>
                </execution>
                <execution>
                    <id>report</id>
                    <phase>prepare-package</phase>
                    <goals>
                        <goal>report</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

Enter fullscreen mode Exit fullscreen mode

Para Gradle:

plugins {
    id 'jacoco'
}

jacoco {
    toolVersion = "0.8.7" // Verifique a versão mais recente
}


Enter fullscreen mode Exit fullscreen mode

Passo 2: Executar seus Testes

Agora você pode executar seus testes unitários e de integração. Certifique-se de que todos os testes relevantes sejam executados.

Passo 3: Gerar Relatórios de Cobertura

Após a execução dos testes, você pode gerar relatórios de cobertura de código. Para isso, utilize o seguinte comando Maven:

mvn clean test jacoco:report

Enter fullscreen mode Exit fullscreen mode

Ou, se você estiver usando o Gradle:

./gradlew jacocoTestReport

Enter fullscreen mode Exit fullscreen mode

Os relatórios gerados estarão disponíveis na pasta target/site/jacoco (no Maven) ou build/reports/jacoco (no Gradle).

Passo 4: Analisar os Relatórios

Agora, você pode abrir os relatórios gerados em um navegador e analisar a cobertura de código. Os relatórios incluirão informações detalhadas sobre a cobertura de código em diferentes níveis de granularidade, como classes, métodos e linhas de código.

Exemplo do relatório do jacoco:

Image description

Conclusão

O plugin Jacoco é uma ferramenta valiosa para medir a cobertura de código em projetos Java, incluindo APIs REST. Ao seguir os passos acima, você pode configurar facilmente o Jacoco em seu projeto e obter informações detalhadas sobre a cobertura de código. Isso ajuda a identificar áreas que precisam de mais testes e a melhorar a qualidade do seu código. Certifique-se de executar os testes regularmente e manter seus relatórios de cobertura atualizados para um desenvolvimento mais seguro e confiável.

Lembre-se de verificar a documentação oficial do Jacoco e as versões mais recentes para obter informações atualizadas sobre o plugin: Site oficial do Jacoco.

Espero que este tutorial tenha sido útil e informativo para você configurar o Jacoco em sua API REST.

Para saber mais sobre o JaCoCo e suas capacidades avançadas, consulte a documentação oficial em JaCoCo Documentation.

Referências:

JaCoCo - Java Code Coverage Library
JaCoCo Maven Plugin
JaCoCo Gradle Plugin

Postmark Image

Speedy emails, satisfied customers

Are delayed transactional emails costing you user satisfaction? Postmark delivers your emails almost instantly, keeping your customers happy and connected.

Sign up

Top comments (0)

Sentry image

See why 4M developers consider Sentry, “not bad.”

Fixing code doesn’t have to be the worst part of your day. Learn how Sentry can help.

Learn more

👋 Kindness is contagious

Please leave a ❤️ or a friendly comment on this post if you found it helpful!

Okay