화면: 코드 생성

소스코드 생성

테이블의 컬럼 정보를 템플릿 팩에 넣어 엔티티, 매퍼, 화면 같은 소스코드를 만듭니다. 만드는 일은 세 단계입니다. 프로젝트에 템플릿 팩을 지정하고, 테이블마다 엔티티 이름과 필드를 다듬고, 생성 결과 창에서 내용을 보고 설치하거나 다운로드합니다. 템플릿 팩을 만들고 수정하는 방법은 템플릿 팩 관리 에서, 템플릿에서 사용하는 변수와 함수는 템플릿 문법 에서 설명합니다.

사용할 수 있는 곳웹데스크톱로그인 없이로그인로컬 프로젝트계정 프로젝트
기능사용하는 환경과 방법
미리보기, ZIP 으로 다운로드하기웹과 데스크톱에서 사용합니다.
프로젝트 폴더에 바로 설치데스크톱 앱의 프로젝트 설정 창에서 설치 위치 칸에 폴더를 지정합니다.

코드 생성은 로그인 여부, 프로젝트 종류, 플랜과 관계없이 사용할 수 있습니다. 로그인하지 않았으면 Store 의 공개 팩과 기기의 팩만 선택할 수 있습니다 (템플릿 Store).

화면 구성

번호이름설명
1미리보기 테이블 선택테이블을 여러 개 선택해 열었을 때만 보입니다. 오른쪽 미리보기가 어느 테이블의 결과인지 선택합니다. 템플릿 선택은 모든 테이블에 함께 적용됩니다.
2선택 템플릿 설치 버튼체크한 템플릿을 선택한 모든 테이블에 대해 만들어 프로젝트 폴더에 저장합니다. 데스크톱에서 설치 위치 칸을 정했을 때만 클릭할 수 있고, 아니면 버튼에 마우스를 올리면 이유가 나옵니다.
3선택 템플릿 다운로드 버튼같은 결과를 설치 경로의 폴더 구조 그대로 ZIP 파일 하나에 담아 다운로드합니다. 웹과 데스크톱 모두 지원합니다.
4Preview 다시적용 버튼미리보기 중인 테이블의 결과를 다시 만듭니다. 테이블 탭에서 엔티티 설정을 수정한 뒤 클릭합니다.
5태그 필터선택한 태그를 모두 가진 템플릿만 트리에 남깁니다.
6전체 선택 체크 상자트리에 보이는 템플릿을 모두 체크하거나 해제합니다. 오른쪽 숫자는 보이는 템플릿 가운데 체크한 수입니다. 필터로 숨은 템플릿의 체크는 그대로 둡니다.
7템플릿 트리프로젝트에 지정한 팩마다 굵은 줄 아래에 팩의 그룹과 템플릿이 있습니다. 템플릿 이름을 클릭하면 오른쪽에 결과가 나옵니다. R 표시는 설치한 파일을 읽기 전용으로 만드는 템플릿, O 표시는 있는 파일을 덮어쓰는 템플릿입니다.
8설치 정보설치 경로, 대체 경로, 덮어쓰기 여부입니다. 대체 경로는 덮어쓰지 않는 템플릿이 이미 있는 파일을 만났을 때 대신 사용하는 곳입니다.
9결과 미리보기만들어진 코드입니다. 템플릿 원본 수정 모드 항목은 팩을 수정할 수 있을 때만 있습니다(아래 '템플릿 원본 수정하기').
10복사 버튼, 이 템플릿만 설치 버튼미리보기 중인 결과를 클립보드에 복사하거나, 템플릿 하나만 선택한 모든 테이블에 대해 설치합니다. 설치 버튼은 데스크톱에만 있습니다.
  • 창을 열면 첫 테이블의 결과만 만듭니다. 다른 테이블은 미리보기에서 선택하거나 설치, 다운로드할 때 만듭니다.
  • 템플릿을 만드는 중에 오류가 나면 어느 테이블, 어느 팩, 어느 템플릿인지 알림으로 나옵니다. 나머지 템플릿의 결과는 그대로 보입니다.

