코딩 표준 및 정적 코드 검사 플러그인을 사용하는 방법-Java시작하기-php.cn

코딩 표준 및 정적 코드 검사 플러그인을 사용하는 방법

醉折花枝作酒筹

풀어 주다： 2021-05-06 10:03:22

앞으로

3276명이 탐색했습니다.

이 글에서는 코딩 표준 및 정적 코드 검사 플러그인을 사용하는 방법을 소개합니다. 도움이 필요한 친구들이 모두 참고할 수 있기를 바랍니다.

코딩 표준 및 정적 코드 검사 플러그인을 사용하는 방법

Alibaba Java 코딩 지침

먼저 소개하는 것은 Alibaba의 코딩 규칙입니다. 설치 방법은

settings->plugins里面搜索
Alibaba Java Coding Guidelines-
>install->重启Idea

로그인 후 복사

이 플러그인은 코드 결함에 중점을 두고 있습니다. 자세한 코딩 사양은 "Alibaba 개발 매뉴얼"에 정의되어 있습니다.

전체 프로젝트의 모든 파일을 확인하고 싶다면 창에서 클래스를 닫은 후 Ctrl+Alt+Shift+J 단축키를 누르거나, 해당 작업을 하시면 됩니다 아래에 표시된 것처럼. Ctrl+Alt+Shift+J 快捷键，或者如下图操作也是可以的。

코딩 표준 및 정적 코드 검사 플러그인을 사용하는 방법
检查的结果如图所示：

코딩 표준 및 정적 코드 검사 플러그인을 사용하는 방법

如果要对单个的文件进行检查的话，可以在类上右键，选中Alibaba Coding Guidelines Analyze

CheckStyle

第二个要介绍的插件是CheckStyle插件。这个插件侧重于代码的格式检查。使用方式如下图：在checkstyle面板，点击检查按钮进行检查，也可以检查单个文件。

코딩 표준 및 정적 코드 검사 플러그인을 사용하는 방법
如上图，可以看到都是一些缩进啥的编码规范，可以不用太关注。

Findbugs

findBugs-idea的作用侧重于发现代码中可能存在的bug。它检查类或者JAR 文件，将字节码与一组缺陷模式（自带检测器）进行对比以发现可能的问题。执行Findbugs编码规约扫描PMD

(Programming Mistake Detector) 是一个开源的静态代码检查工具。PMD 支持多种语言，比如项目本身的 Java，Salesforce 相关的 Apex、VisualForce，还有 JavaScript、XML 等。PMD 对于各种语言都预设了一套代码规则，也支持开发自定义规则，可以使用 Java 类或者XPath。

选中一段代码，然后右键Run PMD->Pre Defined,这里有许多检查类型可以选择，有代码样式，设计等等。

코딩 표준 및 정적 코드 검사 플러그인을 사용하는 방법

SonarLint

最后要介绍的是SonarLint插件，这个插件和Alibaba Java Coding Guidelines插件是实际项目中用到的比较多的两个插件。下面就详细介绍一下插件的安装和使用。

安装

settings->plugins里面搜索
SonarLint
>install->重启Idea

로그인 후 복사

配置SonnarLint 检查地址：

settings->Tools->SonarLint->Settings 
中增加sonarqube的地址

로그인 후 복사

如下图配置了sonarqube的地址

코딩 표준 및 정적 코드 검사 플러그인을 사용하는 방법
使用SonarList

配置好SonarList之后，就是使用了，SonarLint既可以对所有文件进行检查，检查全部文件的方式是：点击Analyze->Analyze All Files with SonarLint

결과 확인

코딩 표준 및 정적 코드 검사 플러그인을 사용하는 방법 여기에 그림 설명 삽입

단일 파일을 확인하고 싶다면 해당 클래스를 마우스 오른쪽 버튼으로 클릭하고

Alibaba 코딩 지침 분석

코딩 표준 및 정적 코드 검사 플러그인을 사용하는 방법

CheckStyle

두 번째로 소개할 플러그인은 CheckStyle 플러그인입니다. 안에. 이 플러그인은 코드 형식 검사에 중점을 둡니다. 사용법은 다음과 같습니다. 체크스타일 패널에서 체크버튼을 눌러 확인하거나, 단일 파일을 체크할 수 있습니다.

위 그림과 같이, 모두 약어입니다. 코딩 표준에 너무 많은 관심을 기울일 필요는 없습니다.

