Spring之RestTemplate使用小结

I. RestTempalate 基本使用

0. 目标

在介绍如何使用RestTemplate之前，我们先抛出一些小目标，至少需要知道通过RestTemplate可以做些什么，以及我们要用它来干些什么

简单的给出了一下常见的问题如下

普通的Get请求获取返回数据，怎么玩？

post提交表达的请求，如何处理

post请求中RequestBody的请求方式与普通的请求方式区别

https/http两种访问如何分别处理

如何在请求中带上指定的Header

有跨域的问题么？如果有怎么解决

有登录验证的请求，该怎么办，怎样携带身份信息

上传文件可以支持么

对于需要代理才能访问的http资源，加代理的姿势是怎样的

上面的问题比较多，目测不是一篇博文可以弄完的，因此对这个拆解一下，本篇主要关注在RestTemplate的简单Get/Post请求的使用方式上

1. 基本接口

捞出源码，看一下其给出的一些常用接口，基本上可以分为下面几种

// get 请求
public <T> T getForObject();
public <T> ResponseEntity<T> getForEntity();
// head 请求
public HttpHeaders headForHeaders();
// post 请求
public URI postForLocation();
public <T> T postForObject();
public <T> ResponseEntity<T> postForEntity();
// put 请求
public void put();
// pathch 
public <T> T patchForObject
// delete
public void delete()
// options
public Set<HttpMethod> optionsForAllow
// exchange
public <T> ResponseEntity<T> exchange()

上面提供的几个接口，基本上就是Http提供的几种访问方式的对应，其中exchange却又不一样，后面细说

2. Get请求

从上面的接口命名上，可以看出可以使用的有两种方式 getForObject 和 getForEntity ，那么这两种有什么区别？

从接口的签名上，可以看出一个是直接返回预期的对象，一个则是将对象包装到


    ResponseEntity

封装类中

如果只关心返回结果，那么直接用


    GetForObject

即可

如果除了返回的实体内容之外，还需要获取返回的header等信息，则可以使用


    getForEntit

a. 创建Get接口

为了验证RestTemplate的使用姿势，当然得先提供一个后端的REST服务，这了直接用了我个人的一个古诗词的后端接口，来作为简单的Get测试使用

请求连接： https://story.hhui.top/detail?id=666106231640

返回结果:

