0. MSA 기반 물류센터 웹 사이트 만들기 - 업체 관리 서비스 개발 계획 스케치

 0.프로젝트 개요

이번 프로젝트에서는 MSA(Microservices Architecture)기반의  업체 관리 서비스를 개발하기로 했다.

업체(Company)는 물류 및 주문 흐름에서 핵심 역할을 하며, 허브(Hub) 및 주문(Order)과 긴밀하게 연결되어 있다.

이를 기반으로 store-service(업체 관리 마이크로서비스)를 구축하며, API 설계, DB 모델링, 인증/인가 시스템, 서비스 간 통신, 분산 트레이싱 등을 구현할 예정이다. 

---

 1. 업체 도메인 및 역할

   1.1 업체 도메인의 핵심 기능
- 업체(Company)는 주문(Order) 및 허브(Hub)와 연관되어 있음
- 업체는 상품(Product)을 보유하고 있으며, 허브와 상호작용하면서 배송 경로 결정
- 권한(Role) 시스템 필요 → 업체 담당자는 자신의 업체만 수정 가능

  1.2 주요 기능 정리
1. 업체 등록 (회사 정보 저장)
2. 업체 정보 조회 (단일 조회 & 리스트 조회)
3. 업체 정보 수정 (회사 정보 업데이트)
4. 업체 삭제 (논리적 삭제 적용)
5. 업체별 메뉴 관리 (업체에 속한 메뉴 리스트 조회)

---

 2. 프로젝트 요구사항 및 구현 방향

  2.1 MSA 환경 구축
MSA(Microservices Architecture) 환경을 고려하여, API Gateway, Eureka, Config Server, Docker 기반의 실행 환경을 포함한다.

도입 기술:
- API Gateway: 클라이언트와 서비스 간 요청을 관리
- Eureka: 서비스 등록 및 발견
- Config Server: 환경 설정 중앙 관리
-  Docker: 컨테이너 기반 서비스 실행
- Spring Security + JWT: 인증 및 인가 처리

---

2.2 업체 권한 관리

요구사항
- 마스터 관리자 : 모든 업체 관리 가능
- 허브 관리자 : 담당 허브의 업체만 관리 가능
- 업체 담당자 : 자신의 업체만 수정 가능, 다른 업체는 조회만 가능

구현 방법

-Spring Security + JWT 기반 인가 로직 추가
- API Gateway에서 인증 및 권한 검증 수행
- @PreAuthorize 어노테이션을 활용한 접근 제한

@PreAuthorize("hasRole('MASTER') or (hasRole('HUB_MANAGER') and #store.hubId == authentication.principal.hubId) or (hasRole('STORE_MANAGER') and #store.ownerId == authentication.principal.userId)")
public ResponseEntity<StoreDTO> updateStore(@PathVariable Long storeId, @RequestBody StoreUpdateRequest request) {
    return storeService.updateStore(storeId, request);
}

 

 

---

 2.3 업체 검색 및 정렬 기능 추가

 요구사항
- 검색 조건: 업체명, 업체 타입, 업체 주소, 허브 ID
- 정렬 기준: 생성일, 수정일
- QueryDSL을 활용한 동적 검색 및 정렬 기능 적용

public Page<Store> searchStores(StoreSearchCriteria criteria, Pageable pageable) {
    BooleanBuilder builder = new BooleanBuilder();
    
    if (StringUtils.hasText(criteria.getName())) {
        builder.and(store.name.contains(criteria.getName()));
    }
    if (criteria.getType() != null) {
        builder.and(store.type.eq(criteria.getType()));
    }
    if (criteria.getHubId() != null) {
        builder.and(store.hubId.eq(criteria.getHubId()));
    }
    
    return storeRepository.findAll(builder, pageable);
}

---

2.4 MSA 간 데이터 동기화 및 재시도 로직

 요구사항
- 업체 생성/수정 시 허브 ID 검증 필요
- 서비스 간 API 호출 실패 시 Resilience4J 기반 재시도 로직 적용

@Retry(name = "hubService", fallbackMethod = "fallbackCheckHub")
public boolean checkHubExists(Long hubId) {
    return hubClient.existsById(hubId);
}

private boolean fallbackCheckHub(Long hubId, Throwable t) {
    log.error("허브 검증 실패. 기본값(false) 반환", t);
    return false;
}

---

2.5 논리적 삭제 처리 보완

요구사항
-  deleted_at, deleted_by 필드를 활용한 논리 삭제
- 조회 시 삭제된 데이터는 기본적으로 검색되지 않도록 처리

public Page<Store> findAllActiveStores(Pageable pageable) {
    return storeRepository.findAll(store.deletedAt.isNull(), pageable);
}

---

2.6 Zipkin을 활용한 분산 트레이싱 추가

 요구사항
-  Zipkin을 적용하여 서비스 호출 추적 가능하도록 설정

 구현 방법

```yaml
spring:
  zipkin:
    base-url: http://zipkin-server:9411
  sleuth:
    sampler:
      probability: 1.0
```

---

3. MSA 환경에서 구현해야 할 것

 DDD 기반 Aggregate 설계
  - Aggregate Root: Store (업체)
  - Store (업체 엔티티)
  - Menu (N:1 관계, 업체에 속한 메뉴)
  - StoreOwner (1:1 관계, 업체 운영자)
  - StoreAddress (1:1 관계, 업체 주소)

API 설계 및 MSA 통신
- 업체 CRUD API 개발
- 업체-메뉴 연동 API 개발
- 업체-허브 연동 API 개발
- Spring Security + JWT 인증 적용
- API Gateway & Eureka 설정
- PostgreSQL 기반 데이터베이스 모델링 적용

---

4. Docker를 활용한 배포 환경 구축

PostgreSQL 기반 MSA 실행

1. docker-compose.yml 설정

```yaml
version: '3.8'
services:
  postgres:
    image: postgres:14
    container_name: postgres-container
    environment:
      POSTGRES_DB: company_db
      POSTGRES_USER: user
      POSTGRES_PASSWORD: password
    ports:
      - "5432:5432"
```

2. Spring Boot PostgreSQL 연결 설정

```properties
spring.datasource.url=jdbc:postgresql://postgres:5432/company_db
spring.datasource.username=user
spring.datasource.password=password
spring.jpa.database=postgresql
spring.jpa.hibernate.ddl-auto=update
```

---

이번 프로젝트에서는 MSA 환경에서 업체 관리 서비스를 구축하며, API 설계, 인증/인가, 데이터 동기화, 분산 트레이싱, Docker 기반 배포까지 적용할 계획이다.  이를 통해 MSA 기반의 서비스 개발 경험을 쌓고, 유지보수 및 확장성을 고려한 구조를 설계할 수 있는 역량을 기를 예정이다.