Spring Boot 调用外部接口的 3 种方式，还有谁不会？！

1、简介

SpringBoot不仅继承了Spring框架原有的优秀特性，而且还通过简化配置来进一步简化了Spring应用的整个搭建和开发过程。
在Spring-Boot项目开发中，存在着本模块的代码需要访问外面模块接口，或外部url链接的需求, 比如在apaas开发过程中需要封装接口在接口中调用apaas提供的接口（像发起流程接口submit等等）下面也是提供了三种方式（不使用dubbo的方式）供我们选择
推荐一个开源免费的 Spring Boot 实战项目：

https://github.com/javastacks/spring-boot-best-practice

2、方式一：使用原始httpClient请求

1. /*
2. * @description get方式获取入参，插入数据并发起流程
3. * @author lyx
4. * @date 2022/8/24 16:05
5. * @params documentId
6. * @return String
7. */
8. //
9. @RequestMapping("/submit/{documentId}")
10. public String submit1(@PathVariable String documentId) throws ParseException {
11.     //此处将要发送的数据转换为json格式字符串
12.     Map<String,Object> map =task2Service.getMap(documentId);
13.     String jsonStr = JSON.toJSONString(map, SerializerFeature.WRITE_MAP_NULL_FEATURES,SerializerFeature.QuoteFieldNames);
14.     JSONObject jsonObject = JSON.parseObject(jsonStr);
15.     JSONObject sr = task2Service.doPost(jsonObject);
16.     return sr.toString();
17. }
18. /*
19. * @description 使用原生httpClient调用外部接口
20. * @author lyx
21. * @date 2022/8/24 16:08
22. * @params date
23. * @return JSONObject
24. */
25. public static JSONObject doPost(JSONObject date) {
26.     String assessToken="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ4ZGFwYXBwaWQiOiIzNDgxMjU4ODk2OTI2OTY1NzYiLCJleHAiOjE2NjEyMjY5MDgsImlhdCI6MTY2MTIxOTcwOCwieGRhcHRlbmFudGlkIjoiMzAwOTgxNjA1MTE0MDUyNjA5IiwieGRhcHVzZXJpZCI6IjEwMDM0NzY2MzU4MzM1OTc5NTIwMCJ9.fZAO4kJSv2rSH0RBiL1zghdko8Npmu_9ufo6Wex_TI2q9gsiLp7XaW7U9Cu7uewEOaX4DTdpbFmMPvLUtcj_sQ";
27.     CloseableHttpClient client = HttpClients.createDefault();
28.     // 要调用的接口url
29.     String url = "http://39.103.201.110:30661 /xdap-open/open/process/v1/submit";
30.     HttpPost post = new HttpPost(url);
31.     JSONObject jsonObject = null;
32.     try {
33.         //创建请求体并添加数据
34.         StringEntity s = new StringEntity(date.toString());
35.         //此处相当于在header里头添加content-type等参数
36.         s.setContentType("application/json");
37.         s.setContentEncoding("UTF-8");
38.         post.setEntity(s);
39.         //此处相当于在Authorization里头添加Bear token参数信息
40.         post.addHeader("Authorization", "Bearer " +assessToken);
41.         HttpResponse res = client.execute(post);
42.         String response1 = EntityUtils.toString(res.getEntity());
43.         if (res.getStatusLine()
44.                 .getStatusCode() == HttpStatus.SC_OK) {
45.             // 返回json格式：
46.             String result = EntityUtils.toString(res.getEntity());
47.             jsonObject = JSONObject.parseObject(result);
48.         }
49.     } catch (Exception e) {
50.         throw new RuntimeException(e);
51.     }
52.     return jsonObject;
53. }

复制代码

3、方式二：使用RestTemplate方法

Spring-Boot开发中，RestTemplate同样提供了对外访问的接口API，这里主要介绍Get和Post方法的使用。
Get请求

提供了getForObject 、getForEntity两种方式，其中getForEntity如下三种方法的实现：
Get--getForEntity，存在以下两种方式重载

1. 1.getForEntity(Stringurl,Class responseType,Object…urlVariables)
2. 2.getForEntity(URI url,Class responseType)

复制代码

Get--getForEntity(URI url,Class responseType)

