TDD(Test Driven Development) 실습 프로젝트

👋️️️️️개요

간단한 커뮤니티를 제작하며 TDD 학습을 위한 레포지토리.

⚒️사용 기술

Java 11
SpringBoot
Jpa
QueryDSL
H2

✨ 학습 목표

브랜치 관리 전략

많은 깃 브랜치 관리 전략 중 하나인 git-flow 를 도입하여 개발을 진행합니다.

코드 리뷰 기반 개발

하나의 기능은 하나의 pull_request 를 생성합니다.

해당 pull_request 에 대하여 다른 개발자가 리뷰를 하여 병합하는 습관을 연습합니다.

페어 프로그래밍

code with me 를 활용하여 어렵거나 힘든 기능을 의견을 주고 받으며 페어 프로그래밍을 진행합니다.

📋 프로젝트 기능 요구 사항

✏️회원

회원 가입
- POST /members MemberController#signUp(@RequestBody MemberSignUpDTO)
회원정보 수정
- PUT /members MemberController#updateMember(@RequestBody MemberInfoUpdateDTO)
비밀번호 수정
- PATCH /members MemberController#updatePassword(@RequestBody MemberChangePasswordDTO)
회원탈퇴
- DELETE /members MemberController#quitMember()
조회
- GET /members MemberController#fetchMember()
로그인
- POST /members/sign-in MemberController#signIn()
회원 아이디 찾기
- GET /members/find-id MemberController#findId()
비밀번호 찾기
- GET /members/find-pw MemberController#findPw()

✏️게시판

쓰기
- POST /posts PostController#posts(@Valid @RequestBody PostSaveRequestDTO)
수정
- PATCH /posts PostController#updatePosts(@Valid @RequestBody PostUpdateRequestDTO)
삭제
- DELETE /posts/{id}/{postId} PostController#deletePost(@Valid @RequestBody PostDeleteRequestDTO)
조회(제목조회(페이징목록), 개별게시글조회)
- 개별게시글조회
  - GET /posts/{id} PostController#posts/{id}(@PathVariable Long id)
- 제목조회(페이징목록)
  - GET /posts/page={number} PostController#posts(@PathVariable Long page)

프로젝트 기능 요구 사항

"*" : 변경이 필요한 요구사항입니다.

✏️회원

✏️게시판

⚔ Project Coding Convention && Resource Convention

✋ Class && Method Convention

하나의 클래스는 하나의 책임만 담당하게 만든다.
else 예약어를 사용하지 않는다.
한줄에 점 하나만 찍는다 ( 체이닝 )
최대한 단위를 쪼개어 메소드를 만든다.
최대한 Lambda Stream 을 이용하기
구분자는 탭(스페이스 4칸)을 사용한다.
예약어(if, switch, for, while 등) 작성 후 스페이스로 한 칸 띄운다. 괄호를 닫은 후 다시 스페이스를 한 칸 띄운다.
필드변수는 모두 메서드 바로 아래에 함께 작성하여 모아둔다.

✋ class 작성 방식

필드 변수
생성자
override 메소드
public 메소드
private 메소드

예시는 아래와 같다.

public class Main {
    public static void main(String... args) {
        int n = 0;

        while (n-- > 0) {
            log.info(n);
        }
    }
}

클래스 / 메서드 추가시마다 javadoc 작성.
javadoc은 아래와 같은 포맷을 가진다.

/**
 * 애플리케이션 실행시 진입 지점으로 사용되는 클래스
 *
 * @author 작업자1
 * @author 작업자2
 *
 */
public class Main {

  /**
   * 0부터 사용자 입력값(정수)까지 더하고 해당 결과값을 출력합니다.
   *
   * @param args 사용자 입력값 (문자열 배열)
   * @author 작업자1
   */
  public static void main(String... args) {
    int result = sum(Integer.parseInt(args[1]));
    System.out.println(result);
  }

  /**
   * 0부터 n까지 더한 값을 반환합니다.
   *
   * @param n 사용자 입력값 (정수 변환)
   * @return 0부터 n까지의 합산값
   * @author 작업자1
   */
  private static int sum(int n) {
    int sum = 0;
    
    while (n-- > 0) {
      sum += n;
    }

    return sum;
  }

}

About

TDD

Languages

Language:Java 81.4%Language:HTML 18.6%