deftkang의 IT 블로그

apple:
  oauth2:
    host: https://appleid.apple.com/auth/authorize
    clientId: 
    response_mode: form_post
    response_type: code id_token
    scope: name email
    redirectUri:

다른 ouath2는 code를 받아서 accessToken을 조회하지만 apple만 id_token의 값으로 email을 추출하고 처음 로그인 사용자시에 나오는 name 데이터로 이름을 받을수있다.

아래가 그 redirect URL인데 code는 받지 않고 id_token과 user만 받는다.

name은 firstName과 lastName으로 나뉘어서 온다.

위 파라미터의 name은 처음 로그인 사용자에게만 뜨는 화면이 있고 그 화면에 설정한대로 나온다. 화면은 아래와 같다.

처음 로그인 사용자는 이름을 수정하거나 그대로 사용할수있고, 이메일도 나의 이메일을 그대로 사용할것인지 아니면 감출것인지 설정할수있다. 만약 감추기를 하면 email은 진짜로 사용하는 이메일이 아닌 다른 이메일로 오게된다. 그래서 만약 같은 구글이메일을 애플이메일로 사용했을때 구글 로그인과 애플로그인은 같은 사용자로 취급해야 하지만 애플이메일을 감추게 되면 새로운 사용자로 될수밖에 없다.

이점이 애플만이 가지는 쫌 까다로운 점이다.

[Oauth2] Google 메일 알림 구독 개발 콘솔 설정 방법

deftkang — Fri, 23 May 2025 15:17:42 +0900

구글은 email이나 calenar에 대한 알림을 구독 하려면

Pub/Sub을 이용해야 한다.

https://console.cloud.google.com/cloudpubsub

위 URL에 접속해서 Topics에 들어간다음 Topic을 만들고

구독을 추가 하면된다. 전송유형은 push로 해서 알림을 받을 endpoint를 기입해주면 된다.

그리고 소스에서는 구글 sdk를 이용해서 WatchRequest()에 그 위에서만든 토픽 이름을 이용해서 watchRequest 객체를 만들고

val resourceList = listOf("INBOX")

/**
 * Gmail watch 요청은 Cloud Pub/Sub 이용하여 푸시 알림을 전달
 */
val watchRequest = WatchRequest().apply {
    topicName = properties.subscriptionTopic
    labelIds = resourceList // Only monitor INBOX emails
    labelFilterAction = "include"
}

구독을 API를 신청하면된다.

val watchResponse = gmailService.users().watch("me", watchRequest).execute()

[에러해결]

Topic의 Publisher 권한이 없으면 Gmail Watch 요청 시 다음 에러가 발생한다.

{
  "code": 403,
  "message": "User not authorized to perform this action.",
  "errors": [
    {
      "reason": "forbidden",
      "message": "Error sending test message to Cloud PubSub..."
    }
  ]
}

User not authorized to perform this action.","status":"PERMISSION_DENIED"

해결하려면 아래 Permission을 추가해줘야 한다.

IAM 에서 계정을 추가후에 위에 ADD Principal 에서 넣어주면 된다.

gmail-api-push@system.gserviceaccount.com

publisher 설정 필수 !!!

[Oauth2] Microsoft 로그인과 API 사용하기 위한 console 세팅

deftkang — Tue, 20 May 2025 15:07:10 +0900

portal.azure.com 사이트로 로그인해서 Microsoft Entra ID 서비스로 들어간다.

그 다음 왼쪽 탬 관리에서 앱등록 으로 들어가서 앱등록을 한다.

앱 등록에서는 지원되는 계정 유형이 있다., 모든 조직계정과 개인계정이 사용될수 있도록 하려면 아래 3번째꺼를 선택하면된다.

만들어진 앱에서 클라이언트 ID와 시크릿 키를 발급받으면 된다.

그리고 관리>인증에서 웹 리디렉션 URI를 기입하면된다.

그리고 왼쪽 탭 관리>API 사용권한 에서 사용자가 사용할수 있는 API 사용 권한을 추가 해줘야 한다. 여기서는 사용자가 API 를 사용요청을 하였을때 그 API에 대한 권한을 열어주기 위함이다.

권한추가 > Microsoft Graph > 위임된 권한 에서 권한 선택 칸에서 검색하고 권한을 선택하고 추가하면된다.

만약에 Oauth2로 로그인을 하는데 사용자에 대한 email을 가져오려면 email을 추가해줘야 한다.

SpringBoot 단일 모듈에서 소스 공통화를 위해 멀티모듈로 변경

deftkang — Thu, 10 Apr 2025 21:29:04 +0900

회사에서 기존 B2B 소스를 기반으로 B2C 개발을 진행하기로 했다. B2B에서 쓰던 공통 소스들이 분명 있을거고, 또 B2B에서 적용될거와 B2C에 적용될게 동시에 있을게 분명하였다. 공통 부분을 관리해서 B2C와 B2B에 같이 적용시키기 위해서 멀티모듈을 하자고 제안했다.

우선 B2B 소스를 멀티모듈로 나눠야 했었는데 Application, Service, Repository 레이어드 아키텍처 기반으로 분리를 하였다.

그리고 실제 작업의 모듈 이름은 아래와 같이 common, b2b-api, common-service, common-domain 으로 분리를 하였다.

setting.gradle.kts 파일에서 include 안에 모듈명을 인입하여 모듈을 생성하면 된다.

setting.gradle.kts 세팅

구성 설명

goyoai-backend-system

├── goyoai-web-common/

├── goyoai-web-common-domain

├── goyoai-web-common-service

├── goyoai-web-b2b

├── goyoai-web-b2c

b2b를 레이어드 아키텍쳐에 따라 application, service, domain 계층으로 나누었다.

application → service → domain 모듈로 나누고 경계를 구분하였다.

application계층 : controller
service계층: dto, service (비즈니스 로직)
domain계층: entity, dao, enumeration (데이터 구조 정의)

goyoai-web-common

모든 모듈에서 사용될 공통 소스 어떠한 의존성도 맺으면 안된다.

goyoai-web-common-domain

