[5기 - 정의진] SpringBoot Part1 Weekly Mission 제출합니다. #897

uijin-j · 2023-10-19T14:30:22Z

👩‍💻요구 사항과 구현 내용

바우처 관리 Command-line Application

요구사항

create 커맨드 지원
- 생성 가능한 바우처 리스트 (FixedAmountVoucher, PercentDiscountVoucher)
list 커맨드 지원
- 생성된 바우처 리스트 조회
exit 커맨드 지원
- 프로그램 종료
blacklist 커맨드 지원
- 블랙 리스트 명단 조회
- 명단은 CSV 파일로 부터 가져옴
에러 로그는 파일로 기록
바우처 정보를 파일로 기록

구현 내용

VoucherManagementSystemApplication

VoucherApplication 실행

VoucherApplication

Console 클래스를 이용해 사용자 입력을 받고 적절한 Service를 호출

CommandType

사용자가 이용할 수 있는 기능을 모아둔 Enum

Console

콘솔 입출력 관련 유틸리티 클래스

VoucherService

바우처 관련 비즈니스 로직 수행
비즈니스 로직에 맞게 적절한 Repository 메서드 호출

BlacklistService

블랙리스트 관련 비즈니스 로직 수행
BlacklistRepository에게 요청을 전달

VoucherRepository

저장소(파일, 메모리 등)에서 바우처 데이터를 가져와 서비스에게 제공해 줄 기능들을 명시해 놓은 인터페이스

MemoryVoucherRepository

메모리로 바우처 정보를 관리하는 VoucherRepository 구현 클래스

JSONFileVoucherRepository

voucher_data.json 파일에서 바우처를 관리하는 VoucherRepository 구현 클래스

LoadedJSONVoucher

JSON으로 저장된 바우처 정보를 매핑하는 클래스
VoucherType 필드에 맞는 바우처 인스턴스를 반환

Voucher

바우처 정보를 가지고 있는 모델 인터페이스

VoucherType

바우처 종류를 모아둔 Enum

FixedAmountVoucher

고정 금액 할인 바우처를 위한 Voucher 구현 클래스

PercentDiscountVoucher

비율(%) 할인 바우처를 위한 Voucher 구현 클래스

User

사용자 정보를 가지고 있는 모델 클래스

✅ PR 포인트 & 궁금한 점

프로젝트를 진행하면서 클래스와 메서스, 변수명을 정하는 것이 고민이었습니다.

ex) LoadedJSONVoucher, VoucherManagementSystemApplication, VoucherApplication, selectCommand(메서드명)

🙋🏻‍♂️ 현재 네이밍이 적절하게 되어있는지, 그리고 추천하는 네이밍 방식이 있을지 궁금합니다!
VoucherApplication 의 실행 방식으로
(1) 재귀적인 메서드 호출 (현재)
(2) while 문으로 루프를 도는 것
을 고민했는데, 어떤 방식을 사용하는 것이 좋았을까요?
현재 저희 어플리케이션에서는 바우처 종류에 상관없이 바우처 정보를 하나의 파일에 저장하고 있습니다. 그렇기 때문에 JSONFileVoucherRepository 에서는 바우처 데이터를 불러올 때 모든 종류의 바우처 정보를 가지고 있는 LoadedJSONVoucher 클래스로 매핑해서 가져오는데 이 부분을 어떻게 개선할 수 있을지 궁금합니다!

❗ (문제점) 바우처 종류가 늘어날수록 LoadedJSONVoucher 클래스가 갖고 있어야 할 필드가 늘어남

🙋🏻‍♂️ 바우처 종류에 따라 파일을 분리해서 저장하는 것이 좋을까요?

🙋🏻‍♂️ 비슷하게 만약 RDB로 관리한다면 모든 종류의 바우처를 하나의 테이블로 관리하는게 좋은 방식일까요?
바우처 정보를 파일에 언제 저장하면 좋을지 궁금합니다!
(1) 프로그램이 종료될 때 한번에 저장 (현재)
(2) 바우처 Create 요청이 올 때마다 저장
(3) 적절한 주기(ex. 1시간, 1일 간격)에 저장
블랙리스트 관련 비즈니스 로직을 UserService에 넣는 것이 좋을지, 아니면 별도의 BlacklistService(현재)에 넣는 것이 좋을지 궁금합니다!