준비: 템플릿 팩 지정하기

프로젝트가 사용할 팩은 프로젝트 설정코드 생성 탭에서 정합니다. 탭은 로컬 프로젝트와, 계정 프로젝트의 소유자 또는 모든 권한 권한이 있는 사람에게 보입니다.

  1. 프로젝트 설정코드 생성 탭에서 코드 생성 기능 사용 스위치를 활성화합니다. 팩을 이미 지정한 프로젝트에서는 스위치 없이 바로 아래 칸이 보입니다.
  2. 데스크톱이면 찾아보기... 버튼(1)으로 생성한 코드를 설치할 프로젝트 폴더를 선택합니다.
  3. + 템플릿 팩 추가 버튼(2)을 클릭하고 Store 창에서 사용할 팩의 추가 버튼을 클릭합니다(템플릿 Store).
  4. 팩 탭(3)이 생깁니다. 팩이 요구하는 값이 있으면 템플릿 변수 영역(6)에 채웁니다.
  5. 프로젝트 설정 창의 저장 버튼을 클릭합니다.
  • 설치 위치 칸(1)은 코드 생성을 활성화한 데스크톱 프로젝트에서 반드시 기입해야 합니다. 비우면 저장할 때 코드 생성 탭으로 돌아옵니다. 웹에서는 칸이 흐리게 보이고 읽기 전용입니다.
  • 팩은 하나 이상 지정해야 저장됩니다. 같은 팩을 여러 번 넣을 수도 있습니다. 탭마다 변수 값과 테이블별 설정이 따로입니다.
  • 팩 탭(3)의 v1 같은 표시는 프로젝트가 사용하는 팩의 버전입니다. 팩을 넣을 때의 최신 버전에 고정되고, 팩이 새 버전을 게시해도 저절로 변경되지 않습니다. 새 버전이 있으면 탭에 화살표 아이콘과 새 버전이 있습니다 (v1 → v2). 안내가 나오고, 업그레이드 버튼으로 올립니다. 탭의 × 는 프로젝트에서 팩을 제외합니다.
  • 팩 이름 줄(4)에 라이브 (내 편집본) 표시가 붙은 팩은 내가 수정할 수 있는 팩입니다. 버전이 아니라 내가 저장한 작업본을 그대로 사용하므로, 팩을 수정해 저장하면 프로젝트의 결과도 바로 변경됩니다. 다른 사람과 나누려면 팩을 게시합니다 (템플릿 팩 관리).
  • 별칭 칸(5)은 프로젝트에서만 사용하는 팩의 이름입니다. 같은 팩을 두 번 넣었을 때 구분합니다.
  • 템플릿 변수 영역(6)은 팩이 정한 전역 변수(패키지 이름, 경로 등)입니다. 어떤 칸이 있는지는 팩마다 다르고, 필수 칸을 비우면 저장되지 않습니다. 변수가 없는 팩에는 이 템플릿팩은 설정할 항목(모듈·변수)이 없습니다. 안내가 나옵니다.

테이블의 엔티티 설정 다듬기

팩을 지정하면 테이블 탭에 Code Generator 탭이 생깁니다(테이블 탭). 테이블 이름과 컬럼 이름으로 엔티티와 필드의 이름을 처음 한 번 만들고, 여기서 수정한 값으로 코드를 만듭니다.

