JPA

10.08 (화)

1. domain

👉 하나의 도메인에 여러가지 엔티티들이 모여있다 (ex: 상품, 카테고리, 제조사 등)
👉 테이블 설계하는것처럼 설계하면 됨.
👉 모든 엔티티는 식별자가 있어야한다. (pk가 있으면 엔티티)

👉 간단한 파일 구조

1-1. ProductEntity

package org.zerock.apidemo.domain;

import jakarta.persistence.*;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;

@Entity
@Table(name = "tbl_product_ex")
@Getter
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class ProductEntity extends BaseEntity {

    @Id // 해당 jpa에서 pk값은 pno
    @GeneratedValue(strategy = GenerationType.IDENTITY) // autoIncrement로 자동 생성되는 pk
    private Long pno;

    @Column(nullable = false, length = 200) // not null, 200자
    private String pname;

    @Lob // 길이가 긴 문자열을 사용하고싶을때
    private String pdesc;

    private int price;

    @Builder.Default // Defalut 옵션
    private ProductStatus status =  ProductStatus.SALE;


    private boolean delFlag;


}

👉 productEntity에서는 db를 만드는 기본 base라고 생각하면된다. table이 pk가 있듯이 pno를 autoIncrement를 통해 pk로 생성 해주고, status 같은 경우에는 ProductStatus에서 SALE, NOT_SALE등 3가지 타입을 사용하므로 별도의 클래스로 생성해두었다.

---

1-2. ProductStatus

package org.zerock.apidemo.domain;

public enum ProductStatus { // status 관련 타입

    SALE, NOT_SALE, RESERVED; // db에서 출력시에 SALE, NOT_SALE로 뜨는게 아니라 0,1,2 의 순번대로 뜬다.
}

---

1-3. BaseEntity

package org.zerock.apidemo.domain;

import jakarta.persistence.EntityListeners;
import jakarta.persistence.MappedSuperclass;
import org.springframework.data.annotation.CreatedDate;
import org.springframework.data.annotation.LastModifiedDate;
import org.springframework.data.jpa.domain.support.AuditingEntityListener;

import java.time.LocalDateTime;

@MappedSuperclass
@EntityListeners(AuditingEntityListener.class) // 날짜 db에 출력
public abstract class BaseEntity { // 자동으로 갱신 되도록 날짜 클래스

    @CreatedDate
    private LocalDateTime createDate;

    @LastModifiedDate
    private LocalDateTime lastModifiedDate;
}

👉 해당 Entity는 날짜관련 Entity로 여러 엔티티에서 날짜관련 코드를 사용하므로 별도의 클래스로 빼서 사용하도록 만들었다.

---

1-4. repository

package org.zerock.apidemo.repository;

import org.springframework.data.jpa.repository.JpaRepository;
import org.zerock.apidemo.domain.ProductEntity;

public interface ProductRepository extends JpaRepository<ProductEntity, Long> { // id의 데이터타입을 맞춰서


}

👉 해당 repository는 JPA를 기반으로 DB에 쉽게 접근할수있도록 연결고리 같은 것인데, 우선 JpaRepository를 extends하여 내부에 사용가능한 CRUD, Paging기능들을 사용할 수 있다.

👉 ProductEntity의 pk값을 참고하여 작성된다.

---

2. Dirty checking

👉 JPA는 Entity를 메모리에서 관리하고, 이 상태를 영속성 컨텍스트(Persistence Context)라는 영역에 저장한다. 이때 엔티티의 속성이 변경되면 JPA가 어떤 부분이 변경이 되었는지 확인하여 DB와 같도록 동기화시킨다.

---

3. testCode

package org.zerock.apidemo.repository;

import lombok.extern.log4j.Log4j2;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.jdbc.AutoConfigureTestDatabase;
import org.springframework.boot.test.autoconfigure.orm.jpa.DataJpaTest;
import org.springframework.test.annotation.Commit;
import org.springframework.transaction.annotation.Transactional;
import org.zerock.apidemo.domain.ProductEntity;
import org.zerock.apidemo.domain.ProductStatus;

import java.util.Optional;
import java.util.stream.IntStream;

@DataJpaTest
@Log4j2
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
public class ProductTests {

    @Autowired
    ProductRepository repo;