################ # <타입> : <제목> 의 형식으로 제목을 아래 공백줄에 작성 # 제목은 50자 이내 / 변경사항이 "무엇"인지 명확히 작성 / 끝에 마침표 금지 # 예) feat : 로그인 기능 추가 # 바로 아래 공백은 지우지 마세요 (제목과 본문의 분리를 위함) ################ # 본문(구체적인 내용)을 아랫줄에 작성 # 여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내) ################ # 꼬릿말(footer)을 아랫줄에 작성 (현재 커밋과 관련된 이슈 번호 추가 등) # 예) Close prgrms-be-devcourse#7 ################ # feat : 새로운 기능 추가 # fix : 버그 수정 # docs : 문서 수정 # test : 테스트 코드 추가 # refact : 코드 리팩토링 # style : 코드 의미에 영향을 주지 않는 변경사항 # chore : 빌드 부분 혹은 패키지 매니저 수정사항 ################

Voucher 필드 게터 추가

ksy90101

간단하게 질문 남겼어요 고생하셨어요 :)

ksy90101 · 2023-10-23T00:03:56Z

src/main/java/team/marco/vouchermanagementsystem/model/FixedAmountVoucher.java

+
+import static java.text.MessageFormat.format;
+
+public class FixedAmountVoucher implements Voucher {


inteface로 구현하는게 좋을까요?
현재 중복코드들이 있는것 같은데요.
이런 경우 상속 또는 조합 방식이 더 어울려 보여요.

Voucher를 추상클래스로 변경했습니다. 확실히 중복되어 있던 코드가 사라져서 더 깔끔해 진 것 같습니다! 조언 감사합니다:)

ksy90101 · 2023-10-23T00:04:17Z

src/main/java/team/marco/vouchermanagementsystem/model/FixedAmountVoucher.java

+        if (amount <= 0) {
+            throw new IllegalArgumentException(format("{0}: 할인 금액은 0 보다 커야 합니다.", amount));
+        }


validate는 따로 메서드를 빼서 의미를 전달하면 어떨까요?
아울러 amount의 값을 int 이상의 값을 입력하면 어떻게 될까요?

ksy90101 · 2023-10-23T00:04:33Z

src/main/java/team/marco/vouchermanagementsystem/model/PercentDiscountVoucher.java

