SpringBoot中使用RestTemplate

2023-11-14 09:28:28

@Author：Guzi499

@QQ：504305797

@Date：2020/01/11

1.添加依赖

引入spring-webmvc包,版本自己选

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>5.1.2.RELEASE</version>
</dependency>

也可以直接引用spring-boot-starter-web，这个依赖了spring-webmvc

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <version>2.1.0.RELEASE</version>
</dependency>

需要做配置优化，可引入httpclient包

<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5.6</version>
</dependency>

2.配置实现类

@Configuration
public class RestTemplateConfig {
    @Bean
    public RestTemplate restTemplate(ClientHttpRequestFactory factory) {
        RestTemplate restTemplate = new RestTemplate(factory);
        // 支持中文编码
        restTemplate.getMessageConverters().set(1, new StringHttpMessageConverter(Charset.forName("UTF-8")));
        return restTemplate;
    }

    @Bean
    public ClientHttpRequestFactory simpleClientHttpRequestFactory() {
        SimpleClientHttpRequestFactory factory = new SimpleClientHttpRequestFactory();
        factory.setReadTimeout(5000);//单位为ms
        factory.setConnectTimeout(5000);//单位为ms
        return factory;
    }
}

3.简单使用

3.1 GET请求

3.1.1 getForEntity

getForEntity方法的返回值是一个ResponseEntity<T>，ResponseEntity<T>是Spring对HTTP请求响应的封装，包括了几个重要的元素，如响应码、contentType、contentLength、响应消息体等。比如下面一个例子：

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

    @Test
    public void test() {

        ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://loaclhost/index0", String.class);

        String body = responseEntity.getBody();
        HttpStatus statusCode = responseEntity.getStatusCode();
        int statusCodeValue = responseEntity.getStatusCodeValue();
        HttpHeaders headers = responseEntity.getHeaders();

        System.out.println("body:" + body);
        System.out.println("statusCode:" + statusCode);
        System.out.println("statusCodeValue" + statusCodeValue);
        System.out.println("headers" + headers);
    }
}

关于这段代码：

getForEntity的第一个参数为我要调用的服务的地址。
getForEntity第二个参数String.class表示我希望返回的body类型是String

最终显示结果如下：

body:<html><h3> this is index <h3></html>
statusCode:200 OK
statusCodeValue:200
headers:{Content-Length=[2381], Content-Type=[text/html], Server=[bfe], Date=[Sun, 10 Jan 2021 02:28:12 GMT]}

在调用服务提供者提供的接口时，可能需要传递参数，有两种不同的方式

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

	@Test
	public void test1(){
	
		ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://localhost/index1?name={1}", String.class, "张三");
		
    	System.out.println(responseEntity.getBody());
	}

    @Test
    public void test2() {

        Map<String, String> map = new HashMap<>();
        map.put("name", "李四");

        ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://localhost/index2?name={name}", String.class, map);

        System.out.println(responseEntity.getBody());
    }
}

可以用一个数字做占位符，最后是一个可变长度的参数，来一一替换前面的占位符
也可以前面使用name={name}这种形式，最后一个参数是一个map，map的key即为前边占位符的名字，map的value为参数值

第一个调用地址也可以是一个URI，这个时候我们构建一个URI即可，参数都包含在URI中，如下：

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

    @Test
    public void test() {

        UriComponents uriComponents = UriComponentsBuilder.fromUriString("http://localhost/index3?name={name}").build().expand("王五").encode();
        URI uri = uriComponents.toUri();

        ResponseEntity<String> responseEntity = restTemplate.getForEntity(uri, String.class);

        System.out.println(responseEntity.getBody());
    }
}

通过Spring中提供的UriComponents来构建Uri即可。

当然，服务提供者也可以返回一个自定义类型的对象，比如如下调用：

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

    @Test
    public void test() {

        ResponseEntity<User> responseEntity = restTemplate.getForEntity("http://localhost/index4", User.class);

        User book = responseEntity.getBody();

        System.out.println(book);
    }
}

