This article will introduce you to coding standards and how to use static code checking plug-ins. It has certain reference value. Friends in need can refer to it. I hope it will be helpful to everyone.
Alibaba Java Coding Guidelines
The first introduction is Alibaba’s coding convention, I believe everyone is familiar with this. The installation method is
settings->plugins里面搜索 Alibaba Java Coding Guidelines- >install->重启Idea
This plug-in focuses on code defects. Detailed coding specifications have been defined in the "Alibaba Development Manual". If you are interested, you can take a look.
If you want to check all the files in the entire project, you can close the class in the window, and then press the Ctrl Alt Shift J shortcut key, or you can do the operation as shown below.
The result of the check is as shown in the figure:
If you want to check a single file, you can right-click on the class , select Alibaba Coding Guidelines Analyze
The second plug-in to be introduced is the CheckStyle plug-in. This plugin focuses on code format checking. The usage is as follows: In the checkstyle panel, click the check button to check, or you can check a single file.
#As shown in the picture above, you can see that there are some coding standards for indentation and so on, so you don’t need to pay too much attention to them.
The function of findBugs-idea focuses on finding bugs that may exist in the code. It inspects a class or JAR file, comparing the bytecode to a set of defect patterns (with built-in detectors) to find possible problems. Execute Findbugs coding convention scanning PMD
(Programming Mistake Detector) is an open source static code inspection tool. PMD supports multiple languages, such as Java for the project itself, Apex and VisualForce related to Salesforce, as well as JavaScript, XML, etc. PMD has a preset set of coding rules for various languages, and also supports the development of custom rules, using Java classes or XPath.
Select a piece of code, and then right-click Run PMD->Pre Defined. There are many inspection types to choose from, including code style, design, etc.
The last thing I want to introduce is the SonarLint plug-in, this plug-in and the Alibaba Java Coding Guidelines plug-in These are two plug-ins that are used more frequently in actual projects. The following will introduce the installation and use of the plug-in in detail.
Installation
settings->plugins里面搜索 SonarLint >install->重启Idea
Configure SonnarLint check address:
settings->Tools->SonarLint->Settings 中增加sonarqube的地址
Configure the address of sonarqube as shown below
Use SonarList
After configuring SonarList, you can use it. SonarLint can check all files. The way to check all files is: click Analyze->Analyze All Files with SonarLint.
You can also check a single file. A single file is selected by right-clicking in the file editing area:
The generated report is as follows : There are both violation issues (ie potential Bugs & Vulnerabilities) here. For example: NullPointerException, which also has bad code smells (Code Smells). Generally speaking, we need to deal with bug-level problems, and bad smells can be ignored. Another indicator is the code duplication rate, that is, the repeated code within the code.
Comparison of various plug-ins
Different focus of inspection
| Tools | Analysis objects | Focus on | Application technology |
|---|---|---|---|
| Alibaba Java Coding Guidelines | Source code | Code defects | Inspection mechanism provides real-time detection function |
| CheckStyle | Source File | Format Defect | Defect Pattern Match |
| FindBugs | Bytecode | Code defects | Defect pattern matching, data flow analysis |
| PMD | Source code | Code defects | Defect pattern matching |
| SonarList | Source code | Code defect | Defect pattern matching, multiple dimensions processing |
Different check items
| Tool | Purpose | Check items |
|---|---|---|
| Alibaba Java Coding Guidelines | Scan out all potential code hazards | Method name parameter name member variable local variable enumeration class try -catch |
| CheckStyle | Check whether the Java source file is consistent with the code specification | Javadoc comment naming specification title import statement volume size blank |
| FindBugs | Based on the concept of Bug Patterns, find potential bugs in javabytecode (.class file) | NullPoint null pointer check, no unreasonable closing of resources |
| PMD | Check Java source files for potential problems | Unused local variables, empty catch blocks, unused parameters, empty if statements, repeated import statements, Unused private methods may be Singleton class short/long variables and method names |
| SonarList | Scan out all potential code hazards | Methods Name parameter name member variable local variable enumeration class try-catch |
Related free learning recommendations: java basic tutorial
The above is the detailed content of How to use coding standards and static code checking plug-ins. For more information, please follow other related articles on the PHP Chinese website!