체크 스타일

안녕!

이것은 검색 여정에서 만난 두 번째 도구이며 스타일 문제가 많은 것 같습니다.

IDE에 공통 포맷터 스타일을 설치하면 대부분이 쉽게 해결할 수 있는 것이 사실이지만 사용자 지정 및 보다 정확한 스타일 지정을 위해 이 도구가 유용할 수 있습니다.

체크 스타일

개발자에서 개발자에 이르기까지 Java 코드를 검사하는 프로세스를 약간 자동화하고 사람을 보호하고 중요한 일에 집중할 수 있도록 하는 멋진 도구입니다.

설치

다음과 같이 프로젝트에 설치하는 몇 가지 방법이 있습니다.

Github에서 가져올 수 있는 Direct JAR

당신의 IDE를 통해 그것을 사용하여 당신에게 적합한 것을 확인하십시오 list

Mavenplugin이 프로젝트의 pom.xml 파일에서 빌드 단계에서 설정됨

용법

선택한 경로에 따라 코드 규칙을 사용자 지정하는 다양한 방법이 있습니다. 이 기사에서는 플러그인 섹션 내의 pom.xml 파일에 간단한 추가를 의미하는 마지막 옵션에 대해 더 많이 작성하기로 했습니다.

<plugin>
   <groupId>org.apache.maven.plugins</groupId>
   <artifactId>maven-checkstyle-plugin</artifactId>
   <version>3.1.1</version>
   <configuration>
     <consoleOutput>true</consoleOutput>
     <violationSeverity>warning</violationSeverity>  <!-- now build fails for Warnings -->
     <failOnViolation>true</failsOnViolation>
     <configLocation>some-dir/your-checkstyle.xml</configLocation>
     <sourceDirectories>
        <sourceDirectory>src/main/java</sourceDirectory> <!-- Root directory from where the checking process starts -->
     </sourceDirectories>
   </configuration>
   <executions>
     <execution>
       <id>validate</id>
       <phase>validate</phase>
       <goals>
         <goal>check</goal>
       </goals>
     </execution>
   </executions>
 </plugin>

이제 프로젝트가 빌드될 때마다 이 검사기가 트리거되고 하나 이상의 경고가 있는 경우 빌드가 실패합니다.

코드 규칙

공식 문서는 이 도구가 지원하는 모든 표준 검사의 훌륭하고 사용하기 쉬운list을 제공합니다. 특정 모듈에 대한 설명이나 세부 정보를 찾을 때 항상 참조해야 합니다.

반면에 거의 즉시 사용할 수 있는 몇 가지 사전 설정 파일이 있습니다.

google_checks.xml

sun_checks.xml

또는 목록이나 사전 설정에서 시작하여 팀과 프로젝트에 적합한 사용자 지정 항목을 만들 수 있습니다.


그것으로 충분합니다. 즐기시기 바라며 현재 또는 향후 프로젝트에 유용할 것입니다. 그러나 반드시 저를 믿지 마시고 직접 사용해 보십시오.


시리즈의 다음 기사를 기대해주세요!

Cover photo by Markus Spiske on Unsplash