[SpringBoot] mallangShopBeta

📍 GitHub 바로가기

Project Intro

1️⃣ 서비스 기능

서비스기능
1. 키워드로 상품검색 → 결과 목록으로 보여주기
2. 관심상품 등록하기
3. 관심상품 조회하기
4. 관심상품 최저가등록하기

2️⃣ API 동작순서 Architecture

3️⃣ API 명세서

기능	Method	URL	Request	Response
메인페이지	GET	/api/shop	-	index.html
Query로 상품검색, 상품검색결과 목록반환	GET	/api/search?query=검색어	-	[ {   "title" : String,   "image" : String,   "link" : String,   "lprice" : int }, ••• ]
관심상품 등록	POST	/api/products	{   "title" : String,   "image" : String,   "link" : String,   "lprice" : int }	{   "id" : Long,   "title" : String,   "image" : String,   "link" : String,   "lprice" : int,   "myprice" : int }
관심상품 조회	GET	/api/products	-	[ {   "id" : Long,   "title" : String,   "image" : String,   "link" : String,   "lprice" : int,   "myprice" : int }, ••• ]
관심상품 최저가 등록	PUT	/api/products/{id}	{   "myprice" : int }	id

4️⃣ Project Setting

---

1 NaverOpenAPI 구현

📎 상품검색결과 목록반환

1️⃣ Naver > NaverApiController.java

@RestController
@RequiredArgsConstructor
@RequestMapping("/api")
public class NaverApiController {

    private final NaverApiService naverApiService;

    // 상품검색결과 목록반환
    @GetMapping("/search")
    public List<ItemDto> searchItems(@RequestParam String query) {
        return naverApiService.searchItems(query);
    }

}

2️⃣ Naver > NaverApiService.java

@Service
@Slf4j
public class NaverApiService {

    public List<ItemDto> searchItems(String query) {

        RestTemplate restTemplate = new RestTemplate();

        HttpHeaders httpHeaders = new HttpHeaders();

        // HttpHeader -> Client Id/Pw 실어 보냄
        httpHeaders.add("X-Naver-Client-Id", "_VwwboxD7N9gzc6pnvuC");
        httpHeaders.add("X-Naver-Client-Secret", "e3kEsesnyl");
        String body = "";

        // HttpEntity -> header + body
        HttpEntity<String> requestEntity = new HttpEntity<String>(body, httpHeaders);

        // HttpResponse -> query + GET메서드 + Request(header+body)
        ResponseEntity<String> responseEntity = restTemplate.exchange(
                "https://openapi.naver.com/v1/search/shop.json?display=15&query="
                        + query, HttpMethod.GET, requestEntity, String.class);
        // display=15 : 검색결과 총 15개 show
        // HttpEntity 클래스 : Http 요청, 응답에 해당하는 HttpHeader와 HttpBody를 가짐
        // HttpEntity 클래스를 상속받아 구현한 클래스 -> requestEntity, responseEntity

        // HttpStatus
        HttpStatusCode httpStatus = responseEntity.getStatusCode();
        int status = httpStatus.value();
        log.info("NAVER API Status Code : " + status);

        // Response Body -> method
        // responseEntity의 바디에 있는 값을 -> String 타입 response에 담아옴
        String response = responseEntity.getBody();

        return fromJSONtoItems(response);

    }

    // String(검색결과) -> Dto에 담기위해 변환하는 메서드
    public List<ItemDto> fromJSONtoItems(String response) {

        // JSONObject -> build.gradle에 종속성추가
        JSONObject jsonObject = new JSONObject(response); // String 검색결과 -> JSONObject
        JSONArray items = jsonObject.getJSONArray("items"); // JSONObject -> JSONArray

        // Dto List 객체생성
        List<ItemDto> itemDtoList = new ArrayList<>();

        // JSONArray -> for문 돌면서 item 하나씩 꺼내 -> ItemDto에 변환
        for (int i = 0; i < items.length(); i++) {
            JSONObject itemJson = items.getJSONObject(i);
            ItemDto itemDto = ItemDto.of(itemJson);
            itemDtoList.add(itemDto);
        }

        return itemDtoList;

    }

}

3️⃣ Naver > ItemDto.java

@Getter
@NoArgsConstructor
public class ItemDto {

    private String title;

    private String link;

    private String image;

    private int lprice;