공통으로 사용될 데이터관리 소스(entity, dao, enumeration)만 있다.
goyoai-web-common 만 의존한다.

goyoai-web-common-service

공통으로 사용될 서비스 소스(service) 비즈니스 로직이다.
goyoai-web-common, goyoai-web-common-domain 만 의존하여야 한다.

goyoai-web-b2b

b2b의 controller와 공통에서 사용되지 않고 b2b용으로 커스텀돼서 사용될 소스이다.
위에서 만든 common쪽 모두 의존한다.

goyoai-web-b2b

b2c의 controller와 공통에서 사용되지 않고 b2c용으로 커스텀돼서 사용될 소스이다.
위에서 만든 common쪽 모두 의존한다.

Common쪽에서 관리되는 파일에서 b2b, b2c로 나뉘어졌을때

앞의 접두사로 B2B, B2C 기입한다.

ex) B2BUserService, B2CUserService

build.gradle.kts 세팅

루트 모듈에서의 build.gradle.kts

루트모듈에서는 allprojects와, subprojects를 설정 해줘야한다.

allprojects {} : (루트 + 하위) 모듈 plugin 및 공통 의존성 세팅

subprojects {} : 하위 모듈의 의존성 세팅

allporjedcts 설정에는 프로젝트에 대한 설명과 사용할 plugin들 설정 그리고 tasks 설정이다.

application 계층의 모듈 빼고는 bootWar나 bootJar가 필요없고 jar만 있으면 되기 때문에 jar만 생성되도록 만들었다.

allprojects {
    description = "GoyoAi Web Service"
    group = "io.goyoai.web"
    version = "2.0.0"

    apply(plugin = "java")
    apply(plugin = "kotlin")
    apply(plugin = "kotlin-spring")
    apply(plugin = "kotlin-jpa")
    apply(plugin = "kotlin-kapt")

    dependencyManagement {
        val springCloudVersion = "2022.0.4"
        imports {
            mavenBom("org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}")
        }
    }

    allOpen {
        annotation("jakarta.persistence.Entity")
        annotation("jakarta.persistence.MappedSuperclass")
        annotation("jakarta.persistence.Embeddable")
    }

    repositories {
        mavenCentral()
        maven { url = uri("https://repo.spring.io/milestone") }
        maven { url = uri("https://repo.spring.io/snapshot") }
    }

    // 라이브러리용 jar만 생성
    tasks.getByName<Jar>("jar") {
        enabled = true
    }

    tasks.getByName<War>("war") {
        enabled = false
    }

    tasks.bootJar {
        enabled = false
    }

    tasks.bootWar {
        enabled = false
    }


    tasks.test {
        enabled = false
    }
}

