화면: 코드 생성

템플릿 팩 관리

앱 메뉴템플릿 팩 관리 화면은 소스코드 생성에 사용하는 템플릿 팩을 만들고 수정하는 화면입니다. 템플릿 팩은 파일 하나씩을 만드는 템플릿, 템플릿을 묶는 그룹, 대상 언어의 타입 매핑, 팩을 사용하는 사람이 기입할 변수를 한데 담습니다. 만든 팩을 프로젝트에 추가하고 테이블로 코드를 만드는 방법은 [소스코드 생성](/ko/docs/screens/codegen/generate) 에서 설명합니다.
사용할 수 있는 곳웹데스크톱로그인 없이로그인로컬 프로젝트계정 프로젝트

화면 구성

번호이름설명
1신규 버튼새 팩을 만드는 창을 엽니다(아래 '팩 만들기').
2가져오기... 버튼폴더나 ZIP 파일로 팩을 가져옵니다(아래 '내보내기와 가져오기').
3Store 버튼공개된 팩을 둘러보고 내 목록으로 받아 옵니다. 서버에 연결할 수 없으면 클릭할 수 없습니다. 템플릿 Store 에서 설명합니다.
4팩 목록내 팩입니다. 자물쇠 표시는 비공개, 지구 표시는 공개 팩입니다. 저장했지만 배포하지 않은 변경이 있는 팩은 이름이 파란색입니다. 배포한 팩에는 최신 버전(v2 등)이 붙고, 로그인한 상태에서는 즐겨찾기와 내 역할 표시가 붙습니다.
5버튼 줄왼쪽은 팩 삭제 버튼(공동 편집자는 템플릿팩 나가기 버튼), 오른쪽은 내보내기..., 팩 복사, 팩 저장 버튼입니다. 로그인한 상태의 팩에는 배포 버튼과 공개 전환 버튼이 더 있습니다.
6정보 칸이름, 작성자, 설명은 수정할 수 있습니다. 언어는 팩을 만들 때 정해지고 변경되지 않습니다. 로그인한 상태에서는 공개 여부도 보입니다.
7팩 상세 구성 탭왼쪽은 그룹과 템플릿의 트리, 오른쪽은 선택한 템플릿이나 그룹의 편집기입니다.
8Settings 탭변수와 타입 매핑을 정합니다(아래 '변수와 타입 매핑 정하기'). 로그인한 상태의 팩에는 멤버 탭과 버전 탭이 더 있습니다.
  • 편집을 시작하면 팩 저장 버튼이 활성화됩니다. 저장해야 보존됩니다. 단축키 Ctrl+S(macOS Cmd+S)로도 저장합니다.
  • 템플릿, 그룹, 변수의 편집은 모두 한 번에 함께 저장됩니다. 템플릿마다 따로 저장하지 않습니다.

화면을 여는 곳

  • 헤더 왼쪽 끝의 앱 메뉴에서 앱 메뉴템플릿 팩 항목을 열고 앱 메뉴템플릿 팩 관리 항목을 클릭합니다.
  • 같은 메뉴의 앱 메뉴새 템플릿 팩... 항목은 만들기 창을 바로 열고, 만든 팩을 선택한 채로 팩 관리 화면을 엽니다.
  • 홈의 템플릿 팩 카드와 목록에서도 만들고 엽니다(홈).

데스크톱에서는 팩 관리 화면이 작업 탭 하나로 열립니다(화면템플릿 팩 관리). 프로젝트 탭으로 옮겨 가도 화면은 닫히지 않고 숨은 채 남으므로, 팩을 수정하다 프로젝트에서 코드를 만들어 보고 돌아와도 편집이 그대로입니다. 저장하지 않은 편집이 있으면 탭을 닫을 때 묻습니다. 웹 앱에는 탭 줄이 없고, 다른 화면으로 옮기면 화면을 떠납니다(작업 탭).

팩이 저장되는 곳은 로그인 여부로 정해집니다. 데이터 사전 자산과 같은 규칙입니다(데이터 사전 관리).

로그인하지 않은 데스크톱로그인한 상태(데스크톱, 웹)
새로 만든 팩, 가져온 팩, 복사한 팩기기의 팩내 계정의 팩
Store 에서 받은 팩게시본을 기기에 다운로드한 사본내 계정에 복제한 사본, 또는 수정하지 않고 사용하는 즐겨찾기
배포, 버전, 공개, 멤버없습니다있습니다. 로그인하지 않았을 때 기기에 만든 팩은 로그인한 뒤에도 기기의 팩이라 없습니다
내보내기, 가져오기폴더나 ZIP데스크톱은 폴더나 ZIP, 웹은 ZIP