번호이름설명
1도구 모음소스코드 생성... 버튼은 테이블로 소스코드 생성 - orders 외 1개 창을 엽니다. Entity 설정 초기화... 버튼은 엔티티 설정을 삭제하고 지금 규칙으로 다시 만듭니다. 새로고침 버튼은 DB 의 지금 구조를 다시 읽습니다.
2기본 설정 영역모든 팩이 함께 사용하는 값입니다. 엔티티의 이름 칸, 별칭 칸, Soft Delete 스위치, 설명 칸입니다.
3팩별 상세 설정 탭프로젝트에 지정한 팩마다 탭이 하나입니다. 팩의 언어에만 있는 값을 정합니다.
4엔티티 영역팩이 정한 엔티티 단위 설정입니다. 없는 팩에는 이 팩의 언어 프로필에는 팩별 엔티티 설정이 없습니다. 안내가 나옵니다.
5필드 그리드컬럼 하나가 한 줄입니다. Database 열 묶음은 DB 의 값이라 읽기 전용입니다. 공통 열 묶음의 NAME, COMMENT 칸은 모든 팩이 함께 사용하고, 오른쪽 팩 전용 열 묶음의 타입과 META 같은 값은 자기 팩에만 적용됩니다.
6NAME 머리의 톱니 아이콘테이블만의 컬럼 이름 규칙 창(Column Renamer)을 엽니다(아래 '이름 규칙').
7행 끝의 초기화 버튼행의 이름을 규칙으로 다시 만들고, 공통 값과 팩의 수정을 처음 상태로 돌립니다.
  • 엔티티 설정은 테이블 탭의 저장 버튼으로 저장합니다. 저장하지 않은 변경이 있으면 Code Generator 탭 이름 옆에 점이 보입니다.
  • 별칭 칸의 처음 값은 엔티티 이름의 대문자를 이어 붙인 소문자입니다. 예를 들어 OrderItem 은 oi 입니다.
  • Soft Delete 스위치를 활성화하면 삭제 여부 컬럼과 삭제 일시 컬럼을 선택합니다. 템플릿이 삭제 대신 표시만 하는 코드를 만듭니다.
  • 삭제 표시를 한 테이블에서는 Code Generator 탭의 설정을 읽기 전용입니다.

소스코드 만들기

  1. 탐색기에서 테이블을 우클릭하고 탐색기 우클릭소스코드 생성... 메뉴를 클릭합니다. 여러 테이블을 선택해 우클릭하면 한 창에서 함께 만듭니다. 테이블 탭의 Code Generator 탭에서는 소스코드 생성... 버튼으로 엽니다.
  2. 왼쪽 트리에서 만들 템플릿을 체크합니다. 템플릿 이름을 클릭하면 오른쪽에 결과가 나옵니다.
  3. 결과와 설치 경로 항목을 확인합니다. 여러 테이블이면 미리보기 테이블 선택으로 테이블을 변경해 봅니다.
  4. 데스크톱이면 선택 템플릿 설치 버튼을 클릭합니다. 파일이 설치 위치 폴더 아래에 저장되고 소스코드가 설치되었습니다. 알림이 나옵니다.
  5. 웹이거나 파일로 다운로드하려면 선택 템플릿 다운로드 버튼을 클릭합니다. 테이블 하나면 테이블이름.zip, 여럿이면 codegen-테이블수-tables.zip 파일이 다운로드됩니다.
  • 프로젝트에 팩을 지정하지 않았으면 탐색기 우클릭소스코드 생성... 메뉴가 흐리게 보입니다.
  • 트리에서 한 번도 펼치지 않은 테이블은 창을 열 때 DB 에서 컬럼을 읽습니다. DB 에 접속할 수 없으면 테이블 메타데이터(컬럼)를 불러오지 못했습니다. DB 연결을 확인해주세요. 알림과 함께 컬럼 없이 만들어집니다.
  • 트리가 비고 생성할 템플릿이 없습니다. 팩에 템플릿이 있는지, 프로젝트가 사용하는 팩 버전에 템플릿이 들어 있는지 확인하세요. 안내가 나오면 프로젝트가 사용하는 팩 버전에 템플릿이 없는 것입니다. 팩을 게시했는지 확인하세요.
  • 데스크톱에서 설치 위치 칸을 비운 채 설치하면 소스코드가 설치될 프로젝트의 루트를 설정해주세요. 안내가 나오고, 확인을 클릭하면 프로젝트 설정 창이 열립니다.
  • 외부 AI 도 MCP 의 generate-code 도구로 같은 팩과 설정을 사용해 파일을 만듭니다(AI 와 MCP, MCP 도구).