// 하위 모듈만 설정
subprojects {
    dependencies {
        // starter
        implementation("org.springframework.boot:spring-boot-starter-data-jpa:3.1.6")
        implementation("org.springframework.boot:spring-boot-starter-validation:3.1.6")
        implementation("org.springframework.boot:spring-boot-starter-web:3.2.0")
        implementation("org.springframework.boot:spring-boot-starter-mail:3.1.6")
        implementation("org.springframework.boot:spring-boot-starter-thymeleaf:3.1.6")
        implementation("org.springframework.boot:spring-boot-starter-data-redis:3.1.6")
        implementation("org.springframework.session:spring-session-data-redis:3.1.6")
        implementation("org.springframework.cloud:spring-cloud-starter-openfeign:4.0.4")
        implementation("com.github.ulisesbocchio:jasypt-spring-boot-starter:3.0.5")
    }

하위 모듈에서의 build.gradle.kts

1. application 계층에 서는 common과, common-service를 의존성 맺고 배포를 해야되기 때문에 bootWar를 만들어야 한다.

그리고 swagger같은 application 계층에서만 필요한 의존성들을 넣고 설정한다.

application 계층의 build.gradle.kts

domain 계층에서는 common인 공통 모듈만 의존하고, service에서는 common과 도메인계층만 의존한다.

멀티 모듈 이유

1. 의존성 방향을 깔끔하게 유지하기 위해

application → service → domain 방향으로 의존을 맺기 때문에 서로 의존하지 못하게 강제할수있음 유지보수 확장성을 증대한다.
- 예를들어서 사용자에게 보여줄 dto를 domain계층에서 사용되고 있다면 이것은 domain계층이 application 계층에 의존하고 있다 이것을 강제로 분리하게 해서 의존을 못맺게 하니 명확하게 구분지어줄수있다.
공통 소스를 common 으로 분리해서 b2b와 b2c 동시 적용 가능하다(재사용성, 공통화 가능)
domain, service 를 나눔으로써 다른 서비스가 모듈로 들어왔을때 domain만 의존해서 사용가능 하다.

고민

아래 우아한 기술블로그에서도 보면은 우리와 동일하게 service에서 사용자에게 보여줄 dto를 만들고 요청데이터 그대로 service에서 받고 있었는데 이러면 service가 controller에 종속적이게 된다고해서 안좋다고 한다.

위 사례로 따지면 레이어드 아키텍쳐를 구분했을때 원래는 controller에서 service로 요청보내는 request dto와 service에서 controller로 보내는 response dto를 따로 만들어줘야 한다. 그래도 dto가 service에서 있고 application 계층에도 따로 있어야 하지만

지금은 service에서 모두 dto를 관리해서 service에서만 사용된다. dto를 service 계층에 맞게 다 따로 만들어줘야 되는데 너무 시간이 오래걸리고 앞으로도 그렇게 하자니 개발하는데 너무 힘들것같다. 우선은 dto를 service 계층에 넣었지만 지금당장은 바꾸기 힘들것같다. 나중에 꼭 필요하다고 생각될 이유가 있을때 바꿔야 할것같다.

참고자료

https://engineerinsight.tistory.com/63

https://techblog.woowahan.com/2711/

[SpringBoot] 포트원 API 이용한 결제 기능 추가

deftkang — Mon, 23 Sep 2024 19:39:06 +0900

결제 연동을 하기 위해서는 가장 간단한 방법으로 포트원 API를 이용하는 것이다. 각 PG사에서 제공하는 API를 이용하여 개발해야 하고 각 PG사마다 제공하는 API에 맞게 개발을 해야 하는데 포트원 API를 사용하면 모든 PG사와 결제수단을 쉽게 이용할 수 있다. 그리고 테스트 연동도 제공한다. 테스트 연동을 하면 자정 전에 결제 취소가 자동으로 된다.

PG는 Payment Gateway 약자로 거래 및 결제를 도와주는 결제 대행사이다. 포트원은 모든 PG 모아서 한 번에 제공해 준다.

포트원 API 결제 프로세스

결제 프로세스는 간단하다. 구매 페이지에서 결제창을 호출하고 PG사에 결제 인증을 요청한 다음 PG사에서 받은 결제 키 전달받는다. 그리고 PG사에 결제 요청을 하고 카드사에 결제 요청을 한 다음 고객은 결제 결과를 받는다.

결제 연동

포트원 관리자 콘솔에서 채널추가

결제 연동을 하기 위해서 먼저 포트원 관리자 콘솔에서 채널을 만들어야 한다.

왼쪽 탭 결제 연동 > 연동 정보에서 아래 정보대로 채널을 추가한다.

결제대행사 칸에서 KG이니시스를 선택하고, 결제 모듈은 일반/정기결제 선택 후 다음 누르고 채널 추가 화면에서 채널이름을 기입하고 PG 상점아이디를 INIpayTest를 선택하면 된다.

의존성 추가

프로젝트 build.gradle.kts 파일에 아래 의존성을 추가한다.

repositories {
    mavenCentral()
    maven(url = "https://jitpack.io")
}

dependencies {
	implementation("com.github.iamport:iamport-rest-client-java:0.2.23")
}

repositores에 maven(url = "https://jitpack.io")을 추가하여 GitHub 저장소에 있는 프로젝트를 의존성으로 추가할 수 있다.

결제창 호출

위에서 봤드시 결제를 하려면 결제창을 먼저 호출해야 한다. 결제창 호출 가이드 문서를 보면 SDK를 추가하기 위해 script를 추가하고

<script src="https://cdn.iamport.kr/v1/iamport.js"></script>

그다음엔 포트원 SDK 초기화를 한다.

저 고객사 식별코드는 연동정보 > 식별코드에서 고객사 식별코드 탭의 정보이다.

그리고 결제창 불러오기를 IMP.request_pay() 함수를 호출해서 열 수가 있다.

pg: 정보 기입란에 {PG사 코드}.{상점 ID}를 넣어줘야 하는데 포트원 콘솔에서 채널정보에서 알 수 있다.

PG사 코드값은 PG Provider의 값이고, 상점 ID는 PG상점 아이디의 값이다.

위 정보를 토대로 하면 pg 값은 "html5_inicis.INIpayTest" 이고, 아래는 script 코드이다.

<script>
    var IMP = window.IMP;
    IMP.init("imp22283555");

    function requestPay() {
        const productId = document.getElementById("productId").value;
        const itemId = document.getElementById("itemId").value;
        const itemOption = document.getElementById("itemOption").value;
        const itemName = document.getElementById('itemName').value;
        const quantity = document.getElementById('quantity').value;
        const price = document.getElementById('price').value;
        const buyerEmail = document.getElementById('buyerEmail').value;
        const buyerName = document.getElementById('buyerName').value;
        const buyerTelNo = document.getElementById('buyerTelNo').value;
        const postCode = document.getElementById('sample4_postcode').value;
        const addr = document.getElementById('sample4_jibunAddress').value;

        IMP.request_pay(
            {
                pg: "html5_inicis.INIpayTest",
                pay_method: "card",
                merchant_uid: `payment-${crypto.randomUUID()}`, // 주문 고유 번호
                name: itemName,
                amount: price,
                buyer_email: buyerEmail,
                buyer_name: buyerName,
                buyer_tel: buyerTelNo,
                buyer_addr: addr,
                buyer_postcode: postCode,
            },
            function (response) {
                // 결제 종료 시 호출되는 콜백 함수
                // response.imp_uid 값으로 결제 단건조회 API를 호출하여 결제 결과를 확인하고,
                // 결제 결과를 처리하는 로직을 작성합니다.
                if (response.success) {
                    if (response.success) {
                        console.log("구매이력 저장 로직실행")
                    }
                } else {
                    console.log(response)
                    alert(response)
                }
            },
        );
    }

상품명과 금액, 구매자 정보는 UI에서 가져와서 인입해줬다. 주소는 카카오지도 API를 이용했다.

결제화면과 결제창 호출과 결제

html 화면을 간단하게 만들어서 KG 이니시스 결제창 불러오기를 성공하였고 결제를 하게 되면 포트원 콘솔 통합 결제 메뉴에서 확인이 가능하다.

필터에서 테스트 결제를 체크해야만 한다.

결제를 성공하면 아래 처럼 reponse가 오고 success필드는 true이다. 이 결제 내역의 imp_uid나 merchant_uid를 통해서 결제를 취소할 수 있다.

[response JSON 값]

response 예제
{
    "success": true,
    "imp_uid": "imp_35168980131",
    "pay_method": "card",
    "merchant_uid": "payment-41693333-e87b-468e-be62-b4485123",
    "name": "오구 슬리퍼",
    "paid_amount": 1990,
    "currency": "KRW",
    "pg_provider": "html5_inicis",
    "pg_type": "payment",
    "pg_tid": "StdpayCARDINIpayTest20240907044147199999",
    "apply_num": "123415",
    "buyer_name": "토비",
    "buyer_email": "test@naver.com",
    "buyer_tel": "010-1111-1111",
    "buyer_addr": "서울 노원구 공릉동",
    "buyer_postcode": "01111",
    "custom_data": null,
    "status": "paid",
    "paid_at": 1725651707,
    "receipt_url": "https://iniweb.inicis.com/DefaultWebApp/mall/cr/cm/mCmReceipt_head.jsp?noTid=StdpayCARDINIpayTest20240907044147194653&noMethod=1",
    "card_name": "BC카드",
    "bank_name": null,
    "card_quota": 0,
    "card_number": "910003*********5"
}

결제가 성공하면 위 구매이력을 DB에 저장하고, 재고를 차감하였다.

[script 코드]

if (response.success) {
    console.log("구매이력 저장과 재고차감 로직실행")
    fetch("/v1/payments", {
        method: "POST",
        headers: {
            "Content-Type": "application/json",
        },
        body: JSON.stringify({
            productId: productId,
            itemId: itemId,
            impUid: response.imp_uid,
            merchantUid: response.merchant_uid,
            itemName: response.name,
            itemOption: itemOption,
            buyQuantity: quantity,
            paidAmount: response.paid_amount,
            buyerName: response.buyer_name,
            buyerEmail: response.buyer_email,
            buyerTelNo: response.buyer_tel,
            buyerAddr: response.buyer_addr,
            buyerPostCode: response.buyer_postcode,
        }),
    }).then((res) => res.json())
        .then((res) => {
            console.log(res)
            if (res.success) {
                alert(res.message);
            } else {
                alert(res.message);
            }
        }).catch(() => {
        alert("ajax 호출 에러")
    });
}

[Kotlin 코드]

@PostMapping("/v1/payments")
fun savePayment(@RequestBody savePaymentRequest: SavePaymentRequest): ResponseEntity<MessageDTO> {
    log.info { "/v1/payment post 요청 실행" }

    paymentServiceApplication.savePayment(savePaymentRequest)

    val messageDTO = MessageDTO(
        HttpStatus.OK.value(),
        "상품을 구매 완료 하였습니다."
    )

    return ResponseEntity(messageDTO, HttpStatus.OK)
}

@Transactional
fun savePayment(savePaymentRequest: SavePaymentRequest) {
    //재고차감
    log.info { "재고차감 로직 실행" }
    val item = itemService.getItemById(savePaymentRequest.itemId)
    itemService.deductItemStock(item, savePaymentRequest.buyQuantity)

    //구매이력 저장
    log.info { "구매이력 저장 실행" }
    paymentService.savePayment(savePaymentRequest)
}

@Transactional
fun deductItemStock(item: Item, quantity: Int) {
    val updatedStock: Int = item.stock - quantity
    item.updateStock(updatedStock)
}

@Transactional
fun savePayment(savePaymentRequest: SavePaymentRequest) {
    val payment = savePaymentRequest.toPayment()
    paymentRepository.save(payment)
}

[SpringBoot] Kotlin 프로젝트에서 Vault 운영 서버 구축

deftkang — Tue, 17 Sep 2024 17:48:38 +0900

Vault를 적용하게된 계기는 application.yml 파일에 DB접속 URL 등 다양한 개인정보들이 git에 노출되는것이 문제여서 적용하게 되었다. 기존에는 Jasypt 를 이용해서 암호화 하였는데 이것 역시 secret 키값이 프로젝트 코드속에 있어서 마음만 먹으면 secret 키값을 알아내서 암호화를 풀수 있다.

Vault는 분산시스템에서 사용되고 시크릿한 정보들을 스프링 클라우드에서 데이터를 가져온다. 지금 프로젝트에서는 분산 시스템이 아니지만 나중에 분산시스템으로 변경 했을때 사용될수 있을것 같아서 미리 도입해 보았다.

그리고 환경변수에 값을 인입하는 방법도 있지만 그 많은 개인정보들을 환경변수에서 관리하면 데이터들이 늘어날수록 관리의 복잡성이 늘어나서 한계가 있다.

환경변수에는 비밀정보가 아닌 애플리케이션 실행 환경값만을 사용하는것이 좋다.
ex) 스프링 프로필명, 포트번호, JVM 힙메모리 설정

