SpringBoot 使用RestTemplate实现调用服务

大锅睿

已于 2022-10-28 17:09:13 修改

阅读量2.5w

点赞数 6

CC 4.0 BY-SA版权

分类专栏： SpringBoot Java 文章标签： SpringBoot 服务调用

于 2018-08-02 10:47:56 首次发布

本文链接：https://blog.csdn.net/cwr452829537/article/details/81352720

Java 同时被 2 个专栏收录

26 篇文章

订阅专栏

SpringBoot

12 篇文章

订阅专栏

本文详细介绍如何在SpringBoot项目中使用RestTemplate进行远程HTTP调用。包括依赖配置、RestTemplate实例化及设置超时时间，同时展示了如何通过POST和GET方式调用远程API，并附带了实际的代码示例。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

SpringBoot的搭建可以看一下我之前写的一篇博客

IDEA 搭建SpringBoot项目_大锅睿的博客-CSDN博客

准备工作

要使用RestTemplate需要引入依赖，web依赖也可以在创建项目时选择Web -> Web

<!-- web -->
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<!-- 远程调用 httpclient -->
<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5.5</version>
</dependency>

注入RestTemplate

可以直接在Application中配置一个RestTemplate Bean

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
import org.springframework.web.client.RestTemplate;

@SpringBootApplication
public class RemoteApplication {
    @Bean 
    public RestTemplate restTemplate() {
        HttpComponentsClientHttpRequestFactory httpRequestFactory = new HttpComponentsClientHttpRequestFactory();
        httpRequestFactory.setConnectionRequestTimeout(30 * 1000);
        httpRequestFactory.setConnectTimeout(30 * 3000);
        httpRequestFactory.setReadTimeout(30 * 3000);
        return new RestTemplate(httpRequestFactory);
    }
    public static void main(String[] args) {
        SpringApplication.run(RemoteApplication.class, args);
    }
}

也可以编写一个RestTemplate配置类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
import org.springframework.web.client.RestTemplate;

/**
 * @Description RestTemplate配置
 * @Author CWR
 * @Date 2022/7/14 16:37
 */
@Configuration
public class RestTemplateConfig {
    @Bean
    public RestTemplate restTemplate() {
        HttpComponentsClientHttpRequestFactory httpRequestFactory = new HttpComponentsClientHttpRequestFactory();
        httpRequestFactory.setConnectionRequestTimeout(30 * 1000);
        httpRequestFactory.setConnectTimeout(30 * 3000);
        httpRequestFactory.setReadTimeout(30 * 3000);
        return new RestTemplate(httpRequestFactory);
    }
}

实体类

import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Data;

@Data
public class UserEntity {
    @JsonProperty("user_id")
    private Long userId;
    private String name;
    private String phone;
}

import lombok.Data;

@Data
public class Result {
    private Integer code;
    private String message;
}

controller

import com.cwr.remote.model.db.UserEntity;
import com.cwr.remote.model.vo.Result;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.*;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.client.RestTemplate;


@RequestMapping("/remote")
//允许跨域访问
@CrossOrigin(origins = "*", maxAge = 3600)
@RestController
public class RemoteController {
    //自动注入RestTemplate 
    private final RestTemplate restTemplate;

    @Autowired
    public RemoteController(RestTemplate restTemplate) {
        this.restTemplate = restTemplate;
    }

    /**
     * 调用远程服务添加用户信息
     *
     * @param userEntity 用户实体
     * @return
     */
    @PostMapping("/add-user")
    public Result addUser(@RequestBody UserEntity userEntity) {
        HttpEntity<UserEntity> entity = new HttpEntity<>(userEntity);
        ResponseEntity<Result> resultResponseEntity = this.restTemplate.exchange(
                "http://xxx.xxx.xxx.xxx/user/add",
                HttpMethod.POST, entity, Result.class);
        if (resultResponseEntity.getStatusCode() == HttpStatus.OK) {
            return resultResponseEntity.getBody();
        }
        return null;
    }

    /**
     * 调用远程服务查询单个用户信息
     *
     * @param id 用户id
     * @return
     */
    @GetMapping("/find-user-id/{id}")
    public UserEntity findOne(@PathVariable Long id) {
        ResponseEntity<UserEntity> resultResponseEntity = this.restTemplate.exchange(
                String.format("http://xxx.xxx.xxx.xxx/user/find-id/%s", id),
                HttpMethod.GET, null, UserEntity.class);
        if (resultResponseEntity.getStatusCode() == HttpStatus.OK) {
            return resultResponseEntity.getBody();
        }
        return null;
    }
}

这里详细讲一下exchange( )方法

public <T> ResponseEntity<T> exchange(String url, 
                                      HttpMethod method, 
                                      @Nullable HttpEntity<?> requestEntity,
                                      Class<T> responseType)

url:请求地址，如果需要在url中带参数，使用String.format()，用%s拼接即可;
method:请求方式，HttpMethod是一个枚举类型，有GET、POST、DELETE等方法;
requestEntity:请求参数，这个主要是POST等有请求体的方法才需要，GET、DELETE等方法可以为null;
responseType:返回数据类型。

测试结果（我使用的是Postman）