참고

템플릿 문법

코드 생성 템플릿의 본문과 설치 경로는 Apache Velocity 문법으로 작성합니다. 템플릿이 읽을 수 있는 값과 도구 함수를 표로 모았습니다. 템플릿을 만들고 수정하는 화면은 템플릿 팩 관리, 템플릿으로 코드를 만드는 화면은 소스코드 생성 에서 설명합니다.

한눈에 보기

코드를 만들 때 테이블 하나마다 템플릿을 한 번씩 그립니다. 그때 템플릿이 읽는 값은 아래와 같습니다.

이름내용
$entity지금 만드는 테이블의 엔티티입니다. 이름, 필드 목록, 소프트 삭제 설정, 팩이 정한 엔티티 변수가 있습니다
$field엔티티의 필드(컬럼) 하나입니다. #foreach($field in $entity.fields) 로 각 필드에 대해 반복 실행합니다
$env프로젝트에서 기입한 팩의 전역 변수입니다
$table원본 테이블입니다. 테이블 이름, 스키마, PK 컬럼 목록, 컬럼 목록이 있습니다
$projectConfig프로젝트 설정입니다. 코드 생성에 사용하는 것은 Audit 설정(auditConfig)입니다
$databaseInfo대상 DBMS 의 제품 이름과 버전입니다
$paid지금 계정이 유료 플랜인지(true/false)입니다
$codegen, $types이름 변경하기, DBMS 판별, PK 선택하기, 타입 판별 같은 도구 함수입니다
$java, $ts, $py언어별 보조 함수입니다. 사용하지 않아도 $codegen, $types 만으로 만들 수 있습니다
$dateVelocity 표준 날짜 도구(DateTool)입니다

팩의 엔티티 변수 표와 필드 변수 표에 정한 변수는 그리기 직전에 $entity, $field 바로 아래로 올라옵니다. 엔티티 변수 subPackage 를 정했으면 $entity.subPackage 로 읽습니다. 같은 이름의 기본 값이 있으면 팩 변수의 값이 이깁니다.

기본 문법

문법뜻
$name, ${name}값을 출력합니다. 뒤에 글자가 바로 붙으면 ${entity.name}Service 처럼 중괄호로 감쌉니다
$!name값이 없으면 빈 글자를 출력합니다. $name 은 값이 없으면 $name 이라는 글자가 그대로 나옵니다
#set($v = …)변수에 값을 넣습니다
#if(…), #elseif(…), #else, #end조건에 따라 출력합니다
#foreach($x in $list) … #end목록의 각 항목에 대해 반복 실행합니다. 안에서 $foreach.count(1부터), $foreach.index(0부터), $foreach.hasNext 를 사용합니다
[1..3], [], {'k': 'v'}범위, 목록, 맵을 바로 만듭니다
## …, #* … *#주석입니다. 결과에 나오지 않습니다

문자열의 Java 메서드(toUpperCase(), startsWith(), substring() 등)와 목록, 맵의 메서드(size(), add() 등)는 그대로 사용합니다.

예: 엔티티 클래스

데모 쇼핑몰의 customer 테이블(customer_id, email, name, grade, created_at)로 Java 클래스를 만드는 템플릿입니다.

package ${env.package.core}.domain;

#foreach($import in $java.imports())
import $import;
#end

/** $!entity.comment */
public class ${entity.name} {
#foreach($field in $entity.fields)
#if($codegen.isPk($field.column))
    // PK
#end
    private $types.typeOf($field) ${field.name};
#end
}
  • 필드 이름($field.name)은 컬럼 이름에 프로젝트의 이름 규칙(Renamer)을 적용한 이름입니다. customer_id 는 규칙에 따라 customerId 같은 이름이 됩니다.
  • $types.typeOf($field) 는 팩의 타입 매핑으로 정한 타입의 짧은 이름(java.lang.String 이면 String)입니다.
  • $env.package.core 는 팩의 전역 변수 키를 package.core 로 정하고 프로젝트에서 값을 기입한 경우입니다.

엔티티

