패스트캠퍼스X야놀자: 백엔드 개발 부트 캠프 - 🎠Spring 기반 토이 프로젝트 2

🎠프로젝트 개요

 

1️⃣프로젝트내용

여행, 여정을 기록하는 SNS 서비스 2단계

2️⃣프로젝트 주제 및 필수 구현 기능 제안

야놀자

3️⃣프로젝트 목적

Spring Boot, DB 설계, DB 트랜잭션, RESTful API  설계 능력 향상

4️⃣프로젝트 기간

2023년 10월 23일 ~ 2023년 10월 29일

5️⃣Team Repository

https://github.com/FC-BE-ToyProject-Team8/TravelApp

GitHub - FC-BE-ToyProject-Team8/TravelApp: 여행 기록 서비스 SpringBoot REST API 서버

6️⃣기술스택

언어

Java17

개발환경 및 Dependency

Spring Boot 3.1.5

Gradle 8.3

MySQL 8

Spring Web

Spring Data JPA

JUint5

lombok

CI

GitHub Actions

API 명세

Swagger

7️⃣서버 배포

AWS EC2를 사용하여 develop , main 브랜치 테스트 서버 및  메인 서버로 자동 배포

 

---

 

 

⚖️프로젝트 컨벤션

 

모든 약속 내용은 노션페이지에 정리

 

 

 

모든 회의 내용은 회의록 작성

 

1️⃣코딩 컨벤션

블록의 들여쓰기만 4공백으로 커스텀하여 구글 자바 코딩 컨벤션을 사용

Git Hub Actions CI를 통해 체크 스타일이 맞지 않는다면 Merge 못하도록 블락킹

 

2️⃣테스트 코드 컨벤션

Repository : @Query 어노테이션 등을 사용한 메서드에 대해 테스트 코드 작성 필수

Service : 단순 Repository 메서드 호출 이상의 로직을 수행하는 메서드에 대해 테스트 코드 작성 필수

Controller : 모든 public 메서드 테스트 코드 작성 필수

 

3️⃣상태코드 컨벤션

200 : 모든 요청 성공 상태코드

 

400 : 바인딩 에러 및 잘못된 요청을 포함한 모든 클라이언트 에러

 

500 : 모든 서버 내부 에러

 

4️⃣커밋 메세지 컨벤션

커밋 제목은 prefix: 커밋 메시지 형태로 작성

 

prefix 는 각각 상황에 맞는 prefix를 사용
(feat, fix, docs, test, refactor...)

모든 커밋 메세지는 한국어로 작성

 

5️⃣프로젝트 깃 브랜치 전략

GitFlow 전략 ( 프로젝트 규모 특징상 release, hotfix 브랜치는 생략)

작성자 : me~

 

 

---

 

⚒️프로젝트 설계

1️⃣API 설계

메인 서버 Swagger page

 

 

2️⃣프로젝트 ERD

 

 

3️⃣프로젝트 Entity

@Embadded를 보여주기 위한 클래스 다이어그램이 아닌 스샷

 

 

---

 

 

🙋‍♂️담당 파트

1. API : 여정 복수 등록

2. 발표회 자료 준비 및 발표

 

1️⃣ API : 여정 복수 등록

POST /api/trips/{tripId}/itineraries

 

 

Controller

 

Service

 

 

 

Common utility class - Entity Dto Converter

 

예외처리

 

 

테스트 코드

 

ItineraryServiceTest.java

package kr.co.fastcampus.travel.service;
 
import static kr.co.fastcampus.travel.TravelTestUtils.createItinerary;
import static kr.co.fastcampus.travel.TravelTestUtils.createItineraryRequest;
import static kr.co.fastcampus.travel.TravelTestUtils.createLodgeRequest;
import static kr.co.fastcampus.travel.TravelTestUtils.createRoute;
import static kr.co.fastcampus.travel.TravelTestUtils.createRouteRequest;
import static kr.co.fastcampus.travel.TravelTestUtils.createStayRequest;
import static kr.co.fastcampus.travel.TravelTestUtils.createTrip;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
 
