[1단계 - 상품 관리 기능] 망고(고재철) 미션 제출합니다. #185

Go-Jaecheol · 2023-04-26T07:35:03Z

안녕하세요 디디!
첫 번째 미션 이후로 다시 만났네요ㅎㅎ
이번에도 잘 부탁드립니다. 🙇‍♂️

이번 미션에서는 다음과 같이 설계한 후 진행했습니다.

DB 테이블 설계

erDiagram
  PRODUCT_LIST {
    BIGINT id PK
    VARCHAR name
    VARCHAR image
    INT price
  }

상품 관리 CRUD API

상품 Create

Request

POST /products HTTP/1.1
Host: localhost:8080
...

{
    "name": "망고",
    "image": "http://mango.png",
    "price": 1000
}

Response

HTTP/1.1 201 Created

상품 Retrieve

Request

GET /products HTTP/1.1
Host: localhost:8080
...

Response

HTTP/1.1 200 OK
...

[
    {
        "name": "망고",
        "image": "http://mango.png",
        "price": 1000,
        "id": 1
    },
    {
        "name": "디디",
        "image": "http://dd.png",
        "price": 2000,
        "id": 2
    }
]

상품 Update

Request

PUT /products/{id} HTTP/1.1
Host: localhost:8080
...

Response

HTTP/1.1 200 OK
...

{
    "name": "네오",
    "image": "http://neo.png",
    "price": 1000,
    "id": 1
}

상품 Delete

Request

DELETE /products/{id} HTTP/1.1
Host: localhost:8080
...

Response

HTTP/1.1 204 No Content

스프링에 대해 아직 익숙하지 않아서 여러모로 부족한 코드지만 잘 부탁드립니다 😁
추가로 궁금한 점은 코멘트로 남겨둘게요!

Co-authored-by: go-jaecheol <gojaech@naver.com>

아래 메서드들 구현 - findByName - deleteByID - update Co-authored-by: go-jaecheol <gojaech@naver.com>

아래 메서드들 테스트 - findByName - deleteByID - update Co-authored-by: go-jaecheol <gojaech@naver.com>

Co-authored-by: go-jaecheol <gojaech@naver.com>

# Conflicts: # README.md # src/main/java/cart/product/domain/Product.java # src/main/java/cart/product/service/ProductListService.java

Go-Jaecheol · 2023-04-26T08:53:42Z

Q1. URI에 ID를 노출시켜도 될까요??

Update나 Delete 요청을 할 때, PUT /admin/product/update/:id와 같은 형식으로 id를 통해 접근할 수 있도록 했습니다.
이렇게 id가 노출되도 되는지, 아니면 /admin/product/update/:name처럼 name을 노출시키고 내부에서 findIdByName()과 같은 메서드를 통해 id를 얻어서 값을 수정하도록 하는 것이 좋은지 궁금합니다!

Q2. REST API에서 URI 스타일

RESTful한 설계를 위해 URI를

/admin/product/update/{id}
/admin/product/{id}/update
/admin/product/{id}(PUT, DELETE 등 http method만 다르게)
어떤 방식을 선택하는 게 좋은지 궁금합니다.

fucct

안녕하세요 망고.

전체적으로 테스트가 미흡한 부분이 있는것 같아요. 관련된 피드백과 함께 질문주신 부분은 코멘트에 남겨두었습니다.
궁금하신 부분 있으시면 코멘트 부탁드립니다!

fucct · 2023-04-26T14:59:03Z

settings.gradle

@@ -1 +1 @@
-rootProject.name = 'jwp-cart'
+rootProject.name = 'jwp-shopping-cart'


모듈명이 어쩌다 수정된걸까요? ㅋㅋㅋ..

Intellij에서 프로젝트를 로드하는데 오류가 생겨서, settings.gradle의 rootProject.name을 프로젝트명과 동일하게 변경해 오류를 해결했습니다.

그런데 다른 크루들은 해당 오류가 발생하지 않았고, 페어의 노트북에서만 오류가 발생해서 IDE의 설정이나 버전 문제인지 정확하게 오류의 이유는 찾지 못했습니다..

settings.gradle이 하는 역할은 무엇인지, 그리고 저렇게 모듈명을 수정하면 안되는건지 궁금합니다!

