update README

This commit is contained in:
youngmok.kim
2025-05-28 16:04:48 +09:00
parent 5cea644bbf
commit d36689e02e

View File

@@ -194,58 +194,6 @@ fileUrlPortIn.getInline(
`inline` 과 `attachment` 는 응답 헤더의 content-disposition 속성 값을 의미합니다.
업로드된 파일은 사용자에게 전달할 때 `inline` 과 `attachment` 두 방식 중 요건에 맞게 사용하면 됩니다.
## 코드 작성 규칙 (coding conventions)
기본 패키지 구조는 [포트 앤 어댑터 패턴](https://coco-log.tistory.com/205)에 기반해 구성됩니다.
![img](./docs/img/port-adapter.jpg)
getArticles 라는 주제(subject) 패키지 하부를 구성하는 ports 와 adapters 패키지를 주의깊게 봐주세요.
```
# 주제(subject)
getArticles
|-- adapters
| |-- persistence
| | |-- GetArticlesDao.java # 포트아웃 구현체
| `-- web
| |-- GetArticlesController.java
| `-- model
| `-- GetArticlesReqVO.java
`-- ports
|-- GetArticlesPortIn.java # 포트인 인터페이스
|-- GetArticlesPortOut.java # 포트아웃 인터페이스
`-- application
|-- GetArticlesService.java # 포트인 구현체
`-- domain
|-- GetArticles.java
`-- GetArticlesCmd.java
```
* ports 는 비지니스 로직을 담는 application 레이어가 위치한 곳입니다. application 은 `포트인` 인터페이스를 통해 호출되며 `포트아웃` 인터페이스를 호출해 결과를 얻습니다.
* application 은 누가 `포트인`을 호출하는지 신경쓰지 않습니다. **자신이 호출하는 `포트아웃`의 구현체에 대해서도 모릅니다.** 이를 통해 application 은 다른 계층(web,
persistence)과 관계없는 독립적인 레이어가 됩니다.
* adapters/web 은 사용자 요청을 처리하는 controller 레이어가 위치한 곳입니다. `포트인` 인터페이스를 호출하는 클라이언트로 해당 규격을 맞춘 어뎁터(adapter) 이며, *
*application 에 종속적입니다.**
* adapters/persistence 는 영속화(persistence) 레이어가 위치한 곳입니다. mybatis, jpa 등 다양한 ORM 기술을 이용하여 `포트아웃` 인터페이스를 구현합니다. `포트아웃` 규격을
맞춘 어뎁터이며, **application 에 종속적입니다.**
### 자동화 스캐폴딩 (scaffolding) 도구 소개
위 패키지 구조와 인터페이스 및 구현체를 일일이 타이핑하며 생성할 필요는 없습니다. [BASC](https://code.etribe.co.kr/core-architect/basc) 스캐폴팅 도구가 자동생성
해줍니다.
### Best Practices
코드 작성 규칙에 맞게 구현된 가장 좋은 예는 관리자의 **예제 게시판**입니다. 새로운 버전에 맞춰 모든 코드들이 재작성되었고 아래 고민들에 대한 해법이 녹아있습니다.
1. 패키지 구조 및 클래스 명칭을 어떻게 잡아야 할까?
2. 브라우저 history 를 잘 유지하면서 back 버튼 이슈를 발생시키지 않는 구현방식은 무엇일까?
3. form submit 과 ajax 호출. 어떤 방식이 더 유용할까?
4. 사용자 입력값을 검증하고 문제점을 표현하는 가장 좋은 방법은?
5. 어떻게 restfull 한 서비스를 구현할 수 있을까? (GET/POST/PUT/PATCH/DELETE)
6. 새로운 파일 업로드 방식.
## PACKAGING
배포방식 설정을 위해 두가지 maven 프로파일을 제공한다.
@@ -265,3 +213,22 @@ $ ll admin/target
-rw-r--r-- 1 user 197121 94905770 4월 22 09:59 admin-0.0.1-SNAPSHOT.war
```
## 개발 서버 환경
### database - postgresql 14.17
```
URL: jdbc:postgresql://15.165.180.203:5432/korea_research
USERNAME: ko_research
PASSWORD: koresearch1@#4
```
### 🚀 ADMIN DEPLOY
#### `deploy_dev_admin` 브렌치로 merge! pipeline 실행 후 아래 URL 에서 확인가능.
* http://ko-research-admin.etribe.co.kr
### 🚀 FRONT DEPLOY
#### `deploy_dev_front` 브렌치로 merge! pipeline 실행 후 아래 URL 에서 확인가능.
* http://ko-research-front.etribe.co.kr