📃 명세

도메인 주도 설계(DDD)는 명세(SPECIFICATION)라는 개념을 소개하는데, 스프링 데이터 JPA는 JPA Criteria로 이 개념을 사용할 수 있도록 지원한다.

명세를 이해하기 위한 핵심 단어는 술어(predcate) 인데 단순히 참이나 거짓으로 평가된다. 그리고 AND, OR 같은 연산자로 조합할 수 있다.

예를 들어 데이터를 검색하기 위한 제약 조건 하나하나를 술어라 할 수 있다.

스프링 데이터 JPA는 org.springframework.data.jpa.domain.Specification 클래스로 정의했다.

Specification은 컴포지트 패턴으로 구성되어 있어 여러 Specification을 조합할 수 있다.

따라서 다양한 검색조건을 조립해 새로운 검색조건을 쉽게 만들 수 있다.

명세 기능을 사용하려면 JpaSpecificationExecutor 인터페이스를 상속받으면 된다.

//JpaSpecificationExecutor 상속public interface OrderRepository extends JpaRepository<Order, Long>, JpaSpecificationExecutor<Order>{...}

//JpaSpecificationExecutor 인터페이스public interface JpaSpecificationExecutor<T>{    T findOne(Specification<T> spec);    List<T> findAll(Specification<T> spec);    Page<T> findAll(Specification<T> spec, Pageable pageable);    List<T> findAll(Specification<T> spec, Sort sort);    long count(Specification<T> spec);}

JpaSpecificationExecutor의 메소드들은 Specification을 파라미터로 받아서 검색 조건으로 사용한다.

//명세 사용 코드import static org.springframework.data.jpa.domain.Specifications.*; //whereimport static org.tmkim.jpashop.domain.spec.OrderSpec.*;public List<Order> findOrders(String name){    List<Order> result = orderRepository.findAll(where(memberName(name)).and(isOrderStatus()));}

Specification는 명세들을 조립할 수 있도록 도와주는 클래스다.(where(), and(), or(), not() 메소드를 제공)

findAll()을 보면 회원 이름 명세(memberName)와 주문 상태 명세(isOrderStatus)를 and로 조합해서 검색 조건으로 사용한다.

명세 기능을 사용할 때 import static을 적용하면 읽기 쉬운 코드가 된다.

//OrderSpec 명세 정의 코드public class OrderSpec{    public static Specification<Order> memberName(final String membeName){        return new Specification<Order>(){            public Predicate toPredicate(Root<Order> root, CriteriaQuery<?> query, CriteriaBuilder builder){                if(StringUtils.isEmpty(memberName))                    return null;                Join<Order, Member> m = root.join("member", JoinType.INNER); //회원과 조인                return builder.equal(m.get("name"), memberName);            }        }    }    public static Specification<Order> isOrderStatus(){        return new Specification<Order>(){            public Predicate toPredicate(Root<Order> root, CriteriaQuery<?> query, CriteriaBuilder builder){                return builder.equal(root.get("status"), OrderStatus.ORDER);            }        }    }}

명세를 정의하려면 Specification 인터페이스를 구현하면 된다.(여기선 편의상 무명 클래스 사용)

명세를 정의할 때는 toPredicate(...) 메소드만 구현하면 되는데 JPA Criteria의 Root, CriteriaQuery, CriteriaBuilder 클래스가 파라미터로 주어지는데,

이 파라미터들을 활용해서 적절한 검색 조건을 반환하면 된다.