YAPP-Github/onboard-server

deprecated > https://github.com/onboard-github/onbaord-be

Ktlint

./gradlew addKtlintCheckGitPreCommitHook

Swagger

./gradlew copySwaggerUI

위 Task를 실행하면 크게 3가지 작업을 진행한다.

1. Test 실행
2. Controller 테스트 실행된 결과 snippet 을 저장
3. snippet을 이용하여 Swagger 생성

Swagger 파일은 src/main/resources/static/swagger 아래에 저장된다.
static import가 불편하고 RestDoc의 Kotlin DSL을 사용하면 정상적으로 작동하지 않아 자체적으로(토스 블로그를 보면서) DSL을 만들었다.

References

RestDoc 세팅
Swagger 파일 생성
토스 블로그 - Kotlin DSL을 이용하기

Module

Class Naming Convention

모듈	접미어	설명
Adapter In	Controller	Restful 통신을 담당하는 객체
	Request	Http 요청 요청 처리 DTO
	Response	Http 응답 처리할 DTO
Adapter Out	Entity	JPA Entity 클래스
	Repository	JpaRepository를 상속한 인터페이스
	QueryRepositoryImpl	QueryRepository 구현체
	CommandRepositoryImpl	CommandRepository 구현체
	Client	QueryRepository, CommandRepository를 모두 구하는 클래스
Pot In	Service	비지니스 로직을 제공하는 인터페이스
	Dto	AdapterIn -> Core 전달하는 DTO
Pot Out	QueryRepository	읽기 전용 (CQRS) 인터페이스
	CommandRepository	쓰기 전용 (CQRS) 인터페이스
Core	ServiceImpl	Service 인터페이스 구현체
Domain	InDto	AdapterIn -> Core -> AdapterOut 방향으로 흘러가는 DTO
	OutDto	AdapterOut -> Core -> AdapterIn 방향으로 흘러가는 DTO

헥사고날 아키텍쳐

1. domain: 도메인 모듈

- 비지니스 로직에서 해결하고자 하는 도메인 객체들
- 위 도식도에서 Entity에 해당한다.
- 모든 모듈에서 사용하는 DTO 객체의 모음

	adapter-in	adapter-out	core	port-in	port-out	domain
사용가능한 모듈 여부	-	-	-	-	-	-

2. core: 코어 모듈

- 비지니스 로직을 관리하는 모듈
- 위 도식도에서 Use Case에 해당한다.
- adapter-out 의 구현체가 필요하여 의존성을 가지나 port-out 모듈의 추상화 객체를 이용하도록 한다.
- 웹 통신 / DB 관련 객체는 가급적 사용을 피한다.

	adapter-in	adapter-out	core	port-in	port-out	domain
사용가능한 모듈 여부	-	O	-	O	O	O

3. port-in: Input Port 모듈

- In Port 추상화 객체가 모여있는 모듈
- 의존성 순환 때문에 추상화 객체만 분리 해둔다. 
- core 모듈에서 구현체를 작성하도록 한다.

	adapter-in	adapter-out	core	port-in	port-out	domain
사용가능한 모듈 여부	-	-	-	-	-	O

4. port-out: Output Port 모듈

- Output Port 추상화 객체가 모여있는 모듈
- 의존성 순환 때문에 추상화 객체만 분리 해둔다. 
- adapter-out 모듈에서 구현체를 작성하도록 한다.

	adapter-in	adapter-out	core	port-in	port-out	domain
사용가능한 모듈 여부	-	-	-	-	-	O

5. adapter-in : Input 어댑터 모듈

- 서비스에 들어오는 요청을 처리하는 구현체
- Web Controller / Kafka Consumer 등이 해당 된다.

	adapter-in	adapter-out	core	port-in	port-out	domain
사용가능한 모듈 여부	-	-	O	O	-	O

6. adapter-out : Output 어댑터 모듈

- 서비스의 결과 데이터를 처리하는 구현체
- JPA / Kafka Producer 등이 해당 된다.

	adapter-in	adapter-out	core	port-in	port-out	domain
사용가능한 모듈 여부	-	-	O	-	O	O