ch10. 스프링_데이터_JPA

스프링 데이터란 무엇일까?

스프링 데이터의 목표는 무엇일까?

스프링 데이터 및 스프링 데이터 JPA를 사용해 관계형 데이터베이스와 통신하는 방법은 무엇인가?

스프링 데이터를 사용해 몽고 DB와 같은 비관계형 데이터베이스와 어떻게 통신할까?

NoSQL의 특징

• 비정형 데이터 : 데이터에 관한 특정 구조가 없다.
• 대용량 : 일반적으로 기존의 데이터베이스에서 처리할 수 있는 것보다 용량이 많다.
• 쉽게 확장 가능 : 일반적으로 수평 및 수직으로 확장할 수 있는 옵션을 제공한다. ex) 하둡, 카산드라, 몽고DB

private static String dburl = "jdbc:mysql://localhost:3306/connectdb?serverTimezone=Asia/Seoul&useSSL=false";
private static String dbUser = "connectuser";
private static String dbpasswd = "connect123!@#";


 String sql = "SELECT description, role_id FROM role order by role_id desc";
        try(Connection conn = DriverManager.getConnection(dburl, dbUser, dbpasswd);
                PreparedStatement ps  = conn.prepareStatement(sql) ) {

                    try(ResultSet rs = ps.executeQuery()){
                        while(rs.next()) {
                            String description =rs.getString(1);
                            int id = rs.getInt("role_id");
                            Role role = new Role(id,description);
                            list.add(role);
                        }
                    }
                    catch(Exception e) {
                        e.printStackTrace();
                    }
                }
        catch(Exception ex){
                    ex.printStackTrace();
        }

일반적인 JDBC 코드에는 실행할 쿼리, 명령문의 오브젝트에 쿼리 매개변수를 설정하는 코드 (EX. setString), ResultSet을 bean에 옮기는 코드

가장 많이 쓰인 레이어

• 마이바티스 : 마이바티스는 매개변수를 설정하고 결과를 검색하기 위해 코드를 수동으로 작성할 필요가 없다. 자바 POJO를 데이터베이스에 매핑하는 간단한 XML이나 어노테이션 기반으로 구성을 제공한다.
• 하이버네이트 : 하이버네이트는 ORM 프레임워크다. ORM 프레임워크는 오브젝트를 관계형 데이터베이스의 테이블에 매핑하는 데 유용하다. 하이버네이트의 가장 큰 장점은 개발자가 직접 쿼리를 작성할 필요가 없다는 것이다. 객체와 테이블 간의 관계가 매핑되면 하이버네이트는 매핑을 사용해 쿼리를 생성하고 데이터를 채우거나 검색한다.

스프링 데이터 - 데이터 스토리지 옵션이 일(WORK) 단위로 증가하고 있다. 데이터에 액세스하기 위한 여러 가지 접근 방식을 제공하는 수많은 NoSQL 데이터베이스가 있다. 
관계형 데이터베이스만큼 일반적인 것조차도 데이터에 액세스하는 접근 방식이 여러가지다. 올바른 데이터 액세스 방법을 식별하고 구현하면 애플리케이션 개발의 복잡성이 가중된다. 

스프링 데이터는 서로 다른 종류의 데이터 레파지토리에서 데이터에 액세스하기 위한 일관된 모델을 제공하는 것이 목표다.

• 스프링 데이터의 기능
  • 다양한 레파지토리를 통해 여러 데이터 레파지토리와 쉽게 통합
  • 레파지토리 메소드 이름을 기반으로 쿼리를 구문 분석하고 구성하는 기능
  • 기본 CRUD 기능 제공
  • 사용자가 생성한 후 마지막으로 변경된 경우와 같은 감사의 기본 지원
  • 스프링과의 강력한 통합
  • 스프링 데이터 레스트를 통해 REST 컨트롤러를 노출시키는 스프링 MVC와 통합