Spring Cloud란

Vault를 적용하기 앞서 Spring Cloud를 알아야 한다.

Spring Cloud란 스프링부트를 기반으로한 분산 시스템을 개발하기 위한 일련의 도구를 제공하는 프레임워크이다.

Spring Cloud Config는 분산 시스템중에서 외부화된 구성에 대한 서버측 및 클라이언트를 제공하는것이다. 대표적으로 구성정보를 관리하는 서버는 git과 vault가 있고 프로젝트에는 vault를 사용하였다.

BootStrap

application.yml에 비밀 구성정보를 기입하려면 서버가 application.yml 로드전에 Vault 정보를 불러와야 하는데 이것을 해주는게 bootstrap 이다. 아래 그림에서 보듯이. bootstrap.yml 정보를 가지고 Vault를 접속하여 정보를 가져오고 application.yml에 정보를 기입하는 구조이다.

Vault 적용

build.gradle.kts 파일에 의존성 추가.

위에서 설명한 Spring Cloud Config, Vault, Bootstrap을 사용하기위해서 3가지 의존성을 추가한다.

//vault
implementation("org.springframework.cloud:spring-cloud-starter-bootstrap:4.1.4")
implementation("org.springframework.cloud:spring-cloud-config-server:4.1.3")
implementation("org.springframework.cloud:spring-cloud-starter-vault-config:4.1.3")

Vault 설치

AWS EC2 Ubuntu 서버에 설치하였다. 공식사이트에서 제공해주는 설치방법으로는 설치가 안돼서 wget 명령어로 설치파일을 가져와서 설치하는 방법으로 설치하였다.

wget으로 zip 파일을 가져오고 unzip으로 압축을 풀어서 /usr/local/bin/ 으로 이동시키면 전역에서 vault 명령어를 사용할 수 있다.

wget https://releases.hashicorp.com/vault/1.14.1/vault_1.14.1_linux_amd64.zip
unzip vault_1.14.1_linux_amd64.zip
sudo mv <Vault 바이너리 경로> /usr/local/bin/

Vault 운영서버 구축

vault server -dev 명령어를 통해서 개발 서버로 구축하면 Valut 서버를 로컬서버에서 밖에 접속할수 밖에 없다 그리고 설정정보를 가진 데이터들이 인메모리에 저장되기 때문에 서버를 중지시키면 데이터들이 다 날라가는 단점이 있다. 그래서 운영으로 구축하였다.

