[4단계 - 체스] 미아(이종미) 미션 제출합니다. #778

jongmee · 2024-03-31T07:44:25Z

안녕하세요 오리! 4단계도 잘 부탁드립니다 🙇🏻‍♀️

추가된 기능과 게임 실행 방법은 리드미에 적어놓았습니다. 또한 docker/db/mysql/init/ddl.sql에 DDL을 첨부해놓았습니다. (도커를 실행하면 따로 DDL을 실행하지 않아도 됩니다.)

DB 다이어그램

추가 구현 기능

DAO가 생기면서 도메인 객체와 DAO 간의 의존과 협력을 다루기 위해 ChessGameService를 생성하였습니다.
선택적으로 추가로 구현한 요구사항은 이전 체스게임 기록을 관리하는 것입니다. 종료된 게임에 대해 최신순으로 게임 결과를 조회할 수 있습니다. 또한 승패를 저장하게 되면서 무승부(TIE)를 다뤄야 했는데, 실제 게임 규칙을 모두 적용하기엔 시간이 부족하여 플레이어의 합의 무승부만 다루었습니다. 유저가 무승부를 입력하면 무승부로 저장됩니다.

리팩토링된 부분

`ChessBoardGenerator`삭제

저번 리뷰를 바탕으로 '추상화의 목적이 불분명하고, 불필요한 의존도가 생겼다'라고 생각하여 삭제하였습니다.

`GameState`구현체 추가

기능이 늘어나면서 Run이 맡는 역할이 커져서 Move와 Summarize를 추가하였습니다.

jinyoungchoi95

안녕하세요 미아 😄

4단계 잘 구현해주셨네요. 몇가지 코멘트 남겨두었으니 확인부탁드려요.

궁금하거나 고민이 되는 부분이 있으시다면 언제든 pr 코멘트 또는 dm으로 요청 부탁드립니다.
감사합니다 🙇‍♂️

jinyoungchoi95 · 2024-03-31T13:17:21Z

build.gradle

    testImplementation platform('org.assertj:assertj-bom:3.25.1')
    testImplementation('org.junit.jupiter:junit-jupiter')
    testImplementation('org.assertj:assertj-core')
+    runtimeOnly("com.mysql:mysql-connector-j:8.3.0")


runtimeOnly는 어떤 기능으로 동작할까요? implementation, compileOnly, api와 무슨 차이가 있을까요?

compileOnly은 컴파일에 의존하는 모듈들을 컴파일패스에 설정하고, runtimeOnly는 런타임에 의존하는 모듈들을 런타임패스에 설정하는 것이 좋습니다. 따라서 runtimeOnly는 DB 의존성에 사용하는 것이 좋습니다.

implementation과 api의 차이는 잘 몰라서 추가로 찾아보았습니다!
implementation과 api는 컴파일패스, 런타임패스에 모두 저장하는데, api는 전이 의존성을 허용하고 implementation은 허용하지 않습니다. implementation이 컴파일이 빠르고 재컴파일 횟수가 줄어들어 더 권장됩니다. 또한 전이 종속성에 실수로 빠지지 않습니다.

전이 종속성에 실수로 빠지지 않습니다

api의 경우 해당 문제때문에 의존성의 방향이 한단계 밑으로 내려가서 사용을 지양하는 편이긴해요. 대부분의 예제가 그런 이유로 implementation을 예제로 뿌려주기도하구요.

jinyoungchoi95 · 2024-03-31T13:18:29Z

docker/db/mysql/init/ddl.sql

+
+CREATE TABLE chess_board
+(
+    chess_board_id BIGINT      NOT NULL AUTO_INCREMENT,


Suggested change

chess_board_id BIGINT NOT NULL AUTO_INCREMENT,

id BIGINT NOT NULL AUTO_INCREMENT,

chess_board의 id인데 굳이 명시할 필요 없이 id로도 충분하지 않을까요?

id로 충분할 것 같아 변경하였습니다!

jinyoungchoi95 · 2024-03-31T13:20:07Z

docker/db/mysql/init/ddl.sql

+CREATE DATABASE IF NOT EXISTS `chess` DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
+CREATE DATABASE IF NOT EXISTS `chess_test` DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;


테스트용 database 세팅값은 같은 파일내에 있을 경우 가독성을 떨어뜨리는 등 혼란을 주기 때문에 별개의 파일로 분리하는것이 좋습니다.

분리하였습니다!

jinyoungchoi95 · 2024-03-31T13:22:00Z

docker/db/mysql/init/ddl.sql

+    PRIMARY KEY (file, `rank`, chess_board_id)
+);
+
+CREATE TABLE turn


turn정보는 chess_board에 들어가도 되었을텐데 테이블로 분리할 필요가 있을까요?

