|Latest version||1.2 ( 13 March 2013 )|
|Requires Sonar version||3.4 or higher ( check version compatibility )|
|License||GNU LGPL 3|
Description / Features
The Java Ecosystem is a set of Sonar plugins used to monitor the quality of Java projects within Sonar.
The Java Ecosystem is a set of plugins:
- Mandatory plugins:
- Java [sonar-java-plugin]: to parse Java code source, compute metrics, etc.
- Squid [sonar-squid-java-plugin]: to compute additional metrics, check code against rules provided by the Sonar engine
- Optional plugins adding features from external tools:
- Checkstyle [sonar-checkstyle-plugin]: to check code against rules provided by Checkstyle
- FindBugs [sonar-findbugs-plugin]: to check code against rules provided by FindBugs
- PMD [sonar-pmd-plugin]: to check code against rules provided by PMD
- Surefire [sonar-surefire-plugin]: to execute unit tests with Surefire
- Cobertura [sonar-cobertura-plugin]: to get code coverage with Cobertura
- JaCoCo [sonar-jacoco-plugin]: to get code coverage with JaCoCo
Note that by default the Java Ecosystem is provided with Sonar.
You can update it from the Update Center (since Sonar 3.5) or download the latest release from this page header.
Run a Sonar Analysis
To launch a Sonar analysis of your Java project, it is recommended to use the following analyzers:
- The source directory should be set to the directory containing the top parent package. For example, if your directory structure is 'src/main/java/com/mycompany/...', the source directory must be set to 'src/main/java'.
- The source directory tree has to match the package declaration. For example, the following class:
must be located in the following directory: [mySourceDirectory]/com/mycompany/mypackage/MyClass.java. Otherwise you would get such an error while running your analysis:
Tests and Code Coverage
The default code coverage engine for unit tests can be set in Settings > Configuration > General Settings > Java > Code coverage plugin property.
To deal with unit tests and code coverage for Java project in Sonar, see Code Coverage by Unit Tests for Java Project tutorial.
To deal with integration tests and code coverage for Java project in Sonar, see Code Coverage by Integration Tests for Java Project tutorial.
Documentation on advanced parameters is available on the Analysis Parameters page.
Advanced parameters specific to Java are:
Deactivate Java bytecode analysis. The Java bytecode is analyzed by Sonar in order to extract dependencies between packages and files. These dependencies are used for instance to display the DSM (Dependency System Matrix). This bytecode analysis can be deactivated.
Java version of the source code. This property is not used by the Sonar core but can be used by Java Sonar plugin like the PMD plugin.
See Java Ecosystem FAQ.
Extending Coding Rules using XPath
New coding rules can be added using XPath. See the related documentation.
To navigate the AST, download the SSLR Java Toolkit.
Version 1.3 (unreleased) (43 issues)
Version 1.2 (16 issues)
Version 1.1 (15 issues)