팩 만들기

  1. 신규 버튼(1)을 클릭합니다.
  2. 템플릿 팩 이름 칸에 이름을 적습니다.
  3. 언어 칸에서 코드를 만들 언어를 선택합니다.
  4. 저장 버튼을 클릭합니다. 새 팩이 목록에 생기고 오른쪽에 열립니다.
  • 언어 목록(2)의 Java, TypeScript, Python, C# 프리셋은 타입 매핑과 자주 사용하는 변수를 미리 채웁니다. 목록에 없는 언어는 Custom… (직접 작성) 항목을 선택하고 언어 이름 칸에 이름을 적습니다. 타입 매핑과 변수는 비어 있습니다.
  • 이름 칸(1)과 언어는 반드시 채웁니다. 언어는 만든 뒤에 변경할 수 없으므로, 다른 언어가 필요하면 팩을 새로 만듭니다.
  • 이미 있는 팩을 출발점으로 삼으려면 팩을 열고 팩 복사 버튼을 클릭합니다. 이름 끝에 _copy 가 붙은 새 팩이 생깁니다.

템플릿과 그룹 만들기

팩 상세 구성 탭의 트리에서 템플릿과 그룹을 구성합니다. 그룹은 템플릿을 정리하는 폴더이고, 코드를 만드는 창에도 같은 트리로 보입니다.

  • 태그 선택 칸(1)에서 태그를 선택하면 선택한 태그를 모두 가진 템플릿만 트리에 남습니다.
  • 새 그룹 버튼과 새 템플릿 추가 버튼(2)은 맨 위에 그룹이나 템플릿을 더합니다.
  • 그룹(3)을 클릭하면 오른쪽에 그룹의 이름, 아이콘, 설명과 하위 그룹, 템플릿이 나옵니다. 설명은 트리에서 툴팁으로 보입니다.
  • 템플릿 옆의 R 표시는 읽기 전용, O 표시는 덮어쓰기 설정이 활성화된 템플릿입니다(4).
  • 그룹이나 템플릿을 우클릭하면 메뉴(5)가 열립니다. 그룹에서는 하위 그룹 추가, 템플릿 추가, 그룹 삭제 항목을, 템플릿에서는 템플릿 삭제... 항목을 선택합니다. 빈 곳을 우클릭하면 최상위 그룹 추가 항목과 템플릿 추가 항목이 나옵니다.
  1. 새 그룹 버튼을 클릭하고 오른쪽에서 그룹 이름을 적습니다.
  2. 그룹을 우클릭해 템플릿 추가 항목을 선택합니다. 새 템플릿이 그룹에 생기고 오른쪽에 열립니다.
  3. 템플릿을 다른 그룹으로 옮기려면 트리에서 드래그 앤 드롭합니다. 그룹도 드래그해서 다른 그룹 안이나 앞뒤로 옮깁니다.
  4. 팩 저장 버튼을 클릭합니다.
  • 같은 그룹 안의 템플릿은 늘 이름순입니다. 드래그해서 순서를 변경할 수 없고, 그룹의 순서만 변경됩니다.
  • 그룹을 삭제하면 템플릿과 하위 그룹은 삭제되지 않고 한 단계 위로 올라갑니다.

템플릿 편집하기

트리에서 템플릿을 클릭하면 오른쪽에 편집기가 열립니다. 위쪽은 템플릿의 속성과 설치 규칙, 아래쪽은 본문입니다.

번호이름설명
1그룹 칸트리에서 템플릿이 있는 곳입니다. 여기서 수정하지 않고 트리에서 옮깁니다.
2이름 칸, 타입 칸반드시 채웁니다. 타입은 Java, TypeScript, XML 같은 파일 종류이고 트리의 아이콘을 정합니다.
3Installation 스위치활성화하면 만든 코드를 프로젝트 폴더의 파일로 저장합니다. 비활성화하면 코드를 만드는 창에서 보고 복사하거나 다운로드하기만 합니다. 파일로 저장하는 기능은 데스크톱에서만 지원합니다.
4설치 유형 항목파일 생성·교체 항목은 새 파일을 만들거나 있는 파일을 변경합니다. 스니펫 주입 항목은 있는 파일에서 플레이스홀더 칸에 적은 글자를 찾아 만든 코드로 변경합니다.
5읽기 전용, 덮어쓰기, Git Add 스위치파일을 읽기 전용으로 만들지, 있는 파일을 덮어쓸지, 만든 뒤 git add 할지 정합니다. 파일 생성·교체에만 있습니다.
6설치 경로 칸파일 이름까지 넣은 경로입니다. 본문과 같은 문법으로 변수를 사용합니다. 스니펫 주입이면 주입 대상 파일 칸입니다.
7파일이 이미 있을 때 대체 경로 칸덮어쓰기를 껐을 때, 파일이 이미 있으면 대신 사용하는 경로입니다.
8태그 칸적어서 새 태그를 만들거나 팩에 있는 태그를 선택합니다. 코드를 만드는 창에서 태그로 템플릿을 거릅니다.
9본문 편집기템플릿 본문입니다. 오른쪽 위 버튼으로 크게 펼칩니다. Ctrl+F(macOS Cmd+F)로 찾고, Ctrl+R(macOS Cmd+R)로 변경합니다.

