[웹개발의 봄, Spring] 4주차 개발일지(1) - 네이버 쇼핑 API 이용하기

 

개발의 핵심 중 하나는 분업과 느슨한 결합이다. 분업을 통해 기능을 온전히 작동하게 하고, 느슨히 결합함으로써 유연성과 확장성을 가질 수 있다. 스프링의 척추라 할 수 있는 Controller, Service, Repository 3계층은 분업과 느슨한 결합의 대표적인 예시이다. 

 

느슨한 결합의 또 다른 예시가 바로 API이다. 내가 API의 내부 로직이 어떻게 짜여졌는지 모르는 상황에서도, 공식 문서에 나온 정해진 약속대로 요구를 하면 정해진 결과를 받을 수 있다. 따라서 API를 "사용"할 줄 아는 것이 중요하다. 

 

이번 주차 수업 내용은 스프링의 3계층과 API handling 연습에 중점을 뒀다. 이번에 만들 것은 <나만의 셀렉샵>이다. 요구 기능은 다음과 같다. 

• 상품명에 따른 검색
• 관심 상품 등록 & 조회
• 관심 상품에 대한 최저가 등록하기

아래 주소에서 데모를 확인할 수 있다. 

http://spring.spartacodingclub.kr/

 

 

프로젝트 설계하기

💡 API 설계하기

자!!!! 이제 API를 설계할 시간이다. 처음에 나는 상품명에 따른 검색과 관심 상품 등록의 url을 구분하지 않고 하려해서 복잡해질 뻔 했는데, 강의를 보니 다음과 같이 깔끔하게 정리할 수 있었다.

 

기능	Method	URL	return
키워드로 상품 검색하고 그 결과를 목록으로 보여주기	GET	/api/search?query=검색어	List<ItemDto>
관심 상품 등록하기	POST	/api/products	Product
관심 상품 조회하기	GET	/api/products	List<Product>
관심 상품에 관심 가격 등록하고, 상품 가격이 더 낮은 경우 표시하기	PUT	/api/products/{id}	id

 

 

💡 3계층 설계하기

1. Controller

• ProductRestController: 관심 상품 관련 컨트롤러
• SearchRequestContorller: 검색 관련 컨트롤러

2. Service

• ProductService: 관심 상품 가격 변경

3. Repository

• Product: 관심 상품 테이블
• ProductRepository: 관심 상품 조회, 저장
• ProductRequestDto: 관심 상품 등록하기
• ProductMypriceRequestDto: 관심 가격 변경하기
• ItemDto: 검색 결과 주고받기 (DB에 저장할 필요X)

 

이제 "상품명에 따른 검색" 기능을 만들기 위해 네이버 쇼핑 API를 이용해보자~~

 

 

 

 

네이버 쇼핑 API 이용하기

💡 API 이용 신청하기

1. https://developers.naver.com/docs/search/shopping/에 접속한다. 
2. "오픈 API 이용 신청" 버튼을 클릭한다. 
   

   

3. 네이버 로그인을 진행한다. 
4. 애플리케이션 이름과 서비스 환경을 추가한 뒤 "등록하기"를 클릭한다. 
   

   

5. Client ID와 Client Secret을 확인한다. 
   

   

 

 

💡 API 이용 방법

네이버 쇼핑 검색 API에 대한 설명은 https://developers.naver.com/docs/search/shopping/에 나와있다. 

JSON 형식으로 데이터를 받고싶다면, https://openapi.naver.com/v1/search/shop.json에 GET 방식으로 요청을 보내면 된다. 

요청 변수 query에 검색을 원하는 문자열을 담아서 요청을 보내면 된다. 출력 결과 items에 상품들에 대한 정보가 JSON 형식으로 전달된다. 

요청을 보낼 때는 발급받은 Client ID와 Client Secret 정보를 함께 넘겨줘야 한다. 

 

 

💡 API 이용 하기

정말 편리하게도 ARC에서 요청 Method, URL, Header(Client ID, Client Secret 포함) 정보를 입력하면 해당 요청의 스프링 코드를 확인할 수 있다. 

RestTemplate rest = new RestTemplate();
HttpHeaders headers = new HttpHeaders();
headers.add("X-Naver-Client-Id", "발급받은 Client ID");
headers.add("X-Naver-Client-Secret", "발급받은 Client Secret");
String body = "";

HttpEntity<String> requestEntity = new HttpEntity<String>(body, headers);
ResponseEntity<String> responseEntity = rest.exchange("https://openapi.naver.com/v1/search/shop.json?query=adidas", HttpMethod.GET, requestEntity, String.class);
HttpStatus httpStatus = responseEntity.getStatusCode();
int status = httpStatus.value();
String response = responseEntity.getBody();
System.out.println("Response status: " + status);
System.out.println(response);

return response;

 

위 코드 예시는 adidas라는 키워드로 검색을 요청한 경우이다.

 

 

💡 Naver Shop Search

이제 검색을 진행할 클래스를 생성하서 코드를 작성해야 한다. 

1. 프로젝트에 utils 패키지를 만든다. 
2. utils 패키지 안에 NaverShopSearch 클래스를 생성한다. 
3. public으로 search 함수를 만들고 위 코드를 붙여넣는다. 

 

아직 부족한게 있다.🤔 내가 원하는 것은 키워드를 넘겨주면 해당 키워드에 대한 검색을 진행하는 것이다. 따라서 search 함수에서 키워드를 받도록 하고, responseEntity를 생성할 때 해당 키워드를 query 값으로 넘겨주도록 수정해야 한다. 