+import static java.text.MessageFormat.format;
+
+public class PercentDiscountVoucher implements Voucher {
+    private static final Logger logger = LoggerFactory.getLogger(FixedAmountVoucher.class);


Suggested change

private static final Logger logger = LoggerFactory.getLogger(FixedAmountVoucher.class);

private static final Logger logger = LoggerFactory.getLogger(PercentDiscountVoucher.class);

ksy90101 · 2023-10-23T00:04:52Z

src/main/java/team/marco/vouchermanagementsystem/model/PercentDiscountVoucher.java

+        if (percent <= 0) {
+            throw new IllegalArgumentException(format("{0}: 할인율은 0% 이하일 수 없습니다.", percent));
+        }
+
+        if (percent > 100) {
+            throw new IllegalArgumentException(format("{0}: 할인율은 100%를 초과할 수 없습니다.", percent));
+        }


별건 아니지만, 하나로 합칠수 있지 않을까요?

ksy90101 · 2023-10-23T00:05:06Z

src/main/java/team/marco/vouchermanagementsystem/model/User.java

+    public String getInfo() {
+
+        return format("id: {0}, 고객명: {1} ", id, name);


Suggested change

public String getInfo() {

return format("id: {0}, 고객명: {1} ", id, name);

public String getInfo() {

return format("id: {0}, 고객명: {1} ", id, name);

ksy90101 · 2023-10-23T00:05:35Z

src/main/java/team/marco/vouchermanagementsystem/repository/BlacklistRepository.java

+        try (BufferedReader reader = Files.newBufferedReader(Paths.get(path), StandardCharsets.UTF_8)) {
+            reader.readLine(); // skip header
+            reader.lines()
+                    .map(s -> s.split("[;,]"))


상수화를 하면 어떨까요?

ksy90101 · 2023-10-23T00:06:25Z

src/main/java/team/marco/vouchermanagementsystem/repository/BlacklistRepository.java

+    }
+
+    public List<User> findAll() {
+        return blacklist;


불변으로 return하면 어떨까요?
unmofiedList라는 키워드를 한번 찾아보세요.

Collections.unmodifiableList()를 사용해서 변경했습니다!

ksy90101 · 2023-10-23T00:06:49Z

src/main/java/team/marco/vouchermanagementsystem/repository/JSONFileVoucherRepository.java

+
+@Profile("dev")
+@Repository
+public class JSONFileVoucherRepository implements VoucherRepository, DisposableBean {


(질문)
DisposableBean 해당 빈을 왜 구현하신걸까요?

저희 프로그램은 프로그램이 종료될 때, 캐시되어 있던 Voucher 정보를 파일에 저장합니다!
그래서 프로그램이 종료되면서 빈이 사라질 때, 자동으로 파일 저장기능을 수행하도록 하기 위해 DisposableBean을 구현했습니다.
파일 저장 기능을 일반 인스턴스 메서드로 빼서 서비스 쪽에서 프로그램을 종료할 때, 해당 로직을 호출하는 형식으로 변경하는 것이 나을까요?

사실 파일에 저장하는 것과 관련해서는 파일 저장을 프로그램 종료 시 가 아닌 프로그램 중간중간에 해야할 것 같다는 생각이 드는데, 어떤 방식이 좋을까요? 저희가 생각했던 방식은

프로그램이 종료될 때 한번에 저장 (현재)

바우처 Create 요청이 올 때마다 저장

적절한 주기(ex. 1시간, 1일 간격)에 저장

이 있습니다! 2번은 오버헤드가 있을 것같고, 3번이 가장 적절해 보이는데 추후 3번 방식으로 변경해도 괜찮을까요?

ksy90101 · 2023-10-23T00:07:29Z

src/main/java/team/marco/vouchermanagementsystem/repository/JSONFileVoucherRepository.java

+        }
+
+        ObjectReader objectReader = objectMapper.readerForListOf(LoadedJSONVoucher.class);
+        List<LoadedJSONVoucher> loadedList;


좀더 의미잇는 단어를 쓰면 어떨까요?
loadedVouchers 같은 의미로요. List라는 단어는 포괄적으로 사용하는 단어니깐요.

jsonVouchers로 변수명 변경했습니다!

ksy90101 · 2023-10-23T00:09:09Z

src/main/java/team/marco/vouchermanagementsystem/util/Console.java

+import java.util.Objects;
+
+public final class Console {
+    private static final BufferedReader reader = new BufferedReader(new InputStreamReader(System.in));


혹시 Scanner대신 BufferedReader를 쓰신 이유가 따로 있나요

그냥 질문입니닷.

저는 주로 Scanner을 쓰고, 현우님은 주로 BufferedReader를 써서 별 고민없이 BufferedReader을 썼던 것 같습니다.. 찾아보니 Scanner와 BufferedReader의 차이에는

버퍼 사이즈 (Scanner: 1KB, BufferedReader: 8KB)

Input 형식 (Scanner: nextInt() 등의 메서드로 다양한 type 지원, BufferedReader: only String)

Thread safe (Scanner: thread safe X, BufferedReader: thread safe O)

가 있는 것 같습니다.

🙋🏻‍♀️ 동기화 이슈로 BufferedReader를 쓰는게 적합해 보이는데, 그대로 BufferedReader를 써도 될까요?

메서드 역할을 구체적으로 명시

기존 상위 모듈인 CommandType 이넘과 VoucherApplication을 application 패키지로 이동 VoucherApplication 이름을 ConsoleApplication으로 변경

최대값: 10억

기존 loadedList -> loadedVouchers

uijin-j and others added 30 commits October 13, 2023 16:30

chore: 프로젝트 설정

d8206b4

chore: 프로젝트 구조 수정

7a43a14

docs: gitignore 파일 추가

b2d855d

feat: 명령어 리스트 출력 기능

09383c2

style: IO 에러 메시지 수정

b8b7a70

feat: 명령어 선택 기능 추가

3c89d69

feat: VoucherService 생성

956c63e

feat: 에러 메시지 Console에 모아서 출력

a90c920

feat: Voucher 클래스 생성

eab04ca

feat: VoucherService에 Voucher 생성 기능 추가

7b618f7

fix: 프로그램이 종료되지 않는 버그 수정

1f39be2

refactor: 프로젝트 구조 세분화

b0a2cef

feat: 바우처 생성 기능 구현

a04242b

feat: 쿠폰 리스트 조회 기능

3afd2b4

feat: 메시지 한글로 변경

4753b4d

feat: 로그 기능 추가

e19a919

feat: 에러 로그 파일 저장 기능 추가

e3e601d

refactor: run() 메서드와 사용자 입력 부분 분리

e23928d

chore: jackson dependency 추가

1096094

feat: console log appender 추가

0ff015e

feat: FileManager 모듈 구현

be5b4b4

feat: VoucherType Enum 추가

3ce8d1a

Voucher 필드 게터 추가

feat: voucher 데이터를 파일에 저장하고 불러오는 기능 추가

989ac9e

feat: 블랙리스트 조회 기능 추가

a205363

refactor: JSONFileManager를 Repository와 병합

bacd5be

feat: 프로파일 설정 적용

620f34b

feat: 개발환경에 따라 로깅을 다르게 설정

7d34e54

fix: voucher_data.json 파일이 존재하지 않는 경우 프로그램이 종료되는 오류 해결

f5c1e48

refactor: voucher 서비스와 blacklist 서비스 분리

9121c79

uijin-j added 🔥 매운맛 Team-Marco labels Oct 19, 2023

uijin-j requested review from ksy90101 and twotwobread October 19, 2023 14:30

uijin-j self-assigned this Oct 19, 2023

ksy90101 requested changes Oct 23, 2023

View reviewed changes

ASak1104 added 22 commits October 24, 2023 09:52

refactor: 혼동을 줄 수 있는 메서드 이름 변경 및 readint(String prompt) 메서드 삭제

73ad52f

style: printList 메서드 명 변경

a6a8b3f

메서드 역할을 구체적으로 명시

refactor: 애플리케이션 실행 방식을 제귀에서 반복으로 변경

97f1d77

refactor: IOException 래핑 예외를 Runtime에서 UncheckedIO로 변경

4b22faf

refactor: validation에 사용되는 숫자를 상수로 변경

c5a9e7e

refactor: voucher 인터페이스를 추상 클래스로 변경

29c3e8c

refactor: csv 파일 regex를 상수로 변경

a72f674

fix: 로거 필드 클래스 부분 수정

d7cb447

style: 불필요한 import 제거

c262bd4

refactor: 프로그램 실행 로그 메시지 포맷 지정

a389446

refactor: application 패키지 구성 및 VoucherApplication 이름 변경

4e677b9

기존 상위 모듈인 CommandType 이넘과 VoucherApplication을 application 패키지로 이동 VoucherApplication 이름을 ConsoleApplication으로 변경

fix: dev, local profile의 로거 설정 수정

8521b76

fix: 명령어 입력 상황에서 잘못된 입력 예외처리가 되지 않는 버그 수정

3b04108

fix: local profile의 repository 변경

da28f47

fix: FixedAmountVoucher의 최대 할인 금액 설정

0ea0170

최대값: 10억

refactor: blacklist 데이터 로드 방법을 stream API로 변경

34b37c7

style: blacklist 필드를 반환할 때 불변성 명시

7752fdb

style: stream API의 코드 줄바꿈 방식 통일

71a2ae4

style: 사용하지 않는 생성자 제거

c804447

refactor: @value 어노테이션을 ConfigurationProperties 사용으로 변경

050a33a

refactor: 로드된 voucher 데이터를 변환하는 로직을 이넘으로 이동

25aeafb

style: 로드한 voucher 리스트의 변수명 수정

6e96e51

기존 loadedList -> loadedVouchers

ksy90101 merged commit 3c688df into prgrms-be-devcourse:uijin-j/week1 Oct 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[5기 - 정의진] SpringBoot Part1 Weekly Mission 제출합니다. #897

[5기 - 정의진] SpringBoot Part1 Weekly Mission 제출합니다. #897

uijin-j commented Oct 19, 2023 •

edited

Loading

ksy90101 left a comment

ksy90101 Oct 23, 2023

uijin-j Oct 24, 2023

ksy90101 Oct 23, 2023

ksy90101 Oct 23, 2023

ksy90101 Oct 23, 2023

ksy90101 Oct 23, 2023

ksy90101 Oct 23, 2023

ksy90101 Oct 23, 2023

uijin-j Oct 24, 2023

ksy90101 Oct 23, 2023

uijin-j Oct 24, 2023 •

edited

Loading

ksy90101 Oct 23, 2023

uijin-j Oct 24, 2023

ksy90101 Oct 23, 2023

uijin-j Oct 24, 2023 •

edited

Loading


		import static java.text.MessageFormat.format;

		public class FixedAmountVoucher implements Voucher {

	private static final Logger logger = LoggerFactory.getLogger(FixedAmountVoucher.class);
	private static final Logger logger = LoggerFactory.getLogger(PercentDiscountVoucher.class);

		public String getInfo() {

		return format("id: {0}, 고객명: {1} ", id, name);

[5기 - 정의진] SpringBoot Part1 Weekly Mission 제출합니다. #897

[5기 - 정의진] SpringBoot Part1 Weekly Mission 제출합니다. #897

Conversation

uijin-j commented Oct 19, 2023 • edited Loading

👩‍💻요구 사항과 구현 내용

요구사항

구현 내용

✅ PR 포인트 & 궁금한 점

ksy90101 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

uijin-j Oct 24, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

uijin-j Oct 24, 2023 • edited Loading

Choose a reason for hiding this comment

uijin-j commented Oct 19, 2023 •

edited

Loading

uijin-j Oct 24, 2023 •

edited

Loading

uijin-j Oct 24, 2023 •

edited

Loading