[Spring Boot] Spring Data JPA (1)

---

1.  Spring Data JPA

JDBC에서 작업하다가 MyBatis를 배울 경우에는 SQL 작성법도 거의 동일하고, 코드의 간략화가 목표여서 러닝커브가 높지 않지만
JPA의 경우에는 JDBC, MyBatis와는 사용방법이 상당한 차이가 있고, 추상적인 개념이 많이 포함이 되어서 러닝커브가 상당히 높음.

그리고 SQL문을 직접 만드는 것보다 JPA가 만드는 SQL의 효율이 떨어진다거나, 동일한 작업인데 JPA가 더 많은 SQL문을 사용하는 비효율성이 존재. 하지만 MSA 방식으로 애플리케이션을 설계하는 경향이 높아짐에 따라, JPA를 사용하는 작업이 많아짐.

1)  ORM / JPA

우리가 사용하는 대부분의 프로그램은 사용자가 입력한 데이터나 비지니스 로직 수행 결과로 얻은 데이터를 재사용할 수 있도록 데이터베이스에 저장을 함. 하지만 자바의 객체와 데이터베이스의 테이블이 정확하게 일치하지는 않음. 따라서 둘 사이를 매핑하기 위해서 많은 SQL 구문과 자바 코드가 필요해짐.

💡  ORM은 정확하게 일치하지 않는 자바 객체와 테이블 사이를 매핑 

  ✓  자바 객체에 저장된 데이터를 테이블의 Row 정보로 저장하고. 반대로 테이블에 저장된 Row 정보를 자바 객체로 매핑

  ✓  이 과정에서 사용되는 SQL 구문과 자바 코드를 ORM 프레임워크가 자동으로 만들어줌.

어떤 DB 연동 기술이나 프레임워크를 사용하더라도 SQL 명령어를 자바 클래스나 외부의 XML 파일에 작성해야 함. 그리고 작성된 SQL은 유지보수 과정에서 지속적으로 수정되며 새로운 SQL이 추가되기도 함.

 

💡  ORM 프레임워크의 가장 큰 특징이자 장점은 DB 연동에 필요한 SQL을 자동으로 생성
  ✓  이렇게 생성된 SQL은 DBMS가 변경될때 자동으로 변경이 됨

        ➡️  다만 ORM 환경 설정 파일에서 DBMS가 변경된 것을 알려주어야 함

 

ORM ; Object Relational Mapping
객체 관계 매핑

• 자바와 같은 객체지향 언어에서 의미하는 객체와 RDB Relational Database 의 테이블을 자동으로 매핑하는 방법
• 클래스는 데이터베이스의 테이블과 매핑하기 위해 만들어진 것이 아니기 때문에 RDB 테이블과의 불일치가 존재
• ORM이 이 둘의 불일치와 제약사항을 해결하는 역할. ORM을 이용하면 쿼리문 작성이 아닌 코드(메서드)로 데이터를 조작할 수 있음

 

JPA ; Java Persistence API

• 자바 진영의 ORM 기술 표준으로 채택된 인터페이스 모음
• ORM이 큰 개념이라면 JPA는 더 구체화된 스펙을 포함. 즉, JPA 또한 실제로 동작하는 것이 아니고 어떻게 동작해야 하는지 매커니즘을 정리한 표준 명세
• JPA를 구현한 대표적인 구현체로 Hibernate, EclipseLink, DataNucleus, OpenJpa 등이 있음
• JPA 인터페이스를 구현한 가장 대표적인 오픈소스가 Hibernate이고 실질적인 기능은 하이버네이트에 구현되어 있음

 

Spring Data JPA

• JPA를 편리하게 사용할 수 있도록 지원하는 스프링 하위 프로젝트 중 하나
• CRUD 처리에 필요한 인터페이스를 제공하며, 하이버네이트의 엔티티 매니저를 직접 다루지 않고 repository를 정의해 사용함으로써 스프링에 적합한 쿼리를 동적으로 생성하는 방식으로 데이터베이스를 조작
• 이를 통해 하이버네이트에서 자주 사용되는 기능을 더 쉽게 사용할 수 있게 구현한 라이브러리

 

