• 기존의 RestTemplate을 발전시킨것
• 기존의 RestTemplate의 경우 모든 파라미터를 넣고 돌리는 Template패턴이었지만, 이번에 RestClient로 바뀌면서 흐르듯이 파라미터를 입력하는 fluent패턴으로 변경되었다. → 가독성이 좋아진다 (DSL 패턴, builder 패턴과도 유사하다.)

• 템플릿 패턴으로 Http 기능을 노출하는 것이 부담을 주는 것으로 알려져있다. 또한 WebClient같은 경우 reactive하고 web-flux라는 의존성을 필요로 한다. 이에 대안으로 나온 것이 RestClient이며 서블릿 버전의 WebClient와 같다

• 최신의 API를 제공하는 동기식 HTTP클라이언트이다. 자바 객체에서 HTTP요청으로 편리하게 변환하고 HTTP응답에서 객체를 생성할 수 있도록 HTTP 라이브러리에 대한 추상화를 제공한다.

• HTTP interface HTTP 서비스를 자바 인터페이스로 정의하고, HTTP 교환 메소드를 사용할 수 있는 기능을 제공한다. 그럼 이렇게 정의된 인터페이스를 구현하는 프록시를 생성할 수 있는데, 이 프록시가 실제로 HTTP 교환을 수행하게 된다.

• Spring 에서 제공하는 4가지 Rest endpoints

  • RestClient - synchronous client with a fluent API
  • WebClient - non-blocking, reactive client with fluent API
  • RestTemplate - synchronous client with template method API
  • HTTP interface - annotated interface with generated, dynamic proxy implementation

