Order에서 주문 정보를 가져와야하고 Product에서 상품이름을 가져와야하고 Member에서 회원 이름과 아이디를 가져와야 한다.
조회화면 특성상 빠를수록 좋은데 여러 애그리것에서 데이터를 가져와야 할 경우 구현 방법을 고민해봐야 한다.
3장에서 언급한 ID를 이용해서 애그리것을 참조하는 방식을 사용하면 즉시로딩 방식과 같은 JPA의 쿼리 관련 최적화 기능을 사용할 수 없다.
이는 한번의 select 쿼리로 조회화면에 필요한 데이터를 읽어올 수 없어 조회속도에 문제가 생길 수 있다.
애그리것간의 연관을 ID가 아니라 직접 참조하는 방식으로 연결해도 고민거리가 생긴다.
조회 화면의 특성에 따라 같은 연관도 즉시 로딩이나 지연 로딩으로 처리해야 하기 때문이다.
경우에 따라 DBMS가 제공하는 전용기능을 이용해 조회 쿼리를 작성해야 해서 JPA의 네이티브 쿼리를 사용해야 할 수도 있다.
이런 고민이 발생하는 이유는 시스템의 상태를 변경할 때와 조회할 때 단일 도메인 모델을 사용하기 떄문이다.
객체 지향으로 도메인 모델을 구현할 떄 주로 사용하는 ORM 기법은 Order.cancel()이나 Order.changeShippingInfo() 처럼 도메인의 상태를 변경하는데 적합하지만 주문 상세 조회화면 처럼 여러 애그리것에서 데이터를 가져와 출력하는 기능을 구현하기에는 고려할 것들이 많아서 구현을 복잡하게 만드는 원인이 된다.
이런 구현 복잡도를 낮추는 간단한 방법이 있는데 그것은 바로 상태변경을 위한 모델과 조회를 위한 모델을 분리하는 것이다.
CQRS
시스템이 제공하는 기능은 크게 두가지로 나누어 생각할수 있다.
하나는 상태를 변경하는 것이고 하나는 상태 정보를 조회하는 것이다.
도메인 모델 관점에서 상태 변경은 주로 한 애그리것의 상태를 변경한다.
예를 들어 주문 취소 기능과 배송지 정보 변경 기능은 한 개의 Order 애그리것을 변경한다.
반면에 조회 기능은 한 애그리것의 데이터를 조회할 수도 있지만 두개이상의 애그리것에서 데이터를 조회할수도 있다. ( 앞에서 얘기함 주문 상세정보조회 )
단일 모델로 두 종류 ( 상태 변경, 상태 조회 ) 의 기능을 구현하면 모델이 불필요하게 복잡해진다.
이럴때 CQRS를 사용하여 복잡도를 해결한다.
CQRS는 상태를 변경하는 명령 모델과 상태를 제공하는 조회 모델을 분리하는 패턴이다.
CQRS는 복잡한 도메인에 적합하다.
도메인이 복잡할수록 명령기능과 조회 기능이 다루는 데이터 범위에 차이가 발생하는데 이 두기능을 단일 모델로 처리하면 조회 기능의 로딩속도를 위해 모델 구현이 필요이상으로 복잡해지는 문제가 발생한다.
예를 들어 온라인 쇼핑에서 다양한 차원에서 주문/판매 통계를 조회해야 한다고 해보자.
JPA기반의 단일 도메인 모델을 사용하면 통계값을 빠르게 조회하기 위해 JPA와 관련된 다양한 성능관련 기능을 모델에 적용해야 한다.
이런 도메인에 CQRS를 적용하면 통계를 위한 조회 모델을 별도로 만들기 때문에 조회 떄문에 도메인이 복잡해지는 것을 막을 수 있다.
CQRS를 사용하면 각 모델에 맞는 구현 기술을 선택할 수 있다.
예를 들어, 명령 모델은 객체 지향에 기반해서 도메인 모델을 구현하기에 적당한 JPA를 사용해서 구현하고, 조회 모델은 DB 테이블에서 SQL로 데이터를 조회할 떄 좋은 MyBatis를 사용해서 구현할수 있다.
보통 결제 시스템은 외부에 존재하므로 RefundService는 외부의 환불 시스템 서비스를 호출하는데, 이때 두 가지 문제를 발생한다.
첫 번째 문제는 외부 서비스가 정상이 아닐경우 트랜잭션 처리를 어떻게 해야할지 애매하다는것
환불처리중 익셉션이 생겼을 경우 롤백을 해야하는가 안해야 하는가 ?
무조건 롤백이라고 생각할수 있지만 주문은 취소상태로 변경하고 환불만 나중에 다시 시도하는 방식으로 처리할 수 있다.
두번째는 성능에 관한 문제
외부시스템의 응답이 길어지면 그만큼 대기 시간이 발생한다.
환불 처리기능이 30초 걸리면 주문 취소 기능은 30초+@가 된다.
즉, 외부 서비스 성능에 직접적인 영향을 받는 문제가 있다.
두가지 문제 외에 도메인 객체에 서비스를 전달하면 추가로 설계상 문제가 나타날 수 있다.
주문 로직과 결제 로직이 섞이는 문제가 있다.
Order는 주문을 표현하는 도메인인데 결제 도메인의 환불 관련 로직이 섞이게 된다.
의존성이 생겨 변경시 같이 변경해야되는 문제가 발생함.
또하나의 문제는 기능을 추가할 때 발생한다.
만약 주문을 취소한 뒤에 환불뿐만 아니라 취소했다는 내용을 통지해야 한다면 ?
환불 도메인 서비스와 동일하게 파라미터로 통지 서비스를 받도록 구현하면 앞서 언급한 로직이 섞이는 문제가 더 커지고 트랜잭션 처리가 더 복잡해진다.
게다가 영향을 주는 외부서비스가 두개나 증가해버렸다.
지금까지 언급한 문제가 발생하는 이유는 주문 Bounded Context와 결제 Bounded Context 간의 강결합 때문이다.
주문이 결제와 강하게 결합되어 있어서 주문 Bounded Context가 결제 Bounded Context에 영향을 받는것이다.
이러한 결합을 없애는 방법이 있는데 그것은 바로 이벤트를 사용하는 것이다.
특히 비동기 이벤트를 사용하면 두 시스템 간의 결합을 크게 낮출 수 있다.
이벤트 개요
여기서 말하는 이벤트란 "과거에 벌어진 어떤 것" 을 의미한다.
예를 들어 사용자가 비밀번호를 변경한 것을 "암호를 변경했음 이벤트" 라고 부를 수 있다.
주문을 취소했다면 ? "주문을 취소했음 이벤트"
이벤트가 발생한다는 것은 상태가 변경됐다는 것을 의미한다.
이벤트는 발생한 것에서 끝나지 않는다.
이벤트가 발생하면 그 이벤트에 반응하여 원하는 동작을 수행하는 기능을 구현한다.
도메인 모델에서도 UI 컴포넌트와 유사하게 도메인의 상태 변경을 이벤트로 표현 할수있다.
이벤트 관련 구성 요소
도메인 모델에서 이벤트 주체는 엔티티, 밸류, 도메인 서비스와 같은 도메인 객체이다.
이들 도메인 객체는 도메인 로직을 실행해서 상태가 바뀌면 관련 이벤트를 발생한다.
이벤트 핸들러는 이벤트 생성 주체가 발생한 이벤트에 반응 한다.
이벤트 핸들러는 생성 주체가 발생한 이벤트를 전달받아 이벤트에 담긴 데이터를 이용해서 원하는 기능을 실행한다.
예를 들어 주문이 취소됐을 경우 "주문 취소됨 이벤트"를 받는 이벤트 핸들러는 해당 주문의 주문자에게 SMS로 주문 취소 사실을 통지할 수 있다.
이벤트 생성 주체와 이벤트 핸들러를 연결해 주는것이 이벤트 디스패처이다.
이벤트 생성 주체는 이벤트를 생성해서 디스패처에 이벤트를 전달한다.
이벤트를 전달받은 디스패처는 해당 이벤트를 처리할 수 있는 핸들러에 이벤트를 전파한다.
이벤트 디스패처의 구현 방식에 따라 이벤트 생성과 처리를 동기나 비동기로 실행하게 된다.
이벤트의 구성
이벤트는 발생한 이벤트에 대한 정보를 담는다.
이벤트 종류: 클래스 이름으로 이벤트 종류를 표현
이벤트 발생 시간
추가 데이터: 주문번호, 신규 배송지 정보등 이벤트와 관련된 정보
public class ShippingInfoChangedEvent {
private String orderNumber;
private long timestamp;
private ShippingInfo newShippingInfo;
// 생성자, getter
}
클래스이름을 과거형으로 했다 과거에 벌어진것을 표현하기 떄문에 이름에는 과거형을 사용한다.
public class Order {
public void changeShippingInfo(ShippingInfo newShippingInfo) {
verifyNotYetShipped();
setShippingInfo(newShippingInfo);
Events.raise(new ShippingInfoChangedEvent(number, newShippingInfo));
}
...
}
위 이벤트를 발생시킨 주체는 Order 애그리것이다.
Order 애그리것의 배송지 변경 기능을 구현한 메서드는 다음 코드처럼 배송지 정보를 변경한 뒤에 이벤트 디스패처를 이용해서 이벤트를 발생시킬 것이다.
public class ShippingInfoChangedHandler implement EventHandler<ShppingInfoChangedEvent> {
@Override
public void handle(ShppingInfoChangedEvent evt) {
shippingInfoSynchronizer.sync(
evt.getOrderNumber(),
evt,getNewShippingInfo();
)
}
}
...
변경된 배송지 정보를 물류 서비스에 재전송하는 핸들러는 다음과 같다.
ShippingInfoChangedEvent 를 처리하는 핸들러는 디스패처로부터 이벤트를 전달받아 필요한 작업을 수행한다.
이벤트는 이벤트 핸들러가 작업을 수행하는 데 필요한 최소한의 데이터를 담아야 한다.
이 데이터가 부족할 경우 핸들러는 필요한 데이터를 읽기 위해 관련 API를 호출하거나 DB에서 데이터를 직접 읽어와야 한다.
그렇다고 이벤트 자체와 관련 없는 데이터를 포함할 필요는 없다.
바뀐 배송지 정보를 포함하는 것은 맞지만 배송지 정보 변경과 관련없는 주문 상품번호와 개수를 담을 필요는 없다.
이벤트 용도
이벤트는 크게 두 가지 용도로 쓰인다.
첫번쨰는 트리거의 용도로 쓰이는데 도메인의 상태가 바뀔때 다른 후처리를 해야 할 경우 후처리를 실행하기 위한 트리거로 이벤트를 사용할 수 있다.
예매 결과를 SMS로 통지할 떄도 이벤트를 트리거로 사용할 수 있다.
예매 도메인은 예매 완료 이벤트를 발생시키고 이 이벤트 핸들러에서 SMS를 발송시키는 방식으로 구현
이벤트의 두번째 용도는 서로 다른 시스템간의 데이터 동기화이다.
배송지를 변경하면 외부 배송 서비스에 바뀐 배송지 정보를 전송해야 한다.
이 경우 주문 도메인은 배송지 변경 이벤트를 발생시키고 이벤트 핸들러는 외부 배송 서비스와 배송지 정보를 동기화 한다.
이벤트 장점
이벤트를 사용하면 첫장에서 말한 서로 다른 도메인 로직이 섞이는 것을 방지할 수 있다.
또한 기능 확장도 용이해진다. 구매 취소시 환불과 함께 이메일을 보내고 싶다면 이메일 발송을 처리하는 핸들러를 구현하고 디스패처에 등록하면 된다.
기능을 확장해도 도메인 로직은 수정할 필요가 없다.
이벤트, 핸들러, 디스패처 구현
이벤트와 관련된 코드는 다음과 같다.
이벤트 클래스
EventHandler: 이벤트 핸들러를 위한 상위 타입으로 모든 핸들러는 이 인터페이스를 구현한다.
Events: 이벤트 디스패처. 이벤트 발행, 이벤트 핸들러 등록, 이벤트를 핸들러에 등록하는 등의 기능을 제공한다.
이벤트 클래스
이벤트 자체를 위한 상위 타입은 존재하지 않는다. 원하는 클래스를 이벤트로 사용할 것이다.
이벤트클래스의 이름을 결정할때는 과거 시제를 사용해야 한다.
OrderCanceledEvent와 같이 클래스 이름뒤에 접미사로 Event를 사용해서 Event로 사용하는 클래스 라는것을 명시적으로 표현할 수 있고 OrderCanceld처럼 간결함을 위해 과거 시제만 사용할 수도 있다.
public class OrderCanceledEvent extends Event {
// 이벤트는 핸들러에서 이벤트를 처리하는 데 필요한 데이터를 포함한다.
private String orderNumber;
public OrderCanceledEvent(String number) {
super();
this.orderNumber = number;
}
public String getOrderNumber() { return orderNumber; }
}
이벤트클래스는 이벤트를 처리하는데 필요한 최소한의 데이터를 포함해야 한다.
public abstract class Event {
private long timestamp;
public Event() {
this.timestamp = System.currentTimeMillis();
}
public long getTimestamp() {
return timestamp;
}
}
모든 이벤트가 공통으로 갖는 프로퍼티가 존재한다면 관련 상위 클래스를 만들 수도 있다.
위와 같은 상위 클래스를 만들고 각 이벤트 클래스가 상속받도록 할 수 있다.
EventHandler 인터페이스
EventHandler 인터페이스는 이벤트 핸들러를 위한 상위 인터페이스이다.
public interface EventHandler<T> {
// handle 메서드를 이용해서 필요한 기능을 구현한다.
void handle(T event);
// 핸들러가 이벤트를 처리할 수 있는지 여부를 검사한다.
default boolean canHandle(Object event) {
Class<?>[] typeArgs = TypeResolver.resolveRawArguments(
EventHandler.class, this.getClass()
);
return typeArgs[0].isAssignableForm(event.getClass());
}
}
EventHandler 인터페이스를 상속받는 클래스는 handle() 메서드를 이용해서 필요한 내용을 구현하면 된다.
canHandler() 메서드는 핸들러가 이벤트를 처리할 수 있는지 여부를 검사한다.
Event의 타입이 T의 파라미터화 타입에 할당 가능하면 true를 리턴한다.
이벤트 디스패처인 Events 구현
public class CancelOrderService {
private OrderRepository orderRepository;
private RefundService refundService;
@Transactional
public void cancel(OrderNo orderNo) {
// handle 메서드에 전달한 EventHandler를 이용해서 이벤트를 처리하게 된다.
Events.handle(
(OrderCanceledEvent evt) -> refundService.refund(evt.getOrderNumber())
);
Order order = findOrder(orderNo);
order.cancel();
// ThreadLocal 변수를 초기화해서 OOME가 발생하지 않도록 한다.
Events.reset();
}
}
도메인을 사용하는 응용 서비스는 이벤트를 받아 처리할 핸들러를 Events.handle()로 등록하고 도메인 기능을 실행한다.
위 코드는 OrderCancledEvent가 발생하면 Events.handle() 메서드에 전달한 EventHandler를 이용해서 이벤트를 처리하게 된다.
이벤트가 발생하면 이벤트를 처리할 EventHandler를 list에서 찾아 EventHandler의 handle() 메서드를 호출해서 이벤트를 처리 한다.
public class Order {
public void cancel() {
verifyNotYetShipped();
this.state = OrderState.CANCELED;
Events.raise(new OrderCanceledEvent(number.getNumber()));
}
}
Events.raise()를 이용해서 이벤트를 발생시키면 Events.raise() 메서드는 이벤트를 처리할 핸들러를 찾아 handle() 메서드를 실행한다.
public class Events {
// EventHandler 목록을 보관하는 ThreadLocal 변수를 생성한다.
private static ThreadLocal<List<EventHandler<?>>> handlers =
new ThreadLocal<>();
// 이벤트를 처리 중인지 여부를 판단하는 ThreadLocal 변수를 생성한다.
private static ThreadLocal<Boolean> publishing =
new ThreadLocal<Boolean>() {
@Override
protected Boolean initialValue() {
return Boolean.FALSE;
}
};
// 파라미터로 전달받은 이벤트를 처리한다.
public static void raise(Object event) {
// 이벤트를 처리 중이면 진행하지 않는다.
if (publishing.get()) return;
try {
// 이벤트 처리 중 상태를 true로 변경한다.
publishing.set(Boolean.TRUE);
// handlers에 담긴 EventHandler가 파라미터로 전달받은 이벤트를 처리할 수 있는지 확인하고
List<EventHandler<?>> eventHandlers = handlers.get();
if (eventHandlers == null) return;
for (EventHandler handler: eventHandlers) {
// handlers에 담긴 EventHandler가 파라미터로 전달받은 이벤트를 처리할 수 있는지 확인한다.
if (handler.canHandle(event)) {
// 처리 가능하면 핸들러의 handle() 메서드에 이벤트 객체를 전달한다.
handler.handle(event);
}
}
} finally {
// 핸들러의 이벤트 처리가 끝나면 처리 중 상태를 False로 변경한다.
publishing.get(Boolean.FALSE);
}
}
// 이벤트 핸들러를 등록하는 메서드
public static void handle(EventHandler<?> handler) {
// 이벤트를 처리 중이면 등록하지 않는다.
if (publishing.get()) return;
List<EventHandler<?>> eventHandlers = handlers.get();
if (eventHandlers == null) {
eventHandlers = new ArrayList<>();
handlers.set(eventHandlers);
}
eventHandlers.add(handler);
}
// handlers에 보관된 List 객체를 삭제한다.
public static void reset() {
if (!publishing.get()) {
handlers.remove();
}
}
}
public class Order {
public void cancel() {
verifyNotYetShipped();
this.state = OrderState.CANCELED;
Events.raise(new OrderCanceledEvent(number.getNumber()));
}
}
Events는 핸들러 목록을 유지하기 위해 ThreadLocal 변수를 사용한다.
톰캣과 같은 웹 애플리케이션 서버는 스레드를 재사용하므로 ThreadLocal에 보관한 값을 제거하지 않으면 기대했던것과 다르게 코드가 동작할수 있다.
예를 들어 사용자의 요청을 처리한 뒤 Events.reset()을 실행하지 않으면 스레드 handlers가 담고 있는 List에 계속 핸들러 객체가 쌓이게 되어 결국 메모리 부족 에러가 발생하게 된다.
따라서 이벤트 핸들러를 등록하는 응용 서비스는 다음과 같이 마지막에 Events.reset() 메서드를 실행해야 한다.
Events.raise()는 등록된 핸들러의 canHandle()를 이용해서 이벤트를 처리할수 있는지 확인
핸들러가 처리할 수 있다면 handle()메서드를 이용해서 이벤트를 처리
Events.raise() 실행을 끝내고 리턴
도메인 기능 실행을 끝내고 리턴
Events.reset()를 이용해서 ThreadLocal을 초기화 한다
코드 흐름을 보면 응용 서비스와 동일한 트랜잭션 범위에서 핸들러의 handle()이 실행되는것을 알수 있다.
즉 도메인의 상태변경과 이벤트 핸들러는 같은 트랜잭션 범위에서 실행된다.
AOP를 이용한 Events.reset() 실행
응용 서비스가 끝나면 ThreadLocal에 등록된 핸들러 목록을 초기화 하기 위해
Events.reset() 메서드를 실행한다.
모든 응용 서비스마다 메서드 말미에 Events.reset()을 실행하는 코드를 넣는것은 중복에 해당한다.
이런 류의 중복을 없앨 떄 적합한 것이 바로 AOP다.
코드는 아래와 같다.
@Aspect
// 우선순위를 0으로 지정한다. 이를 통해 트랜잭션 관련 AOP보다 우선순위를 높여 이 AOP가 먼저 적용되도록 한다.
@Order(0)
@Component
public class EventsResetProcessor {
//서비스 메서드의 중첩 실행 개수를 저장하기 위한 ThreadLocal 변수를 생성한다.
private ThreadLocal<Integer> nestedCount = new ThreadLocal<Integer>() {
@Override
protected Integer initialValue() {
return new Integer(0);
}
};
// @Around Aspect를 이용해서 AOP를 구현한다.
// 적용 대상은 com.myshop 패키지 및 그 하위 패키지에 위치한 @Service가 붙은 빈 객체다
@Around(
"@target(org.springframework.stereotype.Service) and within(com.myshop..*)")
public Object doReset(ProceedingJoinPoint joinPoint) throws Throwable {
// 중첩 실행 횟수를 1 증가한다.
nestedCount.set(nestedCount.get() + 1);
try {
// 대상 메서드를 실행한다.
return joinPoint.proceed();
} finally {
// 중첩 실행 횟수를 1 감소한다.
nestedCount.set(nestedCount.get() - 1);
// 중첩 실행횟수가 0이면 Events.reset()을 실행한다.
if (nestedCount.get() == 0) {
Events.reset();
}
}
}
}
Service 애노테이션을 이용해서 응용 서비스를 지정했는데 @Service를 사용하지 않을 경우
@Around의 포인트 컷에 @Target대신 execution() 명시자를 사용해도 된다.
public class LockId {
private String value;
public LockId(String value) {
this.value = value;
}
public String getValue() {
return value;
}
}
@RequestMapping("/some/edit/{id}")
public String editForm(@PathVariable("id") Long id, ModelMap model) {
// 1. 오프라인 선점 잠금 시도
LockId lockId = lockManager.tryLock("data", id);
// 2. 기능 실행
Data data = someDao.select(id);
model.addAttribute("data", data);
// 3. 잠금 해제에 사용할 LockId를 모델에 추가
model.addAttribute("lockId", lockId);
return "editForm";
}
잠금을 해제할 경우 전달받은 LockId를 이용한다.
잠금시 반드시 주어진 lockId를 갖는 잠금이 유효한지 검사해야한다.
잠금의 유효 시간이 지났으면 이미 다른 사용자가 잠금을 선점한다.
잠금을 선점하지 않은 사용자가 기능을 실행했다면 기능 실행을 막아야 한다.
DB를 이용한 LockManager 구현
잠금 정보를 저장할 테이블과 인덱스를 생성한다.
쿼리는 MySQL용
CREATE TABLE LOCKS (
`type` varchar(255),
id varchar(255),
lockid varchar(255),
expiration_time datetime,
primary key (`type`, id)
) character set utf8;
스레드1이 먼저 커밋시도, 이 시점에 애그리것의 버전은 5지만 스레드1이 수정에 성공하고 버전은 6이 된다.
스레드1이 트랜잭션을 커밋한 후에 스레드2가 커밋을 시도하는데 이미 애그리것 버전이 6이므로 스레드2는 데이터 수정에 실패하게 된다.
JPA는 버전을 이용한 비선점 잠금 기능을 지원한다.
@Entity
@Table(name = "purchage_order")
@Access(AccessType.FIELD)
public class Order {
@EmbeddedId
private OrderNo number;
@Version
private long version;
...
}
JPA는 엔티티가 변경되어 UPDATE 쿼리를 실행할때 @Version에 명시한 필드를 이용해서 비선점 잠금 쿼리를 실행한다.
즉 애그리것 객체의 버전이 10이면 UPDATE쿼리를 실행할때 아래와 같은 쿼리를 실행한다
UPDATE purchage_order SET ..., version = version + 1
WHERE number = ? and version = 10
응용서비스는 버전에 대해 알 필요가 없다.
리포지토리에서 필요한 애그리것을 구하고 알맞은 기능만 실행하면 된다.
기능을 실행하는 과정에서 애그리것의 데이터가 변경되면 JPA는 트랜잭션 종료 시점에 비선점 잠금을 위한 쿼리를 실행한다.
public class ChangeShippingService {
private OrderRepository orderRepository;
@Transactional
public void changeShipping(ChangeShippingRequest changeReq) {
Order order = orderRepository.findById(new OrderNo(changeReq.getNumber()));
checkNoOrder(order);
order.changeShippingInfo(changeReq.getShippingInfo());
}
...
}
비선점 잠금을 위한 쿼리를 실행할 때 쿼리 실행 결과로 수정된 행의 개수가 0이면 이미 누군가 앞서 데이터를 수정한 것이다.
이는 트랜잭션이 충돌한 것이므로 트랜잭션 종료 시점에 익셉션이 발생한다.
위 코드의 경우 스프링의 @Transactional을 이용해서 트랜잭션 범위를 정했으므로 changeShipping() 메서드가 리턴될때 트랜잭션이 종료되고 이시점에 트랜잭션 충돌이 발생하면 OptimisticLockingFailureException을 발생시킨다.
표현 영역의 코드는 이 익셉션의 발생 여부에 따라 트랜잭션 충돌이 일어났는지 확인할 수 있다.
@Controller
public class OrderController {
...
@RequestMapping(value = "/changeShipping", method = RequestMethod.POST)
public String changeShipping(ChangeShippingRequest changeReq) {
try {
changeShippingService.changeShipping(changeReq);
return "changeShippingSuccess";
} catch(optimisticLockingFailureException ex) {
// 누군가 먼저 같은 주문 애그리거트를 수정했으므로,
// 트랜잭션 충돌이 일어났다는 메시지를 보여준다.
return "changeShippingExConflic";
}
}
비선점 잠금을 확장해서 적용할 수 있다.
시스템은 사용자에게 수정 폼을 제공할 때 애그리것 버전을 함꼐 전송하고 사용자가 폼을 전송할 때와 폼을 생성할 때 사용한 애그리것 버전을 함께 전송하도록 할 수 있다.
시스템을 애그리것을 수정할 때 사용자가 전송한 버전과 애그리것 버전이 동일한 경우에만 수정 기능을 수행하도로 함으로써 트랜잭션 충돌문제를 해소할 수 있다.
위의 과정2에서 운영자는 배송 상태 변경을 요청할 때 앞서 과정 1을 통해 받은 애그리것의 버전값을 함께 전송한다.
시스템은 애그리것을 읽는데 해당 시점의 버전 값도 함께 읽어온다. 만약 과정 1에서 받은 버전 A와 과정 2.1을 통해 읽은 애그리것의 버전 B가 다르면 과정 1과 과정 2 사이에 다른 사용자가 해당 애그리것을 수정한 것이다.
이 경우 시스템은 운영자가 이전 데이터를 기준으로 작업을 요청한 것으로 간주하여 과정 2.1.2와 같이 수정할 수 없다는 에러를 응답으로 전송한다.
만약 A와 B의 버전이 같다면 과정 1과 과정 2 사이에 아무도 애그리것을 수정하지 않은것이므로 이 경우 시스템은 과정 2.1.3과 같이 애그리것을 수정하고 과정 2.1.4를 이용해서 변경 내용을 DBMS에 반영한다.
과정 2.1.1과 과정 2.1.4사이에 아무도 애그리것을 수정하지 않았다면 커밋에 성공하므로 성공 결과를 응답으로 전송한다.
반면에 과정 2.1.1과 과정 2.1.4사이에 누군가 애그리것을 수정해서 커밋했다면 버전값이 증가한 상태가 되므로 트랜잭션 커밋에 실패하고 결과로 에러 응답을 전송한다.
위와 같이 비선점 잠금 방식을 여러 트랜잭션으로 확장하려면 애그리것 정보를 뷰로 보여줄때 버전 정보도 함께 사용자 화면에 전달해야 한다.
HTML 폼을 생성하는 경우 버전 값을 갖는 hidden 타입 (input) 태그를 생성해서 폼 전송 시 버전 값이 서버에 함께 전달되도록 한다.
사용자 요청을 처리하는 응용서비스를 위한 요청 데이터는 사용자가 전송한 버전값을 포함한다.
예를 들어, 배송 상태 변경을 처리하는 응용 서비스가 전달받는 데이터는 다음과 같이 주문 번호와 함께 해당 주문을 조회한 시점의 버전 값을 포함해야 한다.
public class StartShippingRequest {
private String orderNumber;
private long version;
protected StartShippingRequest() {}
public StartShippingRequest(String orderNumber, long version) {
this.orderNumber = orderNumber;
this.version = version;
}
public String getOrderNumber() {
return orderNumber;
}
public long getVersion() {
return version;
}
}
응용서비스는 전달받은 버전 값을 이용해서 애그리것의 버전과 일치하는지 확인하고 일치하는 경우에만 요청한 기능을 수행한다.
@Service
public class StartShippingService {
private OrderRepository orderRepository;
@Transactional
public void startShipping(StartShippingRequest req) {
Order order = orderRepository.findById(new OrderNo(req.getOrderNumber()));
checkNoOrder(order);
if (!order.matchVersion(req.getVersion())) {
// throw new VersionConflictException();
throw new OptimisticLockingFailureException("version conflict");
}
order.startShipping();
}
@Autowired
public void setOrderRepository(OrderRepository orderRepository) {
this.orderRepository = orderRepository;
}
}
버전이 맞지않으면 표현 계층으로 exception 을 전달한다.
@Controller
public class OrderAdminController {
private StartShippingService startShippingService;
@RequestMapping(value = "/startShipping", method = RequestMethod.POST)
public String startShipping(StartShippingRequest startReq) {
try {
startShippingService.startShipping(startReq);
return "shippingStarted";
} catch(OptimisticLockingFailureException | VersionConflictException ex) {
// 트랜잭션 충돌
return "startShippingTxConflict";
}
}
...
표현 계층에서 익셉션을 받아 처리한다.
VersionConflictException은 응용 서비스코드에서 발생시키고 OptimisticLockingFailureException 는 스프링에서 발생시킨다.
버전 충돌상황에 대한 구분이 명시적으로 필요 없다면 응용 서비스에서 프레임워크용 익셉션을 발생시켜도 된다.
컨텍스트맵은 시스템의 전체 구조를 보여준다. 이는 하위 도메인과 일치하지 않는 Bounded Context를 찾아 도메인에 맞게 Bounded Context를 조절하고 사업의 핵심 도메인을 위해 조직 역량을 어떤 Bounded Context에 집중할지 파악하는데 도움을 준다.
public class Order {
public void calculateAmounts(
DiscountCalculationService disCalSvc, MemberGrade grade) {
Money totalAmounts = getTotalAmounts();
Money discountAmounts = disCalSvc.calculateDiscountAmounts(this.orderLInes, this.coupons, greade);
this.paymentAmounts = totalAmounts.minus(discountAmounts);
}
...
애그리것 객체에 도메인 서비스를 전달하는 것은 응용 서비스 책임이다.
public class OrderService {
private DiscountCalculationService discountCalculationService;
@Transactional
public OrderNo placeOrder(OrderRequest orderRequest) {
OrderNo orderno = orderRepository.nextId();
Order order = createOrder(orderNo, orderRequest);
orderRepository.save(order);
// 응용 서비스 실행 후 표현 영역에서 필요한 값 리턴
return orderNo;
}
private Order createOrder(OrderNo orderNo, OrderRequest orderReq) {
Member member =findMember(orderReq.getOrdererId());
Order order = new Order(orderNo, orderReq.gerOrderLines(),
orderReq.getCoupons(), createOrderer(member),
orderReq.getShippingInfo());
order.calculateAmounts(this.discountCalculationService, member.getGrade());
return order;
}
...
}
도메인 서비스 객체를 애그리것에 주입하지 않기.
애그리것의 메소드를 실행할때 도메인 서비스 객체를 파라미터로 전달하는 것은 애그리것이 도메인 서비스에 의존한다는 것을 의미
스프링이 제공하는 의존주입을 사용하여 도메인 서비스를 애그리것에 주입해야 기술적으로 나은것 같은 착각이 들 수 있다.
하지만 개인적 (작가의견) 으론 좋은 방법이 아니라고 한다.
도메인 객체는 필드로 구성된 데이터와 메서드를 이용한 기능을 이용해서 개념적으로 하나인 모델을 표현한다.
모델의 데이터를 담는 필드는 모델에서 중요한 구성요소이다. 그런데 도메인 서비스 필드는 데이터 자체와는 관련이 없다.
order 객체를 DB에 보관할때 다른 필드와 달리 저장 대상도 아니다.
또 Order이 제공하는 모든 기능에서 도메인 서비스 ( 할인정책 ) 을 필요로 하는 것도 아니다.
일부 기능만 필요로 하는 도메인서비스 객체를 애그리것에 의존 주입할 필요는 없다.
이는 프레임워크의 기능을 사용하고 싶은 개발자의 욕심을 채우는것에 불과하다.
도메인 서비스를 인자로 전달하지 않고 반대로 도메인 서비스의 기능을 실행할때 애그리것을 전달하기도 한다.
public class TransgerService {
public void transfer(Account fromAcc, Account toAcc, Money amounts) {
fromAcc.withdraw(amounts);
toAcc.credit(amounts);
}
}
특정기능이 도메인 서비스인지 응용서비스인지 감이 안오는 경우엔 해당 로직이 애그리것의 상태를 변경하거나 애그리것의 상태값을 변경하는지 검사해보면 된다.
도메인 로직이면서 (위와 같이) 한 애그리것에 넣기 적합하지 않은 것은 도메인 서비스로 구현하게 된다.
도메인 서비스의 패키지 위치
도메인 서비스는 도메인 로직을 실행하므로 도메인 서비스의 위치는 다른 도메인 구성요소와 동일한 패키지에 위치한다.
예를 들어 주문금액계산 도메인 서비스는 주문 애그리것과 동일 패키지에 위치한다.
도메인 서비스의 개수가 많거나 엔티티나 밸류와 같은 다른 구성요소와 명시적으로 구분하고 싶다면 domain 패키지 밑에 domain.model, domain.service, domain.repository와 같이 하위 패키지를 구분해서 위치시켜도 된다.
도메인 서비스의 인터페이스와 클래스
도메인 서비스의 로직이 고정되어 있지 않은 경우 도메인 서비스 자체를 인터페이스로 구현하고 이를 구현한 클래스를 둘 수도 있다.
특히 도메인 로직을 외부 시스템이나 별도 엔진을 이용해서 구현해야 할 경우에 인터페이스와 클래스를 분리하게 된다.
사용자에게 기능을 잘 제공하려면 도메인과 사용자를 연결시킬 표현영역과 응용영역이 필요하다.
표현영역은 응용서비스가 요구하는 형식으로 사용자 요청을 변환한다.
응용서비스가 요구하는 객체를 생성한뒤 응용서비스의 메서드를 호출한다.
public ModelAndView join(HttpServletRequest request) {
String email = request.getParameter("email");
String password = request.getParameter("password");
//사용자 요청을 응용서비스에 맞게 변환
JoinRequest joinReq = new JoinRequest(email, password);
joinService.join(joinReq);
}
응용서비스를 실행한뒤에 표현영역은 실행결과를 사용자에 알맞은 형식으로 응답한다.
응용서비스는 표현영역이 뭘하던 의존하지 않는다. 사용자가 무엇을 사용하던지 알 필요가 없다.
응용 서비스의 역할
응용서비스는 사용자의 요청을 처리하기 위해 리포지터리로 부터 도메인 객체를 구하고 도메인 객체를 사용한다.
응용서비스의 주요 역할은 도메인 객체를 사용해서 사용자의 요청을 처리하는것이므로 표현영역에서 봤을때 응용 서비스는 도메인 영역과 표현영역을 연결해주는 창구인 파사드 역할을 한다.
public Result doSomeFunc(SomeReq req) {
//1. 리포지터리에서 애그리것을 구한다
SomeAgg agg = someAggRepository.findByid(req.getId());
checkNull(agg);
//2. 애그리것의 도메인 기능을 실행한다.
agg.doFunc(req.getValue());
// 3. 결과를 리턴한다.
return createSuccessResult(agg);
}
응용서비스가 복잡하다면 응용서비스에서 도메인 로직의 일부를 구현하고 있는지 확인해보자.
트랜잭션은 응용서비스에서 처리한다.
도메인 로직 넣지 않기
도메인로직을 도메인 영역과 응용 서비스에 분산해서 구현하면 코드품질에 문제가 발생한다.
코드의 응집도가 떨어진다.
여러 응용서비스에서 동일한 도메인 로직을 구현할 가능성이 높아진다.
보조클래스를 만들어서 사용할수 있지만 애초에 도메인 영역에 구현하면 간단하다.
응용서비스의 구현
응용서비스는 표현 영역과 도메인 영역을 연결하는 매개채 역할을 하는데 디자인 패턴에서 파사드 패턴과 같은 역할을 한다.
응용 서비스는 복잡한 로직이 없기 때문에 구현이 쉽다.
응용 서비스의 크기
보통 응용서비스의 크기는 다음 두가지 방법중 한가지 방식으로 구현한다.
한 응용 서비스 클래스에 회원 도메인의 모든 기능 구현하기.
한 도메인과 관련된 기능을 구현한 코드가 한 클래스에 위치하므로 각 기능에서 동일로직에 대한 코드 중복을 제거할수 있다.
하지만 단점으로는 서비스 클래스의 크기가 커진다.
코드가 커진다는 것은 연관성이 적은 코드가 한 클래스에 함께 위치할 가능성이 높아짐을 의미하는데 이는 결과적으로 관련없는 코드가 뒤섞여서 코드를 이해하는데 방해가 될 수 있다.
구분되는 기능별로 응용 서비스 클래스를 따로 구현하기.
구분되는 기능별로 서비스 클래스를 구현하는 방식은 서비스 클래스에서 한개 내지 2~3개의 기능을 구현한다.
이방식을 사용하면 클래스 갯수는 많아지지만 한 클래스에 관련 기능을 모두 구현하는것과 비교해서 코드 품질을 일정수준으로 유지하는데 도움이 된다.
각 기능마다 동일한 로직을 구현할 경우 여러 클래스에 중복해서 동일한 코드를 구현할 가능성이 있다.
이런 경우 별도 클래스에 로직을 구현해서 코드가 중복되는것을 방지할수 있다.
public final class MemberServiceHelper {
//구현
}
범균이 형님은 한 클래스가 여러 역할을 갖는 것보다 각 클래스마다 구분되는 역할을 갖는것을 선호하신다. ( 2번 선호 )
응용 서비스의 인터페이스와 클래스(흥미로운 주제)
응용 서비스를 구현할때 논쟁이 될만한 것이 인터페이스가 필요한지 여부이다
인터페이스가 필요한 경우는 의존성을 분리할 때 또는 구현 클래스가 여러개일때 등등 여러가지 이유가 있지만 구현 클래스가 다수일때 인터페이스가 유용하게 쓰인다.
그런데 응용서비스는 보통 런타임에 이를 교체하는 경우가 거의 없을뿐만 아니라 한 응용 서비스의 구현 클래스가 두 개인 경우도 매우 드물다.
이런 이유로 인터페이스와 클래스를 따로 구현하면 소스 파일만 많아지고 구현 클래스에 대한 간접참조가 증가해서 전체 구조만 복잡해지는 문제가 발생한다.
따라서 인터페이스가 명확하게 필요하기 전까지는 응용 서비스에 대한 인터페이스를 작성하는것이 좋은 설계는 아니다.
만약 TDD를 하는 경우에는 미리 응용서비스를 구현할수 없으므로 응용서비스의 인터페이스를 작성하게 될것이다.
하지만 mockito와 같은 테스트 도구를 사용하면 테스트용 가짜 객체를 만들기 때문에 인터페이스가 없어도 표현영역을 테스트 할수 있다.
결과적으로 응용서비스에 대한 인터페이스 필요성을 약화시킨다.
메서드 파라미터와 값 리턴
파라미터
값 전달을 파라미터로 받을수도 별도의 데이터 클래스 dto를 만들어 전달받을 수도 있다.
스프링 MVC는 웹 요청 파라미터를 자바 객체로 변환해주는 기능 ( Converter ) 를 제공해주므로 파라미터가 두개 이상 존재하면 데이터 전달을 위한 별도의 클래스를 사용하는것이 편리하다.
값 리턴
값리턴시 편하게 애그리것을 return할수도 있지만 애그리것을 리턴할 경우 의존성이 깨진다.
도메인의 로직이 응용서비스에서 소비되는것이 아닌 표현영역까지 가서 소비되면 응집도를 낮추는 원인이 된다.
응용서비스는 표현영역에서 필요한 데이터만 return 하도록 하자.
표현영역에 의존하지 않기.
응용서비스의 파라미터 타입을 결정할때 주의할 점은 표현 영역과 관련된 타입을 사용하면 안된다.
예를 들어 HttpServletRequest 나 HttpSession을 응용서비스에 파라미터로 전달하면 안된다.
응용서비스에서 표현 영역에 대한 의존이 발생하면 응용 서비스만 단독으로 테스트하기가 어려워진다.
만약 httpsession을 응용 서비스까지 가져와 변경해버린다면 표현 영역에서만 사용해야되는 httpsession이 응용서비스까지 내려온것이므로 표현 영역에 대한 응집도가 꺠진다.
트랜잭션 처리
트랜잭션을 관리하는것은 응용 서비스의 중요한 역할이다
스프링에서 제공하는 @Transaction 어노테이션을 사용하자. 매우 편하다
이 어노테이션을 적용하면 RuntimeException이 발생하면 트랜잭션을 롤백하고 그렇지 않으면 커밋한다.
도메인 이벤트 처리
응용서비스는 또한 도메인 영역에서 발생시킨 이벤트를 처리하는것이 주요 역할중 하나다.
도메인 이벤트란 도메인에서 발생한 상태변경을 의미하며 "암호 변경됨", "주문 취소함"과 같은것이 이벤트가 될 수 있다.
public void changePassword(String oldPw, String newPw) {
if (!password.match(oldPw)) {
throw new IdPasswordNotMatchingException();
}
this.password = new Password(newPw);
Events.raise(new PasswordChangedEvent(id.getId(), newPw));
}
도메인에서 이벤트를 발생시키면 그 이벤트를 받아서 처리할 코드가 필요한데 그 역할을 하는것이 바로 응용 서비스다.
암호가 변경되면 암호가 변경됬다는 알림을 보내는 이벤트 핸들러를 등록할수 있을것이다.
이벤트를 사용하면 코드가 다소 복잡해지는 대신 도메인 간의 의존성이나 외부시스템에 대한 의존을 낮춰주는 장점을 얻을 수 있다.
또한 시스템을 확장하는데에 이벤트가 핵심 역할을 수행하게 된다.
표현 영역
표현영역의 책임은 크게 다음과 같다.
사용자가 시스템을 사용할 수 있는 (화면) 흐름을 제공하고 제어한다.
사용자의 요청을 알맞은 응용 서비스에 전달하고 결과를 사용자에게 제공한다.
사용자의 세션을 관리한다. ( 권한 검사와도 연결이 된다. )
값 검증
값 검증은 표현과 응용 두곳에서 모두 할수 있다.
원칙적으로는 응용서비스에서 처리한다.
표현계층에서 값 검증을 할 경우
스프링 MVC는 에러 메시지를 보여주기 위한 용도로 Errors나 BindingResult를 사용한다.
그렇기에 폼에 에러메시지를 보여주기 위해 다소 번잡한 코드를 작성해야 한다.
응용계층에서 값 검증을 할 경우
각 값이 올바른지 확인할 목적으로 익셉션을 사용할때의 문제점은 사용자에게 좋지않은 경험을 제공한다는 것이다.
사용자는 잘못입력했을경우 어느부분에서 잘못됬는지 알고싶을것이다.
하지만 응용계층에서 값을 검사하는시점에 첫번째값이 잘못되어 익셉션을 발생시키면 나머지 항목에 대해서는 값을 검사하지 않게된다.
그래서 첫번째값의 검증만 알게되고 나머지 항목은 값이 올바른지 여부를 알수 없게되어 사용자가 여러번 입력하게 만든다.
결국 표현계층에서 검증해야 하는데 Spring은 Validator인터페이스를 별도로 제공하므로 위 코드를 사용하면 간결하게 줄일수 있다.
이렇게 표현영역에서 필수값과 값의 형식을 검사하면 실질적으로 응용서비스는 아이디 중복여부와 같은 논리적 오류만 검사하면 된다.
표현영역
필수값, 값의 형식, 범위등을 검증
응용 서비스
데이터의 존재 유무와 같은 논리적 오류를 검증한다.
범균이형님은 두곳에서 다 값검사를 하는것이 아닌 위처럼 구분지어서 하시는 편이라고 하신다.
하지만 응용서비스를 사용하는 주체가 다양하면 응용 서비스에서 반드시 파라미터로 전달받은 값이 올바른지 검사를 해야 된다고 하신다.
권한 검사
보안 프레임워크의 복잡도를 떠나 보통 다음의 세곳에서 권한 검사를 수행할 수 있다.
표현 영역
응용 서비스
도메인 영역
이 URL을 처리하는 컨트롤러에 웹 요청을 전달하기 전에 인증 여부를 검사해서 인증된 사용자의 웹 요청만 컨트롤러에 전달.
인증된 사용자가 아닐경우 로그인 화면으로 리다이렉트
위와 같은 접근제어를 하기 좋은 위치가 서블릿 필터다.
만약 URL만으로도 불가능한 경우에는 스프링 시큐리티는 AOP를 이용한 어노테이션을 이용해 검사를 할 수 있다.
@PreAuthorize("hasRole('ADMIN')")
@Transactional
public void block(String memberId) {
Member member = memberRepository.findById(new MemberId(memberId));
if (member == null) throw new NoMemberException();
member.block();
}
개별 도메인 단위로 검사해야하는 경우는 구현이 아래와 같이 복잡해진다. ( 게시글 삭제는 본인이 또는 관리자 역할을 가진 사용자만 할수 있는 경우의 검증 )
public void delete(String userId, Long articleId) {
Article article = articleRepository.findById(articleId);
checkArticleExistence(article);
permissionService.checkDeletePermission(userId, article);
article.markDeleted();
}
만약 프레임워크 이해도가 낮아 프레임 워크 확장을 원하는 수준으로 할 수 없다면 프레임워크를 사용하는 대신 도메인에 맞는 권한 검사 기능을 직접 구현하는 것이 코드 유지보수에 유리할 수 있다.
조회 전용 기능과 응용 서비스
public class OrderListService {
public List<OrderView> getOrderList(String ordererId) {
return orderViewDao.selectByOrderer(ordererId);
}
}
위와 같이 아주 간단한 조회기능인 경우 표현영역에서 바로 조회 전용 기능을 사용해도 된다.
Uploaded by Notion2Tistory v1.1.0