JPA 사용 시 장점

    A.  특정 데이터베이스에 종속되지 않음

        ✓  오라클을 MariaDB로 변경한다면 데이터베이스마다 쿼리문이 다르기 때문에 전체를 수정해야 함. 따라서 처음 선택한 데이터베이스를 변경하기 어려움. 하지만 JPA는 추상화한 데이터 접근 계층을 제공함. 설정 파일에 어떤 데이터베이스를 사용하는지 알려주면 얼마든지 데이터베이스를 변경할 수 있음

    B.  객체지향적 프로그램

      ✓  데이터베이스 설계 중심의 패러다임에서 객체지향적으로 설계가 가능. 이를 통해 좀 더 직관적이고 비지니스 로직에 집중

    C.  생산성 향상

 

      ✓  데이터베이스 테이블에 새로운 컬럼이 추가 되었을 경우, 해당 테이블의 컬럼을 사용하는 DTO 클래스의 필드도 모두 변경해야 함.
      ✓  JPA에서는 테이블과 매핑된 클래스에 필드만 추가한다면 쉽게 관리가 가능. 또한 SQL문을 직접 작성하지 않고 객체를 이용하여 동작하기 때문에 유지보수 측면에서 좋고 재사용성도 증가.

 

JPA 사용 시 단점

    A.  복잡한 쿼리 처리

      ✓  통계 처리 같은 복잡한 쿼리를 사용할 경우는 SQL문을 사용하는 것이 나을 수 있음
      ✓  JPA에서는 Native SQL을 통해 기존의 SQL문을 사용할 수 있지만 그러면 특정 데이터베이스에 종속된다는 단점이 생김. 이를 보완하기 위해서 SQL과 유사한 기술인 JPQL, Querydsl을 지원.

    B.  성능 저하 위험

      ✓  객체 간의 매핑 설계가 잘못했을 때 성능 저하가 발생할 수 있으며, 자동으로 생성되는 쿼리가 많기 때문에 개발자가 의도하지 않은 쿼리로 인해 성능이 저하되기도 함.

    C.  학습 시간

      ✓  JPA를 제대로 사용하려면 알아야 할 것이 많아서 학습하는데 시간이 오래 걸림.

---

 

2)  엔티티

엔티티 Entity 란 데이터베이스의 테이블에 대응하는 클래스. @Entity가 붙은 클래스는 JPA에서 관리하며 엔티티라고 함.
클래스 자체나 생성한 인스턴스도 엔티티라 부름.

 

엔티티 매니저 팩토리  Entity Manager Factory

• 엔티티 매니저 인스턴스를 관리하는 주체
• 애플리케이션 실행 시 한 개만 만들어지며 사용자로 부터 요청이 오면 엔티티 매니저 팩토리로 부터 엔티티 매니저를 생성.

엔티티 매니저  Entity Manager

• 영속성 컨텍스트에 접근하여 엔티티에 대한 데이터베이스 작업을 제공
• 내부적으로 데이터베이스 커넥션을 사용해서 데이터베이스에 접근

영속성 컨텍스트  Persistence Context

• 엔티티를 영구 저장하는 환경으로 엔티티 매니저를 통해 영속성 컨텍스트에 접근

 

---

2.  Board 엔티티와 JpaRepository

JPA를 이용하는 개발의 핵심은 객체지향을 통해서 영속 계층을 처리하는데 있음. 따라서 JPA를 이용할 때는 테이블과 SQL을 다루는 것이 아니라 데이터에 해당하는 객체를 엔티티 객체로 다루고 JPA로 이를 데이터베이스와 연동해서 관리. 엔티티 객체는 쉽게 말해서 PK 기본키를 가지는 자바의 객체. 엔티티 객체는 고유의 식별을 위해 @Id를 이용해서 객체를 구분하고 관리