제가 도메인 설계를 할 때 ChessBoard가 Turn을 가지고 있지 않아서 따로 분리하였습니다. Java 어플리케이션의 도메인 구조와 DB 테이블 관계가 다른것이 어색하다고 느꼈습니다.

하지만 추후 GameResult를 도입하면서 다른 도메인 클래스(GameResult와 ChessBoard)여도 함께 저장하고, DTO를 사용하여 조회하였습니다. 어차피 일대일 대응 관계이므로 함께 조회하는게 더 효율적인 것 같았기 때문입니다! 그래서 chess_board에 turn 정보도 넣도록 수정하였습니다 :)

추가로 질문은, 실제로 오리가 현업에서 개발할 때 서로 다른 도메인 클래스이고, Composition 과 같은 관계도 없는데 같은 테이블로 저장하는 경우가 종종 있으신가요?! 저는 처음에 어색하다고 느껴서 질문드려요! 한편으로는 제가 도메인 설계를 잘못한 것 같기도 합니다 🥲

사실 데이터베이스에 저장되는 매커니즘과 객체지향의 매커니즘이 다르기때문에 그 둘의 괴리감이 발생하는 경우는 이상하지 않다고 생각해요. 데이터베이스는 연관관계의 주인이 fk로 한쪽이 가지고 있고, 상속도 사용할 수 없는데 반해 객체지향에서는 서로가 서로의 참조값을 가질 수 있고, 상속도 사용할 수 있으니까요.

설계할때는 "편하게"하기 위해서 데이터베이스를 먼저 설계하고 그게 맞게 domain 객체를 매핑만 하는 형태의 소위 데이터베이스 중심적인 설계를 하는데 말씀하신 케이스는 도메인에서 문제를 풀어나갈때 발생하기도 하는 케이스인 것 같아요. 너무 그 둘의 괴리감이 있다고 한쪽에 딱맞추어야 정답이다를 고민하지 않으셔도 좋을 것 같습니다 :)

그렇군요. 객체 설계와 DB 설계를 잘 맞춰나가는게 어렵네요 🥲

jinyoungchoi95 · 2024-03-31T13:24:22Z

src/main/java/chess/repository/utility/MySqlConnector.java

@@ -0,0 +1,31 @@
+package chess.repository.utility;


자바에서는 관습적으로 utility라는 패키지명이 아닌 util, utils 패키지네임을 쓰는 편이에요.

util 관련 관습은 처음 알았네요..! 반영하였습니다 👍

jinyoungchoi95 · 2024-03-31T14:13:28Z

src/test/java/chess/repository/dao/PieceDaoTest.java

+    @BeforeEach
+    void setUp() {
+        dataBaseCleaner.truncateTables();
+    }


beforeEach를 하면 현재 테스트되는 메소드에 영향이 안가는 것은 맞지만 테스트가 다 끝나고나서는 데이터가 남아있을 것 같네요. afterEach가 맞지 않을까요?

그렇군요 afterEach로 변경하였습니다!

jinyoungchoi95 · 2024-03-31T14:18:15Z

src/main/java/chess/service/ChessGameService.java

+
+    public ChessBoard createOrGetInitialChessBoard() {
+        Optional<ChessBoard> chessBoard = chessBoardDao.findLatest();
+        return chessBoard.orElseGet(this::createInitialChessBoard);


orElseGet 👍

jinyoungchoi95 · 2024-03-31T14:19:08Z

src/main/java/chess/service/ChessGameService.java

+        turnDao.delete(chessBoardId);
+        turnDao.save(chessBoardId, nextTurn);


update를 해도되지 않나요?

맞습니다..! 리팩토링하면서 turn을 chess_board에 저장하며 update 쿼리로 변경하였습니다.

jinyoungchoi95 · 2024-03-31T14:21:26Z

src/test/java/chess/repository/dao/ChessBoardDaoTest.java

+                () -> assertThat(chessBoard).isNotEmpty(),
+                () -> chessBoard.ifPresent(actual -> assertThat(actual.getBoard()).hasSize(64))


(반영하지 않으셔도 됩니다.) 개인적으로는 when에서 Optional을 반환하지 않고 get()으로 꺼내어 사용하는 편이긴 합니다 :)

다른 테스트에서는 get()을 사용했어서 이 테스트도 get()을 사용하도록 변경하였습니다 ! 위에서 empty를 확인해주어서 ifPresent가 필요 없어 보이기도 하네요 ..!

jinyoungchoi95 · 2024-03-31T14:21:59Z

src/test/java/chess/repository/DataBaseCleaner.java