"status" : { "code" : 200 , "msg" : "SUCCESS" "result" : { "id" : 666106231640 , "title" : "西塞山二首（今谓之道士矶，即兴国军大冶县" , "author" : "王周" , "content" : "西塞名山立翠屏，浓岚横入半江青。\n千寻铁锁无由问，石壁空存道者形。\n匹妇顽然莫问因，匹夫何去望千春。\n翻思岵屺传诗什，举世曾无化石人。" , "explain" : "" , "theme" : "无" , "dynasty" : "唐诗"

b. getForObject方式

首先看下完整的接口签名

@Nullable
public <T> T getForObject(String url, Class<T> responseType, Object... uriVariables) throws RestClientException ;
@Nullable
public <T> T getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException ;
@Nullable
public <T> T getForObject(URI url, Class<T> responseType) throws RestClientException;

有三个重载的方法，从接口上也比较容易看出如何使用，其中有点疑惑的则是第一钟，参数应该怎么传了，下面给出上面几种的使用姿势

public class RestTestmplateTest {
    private RestTemplate restTemplate;
    @Before
    public void init() {
        restTemplate = new RestTemplate();
    @lombok.Data
    static class InnerRes {
        private Status status;
        private Data result;
    @lombok.Data
    static class Status {
        int code;
        String msg;
    @lombok.Data
    static class Data {
        long id;
        String theme;
        String title;
        String dynasty;
        String explain;
        String content;
        String author;
    @Test
    public void testGet() {
        // 使用方法一，不带参数
        String url = "https://story.hhui.top/detail?id=666106231640";
        InnerRes res = restTemplate.getForObject(url, InnerRes.class);
        System.out.println(res);
        // 使用方法一，传参替换
        url = "https://story.hhui.top/detail?id={?}";
        res = restTemplate.getForObject(url, InnerRes.class, "666106231640");
        System.out.println(res);
        // 使用方法二，map传参
        url = "https://story.hhui.top/detail?id={id}";
        Map<String, Object> params = new HashMap<>();
        params.put("id", 666106231640L);
        res = restTemplate.getForObject(url, InnerRes.class, params);
        System.out.println(res);
        // 使用方法三，URI访问
        URI uri = URI.create("https://story.hhui.top/detail?id=666106231640");
        res = restTemplate.getForObject(uri, InnerRes.class);
        System.out.println(res);

看上面的testcase，后面两个方法的使用没什么好说的，主要看一下 org.springframework.web.client.RestTemplate#getForObject(java.lang.String, java.lang.Class<T>, java.lang.Object...) 的使用姿势

根据实际传参替换url模板中的内容

使用方法一时，模板中使用

{?}

来代表坑位，根据实际的传参顺序来填充

使用方法二时，模板中使用


    {xx}

, 而这个xx，对应的就是map中的key

上面执行后的截图如下

c. getForEntity方式

既然getForObject有三种使用方法，那么getForEntity理论上也应该有对应的三种方式

public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... uriVariables) throws RestClientException ;
public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException;
public <T> ResponseEntity<T> getForEntity(URI url, Class<T> responseType) throws RestClientException;

因为使用姿势和上面一致，因此只拿一个进行测试

@Test
public void testGetForEntity() {
    String url = "https://story.hhui.top/detail?id=666106231640";
    ResponseEntity<InnerRes> res = restTemplate.getForEntity(url, InnerRes.class);
    System.out.println(res);

对这个，我们主要关注的就是ResponseEntity封装中，多了哪些东西，截图如下

从上面可以看出，多了两个东西

一个返回的http状态码，如200表示请求成功，500服务器错误，404not found等

一个 ResponseHeader

3. Post请求

从上面的接口说明上看，post请求除了有forObject 和 forEntity之外，还多了个forLocation；其次post与get一个明显的区别就是传参的姿势问题，get的参数一般会待在url上；post的则更常见的是通过表单的方式提交

因此接下来关注的重点在于forLocation是什么，以及如何传参

a. post接口mock

首先创建一个简单的提供POST请求的REST服务，基于Spring-boot简单搭建一个，如下

@ResponseBody
@RequestMapping(path = "post", method = {RequestMethod.GET, RequestMethod.OPTIONS, RequestMethod.POST})
public String post(HttpServletRequest request,
        @RequestParam(value = "email", required = false) String email,
        @RequestParam(value = "nick", required = false) String nick) {
   Map<String, Object> map = new HashMap<>();
   map.put("code", "200");
   map.put("result", "add " + email + " # " + nick + " success!");
   return JSON.toJSONString(map);

b. postForObject方法

首先看一下接口签名

public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Object... uriVariables) throws RestClientException ;
public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException;
public <T> T postForObject(URI url, @Nullable Object request, Class<T> responseType) throws RestClientException ;

上面的三个方法，看起来和前面并没有太大的区别，只是多了一个request参数，那么具体的使用如何呢？

下面分别给出使用用例

@Test
public void testPost() {
    String url = "http://localhost:8080/post";
    String email = "test@hhui.top";
    String nick = "一灰灰Blog";
    MultiValueMap<String, String> request = new LinkedMultiValueMap<>();
    request.add("email", email);
    request.add("nick", nick);
    // 使用方法三
    URI uri = URI.create(url);
    String ans = restTemplate.postForObject(uri, request, String.class);
    System.out.println(ans);
    // 使用方法一
    ans = restTemplate.postForObject(url, request, String.class);
    System.out.println(ans);
    // 使用方法一，但是结合表单参数和uri参数的方式，其中uri参数的填充和get请求一致
    request.clear();
    request.add("email", email);
    ans = restTemplate.postForObject(url + "?nick={?}", request, String.class, nick);
    System.out.println(ans);
    // 使用方法二
    Map<String, String> params = new HashMap<>();
    params.put("nick", nick);
    ans = restTemplate.postForObject(url + "?nick={nick}", request, String.class, params);
    System.out.println(ans);

上面分别给出了三种方法的调用方式，其中post传参区分为两种，一个是uri参数即拼接在url中的，还有一个就是表单参数

uri参数，使用姿势和get请求中一样，填充uri中模板坑位

表单参数，由


    MultiValueMap

封装，同样是kv结构

c. postForEntity

和前面的使用姿势一样，无非是多了一层包装而已，略过不讲

d. postForLocation

这个与前面有点区别，从接口定义上来说，主要是

POST 数据到一个URL，返回新创建资源的URL

同样提供了三个接口，分别如下，需要注意的是返回结果，为URI对象,即网络资源

public URI postForLocation(String url, @Nullable Object request, Object... uriVariables)
		throws RestClientException ;
public URI postForLocation(String url, @Nullable Object request, Map<String, ?> uriVariables)
		throws RestClientException ;
public URI postForLocation(URI url, @Nullable Object request) throws RestClientException ;

那么什么样的接口适合用这种访问姿势呢？

想一下我们一般登录or注册都是post请求，而这些操作完成之后呢？大部分都是跳转到别的页面去了，这种场景下，就可以使用 postForLocation 了，提交数据，并获取返回的URI，一个测试如下

首先mock一个后端接口

@ResponseBody
@RequestMapping(path = "success")
public String loginSuccess(String email, String nick) {
    return "welcome " + nick;
@RequestMapping(path = "post", method = {RequestMethod.GET, RequestMethod.OPTIONS, RequestMethod.POST})
public String post(HttpServletRequest request, @RequestParam(value = "email", required = false) String email,
        @RequestParam(value = "nick", required = false) String nick) {
    return "redirect:/success?email=" + email + "&nick=" + nick + "&status=success";

访问的测试用例，基本上和前面的一样，没有什么特别值得一说的

@Test
public void testPostLocation() {
    String url = "http://localhost:8080/post";
    String email = "test@hhui.top";
    String nick = "一灰灰Blog";
    MultiValueMap<String, String> request = new LinkedMultiValueMap<>();
    request.add("email", email);
    request.add("nick", nick);
    // 使用方法三
    URI uri = restTemplate.postForLocation(url, request);
    System.out.println(uri);

执行结果如下

获取到的就是302跳转后端url，细心的朋友可能看到上面中文乱码的问题，如何解决呢？

一个简单的解决方案就是url编码一下

@RequestMapping(path = "post", method = {RequestMethod.GET, RequestMethod.OPTIONS, RequestMethod.POST},
            produces = "charset/utf8")
public String post(HttpServletRequest request, @RequestParam(value = "email", required = false) String email,
        @RequestParam(value = "nick", required = false) String nick) throws UnsupportedEncodingException {
    return "redirect:/success?email=" + email + "&nick=" + URLEncoder.encode(nick, "UTF-8") + "&status=success";

II. 小结

上面目前只给出了Get/Post两种请求方式的基本使用方式，并没有涉及到更高级的如添加请求头，添加证书，设置代理等，高级的使用篇等待下一篇出炉，下面小结一下上面的使用姿势

1. Get请求

get请求中，参数一般都是带在url上，对于参数的填充，有两种方式，思路一致都是根据实际的参数来填充url中的占位符的内容；根据返回结果，也有两种方式，一个是只关心返回对象，另一个则包含了返回headers信心

形如


    http://story.hhui.top?id={0}

的 url

调用


    getForObject(String url, Class<T> responseType, Object... uriVariables)

模板中的0，表示 uriVariables 数组中的第0个， i，则表示第i个

如果没有url参数，也推荐用这个方法，不传uriVariables即可

形如


    http://story.hhui.top?id={id}

的 url

调用


    getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables)

map参数中的key，就是url参数中 {} 中的内容

其实还有一种传参方式，就是path参数，填充方式和上面一样，并没有什么特殊的玩法，上面没有特别列出

直接获取返回的数据


    getForObject

获取待responseHeader的数据


    getForEntity

2. Post请求

post请求的返回也有两种，和上面一样

post请求，参数可以区分为表单提交和url参数，其中url参数和前面的逻辑一致

post表单参数，请包装在


    MultiValueMap

中，作为第二个参数


    Request

来提交

post的方法，还有一个


    postForLocation

，返回的是一个URI对象，即适用于返回网络资源的请求方式

3. 其他

最前面提了多点关于网络请求的常见case，但是上面的介绍，明显只处于基础篇，我们还需要关注的有

如何设置请求头？

有身份验证的请求，如何携带身份信息？

代理的设置

文件上传可以怎么做？

post提交json串（即RequestBody) 又可以怎么处理

上面可能还停留在应用篇，对于源码和实现有兴趣的话，问题也就来了

RestTemplaet的实现原理是怎样的

前面url参数的填充逻辑实现是否优雅

返回的对象如何解析

小小的一个工具类，其实东西还挺多的，接下来的小目标，就是针对上面提出的点，逐一进行研究

III. 其他

1. 一灰灰Blog ： liuyueyi.github.io/hexblog

一灰灰的个人博客，记录所有学习和工作中的博文，欢迎大家前去逛逛

2. 声明

尽信书则不如，已上内容，纯属一家之言，因个人能力有限，难免有疏漏和错误之处，如发现bug或者有更好的建议，欢迎批评指正，不吝感激

微博地址: 小灰灰Blog

QQ：一灰灰/3302797840

3. 扫描关注

小灰灰Blog&公众号

友情链接：

穿书后，我带着男配一起逆袭了天降四宝，夫人哪里逃末世求生：我能召唤亡灵军团快穿之炮灰她把剧情玩坏了别恨天依晚,相梦在午时什么意思别想预判我别惹大佬的小祖宗小说别惹我们风水师小说别慌，我不是主角别惹我，我不听资深搬运工【一灰灰blog】 3,046 文章被阅读 655,885 Spring之RestTemplate使用小结 I. RestTempalate 基本使用 0. 目标 1. 基本接口 2. Get请求 3. Post请求 II. 小结 1. Get请求 2. Post请求 3. 其他 III. 其他 1. 一灰灰Blog： liuyueyi.github.io/hexblog