[IntelliJ Live Template] 자주 쓰는 코드 템플릿 등록하기

JAVA

DevBee 2023. 10. 19. 07:32

업무를 하면서 테스트 코드를 작성하다보니 동일한 메서드 형태를 매번 생성해야 하는 경우가 발생했습니다. 이를 템플릿화 하여 조금 더 편하게 사용할 수 있도록 IntelliJ가 제공하는 Live Template을 사용해보도록 하겠습니다.

1. Settings/Preferences > Editor > Live Templates로 이동

2. 목록에서 템플릿을 추가할 그룹 선택 (user를 선택하는데 그냥 + 눌러서 생성하면 바로 user 그룹에 추가됩니다.)

3. + 버튼 클릭 > Live Template 선택하여 추가

선택한 그룹 아래에 템플릿이 생성되면 원하는 내용을 작성합니다.

Abbreviation : 사용할 단축어 (ex: soutv)
Description : 단축어 설명 (optional, 자동완성 칠 때 옆에 뜸)
Template text : 단축어를 통해 삽입할 코드 구성

제가 작성한 Template text 는 다음과 같습니다.

@Test
@DisplayName("")
public void $NAME$() {
    // given
    $END$
    
    // when
    
    // then
    Assertions.assertThat();
}

$NAME$ : 입력할 수 있게 초기화 되는 커서 위치
$END$ : $NAME$ 입력 후 커서가 이동되는 위치

그 다음 Define을 클릭하여 단축어를 사용할 영역을 고릅니다.

💡참고

여기서는 method를 등록하는 것이라 Declaration을 선택했는데, soutv처럼 메서드 내에서만 사용할 거라면 Statement를 선택해도 괜찮습니다.
원하지 않는 곳에서 단축어가 사용되어 불편할 수 있으므로 사용할 곳을 지정하는 것입니다.

이제 다음과 같이 등록한 단축어를 사용하면 됩니다.

위 사진을 보면 @Test를 추가로 import 해야 합니다. 어떤 것을 import 할지 정해져 있다면 자동으로 import 하는 것이 편리합니다. 이때는 단축어 작성 시 full names으로 작성하고 Shorten FQ names 옵션을 켜주면 됩니다.

추가로 Assertions 등 static import를 항상 사용한다면 Use static import if possible 옵션을 켜면 됩니다.