23.08.26 / [intelliJ] intelliJ에 Google Java Style Guide 적용하기

[ Google Java Style Guide ]
회사 혹은 팀 프로젝트를 진행할 때 다른 사람들과 함께 협업을 하게 된다.
이 때 각자 작업하되 통일된 코드 스타일을 적용할 필요가 있다.
자바스크립트를 사용했을 때는 Pritter라는 Code Formatter 플러그인을 사용했었다.
자바를 사용해서 코드를 작성하는 경우 빠르고 쉽게 통일된 코드 스타일을 적용하기 위해서 구글에서 정해둔 스타일 가이드를 활용할 수 있다.

 

구글 자바 스타일 가이드 링크

Google Java Style Guide

 

구글 자바 스타일 가이드 github 링크 (다운로드)

GitHub - google/styleguide: Style guides for Google-originated open-source projects

 

1. intellij-java-google-style.xml 을 다운 받는다. (이클립스 사용자는 eclipse-java-google-style.xml을 받으면 된다.)

2. File - Settings - Code Style - Java (Ctrl + Alt + S 후 Code Style - Java)

3. Schema 옆에 있는 톱니 바퀴 - Import Schema - IntelliJ IDEA code syle XML

4. 다운 받아 둔 xml 파일 가져오기

5. Tab Size(탭 사이즈)와 Indent(들여쓰기) 4로 설정 후 확인

6. 나 같은 경우는 추가로
    Wrapping and Braces - Method declaration parameters - Align when multiline
    Wrapping and Braces - Chained method calls - Align when multiline 에도 체크해줬다.

 

설정 후 Ctrl + Alt + L을 누르면 설정한 스타일이 적용된다.
하지만, 굳이 단축키를 누르지 않고 저장하면 자동으로 적용되게 할 수 있다.

[ File - Settings - Tools - Actions on Save ]
1. Refornat code : 저장했을 때 자동으로 스타일을 적용해준다.
                             (Whole file : 전체 파일 적용 / Changed lines : 변경된 코드에만 적용)
2. Optimize imports : 사용되지 않는 import 삭제
3. 메서드의 위치가 바뀌거나 삭제 되는 등의 원치 않는 결과가 발생할 수 있기 때문에 그외 옵션은 사용하지 않는 것이 좋다.