경희대학교 컴퓨터공학부 하계 리턴 백엔드(스프링부트) 스터디 4주차 - 트랙장 최현영

1. JPQL(JPA Query Language)

   1. JPA에서 사용할 수 있는 쿼리
   2. 엔티티 객체를 대상으로 수행하는 쿼리이기에 엔티티의 이름과 필드의 이름을 그대로 사용하여 쿼리문을 작성함

   select m from member m

   ⇒ 여기서 member는 엔티티 타입이고, m이라는 별칭으로 지정해 주었고, 해당 엔티티의 모든 필드를 출력하도록 JPQL을 작성하였다.

2. 쿼리 메서드 살펴보기

   1. JpaRepository 인터페이스는 상속만 해줘도 이미 정의되고 구현된 CRUD 메서드를 호출하여 사용할 수 있었다.

      1. 허나, 기본 식별자(PK)만으로 해당 엔티티를 가져오기 떄문에, 별도의 메서드를 정의해서 사용하는 경우가 많다.

   2. 이렇듯, 개발자의 입맛대로 쿼리문을 정의할 수 있도록 키워드 몇개를 조합하여 하나의 메서드를 생성할 수 있는데 이를 쿼리 메서드라고 부른다.

      1. 쿼리 메서드 작성은 Jpa리파지토리 인터페이스를 상속받은, 사용자 정의 인터페이스의 블록 내부에서 작성한다.

         

   3. 크게 동작을 결정하는 주제와 서술어로 구분한다.

      1. 3주차에서 FindById(Field field) 메서드를 살펴볼 때, 주제는 find가 되며, 서술언는 By 이후의 Id가 되겠다.
      2. 서술어 부분에 검색 및 정렬 조건을 지정할 수 있다.
      3. And 또는 Or를 접목하여 조건을 확장하는 것도 가능하다.

   리턴타입 { 주제 + 서술어}(대상 필드)

   List<Member> findByClub(String club)

   자세한 쿼리는 다음 기술 블로그를 참고

   https://velog.io/@codren/쿼리-메소드-Query-Method

3. 주제 키워드

   1. find(All)By…

      • 해당하는 친구좀 찾아줘
      • 조회를 수행하는 키워드

      //findBy...
      Optional<Member> findByName(Stirng name);
      Member findByClub(String club);
      List<Member> findAllByGeneration(String generation);
      

   b. existBy…

   • 존재하니?
   • 특정 데이터가 존재하는지 판별하는 키워드

   //existsBy...
   boolean existsByName(String name);
   

   c. countBy…

   • 갯수 좀 세줘
   • 쿼리 결과의 레코드 수를 반환

   Long countByGeneration(String generation);
   

   d. deleteBy

   • 삭제해줘

   • 삭제를 수행하는 쿼리

     void deleteById(Long Id); //반환값 없음
     

   e. …First<Number>… / …Top<Number> …

   • 몇 개만 추려줘

   • 쿼리를 통해 조회딘 결과값의 갯수를 제한함

   • Number는 몇개까지 조회할 것인지를 표현하는 것으로 오직 단일의 엔티티 인스턴스만 조회하고자 한다면 생략 가능

     List<Member> findFirst3ByGeneration(String generation); 
     //처음 상위 3건만 조회하고자 함
     List<Member> findTop5ByGeneration(String generation);
     //상위 5건만 조회하고자 함
     

   f. Distinct

   • 중복 제거

     List<Member> findDistinctByXXX();
     

4. 조건자 키워드

   1. Is / Equals
   • 값의 일치하는 친구들로 추려줘
   • 대개 생략됨

   //FindBy..와 동일하게 적용됨
   Member findByClubIs(String club); 
   Member findByClubEquals(String club);
   

   b. IsNot

   • 값의 불일치한 친구들로 추려줘

   Member findByClubIsNot(String club); 
   

   c. IsNull / IsNotNull

   • 값이 Null 인 친구들로만 추려줘 / Null이 아닌 친구들로 추려줘

   List<Member> findAllByClubIsNull(String club, String generation);
   List<Member> findAllByClubIsNotNull(String club);
   

   d. IsTrue / isFalse

   • 필드가 boolean으로 지정된 칼럼값이 참인지 거짓인지 알려줘

   e. And / Or

   • 여러 조건을 묶을 때 사용함

   f. IsGreaterThan(Equal)[after] / IsLessThan(Equal)[before] / IsBetween

   • 정수형이나 LocalDateTime 타입의 칼럼을 대상으로 비교 연산해주는 키워드
   • 이상/초과, 이하/미만, 사이값에 대한 비교 연산을 수행함

   g. IsStartingWith / IsEndingWith / IsContaining

   • IsStartingWith : 문자열의 앞부분으로 시작하는 친구들 가져와줘 ⇒ str%
   • IsEndingWith : 문자열의 끝부분으로 시작하는 친구들 가져와줘 ⇒ %str
   • IsContaining : 중간에 포함하고 있는 친구들 가져와줘 ⇒ %str%

