개발자 - 경찬주. 2020.06.23

• 개발 환경
• 빌드 및 실행방법
• 사용한 Entity 정의서
• 선택기능 요구사항
• 필수기능 요구사항

• 기본 환경
  • IDE: IntelliJ IDEA Community 2019.03
  • OS: Mac OS X
  • GIT
• Server
  • Java8
  • Spring Boot 2.2.4
  • JPA
  • H2
  • Gradle
  • Junit4
  • commons-lang3:3.9
  • jjwt-api:0.11.1

1. 깃에서소스를 다운받는다.
2. 바로 실행가능.
3. 혹시 실행에서 오류난다면 아래 jar를 다운받아 추가해준다. http://commons.apache.org/proper/commons-lang/
4. 접속 Base URI: http://localhost:8080

• 쿠폰번호와 사용,취소등 관련 정보를 관리하는 테이블

• index추가함 -> IDX_COUPON_NUM(columnList = "id,couponNum, userId")

• 테이블 관계 -> [user] 1:N [coupon]

• http://localhost:8080/h2-console/
• driver class -> org.h2.Driver
• jdbc url -> jdbc:h2:~/data/kyungCoupon
• user name -> sa
• password는 없다.

• API 인증을 위해 JWT(Json Web Token)를 이용해서 Token 기반 API 인증 기능을 개발하고 각 API 호출 시에 HTTP Header 에 발급받은 토큰을 가지고 호출한다.
  • signup 계정생성 API: 입력으로 ID, PW 받아 내부 DB 에 계정 저장하고 토큰 생성하여 출력
    • 단, 패스워드는 인코딩하여 저장한다.
    • 단, 토큰은 특정 secret 으로 서명하여 생성한다.
  • signin 로그인 API: 입력으로 생성된 계정 (ID, PW)으로 로그인 요청하면 토큰을 발급한다.
  • refresh 토큰 재발급 API: 기존에 발급받은 토큰을 Authorization 헤더에 “Bearer Token”으로 입력 요청을 하면 토큰을 재발급한다.

• 관련소스 : kyungCoupon.controller.UserController.java
• 기능설명 :

1. 이메일주소 검증
2. 비밀번호 암호화처리-PasswordEncoder.encode()

• @input : email=?, password=?, userName=?
• @output : 가입상태값, 메시지
• 실행명령어 : http POST localhost:8080/signIn email=[email protected] password=test userName=test3
• 결과 :

{
    "description": "가입 성공했습니다.",
    "resultCode": "0"
}

• 관련소스 : kyungCoupon.controller.UserController.java
• 기능설명 :

1. 이메일주소, 비밀번호 검증
2. accessToken생성-Jwt

• @input : email=?, password=?
• @output : accessTocken, 로그인 상태값, 메시지
• 실행명령어 : http POST localhost:8080/logIn email=[email protected] password=test
• 결과 :

{
    "data": {
        "accessToken": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0MyIsImlkIjoyMywiZW1haWwiOiJ0ZXN0M0BnbWFpbC5jb20iLCJ1c2VyTmFtZSI6InRlc3QzIn0.RDHXnfz5tHHw5OW27vwvdcLlYmuMUaNzVB2Guryx5tc"
    },
    "description": "test3님, 환영합니다.",
    "resultCode": "0"
}

• 관련소스 : kyungCoupon.controller.SndMsg3DayBfreExpController.java
• 기능설명 :

1. 사용자가 지정된 쿠폰중 3일전 유효기간인 대상조회
2. 메시지 세팅 3.System.out.으로 출력

• @input :
• @output :
• 실행명령어 : http POST localhost:8080/SndMsg3DayBfreExp/20200621
• 결과 :

{2건이 전송되었습니다.}
******************* snd email *********************
To : [email protected]
t**t 고객님, 쿠폰[QhHeP]이 3일 후 만료됩니다.
From : [email protected]
***************************************************
******************* snd email *********************
To : [email protected]
t***3 고객님, 쿠폰[jj6a4]이 3일 후 만료됩니다.
From : [email protected]
***************************************************

• 관련소스 : kyungCoupon.controller.CouponController.java
• 기능설명 :

1. 쿠폰랜범 번호 생성-RandomStringUtils.randomAlphanumeric()
2. HashSet에 담아 저장

• @input : int couponCnt
• @output : 결과메시지
• 실행명령어 : http POST localhost:8080/generateCoupon/1
• 결과 :

{1개의 쿠폰이 생성완료함.}