설치할 때 일어나는 일

설치 경로는 템플릿이 정하고, 늘 설치 위치 폴더 아래로 정리됩니다. 경로에 .. 가 있어도 폴더 밖으로 나가지 않고, 드라이브 문자로 시작하는 경로는 설치하지 않습니다. 파일마다 템플릿의 설치 설정에 따라 다르게 저장합니다.

설치 경로에 파일이템플릿 설정하는 일
없음폴더를 만들고 새로 저장합니다
있음덮어쓰기(O)묻지 않고 덮어씁니다
있음덮어쓰기 아님, 대체 경로 있음대체 경로에 저장합니다
있음덮어쓰기 아님, 대체 경로 없음건너뜁니다
있음끼워 넣기 표시(needle)파일 안의 표시 글자를 결과로 변경합니다. 표시가 없으면 건너뜁니다
  • 읽기 전용(R) 템플릿은 저장한 파일을 읽기 전용으로 만듭니다. 덮어쓸 때는 있는 파일을 삭제하고 새로 저장합니다.
  • 템플릿이 git 에 추가하도록 정했고 설치 위치 폴더가 git 저장소이면, 저장한 파일을 git add 합니다.

템플릿 원본 수정하기

내가 수정할 수 있는 팩(라이브 (내 편집본) 표시가 붙은 팩)이면 미리보기 위에 템플릿 원본 수정 모드 항목이 있습니다.

  1. 템플릿 원본 수정 모드 항목을 선택하고 템플릿 원본을 수정합니다.
  2. 수정 사항 반영 및 미리보기 모드 전환 버튼을 클릭합니다. 팩의 작업본에 저장되고, 결과가 다시 만들어집니다.

원본 수정은 팩 자체를 수정하는 것입니다. 팩을 사용하는 내 다른 프로젝트의 결과도 변경됩니다. 다른 사람에게는 게시해야 전해집니다.

이름 규칙(Renamer)

엔티티와 필드의 처음 이름은 커넥션의 이름 규칙으로 만듭니다. 규칙은 커넥션 창의 Renamer 탭에서 정합니다 (커넥션 만들기와 수정). 규칙은 위에서부터 차례로 적용합니다.

번호이름설명
1기본값 복원 버튼두 규칙 목록을 처음 값으로 되돌립니다. 지금 규칙이 있으면 먼저 묻습니다.
2테이블 이름 변환 영역테이블 이름을 엔티티 이름으로 변환하는 규칙입니다. 변환기 유형 항목에서 regexp(정규표현식을 치환 글자로 바꿈)나 case-format(대소문자 형식 바꿈)을 선택하고, 값을 기입해 추가 버튼을 클릭합니다.
3규칙 목록적용 순서대로 보입니다. 화살표 버튼으로 순서를 변경하고, 휴지통 버튼으로 삭제합니다.
4컬럼 이름 변환 영역컬럼 이름을 필드 이름으로 변환하는 규칙입니다. 사용 방법은 테이블과 같습니다.
처음 규칙테이블 이름컬럼 이름
1case-format CAMEL_UPPER (MyName)case-format CAMEL (myName)
  • 처음 규칙은 대소문자 형식만 변환합니다. order_item 은 OrderItem, customer_id 는 customerId 가 됩니다. 이름 앞에 tb_ 같은 접두어를 붙이는 DB 라면 맨 앞에 regexp 규칙(/^tb_/ → 빈 글자)을 더하세요.
  • 예전에 만든 커넥션은 저장된 규칙을 그대로 사용합니다. 첫 밑줄까지 삭제하는 regexp /^[^_]*_/ 규칙이 남아 있으면 접두어가 없는 DB 에서 첫 단어가 삭제되어 필드 이름이 겹칩니다(order_id 와 customer_id 가 둘 다 id). 그 규칙을 삭제하거나 기본값 복원 버튼을 클릭하세요.
  • 커넥션의 규칙을 변경해도 이미 만든 엔티티의 이름은 그대로입니다. 새 규칙을 적용하려면 테이블 탭의 Entity 설정 초기화... 버튼이나 행의 초기화 버튼을 클릭합니다.
  • 테이블 하나만 다르게 하려면 필드 그리드의 NAME 머리 톱니 아이콘으로 Column Renamer 창을 엽니다. 테이블에 규칙이 있으면 커넥션의 컬럼 규칙 대신 테이블의 규칙을 사용합니다. Connection 설정 불러오기 버튼은 커넥션의 규칙을 복사해 오고, 저장 & 적용 버튼은 저장하면서 테이블의 모든 필드 이름을 다시 만듭니다. 손으로 수정한 이름도 덮어씁니다.

