Generate with Custom Templates

개요

본 문서는 eGovFrame Initializr in VSCode 확장의 CRUD Code Generation 기능 중 Generate with Custom Templates 기능을 안내한다.

Generate with Custom Templates는 사용자가 직접 작성한 Handlebars(.hbs) 템플릿 파일을 업로드하여 DDL 기반 코드를 원하는 형식으로 생성하는 기능이다. 기본 제공 템플릿 대신 프로젝트 규약에 맞는 커스텀 코드 구조를 정의할 수 있다.

사용 방법

1. DDL 입력 및 설정 과정을 먼저 완료한다. 유효한 DDL이 입력되면 버튼이 활성화된다.
2. Generate with Custom Templates 버튼을 클릭한다.
3. 파일 탐색기에서 커스텀 Handlebars 템플릿 파일(.hbs)을 선택한다.
4. 선택한 템플릿을 기반으로 코드가 생성된다.

커스텀 템플릿 파일 작성 시 Download Template Context 기능으로 다운로드한 JSON 파일을 참고하면 사용 가능한 변수 목록을 쉽게 파악할 수 있다.

커스텀 템플릿 파일 형식

커스텀 템플릿은 Handlebars(.hbs) 형식으로 작성한다. 기본 제공 템플릿 파일들은 Extension 소스코드의 templates/code/ 디렉터리에서 확인할 수 있으며, 이를 참고하여 커스텀 템플릿을 작성하면 된다.

기본 제공 템플릿 파일 목록

템플릿 컨텍스트 변수

템플릿 내에서 사용할 수 있는 변수는 다음과 같다. 전체 구조는 Download Template Context 기능으로 다운로드한 JSON 파일에서 확인할 수 있다.

최상위 변수

Column 객체 필드

attributes와 pkAttributes 배열의 각 항목에서 사용할 수 있는 필드이다.

지원 Handlebars 헬퍼

커스텀 템플릿에서 사용할 수 있는 헬퍼 목록이다.

헬퍼 사용 예시

concat — MyBatis #{} 표현식 삽입

MyBatis XML 내에서 #{ccName} 형태의 문자열을 생성해야 할 때, Handlebars {{}}와 충돌하므로 concat 헬퍼를 사용한다.

{{concat "#{" ccName "}"}}
{{!-- 출력 결과: #{registDate} --}}

setVar + unless — 첫 번째 비PK 컬럼 찾기

{{~setVar "foundFirst" false~}}
{{#each attributes}}
  {{#unless isPrimaryKey}}{{#unless @root.foundFirst}}
    AND {{columnName}} LIKE '%' || #{searchKeyword} || '%'
    {{~setVar "foundFirst" true~}}
  {{/unless}}{{/unless}}
{{/each}}

eq — PK 개수에 따른 분기 처리

{{#if (eq pkAttributes.length 1)}}
  vo.set{{pkAttributes.[0].pcName}}(id);
{{else}}
  {{!-- 복수 PK 처리 --}}
{{/if}}

템플릿 작성 예시

아래는 간단한 커스텀 VO 클래스 템플릿 예시이다.

package {{packageName}}.service;

/**
 * {{className}} Value Object
 */
public class {{className}}VO {

{{#each attributes}}
    /** {{columnName}} */
    private {{javaType}} {{ccName}};

{{/each}}
{{#each attributes}}
    public {{javaType}} get{{pcName}}() { return {{ccName}}; }
    public void set{{pcName}}({{javaType}} {{ccName}}) { this.{{ccName}} = {{ccName}}; }

{{/each}}
}