Findbugs

findBugs-idea는 코드에 존재할 수 있는 버그를 찾는 데 중점을 둡니다. 클래스 또는 JAR 파일을 검사하여 바이트코드를 일련의 결함 패턴(내장 감지기 포함)과 비교하여 가능한 문제를 찾습니다. PMD를 검사하기 위한 Findbugs 코딩 규칙 실행

(Programming Mistake Detector)는 오픈 소스 정적 코드 검사 도구입니다. PMD는 프로젝트 자체의 Java, Salesforce 관련 Apex 및 VisualForce는 물론 JavaScript, XML 등 다국어를 지원합니다. PMD에는 다양한 언어에 대한 사전 설정된 코딩 규칙 세트가 있으며 Java 클래스 또는 XPath를 사용하여 사용자 정의 규칙 개발도 지원합니다. 코드를 선택한 다음 PMD 실행->사전 정의를 마우스 오른쪽 버튼으로 클릭하세요. 코드 스타일, 디자인 등 선택할 수 있는 검사 유형이 많습니다.

여기에 이미지 설명 삽입

SonarLint / h2>🎜마지막으로 소개하고 싶은 것은 🎜SonarLint🎜 플러그인입니다. 이 플러그인과 🎜Alibaba Java Coding Guideline🎜 플러그인은 실제 프로젝트에서 더 자주 사용되는 두 가지 플러그인입니다. 다음은 플러그인 설치 및 사용법을 자세히 소개합니다. 🎜🎜Installation🎜rrreee🎜SonnarLint 구성 주소 확인: 🎜rrreee🎜아래와 같이 sonarqube의 주소를 구성하세요🎜🎜
SonarList 사용🎜🎜SonarList를 구성한 후 사용할 수 있습니다. SonarLint는 모든 파일을 확인할 수 있습니다. 모든 파일을 확인하는 방법은 다음과 같습니다.분석->SonarLint를 사용하여 모든 파일 분석. 🎜🎜🎜🎜🎜파일 편집 영역에서 단일 파일을 마우스 오른쪽 버튼으로 클릭하면 확인할 수도 있습니다. 🎜🎜🎜🎜🎜생성된 보고서는 다음과 같습니다. 여기에 위반 사항이 있습니다(예: 잠재적인 버그 및 취약점). 예: 나쁜 코드 냄새(코드 냄새)가 있는 NullPointerException. 일반적으로 말하면 버그 수준의 문제를 처리해야 하며, 악취는 무시할 수 있습니다. 또 다른 지표는 코드 중복률, 즉 코드 내에서 반복되는 코드입니다. 🎜🎜🎜🎜🎜🎜다양한 플러그인 비교🎜🎜🎜검사의 초점이 다릅니다🎜

Tools	분석 개체	Focus	응용 기술
Alibaba Java 코딩 지침	소스 코드	코드 결함	검사 메커니즘으로 실시간 감지 기능 제공
체크스타일	소스 파일	형식 결함	결함 패턴 일치
FindBugs	Bytecode	코드 결함	결함 패턴 일치, 데이터 흐름 분석
PMD	소스 코드	코드 결함	결함 모드 일치
SonarList	소스 코드	코드 결함	결함 패턴 일치, 다차원 처리

다른 검사 항목

tools	목적	항목 확인
Alibaba Java 코딩 지침	모든 잠재적인 코드 위험을 검사하세요	메서드 이름 매개변수 이름 멤버 변수 로컬 변수 열거 클래스 try-catch
CheckStyle	Java 소스 파일이 코드 사양을 준수하는지 확인하세요	Javadoc 댓글 이름 지정 사양 제목 import 문 크기 공백
FindBugs	Bug Patterns 개념을 기반으로 javabytecode(.class 파일)에서 잠재적인 버그를 찾아냅니다.	NullPoint 널 포인터 검사, 불합리한 리소스 종료 없음
PMD	잠재적인 문제가 있는지 Java 소스 파일을 확인하세요	사용하지 않는 지역 변수, 빈 캐치 블록, 사용하지 않는 매개변수, 빈 if 문, 반복되는 가져오기 문, 싱글톤 클래스 짧은/긴 변수 및 메서드 이름일 수 있는 사용하지 않는 전용 메서드
SonarList	잠재적인 코드 위험을 모두 검사하세요	메서드 이름 매개변수 이름 멤버 변수 로컬 변수 열거 클래스 try-catch