$entity 는 지금 만드는 테이블의 엔티티입니다. 이름을 변경한 꼴은 미리 계산해 둡니다.

속성내용
name엔티티 이름입니다. 테이블 탭의 코드 생성 설정에서 정합니다(보통 Customer 같은 PascalCase)
comment테이블 설명입니다
alias별칭입니다
varname 의 lowerCamel 입니다. 예: orderItem
snakeLower, snakeUppername 의 snake_case 입니다. 예: order_item, ORDER_ITEM
kebabLower, kebabUppername 의 kebab-case 입니다. 예: order-item, ORDER-ITEM
fields필드 목록입니다. #foreach 로 각 필드에 대해 반복 실행합니다
fieldMapDB 컬럼 이름 → 필드의 맵입니다. 컬럼 이름으로 필드 하나를 찾을 때 사용합니다
softDelete소프트 삭제 설정입니다(아래 표)
(엔티티 변수의 키)팩이 정한 엔티티 변수입니다. 예: $entity.subPackage

소프트 삭제 설정

$entity.softDelete 입니다. 소프트 삭제를 사용하지 않거나 플래그 컬럼이 없으면 enabled 가 false 인 것만 보장합니다. 아래 표에서 '자동' 은 코드를 만들 때 컬럼 타입을 보고 기입하는 값입니다.

속성내용
enabled소프트 삭제를 사용하는지
flagColumn삭제 표시 컬럼의 DB 이름
deletedValue, activeValue플래그가 boolean 이 아닐 때 삭제와 삭제 아님을 뜻하는 값(예: Y/N, 1/0)
dateColumn삭제 일시 컬럼의 DB 이름(없어도 됩니다)
dateFormat일시 컬럼이 문자열일 때 저장할 날짜 형식
flagBoolean자동. 플래그 컬럼이 boolean 인지
flagString자동. 플래그 컬럼이 문자열인지(SQL 에서 값에 따옴표를 붙일지)
flagField자동. 플래그 컬럼의 필드 이름
dateString자동. 일시 컬럼이 문자열인지
dateField자동. 일시 컬럼의 필드 이름

필드

$field 는 $entity.fields 의 한 항목입니다. 필드 이름과 확정 타입, 원본 컬럼을 함께 가집니다.

속성내용
name필드 이름입니다. 컬럼 이름에 이름 규칙(Renamer)을 적용한 이름입니다
comment필드 설명입니다
mappedType확정 타입입니다(아래 표). 지금 그리는 팩의 타입 매핑과 컬럼마다 덮어쓴 타입이 반영된 값입니다
defaultValue필드의 기본값입니다
deletedMark필드가 소프트 삭제 표시인지
metaAttributesMETA 속성 목록입니다. 항목마다 name, value 가 있습니다. $codegen.getMetaAttribute() 로 읽는 편이 쉽습니다
column원본 DB 컬럼입니다(아래 표)
(필드 변수의 키)팩이 정한 필드 변수입니다. 예: $field.customType

확정 타입

$field.mappedType 입니다.

속성내용
type중간 타입입니다. 예: M_LONG, M_STRING(아래 '중간 타입과 분류')
target팩의 언어 타입입니다. 예: java.lang.Long, number. 코드에 사용할 때는 $types.typeOf($field) 가 편합니다
category분류입니다. number, text, datetime, boolean, array, object, url 가운데 하나입니다

원본 컬럼

$field.column 의 주요 속성입니다. DB 에서 읽은 그대로입니다.

속성내용
nameDB 컬럼 이름
remarks컬럼 설명
typeDB 타입. 예: VARCHAR, BIGINT
size, decimalDigits길이와 소수 자릿수
nullableNULL 을 허용하는지
autoIncrement자동 증가인지
defaultValueDB 기본값

그 밖의 값

