https://github.com/f-lab-edu/payment-system
여러 pg사들과 연동한 결제 시스템
https://github.com/f-lab-edu/payment-system
Last synced: 2 months ago
JSON representation
여러 pg사들과 연동한 결제 시스템
- Host: GitHub
- URL: https://github.com/f-lab-edu/payment-system
- Owner: f-lab-edu
- Created: 2023-05-30T04:38:44.000Z (about 2 years ago)
- Default Branch: develop
- Last Pushed: 2024-11-03T05:42:32.000Z (8 months ago)
- Last Synced: 2025-04-23T01:12:15.040Z (2 months ago)
- Language: Java
- Size: 359 KB
- Stars: 19
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 💰 payment-system
> 개인 프로젝트로 스프링 부트를 이용해 백엔드 개발을 했습니다.
> 금융 거래의 흐름과 결제 시스템 구조를 파악하고자 PG 사(카카오, 토스)의 결제 API를 연동한 결제 시스템을 구현했습니다.
> 기술적으로는 scale-out한 환경에서의 신뢰성 있는 결제 시스템을 제공하는 것을 목적으로 개발했습니다.
개발 기간: 2023-06~2023-07
리팩토링 기간: 2024-03-03~2024-03-18
참고사항: 보안상 비밀번호는 암호화돼서 저장됩니다.
### 📌 데이터베이스 설계
- erd cloud 이용해서 테이블 설계
:clipboard: [테이블과 테이블 구성요소](https://closed-glade-095.notion.site/ERD-12a05418296180749115c05f3ea76b50?pvs=4)
### 📌 개발 스택
* for Application : `Java 17` `Spring boot` `MySQL` `JPA` `QueryDSL` `Junit5` `Redis`
### 📁 폴더 구조
🧷 프로젝트 구조 펼쳐보기
```bash
main
├── java
│ ├── flab.payment_system
│ │ ├── adapter # 다른 패키지(도메인)의 클래스를 사용할 때
│ │ │ ├── OrderAdapter
│ │ │ ├── OrderAdapterImpl
│ │ │ ├── PaymentAdapter
│ │ │ ├── PaymentAdapterImpl
│ │ │ ├── RedissonLockAdapter
│ │ │ ├── RedissonLockAdapterImpl
│ │ │ ├── UserAdapter
│ │ │ └── UserAdapterImpl
│ │ ├── common # 공통
│ │ │ ├── data
│ │ │ │ └── BaseEntity
│ │ │ ├── enums
│ │ │ │ └── Constant
│ │ │ ├── exception # 각 domain 의 예외들은 아래 예외들을 상속받음
│ │ │ │ ├── BadRequestException
│ │ │ │ ├── BaseException
│ │ │ │ ├── ConflictException
│ │ │ │ ├── CustomExceptionHandler
│ │ │ │ ├── ExceptionMessage
│ │ │ │ ├── NotFoundException
│ │ │ │ ├── ForbiddenException
│ │ │ │ ├── OkException
│ │ │ │ ├── ServiceUnavailableException
│ │ │ │ └── UnauthorizedException
│ │ │ ├── filter
│ │ │ │ ├── ExceptionHandlerFilter
│ │ │ │ └── SignInCheckFilter
│ │ │ ├── interceptor
│ │ │ │ └── LoggingInterceptor
│ │ │ ├── response
│ │ │ │ └── ResponseMessage
│ │ │ └── utils
│ │ │ │ ├── CookieUtil
│ │ │ │ └── IpUtil
│ │ ├── config # 설정
│ │ │ ├── AppConfig
│ │ │ ├── PaymentStrategyConfig
│ │ │ ├── QueryDslConfig
│ │ │ ├── RedisConfig
│ │ │ └── WebConfig
│ │ ├── domain
│ │ │ ├── batch # 보상 트랜잭션을 위해 주기적으로 PG 사의 엑셀 파일과 데이터베이스를 비교해 데이터를 일치시켜주는 batch
│ │ │ │ ├── compensation
│ │ │ │ │ ├── CompensationConfig
│ │ │ │ │ ├── CompensationItemProcessor
│ │ │ │ │ ├── CompensationItemReader
│ │ │ │ │ ├── CompensationItemWrite
│ │ │ │ │ ├── CompensationJobConfig
│ │ │ │ │ └── CompensationStepExecutionListener
│ │ │ │ │ │ ├── correction
│ │ │ │ │ │ │ └── CorrectionFileWriter
│ │ │ │ │ │ ├── enums
│ │ │ │ │ │ │ └── PGManageName
│ │ │ │ │ │ ├── exception
│ │ │ │ │ │ │ └── CompensationFileNotFoundException
│ │ │ │ │ │ ├── file
│ │ │ │ │ │ │ ├── controller
│ │ │ │ │ │ │ │ └── CompensationFileController
│ │ │ │ │ │ │ ├── service
│ │ │ │ │ │ │ │ └── CompensationFileService
│ │ │ ├── log # 로그
│ │ │ │ ├── entity
│ │ │ │ │ └── AppLogs
│ │ │ ├── mail # 유저에게 이메일 보낼 때(회원가입을 위한 유저 인증번호 발송)
│ │ │ │ ├── service
│ │ │ │ │ └── MailService
│ │ │ ├── order # 주문 생성/ 주문 조회
│ │ │ │ ├── controller
│ │ │ │ │ └── OrderController
│ │ │ │ ├── entity
│ │ │ │ │ └── OrderProduct
│ │ │ │ ├── dto
│ │ │ │ │ ├── OrderCancelDto
│ │ │ │ │ ├── OrderDetailDto
│ │ │ │ │ ├── OrderDto
│ │ │ │ │ └── OrderProductDto
│ │ │ │ ├── exception
│ │ │ │ │ └── OrderNotExistBadRequestException
│ │ │ │ ├── repository
│ │ │ │ │ ├── OrderCustomRepository
│ │ │ │ │ ├── OrderCustomRepositoryImpl
│ │ │ │ │ └── OrderRepository
│ │ │ │ ├── service
│ │ │ │ │ └── OrderService
│ │ │ ├── payment # 단건 결제(결제 생성, 결제 실패, 결제 승인) / 결제 취소
│ │ │ │ ├── client # PG 사와 통신
│ │ │ │ │ ├── kakao
│ │ │ │ │ │ └── PaymentKakaoClient
│ │ │ │ │ ├── toss
│ │ │ │ │ │ └── PaymentTossClient
│ │ │ │ ├── controller
│ │ │ │ │ └── PaymentController
│ │ │ │ ├── entity
│ │ │ │ │ ├── Payment
│ │ │ │ │ │ ├── kakao
│ │ │ │ │ │ │ ├── Amount
│ │ │ │ │ │ │ ├── ApprovedCancelAmount
│ │ │ │ │ │ │ ├── CancelAvailableAmount
│ │ │ │ │ │ │ ├── CanceledAmount
│ │ │ │ │ │ │ ├── CardInfo
│ │ │ │ │ │ │ ├── KakaoPayment
│ │ │ │ │ │ │ └── PaymentActionDetails
│ │ │ │ │ │ ├── toss
│ │ │ │ │ │ │ ├── Cacnels
│ │ │ │ │ │ │ ├── Card
│ │ │ │ │ │ │ ├── CashReceipt
│ │ │ │ │ │ │ ├── Checkout
│ │ │ │ │ │ │ ├── Discount
│ │ │ │ │ │ │ ├── EasyPay
│ │ │ │ │ │ │ ├── Failure
│ │ │ │ │ │ │ ├── GiftCertificate
│ │ │ │ │ │ │ ├── MobilePhone
│ │ │ │ │ │ │ ├── Receipt
│ │ │ │ │ │ │ ├── RefundReceiveAccount
│ │ │ │ │ │ │ ├── TossPayment
│ │ │ │ │ │ │ ├── Transfer
│ │ │ │ │ │ │ └── VirtualAccount
│ │ │ │ ├── enums
│ │ │ │ │ ├── PaymentPgCompany
│ │ │ │ │ ├── PaymentPgCompanyStringToEnumConverter
│ │ │ │ │ └── PaymentStateConstant
│ │ │ │ ├── exception
│ │ │ │ │ ├── PaymentAlreadyApprovedConflictException
│ │ │ │ │ ├── PaymentFailBadRequestException
│ │ │ │ │ ├── PaymentKakaoServiceUnavailableException
│ │ │ │ │ ├── PaymentNotApprovedConflictException
│ │ │ │ │ ├── PaymentNotExistBadRequestException
│ │ │ │ │ └── PaymentTossServiceUnavailableException
│ │ │ │ ├── repository
│ │ │ │ │ ├── PaymentCustomRepository
│ │ │ │ │ ├── PaymentCustomRepositoryImpl
│ │ │ │ │ ├── PaymentRepository
│ │ │ │ │ ├── kakao
│ │ │ │ │ │ ├── KakaoPaymentCustomRepository
│ │ │ │ │ │ ├── KakaoPaymentCustomRepositoryImpl
│ │ │ │ │ │ └── KakaoPaymentRepository
│ │ │ │ │ ├── toss
│ │ │ │ │ │ ├── TossPaymentCustomRepository
│ │ │ │ │ │ ├── TossPaymentCustomRepositoryImpl
│ │ │ │ │ │ └── TossPaymentRepository
│ │ │ │ ├── request
│ │ │ │ │ ├── kakao
│ │ │ │ │ │ └── PaymentKakaoRequestBodyFactory
│ │ │ │ │ ├── toss
│ │ │ │ │ │ └── PaymentTossRequestBodyFactory
│ │ │ │ ├── response
│ │ │ │ │ ├── PaymentApprovalDto
│ │ │ │ │ ├── PaymentCancelDto
│ │ │ │ │ ├── PaymentOrderDetailDto
│ │ │ │ │ ├── PaymentReadyDto
│ │ │ │ │ ├── kakao
│ │ │ │ │ │ ├── PaymentKakao
│ │ │ │ │ │ ├── PaymentKakaoApprovalDtoImpl
│ │ │ │ │ │ ├── PaymentKakaoCancelDtoImpl
│ │ │ │ │ │ ├── PaymentKakaoOrderDetailDtoImpl
│ │ │ │ │ │ └── PaymentKakaoReadyDtoImpl
│ │ │ │ │ ├── toss
│ │ │ │ │ │ ├── PaymentToss
│ │ │ │ │ │ └── PaymentTossDtoImpl
│ │ │ │ ├── service
│ │ │ │ │ ├── PaymentService
│ │ │ │ │ ├── PaymentStrategy # enums - PaymentPgCompany 값에 따라서 해당 인터페이스를 구현한 전략 서비스 호출
│ │ │ │ │ ├── kakao
│ │ │ │ │ │ └── PaymentStrategyKakaoService
│ │ │ │ │ ├── toss
│ │ │ │ │ │ └── PaymentStrategyTossService
│ │ │ │ ├── product # 상품 목록 조회, 특정 상품 조회
│ │ │ │ │ ├── controller
│ │ │ │ │ │ └── ProductController
│ │ │ │ │ ├── dto
│ │ │ │ │ │ └── ProductDto
│ │ │ │ │ ├── entity
│ │ │ │ │ │ └── Product
│ │ │ │ │ ├── exception
│ │ │ │ │ │ ├── ProductNotExistBadRequestException
│ │ │ │ │ │ └── ProductSoldOutException
│ │ │ │ │ ├── repository
│ │ │ │ │ │ ├── ProductCustomRepository
│ │ │ │ │ │ ├── ProductCustomRepositoryImpl
│ │ │ │ │ │ └── ProductRepository
│ │ │ │ │ ├── service
│ │ │ │ │ │ └── ProductService
│ │ │ │ ├── redisson # 재고 증감 시 발생할 수 있는 동시성 이슈 처리를 위한 redisson lock
│ │ │ │ │ ├── service
│ │ │ │ │ │ └── RedissonLockService
│ │ │ │ ├── session
│ │ │ │ │ ├── service
│ │ │ │ │ │ └── SessionService
│ │ │ │ ├── user
│ │ │ │ │ ├── controller
│ │ │ │ │ │ └── UserController
│ │ │ │ │ ├── dto
│ │ │ │ │ │ ├── UserConfirmVerificationNumberDto
│ │ │ │ │ │ ├── UserDto
│ │ │ │ │ │ ├── UserSignUpDto
│ │ │ │ │ │ ├── UserVerificationDto
│ │ │ │ │ │ └── UserVerifiyEmailDto
│ │ │ │ │ ├── entity
│ │ │ │ │ │ ├── User
│ │ │ │ │ │ └── UserVerification
│ │ │ │ │ ├── exception
│ │ │ │ │ │ ├── UserAlreadySignInConflictException
│ │ │ │ │ │ ├── UserEmailAlreadyExistConflictException
│ │ │ │ │ │ ├── UserEmailNotExistBadReqeuestException
│ │ │ │ │ │ ├── UserNotSignInedConflictException
│ │ │ │ │ │ ├── UserPasswordFailBadRequestException
│ │ │ │ │ │ ├── UserSignUpBadRequestException
│ │ │ │ │ │ ├── UserUnauthorizedException
│ │ │ │ │ │ ├── UserVerificationEmailBadReqeust
│ │ │ │ │ │ ├── UserVerificationIdBadRequestException
│ │ │ │ │ │ ├── UserVerificationNumberBadRequestException
│ │ │ │ │ │ ├── UserVerificationUnautorizedExcpetion
│ │ │ │ │ │ └── UserVerifyUserEmailException
│ │ │ │ │ ├── repository
│ │ │ │ │ │ ├── UserCustomRepository
│ │ │ │ │ │ ├── UserCustomRepositoryImpl
│ │ │ │ │ │ ├── UserRepository
│ │ │ │ │ │ └── UserVerificationRepository
│ │ │ │ │ ├── service
│ │ │ │ │ │ └── UserService
│ │ │ │ └── PaymentSystemApplication
├── resources
│ ├── templates
│ │ └── mail.html
│ ├── application.yml
│ ├── application-test.yml
│ ├── log4j2-local.xml
│ ├── log4j2-prod.xml
│ ├── payment_kakao.csv # 배치 시스템에 필요한 예시 엑셀 파일, 주기적으로 PG 사의 API와 통신해 엑셀 파일을 가져와 데이터베이스의 데이터와 비교할 것이라 가정
└ └── payment_toss.csv
```
### 📌 주요 기능
1) 회원가입 & 로그인
- Redis 기반 세션 관리로 확장 가능한 인증 시스템 구축
- 보안을 위해 bcrypt로 암호화해서 비밀번호 저장
2) 주문
- reddison 분산 락을 이용해 재고 증감 시 발생할 수 있는 동시성 이슈 처리
3) 단건 결제 / 결제 취소 / 단건 주문 조회
- 카카오, 토스 PG 사 연동
- enum 값으로 PG 사 식별
- 전략 패턴을 이용해서 하나의 인터페이스 및 로직으로 여러 PG 사 API 사용
- 테스트 키 사용해서 실제 결제는 일어나지 않음
- orderId를 식별자로 결제 정보(Payment Entity)를 생성했으며, 하나의 orderId에 대해 하나의 결제 정보 만 생성
- 단건 결제 프로세스는 아래와 같습니다.
- 단건 결제
- 단건 결제 기능 하나를 구현하기 위해 3개의 API가 필요했습니다. (결제 생성 API / 결제 승인 API/ 결제 실패 API)
- 결제 취소
- 기존에 승인된 결제만 취소할 수 있습니다.
- 주문 조회
- 승인된 결제 정보를 조회할 수 있습니다.
상용 애플리케이션을 참고하는 과정에서 결제 완료 후 서버에서 승인 응답을 받지 못했는데 실제로 결제는 완료된 경우를 발견했습니다. 이로 인해 서버와 PG 사 간 결제 데이터가 일치하지 않을 수 있는 가능성을 발견했습니다. 타임아웃 설정으로 인해 PG 사는 결제 승인을 보내지만 서버가 응답을 받지 못해 결제 실패로 처리할 것이고, 이를 해결하고자 개선이 필요하다고 판단했습니다. Spring Batch 스케줄링을 도입하여 주기적으로 PG 사의 결제 승인 데이터(정산API 사용)와 서버 데이터를 비교하는 시스템을 구현했습니다. 결제 정보가 일치하지 않을 경우 수정되도록 하여 데이터 정합성을 보장했습니다. 또한 대규모 데이터 처리 성능을 향상시키기 위해 멀티스레딩과 파티셔닝을 적용해 병렬 처리를 가능하게 했습니다.
4) 상품 목록 조회
- 결제 시스템에 집중하고자 상품에 대한 명확한 설계는 하지는 않았지만, 대규모 트래픽이 유입되는 사이트에서 자주 삽입이나 수정이 되지 않는 대용량 데이터에서의 페이지네이션을 한다 가정했습니다.
- 대용량 데이터를 조회할 때 offset limit 방식의 페이지네이션을 하면, 성능이 느려지는 경우가 있기 때문에 커서 기반의 페이지네이션 방식을 취했습니다.
- 대규모 트래픽이 오가면 자주 조회될 것이기에, Redis를 이용한 캐싱을 해줬습니다.
### 📌 리팩토링
> 기존에 Exception 클래스들을 정의할 때 RuntimeException을 바로 상속받게 하고 일일이 메세지와 코드를 새로 정의해 주었습니다. Exception Handler에서 핸들링할 때도 아래와 같이 각 예외 별로 처리해 주다 보니 예외를 하나 추가할 때마다 반복적인 코드가 늘어났습니다.
- 기존의 예외 핸들러 코드
```
public class CustomExceptionHandler extends ResponseEntityExceptionHandler {
// 예외 별로 핸들링
@ExceptionHandler(UserVerificationIdBadRequestException.class)
```
>
>
> 이를 해결하기 위해 Exception은 BaseException과 상태 코드 별로 BaseException을 상속받은 예외들을 정의해 줌으로써 hierarchy 구조로 리팩토링했습니다. 리팩토링을 할 때 초기 시간적 비용이 들어가긴 했지만, 장기적으로 봤을 때 예외를 하나 추가할 때마다 드는 반복적인 작업 시간이 줄어들었고, 아래와 같이 핸들러에서 포괄적으로 처리해 줌으로써 예외 처리가 편리해졌습니다.
- 수정된 예외 핸들러 코드
```
public class CustomExceptionHandler {
// 해당 프로젝트의 모든 예외는 BaseException을 상속받음
@ExceptionHandler(BaseException.class)
public ResponseEntity handleBaseException(BaseException baseException) {
```
### 📌 개선하고 싶은점
> 프로젝트 기한이 부족해서 적용하고 싶은 부분을 모두 반영하지는 못했습니다. 시간이 더 주어진다면 아래와 같은 항목들을 적용하고 싶습니다. (리팩토링 기간: 2024-03-03~2024-03-18)
1. PG 사에서 보관 중인 결제 정보와 해당 서버의 결제 정보가 완벽히 호환되기는 힘들 거라고 생각했습니다. 예를 들면 pg 서버에서는 성공적으로 처리된 결제지만 서버에서는 timeout 등의 문제로 실패된 결제라고 처리되는 경우가 있겠습니다. 이를 호환해 주기 위해서 주기적으로 pg 사에서 결제 정보를 파일로 받아와서 해당 서버의 데이터베이스 정보와 비교해 결제 데이터를 맞춰주는 배치 시스템이 있을 것이고 이를 반영하고 싶다는 생각을 했습니다. -> 적용
(2024-07-28)
1. 스케쥴링을 위해 spring batch를 사용했지만 대용량 데이터 처리시 성능 이슈가 생길 수 있다는 것을 알았습니다. 추후 기회가 된다면 성능 개선을 해보고 싶습니다.
2. 통합 테스트 작성 시 성공 케이스만 작성을 했는데 실패 케이스까지 작성을 해줘야한다는 것을 알게 됐습니다. 추후 기회가 된다면 적용하고 싶습니다.
### 📝 회고록
외부 API 를 사용해서 프로젝트를 진행하는 것은 처음이다 보니 문서를 이해하고 적용하는데 시간이 많이 걸려서 프로젝트를 진행하는데 기한이 부족했습니다. 다음번에는 외부 API 를 사용할 일이 있다면 공통 flow를 이해한 뒤 세부적인 문서를 읽는 것이 좋겠다는 생각이 들었습니다.