import java.util.List;
import java.util.Optional;
import java.util.stream.IntStream;
import kr.co.fastcampus.travel.common.exception.EntityNotFoundException;
import kr.co.fastcampus.travel.controller.request.ItineraryRequest;
import kr.co.fastcampus.travel.controller.request.LodgeRequest;
import kr.co.fastcampus.travel.controller.request.RouteRequest;
import kr.co.fastcampus.travel.controller.request.StayRequest;
import kr.co.fastcampus.travel.entity.Itinerary;
import kr.co.fastcampus.travel.entity.Route;
import kr.co.fastcampus.travel.entity.Trip;
import kr.co.fastcampus.travel.repository.ItineraryRepository;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
 
@ExtendWith(MockitoExtension.class)
class ItineraryServiceTest {
 
    @Mock
    private ItineraryRepository itineraryRepository;
 
    @InjectMocks
    private ItineraryService itineraryService;
 
    @Test
    @DisplayName("여정 복수 등록")
    void addItineraries() {
        // given
        Trip trip = createTrip();
        List<ItineraryRequest> requests = IntStream.range(0, 3)
            .mapToObj(i -> createItineraryRequest())
            .toList();
 
        //when
        Trip returnedTrip = itineraryService.addItineraries(trip, requests);
 
        //then
        assertThat(returnedTrip).isNotNull();
        assertThat(returnedTrip.getItineraries().size()).isEqualTo(3);
    }
 
    @Test
    @DisplayName("여정 복수 등록 실패")
    void addItineraries_fail() {
        // given
        Trip trip = createTrip();
        List<ItineraryRequest> requests = IntStream.range(0, 3)
            .mapToObj(i -> createItineraryRequest())
            .toList();
        Trip otherTrip = createTrip();
 
        //when
        Trip returnedTrip = itineraryService.addItineraries(otherTrip, requests);
 
        //then
        assertThat(trip).isNotEqualTo(returnedTrip);
        assertThat(trip.getItineraries().size()).isNotEqualTo(returnedTrip.getItineraries().size());
    }
}
 

 

 

TravelControllerTest.java

package kr.co.fastcampus.travel.controller;
 
import static kr.co.fastcampus.travel.TravelTestUtils.createItinerary;
import static kr.co.fastcampus.travel.TravelTestUtils.createItineraryRequest;
import static kr.co.fastcampus.travel.TravelTestUtils.createLodgeRequest;
import static kr.co.fastcampus.travel.TravelTestUtils.createRouteRequest;
import static kr.co.fastcampus.travel.TravelTestUtils.createStayRequest;
import static kr.co.fastcampus.travel.TravelTestUtils.createTrip;
import static kr.co.fastcampus.travel.TravelTestUtils.putAndExtractResponse;
import static kr.co.fastcampus.travel.TravelTestUtils.requestDeleteApi;
import static kr.co.fastcampus.travel.TravelTestUtils.requestFindAllTripApi;
import static kr.co.fastcampus.travel.common.response.Status.FAIL;
import static kr.co.fastcampus.travel.common.response.Status.SUCCESS;
import static kr.co.fastcampus.travel.controller.util.TravelDtoConverter.toTripSummaryResponse;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.SoftAssertions.assertSoftly;
import static org.junit.jupiter.api.Assertions.assertAll;
 