운영서버로 구축하려면 설정정보가 있는 파일을 생성해야 한다.

$ sudo mkdir -p /etc/vault
$ sudo mkdir -p /srv/vault/data
$ sudo vi /etc/vault/config.hcl

[config.hcl 파일내용]

아래 구성내용은 공식 홈페이지의 Vault 기본 구성 매뉴얼 을 참고하여 작성한것이다. 만약 https 를 사용한다면 이 Vault 공식 홈페이지를 참고하면 된다.

storage "raft" {
  path    = "/srv/vault/data"
  node_id = "node1"
}

listener "tcp" {
  address     = "0.0.0.0:8200"
  tls_disable = "true"
}

api_addr     = "http://127.0.0.1:8200"
cluster_addr = "https://127.0.0.1:8201"
ui = true

storage "raft" 방식은 HA Cluster 방식 이라고도 하는데 하나의 서버가 다운되거나 장애가 생거더라도 자동으로 복구가 가능하다. 그리고 각 서버들에 대해서 데이터들의 일관성들을 보장한다.

listener은 Vault가 API 요청을 수신하는 방식을 구성한다. address = "0.0.0.0:8200" 으로 세팅하여 모든 IP에서 요청이 가능하고 tls_disable 하여 https 가 아니더라도 요청을 수락한다. Vault는 기본적으로 보안상 tls를 활성화 하는데 tls를 활성화 하려면 키파일이 필요하다.

api_addr은 로컬에서 API에 접속할수 있는 주소이고, cluster_addr은 노드간의 접속을 할수 있게 하는 주소이다.

ui = true 로 하면 Vault UI 웹으로 접속할 수 있다.

Vault 백그라운드 실행

-config 로 설정파일 경로와 파일을 지정하고 백그라운드로 실행을 한다.

$ sudo sh -c 'vault server -config=/etc/vault/config.hcl >> /var/log/vault_sys.log 2>&1 &'

그리고 아래 명령어로 vault 최초 사용을 위해 초기화 시킨다.

$ vault operator init

그러면 아래 처럼 unseal key 5개와, token 이 주어진다. 이거는 잊어버리지 않고 개인보관해야 한다.

Vault UI 접속

그리고 IP:8200번 포트로 접속하면 아래 UI 화면이 들어가진다.

Unseal Key Portion에 위에서 받은 Unseal key를 3번 입력하면 오른쪽 화면으로 변경되고 위에서 받은 Token 값을 인입해주고 Sign in 해주면된다.

Vault KV 데이터 생성

맨처음 접속된 Secrets Engines 에서 Enable new engine + 버튼을 클릭하고

KV를 만들어준다. 이름은 secret 으로 만들었다.

그리고 application 이름으로 Create secret을 만들어주고

아래와 같이 application.yml 에 필요한 정보들을 기입해주면된다.

스프링부트 Vault 연동

프로젝트로 돌아가서 bootstrap.yml 파일을 만들고 아래 정보들을 기입해주면된다.

spring.cloud.vault.uri에 주소를 넣어주고, spring.cloud.vault.token에 발급받은 token값을 기입해주면 된다.

kv.backed: 값과, default-context 값으로 위에 Vault UI에서 만든 secret/application의 값들을 가져올수 있다.

Vault 데이터 적용

그리고 application.yml 에 application에 만든 값을 ${} 로 통해서 쓸수있다.

Vault 데이터 확인

값이 제대로 가져왔는지는 테스트 코드를 통해서 확인하면 된다.

참고

- https://wlsdn3004.tistory.com/11

- https://blog.naver.com/wideeyed/222099597474

- https://velog.io/@gweowe/Vault-%EC%84%A4%EC%B9%98-%EB%B0%8F-dev-%EC%84%9C%EB%B2%84-%EA%B5%AC%EC%B6%95-Ubuntu

- https://ssdragon.tistory.com/163#%F-%-F%--%A-%--Vault%EB%A-%BC%--%EB%-F%--%EC%BB%A-%EB%A-%-C%--%EC%-B%A-%ED%--%--%ED%--%--%EA%B-%B-

- https://www.elancer.co.kr/blog/view?seq=248

[SpringBoot] 회원가입 구조 퍼사드 패턴 적용과 SRP 원칙 적용

deftkang — Tue, 17 Sep 2024 17:33:48 +0900

회원가입을 하기 위해서 3가지 흐름이 있다.

회원가입 로직

1. 회원가입시 입력한 인증번호 확인

2. member 테이블에 회원정보 저장

3. account 테이블에 회원 인증정보 저장

위 로직 설명

account 테이블이 따로 있는 이유는 회원 종류가 늘어날때 회원 종류의 테이블을 모두 돌아야 해서 회원 종류의 확장을 고려해 account 인증 테이블을 추가하였다.

member테이블에 먼저 저장하는 이유는 member 테이블에 있는 전화번호 등 유효성검사를 하고 member 엔티티가 저장되고 생성된 id 값을 account 테이블에 넣기 위해서이다.

[기존 코드]

기존코드에서는 아래 코드처럼 Service 하나에서 위 로직을 모두 넣었다.

@Transactional
override fun signUp(createMemberDTO: CreateMemberRequest): Long {
    //인증번호 확인
    val certifyNumFoundByRedis = redisUtil.getData(email)

    if (certifyNumFoundByRedis != certifyNum) {
        throw SignupCertifyNumAuthFailedException(ErrorCode.INVALID_AUTH_CERTIFY_NUM)
    }

    //인증정보 저장
    saveAccountValidCheck(createMemberDTO)
    
    val account = Account(
        email = createMemberDTO.email,
        password = passwordEncoder.encode(createMemberDTO.password),
        role = MemberRole.USER,
        userId = memberId,
    )

    accountRepository.save(account)
    
    //회원정보 저장
    signUpValidCheck(createMemberDTO)

    val member = Member(
        telNo = createMemberDTO.telNo,
        name = createMemberDTO.name,
        memberShoppingActivity = MemberShoppingActivity.init(),
    )

    memberRepository.save(member)

    return member.memberId!!
}