본문은 Apache Velocity 문법으로 작성합니다. 코드를 만들 때 테이블은 $entity, 컬럼 하나는 $field, 프로젝트에서 기입한 전역 변수는 $env 로 들어오고, $codegen, $types 같은 도구로 이름을 변경하거나 타입을 선택합니다. 사용할 수 있는 값과 도구의 전체 목록은 템플릿 문법 에서 설명합니다.

public class $codegen.toUpperCamel($entity.name) {
#foreach($field in $entity.fields)
    private $field.mappedType.target $codegen.toLowerCamel($field.name);
#end
}
  • 설치 경로는 코드를 만드는 프로젝트의 위치(Location)를 기준으로 한 경로입니다. 앞에 붙은 / 와 .. 는 위치 밖으로 나가지 않게 정리됩니다.
  • 설치를 활성화한 템플릿끼리 설치 경로가 같으면 저장하지 못합니다. 저장할 때 문제가 있는 템플릿이 열리고 무엇이 빠졌는지 알려 줍니다.
  • 팩 관리 화면에는 미리보기가 없습니다. 결과는 아래 '저장하고 결과 확인하기' 처럼 프로젝트의 코드 생성 창에서 봅니다.

변수와 타입 매핑 정하기

Settings 탭에서는 팩을 사용하는 사람이 기입할 변수와, 컬럼 타입을 팩 언어의 타입으로 변환하는 규칙을 정합니다.

  • 위의 표시(1)는 팩의 언어입니다. 기본값으로 리셋 버튼은 변수와 타입 매핑을 모두 팩 언어의 프리셋 값으로 되돌립니다. Custom 언어는 빈 상태로 돌아갑니다.
  • 전역 변수 표(2), 엔티티 변수 표(3), 필드 변수 표(4)의 행 하나가 변수 하나입니다. 추가 버튼으로 행을 더합니다.
  • 타입 매핑(5)은 NeoSQL 이 DBMS 의 컬럼 타입을 변환한 중간 타입마다 팩 언어의 타입을 적는 표입니다. 적지 않은 타입은 Fallback 칸의 값을 사용합니다.
  • 대상 타입 칸(6)에 적은 글자가 만든 코드에 그대로 들어갑니다.
종류값을 기입하는 곳템플릿에서 읽는 법
전역 변수프로젝트 설정코드 생성 탭. 프로젝트마다 한 번$env.<key>
엔티티 변수테이블마다$entity.<key>
필드 변수컬럼마다$field.<key>

값을 기입하는 화면은 소스코드 생성 에서 설명합니다.

칸내용
Key템플릿에서 사용하는 이름입니다. 영문, 숫자, _ 만 사용할 수 있습니다. 전역 변수는 package.core 처럼 점으로 나누면 $env.package.core 로 읽습니다
라벨, 도움말값을 기입하는 화면에 보이는 이름과 설명입니다
입력 유형값을 기입하는 방식입니다. 글자, 여러 줄, 활성화하고 비활성화하기, 목록에서 선택하기, 여러 값 등을 선택합니다
기본값, 필수처음 값과 반드시 기입할지 여부입니다
옵션 (select)목록에서 선택하는 변수의 선택지입니다. 한 줄에 값:라벨 하나씩 적습니다
  • 키가 비었거나, 형식이 틀렸거나, 같은 표 안에서 겹치면 저장하지 못합니다. 엔티티 변수와 필드 변수는 $entity, $field 가 이미 가진 이름(name, fields 등)도 사용할 수 없습니다. 선택할 선택지가 없는 목록 변수도 저장하지 못합니다.

저장하고 결과 확인하기