import io.restassured.RestAssured;
import io.restassured.path.json.JsonPath;
import io.restassured.response.ExtractableResponse;
import io.restassured.response.Response;
import java.time.LocalDate;
import java.util.List;
import java.util.stream.IntStream;
import kr.co.fastcampus.travel.ApiTest;
import kr.co.fastcampus.travel.common.response.Status;
import kr.co.fastcampus.travel.controller.request.ItineraryRequest;
import kr.co.fastcampus.travel.controller.request.LodgeRequest;
import kr.co.fastcampus.travel.controller.request.RouteRequest;
import kr.co.fastcampus.travel.controller.request.StayRequest;
import kr.co.fastcampus.travel.controller.request.TripRequest;
import kr.co.fastcampus.travel.controller.response.ItineraryResponse;
import kr.co.fastcampus.travel.controller.response.TripResponse;
import kr.co.fastcampus.travel.controller.response.TripSummaryResponse;
import kr.co.fastcampus.travel.entity.Itinerary;
import kr.co.fastcampus.travel.entity.Trip;
import kr.co.fastcampus.travel.repository.ItineraryRepository;
import kr.co.fastcampus.travel.repository.TripRepository;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
 
public class TravelControllerTest extends ApiTest {
 
    @Autowired
    private TripRepository tripRepository;
 
    @Autowired
    private ItineraryRepository itineraryRepository;
 
    @Test
    @DisplayName("여정 복수 등록")
    void addItineraries() {
        // given
        Trip trip = createTrip();
        tripRepository.save(trip);
        String url = "/api/trips/1/itineraries";
        List<ItineraryRequest> request = IntStream.range(0, 3)
            .mapToObj(i -> createItineraryRequest())
            .toList();
 
        //when
        ExtractableResponse<Response> response = RestAssured
            .given().log().all()
            .contentType(MediaType.APPLICATION_JSON_VALUE)
            .body(request)
            .when()
            .post(url)
            .then().log().all()
            .extract();
 
        // then
        JsonPath jsonPath = response.jsonPath();
        String status = jsonPath.getString("status");
        TripResponse data = jsonPath.getObject("data", TripResponse.class);
 
        assertThat(response.statusCode()).isEqualTo(HttpStatus.OK.value());
 
        assertSoftly((softly) -> {
            softly.assertThat(status).isEqualTo("SUCCESS");
            softly.assertThat(data.id()).isEqualTo(1);
            softly.assertThat(data.name()).isEqualTo("tripName");
            softly.assertThat(data.itineraries().size()).isEqualTo(3);
        });
    }
 
    private Trip saveTrip() {
        Trip trip = createTrip();
        return tripRepository.save(trip);
    }
 
    private Itinerary saveItinerary(Trip trip) {
        Itinerary itinerary = createItinerary(trip);
        return itineraryRepository.save(itinerary);
    }
}
 

 

시연 결과

 

 

2️⃣발표회 자료 준비 및 발표

 

---

 

👥팀회고

 

프로젝트가 끝나고 다같이 모여서 프로젝트에 대한 리뷰 및 피드백, 회고 하는 시간을 가졌다.

1. 검증 실패 시 에러 메시지를 지정 (순서보장까지)
2. 여행 종료일자가 여행 시작일자보다 앞서는지에 대한 예외처리
3. Postman 요청들에 대한 공유
4. ZonedDateTime 사용
5. Create/Update 별로 DTO 나누기
6. Controller의 DTO, Service의 DTO
7. Enum 이동수단
8. 시작일시/종료일시를 다루는 Entity와 그 아래에 모아져있는 검증 메서드들 (보류)

 

예외처리를 보다 더 신경써보자는 이야기가 나왔고, RequestDto , ResponseDto 도 역할별로 세분화하여 나누자는 이야기가 나왔다. 또한 계층별로 쓰는 DTO도 나누어 결합도를 더욱 낮추자는 이야기를 나눴다. PostMan 테스트를 저장하여 팀원이 import하여  다같이 사용할 수 있도록 하자고 하고, 이동수단을 Enum으로 넣자는 이야기도 나왔다.

잘한 점은 다른 조들에 비해 더욱 코드를 클린하게 짰다는 점과 각자 개인이 맡은 API의 테스트코드를 작성했다는 점에 있다.