Portfolio

들어가기에 앞서 1. 폴더 구조 2. 테스트 전략 3. 예외 처리 전략 4. DTO ↔ Entity 변환 전략 5. EndPoint 규칙 6. 로깅 전략 7. Git Branch 전략 8. Validation 전략

💡

OOP, CleanCode를 지향하자 테스트도 프로덕트 코드처럼 생각하자.

들어가기에 앞서

NEXTSTEP에서 개발자들을 위해 디자인된 강의를 수강해보세요.

https://edu.nextstep.camp/c/9WPRB0ys/

JPA Entity에서 일급 컬렉션 사용하기

최근 프로젝트를 진행하던 중 두 Entity를 양방향으로 묶고, 로직을 추가하던 중에 @OneToMany 부분의 List를 가공해야 하는 일이 생겼습니다.컬렉션을 가공할 일이 생기면 가장 먼저 떠오르는 것은 일급 컬렉션인데요.지금까지 그럴 일이 없어서인지 한번도 엔티티 안에서 일급 컬렉션을 사용해 본 적이 없었다는 것을 깨달았습니다. 상황은 다음과 같았습니다.

https://wbluke.tistory.com/23

1. 폴더 구조

Presentation - Application - Domain - Infrastructure


- commmon
	- exception  
  - domain
	- config 
- member
		- presentation 
				- memberController 
		- Application 
			- dto 
				- CreateMemberRequest 
				- MemberResponse
			- memberService 
		- entity
			- Member 
			- MemberRepository
		- infrastructure 
			- s3 , querydsl

2. 테스트 전략

단위 테스트는 필수

테스트 템플릿

given when then 주석붙이기
Fixture 관리

비즈니스 로직 테스트는 통합 테스트를 이용해보자

@SpringBootTest

jacoco , sonarcloud 사용

도입하고 커버리지를 조금씩 올리자

`@DisplayName("저장 성공")

save_success()


save_success 

save_duplicateName_fail

(유저 저장 성공)

(이름 중복으로 인한 실패)

3. 예외 처리 전략

Enum errocode

(A001 , HttpStatus.NotFound , “존재하지 않은 유저입니다” )

보내는 메시지의 경우 예외 안에 있는 메시지를 보내도록


public class BusinessException extends RuntimeException {

    private ErrorCode errorCode;

    public BusinessException(String message, ErrorCode errorCode) {
        super(message);
        this.errorCode = errorCode;
    }

    public BusinessException(ErrorCode errorCode) {
        super(errorCode.getMessage());
        this.errorCode = errorCode;
    }

    public ErrorCode getErrorCode() {
        return errorCode;
    }

}


@JsonFormat(shape = JsonFormat.Shape.OBJECT)
public enum ErrorCode {

    // Common
    INVALID_INPUT_VALUE(HttpStatus., "C001", " Invalid Input Value"),
    METHOD_NOT_ALLOWED(405, "C002", " Invalid Input Value"),
    INTERNAL_SERVER_ERROR(500, "C004", "Server Error"),
    INVALID_TYPE_VALUE(400, "C005", " Invalid Type Value"),
    HANDLE_ACCESS_DENIED(403, "C006", "Access is Denied"),


    // Member
    EMAIL_DUPLICATION(400, "M001", "Email is Duplication"),
    LOGIN_INPUT_INVALID(400, "M002", "Login input is invalid"),

    // Coupon
    COUPON_ALREADY_USE(400, "CO001", "Coupon was already used"),
    COUPON_EXPIRE(400, "CO002", "Coupon was already expired")

    
    private final String code;
    private final String message;
    private int status;

    ErrorCode(final int status, final String code, final String message) {
        this.status = status;
        this.message = message;
        this.code = code;
    }

    public String getMessage() {
        return this.message;
    }

    public String getCode() {
        return code;
    }

    public int getStatus() {
        return status;
    }


}

최상위 예외 : BusinessException

도메인 예외 : UserException

상세 예외 : UserDuplicateException , UserInvalidException

spring-guide/exception-guide.md at master · cheese10yun/spring-guide

스프링은 예외처리를 위해 다양하고 막강한 어노테이션을 제공하고 있습니다. 일관성 있는 코드 스타일을 유지하면서 Exception을 처리하는 방법에 대해서 소개하겠습니다. Error Response 객체는 항상 동일한 Error Response를 가져야 합니다. 그렇지 않으면 클라이언트에서 예외 처리를 항상 동일한 로직으로 처리하기 어렵습니다. Error Response 객체를 유연하게 처리하기 위해서 간혹 Map 형식으로 처리하는데 이는 좋지 않다고 생각합니다.

https://github.com/cheese10yun/spring-guide/blob/master/docs/exception-guide.md

Team_i6_comepet_BE/ExceptionMessage.java at c23d43e46b59ae99fa5cb271f66c2f90391ac44b · prgrms-web-devcourse/Team_i6_comepet_BE

This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters You can't perform that action at this time. You signed in with another tab or window.

https://github.com/prgrms-web-devcourse/Team_i6_comepet_BE/blob/c23d43e46b59ae99fa5cb271f66c2f90391ac44b/src/main/java/com/pet/common/exception/ExceptionMessage.java

custom Exception 사용

유저를 예로


public class UserException extends BusinessException{
	
	public UserException(String message, ErrorCode errorCode) {
		super(message, errorCode);
	}
}


public class UserCustomException extends UserException {

	private static final ErrorCode errorCode = ErrorCode.USER_NOT_FOUND;

	public UserCustomException(String message) {
		super(message, errorCode);
	}
}