    // 생성자
    @Builder
    private ItemDto(String title, String link, String image, int lprice) {
        this.title = title;
        this.link = link;
        this.image = image;
        this.lprice = lprice;
    }

    // 정적팩토리메서드
    public static ItemDto of(JSONObject itemJson) {
        return ItemDto.builder()
                .title(itemJson.getString("title"))
                .link(itemJson.getString("link"))
                .image(itemJson.getString("image"))
                .lprice(itemJson.getInt("lprice"))
                .build();
    }

}

📍 ErrorIssue 바로가기

4️⃣ Postman 확인

---

2 Product 설계

1️⃣ Entity > Product.java

@Entity
@Getter @Setter
@NoArgsConstructor // 파라미터 없는 기본생성자
public class Product {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    // Id 자동생성 및 증가
    private Long id;

    @Column(nullable = false)
    private String title;

    @Column(nullable = false)
    private String image;

    @Column(nullable = false)
    private String link;

    @Column(nullable = false)
    private int lprice;

    @Column(nullable = false)
    private int myprice;

    // 생성자
    @Builder
    private Product(String title, String image, String link, int lprice) {
        this.title = title;
        this.image = image;
        this.link = link;
        this.lprice = lprice;
        this.myprice = 0;
    }

    // 정적팩토리메서드
    public static Product of(ProductRequestDto productRequestDto) {
        return Product.builder()
                .title(productRequestDto.getTitle())
                .image(productRequestDto.getImage())
                .link(productRequestDto.getLink())
                .lprice(productRequestDto.getLprice())
                .build();
    }

}

2️⃣ DTO

Dto > ProductResponseDto.java

@Getter
@NoArgsConstructor // 파라미터없는 기본생성자
public class ProductResponseDto {

    private Long id;

    private String title;

    private String link;

    private String image;

    private int lprice;

    private int myprice;

    // 생성자
    @Builder
    private ProductResponseDto(Long id, String title, String link, String image, int lprice, int myprice) {
        this.id = id;
        this.title = title;
        this.link = link;
        this.image = image;
        this.lprice = lprice;
        this.myprice = myprice;
    }

    // 정적팩토리메서드
    public static ProductResponseDto of(Product product) {
        return ProductResponseDto.builder()
                .id(product.getId())
                .title(product.getTitle())
                .link(product.getLink())
                .image(product.getImage())
                .lprice(product.getLprice())
                .myprice(product.getMyprice())
                .build();
    }

}

Dto > ProductRequestDto.java

@Getter
@NoArgsConstructor // 파라미터없는 기본생성자
@AllArgsConstructor // 모든 필드를 파라미터로받는 생성자
public class ProductRequestDto {

    private String title;

    private String image;

    private String link;

    private int lprice;

}

Dto > ProductMypriceRequestDto.java

@Getter
@NoArgsConstructor
@AllArgsConstructor
public class ProductMypriceRequestDto {

    private int myprice;

}

---

3 관심상품등록 설계

1️⃣ Controller > AllInOneController.java

// JSON 형태의 데이터반환
@RestController
@RequestMapping("/api")
public class AllInOneController {

    // 관심상품 등록
    @PostMapping("/products")
    public ProductResponseDto createProduct(@RequestBody ProductRequestDto productRequestDto) throws SQLException {

        //  RequestDto -> DB에 저장할 Entity객체 생성 + 초기화
        Product product = Product.of(productRequestDto);

        // DB 연결
        Connection connection = DriverManager.getConnection("jdbc:h2:mem:db", "mallang", "");

        // DB Query 작성
        PreparedStatement preparedStatement = connection.prepareStatement("select max(id) as id from product");

        ResultSet resultSet = preparedStatement.executeQuery();

        if (resultSet.next()) {
            // product id 설정 = product 테이블 마지막 Id + 1
            product.setId(resultSet.getLong("id") + 1);
        } else {
            throw new SQLException("product 테이블의 마지막 Id 값을 찾아오지 못했습니다.");
        }

        preparedStatement = connection.prepareStatement("insert into product(id, title, image, link, lprice, myprice) values (?, ?, ?, ?, ?, ?)");
        preparedStatement.setLong(1, product.getId());
        preparedStatement.setString(2, product.getTitle());
        preparedStatement.setString(3, product.getImage());
        preparedStatement.setString(4, product.getLink());
        preparedStatement.setInt(5, product.getLprice());
        preparedStatement.setInt(6, product.getMyprice());

        // DB Query 실행
        preparedStatement.executeUpdate();

        // DB 연결해제
        preparedStatement.close();

        connection.close();

        // Response 전송
        return ProductResponseDto.of(product);

    }
}