위 코드에서의 문제는 signUp() 하나의 메서드 안에서 인증번호 확인, 인증정보 저장, 회원정보 저장 3개의 기능이 분리 되지 않고 같이 있기 때문에 SOLID 원칙에서 SRP 규칙에 어긋난다.

그래서 아래처럼 Controller와 Service 가운데에 ServiceApplication 클래스를 한개둬서 3개의 기능을 분리 했다.

SRP를 지키지 않은 경우에 코드 크기가 커지면서 연관성이 적은 코드가 한 클래스에 위치할 가능성이 높아진다. 이는 결과적으로 코드를 이해하는데 방해가 된다. 코드가 분리돼있지 않으면 인증번호 확인 로직만 수정하고 싶을때 인증정보 저장, 회원정보 저장 로직도 같이 볼수 밖에 없기 때문이다. 이것은 코드를 점점 얽히게 만들어서 유지보수와 확장성에 좋지 않다.

하나의 서비스에서 여러개의 서비스를 나눴을때 여러개의 서비스를 실행시켜주는 매개체 역할이 필요한데 그것이 위에서 MemberServiceApplication이다. 이것이 퍼사드와 같은 역할을 해줘서 퍼사드 패턴이 될수있다.

퍼사드 패턴이란 여러 요소들로 구성된 복잡한 시스템을 서브시스템으로 분리하고 하나의 시스템(퍼사드 객체) 에서 처리할수 있게 해주는 패턴이다. 퍼사드 패턴은 복잡한 시스템을 분리시켜서 유지보수와 확장성에 용이하기 해주게 때문에 위 문제를 해결하기 위해서 가장 적합한 디자인 패턴이다.

각각의 기능들을 서브시스템으로 나누기 위해 인증번호를 확인하는 AuthenticationService, 인증정보를 저장하는 AccountService, 회원정보를 저장하는 MemberService를 따로 따로 분리 하였다. 이 3개의 Service를 나누면 각각의 서브시스템으로 나뉘어 진것이다.

[AuthenticationService]

fun verifyEmailCertifyNum(email: String, certifyNum: String) {
    val certifyNumFoundByRedis = redisUtil.getData(email)

    if (certifyNumFoundByRedis != certifyNum) {
        throw SignupCertifyNumAuthFailedException(ErrorCode.INVALID_AUTH_CERTIFY_NUM)
    }
}

[AccountService]

@Transactional
override fun saveAccount(memberId: Long, createMemberDTO: CreateMemberRequest): Account {
    saveAccountValidCheck(createMemberDTO)

    val account = Account(
        email = createMemberDTO.email,
        password = passwordEncoder.encode(createMemberDTO.password),
        role = MemberRole.USER,
        userId = memberId,
    )

    return accountRepository.save(account)
}

[MemberService]

@Transactional
override fun saveMember(createMemberDTO: CreateMemberRequest): Long {
    signUpValidCheck(createMemberDTO)

    val member = Member(
        telNo = createMemberDTO.telNo,
        name = createMemberDTO.name,
        memberShoppingActivity = MemberShoppingActivity.init(),
    )

    memberRepository.save(member)

    return member.memberId!!
}

그리고 퍼사드 객체 역할을 해주는 MemberServiceApplication 클래스를 만들고 에 위 3개의 Service를 의존하고 각각의 기능을 적용시켰다. 그러면 복잡한 서브 시스템들을 하나의 객체에서 처리할수 있고 이것이 퍼사드 패턴이다.

[MemberServiceApplication]

class MemberServiceApplication(
    private val memberService: MemberService,
    private val accountService: AccountService,
    private val authenticationService: AuthenticationService,
) {
    @Transactional
    fun signUp(createMemberRequest: CreateMemberRequest): Long {
        //인증번호 확인
        authenticationService.verifyEmailCertifyNum(createMemberRequest.email, createMemberRequest.certifyNum)

        val memberId = memberService.saveMember(createMemberRequest)
        accountService.saveAccount(memberId, createMemberRequest)

        return memberId
    }
}

참고 : https://velog.io/@bagt/Design-Pattern-Facade-Pattern-%ED%8D%BC%EC%82%AC%EB%93%9C-%ED%8C%A8%ED%84%B4

[SpringBoot] 3차 프로젝트 자바에서 코틀린 전환 회고

deftkang — Tue, 20 Aug 2024 12:58:46 +0900

기존 2차 프로젝트에서 기준에서 3차 프로젝트를 하면서 2차 프로젝트의 자바 코드를 코틀린 코드로 변환을 완료하였다.

2차 프로젝트 깃허브 링크

3차 프로젝트 깃허브 링크

프로젝트 환경

Spring Boot 3.3.2
Java 17

코틀린 사용하면서 느낀 장단점

Lombok 제거

전환과정에서 자바와 가장 컸던 점은 코틀린에서는 Lombok을 안쓴다는 점이다.

Lombok을 안쓰는 이유

코틀린에서는 타입추론 기능이 있어서 변수앞에 타입을 안붙인다. 변수 값에 의해서 타입이 정해진다. 그래서 변수 앞에는 val이나 var을 붙이는데 val은 Getter 기능이 포함되어 있고 var은 Getter, Setter가 포함되어 있다.
@Data 대신에 Data Class를 사용하면 equals(), hashcode(), toString()를 컴파일러 시점에 자동으로 생성한다.
Named Arguments 문법적 특징으로 @Builder 를 안써도 된다.

다만 불편했던 점은 Lombok의 @Slf4j 어노테이션을 쓸수 없다보니 코틀린에서는 로그를 작성하려면 아래 코드를 이용해서 작성해야 한다. ${}는 변수값을 사용한다는 뜻이다.

//의존성 추가
implementation("io.github.oshai:kotlin-logging-jvm:5.1.4")

//클래스 내부에 추가
private val log = KotlinLogging.logger {}

//로그 사용 예시
log.info { "회원 상세 조회 memberId = ${memberId}" }

Optional 제거