settings.gradle 은 다음 링크를 읽어보시면 좋을것 같아요!
https://galid1.tistory.com/645

왜 그런 오류가 있는지 저도 모르겠네요. 모듈명이 바뀐 케이스를 처음봐서 여쭤봤습니다 ㅎㅎ

fucct · 2023-04-26T14:59:47Z

src/main/java/cart/product/controller/ProductListController.java

+import org.springframework.web.bind.annotation.GetMapping;
+
+@Controller
+public class ProductListController {


Controller 네이밍이 ProductList인데, 프로덕트리스트 페이지랑 어드민 페이지를 렌더하는 기능을 담고있네요.

해당 컨트롤러는 페이지를 렌더링 해주는 기능을 가지고 있어서, PageController로 네이밍 변경했습니다.

크게 REST API 기능을 하는 컨트롤러와 페이지를 렌더링 하는 컨트롤러를 나눠서, ProductRestController와 PageController로 나눴는데
여기서 더 나아가서 PageController를 역할에 따라 HomeController와 AdminController로 나누는 게 좋을까요..?
당장은 큰 의미가 없을 것 같아서 하나의 컨트롤러에 두었는데, 확장성을 고려한다면 나누는 것도 좋아보여서 질문 드립니다!

당장은 안바꿔도괜찮을것같아요.
다만 렌더해야하는 지면이 다양해진다면, 지면 특성별로 분류하는것도 관리측면에서 도움을 줄것 같네요.

fucct · 2023-04-26T15:01:38Z

src/main/java/cart/product/controller/AdminController.java

+        return this.productListService.display();
+    }
+
+    @PostMapping("/product/create")


HttpMethod POST/PUT/DELETE 자체가 행위를 의미하기 때문에 path에 행위에 대한 키워드를 쓰시는것은 Restful 하지 않은것 같아요 :)

https://prohannah.tistory.com/156 요걸 읽어보시면 도움이 될것 같네요.

참고 문서 감사합니다 :)

다음과 같이 수정했습니다!

Method Path

GET /products

POST /products

PUT /products/{id}

DELETE /products/{id}

fucct · 2023-04-26T15:01:55Z

src/main/java/cart/product/controller/AdminController.java

+    }
+
+    @PutMapping("/product/update/{id}")
+    @ResponseStatus(HttpStatus.CREATED)


Update가 CREATED 응답을 받는게 맞을까요?

처음에는 새로운 값을 넣어준다라고 생각해서 CREATED가 맞을 것 같다고 생각했는데
보통 값이 없을 때 값이 생성되면 CREATED를, 값이 있을 때 값을 수정하면 OK를 반환하는 것 같군요.

OK 상태 코드를 반환하도록 수정했습니다!

fucct · 2023-04-26T15:02:33Z

src/main/java/cart/product/controller/AdminController.java

+
+    @PostMapping("/product/create")
+    @ResponseStatus(HttpStatus.CREATED)
+    public void create(@RequestBody final RequestProductDto requestProductDto) {


spring validation 라이브러리를 이용하여 @Valid 어노테이션 사용해보시면 좋을것 같습니다 :)

fucct · 2023-04-26T15:15:15Z

src/test/java/cart/ProductIntegrationTest.java

+
+        //then
+        final String productLiteral = result.body().asString();
+        System.out.println("productLiteral = " + productLiteral);


테스트에 출력이 있는 이유가 어떤걸까요?

이 부분도 제대로 확인을 못했습니다..
RestAssured와 JsonPath에 익숙하지 않아서 값을 확인해본다는 걸 그대로 둔 것 같습니다 😥😥
수정하겠습니다!

fucct · 2023-04-26T15:15:50Z

src/test/java/cart/ProductIntegrationTest.java

+                .then()
+                .extract();
+
+        assertThat(result.statusCode()).isEqualTo(HttpStatus.CREATED.value());


integration test라면, dao를 주입받아 진짜로 저장이 되었는지도 확인해주셔야합니다.

ProductDao를 주입받아 각 테스트 별로 값이 잘 저장되거나 수정, 삭제되었는지 확인하는 과정을 추가했습니다.

fucct · 2023-04-26T15:16:25Z

src/test/java/cart/ProductIntegrationTest.java