이름속성내용
$env(전역 변수의 키)팩의 전역 변수 표에 정하고 프로젝트에서 기입한 값입니다. 키를 package.core 처럼 점으로 나누면 $env.package.core 로 읽습니다. 기입하지 않은 변수는 정의의 기본값입니다
$tablename, remarks, schemaName, databaseName테이블 이름, 설명, 스키마, 데이터베이스
$tableprimaryKeysPK 컬럼의 DB 이름 목록
$tablecolumns원본 컬럼 목록
$projectConfigauditConfig.auditTableAudit 기준 테이블. 같은 커넥션의 테이블일 때 자동 기입됩니다
$projectConfigauditConfig.creationAuthorList, creationDateList, lastModificationAuthorList, lastModificationDateList생성자, 생성 일시, 수정자, 수정일시 컬럼의 후보 이름 목록. 직접 읽기보다 $codegen 의 Audit 함수를 사용합니다
$databaseInfodatabaseProductNameDBMS 제품 이름입니다(예: MariaDB). 제품 이름을 알 수 없으면 커넥션의 DBMS 종류(예: SQLServer)가 들어갑니다. 분기는 $codegen.isMariaDB() 같은 함수를 사용합니다
$databaseInfodatabaseProductVersion제품 버전입니다. 알 수 없으면 빈 글자입니다
$paid지금 계정이 유료 플랜인지입니다

Audit 설정을 기입하는 곳은 소스코드 생성 의 Audit Table 탭입니다.

중간 타입과 분류

NeoSQL 은 DB 컬럼 타입을 먼저 아래 중간 타입으로 변경하고, 팩의 타입 매핑이 중간 타입을 언어 타입으로 변경합니다. 분류는 $types.isDate($field) 같은 판별에 사용합니다.

분류중간 타입
textM_STRING, M_CHAR, M_CLOB
numberM_INTEGER, M_LONG, M_BIGINTEGER, M_BYTE, M_DOUBLE, M_FLOAT, M_BIGDECIMAL
booleanM_BOOLEAN
datetimeM_LOCALDATE, M_LOCALTIME, M_LOCALDATETIME, M_ZONEDDATETIME, M_SQLDATE, M_UTILDATE, M_INSTANT, M_TIME, M_TIMESTAMP
arrayM_ARRAY, M_BYTES, M_BLOB
urlM_URL
objectM_REF, M_OBJECT

codegen 함수

$codegen 은 언어와 상관없는 도우미입니다.

이름과 글자

함수내용
$codegen.toLowerCamel(value)MyName → myName
$codegen.toUpperCamel(value)myProp → MyProp, my_prop → MyProp
$codegen.toUpperUnderscore(value)MyName → MY_NAME
$codegen.toPath(a, b, …)인자마다 점(.)을 / 로 변경하고 경로로 잇습니다. 빈 인자는 건너뜁니다. toPath('com.example', 'app') → com/example/app
$codegen.join(sep, a, b, …)빈 값을 건너뛰고 구분자로 잇습니다. 겹친 구분자는 하나로 줄입니다
$codegen.replace(text, from, to)from 글자를 모두 to 로 변경합니다. 예: $codegen.replace('com.example', '.', '/') → com/example
$codegen.printIf(cond, value)cond 가 참이면 value, 아니면 빈 글자
$codegen.printVelocityVar(value)value 를 ${value} 꼴로 표기합니다. 만든 결과에 Velocity 표기를 남길 때 사용합니다
$codegen.printIgnoreFirst(count, value)count 가 1 이면 빈 글자, 아니면 value. 목록의 첫 항목 앞 구분자를 제외할 때 $foreach.count 와 함께 사용합니다

DBMS 판별과 SQL

함수내용
$codegen.isOracle(), isMySQL(), isMariaDB(), isPostgreSql(), isMsSql()대상 DBMS 인지. $databaseInfo.databaseProductName 에 DBMS 이름이 들어 있는지로 봅니다
$codegen.getColumnName(name)SQL Server 면 [name], 아니면 그대로
$codegen.useSchemaPrefix()커넥션 설정 스키마 탭의 스키마 접두어 사용 항목이 활성화되어 있는지
$codegen.getSchemaPrefix()스키마 접두어 사용 항목이 활성화되어 있으면 스키마.(SQL Server 는 [스키마].), 아니면 빈 글자
$codegen.hasSequence()$entity.sequenceName 이 있는지. 팩이 엔티티 변수 sequenceName 을 정한 경우입니다
$codegen.getSelectKeyStatement()새 PK 값을 읽는 SQL 을 반환합니다. MyBatis 의 selectKey 에 사용합니다. DBMS 별 반환값은 아래 목록에서 설명합니다.
$codegen.getSelectKeyOrder()Oracle, PostgreSQL 은 before, SQL Server, MySQL, MariaDB 는 after, 그 밖은 값이 없습니다

