코드 컨벤션 어떻게 할까요?

[laigasus]

할 것들을 나열해봤습니다.
정해진 내용은 체크 박스 활성화해주세요. 추후 Wiki 에 올리겠습니다!

• 공통 예외 처리
• 응답 Api Response
• Git 전략, 커밋 컨벤션, 템플릿 정형화

[happymink]

커밋 컨벤션이 정해지면 인텔리제이 Commit Message Template 플러그인을 사용하면 유용할 것 같기도 합니다!

참고링크 : https://zzang9ha.tistory.com/334#%F0%9F%93%8E%C2%A0-commit-message-template

[NoJaeHyuk]

[NoJaeHyuk]

Git Commit Template

[NoJaeHyuk]

[NoJaeHyuk]

https://plugins.jetbrains.com/plugin/9861-git-commit-template

[laigasus]

예외처리는 BIz, 공통단 별로 exception 패키지를 사용했습니다.
Biz에서 예외를 만들는데 파일이 꽤 많아지더군요
저는 개인적으로 springboot 3.x 에서 지원하는 rfc 7807 ProblemDetails 를 이용해서 가공했습니다!

작업한 사례도 올립니다.
https://github.com/Mini-Team-6/Mini-Team-6-Backend

[laigasus]

요런 느낌

[Dr-KoKo]

Throwable은 테스트 용도로 사용하던 거라서 제외하고 보시면 될 것 같습니다.

[NoJaeHyuk]

상태코드와 메세지만 받는 형식으로 주로 사용했습니다.

[NoJaeHyuk]

    @PostMapping("/register")
    public ResponseEntity<ApiResponse<Void>> register(@Valid @RequestBody MemberRegisterRequest request) {
        memberRegisterService.register(request);
        return ResponseEntity.ok().body(new ApiResponse<>(LocalDateTime.now(), "성공", null));
    }

    @GetMapping("/email/verify")
    public ResponseEntity<ApiResponse<Void>> verifyEmail(@NotNull String email) {
        memberRegisterService.validateEmailDuplicatation(email);
        return ResponseEntity.ok().body(new ApiResponse<>(LocalDateTime.now(), "성공", null));
    }


    //// 

    public record ApiResponse<T>(
    LocalDateTime timeStamp,
    String detail,
    T data) {

    }

[NoJaeHyuk]

`
@Getter
public class ApiResponse {

private int code;
private HttpStatus status;
private String message;
private T data;

public ApiResponse(HttpStatus status, String message, T data) {
    this.code = status.value();
    this.status = status;
    this.message = message;
    this.data = data;
}

public static <T> ApiResponse<T> of(HttpStatus status, String message, T data) {
    return new ApiResponse(status, message, data);
}

public static <T> ApiResponse<T> of(HttpStatus status, T data) {
    return of(status, status.name(), data);
}

public static <T> ApiResponse<T> ok(T data) {
    return of(HttpStatus.OK, HttpStatus.OK.name(), data);
}

}
`

[laigasus]

작업이 모두 완료되었음 #18