Spring Data JPA는 엔티티 객체를 이용해서 JPA를 이용하는데 더욱 편리한 방법들을 제공하는 스프링 관련 라이브러리. 자동으로 객체를 생성하고 이를 통해서 예외 처리 등을 자동으로 처리하는데 이를 위해서 제공되는 인터페이스가 JpaRepository.

💡  개발의 첫 단계은 엔티티 객체를 생성하기 위한 엔티티 클래스를 정의하는 것

 

프로젝트에 domain 패키지를 구성하고 게시물을 위한 Board 엔티티를 작성

@Entity
public class Board {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long bno;

    private String title;

    private String content;

    private String writer;
}

 

  🥸  엔티티 객체를 위한 엔티티 클래스는 반드시 @Entity를 적용해야 하고 @Id가 필요
  🥸  게시물은 데이터베이스에 추가될 때 생성되는 번호 auto increment 를 이용할 것이므로 이런 경우에 '키 생성 전략 key generate strategy 중에 GenerationType.IDENTITY로 데이터베이스에서 알아서 결정하는 방식을 이용

  🚀  GenerationType.IDENTITY : 데이터베이스에 위임(MYSQL / MariaDB) - auto_increment

---

1) @MappedSuperclass를 이용한 공통 속성 처리

  👾  데이터베이스의 거의 모든 테이블에는 데이터가 추가된 시간이나 수정된 시간 등의 컬럼을 작성
  👾  자바에서는 이를 쉽게 처리하고자 @MappedSuperclass를 이용해서 공통으로 사용되는 칼럼들을 지정하고 해당 클래스를 상속해서 이를 손쉽게 처리.

 

프로젝트의 domain 패키지에 BaseEntity 클래스를 추가

@MappedSuperclass
@EntityListeners(value = {AuditingEntityListener.class})
@Getter
public class BaseEntity {
    @CreatedDate
    @Column(name = "regdate", updatable = false)
    private LocalDateTime regDate;

    @LastModifiedDate
    @Column(name = "moddate")
    private LocalDateTime modDate;

}

 

  🥸  BaseEntity에서 가장 중요한 부분은 자동으로 Spring Data JPA의 AuditingEntityListener를 지정하는 부분

  🥸  AuditingEntityListener는 리스너로 이를 적용하면 엔티티가 데이터베이스에 추가되거나 변경될 때 자동으로 시간 값을 지정

 

AuditingEntityListener를 활성화 시키기 위해서는 프로젝트 설정에 @EnableJpaAuditing을 추가

@SpringBootApplication
@EnableJpaAuditing
public class SpringbootApplication {
	public static void main(String[] args) {
		SpringApplication.run(SpringbootApplication.class, args);
	}
}

 

기존의 Board 클래스는 BaseEntity를 상속하도록 변경하고 추가적인 어노테이션들을 적용

@Entity
@Getter
@Builder
@AllArgsConstructor
@NoArgsConstructor
@ToString
public class Board extends BaseEntity {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long bno;

    @Column(length = 500, nullable = false) // 컬럼의 길이와 null 허용 여부
    private String title;

    @Column(length = 2000, nullable = false)
    private String content;

    @Column(length = 50, nullable = false)
    private String writer;
    
}

 

---

2)  JpaRepository 인터페이스

  👾  Spring Data JPA 를 이용할 때는 JpaRepository라는 인터페이스 선언만으로 데이터베이스 관련 작업을 어느 정도 처리할 수 있음
  👾  개발 단계에서 JpaRepository 인터페이스를 상속하는 인터페이스를 선언하는 것 만으로 CRUD외 페이징 처리가 모두 완료

 

repository 패키지를 생성하고 BoardRepository 인터페이스를 선언

public interface BoardRepository extends JpaRepository<Board, Long> {}

 

  🥸  JpaRepositoy 인터페이스를 상속할 때에는 엔티티 타입과 @Id 타입을 지정해 주어야 하는 점을 제외하면 아무런 코드가 없이도 개발 가능

 

