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

2023-06-22 06:10:58 来源：博客园

1、简介

SpringBoot不仅继承了Spring框架原有的优秀特性，而且还通过简化配置来进一步简化了Spring应用的整个搭建和开发过程。

在Spring-Boot项目开发中，存在着本模块的代码需要访问外面模块接口，或外部url链接的需求, 比如在apaas开发过程中需要封装接口在接口中调用apaas提供的接口（像发起流程接口submit等等）下面也是提供了三种方式（不使用dubbo的方式）供我们选择

(资料图片)

推荐一个开源免费的 Spring Boot 实战项目：

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

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

/* * @description get方式获取入参，插入数据并发起流程 * @author lyx * @date 2022/8/24 16:05 * @params documentId * @return String *///@RequestMapping("/submit/{documentId}")public String submit1(@PathVariable String documentId) throws ParseException {    //此处将要发送的数据转换为json格式字符串    Map map =task2Service.getMap(documentId);    String jsonStr = JSON.toJSONString(map, SerializerFeature.WRITE_MAP_NULL_FEATURES,SerializerFeature.QuoteFieldNames);    JSONObject jsonObject = JSON.parseObject(jsonStr);    JSONObject sr = task2Service.doPost(jsonObject);    return sr.toString();}/* * @description 使用原生httpClient调用外部接口 * @author lyx * @date 2022/8/24 16:08 * @params date * @return JSONObject */public static JSONObject doPost(JSONObject date) {    String assessToken="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ4ZGFwYXBwaWQiOiIzNDgxMjU4ODk2OTI2OTY1NzYiLCJleHAiOjE2NjEyMjY5MDgsImlhdCI6MTY2MTIxOTcwOCwieGRhcHRlbmFudGlkIjoiMzAwOTgxNjA1MTE0MDUyNjA5IiwieGRhcHVzZXJpZCI6IjEwMDM0NzY2MzU4MzM1OTc5NTIwMCJ9.fZAO4kJSv2rSH0RBiL1zghdko8Npmu_9ufo6Wex_TI2q9gsiLp7XaW7U9Cu7uewEOaX4DTdpbFmMPvLUtcj_sQ";    CloseableHttpClient client = HttpClients.createDefault();    // 要调用的接口url    String url = "http://39.103.201.110:30661 /xdap-open/open/process/v1/submit";    HttpPost post = new HttpPost(url);    JSONObject jsonObject = null;    try {        //创建请求体并添加数据        StringEntity s = new StringEntity(date.toString());        //此处相当于在header里头添加content-type等参数        s.setContentType("application/json");        s.setContentEncoding("UTF-8");        post.setEntity(s);        //此处相当于在Authorization里头添加Bear token参数信息        post.addHeader("Authorization", "Bearer " +assessToken);        HttpResponse res = client.execute(post);        String response1 = EntityUtils.toString(res.getEntity());        if (res.getStatusLine()                .getStatusCode() == HttpStatus.SC_OK) {            // 返回json格式：            String result = EntityUtils.toString(res.getEntity());            jsonObject = JSONObject.parseObject(result);        }    } catch (Exception e) {        throw new RuntimeException(e);    }    return jsonObject;}

3、方式二：使用RestTemplate方法

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

Get请求

提供了getForObject、getForEntity两种方式，其中getForEntity如下三种方法的实现：

Get--getForEntity，存在以下两种方式重载

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

Get--getForEntity(URI url,Class responseType)

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

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

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

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

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

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

Post 请求

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

Post--postForEntity，存在以下三种方式重载

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

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

/* * @description post方式获取入参，插入数据并发起流程 * @author lyx * @date 2022/8/24 16:07 * @params * @return */@PostMapping("/submit2")public Object insertFinanceCompensation(@RequestBody JSONObject jsonObject) {    String documentId=jsonObject.get("documentId").toString();    return task2Service.submit(documentId);}/* * @description 使用restTimeplate调外部接口 * @author lyx * @date 2022/8/24 16:02 * @params documentId * @return String */public String submit(String documentId){    String assessToken="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ4ZGFwYXBwaWQiOiIzNDgxMjU4ODk2OTI2OTY1NzYiLCJleHAiOjE2NjEyMjY5MDgsImlhdCI6MTY2MTIxOTcwOCwieGRhcHRlbmFudGlkIjoiMzAwOTgxNjA1MTE0MDUyNjA5IiwieGRhcHVzZXJpZCI6IjEwMDM0NzY2MzU4MzM1OTc5NTIwMCJ9.fZAO4kJSv2rSH0RBiL1zghdko8Npmu_9ufo6Wex_TI2q9gsiLp7XaW7U9Cu7uewEOaX4DTdpbFmMPvLUtcj_sQ";    RestTemplate restTemplate = new RestTemplate();    //创建请求头    HttpHeaders httpHeaders = new HttpHeaders();    //此处相当于在Authorization里头添加Bear token参数信息    httpHeaders.add(HttpHeaders.AUTHORIZATION, "Bearer " + assessToken);    //此处相当于在header里头添加content-type等参数    httpHeaders.add(HttpHeaders.CONTENT_TYPE,"application/json");    Map map = getMap(documentId);    String jsonStr = JSON.toJSONString(map);    //创建请求体并添加数据    HttpEntity httpEntity = new HttpEntity(map, httpHeaders);    String url = "http://39.103.201.110:30661/xdap-open/open/process/v1/submit";    ResponseEntity forEntity = restTemplate.postForEntity(url,httpEntity,String.class);//此处三个参数分别是请求地址、请求体以及返回参数类型    return forEntity.toString();}

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

在maven项目中添加依赖

    org.springframework.cloud    spring-cloud-starter-feign    1.2.2.RELEASE

启动类上加上@EnableFeignClients

@SpringBootApplication@EnableFeignClients@ComponentScan(basePackages = {"com.definesys.mpaas", "com.xdap.*" ,"com.xdap.*"})public class MobilecardApplication {     public static void main(String[] args) {        SpringApplication.run(MobilecardApplication.class, args);    } }

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

定义controller

@AutowiredPrintService printService;@PostMapping("/outSide")public String test(@RequestBody TestDto testDto) {    return printService.print(testDto);}

定义service

@Servicepublic interface PrintService {    public String print(TestDto testDto);}

定义serviceImpl

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

构建Feigin的Service

定义service

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

定义controller

@AutowiredFeignService2 feignService2;//测试feign调用外部接口入口@PostMapping("/test2")public String test2(@RequestBody TestDto testDto) {    return feignService2.getMessage(testDto);}

postman测试

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

补充如下：

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

定义config

@Configurationpublic class FeignConfig implements RequestInterceptor {    @Override    public void apply(RequestTemplate requestTemplate) {        //添加token        requestTemplate.header("token", "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ4ZGFwYXBwaWQiOiIzNDgxMjU4ODk2OTI2OTY1NzYiLCJleHAiOjE2NjEyMjY5MDgsImlhdCI6MTY2MTIxOTcwOCwieGRhcHRlbmFudGlkIjoiMzAwOTgxNjA1MTE0MDUyNjA5IiwieGRhcHVzZXJpZCI6IjEwMDM0NzY2MzU4MzM1OTc5NTIwMCJ9.fZAO4kJSv2rSH0RBiL1zghdko8Npmu_9ufo6Wex_TI2q9gsiLp7XaW7U9Cu7uewEOaX4DTdpbFmMPvLUtcj_sQ");    }}

定义service

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

定义controller

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