[IntelliJ] Java 프로젝트 코딩 컨벤션 적용하기

0. 코딩 컨벤션이란?

• 코딩 컨벤션은 읽고, 관리하기 쉬운 코드를 작성하기 위한 일종의 코딩 스타일 규약입니다.
• 코딩 컨벤션을 준수하면 가독성이 좋아지고, 성능에 영향을 주거나 오류를 발생시키는 잠재적 위험 요소를 줄여줍니다.
• 특히 규모가 큰 프로젝트일수록 유지보수 비용을 줄이는 데 도움이 됩니다.

이렇게 중요한 코딩 컨벤션을, 일일히 지키기엔 실수도 많고 번거롭습니다.

이를 위해 IntelliJ에서 설정하여 저장만 하면 자동으로 준수하도록 구축할 수 있습니다! 

 

1. 코딩 컨벤션 선정하기

자바 코딩 컨벤션에는 주로 구글 코딩 컨벤션과 네이버 코딩 컨벤션이 존재합니다.

네이버 : https://naver.github.io/hackday-conventions-java/
구글(번역본) : https://github.com/JunHoPark93/google-java-styleguide
구글(원본) : https://google.github.io/styleguide/javaguide.html

 

비교와 선택 가이드는 이 글을 참고해 주세요. 
이 포스트에서는 네이버 코딩 컨벤션을 적용해보겠습니다.

 

---

2. IntelliJ 에서 코딩 컨벤션 적용하기

1️⃣ naver-intellij-formatter.xml을 다운 받습니다.

 

2️⃣ Setting 메뉴로 이동합니다.

Windows : File > Setting (단축키 : Alt + Shift + S) 
Mac : IntelliJ IDEA > Setting (단축키 : Command + , ) 

 

3️⃣ Editor > Code Style > Java 메뉴로 이동합니다.

Scheme 항목의 오른쪽에 있는 톱니바퀴 아이콘을 클릭하고 Import Scheme > IntelliJ IDEA Code Style XML을 선택합니다.

 

4️⃣ 다운로드 받은 naver-intellij-formatter.xml 파일을 선택합니다.

5️⃣ To 항목에 이름을 설정하고 OK를 선택합니다. (IntelliJ에서 전역적으로 사용되는 이름입니다.)

6️⃣ Scheme에 5️⃣ 에서 설정한 이름을 선택하고 OK를 선택하여 설정을 확정합니다.

 

7️⃣ 이제 에디터 창에서 아래 단축키를 누르면 지정한 코드 스타일에 맞게 자동으로 코드가 수정됩니다.

Windows : Ctrl + Alt + L
Mac : Command + Option + L

 

8️⃣ 파일의 마지막에 새줄 문자가 없는 경우 자동으로 추가하기 위해 General 메뉴로 이동하여 Ensure every saved file ends with a line break 옵션을 체크합니다.

Windows : File > Settings > Editor > General
Mac :  IntelliJ IDEA > Setting > Editor > General 

---

3. 코드 저장시 자동으로 Formatter가 동작하도록 설정하기

1️⃣ Setting 메뉴로 이동합니다.

Windows : File > Setting (단축키 : Alt + Shift + S) 
Mac : IntelliJ IDEA > Setting (단축키 : Command + , ) 

 

2️⃣ Tools > Actions on Save 메뉴에서 아래와 같이 Reformat code와 Optimize imports를 체크하고 OK를 선택하여 설정을 적용합니다.

 

참고

https://velog.io/@nefertiri/%EC%9D%B8%ED%85%94%EB%A6%AC%EC%A0%9C%EC%9D%B4-%EC%9E%90%EB%B0%94-%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8-%EC%BD%94%EB%94%A9-%EC%BB%A8%EB%B2%A4%EC%85%98-%EC%A0%81%EC%9A%A9%ED%95%98%EA%B8%B0

인텔리제이 자바 프로젝트 코딩 컨벤션 적용하기

https://bestinu.tistory.com/64

InteliJ 네이버 Java 코딩 컨벤션 적용하기 + Checkstyle