UMC 스프링 6주차 & 7주차 정리 및 실습

그린·2023년 11월 6일

UMC 5기

목록 보기

3/6

프로젝트 세팅

https://start.spring.io/에서
아래와 같이 설정해주었다.

java 11, spring boot 2.7을 사용할 예정이라 아래와 같이 설정해주었다.

프로젝트 구조

Converter 패키지

데이터 형식 간의 변환을 수행하는 역할
repository에서 받아온 엔티티를 dto로 바꾸는 과정을 converter에서 하게 된다.
추가로 entity의 생성 역시 converter에서 수행하기도 한다.

converter에서 entity의 생성을 하지 않고 service에서 하도록 하는 경우도 있지만,
converter에서 엔티티의 생성을 하게 되면, service는 순수하게 비즈니스 로직에만 집중할 수 있어 단일 책임 원칙 측면에서 더 좋다.

converter의 사용 위치

service에서 dto 생성

service에서 converter를 통해 dto를 controller에게 리턴 해주는 것
controller에서는 그저 dto를 응답으로 주기만 해도 된다
controller에 엔티티가 노출되지 않아 보안적인 측면에서 도움이 된다
엔티티에 민감한 정보가 있는 경우, 권한이 있는 개발자만 엔티티에 담긴 데이터를 보고, dto로 데이터를 걸러서 컨트롤러로 리턴을 하여, 컨트롤러를 작업하는 사람은 민감한 정보를 볼 수 없게 할 수 있다.

controller에서 dto 생성

service에서 entity를 리턴하고, controller에서 converter를 통해 dto를 만들어서 응답을 주기도 한다.
service의 함수가 범용성이 커져 유지보수가 편해진다.
동일한 엔티티를 필요로 하는 여러 컨트롤러, 혹은 validation을 위한 어노테이션에서 서비스의 함수를 재활용 할 수 있어 코딩이 더 편해진다.

실습 진행

로컬 DB를 만들어서 진행했다.

인텔리제이 프로젝트로 돌아와서, application.properties 파일은 지우고, 대신 application.yml 파일을 만들어서 아래와 같이 입력한다.

domain 패키지에서 엔티티 만들기

User 엔티티를 만들어주었다.

이때, domian 패키지 안에 enums 패키지를 만들어 Gender, SocialType(가입 연동 소셜 SNS 타입), UserStatus(탈퇴 등 여부) 에 대한 enum 타입을 지정해주었다.

그 외에도 아래 사진과 같이 다른 기본 엔티티들을 만들어주었다.

BaseEntity에서는 Created_at, Updated_at을 속성으로 두어 모든 엔티티 클래스에서 상속하도록 설정했다.

등등 다 적용해줌!

그리고 Spring boot Application 자체도 JpaAuditing사용이 가능하도록 변경을 해줘야 한다.

매핑 테이블의 설계

매핑 테이블은 따로 패키지에 모아서 관리하는 것이 보기에 편하다고 한다.
아래 사진과 같이 mapping 패키지를 만들어 그 안에 N:M 관계로 파생된 테이블에 대한 엔티티들을 생성해주었다.

연관 관계 매핑

연관관계의 주인 : 실제 데이터베이스에서 외래키를 가지는 엔티티(테이블)
단방향 매핑 : 단방향 매핑이란 연관 관계 주인에게만 연관 관계를 주입하는 것
양방향 매핑 : 양방향 매핑은 연관 관계 주인이 아닌 엔티티에게도 연관 관계를 주입하는 것
양방향 매핑을 사용하게 될 경우 버그가 생길 위험이 있지만,
양방향 매핑으로 인한 객체 그래프 탐색은 프로그래밍을 굉장히 편리하게 해준다고 한다.

아래와 같은 테이블 매핑 관계에서,
FoodOfUser 테이블의 경우 User와 food 모두에 대한 외래키를 갖고 있다.

1 : N의 경우 N에 해당하는 테이블이 외래키를 가지며 N에 해당하는 엔티티가 연관 관계의 주인이다.
1 : 1의 경우는 둘 중 하나만 외래키를 가지면 되기에 원하는 엔티티를 연관 관계 주인으로 설정하면 된다.

FoodOfUser 엔티티에 연관 관계 매핑을 해보자.

package umc.spring.domain.mapping;

import lombok.*;
import umc.spring.domain.Food;
import umc.spring.domain.User;
import umc.spring.domain.common.BaseEntity;

import javax.persistence.*;

@Entity
@Getter
@Builder
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@AllArgsConstructor
public class FoodOfUser extends BaseEntity {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;


    // N : 1에서 N에 해당하는 엔티티가 1에 해당하는 엔티티와 연관 관계를 매핑할 때 @ManytoOne 어노테이션을 쓴다.
    // (fetch = FetchType.LAZY)는 지연 로딩을 설정하는 것
    // @JoinColumn은 실제 데이터베이스에서 해당 칼럼(외래키)의 이름을 설정하는 것
    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "user_id")
    private User user;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "food_id")
    private Food food;
}

지연 로딩 : 자신과 연관된 엔티티를 실제로 사용할 때 연관된 엔티티를 조회(SELECT) 하는 방식, 필요한 시점에 연관된 객체의 대이터를 불러오는 것
즉시 로딩: 엔티티를 조회할 때 자신과 연관되는 엔티티를 조인(join)을 통해 함께 조회하는 방식, 데이터를 조회할 때 연관된 모든 객체의 데이터까지 한 번에 불러오는 것

