SpringBoot-011-RestTemplate

0. RestTemplate란?

- REST API client 입장에서 활용 할 수 있는 java library

- RestTemplate communicates HTTP server using RESTful principals. RestTemplate provides different methods to communicate that will accept URI template, URI variables, response type and request object as arguments. It uses HTTP methods such as GET, POST, HEAD, PUT, DELETE etc. It also handles HTTP connections.

(참고: https://www.concretepage.com/spring/spring-mvc/spring-rest-client-resttemplate-consume-restful-web-service-example-xml-json)

Spring REST Client with RestTemplate: Consume RESTful Web Service Example for XML and JSON

 

1. RestTemRestTemplate 실습

- 공공데이터 Open API를 이용하여 데이터를 가져오기 (https://www.data.go.kr/)

- 도로명주소 우편번호 조회서비스 API 이용 (문서에서 요청메시지/응답메시지 명세 참고)

 

1) GetZipCodeService.java

package com.zipcode.model;
 
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
 
@Data
@NoArgsConstructor
@AllArgsConstructor
public class GetZipCodeVo {
 
    private String ServiceKey;
    private String searchSe;
    private String srchwrd;
    private String countPerPage;
    private String currentPage;
    
}
 

2) GetZipCodeService.java

package com.zipcode.service;
 
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.nio.charset.Charset;
 
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Service;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.util.UriComponents;
import org.springframework.web.util.UriComponentsBuilder;
 
@Service
public class GetZipCodeService {
 
    public Object getZipCode(String searchSe, String srchwrd, String countPerPage, String currentPage) throws UnsupportedEncodingException{
        
        String url = "http://openapi.epost.go.kr/postal/retrieveNewAdressAreaCdService/retrieveNewAdressAreaCdService/getNewAddressListAreaCd";
        String serviceKey = "iXL2FwauXak7M7U6w8dPxaAEADZhBrlOsCNyroXSd14dkKaQqjcyeiPNMB1xnu1bsGIpaoHWd2cH93e7PzOL0g%3D%3D";
        
        // UnsupportedEncodingException 예외 처리를 해주지 않으면 여기에서 ERROR
        String decodeServiceKey = URLDecoder.decode(serviceKey, "UTF-8");
        
        RestTemplate restTemplate = new RestTemplate();
        HttpHeaders httpHeaders = new HttpHeaders();
        // Response Header to UTF-8
        httpHeaders.setContentType(new MediaType("application", "json", Charset.forName("UTF-8")));
        
        UriComponents uri = UriComponentsBuilder.fromHttpUrl(url).queryParam("serviceKey", decodeServiceKey)
                                                                 .queryParam("searchSe", searchSe)
                                                                 .queryParam("srchwrd", srchwrd)
                                                                 .queryParam("countPerPage", countPerPage)
                                                                 .queryParam("currentPage", currentPage)
                                                                 .build(false); // 자동 Encoding 막기
        
        //Object response = restTemplate.exchange(uri.toUriString(), HttpMethod.GET, new HttpEntity<String>(httpHeaders), String.class);
        Object response = restTemplate.getForObject(uri.toUriString(), String.class);
        
        return response;
        
    }
    
}
 

3) GetZipCodeController.java

package com.zipcode.controller;
 
import java.io.UnsupportedEncodingException;
 
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.spi.LoggerFactoryBinder;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
 
import com.zipcode.model.GetZipCodeVo;
import com.zipcode.service.GetZipCodeService;
 
@RestController
public class GetZipCodeController {
    
    private static final Logger logger = LoggerFactory.getLogger(GetZipCodeController.class);
    
    @Autowired
    GetZipCodeService getZipCodeService;
 
    @RequestMapping(path="/getZipCode", method=RequestMethod.GET)
    public Object getZipCode(@RequestBody GetZipCodeVo vo) throws UnsupportedEncodingException{
        
        String searchSe = vo.getSearchSe();
        String srchwrd = vo.getSearchSe();
        String countPerPage = vo.getCountPerPage();
        String currentPage = vo.getCurrentPage();
        // UnsupportedEncodingException 예외처리 해주지 않으면 여기에서 ERROR
        Object response = getZipCodeService.getZipCode(searchSe, srchwrd, countPerPage, currentPage);
        logger.info("##### RESULT: "+response);
        
        return response;
        
    } 
    
}
 

- 결과

요청

{
"searchSe": "dong",
"srchwrd": "개포동1205-1",
"countPerPage": "10",
"currentPage": "1"
}

응답

{"NewAddressListResponse":{"cmmMsgHeader":{"requestMsgId":"","responseMsgId":"","responseTime":"20190908:224951838","successYN":"Y","returnCode":"00","errMsg":"","totalCount":"","countPerPage":"","totalPage":"","currentPage":""}}}

 

아무리 끙끙대도 newAddressListAreaCd가 왜 안나오는지 모르겠다 =_=....

 

2. 더 자세히...

자세한 document.. 공홈보다 더 자세한듯

- https://attacomsian.com/blog/http-requests-resttemplate-spring-boot