RestTemplate使用详解

简介

Spring 提供用于访问Rest服务的客户端，RestTemplate 提供了多种便捷访问远程HTTP服务的方法，
简化了与HTTP服务之间的通信，满足RestFul原则。
之前与HTTP通信，大多使用Apache提供的HttpClient，代码比较繁琐，通信完需要资源回收。
免费在线测试RestfulFul 测试网址：http://httpbin.org/#/HTTP_Methods/post_post，
或使用PostMan测试。

创建RestTemplate

由于RestTemplate是Sring 框架提供的，只需要引入SpringBoot的依赖

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

RestTemplate常用方法

GET
RestTemplate发送GET请求一般有两种方法：

public <T> T getForObject(...);
public <T> ResponseEntity<T> getForEntity(...);

getForEntity()
​ 后缀带有Entity的方法都代表返回一个ResponseEntity<T>，ResponseEntity<T>是Spring对HTTP请求响应的封装，包括了几个重要的元素，如响应码，contentType、contentLength、响应消息体等。

通过ResponseEntity<T>继承的HttpEntity<T>可返回响应头getHeader，响应体getBody等。
案例：

ResponseEntity<Object> forEntity = restTemplate.getForEntity("https://restapi.amap.com/v3/weather/weatherInfo?city=510100&key=e7a5fa943f706602033b6b329c49fbc6", Object.class);
System.out.println("状态码:"+forEntity.getStatusCode());
System.out.println("状态码内容:"+forEntity.getStatusCodeValue());
HttpHeaders headers = forEntity.getHeaders();
System.out.println("响应头:"+headers);
Object body = forEntity.getBody();
System.out.println("响应内容:"+body);

该例子中getForEntity(...)方法的第一个参数为我要调用服务的URL，第二个参数则为响应内容的类的类型（Java嘛 万物皆对象）还可以添加第三个参数，第三个参数为一个可变参数 代表着调用服务时的传参。

getForObject(...)
​相比于前者getForEntity(...)该方法则是，更偏向于直接获取响应内容的，因为他直接返回响应实体的body。
案例：

Object body = restTemplate.getForObject("https://restapi.amap.com/v3/weather/weatherInfo?city=510100&key=e7a5fa943f706602033b6b329c49fbc6", Object.class);
System.out.println(body);

​ 当你只需要返回的响应内容时，使用getForObject()是一个很好的选择，但当你需要获得更详细的响应信息，如响应头中的信息，你就只能选择getForEntity()了。

---

POST
RestTemplate常用的post请求有三种：

public <T> ResponseEntity<T> postForEntity(...);
public <T> T postForObject(...);
public URI postForLocation(...);

第一种和第二种和上面GET类似，直接贴代码案例
postForObject(...)

User user = new User();
user.setName("张三");
ResponseEntity<Object> objectResponseEntity = restTemplate.postForEntity("https://restapi.amap.com/v3/weather/weatherInfo?city=510100&key=e7a5fa943f706602033b6b329c49fbc6", user, Object.class);
System.out.println("消息响应内容:"+objectResponseEntity.getBody());

postForObject(...)

User user = new User();
user.setName("张三");
ResponseEntity<Object> objectResponseEntity = restTemplate.postForEntity("https://httpbin.org/post", user, Object.class);
MediaType contentType = objectResponseEntity.getHeaders().getContentType();
System.out.println(contentType);
System.out.println("响应内容:"+objectResponseEntity.getBody());

postForLocation(...)

postForLocation(...)返回的是一个URL。

User user = new User();
user.setName("张三");
URI uri = restTemplate.postForLocation("https://httpbin.org/post", user);
System.out.println(uri);

使用POST表单提交

1，封装请求体
2，需要用到如下几个类

该类是用来封装头部信息
HttpHeaders
该类是用来封装请求参数的，是以key-value的形式封装但是以单个key对应多个value的格式传输(也就是是以单个key:[value...]的格式传输的)。
MultiValueMap<K,V> ：
​ 该类是用来封装请求的，主要作用就是将请求头和请求体封装在一起成为一个请求实体 T用来指定用来封装参数的容器的类型。
HttpEntity<T>

        方式一：
        //请求地址
        String url = "https://baidu.com/api";
        //设置请求头, x-www-form-urlencoded格式的数据
        HttpHeaders httpHeaders = new HttpHeaders();
        httpHeaders.setContentType(MediaType.APPLICATION_FORM_URLENCODED);

        //提交参数设置
        MultiValueMap<String, String> map = new LinkedMultiValueMap<>();
        map.add("name","zs");

        //组装请求体
        HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>(map, httpHeaders);

        //发送post请求并打印结果 以String类型接收响应结果JSON字符串
        String s = restTemplate.postForObject(url, request, String.class);
        System.out.println(s);
        方式二：
        HttpHeaders headers = new HttpHeaders();
        headers.add("Content-Type", "application/json");
        HttpEntity<String> formEntity = new HttpEntity<>("{\"account\":\"" + account + "\",\"password\":\"" + password + "\"}", headers);
        String body = restTemplate.postForObject(tokenUrl, formEntity, String.class);
        JSONObject object = JSONObject.parseObject(body);
        log.info("token{}", object.getJSONObject("data").get("token"));
        return object.getJSONObject("data").get("token").toString();

RestTemplate设置访问超时

        //设置超时
        SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();  
        //读取超时10秒,默认无限限制,单位：毫秒
        requestFactory.setConnectTimeout(10000);
        //连接超时10秒，默认无限制，单位：毫秒
        requestFactory.setReadTimeout(10000);  
        List<SlhResults> slhResults = new ArrayList<>();
        HttpHeaders headers = new HttpHeaders();
        //设置编码
        headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
        List<JSONObject> list = new ArrayList<>();
        String strParam = "";
        if (orderInfoDTO != null) {
            JSONObject json = new JSONObject();
            json.put("PMSID", orderInfoDTO.getProjectSubjectCode());
            json.put("ServiceBom", "");
            list.add(json);
            strParam = JSON.toJSONString(list, SerializerFeature.DisableCircularReferenceDetect);
            log.info("slh入参:" + strParam);
        }
        HttpEntity<String> httpEntity = new HttpEntity<String>(strParam, headers);
        ResponseEntity<String> response = null;
        try {
            response = restTemplate.postForEntity(uri, httpEntity, String.class);
            log.info("slh接口："+response.getStatusCode());
            String slhJson = response.getBody();
            log.info("slh出参:" + slhJson);
            JSONObject jsonObject = JSON.parseObject(slhJson);
            if (jsonObject != null) {
                JSONArray content = jsonObject.getJSONArray("Data");
                slhResults = JSONObject.parseArray(content.toString(), SlhResults.class);
            }
        } catch (Exception e) {
            return null;
//            throw new CommonException("调用SLH灯塔接口报错：" + e);
        }
        return slhResults;
}

RestTemplate config配置及使用

配置

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

使用

public class SlhOrderServiceImpl {
    @Autowired
    private RestTemplate restTemplate;
}