Spring之RestTemplate详解
- 1 RestTemplate
- 1.1 引言
- 1.2 环境配置
- 1.2.1 非Spring环境下使用RestTemplate
- 1.2.2 Spring环境下使用 RestTemplate
- 1.2.3 Spring环境下增加线程号
- 1.3 API 实践
- 1.3.1 GET请求
- 1.3.1.1 不带参请求
- 1.3.1.2 带参的get请求(使用占位符号传参)
- 1.3.1.3 带参的get请求(restful风格)
- 1.3.1.4 getForEntity使用示例
- 1.3.1.5 header设置参数
- 1.3.2 POST请求
- 1.3.2.1 模拟表单请求
- 1.3.2.2 模拟表单请求(传递对象)
- 1.3.2.3 模拟JSON请求
- 1.3.2.4 模拟页面重定向
- 1.3.3 PUT请求
- 1.3.4 DELETE请求
- 1.3.5 通用请求方法exchange方法
- 1.3.6 文件上传与下载
- 1.3.6.1 文件上传
- 1.3.6.2 文件下载
- 1.3.6.3 大文件下载
- 1.3.7 通过服务名调用
- 1.3.7.1 简介
- 1.3.7.2 @LoadBalanced作用
- 1.4 核心讲解
- 1.4.1 excute
- 1.4.2 RequestCallback
- 1.4.3 ResponseExtractor
1 RestTemplate
1.1 引言
现如今的 IT 项目,由服务端向外发起网络请求的场景,基本上处处可见!
传统情况下,在服务端代码里访问 http 服务时,一般会使用 JDK 的 HttpURLConnection 或者 Apache 的 HttpClient,不过这种方法使用起来太过繁琐,而且 api 使用起来非常的复杂,还得操心资源回收。
以下载文件为例,通过 Apache 的 HttpClient方式进行下载文件,会很复杂
其实Spring已经为我们提供了一种简单便捷的模板类来进行操作,它就是RestTemplate
RestTemplate是一个执行HTTP请求的同步阻塞式工具类,它仅仅只是在 HTTP 客户端库(例如 JDK HttpURLConnection,Apache HttpComponents,okHttp 等)基础上,封装了更加简单易用的模板方法 API,方便程序员利用已提供的模板方法发起网络请求和处理,能很大程度上提升我们的开发效率
1.2 环境配置
1.2.1 非Spring环境下使用RestTemplate
如果当前项目不是Spring项目,加入spring-web包,即可引入RestTemplate类
<dependency><groupId>org.springframework</groupId><artifactId>spring-web</artifactId><version>5.2.6.RELEASE</version>
</dependency>
编写一个单元测试类,使用RestTemplate发送一个GET请求,看看程序运行是否正常
@Test
public void simpleTest() {RestTemplate restTemplate = new RestTemplate();String url = "http://jsonplaceholder.typicode.com/posts/1";String str = restTemplate.getForObject(url, String.class);System.out.println(str);
}
1.2.2 Spring环境下使用 RestTemplate
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId>
</dependency>
同时,将RestTemplate配置初始化为一个Bean
@Configuration
public class RestTemplateConfig {/*** 没有实例化RestTemplate时,初始化RestTemplate* @return*/@ConditionalOnMissingBean(RestTemplate.class)@Beanpublic RestTemplate restTemplate(){RestTemplate restTemplate = new RestTemplate();return restTemplate;}
}
注意,这种初始化方法,是使用了JDK自带的HttpURLConnection作为底层HTTP客户端实现。
当然,我们还可以修改RestTemplate默认的客户端,例如将其改成HttpClient客户端,方式如下:
@Configuration
public class RestTemplateConfig {@ConditionalOnMissingBean(RestTemplate.class)@Beanpublic RestTemplate restTemplate(){RestTemplate restTemplate = new RestTemplate(getClientHttpRequestFactory());return restTemplate;}/*** 使用HttpClient作为底层客户端* @return*/private ClientHttpRequestFactory getClientHttpRequestFactory() {int timeout = 5000;RequestConfig config = RequestConfig.custom().setConnectTimeout(timeout).setConnectionRequestTimeout(timeout).setSocketTimeout(timeout).build();CloseableHttpClient client = HttpClientBuilder.create().setDefaultRequestConfig(config).build();return new HttpComponentsClientHttpRequestFactory(client);}}
在需要使用RestTemplate的位置,注入并使用即可!
@Autowired
private RestTemplate restTemplate;
从开发人员的反馈,和网上的各种HTTP客户端性能以及易用程度评测来看,OkHttp 优于 Apache的HttpClient、Apache的HttpClient优于HttpURLConnection。
因此,我们还可以通过如下方式,将底层的http客户端换成OkHttp
/*** 使用OkHttpClient作为底层客户端* @return*/
private ClientHttpRequestFactory getClientHttpRequestFactory(){OkHttpClient okHttpClient = new OkHttpClient.Builder().connectTimeout(5, TimeUnit.SECONDS).writeTimeout(5, TimeUnit.SECONDS).readTimeout(5, TimeUnit.SECONDS).build();return new OkHttp3ClientHttpRequestFactory(okHttpClient);
}
1.2.3 Spring环境下增加线程号
使用RestTemplate调用远程接口时,有时需要在header中传递信息,比如:traceId,source等,便于在查询日志时能够串联一次完整的请求链路,快速定位问题。这种业务场景就能通过ClientHttpRequestInterceptor接口实现,具体做法如下
第一步,定义一个LogFilter拦截所有接口请求,在MDC中设置traceId:
public class LogFilter implements Filter {@Overridepublic void init(FilterConfig filterConfig) throws ServletException {}@Overridepublic void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {MDC.put("TRACE_ID",UUID.randomUUID().toString());System.out.println("记录请求日志");chain.doFilter(request, response);System.out.println("记录响应日志");}@Overridepublic void destroy() {}
}
第二步,实现ClientHttpRequestInterceptor接口,MDC中获取当前请求的traceId,然后设置到header中
public class RestTemplateInterceptor implements ClientHttpRequestInterceptor {@Overridepublic ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {request.getHeaders().set("traceId", MDC.get("TRACE_ID"));ClientHttpResponse response = execution.execute(request, body);return response;}
}
第三步,定义配置类,配置上面定义的RestTemplateInterceptor类:
@Configuration
public class RestTemplateConfiguration {@Beanpublic RestTemplate restTemplate() {RestTemplate restTemplate = new RestTemplate();restTemplate.setInterceptors(Collections.singletonList(restTemplateInterceptor()));return restTemplate;}@Beanpublic RestTemplateInterceptor restTemplateInterceptor() {return new RestTemplateInterceptor();}
}
能使用MDC保存traceId等参数的根本原因是,用户请求到应用服务器,Tomcat会从线程池中分配一个线程去处理该请求。那么该请求的整个过程中,保存到MDC的ThreadLocal中的参数,也是该线程独享的,所以不会有线程安全问题
1.3 API 实践
RestTemplate最大的特色就是对各种网络请求方式做了包装,能极大的简化开发人员的工作量,下面我们以GET、POST、PUT、DELETE、文件上传与下载为例,分别介绍各个API的使用方式
1.3.1 GET请求
通过RestTemplate发送HTTP GET协议请求,经常使用到的方法有两个:
getForObject():返回值是HTTP协议的响应体
getForEntity():返回的是ResponseEntity,ResponseEntity是对HTTP响应的封装,除了包含响应体,还包含HTTP状态码、contentType、contentLength、Header等信息
在Spring Boot环境下写一个单元测试用例,首先创建一个Api接口,然后编写单元测试进行服务测试。
1.3.1.1 不带参请求
不带参的get请求
@RestController
public class TestController {/*** 不带参的get请求* @return*/@RequestMapping(value = "testGet", method = RequestMethod.GET)public ResponseBean testGet(){ResponseBean result = new ResponseBean();result.setCode("200");result.setMsg("请求成功,方法:testGet");return result;}
}
public class ResponseBean {private String code;private String msg;省去getset方法
}
@Autowired
private RestTemplate restTemplate;
/*** 单元测试(不带参的get请求)*/
@Test
public void testGet(){//请求地址String url = "http://localhost:8080/testGet";//发起请求,直接返回对象ResponseBean responseBean = restTemplate.getForObject(url, ResponseBean.class);System.out.println(responseBean.toString());
}
1.3.1.2 带参的get请求(使用占位符号传参)
@RestController
public class TestController {/*** 带参的get请求(restful风格)* @return*/@RequestMapping(value = "testGetByRestFul/{id}/{name}", method = RequestMethod.GET)public ResponseBean testGetByRestFul(@PathVariable(value = "id") String id, @PathVariable(value = "name") String name){ResponseBean result = new ResponseBean();result.setCode("200");result.setMsg("请求成功,方法:testGetByRestFul,请求参数id:" + id + "请求参数name:" + name);return result;}
}
@Autowired
private RestTemplate restTemplate;/*** 单元测试(带参的get请求)*/
@Test
public void testGetByRestFul(){//请求地址String url = "http://localhost:8080/testGetByRestFul/{1}/{2}";//发起请求,直接返回对象(restful风格)ResponseBean responseBean = restTemplate.getForObject(url, ResponseBean.class, "001", "张三");System.out.println(responseBean.toString());
}
1.3.1.3 带参的get请求(restful风格)
@RestController
public class TestController {/*** 带参的get请求(使用占位符号传参)* @return*/@RequestMapping(value = "testGetByParam", method = RequestMethod.GET)public ResponseBean testGetByParam(@RequestParam("userName") String userName,@RequestParam("userPwd") String userPwd){ResponseBean result = new ResponseBean();result.setCode("200");result.setMsg("请求成功,方法:testGetByParam,请求参数userName:" + userName + ",userPwd:" + userPwd);return result;}
}
@Autowired
private RestTemplate restTemplate;/*** 单元测试(带参的get请求)*/
@Test
public void testGetByParam(){//请求地址String url = "http://localhost:8080/testGetByParam?userName={userName}&userPwd={userPwd}";//请求参数Map<String, String> uriVariables = new HashMap<>();uriVariables.put("userName", "唐三藏");uriVariables.put("userPwd", "123456");//发起请求,直接返回对象(带参数请求)ResponseBean responseBean = restTemplate.getForObject(url, ResponseBean.class, uriVariables);System.out.println(responseBean.toString());
}
1.3.1.4 getForEntity使用示例
上面的所有的getForObject请求传参方法,getForEntity都可以使用,使用方法上也几乎是一致的,只是在返回结果接收的时候略有差别。
使用ResponseEntity responseEntity来接收响应结果。用responseEntity.getBody()获取响应体。
/*** 单元测试*/
@Test
public void testAllGet(){//请求地址String url = "http://localhost:8080/testGet";//发起请求,返回全部信息ResponseEntity<ResponseBean> response = restTemplate.getForEntity(url, ResponseBean.class);// 获取响应体System.out.println("HTTP 响应body:" + response.getBody().toString());// 以下是getForEntity比getForObject多出来的内容HttpStatus statusCode = response.getStatusCode();int statusCodeValue = response.getStatusCodeValue();HttpHeaders headers = response.getHeaders();System.out.println("HTTP 响应状态:" + statusCode);System.out.println("HTTP 响应状态码:" + statusCodeValue);System.out.println("HTTP Headers信息:" + headers);
}
1.3.1.5 header设置参数
//请求头
HttpHeaders headers = new HttpHeaders();
headers.add("token", "123456789");//封装请求头
HttpEntity<MultiValueMap<String, Object>> formEntity = new HttpEntity<>(headers);ResponseEntity<Map> exchange = restTemplate.exchange('请求的url', HttpMethod.GET, formEntity, Map.class);
1.3.2 POST请求
其实POST请求方法和GET请求方法上大同小异,RestTemplate的POST请求也包含两个主要方法:
postForObject():返回body对象
postForEntity():返回全部的信息
1.3.2.1 模拟表单请求
模拟表单请求,post方法测试
@RestController
public class TestController {/*** 模拟表单请求,post方法测试* @return*/@RequestMapping(value = "testPostByForm", method = RequestMethod.POST)public ResponseBean testPostByForm(@RequestParam("userName") String userName,@RequestParam("userPwd") String userPwd){ResponseBean result = new ResponseBean();result.setCode("200");result.setMsg("请求成功,方法:testPostByForm,请求参数userName:" + userName + ",userPwd:" + userPwd);return result;}
}
@Autowired
private RestTemplate restTemplate;/*** 模拟表单提交,post请求*/
@Test
public void testPostByForm(){//请求地址String url = "http://localhost:8080/testPostByForm";// 请求头设置,x-www-form-urlencoded格式的数据HttpHeaders headers = new HttpHeaders();headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);//提交参数设置MultiValueMap<String, String> map = new LinkedMultiValueMap<>();map.add("userName", "唐三藏");map.add("userPwd", "123456");// 组装请求体HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>(map, headers);//发起请求ResponseBean responseBean = restTemplate.postForObject(url, request, ResponseBean.class);System.out.println(responseBean.toString());
}
1.3.2.2 模拟表单请求(传递对象)
模拟表单请求,post方法测试(对象接受)
@RestController
public class TestController {/*** 模拟表单请求,post方法测试* @param request* @return*/@RequestMapping(value = "testPostByFormAndObj", method = RequestMethod.POST)public ResponseBean testPostByForm(RequestBean request){ResponseBean result = new ResponseBean();result.setCode("200");result.setMsg("请求成功,方法:testPostByFormAndObj,请求参数:" + JSON.toJSONString(request));return result;}
}public class RequestBean {private String userName;private String userPwd;省去getset方法
}
@Autowired
private RestTemplate restTemplate;/*** 模拟表单提交,post请求*/
@Test
public void testPostByForm(){//请求地址String url = "http://localhost:8080/testPostByFormAndObj";// 请求头设置,x-www-form-urlencoded格式的数据HttpHeaders headers = new HttpHeaders();headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);//提交参数设置MultiValueMap<String, String> map = new LinkedMultiValueMap<>();map.add("userName", "唐三藏");map.add("userPwd", "123456");// 组装请求体HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>(map, headers);//发起请求ResponseBean responseBean = restTemplate.postForObject(url, request, ResponseBean.class);System.out.println(responseBean.toString());
}
1.3.2.3 模拟JSON请求
模拟JSON请求,post方法测试
@RestController
public class TestController {/*** 模拟JSON请求,post方法测试* @param request* @return*/@RequestMapping(value = "testPostByJson", method = RequestMethod.POST)public ResponseBean testPostByJson(@RequestBody RequestBean request){ResponseBean result = new ResponseBean();result.setCode("200");result.setMsg("请求成功,方法:testPostByJson,请求参数:" + JSON.toJSONString(request));return result;}
}
@Autowired
private RestTemplate restTemplate;
/*** 模拟JSON提交,post请求*/
@Test
public void testPostByJson(){//请求地址String url = "http://localhost:8080/testPostByJson";//入参RequestBean request = new RequestBean();request.setUserName("唐三藏");request.setUserPwd("123456789");//发送post请求,并打印结果,以String类型接收响应结果JSON字符串ResponseBean responseBean = restTemplate.postForObject(url, request, ResponseBean.class);System.out.println(responseBean.toString());
}
1.3.2.4 模拟页面重定向
模拟页面重定向,post请求
@Controller
public class LoginController {/*** 重定向* @param request* @return*/@RequestMapping(value = "testPostByLocation", method = RequestMethod.POST)public String testPostByLocation(@RequestBody RequestBean request){return "redirect:index.html";}
}
@Autowired
private RestTemplate restTemplate;
/*** 重定向,post请求*/
@Test
public void testPostByLocation(){//请求地址String url = "http://localhost:8080/testPostByLocation";//入参RequestBean request = new RequestBean();request.setUserName("唐三藏");request.setUserPwd("123456789");//用于提交完成数据之后的页面跳转,返回跳转urlURI uri = restTemplate.postForLocation(url, request);System.out.println(uri.toString());
}输出结果如下:
http://localhost:8080/index.html
1.3.3 PUT请求
put请求方法,可能很多人都没用过,它指的是修改一个已经存在的资源或者插入资源,该方法会向URL代表的资源发送一个HTTP PUT方法请求,示例如下
@RestController
public class TestController {/*** 模拟JSON请求,put方法测试* @param request* @return*/@RequestMapping(value = "testPutByJson", method = RequestMethod.PUT)public void testPutByJson(@RequestBody RequestBean request){System.out.println("请求成功,方法:testPutByJson,请求参数:" + JSON.toJSONString(request));}
}
@Autowired
private RestTemplate restTemplate;
/*** 模拟JSON提交,put请求*/
@Test
public void testPutByJson(){//请求地址String url = "http://localhost:8080/testPutByJson";//入参RequestBean request = new RequestBean();request.setUserName("唐三藏");request.setUserPwd("123456789");//模拟JSON提交,put请求restTemplate.put(url, request);
}
1.3.4 DELETE请求
与之对应的还有delete方法协议,表示删除一个已经存在的资源,该方法会向URL代表的资源发送一个HTTP DELETE方法请求。
@RestController
public class TestController {/*** 模拟JSON请求,delete方法测试* @return*/@RequestMapping(value = "testDeleteByJson", method = RequestMethod.DELETE)public void testDeleteByJson(){System.out.println("请求成功,方法:testDeleteByJson");}
}
@Autowired
private RestTemplate restTemplate;
/*** 模拟JSON提交,delete请求*/
@Test
public void testDeleteByJson(){//请求地址String url = "http://localhost:8080/testDeleteByJson";//模拟JSON提交,delete请求restTemplate.delete(url);
}
1.3.5 通用请求方法exchange方法
如果以上方法还不满足你的要求。在RestTemplate工具类里面,还有一个exchange通用协议请求方法,它可以发送GET、POST、DELETE、PUT、OPTIONS、PATCH等等HTTP方法请求。
打开源码,我们可以很清晰的看到这一点。
1.3.6 文件上传与下载
除了经常用到的get和post请求以外,还有一个经常会碰到的场景,那就是文件的上传与下载,如果采用RestTemplate,该怎么使用呢?
案例如下,具体实现细节参考代码注释!
1.3.6.1 文件上传
@RestController
public class FileUploadController {private static final String UPLOAD_PATH = "/springboot-frame-example/springboot-example-resttemplate/";/*** 文件上传* @param uploadFile* @return*/@RequestMapping(value = "upload", method = RequestMethod.POST)public ResponseBean upload(@RequestParam("uploadFile") MultipartFile uploadFile,@RequestParam("userName") String userName) {// 在 uploadPath 文件夹中通过用户名对上传的文件归类保存File folder = new File(UPLOAD_PATH + userName);if (!folder.isDirectory()) {folder.mkdirs();}// 对上传的文件重命名,避免文件重名String oldName = uploadFile.getOriginalFilename();String newName = UUID.randomUUID().toString() + oldName.substring(oldName.lastIndexOf("."));//定义返回视图ResponseBean result = new ResponseBean();try {// 文件保存uploadFile.transferTo(new File(folder, newName));result.setCode("200");result.setMsg("文件上传成功,方法:upload,文件名:" + newName);} catch (IOException e) {e.printStackTrace();result.setCode("500");result.setMsg("文件上传失败,方法:upload,请求文件:" + oldName);}return result;}
}
@Autowired
private RestTemplate restTemplate;/*** 文件上传,post请求*/
@Test
public void upload(){//需要上传的文件String filePath = "/Users/panzhi/Desktop/Jietu20220205-194655.jpg";//请求地址String url = "http://localhost:8080/upload";// 请求头设置,multipart/form-data格式的数据HttpHeaders headers = new HttpHeaders();headers.setContentType(MediaType.MULTIPART_FORM_DATA);//提交参数设置MultiValueMap<String, Object> param = new LinkedMultiValueMap<>();param.add("uploadFile", new FileSystemResource(new File(filePath)));//服务端如果接受额外参数,可以传递param.add("userName", "张三");// 组装请求体HttpEntity<MultiValueMap<String, Object>> request = new HttpEntity<>(param, headers);//发起请求ResponseBean responseBean = restTemplate.postForObject(url, request, ResponseBean.class);System.out.println(responseBean.toString());
}
1.3.6.2 文件下载
@RestController
public class FileUploadController {private static final String UPLOAD_PATH = "springboot-frame-example/springboot-example-resttemplate/";/*** 带参的get请求(restful风格)* @return*/@RequestMapping(value = "downloadFile/{userName}/{fileName}", method = RequestMethod.GET)public void downloadFile(@PathVariable(value = "userName") String userName,@PathVariable(value = "fileName") String fileName,HttpServletRequest request,HttpServletResponse response) throws Exception {File file = new File(UPLOAD_PATH + userName + File.separator + fileName);if (file.exists()) {//获取文件流FileInputStream fis = new FileInputStream(file);//获取文件后缀(.png)String extendFileName = fileName.substring(fileName.lastIndexOf('.'));//动态设置响应类型,根据前台传递文件类型设置响应类型response.setContentType(request.getSession().getServletContext().getMimeType(extendFileName));//设置响应头,attachment表示以附件的形式下载,inline表示在线打开response.setHeader("content-disposition","attachment;fileName=" + URLEncoder.encode(fileName,"UTF-8"));//获取输出流对象(用于写文件)OutputStream os = response.getOutputStream();//下载文件,使用spring框架中的FileCopyUtils工具FileCopyUtils.copy(fis,os);}}
}
@Autowired
private RestTemplate restTemplate;/*** 小文件下载* @throws IOException*/
@Test
public void downloadFile() throws IOException {String userName = "张三";String fileName = "c98b677c-0948-46ef-84d2-3742a2b821b0.jpg";//请求地址String url = "http://localhost:8080/downloadFile/{1}/{2}";//发起请求,直接返回对象(restful风格)ResponseEntity<byte[]> rsp = restTemplate.getForEntity(url, byte[].class, userName,fileName);System.out.println("文件下载请求结果状态码:" + rsp.getStatusCode());// 将下载下来的文件内容保存到本地String targetPath = "/Users/panzhi/Desktop/" + fileName;Files.write(Paths.get(targetPath), Objects.requireNonNull(rsp.getBody(), "未获取到下载文件"));
}
这种下载方法实际上是将下载文件一次性加载到客户端本地内存,然后从内存将文件写入磁盘。这种方式对于小文件的下载还比较适合,如果文件比较大或者文件下载并发量比较大,容易造成内存的大量占用,从而降低应用的运行效率
1.3.6.3 大文件下载
@Autowired
private RestTemplate restTemplate;
/*** 大文件下载* @throws IOException*/
@Test
public void downloadBigFile() throws IOException {String userName = "张三";String fileName = "c98b677c-0948-46ef-84d2-3742a2b821b0.jpg";//请求地址String url = "http://localhost:8080/downloadFile/{1}/{2}";//定义请求头的接收类型RequestCallback requestCallback = request -> request.getHeaders().setAccept(Arrays.asList(MediaType.APPLICATION_OCTET_STREAM, MediaType.ALL));//对响应进行流式处理而不是将其全部加载到内存中String targetPath = "/Users/panzhi/Desktop/" + fileName;restTemplate.execute(url, HttpMethod.GET, requestCallback, clientHttpResponse -> {Files.copy(clientHttpResponse.getBody(), Paths.get(targetPath));return null;}, userName, fileName);
}
这种下载方式的区别在于:
设置了请求头APPLICATION_OCTET_STREAM,表示以流的形式进行数据加载
RequestCallback结合File.copy保证了接收到一部分文件内容,就向磁盘写入一部分内容。而不是全部加载到内存,最后再写入磁盘文件。
在下载大文件时,例如excel、pdf、zip等等文件,特别管用,
1.3.7 通过服务名调用
1.3.7.1 简介
在Spring Cloud中,通过服务名称访问其他服务通常需要使用@LoadBalanced的RestTemplate,可以使用服务名(service ID)来代替具体的URL。
例如:
@Configuration
public class Config
{@LoadBalanced@Beanpublic RestTemplate restTemplate() {SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();// 设置超时requestFactory.setConnectTimeout(60 * 1000);requestFactory.setReadTimeout(60 * 1000);//利用复杂构造器可以实现超时设置,内部实际实现为 HttpClientRestTemplate restTemplate = new RestTemplate(requestFactory);return restTemplate ;}
}
上面的代码定义了一个 RestTemplate bean,并使用@LoadBalanced注解来开启负载均衡。这样,就可以在 应用中自动注入RestTemplate,然后使用服务名称来发送请求。
注意:这种方法需要服务被注册到服务发现组件(如Eureka,Nacos,Consul等)。这样,应用才能找到服务名对应的实际网络位置。
1.3.7.2 @LoadBalanced作用
@LoadBalanced 是 Netflix 的 ribbon 中的一个负载均衡的注解,并完成以下工作:
从负载均衡器中选一个对应的服务实例,所有的服务名实例都放在负载均衡器中的serverlist中;
从挑选的实例中去请求内容;
由服务名转为真正使用的ip地址;
restTemplate能通过服务名获取到具体的服务,是由LoadBalancerInterceptor这个拦截器实现的,而具体的工作是由RibbonLoadBalancerClient来完成的。
RibbonLoadBalancerClient将服务名通过负载均衡策略转为了实际的ip和端口后再apply给restTemplate。
1.4 核心讲解
1.4.1 excute
所有的get、post、delete、put、options、head、exchange(一部分)方法最终调用的都是excute方法
public T execute(String url, HttpMethod method, @Nullable RequestCallback requestCallback,
@Nullable ResponseExtractor responseExtractor, Object… uriVariables)
从上面的Excute方法中我们可以看出Excute方法只是将String格式的URI转成了java.net.URI,之后调用了doExecute方法。
整个调用过程如下
doExecute方法如下:
doExecute 方法并没有暴露出来,只能通过继承调用
这里需要了解两个类: RequestCallback & ResponseExtractor
1.4.2 RequestCallback
RequestCallback用于在ClientHttpRequest上操作的代码的回调接口。允许操作请求头,并写入请求主体。
RequestCallback有两个实现类,都是内部类:
- AcceptHeaderRequestCallback:只处理请求头,用于restTemplate.getXXX()方法
- HttpEntityRequestCallback:继承于AcceptHeaderRequestCallback可以处理请求头和body,用于restTemplate.putXXX()、restTemplate.postXXX()和restTemplate.exchange()方法
1.4.3 ResponseExtractor
restTemplate对此接口ResponseExtractor的检索方法实现,使用的通用回调接口执行,从clienthttpresponse提取数据的实际工作(解析HTTP响应的数据),但不需要担心异常处理或关闭资源
RequestCallback有三个实现类:
- HeadersExtractor:用于提取请求头
- HttpMessageConverterExtractor:用于提取响应body
- ResponseEntityResponseExtractor:使用HttpMessageConverterExtractor提取body(委托模式),然后将body和响应头、状态封装成ResponseEntity对象。