API 명세서

API 명세서

주요 고민 및 해결

1. QueryDSL을 도입하여 복합 조건의 동적 검색 및 추천 기능을 구현
2. getObject 방식에서 Pre-signed URL로 변경하여 서버 부하 및 네트워크 트래픽 절감
3. record를 중첩 구조로 사용하여 가독성/응집도 향상 및 보일러플레이트 코드 제거
4. EC2 프리티어 메모리 부족 문제를 swap 파일 생성으로 해결 및 배포 안정화
5. Page 대신 Slice를 사용하여 불필요한 count 쿼리를 제거 및 페이징 성능 최적화

스프링 관련

• 구현순서 (Bottom-Up: 상향식. 즉, 아래(도메인)부터 위(컨트롤러)로 )

  도메인 엔티티 → DTO & Command (데이터 구조 정의) → Repository Interface → Service (비즈니스 로직) → 컨트롤러

  • 다른 계층들이 domain을 의존하고 domain이 db와 가장 가깝기에 domain이 최하위 (컨트롤러는 사용자와 가장 가깝기에 상위)
  • 상향식은 도메인부터 탄탄히 구축하기에 안정적이고 테스트에 용이함.

<aside> 💡

구분 기준 (위 경우는 실행 흐름 관점)

• 실행 흐름 관점의 '상/하위’ → 데이터의 흐름이나 호출 순서를 기준

  (사용자와 가까운 컨트롤러가 상위 / db와 가까운 도메인이 하위)

• 의존성 규칙 관점의 '고/저수준’ → 누가 더 중요하고, 누가 누구에게 의존해야 하는가의 기준

  (비즈니스 로직을 담은 도메인이 고수준 / 서비스를 의존하는 컨트롤러가 저수준)

</aside>

• @NotNull vs @Column의 nullable=false

  1. 엔티티 설계 시, 일반적으로 @Column 어노테이션을 활용

     → @Column의 nullable=false 설정으로 NOT NULL 제약조건 명시 가능 (기본값은 true)

     → 이 경우, 데이터베이스 컬럼의 속성이기에 애플리케이션 내부에서는 NULL 값이 허용됨. (데이터베이스 쿼리가 실행될 때 예외 발생)

  2. @NOT NULL 어노테이션도 마찬가지로 DDL 상에서 해당 컬럼이 NOT NULL 제약조건을 가짐을 명시 가능

     → 차이점은 스프링(자바) 애플리케이션 내에서 예외를 잡아줌. (불필요한 쿼리 발생 X) (javax.validation.ConstraintViolationException 예외 발생)

     → 엔티티가 영속화되는 시점에 예외 발생

     

  • 주의) @NotBlank나 @NotEmpty는 자동으로 DDL을 생성하지 않음. 즉, @Column(nullable=false)를 반드시 추가해줘야함.

• StringUtils.hasText: Spring 프레임워크가 제공하는 유용한 문자열 검증 유틸리티 메서드

  → 3가지 모두 검사 (성공 시, true 반환)

  • null이 아닌가?
  • 빈 문자열("")이 아닌가?
  • 공백 만으로 이루어진 문자열(" ")이 아닌가?

• 엔티티의 데이터 삭제 (연관된 엔티티)

  • @OneToMany(일대다) 인 경우 → .clear()를 호출하여 리스트를 비워줌으로써 삭제할 수 있음 (연관관계 끊어지면 orphanRemoval=true에 의해 삭제)
  • @OneToOne(일대일)인 경우 → null를 넣어 삭제할 수 있음 (연관관계 끊어지면 orphanRemoval=true에 의해 삭제)

  //3가지 케이스
  
  this.activeDays.clear(); //연결관계 끊기 (리스트이기에 clear로 전체 삭제)
  this.partyImg = null; //연결관계 끊기 (단일 객체기에 null)
  this.content = request.content(); //연관된 엔티티가 아닌 그냥 필드인 경우, 값만 넣어줘도 됨
  

• 양방향 관계 설정 (연관관계 편의 메서드)

  1. 자식 엔티티를 부모 안에서 생성한 경우 (일반적으로 더 선호)

  public void addActiveDay(ActiveDay day) {
      //자식(PartyActiveDay)을 부모(Party) 안에서 직접 생성
      PartyActiveDay partyActiveDay = PartyActiveDay.builder()
              .activeDay(day)
              .party(this) //**생성 시점에 바로 부모-자식 관계 설정**
              .build();
      this.activeDays.add(partyActiveDay); //부모에게 자식을 설정
  }
  

  1. 이미 만들어진 자식을 전달 받아 연관 관계를 설정하는 경우

  public void addMember(MemberParty memberParty) {
      this.memberParties.add(memberParty); //부모에게 자식을 설정
      memberParty.setParty(this); //이미 만들어진 자식에게 부모를 설정
  }