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

🎠토이 프로젝트 - 1 개요

 

✔️프로젝트 내용

여행 기록/조회하는 Java 콘솔 어플리케이션

 

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

야놀자

✔️프로젝트 목표

1단계 달성 목표: Java 문법, 파일 입출력, 예외처리, 클래스 설계
1) 여행의 여정 정보를 기록하고 조회하는 Java 애플리케이션 개발
2) 개별 여행은 복수의 여정 정보로 구성됨 (여행 : 여정 = 1 : n)
3) 여정 정보는 이동 (출발지, 도착지, 출발시각, 도착시각)과 숙박(체크인, 체크아웃)
등의 유형이 있을 수 있음
4) 여행 정보와 특정 여행 정보의 여정 목록은 데이터 저장 경로에 파일 형태로 저
장 (CSV, json 등)

 

✔️프로젝트 기간

2023년 9월 4일(월)~9월 8일(금)

 

✔️프로젝트 정의서

1. 회원은 여러 여행 기록을 저장할 수 있습니다. 회원 가입은 다음 단계에서 고려하고 본 프로젝트는 여행과 여정을 기록하고 조회하는 기능을 구현하기로 한다.
2. 여행에는 여러 여정이 있을 수 있습니다. 여정정보는 이동정보(출발지, 목적지, 출발시간, 도착시간), 숙박정보(체크인, 체크아웃) 등의 종류를 포함할 수 있다.
3. 회원의 여행기록 목록이 출력되며, 각 여행기록 목록을 선택하면 상세한 여정기록이 출력된다.
4. 회원 및 여행기록은 향후 데이터베이스 테이블로 관리되어 지나 1단계 프로젝트에서는 여행별 여정 정보는 json이나 csv 파일로 관리된다.

---

⚖️ 컨벤션

GitHub Flow

• 브랜치 전략으로 GitHub Flow를 사용합니다.
• 모든 팀원의 Approve를 받아야 main에 Merge 할 수 있습니다.

코딩 컨벤션

• 구글 코딩 컨벤션을 사용합니다.
  
  

커밋 메시지 컨벤션

• 커밋 제목은 prefix: 커밋 메시지 형태로 합니다.
• prefix의 목록과 각각의 용도는 IntelliJ 플러그인에서 볼 수 있습니다.
• 커밋 내용을 자세하게 적습니다. (커밋 제목과 내용만 보더라도 코드 내용이 파악 가능할 정도로)

기타 합의사항

• 협업 관련

• 데일리 스크럼: 평일 10:00~10:10에 모여서 각자의 진행상황 공유
• 정규시간에는 Zoom, 끝난 후에는 Discord에서 상시 모각코 (필참 아님)

• 추가 코딩 컨벤션

• 목록을 가져올 때는 get 동사를 쓴다.
• class/enum/interface/record 정의 시 맨 윗줄에는 줄바꿈을 넣고, 맨 아래 줄은 넣지 않는다.

 

✍️ 기획

기술 스택

• 언어: Java 17
• 개발 환경: IntelliJ, Gradle
• 라이브러리: JUnit5, lombok, Jackson
• CI: GitHub Actions

 

패키지 및 클래스 구성

 

 

도메인

 

Trip.java

import java.time.LocalDate;
import java.util.ArrayList;
import java.util.List;
import lombok.AccessLevel;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.ToString;
 
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@ToString(exclude = "itineraries")
public class Trip {
 
    private Long id;
    private String name;
    private LocalDate startAt;
    private LocalDate endAt;
 
    private final List<Itinerary> itineraries = new ArrayList<>();
 
    @Builder
    private Trip(
            Long id,
            String name,
            LocalDate startAt,
            LocalDate endAt
    ) {
        this.id = id;
        this.name = name;
        this.startAt = startAt;
        this.endAt = endAt;
    }
 
    public void setId(Long id) {
        this.id = id;
    }
 
    public void addItinerary(Itinerary itinerary) {
        itineraries.add(itinerary);
    }
}

 

Itinerary.java

