4 crudgen 시작하기
hanmj edited this page 7 months ago

crudgen이란?

crudgen이란 엔티티를 데이터베이스 테이블에 저장, 수정, 삭제, 조회를 실행하는 소스코드를 생성하는 도구다. 구체적으로

  • BusinessEntity
  • BusinessQuery
  • business-mapper.xml
  • BusinessMapper.java
  • BusinessBean.java
  • BusinessServiceBean.java
  • BusinessService.java
  • BusinessController.java

등의 소스코드를 생성한다.

설치

다운로드

crudgen의 배포파일(package/crudgen.zip)을 다운로드하여 원하는 경로로 옮긴다.

압축풀기

배포파일의 압축을 풀면 아래와 같은 레이아웃의 디렉토리가 생성된다.

  • logs: 로그파일 디렉토리
  • src/main
    • java: 자바 소스 디렉토리
    • resources: 설정파일 디렉토리
    • webapp: 웹애플리케이션 리소스 디렉토리
  • crudgen/pom.xml
위 디렉토리를 개발환경에 프로젝트로 import한다.

설정

소스코드가 생성되야할 대상 프로젝트 관련 정보를 다음과 같이 설정한다.

crudgen.properties

src/main/resources/properties/crudgen.properties를 열어 다음 내용을 설정한다.

# 소스생성 대상 프로젝트 경로
crudgen.project.target=../app-starter-test

# 소스 작성자
crudgen.source.author=mjkhan

# 메인 소스 디렉토리 
crudgen.dir.source=/src/main/java
# mapper-xml 디렉토리
crudgen.dir.mapperXml=/src/main/resources/sql/mapper

# 테스트 소스 디렉토리
crudgen.dir.testSource=/src/test/java

application.yml

src/main/resources/application.yml을 열어 대상 프로젝트의 데이터베이스 접속정보를 설정한다.

spring:
  ...
  sql:
    init:
      platform: mariadb
  ...
  datasource:
    hikari:
      ...
      jdbc-url: jdbc:log4jdbc:mariadb://호스트:포트/DB이름?useUnicode=true&characterEncoding=utf8&serverTimezone=Asia/Seoul&useSSL=false
      username: 사용자 아이디
      password: 비밀번호
      ...

소스코드 생성

crudgen 실행

crudgen을 실행하여 웹서버를 시작하면 다음과 같은 웹페이지가 열린다.

테이블 정보 가져오기

'테이블 이름'을 입력하고, '테이블 정보 가져오기' 버튼을 클릭하면 다음과 같이 테이블 정보를 가져온다.

소스코드 미리보기

다음 항목들을 입력하고 '미리보기' 버튼을 클릭하면 다음과 같이 소스코드를 미리 볼 수 있다.

  • 패키지: 생성할 소스코드들의 기준 패키지. cokr.xit로 시작해야 한다.
  • 엔티티: 엔티티 클래스 이름
  • 설명: 엔티티 클래스의 주석
  • @Getter, @Setter: 체크하면 @Getter, @Setter 주석을 적용한다.
  • 컬럼 설명: 각 컬럼별 주석

소스코드 생성

다음 항목들을 입력하고 '소스코드 생성' 버튼을 클릭하면 대상 프로젝트의 디렉토리에 소스코드를 생성한다.

  • 패키지: 생성할 소스코드들의 기준 패키지. cokr.xit로 시작해야 한다.
  • 엔티티: 엔티티 클래스 이름
  • 설명: 엔티티 클래스의 주석
  • @Getter, @Setter: 체크하면 @Getter, @Setter 주석을 적용한다.
  • 컬럼 설명: 각 컬럼별 주석

개발환경의 디렉토리를 새로고침하면 생성한 소스코드를 확인할 수 있다.