1. 프로젝트 개요
HiveGenerator 는 개발자의 생산성을 극대화하고 반복적인 코딩 작업을 최소화하기 위해 설계된 단계별 코드 생성 플랫폼입니다. 이 솔루션은 단순한 스크립트 실행을 넘어 커뮤니티 기반의 공유 및 협업을 지향하며, 다음과 같은 세 가지 주요 발전 단계를 거칩니다.
- 로컬 CLI 도구: 사용자의 인터랙티브 입력을 기반으로 즉석에서 특정 코드를 생성하는 명령줄 인터페이스.
- 생성기 제작 유틸리티: 기존 프로젝트 코드를 템플릿으로 변환하여 재사용 가능한 생성기로 만드는 도구.
- 웹 기반 플랫폼: 생성기의 제작, 배포, 온라인 실행 및 공유를 지원하는 통합 환경.
2. 환경 설정 및 실행
필수 요구 사항
- JDK 8 이상
- Apache Maven
- Git
소스 코드 획득 및 빌드
저장소에서 소스를 다운로드하고 Maven 을 통해 프로젝트를 컴파일합니다.
git clone https://github.com/Enndfp/code-generator.git
cd code-generator
mvn clean package -DskipTests
로컬 생성기 실행
빌드된 JAR 파일을 사용하여 명령줄에서 도구를 기동합니다.
java -jar code-generator-basic/target/code-generator-basic.jar
실행 예시
예를 들어, 새로운 백엔드 서비스 구조를 생성하려면 다음과 같이 파라미터를 전달할 수 있습니다.
java -jar code-generator-basic/target/code-generator-basic.jar --appName=OrderService --groupIds=com.shop.backend
3. 활용 시나리오 및 권장 사항
시나리오 1: Spring Boot 프로젝트 스캐폴딩
새로운 마이크로서비스를 시작할 때, HiveGenerator 를 통해 컨트롤러, 서비스 계층, 설정 파일 및 필수 Maven 의존성을 포함한 기본 골격을 즉시 구축할 수 있습니다.
시나리오 2: 커스텀 DTO 및 엔티티 생성
반복적으로 작성하는 데이터 전송 객체 (DTO) 나 엔티티 클래스의 경우, 특정 어노테이션이 포함된 템플릿을 정의하여 일관된 형식의 코드를 자동으로 생성할 수 있습니다.
개발 모범 사례
- 템플릿 재사용성: 빈번하게 사용되는 코드 블록은 템플릿으로 등록하여 관리합니다.
- 동적 파라미터 적용: 템플릿에 변수를 도입하여 생성되는 코드의 유연성을 확보합니다.
- CI/CD 연동: 파이프라인에 코드 생성 단계를 포함시켜 배포 과정을 자동화합니다.
4. 통합 기술 생태계
Spring Boot
생성된 프로젝트는 Spring Boot 프레임워크와 즉시 호환되도록 설계되어, 설정 파일과 메인 클래스 생성 시 최적화된 구조를 제공합니다.
FreeMarker 템플릿 엔진
코드 생성의 핵심 로직에는 FreeMarker 가 사용됩니다. 이 엔진은 복잡한 조건문과 반복문을 지원하여 동적인 콘텐츠 생성에 적합합니다.
Maven 빌드 도구
생성된 프로젝트의 의존성 관리 및 빌드 과정은 Maven 을 표준으로 채택하여, 기존 Java 생태계와의 호환성을 유지합니다.