* 스프링 데이터 모듈 * 스프링 데이터 커먼즈 : 모든 스프링 데이터 모듈에 공통 개념을 정의한다. * 스프링 데이터 JPA : JPA 레파지토리와 쉽게 통합한다. * 스프링 데이터 몽고DB : 문서 기반 데이터 레파지토리인 몽고DB와 쉽게 통합한다.

스프링 데이터 커먼즈는 데이터 저장소와 상관없이 공통 인터페이스를 정의한다. CrudRepository 인터페이스는 기본 CRUD 메소드를 제공한다. PagingAndSorting Repository 인터페이스는 CrudRepository를 확장해 결과를 정렬하고 페이지를 매기는 기능을 추가한다.

• @Entity : 해당 클래스가 엔티티음을 지정하는 어노테이션이다.
• @Id : ID가 엔티티의 기본 키임을 지정한다.
• @GeneratedValue(strategy = GenerationType.AUTO) : GeneratedValue 어노테이션은 기본 키 생성 방법을 지정하는 데 사용된다. -> autoIncrement
• @ManyToOne(fetch = FetchType.LAZY)는 User와 Todo 사이의 다대일 관계를 나타낸다. 관계의 한쪽에서 @ManyToOne 관계가 사용된다.
• @JoinColumn : 외래 키 열의 이름을 지정한다.

@Entity
@Table(name = "member")
@Builder
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@AllArgsConstructor(access = AccessLevel.PROTECTED)
class MemberEntity {
    @Id
    @GeneratedValue
    private final long id = 0;
    
    // 단방향 매핑.
    /* cascade 설정 하지 않고 자식 entity까지 연관 관계를 통해 insert시 
       "object references an unsaved transient instance" 와 같은 에러 발생.
    */
    @OneToMany(fetch = FetchType.EAGER, cascade = CascadeType.PERSIST)
    @JoinColumn(name = "member_id") // 자식 Entity가 가지는 외래키 이름.
    Set<MemberHistoryEntity> memberHistoryEntitySet = new HashSet<>();
    
    String email;
}

RunWith(SpringRunner.class)
@DataJpaTest
@ActiveProfiles("...")
@AutoConfigureTestDatabase(replace = 
@AutoConfigureTestDatabase.Replace.NONE)
public class JpaTest {

}

• @DataJpaTest : jpa 레파지토리 단위 테스트에서 SpringRunner와 함께 사용된다. JPA 관련 자동 설정만 활성화한다. 테스트는 기본적으로 인메모리 데이터베이스를 사용한다.
• @RunWith(SpringRunner.class) : SpringRunner는 SpringJUnit4ClassRunner의 간단한 별칭이다. 스프링 컨텍스트를 시작한다.
• @Autowired : 테스트에 사용될 class를 오토와이어링한다.

Optional은 null일 수도 있는 객체의 컨테이너 객체를 나타낸다.

• Optional의 중요한 메소드
• isPresent() : Optional에 null이 아닌 값이 포함돼 있는지 확인한다.
• orElse() : 포함된 객체가 null인 경우의 기본값이다.
• ifPresent() : 포함된 객체가 null이 아닌 경우 ifPresent의 코드가 실행된다.
• get() : 포함된 객체를 검색한다.

@Autowired
TestEntityManager entityManager;