저장한 팩은 내 프로젝트의 코드 생성에 곧바로 사용됩니다. 미리보기는 프로젝트에서 테이블로 코드를 만드는 창에서 봅니다.

  1. 팩 저장 버튼을 클릭합니다.
  2. 팩을 추가한 프로젝트를 열고, 탐색기나 ERD 에서 테이블을 우클릭해 코드 생성 창을 엽니다. 여러 테이블을 선택했으면 창 위에서 미리 볼 테이블을 변경합니다.
  3. 결과를 보고 수정할 곳이 있으면 팩 관리 화면으로 돌아와 수정하고 다시 저장합니다. 코드 생성 창의 Preview 다시적용 버튼을 클릭하면 새 내용으로 다시 만듭니다.
  • 즐겨찾기가 아닌 내 팩은 코드 생성 창에서도 템플릿 원본 수정 모드 항목으로 본문을 바로 수정해 저장합니다. 저장도 팩에 남습니다.
  • 데스크톱에서는 팩을 저장하면 열어 둔 프로젝트가 팩을 다시 읽습니다. 프로젝트를 닫았다 열 필요가 없습니다.
  • 내가 편집할 수 있는 팩은 프로젝트가 내 저장본을 사용하고, 편집할 수 없는 팩은 배포한 버전을 사용합니다(아래 '배포, 공개, 멤버').

배포, 공개, 멤버

로그인한 상태의 팩에만 있습니다. 저장은 내 초안에만 보존되고, 배포해야 버전이 생겨 다른 사람이 사용합니다. 초안과 버전, 버전 탭, 멤버 탭은 데이터 사전과 같은 방식이므로 게시, 버전과 백업 에서 설명합니다. 여기서는 템플릿 팩에서 다른 점만 적습니다.

번호이름설명
1버전 표시, 미반영 변경 표시내 초안이 출발한 버전과, 저장했지만 배포하지 않은 변경이 있는지입니다.
2업데이트 버튼다른 멤버가 더 새 버전을 배포했을 때만 나옵니다(업데이트 (v3)). 클릭하면 내 초안을 최신 버전의 내용으로 변경합니다.
3배포 버튼저장한 초안을 버전으로 냅니다. 배포하지 않은 변경이 없으면 클릭할 수 없습니다. 소유자, 관리자, 편집자에게 보입니다.
4공개 버튼팩을 Store 에 공개합니다. 공개한 팩에서는 공개 해제 버튼입니다. 소유자에게만 보입니다.
5멤버 탭, 버전 탭함께 수정할 사람과 배포한 버전의 목록입니다. 즐겨찾기한 팩에는 없습니다.
6목록의 표시즐겨찾기 표시는 Store 에서 즐겨찾기한 팩, 나머지 표시는 팩에서 내 역할입니다.
  1. 팩을 수정하고 팩 저장 버튼을 클릭합니다.
  2. 배포 버튼(3)을 클릭합니다.
  3. 새 버전으로 배포 버튼을 클릭합니다. 한 번이라도 배포한 팩이면 현재 버전 덮어쓰기 버튼도 있습니다.
  • 저장하지 않은 편집이 있는 채로 배포하면 먼저 저장하고 배포합니다.
  • 공개하려면 템플릿이 하나 이상 있고 작성자 칸이 기입되어 있어야 합니다. 배포하지 않은 변경이 있으면, 공개되는 것은 마지막으로 배포한 버전이라고 알립니다.
  • 즐겨찾기한 팩은 읽기 전용입니다. 수정하려면 복제해서 편집 버튼으로 내 팩을 만들고, 그만 사용하려면 즐겨찾기 해제 버튼을 클릭합니다.
  • 멤버의 역할은 데이터 사전과 같습니다. 다만 뷰어 역할도 자기 초안을 수정해 저장할 수 있고, 배포만 하지 못합니다.

내보내기와 가져오기