1. //该方法使用URI对象来替代之前的url和urlVariables参数来指定访问地址和参数绑定。URI是JDK java.net包下的一个类，表示一个统一资源标识符(Uniform Resource Identifier)引用。参考如下：
2. RestTemplate restTemplate=new RestTemplate();
3. UriComponents
4. uriComponents=UriComponentsBuilder.fromUriString("http://USER-SERVICE/user?name={name}")
5. .build()
6. .expand("dodo")
7. .encode();
8. URI uri=uriComponents.toUri();
9. ResponseEntityresponseEntity=restTemplate.getForEntity(uri,String.class).getBody();

复制代码

Get--getForEntity(Stringurl,Class responseType,Object…urlVariables)

1. //该方法提供了三个参数，其中url为请求的地址，responseType为请求响应body的包装类型，urlVariables为url中的参数绑定，该方法的参考调用如下：
2. // http://USER-SERVICE/user?name={name)
3. RestTemplate restTemplate=new RestTemplate();
4. Mapparams=new HashMap<>();
5. params.put("name","dada"); //
6. ResponseEntityresponseEntity=restTemplate.getForEntity("http://USERSERVICE/user?name={name}",String.class,params);

复制代码

Get--getForObject，存在以下三种方式重载

1. 1.getForObject(String url,Class responseType,Object...urlVariables)
2. 2.getForObject(String url,Class responseType,Map urlVariables)
3. 3.getForObject(URI url,Class responseType)

复制代码

getForObject方法可以理解为对getForEntity的进一步封装，它通过HttpMessageConverterExtractor对HTTP的请求响应体body内容进行对象转换，实现请求直接返回包装好的对象内容。
Post 请求

Post请求提供有postForEntity、postForObject和postForLocation三种方式，其中每种方式都有三种方法，下面介绍postForEntity的使用方法。
Post--postForEntity，存在以下三种方式重载

1. 1.postForEntity(String url,Object request,Class responseType,Object...  uriVariables)
2. 2.postForEntity(String url,Object request,Class responseType,Map  uriVariables)
3. 3.postForEntity(URI url,Object request，Class responseType)

复制代码

如下仅演示第二种重载方式

1. /*
2. * @description post方式获取入参，插入数据并发起流程
3. * @author lyx
4. * @date 2022/8/24 16:07
5. * @params
6. * @return
7. */
8. @PostMapping("/submit2")
9. public Object insertFinanceCompensation(@RequestBody JSONObject jsonObject) {
10.     String documentId=jsonObject.get("documentId").toString();
11.     return task2Service.submit(documentId);
12. }
13. /*
14. * @description 使用restTimeplate调外部接口
15. * @author lyx
16. * @date 2022/8/24 16:02
17. * @params documentId
18. * @return String
19. */
20. public String submit(String documentId){
21.     String assessToken="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ4ZGFwYXBwaWQiOiIzNDgxMjU4ODk2OTI2OTY1NzYiLCJleHAiOjE2NjEyMjY5MDgsImlhdCI6MTY2MTIxOTcwOCwieGRhcHRlbmFudGlkIjoiMzAwOTgxNjA1MTE0MDUyNjA5IiwieGRhcHVzZXJpZCI6IjEwMDM0NzY2MzU4MzM1OTc5NTIwMCJ9.fZAO4kJSv2rSH0RBiL1zghdko8Npmu_9ufo6Wex_TI2q9gsiLp7XaW7U9Cu7uewEOaX4DTdpbFmMPvLUtcj_sQ";
22.     RestTemplate restTemplate = new RestTemplate();
23.     //创建请求头
24.     HttpHeaders httpHeaders = new HttpHeaders();
25.     //此处相当于在Authorization里头添加Bear token参数信息
26.     httpHeaders.add(HttpHeaders.AUTHORIZATION, "Bearer " + assessToken);
27.     //此处相当于在header里头添加content-type等参数
28.     httpHeaders.add(HttpHeaders.CONTENT_TYPE,"application/json");
29.     Map<String, Object> map = getMap(documentId);
30.     String jsonStr = JSON.toJSONString(map);
31.     //创建请求体并添加数据
32.     HttpEntity<Map> httpEntity = new HttpEntity<Map>(map, httpHeaders);
33.     String url = "http://39.103.201.110:30661/xdap-open/open/process/v1/submit";
34.     ResponseEntity<String> forEntity = restTemplate.postForEntity(url,httpEntity,String.class);//此处三个参数分别是请求地址、请求体以及返回参数类型
35.     return forEntity.toString();
36. }

复制代码

4、方式三：使用Feign进行消费