import java.time.LocalDateTime;
import lombok.AccessLevel;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.ToString;
 
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@ToString(exclude = "trip")
public class Itinerary {
 
    private Long id;
    private Route route;
    private Lodge lodge;
    private Trip trip;
 
    @Builder
    private Itinerary(
            Long id,
            String departure,
            String destination,
            LocalDateTime departureAt,
            LocalDateTime arriveAt,
            String accommodation,
            LocalDateTime checkInAt,
            LocalDateTime checkOutAt,
            Trip trip
    ) {
        this.id = id;
        this.route = new Route(departure, destination, departureAt, arriveAt);
        this.lodge = new Lodge(accommodation, checkInAt, checkOutAt);
        this.trip = trip;
    }
 
    public void setId(Long id) {
        this.id = id;
    }
 
    public void setTrip(Trip trip) {
        this.trip = trip;
    }
}

 

 

 

 

 

최대한 도메인 주도 설계(DDD)를 지키기 위하여 받은 데이터는 옮길 때 DTO에 담아 옮기고 최종 파일에 접근할때 도메인에 담아서 보내준다.

 

 

 

 

 

토이프로젝트1에서 DB와 연동하지 않고 File에 저장 하기 때문에 Service에서 File에 접근할 때 도메인에 담아 보내주었다.

DTO는 JDK16 이상부터 정식 제공하는 record를 사용하여 만들었다. 

 

 

 

ItinerarySaveRequest.java

import java.time.LocalDateTime;
import lombok.Builder;
 
@Builder
public record ItinerarySaveRequest(
    String departure,
    String destination,
    LocalDateTime departureAt,
    LocalDateTime arriveAt,
    String accommodation,
    LocalDateTime checkInAt,
    LocalDateTime checkOutAt
) {
 
    public ItinerarySaveRequest {
        if ((departureAt == null && arriveAt == null)
            && (checkInAt == null && checkOutAt == null)) {
            throw new IllegalArgumentException();
        }
    }
}
 

레코드는 필드 유형과 이름만 필요한 불변 데이터 클래스이다.

equals, hashcode, tostring 메서드와 private, final field, public constructor는 Java 컴파일러에 의해 생성된다. 또한 getter() 도 만들어 주어 필드 값을 가져올때 . 찍고 필드명을 쓰면 된다.

 

 

예시)

private Itinerary convertDtoToItinerary(Trip trip, ItinerarySaveRequest itinerarySaveRequest) {
    return Itinerary.builder()
            .trip(trip)
            .departure(itinerarySaveRequest.departure())
            .destination(itinerarySaveRequest.destination())
            .departureAt(itinerarySaveRequest.departureAt())
            .arriveAt(itinerarySaveRequest.arriveAt())
            .accommodation(itinerarySaveRequest.accommodation())
            .checkInAt(itinerarySaveRequest.checkInAt())
            .checkOutAt(itinerarySaveRequest.checkOutAt())
            .build();
}

 

 

데이터 흐름

• 저장시

뷰에서 콘솔에서 받은 입력값을 여행 또는 여정에 맞는 SaveRequest DTO에 담아서 Controller로 보내준다. Controller에선 받은 DTO를 Service로 넘겨주고 Service에선 DTO를 Domain으로 변환해준 뒤 파일 저장 시스템으로 보내여 값을 파일(JSON/CSV)에 저장한다.

• 조회시

뷰에서 콘솔에서 조회하고 싶은 FileType을 받는다. JSON/CSV 해당 파일에 맞는 값을 ID로 찾아온다. 조회하여 나온 데이터를 Domain에서 Response DTO로 변경하고 뷰에서 데이터 값을 보여준다.

 

 

 🪄실행 화면

 

메인화면 및 프로그램 종료 실행 화면

 

 

여행 기록 실행화면_1

 

여행 기록 실행화면_2

 

여정 기록 실행화면

 

여행 조회 실행 화면

 

 

여정 조회 실행 화면

 

데이터를 입력한 후 파일 저장 상태 화면

 

 

🤔팀 회고

