🖥️ Server Code (3) - Domain, Config

Domain 패키지

• 데이터 양식을 지정하기 위해 사용한다.
• 매개변수로써 값을 전달할 때에 사용한다.

패키지 구성

1. Result 인터페이스

• Response 에 매개변수로 넘겨지는 클래스의 최상위 인터페이스이다.
• String getResult(); 메서드를 선언해, 구현을 강제한다.

package main.src.Domain;

public interface Result {
    public String getResult(); // Response body 생성 역할
}

• String getResult(); 메서드의 역할은, Response 문자열을 생성하는 것이다.

// getResult() 사용 예시

package main.src.Domain.User;

import main.src.Domain.Result;

public class UserDTO implements Result {
    private Long userId;
    private String nickname;

		//...

    @Override
    public String getResult() {
        return String.format("userId:%s,nickname:%s", userId, nickname);
    }
}

---

Config 패키지

• 기본 구성에 해당하는 클래스의 집합이다.

1. Constant 클래스

• MySQL 접속 정보 (URL, User, Password 등) 를 가지고 있다.
• 중요한 정보를 포함하고 있기 때문에, .gitignore에 등록한다.

package main.config;

public class Constant {
    public static final String mysqlUrl = "jdbc:mysql://localhost:3306/chatProtocol";
    public static final String mysqlUser = "example";
    public static final String mysqlPassword = "example";
}

2. CustomResponse 클래스

• Response 문자열을 생성하는 클래스이다.
• 필드는 statusCode(ex: 200), isSuccess(ex: SUCCESS), result 로 구성되어 있다.
• result 는 Generic 타입이다.
  • 성공 / 실패 결과를 동시에 다룬다.
  • String / Result / List<Result> 타입으로 나뉜다.

package main.config;

import main.src.Domain.Result;
import java.util.List;

public class CustomResponse<T> {
    private String statusCode; // 헤더
    private String isSuccess;  // 헤더
    private T result;          // 바디

    // 요청 성공 생성자
    public CustomResponse(T result) {
        this.statusCode = "200";    // 성공 코드는 200으로 통일한다.
        this.isSuccess = "SUCCESS"; // 성공 메세지는 SUCCESS로 통일한다.
        this.result = result;       // 성공 리턴 값
    }

    // 요청 실패 생성자
    public CustomResponse(ResponseStatus status) {
        this.statusCode = status.getStatusCode(); // 401, 404, 500 etc..
        this.isSuccess = "FAIL";                  // 실패 메세지는 FAIL 로 통일한다.
        this.result = (T) status.getMessage();    // 실패 상세설명
    }

	/**
	 * 성공 결과를 문자열로 변환해주는 메서드
     * 헤더와 바디를 "\t" 구분자로,
     * 바디가 List 값이면 "/" 구분자로,
     * 각 필드들은 "," 구분자로
     * 필드의 Key-Value 값은 ":" 구분자로 나눈다.
	 * 성공 예시) "200 SUCCESS\tuserId:1,nickname:Chehok"
     * 실패 예시) "400 FAIL\tmessage:요청이 잘못 되었습니다."
     */
    public String getResponse() {
        String response = String.format("%s %s\t", statusCode, isSuccess);

        if (result instanceof String) {
            response += String.format("message:%s", result);
        } else if (result instanceof List) {
            for (Result result : (List<Result>) result) {
                response += String.format("%s/", result.getResult());
            }
            // 문자열의 마지막 인덱스에 해당하는 부분을 잘라줌.
            // 결과: 마지막에 들어간 구분자 / 를 제거해줌.
            response = response.substring(0, response.length() - 1);
        } else if (result instanceof Result){
            response += String.format("%s", ((Result) result).getResult());
        }

        return response;
    }
}

3. ResponseStatus Enum 클래스

• 예외 상태를 관리하는 Enum 클래스
• 각 예외에 맞게, 커스텀 에러 메세지 / 에러 코드를 던질 수 있다.
• CustomResponse에 ResponseStatus 객체를 전달하면 실패 결과가 생성 된다.

package main.config;

public enum ResponseStatus {
    ID_DUPLICATION("2001", "아이디가 중복됩니다."),
    USERS_NULL("2002", "아이디 또는 비밀번호가 잘못되었습니다."),
    ROOMS_NULL("2003", "해당하는 방이 없습니다."),
    CHATS_NULL("2004", "채팅이 없습니다."),
    ALREADY_INVITED("2005", "이미 초대한 사람입니다."),
    METHOD_ERROR("400", "요청 메서드가 잘못 되었습니다."),
    BODY_ERROR("400", "요청이 잘못 되었습니다."),
    DB_ERROR("500", "DB 에러");

    private final String statusCode;
    private final String message;

    private ResponseStatus(String statusCode, String message) {
        this.statusCode = statusCode;
        this.message = message;
    }

    public String getStatusCode() { return statusCode; }

    public String getMessage() { return message; }
}

4. CustomException 클래스

• 예외 처리 시, CustomException 을 던짐으로써 예외처리를 커스텀한다.
  • 디버깅 및 Error Response 에 효과적이다.
• ResponseStatus 를 CustomResponse에 전달하는 역할을 수행한다.

package main.config;

public class CustomException extends Exception {
    private ResponseStatus status;

    public CustomException(ResponseStatus status) {
        this.status = status;
    }

    public ResponseStatus getStatus() {
        return status;
    }
}

---

🔗 Github (Code Link)

ChatProgram