springboot restTemplate 使用说明

叁歲伎倆 2023-02-21 04:58 99阅读 0赞

springboot restTemplate 使用说明

#

***********************

相关类与接口

RestTemplate

  1. public class RestTemplate extends InterceptingHttpAccessor implements RestOperations {
  2.     private static final boolean romePresent;
  3.     private static final boolean jaxb2Present;
  4.     private static final boolean jackson2Present;
  5.     private static final boolean jackson2XmlPresent;
  6.     private static final boolean jackson2SmilePresent;
  7.     private static final boolean jackson2CborPresent;
  8.     private static final boolean gsonPresent;
  9.     private static final boolean jsonbPresent;
  10.     private final List<HttpMessageConverter<?>> messageConverters;
  11.     private ResponseErrorHandler errorHandler;
  12.     private UriTemplateHandler uriTemplateHandler;
  13.     private final ResponseExtractor<HttpHeaders> headersExtractor;
  16. ***********
  17. 构造方法
  19.     public RestTemplate() {
  20.         this.messageConverters = new ArrayList();
  21.         this.errorHandler = new DefaultResponseErrorHandler();
  22.         this.headersExtractor = new RestTemplate.HeadersExtractor();
  23.         this.messageConverters.add(new ByteArrayHttpMessageConverter());
  24.         this.messageConverters.add(new StringHttpMessageConverter());
  25.         this.messageConverters.add(new ResourceHttpMessageConverter(false));
  27.         try {
  28.             this.messageConverters.add(new SourceHttpMessageConverter());
  29.         } catch (Error var2) {
  30.         }
  32.         this.messageConverters.add(new AllEncompassingFormHttpMessageConverter());
  33.         if (romePresent) {
  34.             this.messageConverters.add(new AtomFeedHttpMessageConverter());
  35.             this.messageConverters.add(new RssChannelHttpMessageConverter());
  36.         }
  38.         if (jackson2XmlPresent) {
  39.             this.messageConverters.add(new MappingJackson2XmlHttpMessageConverter());
  40.         } else if (jaxb2Present) {
  41.             this.messageConverters.add(new Jaxb2RootElementHttpMessageConverter());
  42.         }
  44.         if (jackson2Present) {
  45.             this.messageConverters.add(new MappingJackson2HttpMessageConverter());
  46.         } else if (gsonPresent) {
  47.             this.messageConverters.add(new GsonHttpMessageConverter());
  48.         } else if (jsonbPresent) {
  49.             this.messageConverters.add(new JsonbHttpMessageConverter());
  50.         }
  52.         if (jackson2SmilePresent) {
  53.             this.messageConverters.add(new MappingJackson2SmileHttpMessageConverter());
  54.         }
  56.         if (jackson2CborPresent) {
  57.             this.messageConverters.add(new MappingJackson2CborHttpMessageConverter());
  58.         }
  60.         this.uriTemplateHandler = initUriTemplateHandler();
  61.     }
  63.     public RestTemplate(ClientHttpRequestFactory requestFactory) {
  64.         this();
  65.         this.setRequestFactory(requestFactory);
  66.     }
  68.     public RestTemplate(List<HttpMessageConverter<?>> messageConverters) {
  69.         this.messageConverters = new ArrayList();
  70.         this.errorHandler = new DefaultResponseErrorHandler();
  71.         this.headersExtractor = new RestTemplate.HeadersExtractor();
  72.         this.validateConverters(messageConverters);
  73.         this.messageConverters.addAll(messageConverters);
  74.         this.uriTemplateHandler = initUriTemplateHandler();
  75.     }
  78. ***********
  79. 普通方法
  81.     private static DefaultUriBuilderFactory initUriTemplateHandler() {
  82.         DefaultUriBuilderFactory uriFactory = new DefaultUriBuilderFactory();
  83.         uriFactory.setEncodingMode(EncodingMode.URI_COMPONENT);
  84.         return uriFactory;
  85.     }
  87.     public void setMessageConverters(List<HttpMessageConverter<?>> messageConverters) {
  88.     private void validateConverters(List<HttpMessageConverter<?>> messageConverters) {
  89.     public List<HttpMessageConverter<?>> getMessageConverters() {
  91.     public void setErrorHandler(ResponseErrorHandler errorHandler) {
  92.     public ResponseErrorHandler getErrorHandler() {
  94.     public void setDefaultUriVariables(Map<String, ?> uriVars) {
  96.     public void setUriTemplateHandler(UriTemplateHandler handler) {
  97.     public UriTemplateHandler getUriTemplateHandler() {
  101. ************
  102. get 方法
  104.     public <T> T getForObject(String url, Class<T> responseType, Object... uriVariables) throws RestClientException {
  105.     public <T> T getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException {
  106.     public <T> T getForObject(URI url, Class<T> responseType) throws RestClientException {
  108.     public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... uriVariables) throws RestClientException {
  109.     public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException {
  110.     public <T> ResponseEntity<T> getForEntity(URI url, Class<T> responseType) throws RestClientException {
  114. ************
  115. post 方法
  117.     public URI postForLocation(String url, @Nullable Object request, Object... uriVariables) throws RestClientException {
  118.     public URI postForLocation(String url, @Nullable Object request, Map<String, ?> uriVariables) throws RestClientException {
  119.     public URI postForLocation(URI url, @Nullable Object request) throws RestClientException {
  122.     public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Object... uriVariables) throws RestClientException {
  123.     public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException {
  124.     public <T> T postForObject(URI url, @Nullable Object request, Class<T> responseType) throws RestClientException {
  126.     public <T> ResponseEntity<T> postForEntity(String url, @Nullable Object request, Class<T> responseType, Object... uriVariables) throws RestClientException {
  127.     public <T> ResponseEntity<T> postForEntity(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException {
  128.     public <T> ResponseEntity<T> postForEntity(URI url, @Nullable Object request, Class<T> responseType) throws RestClientException {
  132. ************
  133. put 方法
  135.     public void put(String url, @Nullable Object request, Object... uriVariables) throws RestClientException {
  136.     public void put(String url, @Nullable Object request, Map<String, ?> uriVariables) throws RestClientException {
  137.     public void put(URI url, @Nullable Object request) throws RestClientException {
  141. ************
  142. delete 方法
  144.     public void delete(String url, Object... uriVariables) throws RestClientException {
  145.     public void delete(String url, Map<String, ?> uriVariables) throws RestClientException {
  146.     public void delete(URI url) throws RestClientException {
  150. ************
  151. head 方法
  153.     public HttpHeaders headForHeaders(String url, Object... uriVariables) throws RestClientException {
  154.     public HttpHeaders headForHeaders(String url, Map<String, ?> uriVariables) throws RestClientException {
  155.     public HttpHeaders headForHeaders(URI url) throws RestClientException {
  159. ************
  160. patch方法
  162.     public <T> T patchForObject(String url, @Nullable Object request, Class<T> responseType, Object... uriVariables) throws RestClientException {
  163.     public <T> T patchForObject(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException {
  164.     public <T> T patchForObject(URI url, @Nullable Object request, Class<T> responseType) throws RestClientException {
  168. ************
  169. options 方法
  171.     public Set<HttpMethod> optionsForAllow(String url, Object... uriVariables) throws RestClientException {
  172.     public Set<HttpMethod> optionsForAllow(String url, Map<String, ?> uriVariables) throws RestClientException {
  173.     public Set<HttpMethod> optionsForAllow(URI url) throws RestClientException {
  177. ************
  178. exchange 方法
  180.     public <T> ResponseEntity<T> exchange(String url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, Class<T> responseType, Object... uriVariables) throws RestClientException {
  181.     public <T> ResponseEntity<T> exchange(String url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException {
  182.     public <T> ResponseEntity<T> exchange(String url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, Object... uriVariables) throws RestClientException {
  183.     public <T> ResponseEntity<T> exchange(String url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, Map<String, ?> uriVariables) throws RestClientException {
  184.                                          //httpEntity自定义请求头，路径及参数可直接设置
  186.     public <T> ResponseEntity<T> exchange(URI url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, Class<T> responseType) throws RestClientException {
  187.     public <T> ResponseEntity<T> exchange(URI url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType) throws RestClientException {
  189.     public <T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, Class<T> responseType) throws RestClientException {
  190.     public <T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, ParameterizedTypeReference<T> responseType) throws RestClientException {
  192.     public <T> ResponseEntity<T> exchange(URI url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, Class<T> responseType) throws RestClientException {
  197. ************
  198. execute 方法
  200.     public <T> T execute(String url, HttpMethod method, @Nullable RequestCallback requestCallback, @Nullable ResponseExtractor<T> responseExtractor, Object... uriVariables) throws RestClientException {
  201.     public <T> T execute(String url, HttpMethod method, @Nullable RequestCallback requestCallback, @Nullable ResponseExtractor<T> responseExtractor, Map<String, ?> uriVariables) throws RestClientException {
  203.     public <T> T execute(URI url, HttpMethod method, @Nullable RequestCallback requestCallback, @Nullable ResponseExtractor<T> responseExtractor) throws RestClientException {
  207. ************
  208. 其他方法
  210.     protected <T> T doExecute(URI url, @Nullable HttpMethod method, @Nullable RequestCallback requestCallback, @Nullable ResponseExtractor<T> responseExtractor) throws RestClientException {
  212.     protected void handleResponse(URI url, HttpMethod method, ClientHttpResponse response) throws IOException {
  214.     public <T> RequestCallback acceptHeaderRequestCallback(Class<T> responseType) {
  215.     public <T> RequestCallback httpEntityCallback(@Nullable Object requestBody) {
  216.     public <T> RequestCallback httpEntityCallback(@Nullable Object requestBody, Type responseType) {
  218.     public <T> ResponseExtractor<ResponseEntity<T>> responseEntityExtractor(Type responseType) {
  219.     protected ResponseExtractor<HttpHeaders> headersExtractor() {
  221.     private static <T> T nonNull(@Nullable T result) {
  224.     static {
  225.         ClassLoader classLoader = RestTemplate.class.getClassLoader();
  226.         romePresent = ClassUtils.isPresent("com.rometools.rome.feed.WireFeed", classLoader);
  227.         jaxb2Present = ClassUtils.isPresent("javax.xml.bind.Binder", classLoader);
  228.         jackson2Present = ClassUtils.isPresent("com.fasterxml.jackson.databind.ObjectMapper", classLoader) && ClassUtils.isPresent("com.fasterxml.jackson.core.JsonGenerator", classLoader);
  229.         jackson2XmlPresent = ClassUtils.isPresent("com.fasterxml.jackson.dataformat.xml.XmlMapper", classLoader);
  230.         jackson2SmilePresent = ClassUtils.isPresent("com.fasterxml.jackson.dataformat.smile.SmileFactory", classLoader);
  231.         jackson2CborPresent = ClassUtils.isPresent("com.fasterxml.jackson.dataformat.cbor.CBORFactory", classLoader);
  232.         gsonPresent = ClassUtils.isPresent("com.google.gson.Gson", classLoader);
  233.         jsonbPresent = ClassUtils.isPresent("javax.json.bind.Jsonb", classLoader);
  234.     }
  238. **************
  239. 内部类：Resttemplate.HeadersExtractor
  241.     private static class HeadersExtractor implements ResponseExtractor<HttpHeaders> {
  242.         private HeadersExtractor() {
  243.         }
  245.         public HttpHeaders extractData(ClientHttpResponse response) {
  246.             return response.getHeaders();
  247.         }
  248.     }
  251. **************
  252. 内部类：Resttemplate.ResponseEntityResponseExtractor
  254.     private class ResponseEntityResponseExtractor<T> implements ResponseExtractor<ResponseEntity<T>> {
  255.         @Nullable
  256.         private final HttpMessageConverterExtractor<T> delegate;
  258.         public ResponseEntityResponseExtractor(@Nullable Type responseType) {
  261.         public ResponseEntity<T> extractData(ClientHttpResponse response) throws IOException {
  265. **************
  266. 内部类：Resttemplate.HttpEntityRequestCallback
  268.     private class HttpEntityRequestCallback extends RestTemplate.AcceptHeaderRequestCallback {
  269.         private final HttpEntity<?> requestEntity;
  271.         public HttpEntityRequestCallback(@Nullable Object requestBody) {
  274.         public HttpEntityRequestCallback(@Nullable Object requestBody, @Nullable Type responseType) {
  276.         public void doWithRequest(ClientHttpRequest httpRequest) throws IOException {
  277.         private void logBody(Object body, @Nullable MediaType mediaType, HttpMessageConverter<?> converter) {
  281. **************
  282. 内部类：Resttemplate.AcceptHeaderRequestCallback
  284.     private class AcceptHeaderRequestCallback implements RequestCallback {
  285.         @Nullable
  286.         private final Type responseType;
  288.         public AcceptHeaderRequestCallback(@Nullable Type responseType) {
  291.         public void doWithRequest(ClientHttpRequest request) throws IOException {
  292.         private boolean canReadResponse(Type responseType, HttpMessageConverter<?> converter) {
  293.         private Stream<MediaType> getSupportedMediaTypes(HttpMessageConverter<?> messageConverter) {

RestOperations

  1. public interface RestOperations {
  4. ***********
  5. get 方法
  7.     <T> T getForObject(String var1, Class<T> var2, Object... var3) throws RestClientException;
  8.     <T> T getForObject(String var1, Class<T> var2, Map<String, ?> var3) throws RestClientException;
  9.     <T> T getForObject(URI var1, Class<T> var2) throws RestClientException;
  11.     <T> ResponseEntity<T> getForEntity(String var1, Class<T> var2, Object... var3) throws RestClientException;
  12.     <T> ResponseEntity<T> getForEntity(String var1, Class<T> var2, Map<String, ?> var3) throws RestClientException;
  13.     <T> ResponseEntity<T> getForEntity(URI var1, Class<T> var2) throws RestClientException;
  17. ***********
  18. post 方法
  20.     URI postForLocation(String var1, @Nullable Object var2, Object... var3) throws RestClientException;
  21.     URI postForLocation(String var1, @Nullable Object var2, Map<String, ?> var3) throws RestClientException;
  22.     URI postForLocation(URI var1, @Nullable Object var2) throws RestClientException;
  24.     <T> T postForObject(String var1, @Nullable Object var2, Class<T> var3, Object... var4) throws RestClientException;
  25.     <T> T postForObject(String var1, @Nullable Object var2, Class<T> var3, Map<String, ?> var4) throws RestClientException;
  26.     <T> T postForObject(URI var1, @Nullable Object var2, Class<T> var3) throws RestClientException;
  28.     <T> ResponseEntity<T> postForEntity(String var1, @Nullable Object var2, Class<T> var3, Object... var4) throws RestClientException;
  29.     <T> ResponseEntity<T> postForEntity(String var1, @Nullable Object var2, Class<T> var3, Map<String, ?> var4) throws RestClientException;
  30.     <T> ResponseEntity<T> postForEntity(URI var1, @Nullable Object var2, Class<T> var3) throws RestClientException;
  34. ***********
  35. put 方法
  37.     void put(String var1, @Nullable Object var2, Object... var3) throws RestClientException;
  38.     void put(String var1, @Nullable Object var2, Map<String, ?> var3) throws RestClientException;
  39.     void put(URI var1, @Nullable Object var2) throws RestClientException;
  43. ***********
  44. delete 方法
  46.     void delete(String var1, Object... var2) throws RestClientException;
  47.     void delete(String var1, Map<String, ?> var2) throws RestClientException;
  48.     void delete(URI var1) throws RestClientException;
  52. ***********
  53. head方法
  55.     HttpHeaders headForHeaders(String var1, Object... var2) throws RestClientException;
  56.     HttpHeaders headForHeaders(String var1, Map<String, ?> var2) throws RestClientException;
  57.     HttpHeaders headForHeaders(URI var1) throws RestClientException;
  61. ***********
  62. patch 方法
  64.     <T> T patchForObject(String var1, @Nullable Object var2, Class<T> var3, Object... var4) throws RestClientException;
  65.     <T> T patchForObject(String var1, @Nullable Object var2, Class<T> var3, Map<String, ?> var4) throws RestClientException;
  66.     <T> T patchForObject(URI var1, @Nullable Object var2, Class<T> var3) throws RestClientException;
  70. ***********
  71. options 方法
  73.     Set<HttpMethod> optionsForAllow(String var1, Object... var2) throws RestClientException;
  74.     Set<HttpMethod> optionsForAllow(String var1, Map<String, ?> var2) throws RestClientException;
  75.     Set<HttpMethod> optionsForAllow(URI var1) throws RestClientException;
  79. ***********
  80. exchange 方法
  82.     <T> ResponseEntity<T> exchange(String var1, HttpMethod var2, @Nullable HttpEntity<?> var3, Class<T> var4, Object... var5) throws RestClientException;
  83.     <T> ResponseEntity<T> exchange(String var1, HttpMethod var2, @Nullable HttpEntity<?> var3, Class<T> var4, Map<String, ?> var5) throws RestClientException;
  84.     <T> ResponseEntity<T> exchange(String var1, HttpMethod var2, @Nullable HttpEntity<?> var3, ParameterizedTypeReference<T> var4, Object... var5) throws RestClientException;
  85.     <T> ResponseEntity<T> exchange(String var1, HttpMethod var2, @Nullable HttpEntity<?> var3, ParameterizedTypeReference<T> var4, Map<String, ?> var5) throws RestClientException;
  87.     <T> ResponseEntity<T> exchange(URI var1, HttpMethod var2, @Nullable HttpEntity<?> var3, Class<T> var4) throws RestClientException;
  88.     <T> ResponseEntity<T> exchange(URI var1, HttpMethod var2, @Nullable HttpEntity<?> var3, ParameterizedTypeReference<T> var4) throws RestClientException;
  90.     <T> ResponseEntity<T> exchange(RequestEntity<?> var1, Class<T> var2) throws RestClientException;
  91.     <T> ResponseEntity<T> exchange(RequestEntity<?> var1, ParameterizedTypeReference<T> var2) throws RestClientException;
  95. ***********
  96. execute 方法
  98.     <T> T execute(String var1, HttpMethod var2, @Nullable RequestCallback var3, @Nullable ResponseExtractor<T> var4, Object... var5) throws RestClientException;
  99.     <T> T execute(String var1, HttpMethod var2, @Nullable RequestCallback var3, @Nullable ResponseExtractor<T> var4, Map<String, ?> var5) throws RestClientException;
  101.     <T> T execute(URI var1, HttpMethod var2, @Nullable RequestCallback var3, @Nullable ResponseExtractor<T> var4) throws RestClientException;

InterceptingHttpAccessor：拦截器设置

  1. public abstract class InterceptingHttpAccessor extends HttpAccessor {
  2.     private final List<ClientHttpRequestInterceptor> interceptors = new ArrayList();
  3.     @Nullable
  4.     private volatile ClientHttpRequestFactory interceptingRequestFactory;
  6.     public InterceptingHttpAccessor() {
  7.     }
  9.     public void setInterceptors(List<ClientHttpRequestInterceptor> interceptors) {
  10.     public List<ClientHttpRequestInterceptor> getInterceptors() {
  12.     public void setRequestFactory(ClientHttpRequestFactory requestFactory) {
  13.     public ClientHttpRequestFactory getRequestFactory() {

HttpAccessor

  1. public abstract class HttpAccessor {
  2.     protected final Log logger = HttpLogging.forLogName(this.getClass());
  3.     private ClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();
  4.     private final List<ClientHttpRequestInitializer> clientHttpRequestInitializers = new ArrayList();
  6.     public HttpAccessor() {
  7.     }
  9.     public void setRequestFactory(ClientHttpRequestFactory requestFactory) {
  10.         Assert.notNull(requestFactory, "ClientHttpRequestFactory must not be null");
  11.         this.requestFactory = requestFactory;
  12.     }
  14.     public ClientHttpRequestFactory getRequestFactory() {
  15.         return this.requestFactory;
  16.     }
  18.     public void setClientHttpRequestInitializers(List<ClientHttpRequestInitializer> clientHttpRequestInitializers) {
  19.         if (this.clientHttpRequestInitializers != clientHttpRequestInitializers) {
  20.             this.clientHttpRequestInitializers.clear();
  21.             this.clientHttpRequestInitializers.addAll(clientHttpRequestInitializers);
  22.             AnnotationAwareOrderComparator.sort(this.clientHttpRequestInitializers);
  23.         }
  25.     }
  27.     public List<ClientHttpRequestInitializer> getClientHttpRequestInitializers() {
  28.         return this.clientHttpRequestInitializers;
  29.     }
  31.     protected ClientHttpRequest createRequest(URI url, HttpMethod method) throws IOException {
  32.         ClientHttpRequest request = this.getRequestFactory().createRequest(url, method);
  33.         this.initialize(request);
  34.         if (this.logger.isDebugEnabled()) {
  35.             this.logger.debug("HTTP " + method.name() + " " + url);
  36.         }
  38.         return request;
  39.     }
  41.     private void initialize(ClientHttpRequest request) {
  42.         this.clientHttpRequestInitializers.forEach((initializer) -> {
  43.             initializer.initialize(request);
  44.         });
  45.     }
  46. }

ClientHttpRequestInterceptor：拦截器接口

  1. @FunctionalInterface
  2. public interface ClientHttpRequestInterceptor {
  3.     ClientHttpResponse intercept(HttpRequest var1, byte[] var2, ClientHttpRequestExecution var3) throws IOException;
  4. }

ClientHttpRequestExecution：拦截器执行接口

  1. @FunctionalInterface
  2. public interface ClientHttpRequestExecution {
  3.     ClientHttpResponse execute(HttpRequest var1, byte[] var2) throws IOException;
  4. }

RequestEntity

  1. public class RequestEntity<T> extends HttpEntity<T> {
  2.     @Nullable
  3.     private final HttpMethod method;
  4.     private final URI url;
  5.     @Nullable
  6.     private final Type type;
  10. *************
  11. 构造方法
  13.     public RequestEntity(HttpMethod method, URI url) {
  14.     public RequestEntity(@Nullable T body, HttpMethod method, URI url) {
  15.     public RequestEntity(@Nullable T body, HttpMethod method, URI url, Type type) {
  17.     public RequestEntity(MultiValueMap<String, String> headers, HttpMethod method, URI url) {
  18.     public RequestEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers, @Nullable HttpMethod method, URI url) {
  19.     public RequestEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers, @Nullable HttpMethod method, URI url, @Nullable Type type) {
  23. *************
  24. 普通方法
  26.     public static RequestEntity.BodyBuilder method(HttpMethod method, URI url) {
  27.     public static RequestEntity.BodyBuilder post(URI url) {
  28.     public static RequestEntity.BodyBuilder put(URI url) {
  29.     public static RequestEntity.BodyBuilder patch(URI url) {
  32.     public static RequestEntity.HeadersBuilder<?> get(URI url) {
  33.     public static RequestEntity.HeadersBuilder<?> head(URI url) {
  34.     public static RequestEntity.HeadersBuilder<?> delete(URI url) {
  35.     public static RequestEntity.HeadersBuilder<?> options(URI url) {
  37.     public HttpMethod getMethod() {
  38.     public URI getUrl() {
  39.     public Type getType() {
  41.     public boolean equals(@Nullable Object other) {
  42.     public int hashCode() {
  43.     public String toString() {
  47. *************
  48. 内部类：RequestEntity.DefaultBodyBuilder
  50.     private static class DefaultBodyBuilder implements RequestEntity.BodyBuilder {
  51.         private final HttpMethod method;
  52.         private final URI url;
  53.         private final HttpHeaders headers = new HttpHeaders();
  55.         public DefaultBodyBuilder(HttpMethod method, URI url) {
  58.         public RequestEntity.BodyBuilder header(String headerName, String... headerValues) {
  59.         public RequestEntity.BodyBuilder headers(@Nullable HttpHeaders headers) {
  60.         public RequestEntity.BodyBuilder headers(Consumer<HttpHeaders> headersConsumer) {
  62.         public <T> RequestEntity<T> body(T body) {
  63.         public <T> RequestEntity<T> body(T body, Type type) {
  65.         public RequestEntity.BodyBuilder accept(MediaType... acceptableMediaTypes) {
  66.         public RequestEntity.BodyBuilder acceptCharset(Charset... acceptableCharsets) {
  68.         public RequestEntity.BodyBuilder contentLength(long contentLength) {
  69.         public RequestEntity.BodyBuilder contentType(MediaType contentType) {
  71.         public RequestEntity.BodyBuilder ifModifiedSince(ZonedDateTime ifModifiedSince) {
  72.         public RequestEntity.BodyBuilder ifModifiedSince(Instant ifModifiedSince) {
  73.         public RequestEntity.BodyBuilder ifModifiedSince(long ifModifiedSince) {
  75.         public RequestEntity.BodyBuilder ifNoneMatch(String... ifNoneMatches) {
  77.         public RequestEntity<Void> build() {
  81. *************
  82. 内部接口：RequestEntity.BodyBuilder
  84.     public interface BodyBuilder extends RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder> {
  85.         RequestEntity.BodyBuilder contentLength(long var1);
  86.         RequestEntity.BodyBuilder contentType(MediaType var1);
  88.         <T> RequestEntity<T> body(T var1);
  89.         <T> RequestEntity<T> body(T var1, Type var2);
  93. *************
  94. 内部接口：RequestEntity.HeadersBuilder
  96.     public interface HeadersBuilder<B extends RequestEntity.HeadersBuilder<B>> {
  98.         B header(String var1, String... var2);
  99.         B headers(@Nullable HttpHeaders var1);
  100.         B headers(Consumer<HttpHeaders> var1);
  102.         B accept(MediaType... var1);
  103.         B acceptCharset(Charset... var1);
  105.         B ifModifiedSince(ZonedDateTime var1);
  106.         B ifModifiedSince(Instant var1);
  107.         B ifModifiedSince(long var1);
  108.         B ifNoneMatch(String... var1);
  110.         RequestEntity<Void> build();

ResponseEntity

  1. public class ResponseEntity<T> extends HttpEntity<T> {
  2.     private final Object status;
  5. **********
  6. 构造方法
  8.     public ResponseEntity(HttpStatus status) {
  9.     public ResponseEntity(@Nullable T body, HttpStatus status) {
  11.     public ResponseEntity(MultiValueMap<String, String> headers, HttpStatus status) {
  12.     public ResponseEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers, HttpStatus status) {
  13.     private ResponseEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers, Object status) {
  17. **********
  18. 普通方法
  20.     public HttpStatus getStatusCode() {
  21.     public int getStatusCodeValue() {
  23.     public boolean equals(@Nullable Object other) {
  24.     public int hashCode() {
  25.     public String toString() {
  27.     public static ResponseEntity.BodyBuilder status(HttpStatus status) {
  28.     public static ResponseEntity.BodyBuilder status(int status) {
  29.         return new ResponseEntity.DefaultBuilder(status);
  30.     }
  32.     public static ResponseEntity.BodyBuilder ok() {
  33.     public static <T> ResponseEntity<T> ok(T body) {
  34.     public static <T> ResponseEntity<T> of(Optional<T> body) {
  36.     public static ResponseEntity.BodyBuilder created(URI location) {
  37.     public static ResponseEntity.BodyBuilder accepted() {
  38.     public static ResponseEntity.BodyBuilder badRequest() {
  39.     public static ResponseEntity.BodyBuilder unprocessableEntity() {
  41.     public static ResponseEntity.HeadersBuilder<?> noContent() {
  42.     public static ResponseEntity.HeadersBuilder<?> notFound() {
  46. **********
  47. 内部类：ResponseEntity.DefaultBuilder
  49.     private static class DefaultBuilder implements ResponseEntity.BodyBuilder {
  50.         private final Object statusCode;
  51.         private final HttpHeaders headers = new HttpHeaders();
  53.         public DefaultBuilder(Object statusCode) {
  54.             this.statusCode = statusCode;
  55.         }
  57.         public ResponseEntity.BodyBuilder header(String headerName, String... headerValues) {
  58.         public ResponseEntity.BodyBuilder headers(Consumer<HttpHeaders> headersConsumer) {
  60.         public <T> ResponseEntity<T> body(@Nullable T body) {
  62.         public ResponseEntity.BodyBuilder contentLength(long contentLength) {
  63.         public ResponseEntity.BodyBuilder contentType(MediaType contentType) {
  65.         public ResponseEntity.BodyBuilder lastModified(ZonedDateTime date) {
  66.         public ResponseEntity.BodyBuilder lastModified(Instant date) {
  67.         public ResponseEntity.BodyBuilder lastModified(long date) {
  69.         public ResponseEntity.BodyBuilder location(URI location) {
  70.         public ResponseEntity.BodyBuilder allow(HttpMethod... allowedMethods) {
  71.         public ResponseEntity.BodyBuilder cacheControl(CacheControl cacheControl) {
  72.         public ResponseEntity.BodyBuilder varyBy(String... requestHeaders) {
  73.         public ResponseEntity.BodyBuilder eTag(String etag) {
  75.         public <T> ResponseEntity<T> build() {
  79. **********
  80. 内部类：ResponseEntity.BodyBuilder
  82.     public interface BodyBuilder extends ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder> {
  84.         ResponseEntity.BodyBuilder contentLength(long var1);
  85.         ResponseEntity.BodyBuilder contentType(MediaType var1);
  87.         <T> ResponseEntity<T> body(@Nullable T var1);
  91. **********
  92. 内部类：ResponseEntity.HeadersBuilder
  94.     public interface HeadersBuilder<B extends ResponseEntity.HeadersBuilder<B>> {
  96.         B header(String var1, String... var2);
  97.         B headers(@Nullable HttpHeaders var1);
  98.         B headers(Consumer<HttpHeaders> var1);
  100.         B lastModified(ZonedDateTime var1);
  101.         B lastModified(Instant var1);
  102.         B lastModified(long var1);
  104.         B location(URI var1);
  105.         B allow(HttpMethod... var1);
  106.         B cacheControl(CacheControl var1);
  107.         B varyBy(String... var1);
  108.         B eTag(String var1);
  110.         <T> ResponseEntity<T> build();

HttpEntity

  1. public class HttpEntity<T> {
  2.     public static final HttpEntity<?> EMPTY = new HttpEntity();
  3.     private final HttpHeaders headers;
  4.     @Nullable
  5.     private final T body;
  9. ************
  10. 构造方法
  12.     protected HttpEntity() {
  13.     public HttpEntity(T body) {
  15.     public HttpEntity(MultiValueMap<String, String> headers) {
  16.     public HttpEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers) {
  20. ************
  21. 普通方法
  23.     public HttpHeaders getHeaders() {
  25.     public T getBody() {
  26.     public boolean hasBody() {
  28.     public boolean equals(@Nullable Object other) {
  29.     public int hashCode() {
  30.     public String toString() {

ResponseErrorHander：响应异常处理

  1. public interface ResponseErrorHandler {
  2.     boolean hasError(ClientHttpResponse var1) throws IOException;
  4.     void handleError(ClientHttpResponse var1) throws IOException;
  6.     default void handleError(URI url, HttpMethod method, ClientHttpResponse response) throws IOException {
  7.         this.handleError(response);
  8.     }
  9. }

DefaultResponseErrorHandler

  1. public class DefaultResponseErrorHandler implements ResponseErrorHandler {
  2.     public DefaultResponseErrorHandler() {
  3.     }
  5.     public boolean hasError(ClientHttpResponse response) throws IOException {
  7.     protected boolean hasError(HttpStatus statusCode) {
  8.     protected boolean hasError(int unknownStatusCode) {
  11.     public void handleError(ClientHttpResponse response) throws IOException {
  12.         HttpStatus statusCode = HttpStatus.resolve(response.getRawStatusCode());
  13.         if (statusCode == null) {
  14.             byte[] body = this.getResponseBody(response);
  15.             String message = this.getErrorMessage(response.getRawStatusCode(), response.getStatusText(), body, this.getCharset(response));
  16.             throw new UnknownHttpStatusCodeException(message, response.getRawStatusCode(), response.getStatusText(), response.getHeaders(), body, this.getCharset(response));
  17.         } else {
  18.             this.handleError(response, statusCode);
  19.         }
  20.     }
  22.     private String getErrorMessage(int rawStatusCode, String statusText, @Nullable byte[] responseBody, @Nullable Charset charset) {
  23.     protected void handleError(ClientHttpResponse response, HttpStatus statusCode) throws IOException {
  25.     protected byte[] getResponseBody(ClientHttpResponse response) {
  26.     protected Charset getCharset(ClientHttpResponse response) {

ResponseExtrator

  1. @FunctionalInterface
  2. public interface ResponseExtractor<T> {
  3.     @Nullable
  4.     T extractData(ClientHttpResponse var1) throws IOException;
  5. }

RestTemplate.HeadersExtrator

  1. public class RestTemplate extends InterceptingHttpAccessor implements RestOperations {
  4. ***********
  5. 内部类：RestTemplate.HeadersExtrator
  7.     private static class HeadersExtractor implements ResponseExtractor<HttpHeaders> {
  8.         private HeadersExtractor() {
  9.         }
  11.         public HttpHeaders extractData(ClientHttpResponse response) {
  12.             return response.getHeaders();
  13.         }
  14.     }

发表评论

表情：
评论列表 （有 0 条评论，99人围观）

还没有评论，来说两句吧...

相关阅读