토이프로젝트가 끝나고 그 차주 화요일에 다 같이 줌에서 만나서 1시간 가량 팀 회고 및 피드백을 진행하였다.

 

조금 힘들었다.
- 코드리뷰 하는게
- SOLID 다 지키면서 하는게
- 협업이 처음이라
- 컨벤션 같은 것이 처음이라
- Git/GitHub 적응하는게
- 공부가 필요할 것 같다
- 기능이 겹쳐서 충돌이 너무 잦았다
- 기능이 얼마 없는데 사람만 많아서

아쉬웠다.
- 코딩컨벤션, 테스트, 코드리뷰, Git Flow
- 시간이 없어서 토, 일 Free
- 다음 프젝 2개 => 1주

코드리뷰 받은 뒤 우리끼리 리팩토링 해보자
- 서비스 로직 정도 짜보면 좋을 듯

'콘솔작업'인데 매우 난항이 많았다.
다음 프젝은 SpringBoot, DB, REST API인데 기간 똑같은데, 괜찮을까?

1. 이대로 괜찮다. 그대로 가자
- 이번 프로젝트가 특수한 상황이였다. 다음엔 괜찮을 거다. (설계에 너무 많은 시간을 쏟음, 처음인 협업)
- 오히려 설계를 처음에 잘 해뒀기 때문에 이틀만에 완성할 수 있었던 거라 생각한다.

2. 뭔가 우리끼리 연습을 해보자
- 토이프로젝트 코드리뷰 피드백에 대한 리팩토링
- 테스트 공부는 필요할 것 같다. (추후에 JUnit을 써야만 함)
- 미리 공부해야 하는 것들을 정리해두면 좋을 것 같다

좀 더 공부 해볼 것

코딩 컨벤션, 테스트 컨벤션
Git Flow(코드리뷰)

찬영님 지인 추천 책
- 단위테스트
- 레거시 코드 활용 전략 (오래됨)

다음 프로젝트 전까지 해볼 것
(필수) 1. 기존 코드에 대해 => 리팩토링 & 테스트 코드 추가 각자 PR
(권장) 2. 프로젝트1를 기반으로 SpringBoot, DB, REST API 앱 만들기 (JPA 이용해서 받아온 DB 정보를 토대로 json 응답하는 메서드 1개

 

 

클래스 설계까지 완벽하게 하고, 최대한 객체지향적으로 SOLID 지켜가며 프로젝트에 임하려고 하니깐 설계하는 부분에 많은 시간을 소요했다. 특히나 MVC나 객체 지향적인 부분에서 배운점이 많았다.

객체를 바라볼 때 항상 DB와 연동하니 종속 관계를 생각했을 때 여행이 여정을 가져야 한다고 생각했다. 근데 이건 ORM적 관점이지 객체의 연관관계에선 틀린 것이다.

모든 프로젝트나 작업물을 DB와 연동시켜서 하니 이런 객체 간의 연관 관계도 관성적으로 테이블의 연관관계로 생각하는 버릇이 있었다.

예를 들어 아래 사진처럼 멤버와 팀이 있을 때 난, 팀 안에 멤버가 있어야한다고 생각했다. 현실 객체의 추상화로서 그게 자연스럽고 항상 그래왔다. 생각했지만, 그건 ORM적 관점이었다.

 

 

그리고 JUNIT5를 사용한 테스트 코드를 이번엔 적극 활용하지 못한 점이 아쉬웠다. 차후 1달 뒤에 다시 토이 프로젝트 2 이니 그땐 꼭 테스트 코드까지 완벽하게 수행해야겠다.

좋았던 점은 Git Hub Actions를 사용하여 실제 협업 처럼 팀원의 리뷰를 받아 Approve를 받아야지만 Merge할 수 있는 것과 다양한 리뷰 및 피드백을 나눌 수 있는 점이 좋았다. 또한 패키지 및 클래스 설계 부분에서 많은 점을 배웠고, 역시 공부엔 끝이 없다는 생각도 들었다.

테스트 코드 공부하러 가야겠다,,,,,