내보내기는 팩 하나를 폴더나 ZIP 파일로 저장합니다. 다른 기기나 계정으로 옮기거나, 템플릿을 외부 편집기에서 수정할 때 사용합니다.

  1. 팩을 열고 내보내기... 버튼을 클릭합니다. 저장하지 않은 편집이 있으면 먼저 저장할지 묻습니다.
  2. 데스크톱에서는 ZIP 파일로 버튼과 폴더로 (외부 편집용) 버튼 가운데 하나를 클릭하고 저장할 곳을 선택합니다. 웹 앱은 ZIP 파일을 바로 다운로드합니다.
  3. 옮길 곳에서 팩 관리 화면을 열고 가져오기... 버튼을 클릭합니다. 데스크톱에서는 ZIP 파일에서 버튼과 폴더에서 버튼 가운데 하나를 선택하고, 웹 앱은 ZIP 파일을 선택합니다.
  4. 같은 팩이 목록에 이미 있으면 기존 팩에 반영 버튼과 새 팩으로 추가 버튼 가운데 하나를 클릭합니다.
  • 폴더와 ZIP 은 같은 구조입니다. 맨 위의 tp-config.json 에 팩 정보와 언어 프로필이 있고, 그룹 경로 아래 템플릿마다 폴더가 하나씩 있어 본문(template.vm)과 설정(config.json)이 들어 있습니다.
  • '같은 팩' 은 이름이 아니라 파일에 적힌 팩 식별자로 찾습니다. 내보낸 팩을 같은 곳으로 다시 가져올 때 묻습니다.
  • 템플릿이 하나도 없는 팩은 내보낼 수 없습니다.
  • 버전, 멤버, 공개 범위는 담기지 않습니다. 가져온 팩은 가져온 곳의 로그인 상태에 따라 기기의 팩이나 계정 팩이 됩니다.

팩 삭제하기와 나가기

  1. 목록에서 팩을 엽니다.
  2. 버튼 줄 왼쪽의 팩 삭제 버튼을 클릭합니다. 공동 편집자로 초대받은 팩이면 템플릿팩 나가기 버튼입니다.
  3. 확인 창의 내용을 읽고 확인합니다.
  • 팩을 사용하는 프로젝트가 있으면 삭제하지 못하고, 프로젝트 이름이 나옵니다. 프로젝트의 코드 생성 설정에서 팩을 먼저 제외합니다.
  • 나가면 목록에서 사라지고, 배포하지 않은 내 초안도 삭제됩니다. 팩과 다른 멤버에는 영향이 없습니다.

주의할 점

  • 저장한 내용은 곧바로 내 프로젝트의 코드 생성에 사용됩니다. 수정하는 중인 템플릿으로 파일을 덮어쓰지 않으려면, 저장한 뒤 코드 생성 창에서 결과를 먼저 확인하고 설치하세요.
  • 덮어쓰기 스위치를 활성화한 템플릿은 프로젝트 폴더에 있던 파일을 묻지 않고 변경합니다. 손으로 수정한 파일이 있을 곳에는 비활성화하고 대체 경로를 사용하세요.
  • 다른 멤버가 더 새 버전을 배포한 뒤에는 내 초안을 배포할 수 없습니다. 배포하면 다른 편집자가 v3 를 배포해 내 편집본의 기준 버전이 뒤처졌습니다. 그대로 배포하면 그 내용이 사라지므로 배포하지 않았습니다. 내 편집을 내보내기로 보관한 뒤 업데이트 버튼으로 최신본을 받아 다시 고쳐 배포하세요. 안내가 나오고 업데이트 버튼(2)이 보입니다. 업데이트를 받으면 저장하지 않았거나 배포하지 않은 내 편집은 사라지므로, 먼저 내보내기로 보관한 뒤 업데이트를 받아 편집을 다시 하세요.
  • 현재 버전 덮어쓰기 버튼은 최신 버전의 내용을 변경합니다. 버전을 사용하는 다른 사람의 프로젝트도 바로 변경되므로, 확실하지 않으면 새 버전으로 배포하세요.
  • 공개한 팩은 로그인하지 않은 사용자도 Store 에서 받아 갑니다. 공개를 되돌려도 이미 다운로드한 사본은 보존됩니다.
  • 기기의 팩은 저장한 기기에만 있습니다. 앱을 삭제하거나 기기를 변경하기 전에 내보내기로 저장해 두세요.
  • 다른 사람이 만든 팩을 받았으면, 설치하기 전에 템플릿의 설치 경로와 본문을 읽어 보세요. 팩은 프로젝트 폴더 안의 파일을 만들고 변경합니다.

관련 화면

  • 소스코드 생성: 팩을 프로젝트에 추가하고, 변수 값을 기입하고, 테이블로 코드를 만들어 설치하는 방법입니다.
  • 템플릿 Store: 공개된 팩을 찾아 받거나 즐겨찾기하는 방법입니다.
  • 템플릿 문법: 템플릿 본문에서 사용하는 값과 도구 함수의 목록입니다.
  • 게시, 버전과 백업: 초안과 버전, 버전 되돌리기, 멤버 역할을 자세히 설명합니다.
  • 작업 탭: 데스크톱에서 템플릿 팩 관리 화면과 프로젝트를 탭으로 오가는 방법입니다.