Shulou(Shulou.com)06/02 Report--

This article is to share with you about how to check the code quality of PMD and FindBug. The editor thinks it is very practical, so I share it with you. I hope you can get something after reading this article.

Last year, I did the development specification management of the project team and sorted out the use of related tools, of which PMD, FindBug and CheckStyle are the most commonly used tools, of course, this kind of tools can not completely replace "walk-around".

Tools

Purpose

Check item

FindBugs

Check .class

Based on the concept of Bug Patterns, find the potential bug in javabytecode (.class file)

Mainly check bug patterns in bytecode, such as NullPoint null pointer check, failure to reasonably close resources, misjudgment of the same string (= =, not equals), etc.

PMD

Check the source file

Check for potential problems in Java source files

It mainly includes:

Empty try/catch/finally/switch statement block

Unused local variables, parameters, and private methods

Empty if/while statement

Overly complex expressions, such as unnecessary if statements, etc.

Complex class

CheckStyle

Check the source file

Main focus on format

Check whether the Java source file conforms to the code specification

It mainly includes:

Javadoc comment

Naming convention

Unnecessary and useless Imports

Size metrics, such as overly long methods

Missing the necessary space Whitespace

Duplicate code

1. PMD--Java code static analysis tool

1. Install PMD in eclipse

(1) in Eclipse, select Help- > Install New Software

(2) Click Add in the pop-up window.

(3) enter Name and download address: https://sourceforge.net/projects/pmd/files/pmd-eclipse/update-site/

(4) choose a suitable version

(5) restart after installation.

(6) PMD form is displayed to the page: widows- > open perspective- > other

2. PMD check code

PMD check method: check a project, check the subordinate files of the project, and check the expanded classes.

Check method: right-click the file to be checked to select the PMD option, select the Check Code With PMD option to check the code. The error message is displayed in the violation Overview box, as shown in the following figure:

Note: Element: files checked

# Violation/LOC (line of code abbreviation) is: number of warnings / number of lines of source code x1000.

# Violations/Method: number of warnings divided by the number of methods (average error per method in the class)

# Project: project

Right-click anywhere in the box to display the functions corresponding to the four option buttons

1) Filter Resource: whether to show the following projects

2) Filter Priorities: the warning level you want to display (5 levels, with red as the most serious warning)

3) Presentation Type: structure of the display

4) clear PMD violations: clear the information in Violations Outline

3. Check the code specification

Double-click the error element under the "Element" column to display the class file where the warning is located. The details of the error are displayed in the Violations Outline box. When you right-click the warning message displayed in the box, there are four functional options.

1) Show details: displays the details of the error, as shown in the following figure:

2) Mark as reviews: Mark warning messages

3) Remove Violation (s): clear error messages

4) clear violations reviews: clear the previous tag.

4. Generate a report

Right-click the project, select "PMD"-> "Generatereports", and generate a reports directory under the root directory of the current project, which stores the result report of the code inspection. According to the report, you can locate the package in which the error is located, the class in which it is located, and the level of the error, the triggered rule set and rules, so that it is easy for us to count.

II. Findbugs

1. Install Findbugs in eclipse

(1) download edu.umd.cs.findbugs.plugin.eclipse_3.0.0.20140706-2cfb468.zip package from the official website http://findbugs.sourceforge.net/downloads.html

(2) extract the contents of the compressed file to the eclipse\ plugins directory under the myeclipse installation directory.

(3) Open Esclipse → Preferences → Java. If FindBugs is displayed, the installation is successful, otherwise the installation fails.

2. Check the code

Right-click on the Project or Package and Class where you want to test bug, as shown below:

After the detection, the bug information will be displayed in Bug Explorer as shown below:

Clicking on the gray bug will expand the bug message, and double-clicking the red bug will locate the bug.

The above is how to check the code quality of PMD and FindBug. The editor believes that there are some knowledge points that we may see or use in our daily work. I hope you can learn more from this article. For more details, please follow the industry information channel.

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.