this-is-spear / hello-banking-api Goto Github PK

Dictionary

Modeling

AccoutController

• 사용자의 계좌(AccountNumber)를 입력해 잔액(AccountBalance)과 사용 목록(AccountHistoryList)을 반환한다.(getAccountBalanceAndAccountHistory)
  • 세션(Session)에서 사용자의 정보(User)를 식별해 사용자의 계좌가 맞는지 확인한다.
  • 잔액(Balance)과 사용 목록(AccountHistoryList)을 반환한다.
• 사용자의 계좌 정보(FromAccountNumber), 상대방의 계좌 정보(ToAccountNumber), 금액(Money)을 입력받아 돈을 이체한다. (transferMoney)
  • 세션(Session)에서 사용자의 정보(User)를 식별해 사용자의 계좌가 맞는지 확인한다.
  • 돈(Money)을 이체한다.
• 사용자의 정보를 식별해 계좌 이체할 상대방의 리스트를 반환한다.(getTargetsToBeTransfer) - (임시)
  • 이체할 상대방의 리스트(Targets)를 반환한다.

AccoutApplicationService

• 계좌 번호(AccountNumber)로 잔액(AccountBalance)과 히스토리(AccountHistory)을 반환한다.
  • 사용자 계좌 히스토리(AccountHistory)를 조회한다.
  • 사용자 계좌 잔액(AccountBalance)을 조회한다.
• 사용자의 계좌(FromAccountNumber)에서 상대방(ToAccountNumber)에게 입력받은 금액을 이체한다.
  • 계좌 이체한다.
  • 계좌 이체가 완료된 이후 사용자에게 이체 완료 알람을 보낸다.
  • 계좌 이체가 완료된 이후 상대방에게 입금 완료 알람을 보낸다.
• 사용자 리스트를 반환한다. - (임시)
  • 전체 사용자 계좌 번호(AccountNumber) 리스트를 반환한다.

AccountService

• 계좌를 조회한다.
• 계좌에 입금하다.
  • 사용자의 계좌 번호(AccountNumber)를 입력해 히스토리(AccountHistory)에 입금 정보를 추가한다.
• 계좌에 출금하다.
  • 사용자의 계좌 번호(AccountNumber)를 입력해 히스토리(AccountHistory)에 지출 정보를 추가한다.
• 계좌 이체한다.
  • 계좌 번호(FromAccountNumber, ToAccountNumber)가 존재해야 한다.
  • 같은 계좌에 이체할 수 없다.
  • 사용자의 계좌에서 상대방의 계좌로 금액을 이체한다.
  • 사용자의 계좌 번호(AccountNumber)를 입력해 히스토리(AccountHistory)에 지출 정보를 추가한다.
  • 상대방의 계좌 번호(AccountNumber)를 입력해 히스토리(AccountHistory)에 입금 정보를 추가한다.

ConcurrencyManager

• 동시성을 제어한다.
  • 다른 사용자의 접근을 제한한다.
  • 사용자의 동작을 진행한다.
  • 다른 사용자의 제한을 해제한다.

LockRepository

• 다른 사용자의 접근을 제한한다.
• 다른 사용자의 제한을 해제한다.

UserRepository

• 사용자 정보를 저장한다.
• 사용자 정보를 반환한다.
• 사용자의 전체 리스트를 반환한다.

AccountRepository

• 계좌를 생성한다.
• 계좌 정보를 반환한다.

AccountHistory

• 계좌 사용 기록을 저장한다.
• 계좌 사용 기록 목록을 반환한다.

AccountNumberGenerator

• 계좌 번호를 생성한다.

User

• 상태
  • 사용자 식별자(userId), 아이디(Id), 이름(name), 비밀번호(Password)를 가진다.

Account

• 상태
  • 계좌 식별자(Id), 계좌 번호(AccountNumber), 사용자 식별자(UserId), 계좌 잔액(Balance) 정보를 가진다.
    • 계좌 번호는 유일하다.
    • 계좌 잔액은 금액(Money)의 정보이다.
• 행위
  • 금액을 출금한다.
  • 금액을 입금한다.

AccountNumber

• 상태
  • 계좌 번호는 숫자와 - 의 조합이다.
  • 계좌 번호의 숫자는 총 13 자리이다.
  • 계좌 번호의 포맷은 xxx-xxxx-xxxxxx 이다.

Money

• 상태
  • 금액을 의미한다.
  • 금액(Money)은 0 원 이상이어야 한다.

AccountHistories

