swan.song 사전 과제 제출합니다.

[Unagi-zoso]

해결한 부분

• 요구 API 작성 (디자인, 응답 값, 유효성 검사)
• 테스트 코드 작성
• format 파라미터를 통한 json, xml 제공
• Rate Limiter 작성
• 커스텀 에러 작성
• Logging
• 배포

고민한 부분

• JDBC : 데이터의 삽입 없이 조회만 하면 되기에 JdbcTemplate 과 DTO 를 통해 간단히 쿼리를 구현했습니다.
• Filter, Aspect 사용 : API Key 인증, 에러 핸들링, 로깅, 반환 포맷 변환은 비즈니스 코드와 관심사를 분리할 수 있을 것 같아
  AOP, Filter 를 통해서 구현했습니다.
• 다양한 Test 코드 네이밍 스펙 : 각 레이어 및 객체 별 자연스럽게 읽히는 쪽으로 네이밍 스펙을 각기 가져갔습니다.
• Test DB : 간단한 기능을 구현하기에 H2 DB 로 환경을 구축했습니다.
• 동시성을 고려한 Rate Limiter : 서버가 한 대이기에 Synchronized , ConcurrentHashMap 을 사용해 동시성 문제를 방지했습니다.

잘 부탁드리겠습니다.

감사합니다.

[Unagi-zoso]

API 철학

Interface 인 만큼 이후에 자잘한 변화가 일어나지 않게끔 신중하게 스펙을 정하는데 가장 신경을 씁니다.
이번 과제의 경우엔 모든 스펙이 주어졌지만 실제 협업을 하는 상황에선 사용자(프론트엔드 개발자 같은 ..)와의 많은 대화 후에
API 를 설계했습니다.
만약 필요에 의해 API 의 버전을 바꾸어야한다면 변경 없이 확장만으로 해결할 수 없을지 고민합니다.
기본적으로 RESTful 한 API 를 지향하여 URL 에서 자원의 관계나 HTTP 메소드로 API 의 목적, 행동을 예측할 수 있도록 신경을 씁니다.
이번 과제의 경우엔 API 스펙이 다 주어져 따로 고려하진 않았습니다.


이번 과제에서 버저닝을 의식한 부분은 아래와 같습니다.

@RestController
@RequestMapping("/api/v1/stocks") // 버전 1 API 임을 명시
public class StockController {
    // 생략
}

[Unagi-zoso]

배포 후 컨테이너 상태

테스트 시연 자료

[Unagi-zoso]

Log rotation 정책

INFO 이상의 일반 로그는 30일간 유지되며 파일 크기가 500MB 초과하면 오래된 로그가 삭제됩니다.
ERROR 레벨의 로그는 7일간 유지되며 파일 크기가 100MB 초과하면 오래된 로그가 삭제됩니다.

단기간 과제라 수치 자체에는 큰 의미 없이 일반적인 값을 넣었습니다.
운영상황에서 로그 파일이 계속 커지면 서버 컴퓨터에 제한이 생길 수 있어 이런 rotation 정책을 추가했습니다.

[Unagi-zoso]

배포 관련

애플 실리콘 환경에서 개발해 리눅스 환경으로 운영할 예정이였습니다.
이때 플랫폼 차이의 불편함을 줄이기 위해 도커를 이용해 컨테이너로 관리, 배포 했습니다.

단기성 프로젝트라 자원 할당에는 신경쓰지 않았습니다.

그외에는
최신 SpringBoot 3.4.X 버전을 사용하다보니 JarLauncher 를 못 찾는 문제가 있었는데
공식 문서를 확인하고 Gradle 에 반영해 해결했습니다.