Java 형식 지정 및 린팅

Red Hat의 Java™ 지원 또한 형식 지정 설정을 제공합니다. Eclipse 형식 지정 파일을 내보내 VS Code에서 프로젝트에 사용할 수 있습니다.

또한 Java용 Checkstyle 및 SonarLint 확장 프로그램도 있어 실시간 린팅 및 코드 분석 기능을 제공합니다.

형식 지정 도구

문서 형식 지정 명령을 사용하여 Java 파일을 형식 지정할 수 있습니다. 이전에 형식 지정 프로필을 지정하지 않은 경우 Java 파일은 기본 설정을 사용하여 형식 지정됩니다.

형식 지정 설정 적용

Eclipse 스키마의 기존 형식 지정 프로필에서 형식 지정 설정을 쉽게 적용할 수 있습니다. 예를 들어, Java 프로젝트에 Google 스타일을 적용하려면 settings.json에 다음 속성을 설정할 수 있습니다.

"java.format.settings.url": "https://raw.githubusercontent.com/google/styleguide/gh-pages/eclipse-java-google-style.xml",

이 속성은 URL 또는 로컬 파일 경로로 설정할 수 있습니다. 형식 지정 XML 파일에 여러 프로필이 포함된 경우 프로필 이름을 지정할 수 있습니다.

"java.format.settings.profile": "GoogleStyle",

형식 지정 프로필을 설정한 후 문서 형식 지정 명령은 해당 프로필을 사용하여 Java 파일을 형식 지정합니다.

형식 지정 설정 편집

Java용 확장 팩은 사용자가 기존 형식 지정 프로필을 편집하는 데 도움이 되는 편집기를 제공합니다. Java: Java 형식 지정 설정 열기 (미리 보기 포함) 명령으로 편집기를 열 수 있습니다. 편집기에서 형식 지정 설정을 변경하고 효과를 미리 볼 수 있습니다. 현재 편집기를 저장하면 변경 사항이 형식 지정 프로필에 저장됩니다.

참고: 형식 지정 설정 편집기는 로컬 형식 지정 프로필만 지원합니다. 작업 영역에 원격 형식 지정 프로필이 포함된 경우 .vscode 폴더에 다운로드하도록 안내합니다.

편집기에서 설정을 편집할 때 오른쪽 미리 보기 패널에서 변경 사항의 효과를 미리 볼 수 있습니다.

변경 사항을 실행 취소 및 다시 실행할 수도 있습니다.

SonarLint

SonarLint는 코드를 작성하면서 버그 및 보안 문제를 찾고 수정하는 데 도움이 되는 사용하기 쉬운 확장 프로그램입니다. 이 확장 프로그램은 백그라운드에서 실행되며, 마치 맞춤법 검사기처럼 품질 또는 보안 문제를 야기하는 소스 코드 문제를 강조 표시합니다. 이 확장 프로그램은 문제점이 무엇인지 알려줄 뿐만 아니라 왜 위험하며 수정 방법에 대한 인컨텍스트 지침과 예시를 제공합니다. 이 확장 프로그램은 500개 이상의 Java 규칙을 지원하며 몇 가지 빠른 수정을 포함하여 특정 품질 문제를 자동으로 수정합니다.

실시간 코드 분석

문제점은 편집기에서 직접 강조 표시되며, 마우스를 올리면 자세한 설명이 제공됩니다.

열린 파일에서 발견된 문제점은 VS Code의 문제점 패널을 통해 검토할 수도 있습니다. 해당되는 경우 문제점이 발생한 위치(예: 버그로 이어진 코드 경로)를 이해할 수 있도록 보조 코드 위치가 언급됩니다.

규칙 문서 및 해결 지침

감지된 문제점에 대해 SonarLint는 위반된 규칙 및 관련 모범 코딩 사례에 대한 전체 문서를 제공합니다. 이를 통해 문제점이 발생하는 이유와 수정 방법을 이해할 수 있습니다.

더 많은 품질 및 보안 규칙 활성화

기본적으로 SonarLint는 버그 및 취약점을 탐지하는 광범위한 규칙을 제공합니다. SonarLint 규칙 보기를 통해 더 많은 검사를 활성화할 수 있습니다.

VS Code용 SonarLint 확장 프로그램에 대한 자세한 내용은 SonarLint 웹사이트를 방문하십시오.

Checkstyle

Java용 Checkstyle 확장 프로그램을 사용하면 기존 checkstyle 구성(Google 또는 Sun의 Check) 또는 프로젝트에 대한 사용자 지정 파일을 사용할 수 있습니다. Java 파일을 편집할 때 확장 프로그램은 파일 형식을 확인하고 가능한 경우 실시간으로 빠른 수정을 제공합니다.

Checkstyle: Checkstyle 구성 파일 설정 명령을 사용하여 Checkstyle 구성 파일을 설정하고 드롭다운에서 Checkstyle 파일을 선택합니다.

Java용 Checkstyle 확장 프로그램은 실시간 린팅을 지원합니다.

그리고 일괄 검사.

상태 표시줄의 Checkstyle 상태 아이콘을 클릭하면 문제점 패널이 열립니다.

Checkstyle 구성 파일 설정

구성 파일을 설정하려면 .xml 파일을 마우스 오른쪽 버튼으로 클릭하고 Checkstyle 구성 파일 설정을 선택합니다.

또한 Checkstyle: Checkstyle 구성 파일 설정 명령을 트리거하여 파일 탐색기에서 구성 파일을 선택할 수도 있습니다. 이 확장 프로그램은 작업 영역에서 checkstyle.xml 파일을 찾아 Checkstyle 구성을 더 쉽게 만듭니다. 두 가지 내장 구성도 볼 수 있습니다.

• Google의 Check
• Sun의 Check

Checkstyle: Checkstyle 구성 설정 명령은 잠재적인 Checkstyle 구성 파일을 감지하고 나열합니다. 입력 상자에 URL을 직접 입력하여 구성 파일을 제공할 수도 있습니다.

Checkstyle: Checkstyle 버전 설정 명령을 사용하여 Checkstyle 버전을 설정할 수도 있습니다.

이 명령은

• 주 저장소에서 최신 Checkstyle 버전을 나열합니다.
• 다운로드한 모든 버전을 나열합니다.
• 지원되는 모든 버전을 나열합니다.
• 현재 사용 중인 버전에 체크 기호를 표시합니다.

또한 Checkstyle 경로를 구성하여 타사 모듈을 가져올 수도 있습니다. 예를 들어, 아래 구성을 사용한 후 checkstyle.xml에 <module name="SingleBreakOrContinueCheck"/> 또는 <module name="com.github.sevntu.checkstyle.checks.naming.SingleBreakOrContinueCheck"/>를 추가하여 해당 검사를 사용할 수 있습니다.

"java.checkstyle.modules": [ "${workspaceFolder}/src/main/resources/sevntu-checks-1.35.0.jar" ]

스타일 확인 및 위반 사항 수정

Java 파일을 편집할 때 확장 프로그램은 파일 형식을 확인하고 가능한 경우 빠른 수정을 제공합니다. 편집기의 전구 버튼을 클릭하여 사용 가능한 빠른 수정을 표시할 수 있습니다.

Java용 Checkstyle에 대한 자세한 내용은 해당 GitHub 리포지토리를 방문하십시오.