그리고 ? 를 사용해서 이 값이 null이 될수 있는지 없는지를 항상 생각하고 붙여줘야 한다. 그래서 코틀린에서는 optional을 안쓴다.

사실 자바코드를 짜면서 null 허용 여부를 신경 안쓰고 무조건 Optional을 써서 작업하였는데 코틀린에서는 ? 여부를 항상 붙여줄수 있다보니 null 허용 여부를 항상 신경쓰면서 개발하였다. 그래서 코드가 더 깔끔해졌다

JPA를 사용할때 findById() 함수를 사용할때 Optional을 강요하여서 코틀린에서도 어쩔수 없이 사용될수 밖에 없다고 생각하였지만

코틀린에서 반환 타입에 ? 를 붙이면 nullable 타입이 되고 findByIdOrNull 확장함수를 사용할 수 있어서 Optional을 사용하지 않아도 된다.

그리고 아래처럼 ?:(엘비스 연산자) 를 통해서 값이 없을때의 처리를 지정해주면 된다.

확장함수 ?.let 사용

코틀린에서는 다양한 확장함수가 있는데 이중에서 let을 가장 많이 사용하였다.

let 확장함수는 아래처럼 T 객체 타입에서 R 객체타입으로 변환할 수 있는 함수인데

fun <T, R> T.let(block: (T) -> R): R

nullable 타입에서 사용하게 된다면 T?.let{ } 에서 {} 안에는 non-null 값만 들어올수 있어서 ?: 와 같이 사용했을때 굉장히 유용하다.

아래 코드는 memberRepository 에서 Id값으로 객체를 불러왔을때 객체 값이 없으면 MemberResponse로 타입을 변환시키고 그게 아니면 NotFoundMemberExcetpion을 발생시키는 코드이다.

마무리

2차 프로젝트에서 3차 프로젝트로 넘어가면서 코틀린 전환을 하였는데 첨에는 속도가 많이 더디고 느렸지만 점차 하면서 코드가 간결해지는것을 느꼈다. 새로운 언어를 배운다는것은 쉽지 않았지만 왜 다양한 기업에서 코틀린으로 전환하려고 하는지 느낄수 있었다.

[SpringBoot] Redis 활용한 회원가입 이메일 인증 방법(개선후)

deftkang — Sat, 6 Jul 2024 23:48:52 +0900

회원가입 이메일 인증 방법 개선전에는 MemberEntity에 enabled 필드를 추가하여 회원가입시 DB에 가입정보를 insert할때 enabled 필드에 false값을 넣어서 회원을 비활성화 하고 전송된 인증메일에 링크를 누르면 enabled 값을 true로 변경하여 회원을 활성화 시켰다. 하지만 이 방법은 회원이 인증을 하지 않으면 DB에 쓰레기 값만 남게 되고 회원이 다시 똑같은 아이디(email)로 회원가입을 못한다.

그래서 이메일로는 인증번호를 전송하고 회원가입 화면에서 인증번호를 제대로 기입해야 회원가입이 완료되도록 설정하였다.

인증번호 유효성은 Redis를 활용하였다.

DB를 사용안하고 Redis를 활용한 이유는 DB에 직접 접근하지 않고 Redis 캐싱을 활용하여 인증을 빨리 할수있고 데이터에 시간을 설정하여 자동으로 삭제되게 할수있는 휘발성 데이터라는 점에서 선택을 하였다.

0. 프로젝트 환경

Spring Boot 3.2.5
Spring Boot Data Redis 3.2.5
Lettuce 6.3.2

1. Redis 의존성 추가와 Redis Server 설치

build.gradle에 redis 의존성을 추가한다.

//Redis 의존성
implementation 'org.springframework.boot:spring-boot-starter-data-redis'

이 의존성을 추가하면 Redis Client인 Lettuce가 설치된다. Redis Client는 대표적으로 Jedis와 Lettuce가 있는데 SpringBoot 2.0 부터는 기본적으로 Lettuce가 사용된다.

Lettuce는 동기, 비동기및 반응형 API를 제공하는 확장 가능하고 thread-safe한 Redis 클라이언트 이다. 반면에 Jedis는 사용법이 간단하지만 thread-safe 하지 않다. 그래서 멀티 스레드 환경에서 적합하지 않다.

2. Redis Server 설치

맥북을 사용하면 brew로 쉽게 설치가 가능하다. redis-cli로 server로 접속이 가능하다.

set [key] [value] 로 데이터 인입, get [key]로 데이터 호출, del [key] 로 데이터 삭제가 가능하다. 모든 데이터를 보려면 keys * 를 사용하면된다.

3. Redis 설정 추가

application.yml에 아래 설정을 추가한다. Redis Server는 기본적으로 6379 포트 번호를 사용한다. duration은 600 기입하여 10분으로 기입하였다. 10분이 지나면 redis data는 자동으로 삭제된다.

spring:
  # Redis
  data:
    redis:
      host: localhost
      port: 6379
      duration: 600

4. Redis Server 연결 설정

redisConnectionFactory() 함수로 application.yml에 기입한 host와 port로 Redis Server와 연결한 Lettuce 클라이언트 객체를 생성한다.

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory;

@Configuration
public class RedisConfig {
    @Value("${spring.data.redis.host}")
    private String host;

    @Value("${spring.data.redis.port}")
    private int port;

    @Bean
    public RedisConnectionFactory redisConnectionFactory() {
        return new LettuceConnectionFactory(host, port);
    }
}

5. Redis Util 생성

Redis Server에 데이터를 생성하고 삭제하고 인증번호를 만드는 기능이 있는 Util 클래스이다.

import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.core.ValueOperations;
import org.springframework.stereotype.Service;

import java.time.Duration;
import java.util.Random;

@RequiredArgsConstructor
@Service
public class RedisUtil {
    private final StringRedisTemplate template;

    @Value("${spring.data.redis.duration}")
    private int duration;

    public String getData(String key) {
        ValueOperations<String, String> valueOperations = template.opsForValue();
        return valueOperations.get(key);
    }