@Test
public void save() {
 Todo todo = todoRepository.findById(101L);
 todo.setDescription("Todo Desc Updated");
 todoRepository.save(todo);
 
 entityManager.flush();
 
 Todo updatedTodo = todoRepository,findById(101L).get();
 
 assertEquals("Todo Desc Updated", updatedTodo.getDescription());

PagingAndSortingRepository 정렬과 페이징을 도우는 Repository이다.

@DataJpaTest
@Runwith(SpringRunner.class)
public class UserRepository.class {
 @Autowired
 UserRepository userRepository;
 
 @Autowired
 TestEntityManager entityManager;
 }
 
 @Test
 public void testing() {
  Sort sort = new Sort(Sort.Description.DESC, "name")
                   .and(new Sort(Sort.Direction.ASC, "userid"));
  Iterator<User> users = userRepository.findAll(sort);
  }

• new Sort(Sort.Description.DESC - name을 내림차순으로 정렬한다.
• and(new Sort(Sort.Direction.ASC - and() 메소드는 서로 다른 메서드는 서로 다른 정렬 구성을 결합하는 연결 메소드다.
• userRepository(sort) : 정렬 기준은 findAll 메서드에 매개변수로 전달된다.

@Test
public void paging() {
 PageRequest pageable = new PageRequest(0,2);
 Page<User> userPage = userRepository.findAll(pageable);

}

• new PageRequest(0,2)첫번째 페이지를 요청하고 2개씩 보내준다.
• userRepository.findAll(pageable) findAll 메소드에 pageable을 전달해준닫.

pageRequest의 주의사항

• PageRequest 객체에는 페이지를 탐색하는 next(), previous(), first() 메소드가 있다.
• pageRequest 생성자(public PageRequest(int page, int size, Sort sort)) 이다.

반환 타입에 따른 페이징 결과

Spring Data JPA 에는 반환 타입에 따라서 각기 다른 결과를 제공한다.

• Page 타입
• Slice 타입
• List 타입 각자 다른 결과를 반환해준다.
• Page 타입 : Page 타입을 반환 타입으로 받게 된다면 offset과 totalPage 를 이용하여 서비스를 제공할 수 있게된다.
• Page 는 일반적인 게시판 형태의 페이징에서 사용된다.

 

• 여기서 중요한 정보는 총 페이지 수 이다. 그 정보를 포함하여 반환한다.
• Page 타입은 count 쿼리를 포함하는 페이징으로 카운트 쿼리가 자동으로 생성되어 함께 나간다.

{
 "content": [
   { "id": 13, "username": "User 12", "address": "Korea", "age": 12 },
   { "id": 14, "username": "User 13", "address": "Korea", "age": 13 },
   { "id": 15, "username": "User 14", "address": "Korea", "age": 14 },
   { "id": 16, "username": "User 15", "address": "Korea", "age": 15 }
 ],
 "pageable": {
   "sort": { "sorted": false, "unsorted": true, "empty": true },
   "pageNumber": 3,
   "pageSize": 4,
   "offset": 12,
   "paged": true,
   "unpaged": false
 },
 "totalPages": 25,
 "totalElements": 100,
 "last": false,
 "numberOfElements": 4,
 "number": 3,
 "sort": { "sorted": false, "unsorted": true, "empty": true },
 "size": 4,
 "first": false,
 "empty": false
}

• Slice 타입 : Slice 타입을 반환 타입으로 받게 된다면 더보기 형태의 페이징에서 사용된다.

 

{
 "content": [
   { "id": 13, "username": "User 12", "address": "Korea", "age": 12 },
   { "id": 14, "username": "User 13", "address": "Korea", "age": 13 },
   { "id": 15, "username": "User 14", "address": "Korea", "age": 14 },
   { "id": 16, "username": "User 15", "address": "Korea", "age": 15 }
 ],
 "pageable": {
   "sort": { "sorted": false, "unsorted": true, "empty": true },
   "pageNumber": 3,
   "pageSize": 4,
   "offset": 12,
   "paged": true,
   "unpaged": false
 },
 "number": 3,
 "numberOfElements": 4,
 "first": false,
 "last": false,
 "size": 4,
 "sort": { "sorted": false, "unsorted": true, "empty": true },
 "empty": false
}

Page 타입의 반환에 없는 것들이 존재한다. number과 numberOfElements 그리고 Page 에 존재하던 totalPages, totalElements 가 없어졌다.
Slice 타입은 추가 count 쿼리 없이 다음 페이지 확인 가능하다. 내부적으로 limit + 1 조회를 해서 totalCount 쿼리가 나가지 않아서 성능상 조금 이점을 볼 수도 있다.

커스텀 JPQL 쿼리 작성하기

@Query("select u from User u where u.name = ?1")
List<User> findUsersByNameUsingQuery(String name);

@Query("select u from User u where u.name = :name")
List<User> findUsersByNameUsingQuery(@Param("name") String name);

• @Query : 레파지토리 메소드의 쿼리를 정의하는 어노테이션이다.
• name 매개변수는 인스 리스트에서 명명된 매개변수를 정의한다.

네이티브 SQL 쿼리

• 네이티브 쿼리란 - JPQL은 표준 SQL이 지원하는 대부분의 문법과 SQL함수를 지원한다.근데 특정 DB의 방언과 같은 종속적 기능은 지원하지 않는다.
• 네이티브 SQL을 사용하면 엔티티를 조회할 수 있고, JPA가 지원하는 영속성 컨텍스트의 기능을 그대로 사용할 수 있다.

• 네이티브 쿼리 API는 3가지가 있다.

• 결과 타입을 정의
• 결과 타입을 정의할수 없을 때
• 결과 매핑 사용

 @Test
   @DisplayName("네이티브 SQL 엔티티 조회")
   void nativeQueryTest() {
       String sql = "select id, name, price from item where price > ?";
       Query nativeQuery = em.createNativeQuery(sql, Item.class).setParameter(1, 100);

       List<Item> items = nativeQuery.getResultList();
   }

• jdbc 사용할때와 똑같은 느낌이 든다.
• 근데 가장 중요한점은
• SQL만 직접 사용할 뿐, JPQL을 사용할 때와 같다. 조회한 엔티티도 영속성 컨텍스트에서 관리 된다.
• 값 조회
  • 값으로 조회하려면 엔티티 조회처럼 class를 같이 넣어주는게 아니라
  • em.createNativeQuery(sql) 를 사용하면 된다.
  • 대신 이때 nativeQuery.getResultList() 는 Object 배열을 반환하므로
  • List<Object[]> 로 반환을 받아야한다.
  • 더욱 더 JDBC같이 생겼다.
• 결과 매핑 사용
  • 결과 매핑을 사용하면 엔티티 자체에 너무 많은 어노테이션 설정을 해야되므로 보편적으로 사용하지 않을 것 같다는 나의 생각이 들어있다.
  • 그래도 정리를 해보도록 하겠다.

String sql = "select M.ID, AGE, NAME, TEAM_ID, I.ORDER_COUNT FROM MEMBER M " +
"LEFT JOIN (SELECT IM.ID, COUNT(*) AS ORDER_COUNT FROM ORDERS O, MEMBER IM " +
"WHERE O.MEMBER_ID = IM.ID) I ON M.ID = I.ID";

Query nativeQuery = em.createNativeQuery(sql, "memberWithOrderCount");
List<Object[]> members = nativeQuery.getResultList();

아래는 매핑 정의 코드이다.

@Entity
@SqlResultSetMapping(name = "memberWithOrderCount",
    entities = {@EntityResult(entityClass = Member.class) },
    columns = {@ColumnResult(name = "ORDER_COUNT")}
}

• public class Member {...}
• id, age, name, team_id 는 Member 엔티티로 매핑을 시키고 order_count 는 단순 칼럼으로 매핑했다.
• 이렇게 여러 컬럼들을 매핑해서 추출할 수 있다.

참고로 nativeQuery는 entityManager에서도 jpaRepository에서도 전부 사용 가능.

• @Transactional

1. @Transactional 은 public 메소드에서만 정상 작동한다.
2. @Transactional 을 달아놓은 메소드가 동일한 클래스 내의 다른 메소드에 의해 호출된다면 트랜잭션이 정상 작동하지 않는다.

ex: 퍼사드 패턴이나 템플릿 패턴처럼 여러 메소드를 내부적으로 묶어 사용하고 있는 메소드가 있다면 구성요소 메소드에 @Transactional 를 달지 않고 구성요소를 묶고 있는 상위개념의 메소드에 @Transactional 을 달아주어야 한다. 구성요소 메소드에 @Transactional 을 달아 주어 트랜잭션으로 관리 할 경우 rollback 이 정상적으로 작동하지 않는 경우가 발생한다.

• propagation 속성이 required 인 경우, 트랜잭션안에서 호출되는 메소드가 트랜잭션으로 같이 묶이게 되어 예상치 못한 결과가 나올 수 있다는 내용이다.
• required propagation 속성은 트랜잭션이 이미 존재하면 append를 하고, 트랜잭션이 존재하지 않다면 새로 생성한다. (공식 doc)

1. Spring Transaction 은 기본적으로 unchecked Exception (RuntimeException) 만 관리하며 checked Exception (IOException, SQLException 등) 은 관리하지 않는다.

처리방법 1: @Transactional(rollbackFor=Exception.class) 와 같이 설정하여 모든 Exception 발생시 rollback 이 발생하게 처리하거나(unchecked Exception, checked Exception 모두 Exception.class 밑에 있다.)

처리방법 2: checked Exception 이 발생할 가능성이 있는 부분을 try ~ catch (SQLException se){throw new RuntimeException(); } 과 같이 처리(checked Exception 발생시 unchecked Exception 으로 예외를 바꾸어 던지게 처리)하여 Transaction의 관리대상으로 묶어버릴 수 있다.

1. pointcut 을 사용한 Transaction 설정과 어노테이션을 사용한 Transaction 설정을 동시에 사용하게 될 경우, 어노테이션이 우선적용(precedence)되는 것 같다. (https://stackoverflow.com/questions/32057910/custom-spring-aop-around-transactional/33509777#33509777)
2. Isolation

SQL 의 Isolation level 과 동일하게 동작 (SQL 격리수준 속성에 대한 자세한 내용은 이곳을 참고)

• READ_UNCOMMITED : commit 되지 않은 데이터를 읽는다
• READ_COMMITED : commit 된 데이터만 읽는다
• REPEATABLE_READ : 자신의 트랜잭션이 생성되기 이전의 트랜잭션(낮은 번호의 트랜잭션)의 커밋된 데이터만 읽는다
• SERIALIZABLE : LOCK 을 걸고 사용
• DEFAULT : 사용하는 DB 기본 설정을 따른다. (Oracle 은 READ_COMMITED, Mysql InnoDB 는 REPEATABLE_READ 가 Default)

1. Propagation

• REQUIRE : 부모 트랜잭션(자신을 호출한 메소드의 Transaction)이 존재한다면 그에 포함되어 동작. 부모 트랜잭션이 존재하지 않을 경우 새로 트랜잭션 생성(default 속성)
• SUPPORTS : 부모 트랜잭션이 존재하면 그에 포함되어 동작. 부모 트랜잭션이 없다면 트랜잭션 없이 동작.
• MANDATORY : 부모 트랜잭션이 존재하면 그에 포함되어 동작. 부모 트랜잭션이 없다면 예외 발생시킨다.
• REQUIRES_NEW : 부모 트랜잭션 존재 여부와 상관없이 트랜잭션을 새로 생성
• NOT_SUPPORTED : 트랜잭션을 사용하지 않는다. 부모 트랜잭션이 존재하면 보류시킨다.
• NEVER : 트랜잭션을 사용하지 않도록 강제한다. 부모 트랜잭션이 존재할 경우 예외를 발생시킨다.
• NESTED : 부모 트랜잭션이 존재하면 부모 트랜잭션 안에 트랜잭션을 만든다. 부모트랜잭션의 커밋과 롤백에 영향을 받지만 자신의 커밋과 롤백은 부모 트랜잭션에 영향을 주지 않는다.