• 상태
  • 사용자의 계좌 이체 사용 기록(AccountHistory) 목록을 가진다.

AccountHistory

• 상태
  • 히스토리 식별자(Id), 계좌 번호(FromAccountNumber)와, 상대 계좌 번호(ToAccountNumber) 기록 타입(HistoryType)과 금액(Money), 계좌 잔액(Balance), 기록 날짜(RecordDate)을 포함한다.
  • 기록 타입(HistoryType)은 입금(DEPOSIT), 출금(WITHDRAW) 중 하나의 정보를 포함한다.

참고 사항

• 도메인 관련 용어는 금융 API를 제공하는 Exness, Toss에서 참고했습니다.

요구사항

• 사용자는 이메일, 비밀번호, 이름을 입력해 회원가입할 수 있다.
• 사용자는 회원가입을 하면 자동으로 계좌를 하나 개설한다.

용어 사전

모델링

MemberController

• 이메일, 비밀번호, 이름을 입력받아 회원가입한다.
• 세션에 저장된 사용자 정보를 이용해 사용자의 정보를 조회한다.

UserDetailService

• 로그인하려는 사용자의 정보를 확인한다.
  • 로그인하려는 사용자 정보가 있어야 한다.

MemberApplicationService

• 이메일, 비밀번호, 이름을 입력받아 회원가입한다.
  • 이메일이 유일해야 한다.
  • 저장할 때, 비밀번호를 암호화한다.
• 사용자 식별자를 이용해 사용자의 정보를 조회한다.
  • 로그인하려는 사용자 정보가 있어야 한다.

Member

• 상태
  • 사용자는 식별자, 이메일, 이름, 권한, 암호화된 비밀번호를 가진다.
  • 이메일은 형식에 맞아야 한다.
  • 이름은 비어있을 수 없다.
  • 권한은 회원(ROLE_MEMBER), 운영자(ROLE_ADMIN) 중 하나의 정보를 가진다.

사용자 시나리오 목록

• 사용자는 5천원을 입금하고 5천원을 출금하면 잔액이 0원 남는다.
• 잔액이 만 원인 사용자는 상대방에게 5천 원 계좌 이체하면 잔액이 5천 원이 남는다.
• 잔액이 3천원인 사용자는 상대방에게 5천원을 이체하려하면 실패한다.
• 백만원 있는 사용자가 상대방에게 동시에 천원을 200번 요청하면 잔액에 80만원 남는다.

Description

• 계좌이체는 친구끼리만 가능합니다.
• 이체할 수 있는 목록을 조회할 때, 친구의 계좌만 조회합니다.

Description

• 공통 관심사를 한 곳에 관리해 유지 보수 비용을 줄입니다.

How to solved

• 인증 인가 통합 테스트 작성과 문서화 리팩토링을 진행합니다.
• 인가가 필요한 소스 코드를 리팩토링합니다.
• 인증 인가가 필요한 테스트 로직을 리팩토링합니다.

사용자 시나리오 목록

• 친구 요청을 받은 사용자가 승인을 하면 친구 목록에 추가가 된다.
• 친구 요청을 받은 사용자가 거절하면 친구 목록에서 볼 수 없다.
• 거절한 사용자에게 다시 친구 추가 요청을 보낼 수 있다.
• 요청 대기중이거나 승인한 사용자에게 친구 요청을 보낼 수 없다.

기능

• 상대방에게 친구 요청을 한다.
• 친구 요청에 대한 응답을 보낸다.
• 친구 목록을 조회한다.

용어 사전

모델링

Friend

• 상태
  • 식별자(Id), 사용자 식별자(FromMemberId), 상대방 식별자(ToMemberId)를 포함한다.
  • 사용자 식별자는 비어있을 수 없다.
  • 상대방 식별자는 비어있을 수 없다.
  • 사용자 식별자와 상대방 식별자는 같을 수 없다.

AskedFriendHistory

• 상태
  • 식별자(Id), 사용자 식별자(FromMemberId), 상대방 식별자(ToMemberId), 승인 여부(ApprovalStatus)를 포함한다.
  • 승인 여부는 대기(WAITING), 승인(APPROVED), 거절(REJECTED)중 하나의 정보를 가진다.
  • 사용자 식별자는 비어있을 수 없다.
  • 상대방 식별자는 비어있을 수 없다.
  • 사용자 식별자와 상대방 식별자는 같을 수 없다.