Audit Table 탭

프로젝트 설정Audit Table 탭은 코드 생성을 활성화한 프로젝트의 설정에 있고, 로컬 프로젝트와 계정 프로젝트의 소유자 또는 모든 권한 권한이 있는 사람에게 보입니다. 등록자, 등록일시, 수정자, 수정일시처럼 공통 감사 필드를 템플릿이 따로 다루게 하는 설정입니다. 감사 필드를 사용하는지는 팩마다 다릅니다.
칸내용
Audit Table감사 필드를 가진 테이블을 커넥션, 스키마, 테이블 순으로 선택합니다. 비워 두면 탭 이름에 경고 아이콘과 Audit Table 을 설정하지 않는 경우 일부 기능이 작동하지 않을 수 있습니다. 안내가 나옵니다
Audit Entity Interface, Immutable Audit Entity Interface감사 필드를 가진 엔티티가 이어받을 클래스 이름입니다
생성 필드 이름, 수정 필드 이름생성과 수정의 작성자(작성자), 일시(일시) 필드로 볼 이름입니다. 이름을 적고 추가 버튼을 클릭합니다
  • 이름은 DB 컬럼 이름이 아니라 이름 규칙을 거친 필드 이름(createdBy 같은)으로 적습니다.
  • 선택한 테이블의 컬럼 정보는 같은 커넥션의 테이블로 코드를 만들 때만 템플릿에 전해집니다.

주의할 점

  • 설치는 묻지 않고 파일을 저장합니다. 덮어쓰기(O) 템플릿은 손으로 수정한 파일도 덮어씁니다. 처음 설치하기 전에 선택 템플릿 다운로드 버튼으로 결과를 다운로드해 확인하거나, 설치 위치 폴더를 git 에 커밋해 두세요.
  • 덮어쓰지 않는 템플릿이 이미 있는 파일을 만나거나 끼워 넣을 표시를 찾지 못한 파일은 건너뜁니다. 그때는 설치 완료 알림 대신 설치하지 않은 파일의 수와 첫 사유가 알림으로 나옵니다. 설치 중에 오류가 나면 거기서 멈추고 오류 알림이 나옵니다.
  • 데스크톱에서 템플릿은 코드를 만드는 동안 기기에서 실행됩니다. 다른 사람이 만든 공개 팩은 믿을 수 있는 것만 사용하고, 처음 사용하는 팩은 템플릿 팩 관리 에서 내용을 먼저 보세요.
  • 로그인한 채 선택한 비공개 팩은 로그인하지 않은 상태에서 읽지 못합니다. 비공개 팩을 지정한 프로젝트를 로그인 없이 열면 코드를 만들 수 없습니다.
  • 고정한 버전보다 새 버전이 있어도 결과는 고정한 버전으로 만듭니다. 팩 작성자가 수정한 내용을 사용하려면 업그레이드 버튼을 클릭하세요.

관련 화면