Покрытие кода и статический анализ
Интегрируйте в сборку Gradle инструменты покрытия кода, такие как JaCoCo, и инструменты статического анализа, такие как Checkstyle и PMD.
«Покрытие кода и статический анализ» — бесплатный урок Groovy & Gradle: JVM Automation and Build Engineering на CoddyKit. Это урок 3 из 4. Ты можешь прочитать весь урок бесплатно ниже — а потом практиковать его прямо в браузере с встроенным редактором кода и ИИ-репетитором 24/7. Это часть пути обучения Groovy & Gradle: JVM Automation and Build Engineering, и твой прогресс синхронизируется между веб-версией и приложением CoddyKit. Курс Groovy & Gradle: JVM Automation and Build Engineering содержит 4 уроков всего.
Части этого урока еще не переведены и отображаются на английском.
Welcome to Code Quality
Ensuring high-quality code is crucial for reliable software. In this lesson, we'll explore two key practices:
- Code Coverage: How much of your code is tested?
- Static Analysis: Does your code follow best practices and style guidelines?
These tools help you write better, more maintainable code by identifying issues early.
Understanding Code Coverage
Code coverage measures the percentage of your source code that is executed by your tests. It's a metric that tells you how thoroughly your tests are exercising your application's logic.
While high coverage doesn't guarantee bug-free code, it indicates a good foundation of testing and helps pinpoint untested areas.
Meet JaCoCo for Coverage
JaCoCo (Java Code Coverage) is a popular and free code coverage library for Java projects, which works seamlessly with Groovy. It integrates exceptionally well with build tools like Gradle.
JaCoCo generates detailed reports showing which parts of your code are covered by tests and which are not, helping you identify gaps.
JaCoCo Plugin & Basic Config
To integrate JaCoCo, apply its plugin in your build.gradle. This automatically adds tasks and allows you to configure report generation, specifying formats like HTML and XML.
We'll also include basic Java/JUnit setup for context.
plugins {
id 'java'
id 'jacoco'
}
repositories {
mavenCentral()
}
dependencies {
testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.0'
testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.10.0'
}
test {
useJUnitPlatform()
}
jacoco {
toolVersion = "0.8.11" // Use a recent version
}
jacocoTestReport {
reports {
xml.required = true
html.required = true
csv.required = false // Optional: disable CSV
}
}Executing JaCoCo Tasks
Once configured in build.gradle, you can run the JaCoCo test report task from your terminal. This command will execute your tests and then generate the coverage report.
The interactive HTML report can be found in build/reports/jacoco/test/html/index.html.
// In your terminal:
// gradlew clean test jacocoTestReportUnderstanding Static Analysis
Static analysis is the examination of your code without actually executing it. It's like a linter or a spell checker for your code, identifying potential issues before runtime.
It helps identify problems such as:
- Coding standard violations
- Potential bugs (e.g., null pointer dereferences)
- Security vulnerabilities
Meet Checkstyle for Style
Checkstyle is a development tool that helps programmers write Java (and often Groovy) code that adheres to a coding standard. It automates the process of checking code against a predefined set of rules.
By catching style and common error violations early, it improves code consistency and readability.
Checkstyle Plugin & Basic Config
To integrate Checkstyle, apply its plugin in your build.gradle. You'll typically point it to a ruleset file, often located within your project's config/checkstyle directory, or use a default.
This configuration also ensures reports are generated in useful formats like HTML and XML.
// build.gradle
plugins {
id 'java'
id 'jacoco'
id 'checkstyle' // Add this line
}
// ... other existing configurations like repositories, dependencies, test block ...
checkstyle {
toolVersion = "10.12.7" // Use a recent version
// Point to your custom ruleset file (e.g., a Google style guide)
configFile = file("${project.rootDir}/config/checkstyle/checkstyle.xml")
}
tasks.withType(Checkstyle) {
reports {
xml.required = true
html.required = true
}
}Executing Checkstyle Tasks
After configuration, you can run Checkstyle from your terminal. It will analyze your source code and generate reports without compiling or running tests.
You can find the HTML report in build/reports/checkstyle/main.html for your main source code.
// In your terminal:
// gradlew checkstyleMainQuick Check on Quality Tools
You've learned about two powerful tools for code quality. Let's test your understanding.
Recap: Quality Assurance
In this lesson, you learned how to integrate essential quality assurance tools into your Gradle build:
- JaCoCo: For measuring code coverage, showing how much of your code is exercised by tests.
- Checkstyle: For static analysis, enforcing coding standards and identifying potential issues without running the code.
These tools are vital for maintaining high-quality, readable, and maintainable software.
Часто задаваемые вопросы
Урок «Покрытие кода и статический анализ» бесплатный?
Да — полный текст урока «Покрытие кода и статический анализ» бесплатно доступен здесь в веб-версии. Чтобы практиковать его интерактивно (встроенный редактор кода и ИИ-репетитор 24/7) и разблокировать остальной курс Groovy & Gradle: JVM Automation and Build Engineering, подпишись на CoddyKit PRO. Курс Groovy & Gradle: JVM Automation and Build Engineering содержит 4 уроков всего.
Чему я научусь в уроке «Покрытие кода и статический анализ»?
Интегрируйте в сборку Gradle инструменты покрытия кода, такие как JaCoCo, и инструменты статического анализа, такие как Checkstyle и PMD. Ты практикуешь Groovy & Gradle: JVM Automation and Build Engineering с помощью реального кода, который запускаешь прямо в браузере, и ИИ-репетитор 24/7 отвечает на твои вопросы во время урока.
Нужен ли мне опыт, чтобы начать Groovy & Gradle: JVM Automation and Build Engineering?
Предыдущий опыт не требуется. Groovy & Gradle: JVM Automation and Build Engineering на CoddyKit структурирован для всех уровней — от новичков до продвинутых, поэтому ты можешь начать отсюда или с самого начала и учиться в своем темпе. Это урок 3 из 4.
Сколько времени занимает урок «Покрытие кода и статический анализ»?
Большинство уроков CoddyKit занимают около 5–10 минут. Каждый из них компактный и интерактивный, поэтому ты постоянно делаешь прогресс и продолжаешь с того же места в веб-версии и приложении.
Можно ли писать и запускать код в этом уроке Groovy & Gradle: JVM Automation and Build Engineering?
Да. Каждый урок Groovy & Gradle: JVM Automation and Build Engineering включает встроенный редактор кода, поэтому ты пишешь и запускаешь реальный код прямо в браузере и получаешь моментальную обратную связь от AI — локальная установка не требуется.
Все уроки этого курса
- Модульное и интеграционное тестирование
- Отчёты и фильтрация тестов
- Покрытие кода и статический анализ
- Тестовые приспособления и общий код тестов