+import java.sql.SQLException;
+import java.util.List;
+
+public class DataBaseCleaner {


truncate를 사용한 이유가 무엇일까요? 단점은 없을까요?

테스트를 할 때마다 데이터를 지우는 방법으로 drop과 trncate를 생각했는데, 매번 테이블을 드랍하고 생성하는 것보다 truncate가 간편하여 사용하였습니다..! 지금 방식의 단점은 쿼리를 문자열로 저장해놓아서 테이블에 변경 사항이 있다면 함께 변경해주어야 하는 것입니다. truncate 자체의 단점은 떠오르지 않는데, 오리가 생각하는 다른 단점이 있을까요 ??

말씀해주신 내용들이 맞아요. rollback이 안되는 문제가 있는데 현재 케이스에선 큰 문제가 없을 것 같아요 :)

jongmee · 2024-04-01T08:47:21Z

안녕하세요 오리 ! 마감 직전에 다시 리뷰 요청 드리네요 🥲 몇 가지 질문과 답변을 코멘트에 남겨놓았습니다!

jinyoungchoi95

안녕하세요 미아 😄

피드백 잘 반영해주셨네요. 4단계에 필요한 학습과 구현을 충분히 진행하신 것으로 보여 머지하려고하는데요. 남겨둔 코멘트에 궁금하신 것이 있을까하여 request change드려요.

궁금하거나 고민이 되는 부분이 있으시다면 언제든 pr 코멘트 또는 dm으로 요청 부탁드립니다.
감사합니다 🙇‍♂️

jinyoungchoi95 · 2024-04-01T10:38:23Z

docker/db/mysql/init/ddl_prod.sql