출처 : https://velog.io/@ssssujini99/SpringJPA-%EC%A6%89%EC%8B%9C-%EB%A1%9C%EB%94%A9Eager-Loading%EA%B3%BC-%EC%A7%80%EC%97%B0-%EB%A1%9C%EB%94%A9Lazy-Loading

그리고 UserMission 엔티티에 대해 단방향 연관 관계를 설정하겠다.

양방향 매핑

양방향 매핑의 장점은 객체 그래프 탐색으로 인한 이점이 있으며,
필수적인 기능인 cascade의 설정이 가능하다

원래 database에서의 cascade : 본래 외래키를 가진, 연관 관계의 주인인 테이블에 설정을 해서
참조 대상인 테이블의 칼럼이 삭제 될 때 같이 삭제되거나 변경이 될 때 같이 변경이 되는 기능
JPA에서의 cascade : 연관관계의 주인이 아닌, 참조의 대상이 되는 엔티티에 설정을 해야 한다. -> 단방향 매핑 만으로는 cascade 설정을 하는 것이 문제가 있다
ex) 만약 단방향 매핑만 적용이 된 상태에서 cascade를 설정 시, member를 참조하는 review가 삭제가 될 때 member도 같이 삭제가 되는 끔찍한 상황이 발생합니다.

따라서 양방향 매핑이 있어야 올바르게 cascade의 적용이 가능한데, 양방향 매핑을 할 경우 연관 관계 편의 메서드가 필요해진다.

User 엔티티에 양방향 매핑을 해보겠다.

package umc.spring.domain;

import lombok.*;
import umc.spring.domain.common.BaseEntity;
import umc.spring.domain.enums.Gender;
import umc.spring.domain.enums.SocialType;
import umc.spring.domain.enums.UserStatus;
import umc.spring.domain.mapping.FoodOfUser;
import umc.spring.domain.mapping.UserMission;

import javax.persistence.*;
import java.util.ArrayList;
import java.util.List;

@Entity
@Getter
@Builder
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@AllArgsConstructor
public class User extends BaseEntity {

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

    private String name;

    @Enumerated(EnumType.STRING)
    private Gender gender;

    private Integer birthYear;

    private Integer birthMonth;

    private Integer birthDay;

    private String address;

    private Integer point;

    @Enumerated(EnumType.STRING)
    private UserStatus status;

    private String email;

    @Enumerated(EnumType.STRING)
    private SocialType socialType;

    private boolean certification;

    @OneToMany(mappedBy = "user", cascade = CascadeType.ALL)
    private List<FoodOfUser> memberPreferList = new ArrayList<>();

    @OneToMany(mappedBy = "user", cascade = CascadeType.ALL)
    private List<Review> reviewList = new ArrayList<>();

    @OneToMany(mappedBy = "user", cascade = CascadeType.ALL)
    private List<UserMission> userMissionList = new ArrayList<>();
}

양방향 매핑의 경우 1 : N에서 1에 해당하는 엔티티에게 설정한다.

@OneToMany 어노테이션을 통해 1에 해당하는 엔티티가 N에 해당하는 엔티티와 관계가 있음을 명시하고,
N에 해당하는 엔티티에서 ManyToOne이 설정 된 멤버변수를 mappedBy한다.
CascadeType.ALL이란 Member의 변화에 따라 Review, FoodOfUser 등의 엔티티가 영향을 받는다는 것을 의미한다.
-> 유저가 삭제 될 때, 유저를 참조하는 나머지 데이터도 같이 삭제된다. (에브리타임의 경우 탈퇴한다고 게시글이 사라지는 게 아니므로 이런 경우인지 기획된 것을 잘 봐야 한다!)

칼럼 별 세부적인 설정

JPA에서 칼럼에 대한 세부적인 설정((유니크, 디폴트 값, null이 가능한지 등등)은 @Column을 이용해서 한다.

columnDefinition = "VARCHAR(10)" 이렇게 칼럼의 타입을 직접 지정할 수도 있고,
@Column(nullable = false, length = 40) 도 가능하다.

gender와 status는 enum으로 되어있어서
@Column(columnDefinition = "VARCHAR(10)") 와 같이 설정했다.

package umc.spring.domain;

import lombok.*;
import umc.spring.domain.common.BaseEntity;
import umc.spring.domain.enums.Gender;
import umc.spring.domain.enums.SocialType;
import umc.spring.domain.enums.UserStatus;
import umc.spring.domain.mapping.FoodOfUser;
import umc.spring.domain.mapping.UserMission;

import javax.persistence.*;
import java.util.ArrayList;
import java.util.List;

@Entity
@Getter
@Builder
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@AllArgsConstructor
public class User extends BaseEntity {

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

    @Column(nullable = false, length = 15)
    private String name;

    @Enumerated(EnumType.STRING)
    @Column(columnDefinition = "VARCHAR(10)")
    private Gender gender;

    private Integer birthYear;

    private Integer birthMonth;

    private Integer birthDay;

    @Column(nullable = true, length = 100)
    private String address;

    private Integer point;

    @Enumerated(EnumType.STRING)
    @Column(columnDefinition = "VARCHAR(15) DEFAULT 'ACTIVE'")
    private UserStatus status;

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

    @Enumerated(EnumType.STRING)
    private SocialType socialType;

    private boolean certification;

    @OneToMany(mappedBy = "user", cascade = CascadeType.ALL)
    private List<FoodOfUser> memberPreferList = new ArrayList<>();

    @OneToMany(mappedBy = "user", cascade = CascadeType.ALL)
    private List<Review> reviewList = new ArrayList<>();

    @OneToMany(mappedBy = "user", cascade = CascadeType.ALL)
    private List<UserMission> userMissionList = new ArrayList<>();
}