$codegen.getSelectKeyStatement() 의 반환값은 다음과 같습니다.

  • Oracle 에서 시퀀스 이름을 지정하면 SELECT 시퀀스.NEXTVAL FROM DUAL 을 반환합니다.
  • PostgreSQL 에서 시퀀스 이름을 지정하면 SELECT CURRVAL('시퀀스') 을 반환합니다.
  • SQL Server 에서 첫 PK 컬럼이 자동 증가 컬럼이면 SELECT SCOPE_IDENTITY() AS id 를 반환합니다.
  • MySQL 이나 MariaDB 에서 첫 PK 컬럼이 자동 증가 컬럼이면 SELECT LAST_INSERT_ID() 를 반환합니다.
  • 위 조건에 해당하지 않으면 값이 없습니다.

PK 와 필드 선택하기

함수내용
$codegen.getPkAttr()PK 필드 목록($table.primaryKeys 순서)
$codegen.getNonPkAttr()PK 가 아닌 필드 목록
$codegen.isSinglePk()PK 가 컬럼 하나인지
$codegen.isSinglePkAndLongTypeAndNameIsId()PK 가 하나이고 이름이 id, 중간 타입이 M_LONG 인지
$codegen.isPk($field.column)컬럼이 PK 인지
$codegen.getDeletedField(), hasDeletedField()소프트 삭제 표시 필드(deletedMark)와 그 필드가 있는지
$codegen.getMetaAttribute(name, $field)필드의 META 속성 값. 없으면 빈 글자

Audit 컬럼

후보 이름 목록은 $projectConfig.auditConfig 에 있고, 함수의 name 은 필드 이름입니다.

함수내용
$codegen.hasAuditTable()Audit 기준 테이블을 이 커넥션에서 찾았는지
$codegen.hasCreated(), hasModified()생성자, 생성 일시 컬럼이 둘 다 있는지, 수정자, 수정일시 컬럼이 둘 다 있는지
$codegen.isCreationAuthor(name), isCreationDate(name)생성자, 생성 일시 후보인지
$codegen.isModificationAuthor(name), isModificationDate(name)수정자, 수정일시 후보인지
$codegen.isCreationField(name), isModificationField(name)생성 관련, 수정 관련 컬럼인지
$codegen.isAuditField(name), isAuditDateField(name)Audit 컬럼 가운데 하나인지, 그 가운데 일시 컬럼인지

검증 키워드

함수내용
$codegen.validationsField($field)필드의 검증 키워드 목록을 반환합니다. 조건별 키워드는 아래 목록에서 설명합니다.
$codegen.validationsEntity($entity)모든 필드의 키워드를 겹치지 않게 모은 목록

$codegen.validationsField($field) 는 다음 조건을 적용합니다.

  • PK 와 Audit 필드는 빈 목록을 반환합니다.
  • NOT NULL 인 VARCHAR 또는 VARCHAR2 컬럼에는 notblank 를 추가합니다.
  • 그 밖의 NOT NULL 컬럼에는 notnull 을 추가합니다.
  • 길이가 0보다 큰 VARCHAR 또는 VARCHAR2 컬럼에는 utf8size 를 추가합니다. NOT NULL 여부와 관계없이 적용합니다.

types 함수

$types 는 필드의 확정 타입($field.mappedType)을 읽습니다. 모든 언어에 같습니다.

