HomeAboutMeBlogGuest
© 2025 Sejin Cha. All rights reserved.
Built with Next.js, deployed on Vercel
🍗
[New] 조규현팀/
🏪
Intellij Java 컨벤션 및 세팅
🏪

Intellij Java 컨벤션 및 세팅

Editor - Code Style (구글)Plugins - Save ActionsImport 와일드 카드 방지Java 코딩 컨벤션팁Todo 커스텀하게 (Tag 로써) 사용해보자 - 색깔, 필터 기능 강추링크
 
 
📌
팀원 끼리 Code Style 설정을 맞춘다면, 남의 코드를 볼때도 조금 덜 어색하게 느껴집니다. 코드 스타일을 공통으로 맞춘다면 코드리뷰 할때 컨벤션에 대한 리뷰를 줄일 수 있습니다. 코드 컨벤션으로 인하여 잦은 실수가 있다면 자동으로 관리되는 Save Actions 라는 플러그인을 이용해보시길 추천드립니다.

Editor - Code Style (구글)

intellij-java-google-style.xml
21.6KB
  1. File > Settings > Code Style로 들어간다
    1. windows (ctrl + Alt+ s)
    2. mac (cmd + ,)
  1. 상단의 톱니바퀴 모양을 누르고, Import Scheme > IntelliJ IDEA code style scheme을 선택한다.
  1. 다운 받은 intellij-java-google-style.xml 을 선택한다.
notion image
 
 

Plugins - Save Actions

자동 정렬, import 최적화( 자동 import, 사용하지 않는 import 제거, 순서 정렬) 기능을 저장할때 자동으로 해준다.
 
File > Settings > Save Actions 혹은
File > Settings > Other Settings > Save Actions
 
 
notion image
notion image
 
 
 

Import 와일드 카드 방지

📌
클래스를 import할때는 와일드카드(*) 없이 모든 클래스명을 다 쓴다. static import에서는 와일드카드를 허용한다. - 캠퍼스 핵데이 Java 코딩 컨벤션 중
notion image
[Intellij] java 개발 중 import 문이 자동으로 와일드카드(*)로 바뀐다면?
Intellij를 사용해서 java 개발을 하다 보면 파일 내부에 자연스럽게 많은 import 문이 만들어진다. 눈치가 빠른 사람들은 알 수도 있지만 어느 순간 내가 사용한 패키지 내의 클래스들이 하나로 묶여 와일드카드(*)로 import 될 때가 있다. Intellij의 기본 설정을 확인해보면 왜 이런 현상이 일어나는지 알 수 있다.
[Intellij] java 개발 중 import 문이 자동으로 와일드카드(*)로 바뀐다면?
https://dev-kani.tistory.com/39
[Intellij] java 개발 중 import 문이 자동으로 와일드카드(*)로 바뀐다면?
import wild card 는 나쁜 것인가? 왜 나쁘지?
Why is using a wild card with a Java import statement bad?
It is much more convenient and cleaner to use a single statement like import java.awt.*; than to import a bunch of individual classes import java.awt.Panel; import java.awt.Graphics; import java.awt.Canvas; ... What is wrong with using a wildcard in the import statement?
Why is using a wild card with a Java import statement bad?
https://stackoverflow.com/questions/147454/why-is-using-a-wild-card-with-a-java-import-statement-bad
Why is using a wild card with a Java import statement bad?
 
 

Java 코딩 컨벤션

캠퍼스 핵데이 Java 코딩 컨벤션
약어가 클래스명에서 대문자로 들어가면 단어 간의 구분을 인지하기에 불리하다. 약어가 연속된 경우 더욱 가독성을 해친다. 예를 들면 XMLRPCHTTPAPIURL과 같은 경우이다. 그래서 기본 정책으로는 약어의 중간단어를 소문자로 표기하고 프로젝트별로 모두 대문자로 표기할 약어의 목록을 명시하는 방식이 가독성을 높이고 규칙을 단순화하는데 유리하다. 즉 프로젝트 내에서 정의한 단어 목록이 없다면 'XmlRpcHttpApiUrl'과 같이 쓴다.
https://naver.github.io/hackday-conventions-java
캠퍼스 핵데이 Java 코딩 컨벤션
 
 

팁

Todo 커스텀하게 (Tag 로써) 사용해보자 - 색깔, 필터 기능 강추

이 기능 있는줄 나만 몰랐나? - 1편- Intellij에서 TODO 기능을 사용해보자.
Intellij에서 프로젝트를 열면, 항상 궁금했던 것이 하나 있는데, 도대체 이 TODO 기능은 도대체 어떻게 쓰는가? 에 대한 것이었다. 도대체 어떤식으로 작동하는 건데..라며 생각했던적이 있었다. 얼마전에 //TODO 주석이 포함된 복사하다가 오잉? 하이라이트가 되는 것을 보고, TODO기능의 쓰임에 대해서 찾아보았다. 의외로 간단했다. 주석달고 //TODO나 //FIXME를 통해서 색반전이 되면서 더 가독성이 높아진다.
이 기능 있는줄 나만 몰랐나? - 1편- Intellij에서 TODO 기능을 사용해보자.
https://sundries-in-myidea.tistory.com/116
이 기능 있는줄 나만 몰랐나? - 1편- Intellij에서 TODO 기능을 사용해보자.
notion image