2️⃣ Postman 확인

---

4 관심상품조회 설계

1️⃣ Controller > AllInOneController.java

{
	// 관심상품 조회
    @GetMapping("/products")
    public List<ProductResponseDto> getProducts() throws SQLException {

        // 반환타입 (ResponseDtoList) 객체생성
        List<ProductResponseDto> productResponseDtoList = new ArrayList<>();

        // DB 연결
        Connection connection = DriverManager.getConnection("jdbc:h2:mem:db", "mallang", "");

        // DB Query 작성 및 실행
        Statement statement = connection.createStatement();

        ResultSet resultSet = statement.executeQuery("select * from product");

        // DB Query 결과 -> productResponseDtoList 변환
        while (resultSet.next()) {
            Product product = new Product();

            product.setId(resultSet.getLong("id"));
            product.setTitle(resultSet.getString("title"));
            product.setImage(resultSet.getString("image"));
            product.setLink(resultSet.getString("link"));
            product.setLprice(resultSet.getInt("lprice"));
            product.setMyprice(resultSet.getInt("myprice"));

            productResponseDtoList.add(ProductResponseDto.of(product));
        }

        // DB 연결해제
        resultSet.close();
        connection.close();

        // Response 전송
        return productResponseDtoList;

    }
}

2️⃣ Postman 확인

---

5 관심상품최저가등록 설계

1️⃣ Controller > AllInOneController.java

{
	// 관심상품 최저가 등록
    @PutMapping("/products/{id}")
    public Long updateProduct(@PathVariable Long id, @RequestBody ProductMypriceRequestDto productMypriceRequestDto) throws SQLException {

        // Entity 객체생성
        Product product = new Product();

        // DB 연결
        Connection connection = DriverManager.getConnection("jdbc:h2:mem:db", "mallang", "");

        // DB Query 작성
        PreparedStatement preparedStatement = connection.prepareStatement("select  * from product where id = ?");

        preparedStatement.setLong(1, id);

        // DB Query 실행
        ResultSet resultSet = preparedStatement.executeQuery();

        if (resultSet.next()) {
            product.setId(resultSet.getLong("id"));
            product.setTitle(resultSet.getString("title"));
            product.setImage(resultSet.getString("image"));
            product.setLink(resultSet.getString("link"));
            product.setLprice(resultSet.getInt("lprice"));
            product.setMyprice(resultSet.getInt("myprice"));
        } else {
            throw new NullPointerException("해당 Id가 존재하지 않습니다.");
        }

        // DB Query 작성
        preparedStatement = connection.prepareStatement("update product set myprice = ? where id = ?");

        preparedStatement.setInt(1, productMypriceRequestDto.getMyprice());
        preparedStatement.setLong(2, product.getId());

        // DB Query 실행
        preparedStatement.executeUpdate();

        // DB 연결해제
        resultSet.close();
        preparedStatement.close();
        connection.close();

        // Response 전송
        return product.getId();

    }
}

2️⃣ Postman 확인

---

6 AllInOneController 한계점

• 1개의 클래스 → 너무 많은 양의 코드가 존재함

  • 코드이해 어려움
  • 처음 ~ 끝까지 다 읽어야 코드이해 가능

• 코드 추가 및 변경 요청 → 대응 어렵고 번거로움

1️⃣ 절차적 프로그래밍

• 초기 프로그래밍 방식

• 컴퓨터가 해야하는 일 → 순차적으로 쭉 나열해놓은 코딩방식

• (ex. AllInOneController 클래스 API 처리내용)

2️⃣ 객체지향 프로그래밍

• 소프트웨어 규모가 커지면서 등장

• 하나의 사물(객체) → 하나의 의미를 부여하는 방식으로 프로그래밍

3️⃣ 지향해야할 프로그래밍 방식

📌 처음엔 절차적프로그래밍, 나중엔 객체지향 프로그래밍으로 리팩토링

• 리팩토링 (Refactoring) : 기능 상 변경 ❌, 프로그래밍 구조를 개선하는 것

  • ① 하나의 파일에 너무 많은 코드가 들어가지 않도록
  • ② 역할별로 코드 분리
  • ③ 코드를 가독성 좋게

---