Java SpringBoot项目调用外部HTTP接口的三种实战方案：HttpClient、RestTemplate与Feign

SpringBoot 不仅继承了 Spring 框架原有的优秀特性，还通过简化配置进一步降低了整个应用的搭建和开发复杂度。在实际的 Spring Boot 项目开发中，我们经常需要访问外部模块的接口或外部 URL，例如在低代码平台（aPaaS）开发中封装接口来调用平台提供的流程引擎服务。本文将详细介绍三种不使用 Dubbo 的常见 HTTP 调用方式，并附上完整的代码示例。

方式一：使用原生HttpClient请求

Apache HttpClient 是一个功能强大且底层的 HTTP 客户端库，提供了对 HTTP 协议的全面控制。使用它调用接口虽然代码量稍多，但灵活性极高。

首先，我们来看一个在 Controller 层接收参数并准备数据的例子：

/*
 * @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<String,Object> 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();
}

紧接着，在 Service 层实现使用 HttpClient 调用外部接口的核心方法：

/*
 * @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;
}

方式二：使用RestTemplate方法

RestTemplate 是 Spring 框架提供的一个用于同步 HTTP 客户端的模板类，它简化了与 HTTP 服务器的通信，并遵循 RESTful 原则。在 Spring Boot 项目中，我们可以方便地使用它来进行外部接口调用。它主要提供了 getForObject、getForEntity、postForObject、postForEntity 等方法。

Get请求

getForEntity 方法返回包含响应状态、头信息和响应体的 ResponseEntity 对象，它有以下两种常用重载形式：

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

示例：使用 URI 对象

//该方法使用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();

示例：使用 URL 变量

//该方法提供了三个参数，其中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);

getForObject 方法则可以理解为对 getForEntity 的进一步封装，它直接返回响应体转换后的对象，省去了从 ResponseEntity 中提取的步骤。

Post 请求

Post请求主要有 postForEntity、postForObject 和 postForLocation 三种方式。我们重点看一下 postForEntity 的使用，它同样有多种重载方式。

下面是一个完整的实战示例，展示了在 Controller 中接收 POST 请求，并通过 Service 层的 RestTemplate 调用外部接口。

首先，Controller 层接收 JSON 参数：

/*
 * @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);
}

然后，Service 层使用 RestTemplate 发送 POST 请求：

/*
 * @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<String, Object> map = getMap(documentId);
    String jsonStr = JSON.toJSONString(map);
    //创建请求体并添加数据
    HttpEntity<Map> httpEntity = new HttpEntity<Map>(map, httpHeaders);
    String url = "http://39.103.201.110:30661/xdap-open/open/process/v1/submit";
    ResponseEntity<String> forEntity = restTemplate.postForEntity(url,httpEntity,String.class);//此处三个参数分别是请求地址、请求体以及返回参数类型
    return forEntity.toString();
}

方式三：使用Feign进行消费

Feign 是一个声明式的 Web Service 客户端，它让编写 HTTP 客户端变得更简单。通过定义接口并添加注解，开发者可以像调用本地方法一样调用远程服务，这在 微服务架构 中尤为常见。

1. 添加依赖与启用

在 Maven 项目的 pom.xml 中添加 Feign 依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-feign</artifactId>
    <version>1.2.2.RELEASE</version>
</dependency>

在 Spring Boot 启动类上添加 @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);
    }
}

2. 模拟外部接口（供Feign调用测试）

为了演示，我们先在项目中编写一个模拟外部系统的接口。

定义Controller：

@Autowired
PrintService printService;

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

定义Service接口：

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

定义Service实现：

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

3. 构建FeignClient

这是 Feign 使用的核心，我们通过一个接口来声明要调用的远程服务。

定义FeignClient接口：

//此处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中调用FeignClient：

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

4. 测试与结果

使用 Postman 等工具向 /test2 接口发送 POST 请求，Feign 会自动将请求转发到配置的 ${outSide.url}/custom/outSide 地址。

使用 Postman 测试 Feign 接口调用，成功返回模拟的外部接口响应。

5. 为Feign请求添加Header（如Token）

在实际项目中，调用外部接口通常需要携带认证信息。Feign 可以通过自定义配置，全局地为所有请求添加 Header。

定义一个实现 RequestInterceptor 的配置类：

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

在 FeignClient 接口中指定该配置：

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

总结

本文详细讲解了在 Spring Boot 项目中调用外部 HTTP 接口的三种主流方式：原生的 HttpClient、Spring 封装的 RestTemplate 以及声明式的 Feign。每种方式各有优劣：

• HttpClient 控制力最强，适合需要精细调控 HTTP 请求的场景。
• RestTemplate 是 Spring 生态的标准选择，简单易用，功能齐全。
• Feign 则以声明式编程见长，代码最简洁优雅，尤其在微服务体系中集成度最高。

开发者可以根据项目的具体需求、技术栈偏好以及对代码简洁性的要求来选择合适的方式。希望这些实战示例能帮助你更高效地进行外部服务集成。如果你想深入探讨更多关于系统架构或 Java 开发的话题，欢迎访问 云栈社区 与广大开发者交流。