Lombok 사용
- 어노테이션은 덜 중요할 수록 위로, 중요할 수록 아래로 배치하도록 합니다.
- 예를 들어
@Entity 가장 아래에, @ToString 가장 위에
@Data은 너무 많은 것을 하기 때문에 도메인에서 사용을 지양합니다.
@Setter를 도메인에서 사용하면 변경 포인트가 많아지기 때문에 유지보수가 어려워집니다. 따라서 사용을 지양합니다.
- 대신 명확하게 메서드를 이용해서
@Setter를 대신합니다.
- 예제 코드
@ToString은 양방향 연관 관계에서 무한 참조 문제가 발생할 수 있기 때문에 조심해서 사용해야 합니다.
@ToString(of = {..})로 선택적 사용 or @ToString(exclude = "")로 제외
@NoArgsConstructor의 접근 권한은 최소화 합니다.
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@Id를 통해 Id를 생성하는 전략과 관련이 있는데, 이때 Id 필드의 접근 제한자도 private으로 제한해서 Id 값이 null로 생성되는 경우를 방지합니다.
public인 경우 도메인 객체를 생성해서 Id값이 null인 경우가 발생할 수 있습니다.
@Builder의 경우 클래스 위에 사용하기보다 생성자 위에 @Builder를 사용하는 것을 권장합니다.
@Builder는 @AllArgsConstructor와 유사한 효과를 주기 때문에 생성자의 인자를 최소화하는 것이 좋습니다.
- 정적 팩토리 메서드 패턴으로 생성자 대신 사용함으로써 의미 전달을 명확하게 하는 것도 생각해봤지만, 생성자나 빌더 패턴을 사용하는 것보다 불편해질 것 같아서 보류했습니다.
equals()와 hashcode()는 도메인에서 Id만을 이용해서 비교해도 충분합니다.
JPA
@Table(name = "member")과 같이 테이블 이름은 명시해야 합니다. 명시하지 않으면 기본적으로 클래스 이름을 참조하기 때문에 클래스 이름이 변경될 경우 영향을 받게 됩니다.
- 필드에서
@Column(name = "user_id") 지정하는 대신 그냥 Camel Case로만 필드 명을 지정해줍니다.
- JPA에서 자바 CamelCase를 변환해서 Snake_Case로 변경해주는 것을 적극 활용합니다.
- Enum 타입 사용 시
@Enumerated(EnumType.*STRING*)을 사용합니다.
- 연관관계 참조 시 기본 전략은 지연로딩인 LAZY를 사용합니다.
@ManyToOne(fetch = FetchType.LAZY), @OneToMany(fetch = FetchType.LAZY)
- 이후에 fetch join 등으로 성능을 튜닝합니다.
- 양방향 매핑 시 양쪽 도메인 전부 연관 관계를 설정해주는 메서드를 사용합니다.