public class NaverShopSearch {
    public String search(String query) {
        RestTemplate rest = new RestTemplate();
        HttpHeaders headers = new HttpHeaders();
        headers.add("X-Naver-Client-Id", "발급받은 Client ID");
        headers.add("X-Naver-Client-Secret", "발급받은 Client Secret");
        String body = "";

        HttpEntity<String> requestEntity = new HttpEntity<String>(body, headers);
        // 넘겨받은 query로 검색 요청
        ResponseEntity<String> responseEntity = rest.exchange("https://openapi.naver.com/v1/search/shop.json?query=" + query, HttpMethod.GET, requestEntity, String.class);
        HttpStatus httpStatus = responseEntity.getStatusCode();
        int status = httpStatus.value();
        String response = responseEntity.getBody();
        System.out.println("Response status: " + status);
        System.out.println(response);

        return response;
    }
}

 

 

💡 Item DTO

또또또 부족한게 있다.🤔 나는 검색 결과를 문자열이 아닌, ItemDto로 받고 싶다. ItemDto는 검색 결과로 오는 상품들에 대한 데이터를 물고 다니는 객체이다. ItemDto 클래스는 다음과 같다. 

@Getter
public class ItemDto {
    private String title;
    private String link;
    private String image;
    private int lprice;

    public ItemDto(JSONObject itemJson) {
        this.title = itemJson.getString("title");
        this.link = itemJson.getString("link");
        this.image = itemJson.getString("image");
        this.lprice = itemJson.getInt("lprice");
    }
}

 

 

response를 ItemDto로 바꾸기 위해선 다음 과정이 필요하다. 

1. 문자열 정보를 JSONObject로 바꾸기
2. JSONObject에서 items 배열 꺼내기
3. items 배열이 담긴 JSONArray의 원소를 하나씩 JSONObject로 받기
4. 받은 JSONObject로 ItemDto 생성 하기

JSONObject와 JSONArray를 처리하기 위해 https://mvnrepository.com/에서 JSON In Java 라이브러리를 gradle의 dependencies에 추가해야 한다. 

 

그 다음, NaverShopSearch에 fromJSONtoItems 함수를 추가한다. 

public List<ItemDto> fromJSONtoItems(String result) {
    JSONObject rjson = new JSONObject(result);
    JSONArray items  = rjson.getJSONArray("items");
    List<ItemDto> ret = new ArrayList<>();
    for (int i=0; i<items.length(); i++) {
        JSONObject itemJson = items.getJSONObject(i);
        ItemDto itemDto = new ItemDto(itemJson);
        ret.add(itemDto);
    }
    return ret;
}

 

 

 

💡 Search Request Controller

또또또또또 부족한 점이 있다.🤔 NaverShopSearch를 사용하기 위해 매우 매우 중요한 작업이 남았다. 프로젝트 요구 조건은 다음과 같다.

1. 사용자가 검색어를 입력하면 컨트롤러가 그것을 전달 받는다. 
2. 전달받은 검색어로 네이버 API에 요청하고, 그 결과를 사용자에게 응답한다. 

따라서 Controller가 NaverShopSearch를 사용할 수 있어야 한다. 사용자가 요청을 하면 NaverShopSearch 클래스를 자동으로 만들어 주면 정말 정말 좋을 텐데... 이게 스프링에서는 가능하다..! 스프링이 자동으로 필요한 클래스를 필요한 곳에 생성하도록 하려면 "목록"에 해당 클래스를 넣어주면 된다. 그 목록에 등록하는 간단한 방법이 바로 컴포넌트 등록이다. 

 

클래스 앞에 @Component를 붙여주기만 하면 된다. 

@Component // @RequiredArgsConstructor 와 함께 사용할 경우 스프링이 자동으로 생성
public class NaverShopSearch {

 

갑자기 든 의문,, 그럼 지금까지 썼던 서비스나 리포지토리는 어떻게 가져다 쓴거지,,? 분명 Controller에만 @RequiredArgsConstructor를 추가하고, 서비스나 리포지토리에는 컴포넌트 등록을 안 해줬는데,,라고 생각했던 내가 바보였다~~

https://namocom.tistory.com/421 글을 참고하자면, @Component의 구체화된 형태로 @Repository, @Service, @Controller가 있는 것이다. 

 

그렇다면 이제 남은 것은 사용자의 요청을 받을 Controller를 만드는 것이다. 검색 함수를 다 만들었기 때문에 GetMapping에서 사용만 하면되므로 간단하다. 

@RequiredArgsConstructor // final 로 선언된 클래스를 자동으로 생성
@RestController // JSON으로 응답함을 선언
public class SearchRequestController {

    private final NaverShopSearch naverShopSearch;

    @GetMapping("/api/search")
    public List<ItemDto> getItems(@RequestParam String query) {
        String resultString = naverShopSearch.search(query);
        return naverShopSearch.fromJSONtoItems(resultString);
    }
}

 

이로써 <나만의 셀렉샵>의 첫번째 요구 기능을 완성했다!!!

• 상품명에 따른 검색
• 관심 상품 등록 & 조회
• 관심 상품에 대한 최저가 등록하기

 

 

 

 

 

 

참고 자료: 스파르타코딩클럽 웹개발의 봄, Spring 4주차 강의자료