    public boolean existData(String key) {
        return Boolean.TRUE.equals(template.hasKey(key));
    }

    public void setDataExpire(String key, String value) {
        ValueOperations<String, String> valueOperations = template.opsForValue();
        Duration expireDuration = Duration.ofSeconds(duration);
        valueOperations.set(key, value, expireDuration);
    }

    public void deleteData(String key) {
        template.delete(key);
    }

    public void createRedisData(String toEmail, String code) {
        if (existData(toEmail)) {
            deleteData(toEmail);
        }

        setDataExpire(toEmail, code);
    }

    public String createdCertifyNum() {
        int leftLimit = 48; // number '0'
        int rightLimit = 122; // alphabet 'z'
        int targetStringLength = 6;
        Random random = new Random();

        return random.ints(leftLimit, rightLimit + 1)
                .filter(i -> (i <= 57 || i >= 65) && (i <= 90 || i >= 97))
                .limit(targetStringLength)
                .collect(StringBuilder::new, StringBuilder::appendCodePoint, StringBuilder::append)
                .toString();
    }
}

StringRedisTemplate 클래스는 Spring Redis Data 에서 제공하는 클래스이다. RedisTemplate<String,String> 클래스를 상속받았고 StringRedisTemplate의 defaultSerializer는 StringRedisSerializer이다. StringRedisTemplate bean은 일반적인 String 값을 key, value로 사용하는 경우 사용하면 된다.

setDataExpire() 함수로 Redis Server에 데이터를 인입하며, application.yml에 설정한 duration값을 이용하여 10분후에 데이터가 삭제되게 한다.

createdCertifyNum() 함수는 숫자 영문자 합쳐서 랜덤으로 인증번호 6자리를 만든다.

6. mailTemplate.html 생성과 MailBuilder 클래스 생성

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<body>
<div style="margin:120px">
    <div style="margin-bottom: 10px">
        <h1>인증 코드 메일입니다.</h1>
        <br/>
        <h3> 아래 코드를 사이트에 입력해주십시오</h3>
    </div>
    <div>
        <h2 style="color: crimson;" th:text="${certifyNum}"></h2>
    </div>
    <br/>
</div>
</body>
</html>

import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
import org.thymeleaf.TemplateEngine;
import org.thymeleaf.context.Context;


@Service
@RequiredArgsConstructor
public class MailContentBuilder {
    private final TemplateEngine templateEngine;

    public String build(String certifyNum) {
        Context context = new Context();
        context.setVariable("certifyNum", certifyNum);
        return templateEngine.process("mailTemplate", context);
    }
}

Template Engine은 템플릿 양식과 데이터를 합쳐서 HTML을 보여준다. context.setVariable("certifyNum", certifyNum) 를 통해서 위에서 만든 html에서 ${certifyNum} 에 대한 값을 매핑해 줄 수 있다.

7. email 전송 Controller, Service 생성

@Operation(summary = "이메일로 인증번호 전송", description = "기입한 이메일로 인증번호를 전송합니다.")
@PostMapping("/v1/members/auth")
public void signupEmailAuthentication(@Validated @RequestBody CertifyNumRequest certifyNumRequest) {
    memberServiceApplication.signupCertifyNumEmailSend(certifyNumRequest.getEmail());
}

@Override
public void signupCertifyNumEmailSend(String email) {
    sendEmailAuthentication(email);
    log.info("인증번호 전송 완료, email = {}", email);
}

private void sendEmailAuthentication(String toEmail) {
    String certifyNum = redisUtil.createdCertifyNum();
    String message = mailContentBuilder.build(certifyNum);
    MailSendDTO mailSendDTO = new MailSendDTO(toEmail, "clothstar 회원가입 인증 메일 입니다.", message);

    mailService.sendMail(mailSendDTO);

    //메일 전송에 성공하면 redis에 key = email, value = 인증번호를 생성한다.
    //지속시간은 10분
    redisUtil.createRedisData(toEmail, certifyNum);
}

createdCertifyNum() 함수로 인증번호를 만들고 템플릿엔진 html 데이터를 message에 담아 인증번호 메일을 전송한다. 그리고 key는 email, value는 인증번호인 redis 데이터를 생성한다.

8. 회원가입 Service로직에 인증번호 확인 로직 추가

public Boolean verifyEmailCertifyNum(String email, String certifyNum) {
    String certifyNumFoundByRedis = redisUtil.getData(email);
    if (certifyNumFoundByRedis == null) {
        return false;
    }

    return certifyNumFoundByRedis.equals(certifyNum);
}

인증번호가 틀리면 예외처리를 하고 맞으면 회원데이터를 DB에 insert 한다.

9. 회원가입 html에서 인증번호 전송 버튼을 추가하고 인증번호 메일 전송 js 추가

signup.html에서 인증번호 버튼

const certifyNumEmailSendButton = document.getElementById("certifyNum-btn");

if (certifyNumEmailSendButton) {
    certifyNumEmailSendButton.addEventListener("click", (event) => {
        const emailValue = document.getElementById("email").value;
        if (emailValue == null || emailValue == "") {
            alert("이메일을 입력해 주세요");
        } else {
            fetch(`/v1/members/auth`, {
                method: "POST",
                headers: {
                    "Content-Type": "application/json",
                },
                body: JSON.stringify({
                    email: emailValue
                }),
            }).then((res) => {
                if (res.ok) {
                    alert("인증번호가 전송 되었습니다.")
                }
            }).catch(() => {
                console.log("catch");
            });
        }
    });
}

10. 화면 테스트

이메일을 기입하고 인증번호 전송을 누르면 기입한 이메일로 인증 코드가 전송된다.

만약에 인증번호가 잘못되면 인증번호가 잘못 되었다고 alert창을 보여주고 인증번호를 제대로 기입하면 회원가입을 완료 시킨다.

참고

- https://velog.io/@juno0713/Spring-Redis-%EC%9D%B4%EB%A9%94%EC%9D%BC-%EC%9D%B8%EC%A6%9D-%EC%95%A0%ED%94%8C%EB%A6%AC%EC%BC%80%EC%9D%B4