+                .contentType(MediaType.APPLICATION_JSON_VALUE)
+                .body(requestProductDto)
+                .when()
+                .put("/admin/product/update/1")


실제로 id = 1 에 해당하는 product가 없을텐데, update가 되었다는걸 어떻게 검증할 수 있을까요?

우선 update 전에 해당 id가 값이 있는지 확인하고, 없으면 임의의 값을 넣어주는 과정을 추가했습니다..!

fucct · 2023-04-26T15:16:49Z

src/test/java/cart/ProductIntegrationTest.java

+        final var deleteResult = given()
+                .contentType(MediaType.APPLICATION_JSON_VALUE)
+                .when()
+                .delete("/admin/product/delete/2")


마찬가지로 id=2에 해당하는 product가 없을텐데 이거로 삭제검증이 가능할까요?

delete의 경우에도 우선 해당 id가 값이 있는지 확인하고, 없으면 임의의 값을 넣어주는 과정을 추가했습니다.

fucct · 2023-04-26T15:17:07Z

src/main/java/cart/product/domain/Product.java

+
+import cart.product.dto.RequestProductDto;
+
+public class Product {


product의 테스트도 필요해보입니다.

Product 생성 테스트 추가했습니다..!

fucct

안녕하세요 망고!

피드백 사항이 많았는데 꼼꼼하게 반영해주셨네요!
크게 피드백 드릴 내용은 없는것 같아서 머지하겠습니다 :)
수고많으셨고 다음 미션 진행해주세요!

echo and others added 25 commits April 25, 2023 14:43

docs: 기능목록 작성

9eda173

Co-authored-by: go-jaecheol <gojaech@naver.com>

feat: Product 도메인 추가

e621a40

Co-authored-by: go-jaecheol <gojaech@naver.com>

refactor: Product 필드 원시값 포장

0d58b31

Co-authored-by: go-jaecheol <gojaech@naver.com>

feat: JdbcProductDao 구현

e78f609

Co-authored-by: go-jaecheol <gojaech@naver.com>

feat: DB 테이블 생성

1f7c82e

Co-authored-by: go-jaecheol <gojaech@naver.com>

feat: 상품 목록 서비스 구현

98fcc2d

Co-authored-by: go-jaecheol <gojaech@naver.com>

test: Product 도메인 테스트 추가

c51d5aa

Co-authored-by: go-jaecheol <gojaech@naver.com>

test: JdbcProductDao 테스트 추가

00a8067

Co-authored-by: go-jaecheol <gojaech@naver.com>

test: ProductListService 테스트 추가

73a451a

Co-authored-by: go-jaecheol <gojaech@naver.com>

feat: 상품 목록 페이지 연동 기능 구현

e07aa97

Co-authored-by: go-jaecheol <gojaech@naver.com>

docs: 상품 관리 CRUD API 기능 작성

6f373f0

Co-authored-by: go-jaecheol <gojaech@naver.com>

feat: ProductDao 기능 추가

5cf9f49

아래 메서드들 구현 - findByName - deleteByID - update Co-authored-by: go-jaecheol <gojaech@naver.com>

test: ProductDao 테스트 추가

9c0a0ef

아래 메서드들 테스트 - findByName - deleteByID - update Co-authored-by: go-jaecheol <gojaech@naver.com>

feat: ProductListService에 create,update 추가

ba95228

Co-authored-by: go-jaecheol <gojaech@naver.com>

feat: ProductListService에 create,update 추가

303bca5

Co-authored-by: go-jaecheol <gojaech@naver.com>

refactor: ProductListService update 메서드 시그니쳐 변경

158d206

Co-authored-by: go-jaecheol <gojaech@naver.com>

docs: 상품 관리 CRUD API url 및 기능 변경

74c30e0

Co-authored-by: go-jaecheol <gojaech@naver.com>

feat: ProductListService에 delete 기능 추가

d60e79a

Co-authored-by: go-jaecheol <gojaech@naver.com>

feat: 상품 관리 CRUD API 구현

d94ceb2

Co-authored-by: go-jaecheol <gojaech@naver.com>

refactor: RequestProductDto ResponseProductDto 분리

14b95de

Co-authored-by: go-jaecheol <gojaech@naver.com>

feat: 관리자 도구 페이지 연동

c953b27

Co-authored-by: go-jaecheol <gojaech@naver.com>

