| View file | ||
|---|---|---|
|
1.1 로컬 개발환경
1.1.1 IDE Tool
- IntelliJ IDEA - 2023.2(232.8660.185) : 최신 버전 이용
- Visual Studio Code - 1.81 : 최신 버전 이용
- Eclipse - 2023‑06 : 최신 버전 이용
1.1.2 JDK 버전
- openjdk-17.0.8.7.1 (LTS) : 17버전 기준으로 최신 버전 이용
1.1.3 형상관리
- GitLab : 배포서버에 설치된 GitLab에서 생성되는 Git Repository를 사용
1.1.4 WAS
- Tomcat – 10.1.11 : Java Servlet Container
1.1.5 DBMS
- Postgresql – 15.3
1.2 주요 Framework / Library
1.2.1 Spring Framework
- spring-boot – 3.1.2
- spring-core – 6.0.11
- spring-data-jpa – 3.1.2
- tomcat-embed-core – 10.1.11 (exclusion)
1.2.2 Spring Cloud Aws – 3.0.1
1.2.3 logback – 1.4.8
1.2.4 mybatis – 3.5.13
1.2.5 HikariCP – 5.0.1
1.2.6 postgresql – 42.6.0
1.2.7 querydsl – 5.0.0
1.2.8 ehcache – 3.10.8
1.2.9 jjwt – 0.11.5
1.2.10 poi – 5.2.3
1.2.11 jackson
- jackson-core – 2.15.2
- jackson-databind – 2.15.2
1.2.12 Apache Utils
- commons-lang3 – 3.12.0
- commons-text – 1.10.0
- commons-io - 2.13.0
- commons-codec – 1.16.0
- commons-beanutils – 1.9.4
1.2.13 Lombok – 1.18.28
1.2.14 Springdoc(swagger 3.0) – 2.1.0
로컬개발환경 세팅
1.3 개발환경 다운로드
개발 Tool의 경우 3가지중에 본인이 사용하는 프로그램을 다운로드
- IntelliJ IDEA : https://www.eclipse.org/downloads/
- Visual Studio Code : https://code.visualstudio.com/
- Eclipse : https://www.eclipse.org/downloads/
1.4 Tool 설치 파일
- git (git version control) : https://git-scm.com/ (git에서 소스코드를 받기 위해서 설치)
- SourceTree (git ui client) : https://www.sourcetreeapp.com/ (SourceTree를 사용하지 않고 개발 Tool에서 기본 제공하는 Git Client 사용도 가능)
- DBeaver (db client) : https://dbeaver.io/download/ (DBMS를 활용하기 위한 UI Client
- Open Jdk 17 : https://docs.aws.amazon.com/corretto/latest/corretto-17-ug/downloads-list.html (Amazon외에 다른 곳에서 제공하는 Open jdk를 설치하여도 됨)
1.5 Project 목록
- x2bee-common : Spring 공통 기능 제공 프로젝트
(해당 프로젝트의 경우 각각의 Spring 프로젝트가 pom.xml에서 dependency를 추가하여 참조해서 사용하고 있음)
- x2bee-gw : Spring cloud gateway 프로젝트
- x2bee-bo : 관리자 사이트 Spring Thymeleaf Front End 프로젝트
- x2bee-api-bo : 관리자 Api Spring 프로젝트
- x2bee-api-common : 공통 Api 및 외부 인터페이스 Api Spring 프로젝트
- x2bee-api-display : 전시 Api Spring 프로젝트
- x2bee-api-event : 이벤트 Api Spring 프로젝트
- x2bee-api-goods : 상품 Api Spring 프로젝트
- x2bee-api-order : 주문 Api Spring 프로젝트
- x2bee-api-member : 회원 Api Spring 프로젝트
- x2bee-batch-gddp : 전시, 상품 Spring Batch 프로젝트
- x2bee-batch-mbod: 회원, 주문 Spring Batch 프로젝트
...
본 문서에서는 개발자 개발 환경 설정 방법에 대하여 기술합니다.
아래에서 로컬 개발환경 기본구조를 설명하고, 로컬개발환경 세팅 방법을 설명합니다.
로컬 개발환경
구분 | 내용 | 비고 |
|---|---|---|
IDE Tool | IntelliJ IDEA 2024.1.2 | 최신 버전 이용 |
Visual Studio Code 1.89 | 최신 버전 이용 | |
Eclipse 2024‑03 | 최신 버전 이용 | |
JDK 버전 | OpenJDK 17.0.10.8.1 (LTS) | 17 버전 중 최신 버전 이용 |
Node 버전 | Node.js 20.12.1 (LTS) | 20 버전 중 최신 버전 이용 |
형상관리 | GitLab | |
WAS | Apache Tomcat 10.1.24 | Java Servlet Container |
DBMS | PostgreSQL 15.3 |
주요 프레임워크(Framework)
Spring Framework
spring-boot 3.3.1
spring-core 6.1.10
spring-data-jpa 3.3.1
tomcat-embed-core 10.1.25 (exclusion)
Spring Cloud Framework
spring-cloud 2023.0.2
spring-cloud-aws 3.1.1
NestJS Framework
nestjs 10.3.9
opensearch 2.10.0
typeorm 0.3.20
pg 8.11.5
Next.js Framework
next 14.2.3
next-intl 3.14.1
react 18.3.1
react-query 5.40.0
zustand 4.5.2
Spring Framework 주요 라이브러리 (Library)
구분 | 내용 | 비고 |
|---|---|---|
Logging | logback 1.5.6 | |
Database |
| |
Query 및 ORM | querydsl 5.1.0 | |
Cache | ehcache 3.10.8 | |
인증 및 보안 | jjwt 0.12.6 | |
Excel 처리 | poi 5.2.5 | |
JSON 처리 (Jackson) |
| |
Apache Utils |
| |
편의성 라이브러리 | Lombok 1.18.32 | |
API 문서화 | Springdoc 2.5.0 - Swagger3.0 |
NestJS Framework 주요 라이브러리 (Library)
구분 | 내용 | 비고 |
|---|---|---|
Logging | winston 3.13.0 | |
Database |
| |
Query 및 ORM | typeorm 0.3.20 | |
Cache | cache-manager 5.5.3 | |
인증 및 보안 | nestjs/jwt 10.2.0 | |
통신 처리 | axios 1.7.2 | |
검색엔진Database | opensearch 2.10.0 | |
인메모리 Database | ioredis 5.4.1 | |
API 문서화 | nestjs/swagger 7.3.1 - Swagger3.0 |
Next.js Framework 주요 라이브러리 (Library)
구분 | 내용 | 비고 |
|---|---|---|
상태관리 | zustand 4.5.2 | |
데이터 조회 캐싱 | react-query 5.40.0 | |
다국어 처리 | next-intl 3.14.1 | |
반응형 슬라이드쇼 처리 | swiper 11.1.3 | |
CSS | tailwindcss 3.4.3 |
로컬 개발환경 세팅
프로젝트 개발을 시작하기 위해 필요한 개발 도구 정보를 참고하여 설치해주세요.
구분 | 도구 | 다운로드 |
|---|---|---|
개발 | IntelliJ IDEA | |
Visual Studio Code | ||
Eclipse | ||
필수 | git (Git Client 사용 가능) | |
SourceTree | ||
DBeaver | ||
Open Jdk 17 (타사 Opeb jdk 가능) | ||
Node.js 20 |
프로젝트 목록
프로젝트명 | 설명 |
|---|---|
x2bee-common | Spring 공통 기능 제공 프로젝트 |
x2bee-gw | Spring Cloud Gateway 프로젝트 |
x2bee-bo | 관리자 사이트 Next.js Front End 프로젝트 |
x2bee-api-bo | 관리자 API Spring 프로젝트 |
x2bee-api-common | 공통 API 및 외부 인터페이스 API Spring 프로젝트 |
x2bee-api-display | 전시 API Spring 프로젝트 |
x2bee-api-event | 이벤트 API Spring 프로젝트 |
x2bee-api-goods | 상품 API Spring 프로젝트 |
x2bee-api-order | 주문 API Spring 프로젝트 |
x2bee-api-member | 회원 API Spring 프로젝트 |
x2bee-batch-gddp | 전시, 상품 Spring Batch 프로젝트 |
x2bee-batch-mbod | 회원, 주문 Spring Batch 프로젝트 |
x2bee-nest-search | 검색엔진 프로젝트 |
x2bee-fo | 사용자 사이트 Next.js Front End 프로젝트 |
IntelliJ IDEA 설정 및 APP 실행하기
IntelliJ를 설치하고 실행합니다.
Git에서 소스코드를 복제하기 위해 “Git-Clone”을 실행합니다.
전체 프로젝트 또는 개별 프로젝트를 선택하고 "Reload project"를 실행하여 Maven에서 의존성을 재설정 및 다운로드합니다.
| Rw ui textbox macro | ||
|---|---|---|
| ||
의존성 설정에 문제가 있어 충돌이 발생하면 메뉴에서 "Clean"을 선택하여 초기화한 후 다시 "Reload"합니다. |
실행할 프로젝트의 기동 파일을 선택하고 "Run" 또는 "Debug"를 선택하여 해당 프로젝트를 실행합니다.
IntelliJ IDEA 설정 및 FO APP 실행하기
IntelliJ를 설치하고 실행합니다.
Git에서 소스코드를 복제하기 위해 “Git-Clone”을 실행합니다.
package.json을 선택하고 "Run ‘npm install’"를 실행하여 npm에서 의존성을 재설정 및 다운로드합니다.
npm 실행 목록에서 "start:local"을 선택하여 해당 프로젝트를 실행합니다.
Visual Studio Code 설정 및 APP 실행하기
Visual Studio Code를 설치하고 실행합니다.
소스 코드를 복제하기 위해 "Source Control" 탭에서 "Clone Repository"를 실행합니다.
"Extensions" 탭에서 "java"를 검색하여 "Extension Pack for Java" 및 "Spring Boot Extension Pack"을 설치합니다.
해당 프로젝트의 실행 파일을 선택하고 “Run” 또는 “Debug”를 선택하여 해당 프로젝트를 실행합니다.
Eclipse 설정 및 APP 실행하기
Eclipse를 설치하고 실행합니다.
"Open Perspective" 창에서 "Clone a Git repository"를 실행하여 Git Repository에서 소스 코드를 로컬 디렉토리에 복제합니다.
Lombok 다운로드에서 "lombok.jar" 파일을 Eclipse 설치 경로에 다운로드합니다. 그 후, 설치된 폴더의 "eclipse.ini" 파일을 열어 "-javaagent:C:\설치경로\jee-2023-06\eclipse\lombok.jar"를 추가합니다.
실행할 프로젝트의 기동 파일을 선택하고 "Run" 또는 "Debug"를 선택하여 해당 프로젝트를 실행합니다.