[IntelliJ] 코드 템플릿 - Live Template을 이용하여 자주 사용하는 코드 템플릿화 해보기

코딩을 하다보면, 똑같은 코드를 계속 치는 경우가 생긴다. 나는 테스트 코드를 작성할 때, 기본 틀을 타이핑하는 것이 너무 귀찮았다.😭

인텔리제이를 사용하다보면 sout 등의 키워드만 입력해도 System.out.println();이 완성되는 걸 볼 수 있다.

사용자가 원하는 템플릿도 만들 수 있지 않을까? 라는 생각에 검색해보니 당연히 존재하는 기능이었다. 해당 기능을 적용해본 과정을 기록해 놓으려고 한다.

Live Template

나는 테스트 코드를 작성할 때, 아래와 같은 형식으로 작성한다.

@Test
@DisplayName("설명")
void 메서드명() {
    // given
    
    // when
    
    // then
}

복사 붙여넣기 하고, 수정해도 되지만, 매번 해주기 매우 매우 귀찮다. 인텔리제이의 Live template을 활용해보자!

참고로 맥 기준입니다!

인텔리제이를 실행하고 Preference를 클릭한다.(단축키 ⌘,)

Live Template에 들어가서 Java(원하는 종목 클릭하시면 됩니다! 전 Java로 할 거라서 Java..) 클릭 후, 우측의 + 버튼을 눌러 Live Template을 클릭한다.

그럼 단축키, 설명, 템플릿을 적는 부분이 나오고, 해당 항목들을 채워넣으면 된다.

아래의 템플릿을 적용해보겠다.

@Test
@DisplayName("")
void $METHOD_NAME$() {
    // given
    
    // when
    
    // then
}

단축키, 설명, 템플릿만 작성한다고 끝나는 게 아니다! 만약 나와 같이 $METHOD_NAME$ 같은 변수를 사용한다면 1)변수 정의를 해줘야하고, 이 템플릿을 2)어디서 사용할 것인지도 설정해줘야 한다.

1) 변수 정의는 우측의 Edit variables를 눌러준다. 그럼 내가 정의해 둔 $METHOD_NAME$를 관리할 수 있다. 나는 className()을 값으로 정해주겠다.

2)어디서 사용할 것은 하단의 Define을 눌러준다. 그 후 사용할 곳을 선택해주면 되는데, 난 Java만 선택해보겠다.

그 후 Apply를 누르면 적용이 끝난다!😎

사용해보기

템플릿 테스트를 위한 클래스를 만들고 설정해준 단축키 tc를 입력하면 아래와 같이 나온다.

엔터를 눌러주면..

잘 나오는 걸 볼 수 있다! 변수명으로 설정해 둔 부분은 커서가 생겨 바로 변경도 가능하다!