• 행위
  • 대기(WAITING)에서 승인(APPROVED)으로 변경한다.
    • 승인 여부(ApprovalStatus)가 대기(WAITING)여야 한다.
  • 대기(WAITING)에서 거절(REJECTED)로 변경한다.
    • 승인 여부(ApprovalStatus)가 대기(WAITING)여야 한다.
  • 거절(REJECTED)에서 대기(WAITING)로 변경한다.
    • 승인 여부(ApprovalStatus)가 거절(REJECTED)이어야 한다.

SocialNetworkController

• 상대방에게 친구 요청을 보낸다.
  • 회원만 사용할 수 있다.
• 자신에게 온 친구 요청을 승낙한다.
  • 회원만 사용할 수 있다.
• 자신에게 온 친구 요청을 거절한다.
  • 회원만 사용할 수 있다.
• 자신의 친구 목록을 조회한다.
  • 회원만 사용할 수 있다.
• 자신에게 온 친구 요청 목록을 확인한다.
  • 회원만 사용할 수 있다.

SocialNetworkService

• 사용자의 정보(Principal)와 상대방의 식별자(MemberId)를 입력받아 친구 요청을 보낸다.
  • 사용자의 정보가 존재해야 한다.
  • 상대방의 정보가 존재해야 한다.
• 사용자 정보(Principal)와 친구 요청 식별자(AskedFriendHistoryId)를 입력해 친구 요청을 승낙한다.
  • 요청 받은 사용자 본인이어야 한다.
  • 친구 요청을 승낙한다.
  • 친구 정보가 생성된다.
• 사용자 정보(Principal)와 친구 요청 식별자(AskedFriendHistoryId)를 입력해 친구 요청을 거절한다.
  • 요청 받은 사용자 본인이어야 한다.
  • 친구 요청을 거절한다.
• 자신의 정보(Principal)를 이용해 친구 목록을 조회한다.
• 자신의 정보(Principal)를 이용해 자신에게 온 친구 요청 목록을 확인한다.

FriendService

• 친구 정보를 저장한다.
• 친구 목록을 조회한다.
• 친구 요청 정보를 저장한다.
  • 상대방에게 보내거나 받은 이력이 있으면 안된다.
  • 생성된 친구 요청의 승인 여부(ApprovalStatus)는 대기(WAITING) 상태이거나 거절(REJECTED) 상태여아 한다.
• 친구 요청 정보를 조회한다.
• 대기(WAITING) 중인 친구 요청 목록을 조회한다.
• 친구 요청 정보를 승낙한다.
  • 친구 요청 정보가 존재해야 한다.
  • 승인 여부(ApprovalStatus)가 승인(APPROVED)으로 변경된다.
• 친구 요청 정보를 거절한다.
  • 친구 요청 정보가 존재해야 한다.
  • 승인 여부(ApprovalStatus)가 거절(REJECTED)로 변경된다.

Description

• 기존에 사용한 synchronized 락이 구현 비용은 작지만, 유지 비용이 매우 비싼 문제가 있습니다.
• 동시성 제어를 해결하기 위해 여러 기술들을 고민했고 개발, 운영 비용이 적은 Named Lock을 선택했습니다.

비교

Description

• 사용자는 같은 계좌에 이체할 수 없습니다.

How to solved

• 도메인 서비스에서 제한 조건을 생성합니다.

Description

• 자신의 계좌에서만 거래를 진행할 수 있도록 보장해야 합니다.

How to solved

• Presentation 레이어에서 로그인한 사용자의 세션 정보와 계좌 주인이 일치한지 확인합니다.

Description

• 예외 발생 위치가 명확하기 때문에 stack trace 없이 적절한 message만 로깅합니다.
• 복잡한 디버깅을 더 이상 불가능하기 때문에 Customizing Exception을 final 클래스로 변경합니다.

Description

• 안전한 API 요청을 위해 모든 요청이 멱등을 가집니다.
• 비용을 고려해 성능 목적이 아닌 멱등성만을 제공합니다.

How to solved

• 사용자는 header에 멱등성을 유지할 수 있는 키와 함께 요청을 보냅니다.
• 멱등성 키와 응답 데이터를 DB에 관리합니다.
• 요청을 보낼 때, 멱등성 키와 연관된 정보가 있을 경우 해당 정보를 반환합니다.

용어 사전

모델링

AlarmType

• 작업 상태(status)와 작업 유형(type)의 정보가 포함된다.

AlarmService

• 사용자 식별자(userId)와 작업 유형(AlarmType)에 따라 사용자에게 알림을 보낸다.
  • 외부 API를 활용해 메시지를 전송한다.