+CREATE TABLE piece
+(
+    file           VARCHAR(10) NOT NULL,
+    `rank`         INT         NOT NULL,


(반영하지 않으셔도 됩니다.) 예약어는 현재처럼(`를 붙여야하는) 제약사항이 존재하기 때문에 가능하면 db에서 네이밍은 예약어를 피하려는 편입니다.

level2에서 db를 많이 활용할 때 예약어를 피해서 설계해보도록 하겠습니다! 감사합니다 😊

jinyoungchoi95 · 2024-04-01T10:38:54Z

docker/db/mysql/init/ddl_test.sql

@@ -0,0 +1,26 @@
+GRANT ALL PRIVILEGES ON *.* TO 'root'@'localhost';


root보다는 user에게 권한을 주고 user를 사용하는 것이 좋았을 것 같네요 :)

db connection과 ddl 실행을 root 권한이 아닌 user권한으로 실행하도록 변경하였습니다!

jinyoungchoi95 · 2024-04-01T10:41:56Z

src/main/java/chess/repository/dao/ChessBoardDao.java

@@ -0,0 +1,147 @@
+package chess.repository.dao;


다음단계에서 진행할 내용이지만, 엄밀히 따지면 repository 내부에 dao가 있는 구조 현재는 어색할 수 있어요. repository 클래스가 존재하는 것도 아니기 때문에 repository라는 네이밍이 어디서왔고 왜쓰였느냐가 명확하지 않은 것 같아요. 해당 내용은 2레벨때 천천히 배우셔도 좋을 것 같아 링크만 드립니다.

https://www.baeldung.com/java-dao-vs-repository

DAO is an abstraction of data persistence. However, a repository is an abstraction of a collection of objects

dao와 repository가 비슷한 개념인 줄 알았는데 잘못사용했네요 🥲 패키지명은 dao로 변경하였습니다! 감사합니다 🙇🏻‍♀️

jongmee · 2024-04-02T04:48:35Z

안녕하세요 오리! 남겨주신 리뷰를 바탕으로 약간의 수정을 진행했습니다. 추가적으로 궁금한 것은 없습니다 :)

jinyoungchoi95

안녕하세요 미아 😄

1레벨동안 고생많으셨습니다. 다음 레벨도 화이팅하세요 :)

감사합니다 🙇‍♂️

jongmee added 30 commits March 29, 2024 13:52

feat(PieceValue): PieceValue 캐싱

504a565

build: mysql 의존성 설정

782a065

feat(MySqlConnection): mysql 연결 설정 클래스 생성

eb6ef8d

feat(ChessBoardDao): 체스보드를 생성하고 id로 조회한다

4cf7ab7

feat(PieceDao): 특정 ChessBoard의 Piece를 저장하고 수정한다

bac7a37

feat(TurnDao): 게임 차례를 저장하고 조회한다

b78d303

refactor(StatementExecutor, ResultSetMapper): dao 리팩토링

0572b66

refactor: dao 메소드 이름 변경

0388c70

feat(DataAccessException): dao 관련 커스텀 예외 생성

004f830

refactor: respository 패키지 구조 변경

89c3a2e

fix: ChessBoard의 id 를 long type으로 변경

2330ed8

feat(ChessGameService): 체스보드, 기물, 게임 차례를 어플리케이션에서 저장한다

9ce63d3

feat(ChessBoardDao): 가장 최근 저장된 체스 보드 id를 조회한다

722a81d

fix(ChessBoardDao): 가장 최근에 생성된 체스 보드를 조회한다.

f9528f3

fix(ChessGameService): 이미 생성된 게임 차례가 있다면 새로 생성하지 않는다

0bd4e1a

refactor(ChessBoardDao): ResultSetMapper 로직 리팩토링

f438b00

fix(ChessGameService): 게임 차례를 바꿀 때 기존 차례를 삭제한다

802c781

feat(ChessBoardDao): ChessBoard에 게임 결과를 저장한다

4910aa9

fix(ChessBoardDao): 최근 체스보드 조회시 '진행중'인 것만 조회한다

4adc0d9

feat(ChessBoardDao): 게임 결과를 저장하고 조회한다

5653b5b

feat: 최종 게임 결과를 판단하고 저장한다

336534e

feat: 이전 체스 게임 결과 목록을 조회한다

4fea615

chore(OutputView): 게임 안내 문구 수정

121644a

refactor: 불필요한 싱글톤 제거

cbe6fa3

chore(MySqlConnection): 환경 변수 설정

fdadbd7

build: mysql docker 설정 및 MySqlConnector 설정 변경

56d6e99

chore(ChessBoardDao): 쿼리 문자열 수정

47ab38a

docs: step4 기능 추가

7aef379

remove(TurnMapper): TurnMapper getter로 대체

d63dc73

remove(ChessBoardGenerator): ChessBoardGenerator 인터페이스 삭제

aa7d3ef

jongmee added 6 commits March 31, 2024 04:26

style: sql 포매팅

5fe009b

remove(PropertyLoadException): 사용하지 않는 exception 제거

15fa090

feat: 플레이어가 서로 합의하여 무승부가 될 수 있다

561f7d2

chore(OutputView): 게임 시작 문구 변경

dd52c74

refactor(GameState): Move, Summarize state 생성

7f28d79

test(ChessGameServiceTest): ChessGameService 통합 테스트 추가

bb5087c

jinyoungchoi95 requested changes Mar 31, 2024

View reviewed changes

jongmee added 8 commits April 1, 2024 14:35

chore: test용 ddl 별개의 파일로 분리

1fb6789

refactor: repository 패키지의 utility 패키지명 변경

d32ea66

test(ChessBoardDaoTest): Optional 사용 로직 수정

612db51

test: DB 연동 테스트 시 BeforeEach를 AfterEach로 변경

cb48c6f

feat: turn 테이블 삭제, chess_board에 turn 속성 추가

07d3742

refactor: 초기 체스판 조회시 게임 차례도 함께 조회

6e6f9be

refactor(MySqlConnector): 테스트와 프로덕션 db connection을 따로 관리

8323757

chore: chess_board id 컬럼명 변경

f64e100

jongmee added 3 commits April 1, 2024 17:52

refactor(ChessBoardDao): 쿼리에서 컬럼 이름 변경

a418e73

fix: ddl 오타 수정

8edc646

fix: ddl 오타 수정

99ef558

jinyoungchoi95 requested changes Apr 1, 2024

View reviewed changes

jongmee added 3 commits April 2, 2024 12:31

refactor: repository에서 dao로 패키지명 변경

9dfa5b9

remove(MySqlConnectionTest): db 연결 테스트 삭제

8f32164

fix: db connection과 ddl 실행하는 계정 변경

6b24c62

docs: db 스키마 다이어그램 추가

a8677e5

jinyoungchoi95 approved these changes Apr 2, 2024

View reviewed changes

jinyoungchoi95 merged commit cc0345a into woowacourse:jongmee Apr 2, 2024

	chess_board_id BIGINT NOT NULL AUTO_INCREMENT,
	id BIGINT NOT NULL AUTO_INCREMENT,

		CREATE DATABASE IF NOT EXISTS `chess` DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
		CREATE DATABASE IF NOT EXISTS `chess_test` DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;

		turnDao.delete(chessBoardId);
		turnDao.save(chessBoardId, nextTurn);

		() -> assertThat(chessBoard).isNotEmpty(),
		() -> chessBoard.ifPresent(actual -> assertThat(actual.getBoard()).hasSize(64))

		@@ -0,0 +1,26 @@
		GRANT ALL PRIVILEGES ON . TO 'root'@'localhost';

[4단계 - 체스] 미아(이종미) 미션 제출합니다. #778

[4단계 - 체스] 미아(이종미) 미션 제출합니다. #778

Uh oh!

Conversation

jongmee commented Mar 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

DB 다이어그램

추가 구현 기능

리팩토링된 부분

ChessBoardGenerator삭제

GameState구현체 추가

Uh oh!

jinyoungchoi95 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jongmee commented Apr 1, 2024

Uh oh!

jinyoungchoi95 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jongmee commented Apr 2, 2024

Uh oh!

jongmee commented Mar 31, 2024 •

edited

Loading

`ChessBoardGenerator`삭제

`GameState`구현체 추가