• 관련소스 : kyungCoupon.controller.CouponController.java
• @input : String accessToken
• @output : XXXXX-XXXXX-XXXXX
• 실행명령어 : http PATCH localhost:8080/setCouponUser "Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0MyIsImlkIjoyMywiZW1haWwiOiJ0ZXN0M0BnbWFpbC5jb20iLCJ1c2VyTmFtZSI6InRlc3QzIn0.RDHXnfz5tHHw5OW27vwvdcLlYmuMUaNzVB2Guryx5tc"
• 결과 :

{
    "data": "jj6a4-kdE7Q-Myqez",
    "description": "정상처리되었습니다.",
    "resultCode": "0"
}

• 관련소스 : kyungCoupon.controller.CouponController.java
• @input : String accessToken
• @output : List
• 실행명령어 : http GET localhost:8080/getMyCouponInfo "Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0MyIsImlkIjoyMywiZW1haWwiOiJ0ZXN0M0BnbWFpbC5jb20iLCJ1c2VyTmFtZSI6InRlc3QzIn0.RDHXnfz5tHHw5OW27vwvdcLlYmuMUaNzVB2Guryx5tc"
• 결과 :

{
    "dataList": [
        {
            "cnclDate": null,
            "cnclYN": null,
            "couponNum": "jj6a4kdE7QMyqez",
            "expDate": "20200624",
            "id": 24,
            "useDate": null,
            "useYN": "N"
        }
    ],
    "dataListSize": 1,
    "description": "정상처리되었습니다.",
    "resultCode": "0"
}

• 관련소스 : kyungCoupon.controller.CouponController.java
• @input : String couponNum, String accessToken
• @output : Coupon
• 실행명령어 : http PATCH localhost:8080/useCoupon/jj6a4kdE7QMyqez "Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0MyIsImlkIjoyMywiZW1haWwiOiJ0ZXN0M0BnbWFpbC5jb20iLCJ1c2VyTmFtZSI6InRlc3QzIn0.RDHXnfz5tHHw5OW27vwvdcLlYmuMUaNzVB2Guryx5tc"
• 결과 :

{
    "data": {
        "cnclDate": null,
        "cnclYN": null,
        "couponNum": "jj6a4kdE7QMyqez",
        "expDate": "20200624",
        "id": 24,
update->"useDate": "20200623", 
update->"useYN": "Y" 
    },
    "description": "정상처리되었습니다.",
    "resultCode": "0"
}

재사용불가 확인:
[kyungCoupon.exception.CouponAllUsedException: 해당 쿠폰은 이미 사용완료되었습니다.[쿠론번호 : jj6a4-kdE7Q-Myqez]]  

• 관련소스 : kyungCoupon.controller.CouponController.java
• @input : String couponNum, String accessToken
• @output : Coupon
• 실행명령어 : http PATCH localhost:8080/cnclUseCoupon/jj6a4kdE7QMyqez "Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZXN0MyIsImlkIjoyMywiZW1haWwiOiJ0ZXN0M0BnbWFpbC5jb20iLCJ1c2VyTmFtZSI6InRlc3QzIn0.RDHXnfz5tHHw5OW27vwvdcLlYmuMUaNzVB2Guryx5tc"
• 결과 :

{
    "data": {
update->"cnclDate": "20200623",<-update
update->"cnclYN": "Y",<-update
        "couponNum": "jj6a4kdE7QMyqez",
        "expDate": "20200624",
        "id": 24,
update->"useDate": null,
update->"useYN": "N"
    },
    "description": "정상처리되었습니다.",
    "resultCode": "0"
}

취소된 쿠폰재사용가능 확인:
{
    "data": {
update->"cnclDate": null,
update->"cnclYN": null,
        "couponNum": "jj6a4kdE7QMyqez",
        "expDate": "20200624",
        "id": 24,
update->"useDate": "20200623",
update->"useYN": "Y"
    },
    "description": "정상처리되었습니다.",
    "resultCode": "0"
}

• 관련소스 : kyungCoupon.controller.CouponController.java
• @input :
• @output : List
• 실행명령어 : http GET localhost:8080/getCouponExpiredToday
• 결과 :

{
    "dataList": [
        {
            "cnclDate": null,
            "cnclYN": null,
            "couponNum": "FHoS9E7wfC5QUZp",
            "expDate": "20200623",
            "id": 20,
            "useDate": null,
            "useYN": "N"
        }
    ],
    "dataListSize": 1,
    "description": "정상처리되었습니다.",
    "resultCode": "0"
}