Skip to content

여행의 순간을 포착하여 기록하고 공유하자, phochak

Notifications You must be signed in to change notification settings

Nexters/phochak-server

Repository files navigation

스크린샷 2023-05-24 오전 12 51 01 IMG_2281

"포착"

✈️ 포착은 여행에서의 소중했던 추억을 공유하는 쇼츠 컨텐츠 서비스입니다 ✈️

인스타 릴스, 유튜브 쇼츠, 틱톡.. 딱히 보고 싶지 않은 영상들에 지치지 않으셨나요?


🏖️ 그렇다면 혹시 여행과 관련된 주제만 골라서 보고싶지 않으신가요? 🏖️

🤩 특별했던 장면을 공유하며 다음을 기약하고, 다른 사람들이 포착한 순간을 시청하며 나만의 여행을 꿈꿔보세요 🤩



🟢 운영중 - Play Store / App Store

🤖 Android Github

🍎 iOS Github 📝 Rest API Sheet

Back-end Members

김세영 천진우
김세영 천진우

Infrastructure

Branch Rule

스크린샷 2023-09-20 오후 1 32 12

  • Release: 운영 서버에 배포
  • Develop: 개발 서버에 배포
  • Feature: 기능 개발

Co-Work Flow

  1. Issue 생성
  2. feature 개발
  3. Pull Request
  4. 리뷰
  5. Squash Merge

Documentation Rule

📝 Rest API Sheet

Rest Docs 를 활용합니다.

컨트롤러 통합 테스트 -> ActionResult 를 DocumentGenerator.java(Util 클래스)에 추상화.

Test Rule

🔗 시나리오 테스트 예시

[9.1 수정] 기존 테스트들은 사실상 재사용 불가능하며 가독성이 좋지 않은 테스트라서, 모든 테스트를 다음 규칙으로 재작성합니다.

단, 리팩토링 이후에 기존 테스트도 잘 돌아가야하며, 최종 확인 이후 PR 직전에 삭제합니다.

  • 시나리오 기반 테스트로 중복 최소화하고 가독성을 가져가기
  • Rest Docs Test, JUnit(AssertJ) 활용
  • 다음 테스트코드 작성 기준을 준수하기
    • Presentation Layer: Rest Docs, Integration Test, Only Happy Test
    • Application Layer: Unit Test, Happy Test, Fail Test
    • Domain Layer: Unit Test, Happy Test, Fail Test
    • Query: 직접 정의한 쿼리 Happy Test

Constructor Convention

도메인 객체와 엔티티 객체를 구분하게 되면서, 다음 고민들을 하게 되었습니다.

  1. 도메인 객체의 생성자 공개를 최소화

  2. 엔티티 객체를 개발자가 직접 생성하지 못하도록 제한

  3. Mapper 클래스를 통해 도메인 객체와 엔티티 객체의 자유로운 매핑
    - 🔗 Mapper 클래스 예시

그래서 고민하고 적용한 규칙은 다음과 같습니다

도메인 객체 생성자 규칙

  • 🔗 도메인 객체 예시
  • 실제 도메인 데이터 create를 위해서만 생성자를 제공합니다.
  • 도메인 객체 생성 시에 Spring boot Assert 로 값을 검증합니다.
  • Mapper를 위해 정적 팩토리 메소드 'forMapper'를 제공합니다.

엔티티 객체 생성자 규칙

  • 🔗 엔티티 객체 예시
  • 오직 Mapper를 위한 생성자만 존재합니다. (개발자가 엔티티 객체를 직접 생성하지 못하게 제한합니다.)
  • 엔티티를 직접 생성할 수 없도록 해당 생성자를 default 접근제어자로 설정했습니다.
  • User 엔티티의 생성자는 테스트 편의를 위해 @VisibleForTesting 를 적용한 생성자를 적용했습니다.

About

여행의 순간을 포착하여 기록하고 공유하자, phochak

Resources

Stars

Watchers

Forks

Packages

No packages published