링크

IntelliJ에 Google Java Style Guide 적용하기
Google Java Style Guide는 구글에서 자바를 사용할 때 코드를 작성하는 사람, 읽는 사람의 편의성을 위해 양식을 통일해둔 것이다. https://google.github.io/styleguide/javaguide.html (구글 자바 스타일 가이드 링크) 이러한 양식은 IntelliJ에서 한번에 적용시킬 수 있는 방법이 있다. https://github.com/google/styleguide 이 링크에서 intellij-java-google-style.xml 을 다운받고, File > Settings > Code Style로 들어간다 (ctrl + Alt+ s).
IntelliJ에 Google Java Style Guide 적용하기
https://velog.io/@injoon2019/IntelliJ%EC%97%90-Google-Java-Style-Guide-%EC%A0%81%EC%9A%A9%ED%95%98%EA%B8%B0
IntelliJ에 Google Java Style Guide 적용하기
Intellij Code Convention 자동화하기
개발을 하면 Line 자동 정렬, import 자동 정렬 등등 매번 해줘야 하지만.. 귀찮으니 자동화해주는 plugin과 setting을 공유합니다. :D 저장 시 Auto import, Reformat (⌥⌘L, ⌥⇧⌘L)을 자동화합니다. save가 발생할 경우에 Activate 저장 단축키를 누른 경우 Activate(CTRL + SHIFT + S) 컴파일 에러가 발생한 경우 DeActivate
Intellij Code Convention 자동화하기
https://nesoy.github.io/articles/2018-09/Intellij-Auto-Convention
Intellij Code Convention 자동화하기
캠퍼스 핵데이 Java 코딩 컨벤션
약어가 클래스명에서 대문자로 들어가면 단어 간의 구분을 인지하기에 불리하다. 약어가 연속된 경우 더욱 가독성을 해친다. 예를 들면 XMLRPCHTTPAPIURL과 같은 경우이다. 그래서 기본 정책으로는 약어의 중간단어를 소문자로 표기하고 프로젝트별로 모두 대문자로 표기할 약어의 목록을 명시하는 방식이 가독성을 높이고 규칙을 단순화하는데 유리하다. 즉 프로젝트 내에서 정의한 단어 목록이 없다면 'XmlRpcHttpApiUrl'과 같이 쓴다.
https://naver.github.io/hackday-conventions-java/
캠퍼스 핵데이 Java 코딩 컨벤션
Why is using a wild card with a Java import statement bad?
It is much more convenient and cleaner to use a single statement like import java.awt.*; than to import a bunch of individual classes import java.awt.Panel; import java.awt.Graphics; import java.awt.Canvas; ... What is wrong with using a wildcard in the import statement?
Why is using a wild card with a Java import statement bad?
https://stackoverflow.com/questions/147454/why-is-using-a-wild-card-with-a-java-import-statement-bad
Why is using a wild card with a Java import statement bad?
[Intellij] java 개발 중 import 문이 자동으로 와일드카드(*)로 바뀐다면?
Intellij를 사용해서 java 개발을 하다 보면 파일 내부에 자연스럽게 많은 import 문이 만들어진다. 눈치가 빠른 사람들은 알 수도 있지만 어느 순간 내가 사용한 패키지 내의 클래스들이 하나로 묶여 와일드카드(*)로 import 될 때가 있다. Intellij의 기본 설정을 확인해보면 왜 이런 현상이 일어나는지 알 수 있다.
[Intellij] java 개발 중 import 문이 자동으로 와일드카드(*)로 바뀐다면?
https://dev-kani.tistory.com/39
[Intellij] java 개발 중 import 문이 자동으로 와일드카드(*)로 바뀐다면?
이 기능 있는줄 나만 몰랐나? - 1편- Intellij에서 TODO 기능을 사용해보자.
Intellij에서 프로젝트를 열면, 항상 궁금했던 것이 하나 있는데, 도대체 이 TODO 기능은 도대체 어떻게 쓰는가? 에 대한 것이었다. 도대체 어떤식으로 작동하는 건데..라며 생각했던적이 있었다. 얼마전에 //TODO 주석이 포함된 복사하다가 오잉? 하이라이트가 되는 것을 보고, TODO기능의 쓰임에 대해서 찾아보았다. 의외로 간단했다. 주석달고 //TODO나 //FIXME를 통해서 색반전이 되면서 더 가독성이 높아진다.
이 기능 있는줄 나만 몰랐나? - 1편- Intellij에서 TODO 기능을 사용해보자.
https://sundries-in-myidea.tistory.com/116
이 기능 있는줄 나만 몰랐나? - 1편- Intellij에서 TODO 기능을 사용해보자.