test: 상품 통합 테스트 추가

cd8c16f

Co-authored-by: go-jaecheol <gojaech@naver.com>

test: 상품 통합 테스트 추가

3d19dc9

Co-authored-by: go-jaecheol <gojaech@naver.com>

feat: 에러 발생시 400 상태 코드 반환하는 기능 추가

310c993

Co-authored-by: go-jaecheol <gojaech@naver.com>

Merge remote-tracking branch 'origin/step1' into step1

1efa9d4

# Conflicts: # README.md # src/main/java/cart/product/domain/Product.java # src/main/java/cart/product/service/ProductListService.java

fucct requested changes Apr 26, 2023

View reviewed changes

Go-Jaecheol added 3 commits April 27, 2023 16:44

docs: 1단계 리팩토링 요구사항 정리

fd507f2

refactor: Controller 네이밍 변경

0f0e30c

refactor: REST API의 URI path 수정

21e0f73

Go-Jaecheol added 13 commits April 28, 2023 16:15

refactor: Update의 반환 상태 코드 변경

55059a3

refactor: 사용하지 않는 클래스 및 구문 제거

3b02233

refactor: @Valid 어노테이션 사용

e886e18

refactor: Domain 객체에 DTO 객체를 넘겨주지 않도록 변경

0c29976

refactor: findById() Optional 처리하도록 변경

516b8c3

feat: ExceptionHandler 추가

7d75240

refactor: 매직넘버 상수 처리

8c4a52f

refactor: 사용하지 않는 findByName() 메서드 삭제

57ec683

test: fake 객체의 저장, 조회가 정상적으로 동작하는지 확인하도록 변경

20badac

test: service 테스트 추가

df5f433

test: IntegrationTest에서 DB에 값이 실제로 저장되는지 확인하도록 변경

1521161

test: Product 테스트 추가

ea64914

test: JdbcProductDao 테스트 변경 및 findById 테스트 추가

7f05fbd

fucct approved these changes May 1, 2023

View reviewed changes

fucct merged commit 56d2887 into woowacourse:go-jaecheol May 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[1단계 - 상품 관리 기능] 망고(고재철) 미션 제출합니다. #185

[1단계 - 상품 관리 기능] 망고(고재철) 미션 제출합니다. #185

Go-Jaecheol commented Apr 26, 2023 •

edited

Loading

Go-Jaecheol commented Apr 26, 2023

fucct left a comment

fucct Apr 26, 2023

Go-Jaecheol Apr 27, 2023

fucct May 1, 2023

fucct Apr 26, 2023

Go-Jaecheol Apr 28, 2023

fucct May 1, 2023

fucct Apr 26, 2023

Go-Jaecheol Apr 28, 2023

fucct Apr 26, 2023

Go-Jaecheol Apr 29, 2023

fucct Apr 26, 2023

fucct Apr 26, 2023

Go-Jaecheol Apr 26, 2023

fucct Apr 26, 2023

Go-Jaecheol Apr 29, 2023

fucct Apr 26, 2023

Go-Jaecheol Apr 29, 2023

fucct Apr 26, 2023

Go-Jaecheol Apr 29, 2023

fucct Apr 26, 2023

Go-Jaecheol Apr 29, 2023

fucct left a comment

		@@ -1 +1 @@
		rootProject.name = 'jwp-cart'
		rootProject.name = 'jwp-shopping-cart'

Method	Path
GET	/products
POST	/products
PUT	/products/{id}
DELETE	/products/{id}


		import cart.product.dto.RequestProductDto;

		public class Product {

[1단계 - 상품 관리 기능] 망고(고재철) 미션 제출합니다. #185

[1단계 - 상품 관리 기능] 망고(고재철) 미션 제출합니다. #185

Conversation

Go-Jaecheol commented Apr 26, 2023 • edited Loading

DB 테이블 설계

상품 관리 CRUD API

상품 Create

상품 Retrieve

상품 Update

상품 Delete

Go-Jaecheol commented Apr 26, 2023

Q1. URI에 ID를 노출시켜도 될까요??

Q2. REST API에서 URI 스타일

fucct 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

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

fucct left a comment

Choose a reason for hiding this comment

Go-Jaecheol commented Apr 26, 2023 •

edited

Loading