함수내용
$types.typeOf($field)언어 타입의 짧은 이름. java.lang.Long → Long
$types.importOf($field)import 에 사용하는 전체 이름. 예: java.lang.Long
$types.simpleNameOf(fullType)전체 이름 글자를 짧은 이름으로
$types.categoryOf($field)분류. 확정 타입이 없으면 object
$types.isCategory($field, category)분류에 속하는지
$types.isDate, isNumber, isBoolean, isText, isArray각각 datetime, number, boolean, text, array 분류인지. 인자는 $field
$types.isDateOnly($field)시간 없는 날짜(M_LOCALDATE)인지
$types.isLongText($field)M_CLOB, M_BLOB 이거나 길이 1000 이상인 M_STRING 인지

언어별 함수

함수내용
$java.imports()엔티티 필드의 타입에서 모은 import 목록. java.lang.* 은 제외하고, 겹치지 않게, 정렬합니다
$java.simpleName(fullType)전체 이름을 짧은 이름으로
$ts.propertyType($field)TypeScript 타입. datetime 분류는 늘 Date, 그 밖은 확정 타입, 없으면 any
$ts.interfaceName(value)PascalCase 로. user_profile → UserProfile
$py.snakeCase(value)snake_case 로. UserProfile → user_profile
$py.typeHint($field)Python 타입 힌트. 중간 타입에 따라 str, int, float, bool, datetime.date, datetime.time, datetime.datetime, list, 그 밖은 Any

날짜 도구

$date 는 Velocity Tools 의 DateTool 입니다. 예를 들어 $date.get('yyyy-MM-dd') 는 코드를 만든 날짜를 출력합니다. $date.timeZone 처럼 JDK 내부 객체를 돌려주는 호출은 아래 '주의할 점' 의 제한에 걸려 값이 나오지 않습니다.

설치 경로에서 사용하기

템플릿의 설치 경로 칸과 파일이 이미 있을 때 대체 경로 칸도 본문과 같은 값과 함수로 그립니다. 대체 경로는 덮어쓰기를 비활성화한 파일 생성 템플릿에서만 그립니다.

src/main/java/$codegen.toPath($env.package.core, $entity.subPackage)/${entity.name}.java

주의할 점

템플릿 본문은 믿을 수 없는 입력으로 다룹니다. Store 에서 받은 남의 팩도 기기(데스크톱) 나 NeoSQL 서버(웹) 에서 그려지기 때문입니다. 그래서 템플릿은 위 표의 값과 도구 함수, 문자열, 목록, 맵의 메서드만 사용할 수 있고, 아래 일은 할 수 없습니다.

할 수 없는 일예결과
리플렉션, 클래스 불러오기$x.getClass().forName(…), $x.class.classLoader, $x.class.getMethods()값이 없습니다. $! 로 작성하면 빈 글자, $ 로 작성하면 표기가 그대로 나옵니다. 클래스 객체에서는 $x.class.name 만 읽습니다
클래스 객체로 정적 메서드 호출하기$s.class.valueOf(5)값이 없습니다
파일, 네트워크, 프로세스, DB 연결, 시스템 속성java.io, java.nio, java.net, java.sql, Runtime, System, Thread 등값이 없습니다
다른 파일 넣기#include('…'), #parse('…')템플릿의 그리기가 실패합니다
  • 그리기가 실패한 템플릿은 코드 생성 창의 미리보기에 오류와 템플릿 이름이 나옵니다. 나머지 템플릿은 그대로 만들어집니다.
  • 공통 부분을 여러 템플릿에서 사용하려면 #include 대신 팩의 변수($env, 엔티티, 필드 변수)나 #macro 를 템플릿마다 두세요.
  • 값이 없는 참조는 오류가 아니라 $entity.nmae 같은 글자로 결과에 남습니다. 오타를 찾으려면 만든 결과를 미리보기에서 읽으세요.

관련 화면

  • 템플릿 팩 관리: 템플릿 본문과 설치 경로, 변수, 타입 매핑을 정하는 화면입니다.
  • 소스코드 생성: 변수 값을 기입하고, 테이블로 코드를 만들어 미리 보고 설치하는 화면입니다.
  • 템플릿 Store: 공개된 팩을 찾아 받는 화면입니다.
  • MCP 도구: 외부 AI 가 같은 템플릿으로 코드를 만드는 generate-code 도구입니다.