Boost Java Code Quality with CheckStyle, PMD, FindBugs, SonarLint

Introduction

As a system grows, simple and stable functions can become complex, increasing the risk of instability and business loss. Improving code quality through static analysis tools helps reduce errors and makes code reviews more efficient.

1. Alibaba Java Coding Guidelines

Overview: Provides Java coding standards, categorizing violations as Blocker, Critical, or Major, with many auto‑fixes and real‑time inspection.

Installation: File > Settings > Plugins > Marketplace → search "Alibaba Java Coding Guidelines" → install → restart.

Usage:

Run via Tools > Alibaba Coding Guidelines > Scan or right‑click the project/editor and select "Scan".

Result panel shows issues grouped by severity.

Toolbar functions include rerun, expand/collapse, navigate problems, filter resolved items, export results, etc.

2. CheckStyle

Overview: Focuses on coding style and format (naming, Javadoc, whitespace, size metrics, duplicate code, unused imports). It enforces style but has limited bug‑finding capability.

Installation: File > Settings > Plugins > Marketplace → search "CheckStyle" → install → restart.

Usage: After installation, run the CheckStyle inspection from the IDE; the results mainly highlight style violations.

3. PMD

Overview: Detects potential bugs, dead code, unsafe constructs, complex expressions, duplicated code, resource leaks, etc., and allows custom rule sets.

Installation: File > Settings > Plugins > Marketplace → search "PMDPlugin" → install → restart.

Usage:

Run via Tools > Run PMD for the whole project or selected files.

Configure rule sets (predefined or custom) in File > Settings > Other Settings > PMD.

4. FindBugs

Overview: Finds real bugs such as null‑pointer dereferences, resource leaks, and incorrect string comparisons.

Installation: File > Settings > Plugins > Marketplace → search "FindBugs" → install → restart.

Usage: Analyze a file, package, module, or whole project via right‑click → "Run FindBugs"; results panel links directly to problematic code.

5. SonarLint

Overview: Extends static analysis to code health, dependencies, complexity, and duplication, offering richer rules than FindBugs.

Installation: File > Settings > Plugins > Marketplace → search "SonarLint" → install → restart.

Usage: Right‑click a project or file and select SonarLint analysis; configure a Sonar server for remote rule sets if needed.

Summary

For coding standards, Alibaba Java Coding Guidelines is sufficient. To locate bugs, combine PMD, FindBugs, and SonarLint, each complementing the others.