• RestClient 생성 - builder 방식을 추천

  • create() 메서드를 사용하는 방법

    • RestClient restClient = RestClient.create();

  • builder를 이용한 방법 - 굳이 빈으로 사용하지 않아도 된다.

    @Bean
    RestClient restClient(RestClient.Builder builder){
    	return builder
    		.requestFactory(new JdkClientHttpRequestFactory())
    		.messageConverters(converters->
    							converters.add(new MyCustomMessageConverter())).....
    

  • ⭐ Http 통신을 하기 위해서는 HttpClient 라는 인터페이스가 필요

    • 구현체는 WAS에서 구현해 놓은 것들이 있다.
      • jdk11 버전 이후 부터 jdk에서 제공→ JdkCientHttpRequestFactory
      • 톰켓에서 제공: HttpComponentsClientHttpRequestFactory
      • 제티에서 제공 : JettyClientHttpRequestFactory

  • MessageConverters → 어떤 형식으로 통신할 건지( Rest ful → json, xml → 파싱 결정이 필요)

• 웅답 객체

  • void
  • HttpHeaders
  • <T> → 저정한 클래스로 받을 수도 있다.
  • ResponsEntity<Void>
  • ResponseEntity<T>

• RestClient 사용하기

  restClient.get()
  	.uri("<https://example.com>")
  	.retrieve()
  	.body(String.class);
  

  • header 가 필요하면 header(string, string) 넣어주면 됨. header관련 메서드도 존재
  • get, post, put, delete 등 모두 지원
  • retrieve() 호출하면 응답 받음 → 위 uri를 호출해서 결과를 가져온다는 뜻이다.
  • body(String.class) → String형태로 받는다는 뜻
    • retrieve() 앞에 쓰인 경우 RequestBody에 넣어 보낸다는 뜻
    • retrieve() 뒤에 쓰인 경우 ResponseBody에 넣어서 받겠다는 뜻

  ResponseEntity<Void> response = restClient.post()
  	.uri("<https://petclinic.example.com/pets/new>")
  	.contentType(APPLICATION_JSON)
  	.body(pet)
  	.retrieve()
  	.toBodilessEntity();
  

  • void의 형식으로 보낼 시 위에처럼 보낸다.

String result = restClient.get()
	.uri("<https://example.com/this-url-does-not-exist>")
	.onStatus("HttpStatusCode::is4xxClientError,
					(request, response) ->
							{throw new MyCustomRuntimeException(response.getStatusCode(),
										response.getHeaders()) })
	.body(String.class);

• 에러처리는 위와같이 한다.
  • 해당 uri의 상태를 체크한 후 지정한 예외처리를 한 다음 아래의 body에서 볼 수 있듯 String으로 무슨 에러인지 ResponseBody에 담겨 볼 수 있다.

Pet result = restClient.get()
	.uri("<https://petclinic.example.com/pets/{id}>", id)
	.accept(APPLICATION_JSON)
	.exchange((request, response) -> {
			if (response.getStatusCode().is4xxClientError()) {
					throw new MyCustomRuntimeException(response.getStatusCode(),
					response.getHeaders());
			} else { Pet pet = convertResponse(response); return pet;} });

• 보통은 위와 같이 return 과 에러처리를 exchange()를 사용하여 한 번에 처리한다.

• @HttpExchange

  • HTTP Interface 에서 가져온 양식으로 쓴다.

  @HttpExchange("<https://example.com>") 
  interface RepositoryService {
  	@GetExchange("/repos/{owner}/{repo}"}
  	Repository get Repository(@PathVariable String owner,
  														 @PathVariable String repo);
  	
  

  • 위 예제처럼 인터페이스만 선언해 주면 위에 처럼 일일이 구현할 필요는 없다.
  • 어노테이션 옆 주소는 .url()에 적어주는 baseUrl이다.
  • @GetExchange → 바로 위위 코드의 get을 request하는 것을 대체할 수있다.
  • 이걸 사용하려면 Proxy를 미리 등록(Bean)해줘야 한다. →rest Client를 바로 가져다 쓰는 것이아닌 인터페이스를 보고 사용하는 방식이기 때문에 미리 만들어 줘야한다.
  • Proxy : 대리로 통신을 수행해 주는 것을 말한다.
  • 여러가지 도메인으로 요청하는 경우 각각을 @Bean으로 등록하여 사용한다.

  @Bean
  RepositoryService repositoryPoxy(RestClient.Builder builder){
  	RestClient restClient = builder.baseUrl("<https://api.github.com/>").build();
  	RestClientAdapter adapter = RestClientAdapter.create(restClient);
  	HttpServiceProxyFactory.builderFor(adapter).build();
  	
  	return factory.createClient(RepositoryService.class);
  }
  
  @Bean
  RepositoryService repositoryKakaoPoxy(RestClient.Builder builder){
  	RestClient restClient = builder.baseUrl("<https://api.kakao.com/>").build();
  	RestClientAdapter adapter = RestClientAdapter.create(restClient);
  	HttpServiceProxyFactory.builderFor(adapter).build();
  	
  	return factory.createClient(RepositoryService.class);
  }
  ...
  

  • 위와 같이 해당하는 도메인에 요청하는 것들을 빈으로 등록해놓고 사용할 수 있다.
  • @HttpExchange 어노테이션을 적은 것에 리턴 타입을 반드시 맞춰서 반환해줘야 한다.

• 예제

  https://velog.io/@gnivy303/Spring-boot-3.2에서-Rest-Clinet-와-HTTP-Interface-를-활용한-외부-API-호출

  • RestClient Config
    • 먼저 HTTP Interface를 사용하기 앞서 HTTP Interface를 호출하면 요청될 구현체 생성

  @Configuration
  public class RestClientConfig{
  
  	@Bean
  	public AnyComponent anyService() {
  		RestClient restClient = RestClient.builder().baseUrl("<http://anything.co.kr>")
  			.build();
  		RestClientAdapter adapter = RestClientAdapter.create(restClient);
  		HttpServiceProxyFactory factory = HttpServiceProxyFactory.builder(adapter)
  			.build();
  		
  		return factory.createClient(AnyComponent.class);
  	}
  }
  

  • RestClient restClient = RestClient.builder().baseUrl("http://anything.co.kr").build(); → RestClient객체 생성, 기본 URL설정, Http요청을 보내는 역할을 한다.

  • RestClientAdapter adapter = RestClientAdapter.create(restClient); → 이 Adapter는 RestClient의 기능을 확장하는 역할을 한다.

  • HttpServiceProxyFactory factory = HttpServiceProxyFactory.builder(adapter).build(); → HttpServiceProxyFactory객체를 생성한다. 이 Factory는 Http서비스의 프록시 객체 생성 역할

  • Http Interface

    • Http 인터페이스와 그 인터페이스의 교환 메서드에 적용할 수 있는 루트 어노테이션이다. 이 어노테이션이 인터페이스 레벨에 적용되면, 모든 교환 메서드에 적용된다.

  @Component
  @HttpExchange
  public interface AnyComponent {
  	
  	@GetExchange("/Search.aspx")
  	String findAllByQuery(@RequestParam String key, @RequestParam String value);
  }
  

  • @HttpExchange → 인터페이스와 . 그인터페이스의 교환 메서드에 적용할 수 있는 루트 어노테이션. 이 어노테이션이 인터페이스 레벨에 적용되면 , 모든 교환 메서드에 적용된다.
  • @GetExchange → Http GET requests 를 호출하기 위한 어노테이션이다

• 사용 예시

@Component
@RequiredArgsConstructor
public class ApiComponent {

private final AnyComponent anyComponent;

public ApiListResponse findListByKeyWordAndApi(){
	JSONObject json = new JSONObject(anyComponent.findAllByQuery("anyKey", "anyValue");
}

• 서비스 단에서 실제 Http interfacefmf 호출 → Http Interface를 작성한 AnyComponent를 의존성으로 주입받는다.
• anyComponent 에서 findAllByQuery를 호출하면 먼저 RestClientConfig에서 주입한 baseUrl http://anything.co.kr 가 앞으로 오게된다.
• 그 후 @GetExchange에 작성해둔 /Search.aspx가 추가되어 http://anything.co.kr/Search.aspx 형태로 변환