---

3)  테스트 코드를 통한 CRUD / 페이징 처리 확인

  👾  Spring Data JPA를 이용하면 SQL의 개발도 거의 없고, JPA의 많은 기능을 활용 할 수 있지만 항상 테스트 코드로 동작 여부를 확인하는 것이 좋음

 

프로젝트에 test에 repository 패키지를 추가하고 BoardRepositoryTests 클래스를 추가

@SpringBootTest
@Log4j2
public class BoardRepositoryTests {
    @Autowired
    private BoardRepository boardRepository;
}

---

 

insert 기능 테스트

  ✓  데이터베이스에 insert를 실행하는 기능은 JpaRepository의 save()를 통해서 이루어짐
  ✓  save()는 현재의 영속 컨텍스트 내에 데이터가 존재하는지 찾아보고 해당 엔티티객체가 없을 때는 insert를, 존재할 때는 update을 자동으로 실행

    @Test
    public void testInsert() {
        for (int i = 1; i <= 100; i++) {
            Board board = Board.builder()
                    .title("title...")
                    .content("content..." + i)
                    .writer("user" + (i % 10))
                    .build();
            Board result = boardRepository.save(board);
            log.info("BNO: " + result.getBno());
        }
    }

 

 

  📍  save()의 결과는 데이터베이스에 저장된 데이터와 동기화된 Board 객체가 반환
  📍  최종적으로 테스트 실행 후에 데이터베이스를 조회해 보면 100개의 데이터가 생성된 것을 확인
  📍  테스트 코드의 경우 @Id 값이 null 이므로 insert만 실행. (update와 비교)

 

 

 

 

 

---

 

select 기능 테스트

  ✓  특정한 번호의 게시물을 조회하는 기능은 findById()를 이용해서 처리. findById()의 리턴 타입은 Optional<T>

    @Test
    public void testSelect() {
        Long bno = 100L; // 조회하고자 하는 bno 번호
        Optional<Board> result = boardRepository.findById(bno);
        Board board = result.orElseThrow();
        log.info(board);
    }

---

 

update 기능 테스트

  ✓  update 기능은 insert와 동일하게 save()를 통해서 처리. 동일한 @Id 값을 가지는 개체를 생성해서 처리가능.
  ✓  update는 등록 시간이 필요하므로 가능하면 findById()로 가져온 객체를 이용하여 약간의 수정을 통해서 처리하도록 함
  ✓  일반적으로 엔티티 객체(Board 클래스)는 가능하면 최소한의 변경이나 변경이 없는 immutable로 설계하는 것이 좋지만, 강제적인 사항은 아니므로 Board 클래스에 수정이 가능한 부분을 미리 메서드로 설계

  📍  Board의 경우 '제목 / 내용'은 수정이 가능하므로 이에 맞도록 change() 라는 메서드를 추가

public void change(String title, String content) {
    this.title = title;
    this.content = content;
}

 

  📍  테스트 코드에서는 이를 활용하여 update를 실행하는 테스트 코드를 작성

@Test
public void testUpdate() {
    Long bno = 100L;
    Optional<Board> result = boardRepository.findById(bno);
    Board board = result.orElseThrow();

    board.change("update... title 100", "update content 100");
    boardRepository.save(board);
}

 

findById 실행 ▶️ save()실행 시 다시 검사 ▶️ update 실행

 

  ⚡️  update가 실행된 후에 moddate가 변경된 것 확인
  ⚡️  변경할 부분을 sql에서 set로 지정하는 것이 아니라, 객체를 영속성 콘텍스트에 올리면 @Id와 동일한 데이터를 찾아 매핑을 하는 개념이어서 수정할 부분만 엔티티 객체에 넣으면 안되고, 데이터베이스에 저장되어야 하는 데이터와 동일한 엔티티 객체가 필요함

 

  📍  JDBC나 MyBatis 방식으로 처리하면 에러

   @Test
    public void testUpdate2() {

        Long bno = 100L;
        Board board = Board.builder()
                .bno(bno)
                .title("title...")
                .content("content...update3")
                .build();
        boardRepository.save(board);
    }

 

  📍  없는 @Id 값을 지정하면 update가 아니라 insert가 실행

   @Test
    public void testUpdate3() {

        Long bno = 10000L;
        Board board = Board.builder()
                .bno(bno)
                .title("title...")
                .content("content...update")
                .build();
        boardRepository.save(board);
    }

