Generate CRUD Code

개요

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

Generate CRUD Code는 DDL의 테이블 구조를 분석하여 eGovFrame 표준 아키텍처에 맞는 CRUD 코드 파일 전체를 자동으로 생성하는 핵심 기능이다. Java 계층(VO, Service, Controller, Mapper)과 SQL 매핑 파일(MyBatis XML), 뷰 템플릿(Thymeleaf HTML, JSP)을 한 번에 생성한다.

실행 조건

다음 항목이 모두 입력되어야 Generate CRUD Code 버튼이 활성화된다.

유효성 검사

버튼 클릭 시 다음 항목에 대해 유효성 검사가 수행된다. 오류가 있으면 오류 목록이 표시되며 생성이 진행되지 않는다.

생성 가능한 파일 목록

Generate CRUD Code 버튼 클릭시 상단에 생성 가능한 파일 목록 다이얼로그가 뜬다. 기본적으로 모든 템플릿이 선택된 상태이고, 체크박스를 통해 특정 템플릿만 선택적으로 생성할 수도 있다.

생성되는 파일 목록

DDL의 테이블명을 기반으로 클래스명이 결정되며, 아래 규칙에 따라 변환된다.

• 테이블명의 snake_case를 PascalCase로 변환하여 클래스명으로 사용한다.
  • 예) BOARD_NOTICE → BoardNotice

Java 파일

설정 파일

뷰 템플릿

디렉터리 구조

패키지 이름이 egovframework.example.sample이고 테이블명이 BOARD인 경우, 출력 경로 아래에 다음과 같은 구조로 파일이 생성된다.

src/
└── main/
    ├── java/
    │   └── egovframework/example/sample/
    │       ├── service/
    │       │   ├── BoardVO.java
    │       │   ├── DefaultVO.java
    │       │   └── BoardService.java
    │       ├── service/impl/
    │       │   ├── BoardServiceImpl.java
    │       │   └── BoardMapper.java
    │       └── web/
    │           └── BoardController.java
    ├── resources/
    │   ├── mapper/
    │   │   └── Board_SQL.xml
    │   └── templates/board/
    │       ├── BoardList.html
    │       └── BoardRegist.html
    └── webapp/
        └── WEB-INF/jsp/egovframework/example/sample/
            ├── BoardList.jsp
            └── BoardRegist.jsp

생성 코드 상세

VO 클래스 (클래스명VO.java)

• DDL의 각 컬럼이 Java 필드로 매핑된다.
• 컬럼명은 snake_case → camelCase로 변환된다 (예: REGIST_DATE → registDate).
• SQL 데이터 타입은 아래 기준으로 Java 타입으로 변환된다.

• DefaultVO를 상속하므로 페이징·검색 관련 필드(pageIndex, pageUnit, pageSize 등)를 별도로 선언하지 않아도 사용 가능하다.

ServiceImpl 클래스

• EgovAbstractServiceImpl을 상속한다.
• 등록(insert) 시 egovIdGnrService(ID Generation 서비스)를 통해 PK 값을 자동으로 채번하여 설정한다.
• PK 컬럼이 복수인 경우 코드 내 주석(// egovframe-Todo)으로 추가 검토가 필요한 부분을 안내한다.

Controller 클래스

다음 URL 패턴의 핸들러 메서드가 생성된다 (테이블명 Board 기준).

MyBatis SQL Mapper XML

클래스명_SQL.xml에는 다음 쿼리가 포함된다.