在maven项目中添加依赖

1. <dependency>
2.     <groupId>org.springframework.cloud</groupId>
3.     <artifactId>spring-cloud-starter-feign</artifactId>
4.     <version>1.2.2.RELEASE</version>
5. </dependency>

复制代码

启动类上加上@EnableFeignClients

1. @SpringBootApplication
2. @EnableFeignClients
3. @ComponentScan(basePackages = {"com.definesys.mpaas", "com.xdap.*" ,"com.xdap.*"})
4. public class MobilecardApplication {
6.     public static void main(String[] args) {
7.         SpringApplication.run(MobilecardApplication.class, args);
8.     }
10. }

复制代码

此处编写接口模拟外部接口供feign调用外部接口方式使用
定义controller

1. @Autowired
2. PrintService printService;
4. @PostMapping("/outSide")
5. public String test(@RequestBody TestDto testDto) {
6.     return printService.print(testDto);
7. }

复制代码

定义service

1. @Service
2. public interface PrintService {
3.     public String print(TestDto testDto);
4. }

复制代码

定义serviceImpl

1. public class PrintServiceImpl implements PrintService {
3.     @Override
4.     public String print(TestDto testDto) {
5.         return "模拟外部系统的接口功能"+testDto.getId();
6.     }
7. }

复制代码

构建Feigin的Service
定义service

1. //此处name需要设置不为空，url需要在.properties中设置
2. @Service
3. @FeignClient(url = "${outSide.url}", name = "service2")
4. public interface FeignService2 {
5.     @RequestMapping(value = "/custom/outSide", method = RequestMethod.POST)
6.     @ResponseBody
7.     public String getMessage(@Valid @RequestBody TestDto testDto);
8. }

复制代码

定义controller

1. @Autowired
2. FeignService2 feignService2;
3. //测试feign调用外部接口入口
4. @PostMapping("/test2")
5. public String test2(@RequestBody TestDto testDto) {
6.     return feignService2.getMessage(testDto);
7. }

复制代码

postman测试

此处因为我使用了所在项目，所以需要添加一定的请求头等信息，关于Feign的请求头添加也会在后续补充
补充如下：
添加Header解决方法

将token等信息放入Feign请求头中，主要通过重写RequestInterceptor的apply方法实现
定义config

1. @Configuration
2. public class FeignConfig implements RequestInterceptor {
3.     @Override
4.     public void apply(RequestTemplate requestTemplate) {
5.         //添加token
6.         requestTemplate.header("token", "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ4ZGFwYXBwaWQiOiIzNDgxMjU4ODk2OTI2OTY1NzYiLCJleHAiOjE2NjEyMjY5MDgsImlhdCI6MTY2MTIxOTcwOCwieGRhcHRlbmFudGlkIjoiMzAwOTgxNjA1MTE0MDUyNjA5IiwieGRhcHVzZXJpZCI6IjEwMDM0NzY2MzU4MzM1OTc5NTIwMCJ9.fZAO4kJSv2rSH0RBiL1zghdko8Npmu_9ufo6Wex_TI2q9gsiLp7XaW7U9Cu7uewEOaX4DTdpbFmMPvLUtcj_sQ");
7.     }
8. }

复制代码

定义service

1. @Service
2. @FeignClient(url = "${outSide.url}",name = "feignServer", configuration = FeignDemoConfig.class)
3. public interface TokenDemoClient {
4.     @RequestMapping(value = "/custom/outSideAddToken", method = RequestMethod.POST)
5.     @ResponseBody
6.     public String getMessage(@Valid @RequestBody TestDto testDto);
7. }

复制代码

定义controller

1. //测试feign调用外部接口入口，加上token
2. @PostMapping("/testToken")
3. public String test4(@RequestBody TestDto testDto) {
4.     return tokenDemoClient.getMessage(testDto);
5. }

复制代码

版权声明：本文为CSDN博主「Chelsea」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。原文链接：https://blog.csdn.net/Chelsea/article/details/126689495

近期热文推荐：
1.1,000+ 道 Java面试题及答案整理(2022最新版)
2.劲爆！Java 协程要来了。。。
3.Spring Boot 2.x 教程，太全了！
4.别再写满屏的爆爆爆炸类了，试试装饰器模式，这才是优雅的方式！！
5.《Java开发手册（嵩山版）》最新发布，速速下载！
觉得不错，别忘了随手点赞+转发哦！

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！