---

 

delete 기능 테스트

  ✓ delete는 @Id에 해당하는 값으로 deleteById()를 통해서 실행

  ✓  deleteById() 역시 데이터베이스의 내부에 같은 @Id가 존재하는지 먼저 확인하고 delete문이 실행

@Test
public void testDelete() {
    Long bno = 1L;
    boardRepository.deleteById(bno);
}

 

---

 

수정이나 삭제 시에 굳이 select문이 먼저 실행되는 이유는 JPA의 동작 방식과 관련. JPA를 이용한다는 것은 엄밀하게 말하면 영속 컨텍스트와 데이터베이스를 동기화해서 관리한다는 의미. 그러므로 특정한 엔티티 객체가 추가되면 영속 컨텍스트에 추가하고, 데이터베이스와 동기화가 이루어짐. 마찬가지로 수정이나 삭제를 한다면 영속 컨텍스트에 해당 엔티티 객체가 존재해야만 하므로 먼저 select로 엔티티 객체를 영속 컨텍스트에 저장해서 이를 삭제한 후에 delete가 이루어짐.

---

4)  Pageable과 Page<E> 타입

  👾  Spring Data JPA를 이용해서 별도의 코드 없이도 CRUD가 실행되지만, 페이징 처리도 가능
  👾  페이징 처리는 Pageable이라는 타입의 객체를 구성해서 파라미터로 전달하면 됨.
  👾  Pageable은 인터페이스로 설계되어 있고, 일반적으로는 PageRequest.of()라는 기능을 이용해서 개발이 가능.

PageRequest.of(페이지 번호, 사이즈) : 페이지 번호은 0부터
PageRequest.of(페이지 번호, 사이즈, Sort) : 정렬 조건 추가
PageRequest.of(페이지 번호, 사이즈, Sort.Direction, 속성...) : 정렬 방향과 여러 속성 지정

 

  ⚡️  파라미터로 Pageable을 이용하면 리턴 타입은 Page<T> 타입을 이용할 수 있는데 이는 단순 목록뿐 아니라 페이징 처리에 데이터가 많은 경우에는 count 처리를 자동으로 실행
  ⚡️  대부분의 Pageable 파라미터는 메서드 마지막에 사용하고, 파라미터에 Pageable이 있는 경우에는 메서드의 리턴 타입을 Page<T> 타입으로 설계.

 

JpaRepository에는 findAll()이라는 기능을 제공하여 기본적인 페이징 처리를 지원

@Test
public void testPaging() {
    // 1 page order by bno desc
    Pageable pageable = PageRequest.of(0, 10, Sort.by("bno").descending());
    Page<Board> result = boardRepository.findAll(pageable);
}

 

 

  ✓  findAll()의 리턴 타입으로 나오는 Page<T> 타입은 내부적으로 페이징 처리에 필요한 여러 정보를 처리
  ✓  예를 들어 다음 페이지가 존재하는지, 이전 페이지가 존재하는지, 전체 데이터의 개수는 몇 개인지 등의 기능들을 모두 알아낼수 있음

    @Test
    public void testPaging() {
        // 1 page order by bno desc
        Pageable pageable = PageRequest.of(0, 10, Sort.by("bno").descending());
        Page<Board> result = boardRepository.findAll(pageable);

        log.info("total count : " + result.getTotalElements());
        log.info("total page : " + result.getTotalPages()); 
        log.info("page number : " + result.getNumber());
        log.info("page size : " + result.getSize());

        // prev next
        log.info(result.hasPrevious() + ": " + result.hasNext());

        List<Board> boardList = result.getContent();

        boardList.forEach(board -> log.info(board));
    }

 

