Skip to content

[Rule] Intellij 설정

lim-12 edited this page Apr 26, 2023 · 2 revisions

설치

공식 사이트(https://www.jetbrains.com/idea) 에서 다운받고 설치 한다.

  • 최신 Ultimate 버전을 설치

편집 환경 준비

모든 encoding을 UTF-8로 바꾼다.

  • Preferences 창에서 "encoding"으로 검색하여 모든 관련 항목을 UTF-8로 바꾼다. 대소문자 가리지 않고 코드 자동완성하기
  • Preferences 창 > Editor > General > Code Completion > Match case 체크 해제

Code Style

xml파일을 다운받아 import 하면 한번에 적용 가능합니다. image

tab을 space로

  • Preferences 창 > Editor > Code Style > Java > Tab and Indents 에서 다음과 같이 수정
    • Use tab character > 언체크
    • Tab size > 4
    • Indent > 4
    • Continuation indent > 4
    • 나머지 모두 언체크
  • Preferences 창 > Editor > Code Style > XML > Tab and Indents 부분도 Java와 같게 수정 화면에 120 캐릭터 넓이 줄 긋기
  • Preferences 창 > Editor > Code Style
    • General 탭
      • Hard wrap at 120 으로 수정 코드에 마우스 올려 놓을 때 quick java doc 창이 뜨는 설정
  • Preferences 창 > Editor > General > Other 구역 > Show quick documentation on mouse move > 체크 if 무에 대한 선택적 brace 및 else 문 new line 설정
  • Preferences 창 > Editor > Code Style > Java > Wrapping and Braces 탭
    • 'if()' statement
      • Force braces > When multiline
      • 'else' on new line > 체크 루프 문에 대한 강제 brace
  • Preferences 창 > Editor > Code Style > Java > Wrapping and Braces 탭
    • 'for()' statement
      • Force braces > Always
    • 'while()' statement
      • Force braces > Always
    • 'do ... while()' statement
      • Force braces > Always
      • 'while' on new line > 체크 try catch 문 new line 설정
  • Preferences 창 > Editor > Code Style > Java > Wrapping and Braces 탭
    • 'try' statement
      • 'catch' on new line > 체크
      • 'finally' on new line > 체크 메서드 시그니처 파라미터 개수가 길 때 콤마 단위로 new line 설정
  • Preferences 창 > Editor > Code Style > Java > Wrapping and Braces 탭
    • Method declaration paramters > Chop down if long 설정
      • Align when multiline > 체크 X 메서드 호출 파라미터 개수가 길 때 콤마 단위로 new line 설정
  • Preferences 창 > Editor > Code Style > Java > Wrapping and Braces 탭
    • Method call arguments > Chop down if long 설정
      • Align when multiline > 체크 X 메서드 체이닝 사용 시 1줄에 점(.) 1개만 찍기
  • Preferences 창 > Editor > Code Style > Java > Wrapping and Braces 탭
    • Chained method class > Chop down if long 설정
      • Align when multiline > 체크 X

테스트코드 생성 템플릿변경(given, when, then) 자동생성

테스트코드에서 주로 사용하는 given, when, then 을 테스트코드 생성시 자동으로 생성할 수 있다. Intellij에서 테스트코드 자동생성은 다음과 같다. ⌘ + n image 이때 생성되는 테스트 코드의 템플릿은 Edit Template 을 눌러 변경가능하다. image 설정후 적용됨을 확인할 수 있다. image

Auto import shortening 기능 off

intellij default 설정으로 같은 클래스내 import가 5개 이상이면 * 으로 축약됩니다. 해당 기능을 off 시키는 설정입니다. image

Usage, implementations, inheritors 표시

intellij default 설정에는 해당 클래스나 메서드를 사용하는 곳이나 인터페이스를 구현하고 있는 구현체, 해당 클래스를 상속받는 자식 클래스들을 찾기 어렵습니다.

  • 상속받는 자식 클래스 및 구현체 확인 방법 : Control + H 단축키로 구현체, 상속받는 자식 클래스 확인해야됩니다.
  • 해당 메서드나 클래스의 사용하는 곳 확인 방법 : ⌘ + 클래스 및 메서드 시그니처 클릭을 해야되는 번거로움이 존재합니다. 해당 옵션은 이를 가시적으로 표현할 수 있는 옵션입니다. image Editor > inlay Hints > Code version에서 Usages와 inheritors를 체크하시면 됩니다. 이를 사용하면 아래와 같이 가시적으로 명시가 되며, usages나 implementation, inheritors를 클릭하여 실제 사용하는 부분을 확인할 수 있습니다. image

사용하지않는 import 클래스 자동 제거

코딩을 할 때 다른 클래스들을 import해서 사용하고, 실제 구현 과정 중에서 이 import 클래스를 사용하지 않는 경우가 존재합니다.

  • 이때, 만약에 사용하지 않는 import들 클래스들이 남겨진 상태로 commit을 하게되면 코드가 지저분해집니다.
  • ⌘ + ⌥ + O 명령어로 지울 수는 있으나, 커밋 전에 일일히 변경된 클래스에 이런 작업을 하기에는 번거롭습니다.
  • 다음 옵션은 사용하지 않는 import 클래스가 존재할 때 자동으로 제거해주는 옵션입니다. image Editor > General > Auto Import에서 Optimize import on the fly 부분에 체크하시면 됩니다.

기타

intellij 실행 환경 최적화

  • 프로젝트 네이비게이터에서 프로젝트 이름에 오른쪽 마우스 클릭
  • Open Modules Settings 메뉴 선택
  • Modules 화면의 Sources 탭 선택
  • out / bulid / log 등 컴파일과 검색 등 작업에서 제외 시킬 폴더들을 Excluded 시키자