运行结果如下：

{"name":"zhangsan", "age":20, "gender":"男"}

3.1.2 getForObject

getForObject函数实际上是对getForEntity函数的进一步封装，如果你只关注返回的消息体的内容，对其他信息都不关注，此时可以使用getForObject，如下：

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

    @Test
    public void test() {

        User user = restTemplate.getForObject("http://localhost/index5", User.class);
        System.out.println(user);

    }
}

getForObject也有几个重载方法，这几个重载方法参数的含义和getForEntity一致，这里不再赘述了。

3.2 POST请求

3.2.1 postForEntity

该方法和get请求中的getForEntity方法类似，如下：

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

    @Test
    public void test() {

        Book book = new Book();
        book.setName("红楼梦");

        ResponseEntity<Book> responseEntity = restTemplate.postForEntity("http://localhost/index6", book, Book.class);
        
        System.out.println(responseEntity.getBody());

    }
}

方法的第一参数表示要调用的服务的地址
方法的第二个参数表示上传的参数
方法的第三个参数表示返回的消息体的数据类型

postForEntity也有几个重载方法，这几个重载方法参数的含义和getForEntity一致，这里不再赘述了。

3.2.2 postForObject

如果你只关注，返回的消息体，可以直接使用postForObject。用法和getForObject一致。

3.2.3 postForLocation

postForLocation也是提交新资源，提交成功之后，返回新资源的URI，postForLocation的参数和前面两种的参数基本一致，只不过该方法的返回值为Uri，这个只需要服务提供者返回一个Uri即可，该Uri表示新资源的位置。

3.3 PUT请求

在RestTemplate中，PUT请求可以通过put方法调用，put方法的参数和前面介绍的postForEntity方法的参数基本一致，只是put方法没有返回值而已。例子如下：

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

    @Test
    public void test() {

        Book book = new Book();
        book.setName("金瓶梅");

        restTemplate.put("http://localhost/index7/{1}", book, 100);
    }
}

book对象是我要提交的参数，最后的100用来替换前面的占位符{1}

3.4 DELETE请求

delete请求我们可以通过delete方法调用来实现，如下：

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

    @Test
    public void test() {

        restTemplate.delete("http://localhost/index8/{1}", 100);
    }
}

delete方法也有几个重载的方法，不过重载的参数和前面基本一致，不赘述

4.高级使用(添加请求头与参数- json发送)

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class TestRestTemplate {
    @Autowired
    private RestTemplate restTemplate;

    private static final ObjectMapper MAPPER = new ObjectMapper();

    @Test
    public void test() {

        //设置请求地址
        String url = "http://www.baidu.com";

        try {
            //设置请求头
            HttpHeaders headers = new HttpHeaders();
            //如果发送的参数数据是json数据的话，需要添加如下特殊的请求头
            headers.setContentType(MediaType.APPLICATION_JSON);
            //或者headers.set("Content-Type", "application/json");
            headers.add("token", "xxxxx");

            //设置请求参数
            Map<String, Object> param = new HashMap<>();
            param.put("name", "guzi");
            param.put("age", 24);
            //也可以直接String = "{\"name\":\"guzi\", \"age\":24}";

            //添加请求的实体类，这里第一个参数是要发送的参数，第二个参数是请求头里的数据
            HttpEntity<String> httpEntity = new HttpEntity<>(MAPPER.writeValueAsString(param), headers);

            //POST请求  如果直接写的json就不用再转换了
            ResponseEntity<String> responseEntity = this.restTemplate.postForEntity(url, httpEntity, String.class);

            System.out.println(responseEntity.getStatusCodeValue()); //200
            System.out.println(responseEntity.getBody()); //<html> ... 百度一下，你就知道 ... </html>

        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
    }
}

码农公寓