    @Test
    @Transactional
    @Commit
    public void insertDummies() {

        IntStream.rangeClosed(1,100).forEach(i -> { // 100개의 더미데이터 생성
            ProductEntity entity = ProductEntity.builder()
                    .pname("Product" + i)
                    .pdesc("Product desc " + i)
                    .price(i)
                    .build();
            repo.save(entity);
        });
    }

    @Test
    @Transactional
    public void testRead() {
        Long id = 50L;

        Optional<ProductEntity> result = repo.findById(id);

        ProductEntity productEntity = result.orElse(null);

        log.info(productEntity);

    }

    @Test
    @Transactional
    @Commit
    public void testUpdate() {
        Long id = 50L;

        Optional<ProductEntity> result = repo.findById(id);

        ProductEntity productEntity = result.orElse(null);

        productEntity.changeStatus(ProductStatus.NOT_SALE);

    }

    @Test
    @Transactional
    @Commit
    public void insertOne() {

            ProductEntity entity = ProductEntity.builder()
                    .pname("Test Product")
                    .pdesc("Test Product desc ")
                    .price(3000)
                    .build();
            repo.save(entity);

            log.info(entity.getPno());
    }

}

---

4. Dirty checking 확인

@Test
    @Transactional
    @Commit
    public void testUpdate() {
        Long id = 50L;

        Optional<ProductEntity> result = repo.findById(id);

        ProductEntity productEntity = result.orElse(null);

        productEntity.changeStatus(ProductStatus.NOT_SALE);

    }

👉 해당코드를 간단하게 분석해보자면, id가 50번인 데이터 값의 상태를 Not_SALE로 변경하는것인데 이곳에서 중요한점이 두가지가있다. 우선 Hibernate에서 db값이 같은지 확인하기 위해 select문을 사용하고, 이후에 값이 다르다면 update를 통해서 상태를 변경해주는 쿼리를 작성한다.

👉 만약 update가 필요가 없다면 기존의 select문만 실행하게 되고 필요하다면 자동으로 update문까지 실행되는것이 중요한점이다. 두번째로 한번에 select와 update가 실행되어야하므로 @transactional이 무조건들어가줘야하고, update된 내용이 db에 반영되어야하므로 @Commit이 추가되어야한다.

---

5. paging

5-1. repository

package org.zerock.apidemo.repository;

import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;
import org.zerock.apidemo.domain.ProductEntity;

import java.util.List;

public interface ProductRepository extends JpaRepository<ProductEntity, Long> { // id의 데이터타입을 맞춰서

    @Query("select p from ProductEntity p where p.pname like %:keyword% ")
    Page<ProductEntity> getByPname(@Param("keyword")String keyword, Pageable pageable);
}

👉 reposiotry에서 @Query를 이용하여 해당키워드가 들어간 pname들을 출력하도록 만들기 위해서 이 처럼 작성하고

5-2. testCode

    @Test
    @Transactional
    public void testLike() {

        int page = 0;
        int size = 20;

        Pageable pageable = PageRequest.of(page,size, Sort.by("pno").descending());

        String keyword = "1";

       Page<ProductEntity> result = repo.getByPname(keyword, pageable);

       result.get().forEach( productEntity -> log.info(productEntity.getPno())) ;



    }

👉 page,size를 정해놓고, pageable을 of를 통해 만들어놓는다. 이후에 매개변수로 들어갈 keyword를 작성하여 repository의 메소드를 호출하여 출력한다.

---

6. index생성

👉 ProductEntity table생성시에 index를 정해주고싶다면

@Table(name = "tbl_product_ex", indexes = {
        @Index(name = "idx_product_sale", columnList = "status, pno") // 상태와 pno를 기준으로 하는 인덱스 생성, 하지만 order by 를 사용불가
})

👉 이 처럼 index를 정해준다.

    @Query("select p from ProductEntity p where p.pname like %:keyword% and p.status = 0 ")
    Page<ProductEntity> getByPname(@Param("keyword")String keyword, Pageable pageable);

👉 repository에도 인덱스를 어떻게 타고갈지 정해준다.

---

7. CORS

package org.zerock.apidemo.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebAPIConfig implements WebMvcConfigurer {
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                .allowedOrigins("*")
                .allowedMethods("HEAD","GET","POST","PUT","DELETE","OPTIONS")
                .maxAge(300)
                .allowedHeaders("Authorization", "Cache-Control","Content-Type");
    }
}