5. Order By

   1. 정렬할 때 사용하는 키워드
   2. Asc : 오름차순
   3. Desc : 내림차순

   List<Member> findByClubOrderByGenerationAsc(String club);
   List<Member> findByClubOrderByGenerationDesc(String club);
   

   d. 여러 정렬 조건을 주고 싶다면 And와 Or 키워드는 사용하지 않음

   List<Member> findByClubOrderByGenerationAscStudentIdAsc(String club);
   List<Member> findByClubOrderByGenerationDescStudentIdDesc(String club)
   

   e. Sort 객체 및 Order 객체 활용 ⇒ 매개변수 쿼리 정렬

   • 위처럼 정렬 조건을 2개만 넣었는데 벌써부터 긴 줄로 나열 된 것이 어질어질하다. ⇒ 정렬 객체를 매개변수에 넣어줌으로써 간결하게 처리하자.

   //리파지토리 인터페이스 내
   List<Member> findByClub(String club, Sort sort);
   
   //서비스 클래스 내
   List<Member> members = memberRepository.findByName("RETURN", 
   																				Sort.by(Order.asc("generation"));
   
   //두개 이상의 정렬 조건인 경우 Sort.by(Order.by(~) , ...);
   

6. Page 및 Pageable

   • 페이징 : 레코드를 갯수로 나눠 페이지를 구분하는 것을 의미

   //리파지토리 인터페이스 내
   Page<Member> findByClub(String club, Pageable pageable);
   //반환값은 Page 타입로 두고, 입력 파라미터로 Pageable 타입으로 두자,
   
   //서비스 클래스 내
   Page<Member> memberPage = memberRepository.findByClub("RETURN",
   																					 PageReqeust.of(2,6));
   																					 
   																	
   

   • 여기서, Pageable의 구현체가 PageRequest 객체이다. of 메서드를 통해 객체를 생성한다.
   • 왼쪽 파라미터는 페이지의 번호를 의미하며, 오른쪽 파라미터는 페이지당 보여질 데이터의 갯수를 의미한다.
   • 세번째 파리미터로 Sort 타입을 사용할 수 있다.
   • 반환값은 getContent() 메서드를 통해 배열로 조작하여 엔티티들에게 접근할 수 있다.

7. @Query

   • 사용자가 직접 JPQL을 작성하여 메서드를 생성할 수 있다.
     • JPQL을 직접 사용하면 JPA가 알아서 sql로 변환해준다.
   • 이처럼 활용 가능하다.

   @Query("SELECT m FROM MEMBER AS m WHERE m.club = :club")
   List<Member> findByClub(@Param("club") String club);
   

   ⇒ AS 문을 통해 Member 엔티티를 m이라는 별칭을 두었다.

   ⇒ @Query 어노테이션의 JPQL 중, 조건문에서 ‘:’ 은 이름 기반으로 입력 파라미터의 값을 가져오기 위한 파리미터 바인딩을 해주는 문법에 해당한다. 즉, club이라는 입력 파라미터에 “RETURN”이라는 문자열이 들어오면 @Param에 정의한 club에 바인딩하라고 지시하고, ‘:club’에 “RETURN”을 대입하는 것이다.

   • Select 문 내에서 ‘m.필드’로 두어 특정 필드만 추출할 수 있다.

8. 연관관계

• 1:1

• 1:N

• N:1

• N:M

• 데이터베이스에서는 두 테이블의 연관관계를 설정하면 외래키만으로 서로 조인(JOIN)을 통해 참조하는 구조로 생성되지만, JPA를 사용하는 객체지향 모델링에서는 엔티티 간 참조 방향을 설정할 수 있다.

  • 단방향 : 두 엔티티 관계에서 한쪽의 엔티티만 참조하는 형식
  • 양방향 : 두 엔티티의 관계에서 각 엔티티가 서로의 엔티티를 참조하는 형식

  ⇒ 한 테이블에서 다른 테이블의 기본값을 외래키로 가지게 된다. → 외래키를 가지는 테이블이 그 관계에서 주인이 된다.

  • 주인 엔티티는 외래키를 사용할 수 있으나, 상대 엔티티는 읽기만 가능하다.

8.1 applicatoin.yml에서 opne-in-view 옵션을 false로 설정하자[매우 중요]

jpa:
    hibernate:
      ddl-auto: create
    properties:
      hibernate:
        show_sql: true
        format_sql: true
    **open-in-view: false**

• 스프링 OSIV의 사용을 안하겠다는 뜻인데, 기본값은 true로 되어 있다. OSIV는 프레젠테이션 계층에도 영속성 컨텍스트를 열어두는 기능이다. 영속성 컨텍스트가 유지되면 엔티티도 영속 상태로 유지된다. 뷰[컨트롤러 레이어]까지 영속성 컨텍스트가 살아있다면 뷰에서도 지연 로딩을 사용할 수가 있다. ⇒ 허나, 우리는 필요없다.

1. 1:1 (단방향)

   1. 하나의 엔티티에 하나의 엔티티만 매핑되는 구조
   2. 현재 Member 라는 엔티티가 존재하니, 회원의 상세 정보 엔티티를 하나 더 만들어서 1:1 매핑을 시켜보자.

   package com.rebe.returnstudy.Entity;
   
   import jakarta.persistence.*;
   import lombok.*;
   
   @Entity
   @Getter
   @Setter
   **@ToString //추가해 주자**
   @NoArgsConstructor
   @AllArgsConstructor
   public class Member {
   ..
   
   

   package com.rebe.returnstudy.Entity;
   
   import jakarta.persistence.*;
   import lombok.*;
   
   @Entity
   @Getter
   @Setter
   @ToString
   @NoArgsConstructor
   @AllArgsConstructor
   public class MemberDetails {
       @Id
       @GeneratedValue
       private Long id;
   
       @Column(unique = false, nullable = false)
       private String email;
   
       @Column(unique = false, nullable = false)
       private String phoneNumber;
   
       @Column(nullable = true, length = 255)
       private String StatusMsg;
   
       @Column
       private boolean isActive;
   
       **@OneToOne
       @JoinColumn(name = "member_id")
       private Member member;**
   }
   

   • @OneToOne

     • 1:1 연관관계로 매핑하기 위해 사용된다.

     

     • fetch

       

       • LAZY
         • Member 엔티티는 프록시 객체[실제 객체인척 시늉하는 모의 객체]로 가져온다.
         • 실제 Member 객체를 사용하는 시점에 초기화가 된다. DB에 쿼리가 나간다.
           • getMember()으로 Member 객체를 조회하면 프록시 객체가 조회가 된다.
           • getMember().getGeneration()으로 Member의 기수라는 필드에 접근 할 때, 쿼리가 나간다.
       • EAGER

     • optional

     • mappedBy

   • @JoinColumn

   package com.rebe.returnstudy.Repository;
   
   import com.rebe.returnstudy.Entity.MemberDetails;
   import org.springframework.data.jpa.repository.JpaRepository;
   
   public interface MemberDetailsRepository extends JpaRepository<MemberDetails, Long> {
   }
   
   ----
   
   package com.rebe.returnstudy.Service;
   
   import com.rebe.returnstudy.Entity.Member;
   import com.rebe.returnstudy.Entity.MemberDetails;
   import com.rebe.returnstudy.Repository.MemberDetailsRepository;
   import com.rebe.returnstudy.Repository.MemberRepository;
   import lombok.RequiredArgsConstructor;
   import lombok.extern.slf4j.Slf4j;
   import org.springframework.stereotype.Service;
   
   @Service
   **@RequiredArgsConstructor**//final 한정자로 된 필드를 의존성 주입하기 위해 어노테이션 추가
   **@Slf4j**//로그 출력을 위해 사용될 어노테이션 추가
   public class MemberDetailsService {
       private final MemberRepository memberRepository;
       private final MemberDetailsRepository memberDetailsRepository;
   		
   		public void OneToOne(){
           Member member = new Member();
           member.setStudentId(2019102236);
           member.setName("최현영");
           member.setGeneration("32nd");
           member.setClub("RETURN");
           memberRepository.save(member);
   
           MemberDetails memberDetails = new MemberDetails();
           memberDetails.setMember(member); //위에서 저장한 member 인스턴스를 setter 메서드로 할당
           memberDetails.setActive(true);
           memberDetails.setEmail("[email protected]");
           memberDetails.setPhoneNumber("01095026088");
           memberDetails.setStatusMsg("날씨 미친거 아님? 너무 덥다.");
           memberDetailsRepository.save(memberDetails);
   
           log.info("saved Member Entity" + memberDetailsRepository.findById(memberDetails.getId())
                   .get().getMember());
   
           log.info("saved Member Details Entity : " + memberDetailsRepository.findById(memberDetails.getId())
                   .get());
       }
   }
   
   ----
   
   package com.rebe.returnstudy.Controller;
   
   import com.rebe.returnstudy.Service.MemberDetailsService;
   import lombok.RequiredArgsConstructor;
   import org.springframework.web.bind.annotation.GetMapping;
   import org.springframework.web.bind.annotation.RestController;
   
   @RestController
   @RequiredArgsConstructor
   public class OneToOneController {
   
   		private final MemberDetailsService memberDetailsService;
       
       @GetMapping("/one-to-one")
       public void OneToOneTest(){
           memberDetailsService.OneToOne();
       }
   
   }
   

   

   

   

   

   단방향 매핑이기 때문에 외래키를 관리하지 않는다.

   

   외래키를 관리하고 있다.

2. 1:1 (양방향)

3. N:1

4. 1:N

5. N:M

6. 영속성 전이[CasCade]

7. 고아[Orphan]