---

5)  쿼리 메서드와 @Query

  👾  간단한 CRUD는 JpaRepository를 이용하면 되지만 다양한 검색 조건이 들어가게 되면 추가 기능이 필요하게 됨
  👾  예를 들어 특정한 범위의 Memo 객체를 검색하거나, like 처리가 필요한 경우, 여러 검색 조건이 필요한 경우 등

💡  Spring Data JPA의 경우에는 이러한 처리를 위해 다음과 같은 방법을 제공
    ·  쿼리 메서드 : 메서드의 이름 자체가 쿼리의 구문으로 처리되는 기능.
    ·  @Query : SQL과 유사하게 엔티티 클래스의 정보를 이용해서 쿼리를 작성하는 기능. JPQL.
    ·  Querydsl 등의 동적 쿼리 기능

  ⚡️  쿼리 메서드는 보통 SQL에서 사용하는 키워드와 컬럼들을 같이 결합해서 구성하면 그 자체가 JPA에서 사용하는 쿼리가 되는 기능
        -  일반적으로는 메서드 이름을 'findBy...' 혹은 'get...'으로 시작하고 칼럼명과 키워드를 결합하는 방식으로 구성
            (각 키워드 사용법은 https://spring.io/projects/spring-data-jpa 참고)
        -  인텔리제이 얼티메이트에서는 자동완성 기능으로 쿼리 메서드를 작성할 수 있는 기능을 지원
        -  쿼리 메서드는 실제로 사용하려면 상당히 길고 복잡한 메서드를 작성하게 되는 경우가 많음
             ➡️  예를 들어 '제목'에 특정한 '키워드'가 존재하는 게시글들을 bno의 역순으로 정렬해서 가져오고 싶다면 아래의 메소드 이름이 생성

          ✓  쿼리 메서드는 주로 단순한 쿼리를 작성할 때 사용하고 실제 개발에서는 많이 사용되지 않음

Page<Board> findByTitleContainingOrderByBnoDesc(String keyword, Pageable pageable);

    
  ⚡️  @Query로 JPQL을 이용
      -  @Query 어노테이션의 value로 작성하는 문자열을 JPQL이라고 하는데 JPQL은 SQL과 유사하게 JPA에서 사용하는 쿼리 언어 query language 라고 생각하면 됨
      -  JPA는 데이터베이스에 독립적으로 개발이 가능하므로 특정한 데이터베이스에서만 동작하는 SQL 대신에 JPA에 맞게 사용하는 JPQL을 이용. JPQL은 테이블 대신에 엔티티 타입을 이용하고 컬럼 대신에 엔티티의 속성으로 이용해서 작성. JPQL은 SQL을 대신하는 용도로 사용하기 때문에 SQL에 존재하는 여러 키워드나 기능들이 거의 유사하게 제공.

 

  📍 앞선 쿼리 메서드에 @Query를 이용한다면 다음과 같이 작성

@Query("select b from Board b where b.title like concat('%', :keyword, '%')")
Page<Board> findKeyword(String keyword, Pageable pageable);

 

  ✓  작성된 JPQL을 보면 SQL과 상당히 유사하다는 것을 알 수 있음
  ✓  @Query를 이용하면 크게 쿼리 메서드가 할 수 없는 몇 가지 기능을 할 수 있음
        * 조인과 같이 복잡한 쿼리를 실행할 수 있는 기능
        * 원하는 속성들만 추출해서 Object[]로 처리하거나 DTO로 처리하는 기능
        * nativeQuery 속성값을 true로 지정해서 특정 데이터베이스에서 동작하는 SQL을 사용하는 기능

  📍  native 속성을 지정하는 예제는 다음과 같이 작성 가능

@Query(value="select now()", nativeQuery=true)
String getTime();

 

 

 

 

 

[ 내용 참고 : IT 학원 강의 ]