Intellij에 Google Java Style Guide 적용하기.

안녕하세요.

오늘은 제 인텔리제이 프로젝트에 구글 자바 스타일 가이드를 적용시켜 코드를 통일화할 수 있는 방법을 소개하고자 합니다.

 

평소에는 팀원들간의 약속된 코드를 유지하는게 더 중요하다고 생각하고 스타일 가이드에 대한 다소 불필요하지 않나? 라는 생각이 있었으나 최근에는 생각이 바뀌어 강한 규칙을 통해 코드의 일관성을 유지하는 방법이 좀 더 탄탄한 개발조직에는 필요하다는 것을 느껴가고 있습니다.

 

이직이 잦은 개발자라는 직업의 특성상 계속해서 새로운 개발자분이 오실때마다 코드 스타일을 공유하고 코드리뷰때마다 비즈니스 로직이나 불필요한 로직이 아닌 코드 스타일을 리뷰하는 것이 매우 불필요하다는 생각이 들기도 했었는데 마침 다행이라고 생각했습니다.

 

우선 제 생각은 여기까지로 하고 적용하는 방법을 공유드리겠습니다.

 

---

Google Java Style Guide는 구글에서 자바를 사용할 때 코드를 작성하는 사람, 읽는 사람의 편의성을 위해 양식을 통일해둔 것입니다.

 

https://google.github.io/styleguide/javaguide.html 구글 자바 스타일 가이드 링크

 

이러한 양식을 IntelliJ에서 한번에 적용시킬 수 있는 방법이 있습니다.

 

아래의 링크에서 intellij-java-google-style.xml 파일을 다운받습니다.

https://github.com/google/styleguide

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

 

그 다음 인텔리제이 화면에서

 

File > Settings > Code Style로 들어갑니다. (맥 기준 preferences -> code style)

상단의 톱니바퀴 모양을 누르고, Import Scheme > IntelliJ IDEA code style scheme을 선택합니다.

그리고 다운 받은 intellij-java-google-style.xml 을 선택해줍니다.

저는 지금 셋팅이 모두 끝난 상태라 Tab Size 와 Indent 값이 4로 설정되어 있지만 다운받으신 분들은 2로 되어있을 수 있습니다. 자바는 일반적으로 Tab Size와 Indent를 4의 값으로 사용하니 이를 위해 4로 변경해줍니다.

 

또한 엔터를 쳤을 때 발생하는 탭의 사이즈 (Continuation indent) 값을 8로 수정해줍니다. (여기는 사실 팀과 논의해야합니다만 저희 팀은 8로 사용하기로 했습니다.)

 

---

이제 코드 스타일을 클래스파일 전역으로 적용하는 방법입니다.

 

각 단축키가 윈도우, 맥 OS별로 다릅니다.

 

윈도우 기준으로 Ctrl + Alt+ L

맥 OS 기준으로 Cmd + Option + L