From de6d2af4d8e5d0343f7aeb0d5aac6133ff63e8da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=EC=A3=BC=EC=88=98=ED=98=84?= Date: Wed, 30 Jul 2025 12:13:05 +0900 Subject: [PATCH] =?UTF-8?q?=EB=A6=AC=EB=93=9C=EB=AF=B8=20=EC=97=85?= =?UTF-8?q?=EB=8D=B0=EC=9D=B4=ED=8A=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 539 ++++++++++++++++++++++-------------------------------- 1 file changed, 217 insertions(+), 322 deletions(-) diff --git a/README.md b/README.md index 27bddca8..95a2aeed 100644 --- a/README.md +++ b/README.md @@ -1,404 +1,299 @@ +# KOREA-RESEARCH μ‹œμŠ€ν…œ -# KOREA-RESEARCH +## πŸ“Œ ν”„λ‘œμ νŠΈ κ°œμš” + +**KOREA-RESEARCH**λŠ” μž„κ°€ νŒ¨λ„μ˜ 일계뢀 μˆ˜μ§‘ 및 관리λ₯Ό μœ„ν•œ μ‹œμŠ€ν…œμž…λ‹ˆλ‹€. +이 μ‹œμŠ€ν…œμ€ ν—₯사고날 μ•„ν‚€ν…μ²˜(Ports & Adapters) νŒ¨ν„΄μ„ μ μš©ν•œ Spring Boot 기반의 λ©€ν‹°λͺ¨λ“ˆ ν”„λ ˆμž„μ›Œν¬λ₯Ό 기반으둜 ν•˜μ—¬ μž‘μ„± λ˜μ—ˆμŠ΅λ‹ˆλ‹€. + +--- + +## βœ… Prerequisites + +- JDK 17+ +- Maven +- PostgreSQL + +--- + +## πŸ“‚ ν”„λ‘œμ νŠΈ ꡬ쑰 ``` -β”¬β”€β”β”Œβ”€β”β”Œβ”€β”β”¬ β”¬β”Œβ”€β”β”¬ β”Œβ”€β” -β”œβ”¬β”˜β”œβ”€ β”‚ β””β”¬β”˜β”‚ β”‚ β”œβ”€ -β”΄β””β”€β””β”€β”˜β””β”€β”˜ β”΄ β””β”€β”˜β”΄β”€β”˜β””β”€β”˜ - framework for spring developers exploring JPA +β”œβ”€β”€ admin # κ΄€λ¦¬μž μ–΄ν”Œλ¦¬μΌ€μ΄μ…˜ +β”œβ”€β”€ core # 곡톡 도메인 및 둜직 +β”œβ”€β”€ front # μ‚¬μš©μž μ–΄ν”Œλ¦¬μΌ€μ΄μ…˜ +└── pom.xml - _____\ _______ - / \ | /\ - /_______/ |_____/ \ - | \ / / / - \ \ \/ / - \ / \__/_ - \/ ____ /\ - / \ / \ - /\ \ / / - \ \/ / - \___\__/ - -GNU GENERAL PUBLIC LICENSE -Version 3, 29 June 2007 - -Copyright (C) 2007 Free Software Foundation, Inc. -Everyone is permitted to copy and distribute verbatim copies -of this license document, but changing it is not allowed. ``` -## ν”„λ‘œμ νŠΈ κ°œμš” +> λͺ¨λ“  μ• ν”Œλ¦¬μΌ€μ΄μ…˜μ€ `core` λͺ¨λ“ˆμ„ μ€‘μ‹¬μœΌλ‘œ 포트, μ–΄λŒ‘ν„° ꡬ쑰둜 κ΅¬μ„±λ©λ‹ˆλ‹€. -λ³Έ ν”„λ‘œμ νŠΈλŠ” **ν—₯사고날 μ•„ν‚€ν…μ²˜(Ports & Adapters)** 기반의 Spring Boot λ©€ν‹°λͺ¨λ“ˆ μ‹œμŠ€ν…œμž…λ‹ˆλ‹€. -도메인 둜직과 μ™ΈλΆ€ μ‹œμŠ€ν…œ(μ›Ή, DB, 파일 λ“±)을 λͺ…ν™•νžˆ λΆ„λ¦¬ν•˜μ—¬ μœ μ§€λ³΄μˆ˜μ„±κ³Ό ν™•μž₯성을 κ·ΉλŒ€ν™”ν•˜μ˜€μŠ΅λ‹ˆλ‹€. - -## Prerequisites - -* JDK 17+ -* Maven -* PostgreSQL - -## Structure - -recycle 은 `core` λͺ¨λ“ˆμ„ 기반으둜 ν•œ `admin`, `front`, `api` μ–΄ν”Œλ¦¬μΌ€μ΄μ…˜μœΌλ‘œ κ΅¬μ„±λ˜μ–΄ μžˆλ‹€. - -```shell -. -|-- README.md -|-- admin # κ΄€λ¦¬μž μ–΄ν”Œλ¦¬μΌ€μ΄μ…˜ -| |-- pom.xml -| |-- src -| `-- target -|-- core # 곡톡 λͺ¨λ“ˆ -| |-- pom.xml -| |-- src -| `-- target -|-- front # ν”„λ‘ νŠΈ μ–΄ν”Œλ¦¬μΌ€μ΄μ…˜ -| |-- pom.xml -| |-- src -| `-- target -`-- pom.xml -`-- README.md -``` - -⚑ AWS S3 μ—…λ‘œλ“œλ₯Ό μ΄μš©ν•˜μ§€ μ•ŠλŠ”λ‹€λ©΄, pom.xml μ—μ„œ `aws`λͺ¨λ“ˆ κ΄€λ ¨ λ‚΄μš©μ„ μ‚­μ œν•˜λ©΄ λœλ‹€. -⚑ `admin`, `front`, `api` 쀑 μ‹€μ œ ν”„λ‘œμ νŠΈμ—μ„œ μ‚¬μš©ν•  λͺ¨λ“ˆλ§Œ 남기고 μ‚­μ œν•΄μ£Όμ„Έμš”. - -βœ”οΈ Dockerfile κ³Ό .gitlab-ci.yml 은 μ‚­μ œν•΄μ£Όμ„Έμš” : ) recycle demo μš©μ΄κΈ°μ— μ—¬λ €λΆ„μ˜ ν”„λ‘œμ νŠΈμ—μ„œλŠ” μ˜λ―Έκ°€ μ—†μŠ΅λ‹ˆλ‹€. - -recycle 의 demo κ°€ κΆκΈˆν•˜λ‹€λ©΄ μ•„λž˜ URL μ—μ„œ 확인 ν•΄μ£Όμ„Έμš”. -- `recycle-admin` - https://recycle-admin.etribe.co.kr 계정정보 (recycle-super/recycle1@#$) -- `recycle-api` - https://recycle-api.etribe.co.kr/swagger-ui/index.html -- `recycle-front` - https://recycle-front.etribe.co.kr/ 계정정보 (generalUser/generalUser1@#$) - -### 각 λͺ¨λ“ˆμ˜ λ‚΄λΆ€ ꡬ쑰(ν—₯사고날 μ•„ν‚€ν…μ²˜ μ˜ˆμ‹œ) +### πŸ“¦ ν—₯사고날 ꡬ쑰 μ˜ˆμ‹œ ``` usecase/ - └── daily/ - └── expense/ - β”œβ”€β”€ ports/ - β”‚ β”œβ”€β”€ application/ - β”‚ β”‚ └── DailyExpenseService.java - β”‚ β”œβ”€β”€ DailyExpensePortIn.java - β”‚ └── DailyExpensePortOut.java - └── adapters/ - β”œβ”€β”€ persistence/ - β”‚ └── DailyExpenseDao.java - └── web/ - └── DailyExpenseController.java -``` -- **ports/**: 도메인 μ„œλΉ„μŠ€ 및 μΈν„°νŽ˜μ΄μŠ€(Port) -- **adapters/**: μ™ΈλΆ€ μ‹œμŠ€ν…œ(μ›Ή, DB λ“±) μ—°κ²° μ–΄λŒ‘ν„° +└── daily/ +└── expense/ +β”œβ”€β”€ ports/ +β”‚ β”œβ”€β”€ application/ +β”‚ β”‚ └── DailyExpenseService.java +β”‚ β”œβ”€β”€ DailyExpensePortIn.java +β”‚ └── DailyExpensePortOut.java +└── adapters/ +β”œβ”€β”€ persistence/ +β”‚ └── DailyExpenseDao.java +└── web/ +└── DailyExpenseController.java +```` -## VM Options +--- -ν”„λ ˆμž„μ›Œν¬ μ‹€ν–‰ μ‹œ ν•„μš”ν•œ μžλ°” VM μ˜΅μ…˜μ€ μ•„λž˜μ™€ κ°™λ‹€. +## βš™οΈ VM Options -| VM λ³€μˆ˜ | μ„€λͺ… | μ„€μ • κ°’ | ν•„μˆ˜μ—¬λΆ€ | -|-----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|-------------------------|------| -| -Dspring.profiles.active | Spring active ν”„λ‘œνŒŒμΌ | local, dev, prod | Y | -| -Dapp.initData.core | μ–΄ν”Œλ¦¬μΌ€μ΄μ…˜ 초기 ꡬ동에 ν•„μš”ν•œ ν•„μˆ˜ 데이터 생성여뢀 | true, false | N | -| -Dspring.sql.init.mode | SQL μ΄ˆκΈ°ν™” λͺ¨λ“œλ₯Ό μ„€μ • | always, embedded, never | N | -| -Dpath.upload.public | 파일 μ—…λ‘œλ“œ 경둜 | κΈ°λ³Έκ°’ (~/upload/public) | N | -| -Dpath.upload.tmpdir | μž„μ‹œ 파일 μ—…λ‘œλ“œ 경둜 | κΈ°λ³Έκ°’ (~/upload/tmpdir) | N | -| -Dlogging.file.path | 둜그 파일 생성 경둜 | κΈ°λ³Έκ°’ (~/logs) | N | -| -Dfile.encoding | JVM 속성 | `UTF-8` | Y | -| -Djava.net.preferIPv4Stack | JVM 속성. ν΄λΌμ΄μ–ΈνŠΈ IPμ²΄ν¬μ‹œ IPv4 ν˜•μ‹μ„ μ‚¬μš©ν•˜κΈ° μœ„ν•¨. | true | Y | -| -Dcom.amazonaws.sdk.disableEc2Metadata | aws λͺ¨λ“ˆμ˜ ec2 metadata 전솑 끄기 | true | N | -| **-Dserver.port** (2023-03-25 μΆ”κ°€) | μ„œλ²„ 포트 (μ—†λ‹€λ©΄ κΈ°λ³Έ 8080) | μ›ν•˜λŠ” port | N | -| **-Dserver.forward-headers-strategy** (2023-03-25 μΆ”κ°€) | ν”„λ‘μ‹œ μ„œλ²„(nginx, apache)에 μ •μ˜λœ `X-Forward-For`, `X-Forwarded-Proto` 섀정값을 μ΄μš©ν•˜λ €λ©΄ `native` 둜 μ„€μ •ν•΄μ£Όλ©΄ λœλ‹€. (λ‚΄μž₯ μ»¨ν…Œμ΄λ„ˆλ₯Ό μ‚¬μš©ν•˜λŠ” κ²½μš°μ—λ§Œ 유효) | `native` | N | -| **-Dspring.datasource.driver-class-name** (2023-03-25 μΆ”κ°€) | JDBC Driver. μ—†λ‹€λ©΄ JDBC URL을 κΈ°μ€€μœΌλ‘œ JPAκ°€ νŒλ‹¨ν•œλ‹€. | jdbc λ“œλΌμ΄λ²„ | Y | -| **-Dspring.datasource.url** (2023-03-25 μΆ”κ°€) | JDBC URL | jdbc url | N | -| **-Dspring.datasource.username** (2023-03-25 μΆ”κ°€) | DB Username | DB μ‚¬μš©μž | Y | -| **-Dspring.datasource.password** (2023-03-25 μΆ”κ°€) | DB Password | DB νŒ¨μŠ€μ›Œλ“œ | Y | - - -### VM Options μ˜ˆμ‹œ -#### `admin`, `front` λͺ¨λ‘ μ‚¬μš©κ°€λŠ₯ν•©λ‹ˆλ‹€. -``` --Dspring.profiles.active=local --Dapp.initData.core=false --Dspring.sql.init.mode=never +```bash +-Dspring.profiles.active=prod +-Dserver.port=8081 -Dfile.encoding=UTF-8 -Djava.net.preferIPv4Stack=true --Dcom.amazonaws.sdk.disableEc2Metadata=true --Dserver.port=8080 --Dserver.forward-headers-strategy=native -Dlogging.level.org.springframework.security=DEBUG -Daes.secret-key=092HW829O0A0AVR0 -Dpath.upload.storage=LOCAL --Dpath.upload.sftp.public=/home/etribe/data/upload --Dfile.upload.sftp.ip=115.68.193.117 --Dfile.upload.sftp.id=etribe --Dfile.upload.sftp.password=Etribe@3415 --Dfile.upload.sftp.port=22 --Dspring.datasource.hikari.maximum-pool-size=10 --Dspring.datasource.hikari.minimum-idle=5 --Dspring.datasource.hikari.idle-timeout=120000 --Dspring.datasource.hikari.max-lifetime=900000 --Dspring.datasource.hikari.connection-timeout=5000 --Dspring.datasource.hikari.leak-detection-threshold=30000 -``` -** 주의 : μš΄μ˜μ„œλ²„μΌ 경우 vmμ˜΅μ…˜ μΆ”κ°€ --Dspring.profiles.active=prod --Dpath.upload.storage=SFTP +-Dpath.upload.public=/home/etribe/data/upload +-Dpath.upload.tmpdir=/home/etribe/data/upload/tmp -Djasypt.encryptor.password=ko-research -Djasypt.encryptor.algorithm=PBEWITHHMACSHA512ANDAES_256 +```` +## πŸ’» 둜컬 ꡬ동 μ‹œ ν•„μˆ˜ μ„€μ • -## JDBC 및 데이터 핸듀링 ꡬ성 μ˜΅μ…˜ +둜컬 ν™˜κ²½μ—μ„œ ꡬ동 μ‹œ μ•„λž˜ JVM μ˜΅μ…˜λ“€μ„ ν™˜κ²½μ— 맞게 μ„€μ •ν•΄ μ£Όμ„Έμš” -### app.initData.core - -```shell --Dapp.initData.core=true # true | false +```bash +-Dspring.profiles.active=local +-Dpath.upload.public=/home/etribe/data/upload +-Dpath.upload.tmpdir=/home/etribe/data/upload/tmp +-Djasypt.encryptor.password=ko-research +-Djasypt.encryptor.algorithm=PBEWITHHMACSHA512ANDAES_256 ``` -μ–΄ν”Œλ¦¬μΌ€μ΄μ…˜ 초기 ꡬ동에 ν•„μš”ν•œ ν•„μˆ˜ 데이터 생성여뢀. κ³΅ν†΅μ½”λ“œ, 메뉴 정보 및 κ°œλ°œμ— ν•„μš”ν•œ 기반 데이터 등이 여기에 ν•΄λ‹Ήν•œλ‹€. -InitAdminData, InitUriFrontData λ“± *ApplicationRunner* κ΅¬ν˜„μ²΄μ—μ„œ λ‚΄μš©μ„ 확인할 수 μžˆλ‹€. - -### spring.sql.init.mode - -```shell --Dspring.sql.init.mode=never # always | embedded | never -``` -μ–΄ν”Œλ¦¬μΌ€μ΄μ…˜ 초기 ꡬ동 μ‹œ, schema.sql, data.sql λ“± SQL μ΄ˆκΈ°ν™” 슀크립트 μ‹€ν–‰ μ—¬λΆ€λ₯Ό μ œμ–΄ν•˜λŠ” μ„€μ •. - -* always : μ• ν”Œλ¦¬μΌ€μ΄μ…˜ ꡬ동 μ‹œ 항상 SQL 슀크립트λ₯Ό μ‹€ν–‰ -* embedded : λ‚΄μž₯ DB(H2 λ“±)일 κ²½μš°μ—λ§Œ μ‹€ν–‰ -* never : SQL 슀크립트λ₯Ό μ‹€ν–‰ν•˜μ§€ μ•ŠμŒ - -## 데이터 호좜 및 응닡 처리 방식 κ°€μ΄λ“œ -> BO(Back Office)와 FO(Front Office) ν™”λ©΄μ—μ„œλŠ” κΈ°λŠ₯에 따라 **Ajax 호좜 방식**κ³Ό **μ„œλ²„ λ Œλ”λ§ 방식(Server-Side Rendering, SSR)을** κ΅¬λΆ„ν•˜μ—¬ μ‚¬μš©ν•©λ‹ˆλ‹€. - -### BO (Back Office: κ΄€λ¦¬μž ν™”λ©΄) -- #### πŸ“‘ Ajax 호좜 방식 (REST API, JSON 응닡) -λ‹€μŒ κΈ°λŠ₯은 Ajaxλ₯Ό 톡해 REST API(JSON)λ₯Ό ν˜ΈμΆœν•©λ‹ˆλ‹€ - -| κΈ°λŠ₯ | λ©”μ„œλ“œ | URI | μ˜ˆμ‹œ | -|----------|----------|------------------------------------|------------------------| -| λͺ©λ‘ 쑰회 | GET | `/api/{resource-name}/list` | `/api/articles/list` | -| 등둝 | POST | `/api/{resource-name}/create` | `/api/articles/create` | -| μˆ˜μ • | PUT/PATCH | `/api/{resource-name}/update` | `/api/articles/update` | -| μ‚­μ œ | DELETE | `/api/{resource-name}/remove` | `/api/articles/remove` | -| 등둝 & μˆ˜μ • |POST | `/api/{resource-name}/save` | `/api/articles/save` | - - -- #### πŸ–₯️ μ„œλ²„ λ Œλ”λ§ 방식 (SSR) -상세 쑰회(view) 화면은 SSR λ°©μ‹μœΌλ‘œ μ²˜λ¦¬ν•©λ‹ˆλ‹€. - -| κΈ°λŠ₯ | λ©”μ„œλ“œ | URI | μ˜ˆμ‹œ | -|------------|--------|------------------------|---------------| -| 상세 쑰회 | GET | `/{resource-name}/{id}` | `/articles/1` | +> πŸ’‘ `-Djasypt.encryptor.password`와 `-Djasypt.encryptor.algorithm`λŠ” ν™˜κ²½μ— 따라 **μˆ˜μ • κ°€λŠ₯**ν•©λ‹ˆλ‹€. --- -### FO (Front Office: μ‚¬μš©μž ν™”λ©΄) -- #### πŸ“‘ Ajax 호좜 방식 (REST API, JSON 응닡) -λ‹€μŒ κΈ°λŠ₯은 Ajax 기반 REST API 호좜둜 μ²˜λ¦¬ν•©λ‹ˆλ‹€. -| κΈ°λŠ₯ | λ©”μ„œλ“œ | URI | μ˜ˆμ‹œ | -|------|------------|-------------------------|--------------------------| -| 등둝 | POST | `/api/{resource-name}/create` | `/api/articles/create` | -| μˆ˜μ • | PUT/PATCH | `/api/{resource-name}/update` | `/api/articles/update` | -| μ‚­μ œ | DELETE | `/api/{resource-name}/remove` | `/api/articles/remove` | +## ⚠️ 둜컬 DB μ—°κ²° κ΄€λ ¨ μ•ˆλ‚΄ -- #### πŸ–₯️ μ„œλ²„ λ Œλ”λ§ 방식 (SSR) -λͺ©λ‘ 및 상세 화면은 SSR λ°©μ‹μœΌλ‘œ μ²˜λ¦¬ν•  수 있으며, 상황에 따라 μ„ νƒμ μœΌλ‘œ μ‚¬μš©ν•©λ‹ˆλ‹€. +ν˜„μž¬ 제곡된 DB 섀정은 **운영 μ„œλ²„μš© 정보**만 ν¬ν•¨λ˜μ–΄ μžˆμŠ΅λ‹ˆλ‹€. +둜컬 ν™˜κ²½μ—μ„œ κ΅¬λ™ν•˜κΈ° μœ„ν•΄μ„œλŠ” **둜컬 DB 섀정을 λ³„λ„λ‘œ ꡬ성해야 ν•©λ‹ˆλ‹€.** -| κΈ°λŠ₯ | λ©”μ„œλ“œ | URI | μ˜ˆμ‹œ | -|------------|--------|------------------------------|------------------------| -| λͺ©λ‘ 쑰회 | GET | `/{resource-name}/list` | `/articles/list` | -| 상세 쑰회 | GET | `/{resource-name}/{id}` | `/articles/1` | +* `application-local.yml`에 둜컬 DB 접속 정보λ₯Ό μž…λ ₯ν•΄μ•Ό ν•©λ‹ˆλ‹€. +* 운영 DB에 직접 μ ‘κ·Όν•˜μ—¬ κ°œλ°œν•˜μ§€ μ•Šλ„λ‘ μ£Όμ˜κ°€ ν•„μš”ν•©λ‹ˆλ‹€ +* `Jasypt`둜 μ•”ν˜Έν™”λœ DB 계정 정보가 μžˆλŠ” 경우, 둜컬 λΉ„λ°€λ²ˆν˜Έ λ³΅ν˜Έν™”λ₯Ό μœ„ν•œ `encryptor.password`κ°€ λ°˜λ“œμ‹œ ν•„μš”ν•©λ‹ˆλ‹€. -## LOG 생성 μ˜΅μ…˜ +--- +## πŸ” Jasypt μ•”ν˜Έν™” -### logging.file.path +* DB 컀λ„₯μ…˜ μ •λ³΄λŠ” Jasypt둜 μ•”ν˜Έν™”λ˜μ–΄ μ‚¬μš©λ©λ‹ˆλ‹€. +* `admin`, `front` λͺ¨λ“ˆ 각각에 `JasyptConfig.java` 섀정이 ν¬ν•¨λ˜μ–΄ μžˆμŠ΅λ‹ˆλ‹€. -```shell --Dlogging.file.path=~/logs # κΈ°λ³Έκ°’ ${user.home}/logs +```yaml +jasypt: + encryptor: + password: # 별도 관리 + algorithm: # 별도 관리 ``` -둜그 파일 생성 경둜λ₯Ό μ§€μ •ν•œλ‹€. μ§€μ •λœ κ²½λ‘œμ— μ•„λž˜μ™€ 같은 둜그 파일이 μƒμ„±λœλ‹€. +μ˜ˆμ‹œ: -```shell -admin-app.log # μ–΄λ“œλ―Ό 전체 둜그 -admin-app-ERROR.log # μ–΄λ“œλ―Ό 둜그 쀑 ERROR λΆ€λΆ„ 필터링 -front-app.log # ν”„λ‘ νŠΈ 전체 둜그 -front-app-ERROR.log # ν”„λ‘ νŠΈ 둜그 쀑 ERROR λΆ€λΆ„ 필터링 +```yaml +spring: + datasource: + kri: + jdbc-url: ENC(...) + username: ENC(...) + password: ENC(...) + mms: + jdbc-url: ENC(...) + username: ENC(...) + password: ENC(...) ``` -## File ꡬ성 μ˜΅μ…˜ +--- -### 파일 μ—…λ‘œλ“œ +## πŸ—ƒοΈ DB ꡬ성 -```shell --Dpath.upload.public=~/upload/public # 파일 μ—…λ‘œλ“œ 경둜 --Dpath.upload.tmpdir=~/upload/tmpdir # tmp 디렉토리 경둜 +| λͺ¨λ“ˆ | μ—°κ²° DB | +| ------- | ----------------------- | +| `admin` | kri DB, mms DB (문자 λ°œμ†‘μš©) | +| `front` | kri DB | + +--- + +## πŸ”„ 닀쀑 DB μ„€μ • (admin) + +* `admin` λͺ¨λ“ˆμ—λŠ” `MMSDBConfig.java`λ₯Ό ν†΅ν•œ **mms μ „μš© DataSource** 섀정이 μžˆμŠ΅λ‹ˆλ‹€. +* MyBatis λ§€νΌλŠ” 별도 μœ„μΉ˜λ‘œ κ΅¬λΆ„λ©λ‹ˆλ‹€. + +```yaml +mybatis: + mapper-locations: + kri: classpath*:mappers/**/*Mapper.xml + mms: classpath*:mappers/mms/*Mapper.xml + configuration: + log-impl: org.apache.ibatis.logging.stdout.StdOutImpl ``` -파일 μ—…λ‘œλ“œ κ²½λ‘œκ°€ μ§€μ •λ˜λ©΄ μ‚¬μš©μžκ°€ μ—…λ‘œλ“œν•œ νŒŒμΌμ€ 이 경둜λ₯Ό κΈ°μ€€μœΌλ‘œ `주제`/`년월일` 폴더 μ•„λž˜μ— μ €μž₯λ©λ‹ˆλ‹€. -tmpdir 은 μ„œλΈ”λ¦Ώ μ»¨ν…Œμ΄λ„ˆκ°€ multipart 파일 μ—…λ‘œλ“œ μ‹œ λŒ€μš©λŸ‰ 처리λ₯Ό μœ„ν•΄ μž„μ‹œνŒŒμΌμ„ μ €μž₯ν•˜λŠ” κ³΅κ°„μž…λ‹ˆλ‹€. +--- -파일 μ‹œμŠ€ν…œ 외에 AWS S3 λ‘œλ„ μ—…λ‘œλ“œν•΄μ•Ό ν•œλ‹€λ©΄, μ•„λž˜ AWS CLI λ₯Ό μ΄μš©ν•˜κΈ° μœ„ν•œ 정보λ₯Ό μ œκ³΅ν•΄μ£Όμ–΄μ•Ό ν•©λ‹ˆλ‹€. - -```shell --Dapp.aws.s3.accessKey=AKIAZF27HETWNITZBZOF # AMI μ—μ„œ λ°œκΈ‰ν•œ μ‚¬μš©μž μ—‘μ„ΈμŠ€ ν‚€ --Dapp.aws.s3.secretKey=IhnTG0X7Wav8ak3cbYR1l8UAjL+gbnXdWJRM11cx # AMI μ—μ„œ λ°œκΈ‰ν•œ μ‚¬μš©μž μ‹œν¬λ¦Ώ ν‚€ --Dapp.aws.s3.bucketName=etribe # S3 버킷 이름 --Dapp.aws.s3.bucketFolder=/recycle/upload # S3 버킷 디렉토리 --Dapp.aws.s3.domain=dixjkmptx5pkm.cloudfront.net # S3 ν˜Ήμ€ cloudfront 도메인 -``` - -πŸ”‘ μœ„ accessKey μ •λ³΄λŠ” μ œκ°€ λ§Œλ“  μž„μ‹œ 정보이며, recycle 데λͺ¨μš©μœΌλ‘œλ§Œ μ‚¬μš©λ˜λ‹ˆ μ°Έκ³ ν•΄μ£Όμ„Έμš”. - -πŸ’‘ recycle 은 파일 μ‹œμŠ€ν…œ μ—…λ‘œλ“œμ™€ S3 μ—…λ‘œλ“œλ₯Ό μ‚¬μš© λͺ©μ μ— 맞게 선택할 수 μžˆλŠ” μœ μ—°μ„±μ„ μ œκ³΅ν•©λ‹ˆλ‹€. -`FileUploadType`은 파일 μ—…λ‘œλ“œκ°€ ν•„μš”ν•œ 주제 도메인듀이 μ •μ˜λœ enum κ°μ²΄μž…λ‹ˆλ‹€. μ—¬κΈ° 기술된 `FileStorageType` 속성에 따라 파일 μ—…λ‘œλ“œ κ²½λ‘œκ°€ κ²°μ •λ©λ‹ˆλ‹€. - -### 파일 μ°Έμ‘° - -μ—…λ‘œλ“œλœ νŒŒμΌμ€ 참쑰될 수 μžˆμ–΄μ•Ό ν•©λ‹ˆλ‹€. `fileUrlPortIn`λŠ” 파일이 파일 μ‹œμŠ€ν…œμ— μžˆλ“  S3 에 μžˆλ“  μ •ν™•ν•œ μ°Έμ‘° URL 을 μ „λ‹¬ν•΄μ£ΌλŠ” μΈν„°νŽ˜μ΄μŠ€μž…λ‹ˆλ‹€. +## 🧩 MyBatis 닀쀑 DB μ„€μ • μ˜ˆμ‹œ (`MMSDBConfig.java`) ```java -// μ°Έμ‘° URL 전달 - inline 방식 -fileUrlPortIn.getInline( - uploadFile.getType().getFileStorageType(), - uploadFile.getPath(), - uploadFile.getName()); - -// μ°Έμ‘° URL 전달 - attachment 방식 - fileUrlPortIn.getAttachment( - uploadFile.getType().getFileStorageType(), - uploadFile.getId()); +@MapperScan( + basePackages = "app.module.mms.**.persistence", + sqlSessionFactoryRef = "mmsSqlSessionFactory") ``` -`inline` κ³Ό `attachment` λŠ” 응닡 ν—€λ”μ˜ content-disposition 속성 값을 μ˜λ―Έν•©λ‹ˆλ‹€. -μ—…λ‘œλ“œλœ νŒŒμΌμ€ μ‚¬μš©μžμ—κ²Œ 전달할 λ•Œ `inline` κ³Ό `attachment` 두 방식 쀑 μš”κ±΄μ— 맞게 μ‚¬μš©ν•˜λ©΄ λ©λ‹ˆλ‹€. +## πŸ“€ 파일 μ—…λ‘œλ“œ -## 곡톡 ν•„λ“œ(Audit) μžλ™ μ£Όμž… 방법 (AOP기반) -createdAt, createdBy, updatedAt, updatedBy, deletedAt, deletedBy, isDeleted 와 같은 곡톡 이λ ₯ ν•„λ“œλŠ” -맀번 μˆ˜λ™μœΌλ‘œ μ„€μ •ν•˜μ§€ μ•Šμ•„λ„ λ˜λ„λ‘, AOPλ₯Ό ν™œμš©ν•΄ μžλ™μœΌλ‘œ μ£Όμž…λ˜λ„λ‘ κ΅¬μ„±ν–ˆμŠ΅λ‹ˆλ‹€. - -### 1. κΈ°λ³Έ ꡬ쑰 -create, update, delete μ‹œ Command 객체에 AuditCommandλ₯Ό μƒμ†ν•©λ‹ˆλ‹€. -#### AuditCommand μ‚¬μš© μ˜ˆμ‹œ -``` java -// ν•„μˆ˜: AuditCommand 상속 -public class UpdateCmd extends AuditCommand { - private Long seq; - ... -} -``` -AuditCommandλŠ” μ•„λž˜ λ©”μ„œλ“œλ₯Ό μ œκ³΅ν•˜λ©°, 각각 생성/μˆ˜μ •/μ‚­μ œ μž‘μ—…μ— ν•„μš”ν•œ ν•„λ“œλ₯Ό μžλ™μœΌλ‘œ μ„€μ •ν•©λ‹ˆλ‹€. -``` java -public class AuditCommand { - private LocalDateTime createdAt; - private String createdBy; - private LocalDateTime updatedAt; - private String updatedBy; - private LocalDateTime deletedAt; - private String deletedBy; - - public void create() { ... } - public void update() { ... } - public void delete() { ... } -} +```bash +-Dpath.upload.public=/home/etribe/data/upload ``` -### 2. AOP 기반 μ–΄λ…Έν…Œμ΄μ…˜ μžλ™ μ£Όμž… -service λ˜λŠ” dao 내에 -@CreateCommand, @UpdateCommand, @DeleteCommand μ–΄λ…Έν…Œμ΄μ…˜μ„ 톡해 -AOPκ°€ μžλ™μœΌλ‘œ ν•΄λ‹Ή λ©”μ„œλ“œμ˜ νŒŒλΌλ―Έν„°(AuditCommand 상속 객체)에 곡톡 ν•„λ“œλ₯Ό μ£Όμž…ν•©λ‹ˆλ‹€. +파일 μ €μž₯ κ΅¬μ‘°λŠ” `주제/년월일/파일λͺ…`이며, `FileUploadType` Enum에 따라 κ²½λ‘œκ°€ κ²°μ •λ©λ‹ˆλ‹€. -| μ–΄λ…Έν…Œμ΄μ…˜ | μžλ™ μ„€μ •λ˜λŠ” ν•„λ“œ | -| ---------------- | -------------------------------------------------- | -| `@CreateCommand` | `createdAt`, `createdBy`, `updatedAt`, `updatedBy` | -| `@UpdateCommand` | `updatedAt`, `updatedBy` | -| `@DeleteCommand` | `updatedAt`, `updatedBy`, `deletedAt`, `deletedBy` | +```java +fileUrlPortIn.getInline(type, path, name); +fileUrlPortIn.getAttachment(type, id); +``` -#### μ–΄λ…Έν…Œμ΄μ…˜ μ‚¬μš© μ˜ˆμ‹œ +--- + +## 🧾 Audit 곡톡 ν•„λ“œ μžλ™ μ£Όμž… + +* AOP 기반 μžλ™ μ£Όμž… λ°©μ‹μœΌλ‘œ 생성/μˆ˜μ •/μ‚­μ œ μ‹œ ν•„λ“œ λ°˜λ³΅μ„ μ΅œμ†Œν™”ν•©λ‹ˆλ‹€. +* 곡톡 ν•„λ“œ: `createdAt`, `createdBy`, `updatedAt`, `updatedBy`, `deletedAt`, `deletedBy`, `isDeleted` + + +| μ–΄λ…Έν…Œμ΄μ…˜ | μ£Όμž… ν•„λ“œ | +| ---------------- | ------------------------------------------ | +| `@CreateCommand` | createdAt, createdBy, updatedAt, updatedBy | +| `@UpdateCommand` | updatedAt, updatedBy | +| `@DeleteCommand` | deletedAt, deletedBy | + +### βœ… κΈ°λ³Έ μ‚¬μš©λ²• +λͺ¨λ“  CommandλŠ” AuditCommandλ₯Ό μƒμ†ν•˜κ³ , Service/DAO λ©”μ„œλ“œμ— μ–΄λ…Έν…Œμ΄μ…˜λ§Œ 뢙이면 μžλ™μœΌλ‘œ ν•„λ“œμ— 값이 μ£Όμž…λ©λ‹ˆλ‹€. ```java @UpdateCommand -public void operate(UpdateCmd cmd) { - mapper.update(cmd); +public void update(UpdateCmd cmd) { + mapper.update(cmd); // updatedAt, updatedBy μžλ™ μ£Όμž… } ``` -### 3. AOP μ™Έ μˆ˜λ™ 적용이 ν•„μš”ν•œ 경우: AuditUtil μ‚¬μš© -AOP 외에도, ν•˜λ‚˜μ˜ DAO λ©”μ„œλ“œ λ‚΄μ—μ„œ μ—¬λŸ¬ Insert/Delete μ²˜λ¦¬κ°€ ν•„μš”ν•œ κ²½μš°μ—λŠ” μ•„λž˜μ²˜λŸΌ 직접 AuditUtil을 μ‚¬μš©ν•  수 μžˆμŠ΅λ‹ˆλ‹€. -#### AuditUtil μ‚¬μš© μ˜ˆμ‹œ +```java +public class UpdateCmd extends AuditCommand { + private Long seq; +} +``` + +### βœ… 볡합적인 CRUD 처리 μ‹œ +ν•˜λ‚˜μ˜ 둜직 μ•ˆμ—μ„œ insert, update, delete λ“± μ—¬λŸ¬ DB μž‘μ—…μ΄ ν•¨κ»˜ μ²˜λ¦¬λ˜λŠ” 경우, `AuditUtil`의 μœ ν‹Έ λ©”μ„œλ“œλ₯Ό μ‚¬μš©ν•©λ‹ˆλ‹€. ```java // κ΄€λ¦¬μž 등둝 mapper.insertAdmin(AuditUtil.create(cmd)); -// κ΄€λ¦¬μžμ˜ μ—­ν•  λ§€ν•‘ +// κ΄€λ¦¬μž μ—­ν•  λ§€ν•‘ (닀건) mapper.insertAdminHasRoles( AuditUtil.create(new SaveAdminHasRoleParam(cmd.getSeq(), cmd.getRoleIds())) ); ``` +--- -### 4. XMLμ—μ„œ 곡톡 ν•„λ“œ include둜 μž¬μ‚¬μš© -SQL μž‘μ„± μ‹œ κ³΅ν†΅ν•„λ“œμ˜ 반볡 μž‘μ„±μ„ ν”Όν•˜κΈ° μœ„ν•΄ `` νƒœκ·Έλ‘œ λΆ„λ¦¬ν•˜μ—¬ `` λ°©μ‹μœΌλ‘œ μž¬μ‚¬μš©ν•©λ‹ˆλ‹€. -μžμ„Έν•œ μ •μ˜λŠ” `CommonFieldsMapper.xml` νŒŒμΌμ—μ„œ 확인할 수 μžˆμŠ΅λ‹ˆλ‹€. +## πŸ” XML 곡톡 ν•„λ“œ include -| SQL ID | μ„€λͺ… | μ‚¬μš© μ˜ˆμ‹œ | -| ---------------------------- | -------------------------------------- | -------------------------------------------------------------- | -| `CreateUpdateBaseColumns` | `INSERT` μ‹œ 곡톡 컬럼 μ •μ˜ | `` | -| `CreateUpdateBaseValues` | `INSERT` μ‹œ 곡톡 컬럼의 κ°’ μ •μ˜ | `` | -| `CreateUpdateListBaseValues` | `닀건 INSERT` μ‹œ 곡톡 κ°’ μ •μ˜ (e.g. `foreach`) | `` | -| `UpdateBaseSet` | `UPDATE` μ‹œ 곡톡 `SET` ꡬ문 | `` | -| `DeleteBaseSet` | `μ‚­μ œ 처리용 UPDATE` μ‹œ 곡톡 `SET` ꡬ문 | `` | - -#### include μ‚¬μš© μ˜ˆμ‹œ ```xml -UPDATE household -SET - owner_name = #{ownerName}, - owner_age = #{ownerAge}, - tel = #{tel}, - phone = #{phone}, - region = #{region}, - city = #{city}, - address_detail = #{addressDetail}, - -WHERE seq = ${seq} + ``` +곡톡 SQL은 `CommonFieldsMapper.xml` 에 μ •μ˜λ˜μ–΄ μžˆμŠ΅λ‹ˆλ‹€. -## PACKAGING +--- -배포방식 섀정을 μœ„ν•΄ 두가지 maven ν”„λ‘œνŒŒμΌμ„ μ œκ³΅ν•œλ‹€. +## πŸ“¦ νŒ¨ν‚€μ§• (WAR) -* `jar` (default) -* `war` Jeus, WebLogic, Tomcat λ“± 별도 μ™Έμž₯ μ»¨ν…Œμ΄λ„ˆ μ΄μš©μ‹œ μ‚¬μš© - -maven λΉŒλ“œ μ‹œ ν”„λ‘œνŒŒμΌμ„ μ§€μ •ν•˜μ§€ μ•ŠμœΌλ©΄ κΈ°λ³Έ `jar` ν”„λ‘œνŒŒμΌλ‘œ λ™μž‘ν•˜κ³ , `war` 의 경우 λͺ…μ‹œμ μΈ 지정이 ν•„μš”ν•˜λ‹€. - -μ•„λž˜λŠ” admin λΉŒλ“œμ‹œ `war` ν”„λ‘œνŒŒμΌμ„ μ§€μ •ν•œ μ˜ˆμ‹œμ΄λ‹€. - -```shell -$ mvn --projects admin --also-make clean package -DskipTests -P war - -# λΉŒλ“œ ν›„, admin/target 디렉토리에 war κ°€ μƒμ„±λœκ±Έ 확인할 수 μžˆλ‹€. -$ ll admin/target --rw-r--r-- 1 user 197121 94905770 4μ›” 22 09:59 admin-0.0.1-SNAPSHOT.war +```bash +$ mvn clean package -P war ``` -## 개발 μ„œλ²„ ν™˜κ²½ +--- -### database - postgresql 14.17 +## πŸ”Œ API 호좜 방식 -``` -URL: jdbc:postgresql://15.165.180.203:5432/korea_research -USERNAME: ko_research -PASSWORD: koresearch1@#4 +### BO (κ΄€λ¦¬μž) + +| κΈ°λŠ₯ | 방식 | URI μ˜ˆμ‹œ | +| ------- | ---- | -------------------------------------- | +| λͺ©λ‘/등둝 λ“± | Ajax | `/api/household/daily/list`, `/save` λ“± | +| 상세 쑰회 | SSR | `/household/{id}` | + +### FO (μ‚¬μš©μž) + +| κΈ°λŠ₯ | 방식 | URI μ˜ˆμ‹œ | +| -------- | ---- | -------------------------------------------------------- | +| 등둝/μˆ˜μ •/μ‚­μ œ | Ajax | `/api/record/income/{searchMonth}/{groupNo}/form/{id}` λ“± | +| λͺ©λ‘/상세 쑰회 | SSR | `/record/income/{searchMonth}/{groupNo}`, `/form/{id}` λ“± | + +--- + +## πŸ“‹ 둜그 μ„€μ • + +```bash +-Dlogging.file.path=~/logs ``` -### πŸš€ ADMIN DEPLOY +| 파일 이름 | μ„€λͺ… | +| --------------------- | ------------ | +| `admin-app.log` | κ΄€λ¦¬μž 전체 둜그 | +| `admin-app-ERROR.log` | κ΄€λ¦¬μž μ—λŸ¬ μ „μš© 둜그 | +| `front-app.log` | ν”„λ‘ νŠΈ 전체 둜그 | +| `front-app-ERROR.log` | ν”„λ‘ νŠΈ μ—λŸ¬ μ „μš© 둜그 | -#### `deploy_dev_admin` 브렌치둜 merge! pipeline μ‹€ν–‰ ν›„ μ•„λž˜ URL μ—μ„œ 확인가λŠ₯. -* https://ko-research-admin.etribe.co.kr +--- -### πŸš€ FRONT DEPLOY +## ⏱️ 배치 μŠ€μΌ€μ€„λŸ¬ + +`AutoSchedulesController.java`에 μ •μ˜λ˜μ–΄ 있으며, 총 3개의 λ°°μΉ˜κ°€ μ‘΄μž¬ν•©λ‹ˆλ‹€. + +| 배치λͺ… | μ‹€ν–‰ μ£ΌκΈ° | μ„€λͺ… | +| ----------- | ------------ | -------------------------- | +| 월별 μž…λ ₯ μƒνƒœ 등둝 | λ§€μ›” 1일 0μ‹œ 0초 | 월별 μž…λ ₯ μƒνƒœλ₯Ό μ΄ˆκΈ°ν™” 등둝함 | +| 문자 μžλ™ λ°œμ†‘ | 맀일 17μ‹œ 0λΆ„ | mms DBλ‘œλΆ€ν„° μˆ˜μ‹  λŒ€μƒ μΆ”μΆœ ν›„ 문자 λ°œμ†‘ | +| μ›”μ΄ˆ μ΄μ›”κΈˆ 등둝 | λ§€μ›” 16일 0μ‹œ 0초 | 이전 달 데이터λ₯Ό κΈ°μ€€μœΌλ‘œ μ΄μ›”κΈˆ 등둝 | + +--- + +## πŸ‘€μš΄μ˜μ„œλ²„ ν…ŒμŠ€νŠΈ 계정 + 계정 ID | λΉ„λ°€λ²ˆν˜Έ | κΆŒν•œ | +| ------------ | ------- | ------- | +| `koadmin` | `0701!` | κ΄€λ¦¬μž κΆŒν•œ | +| `kolocal` | `0701@` | 지방싀사 κΆŒν•œ | +| `kosearcher` | `0701#` | 쑰사원 κΆŒν•œ | + +--- + +## 🧾 μš΄μ˜μ„œλ²„ μž„κ°€ 계정 λͺ©λ‘ + +| μž„κ°€λ²ˆν˜Έ | λΉ„λ°€λ²ˆν˜Έ | +|---------| ------ | +| `22221` | `1111` | +| `22222` | `1111` | + +--- + +## ❗ 싀사지역 μ„€μ • μ£Όμ˜μ‚¬ν•­ + +ν…ŒμŠ€νŠΈ 계정듀은 **싀사지역이 `ν…ŒμŠ€νŠΈ`둜 μ§€μ •**λ˜μ–΄ μžˆμŠ΅λ‹ˆλ‹€. + +> 이둜 인해 ν•΄λ‹Ή κ³„μ •μœΌλ‘œ μˆ˜μ§‘λœ λ°μ΄ν„°λŠ” **톡계에 λ°˜μ˜λ˜μ§€ μ•ŠμŠ΅λ‹ˆλ‹€.** + +**주의:**⚠️ 톡계에 ν¬ν•¨λ˜λ„λ‘ ν•˜λ €λ©΄ **μ‹€μ œ 싀사지역**으둜 맀핑이 ν•„μš”ν•©λ‹ˆλ‹€. + +--- -#### `deploy_dev_front` 브렌치둜 merge! pipeline μ‹€ν–‰ ν›„ μ•„λž˜ URL μ—μ„œ 확인가λŠ₯. -* https://ko-research-front.etribe.co.kr \ No newline at end of file