Spring应用消费REST服务

　　在微服务领域，使用Spring应用对另外一个应用的API发起请求的场景并不罕见。

　　Spring应用可以采用多张方式来消费REST API，包括以下几种方式

⒈RestTemplate

　　Spring核心框架提供的简单、同步REST客户端。

　　为了避免单调的样板代码，Spring提供了RestTemplate。RestTemplate提供了41个与REST资源交互的方法，下表中提供了常见的12方法。

方法	描述
delete(...)	在特定的URL上对资源执行HTTP DELETE操作
exchange(...)	在URL上执行特定的HTTP方法，返回包含对象的ResponseEntity， 这个对象是从响应体中映射得到的
execute(...)	在URL上执行特定的HTTP方法，返回一个从响应体映射得到的对象
getForEntity(...)	发送一个HTTP GET请求，返回的ResponseEntity包含了响应体所 映射成的对象。
getForObject(...)	发送一个HTTP GET请求，返回的请求体将映射为一个对象
headForHeaders(...)	发送HTTP  HEAD请求，返回包含特定资源URL的HTTP头信息
optionsForAllow(...)	发送HTTP OPTIONS请求，返回特定URL的Allow头信息
patchForObject(...)	发送HTTP PATCH请求，返回一个从响应体映射得到的对象
postForEntity(...)	POST数据到一个URL，返回包含一个对象的ResponseEntity，这个 对象是从响应体中映射得到的
postForLocation(...)	POST数据到一个URL，返回新创建资源的URL
postForObject(...)	POST数据到一个URL，返回根据响应体匹配形成的对象
put(...)	PUT资源到特定的URL

　　除了TRACE以外，RestTemplate对每种标准的HTTP方法都提供了至少一个方法。除此之外，execute()和exchange()提供了较低层次的通用方法，以便于进行任意的HTTP操作。

@RestController
@Log
public class UserController {

    private RestTemplate restTemplate = new RestTemplate();

    // ----------------- getForObject -----------------------
    public User getUserById(String userId){
        return restTemplate.getForObject("http://localhost:8080/user/{id}",User.class,userId);
    }

    public User getUserById2(String userId){
        Map<String,String> urlVariables = new HashMap<>();
        urlVariables.put("id",userId);
        return restTemplate.getForObject("http://localhost:8080/user/{id}",User.class,urlVariables);
    }

    //构建Url参数的方式
    public User getUserById3(String userId){
        Map<String,String> urlVariables = new HashMap<>();
        urlVariables.put("id",userId);
        URI url = UriComponentsBuilder.fromHttpUrl("http://localhost:8080/user/{id}").build(urlVariables);
        return restTemplate.getForObject(url, User.class);
    }

    // ----------------- getForEntity -----------------------
    // getForEntity()的工作方式和getForObject()类似，但是它返回的不是实体对象，而是一个包裹实体对象的ResponseEntity对象
    // 借助ResponseEntity对象能够访问很多响应细节，比如响应头信息等。
    public User getUserById4(String userId){
        ResponseEntity<User> responseEntity = restTemplate.getForEntity("http://localhost:8080/user/{id}",User.class, userId);
        log.info("记录时间： " + responseEntity.getHeaders().getDate());
        return responseEntity.getBody();
    }

    // ----------------- PUT -----------------------
    public void updateUser(User user){
        restTemplate.put("http://localhost:8080/user/{id}",user,user.getId());
    }

    // ----------------- DELETE -----------------------
    public void delUser(User user){
        restTemplate.delete("http://localhost:8080/user/{id}",user.getId());
    }

    // ----------------- POST -----------------------
    //  1.希望在POST请求后获得新添加的资源，使用postForObject()
    public User createUser(User user){
        return restTemplate.postForObject("http://localhost:8080/user",user,User.class);
    }

    // 2.如果想要在创建资源后获得新资源的地址，使用postForLocation()
    public URI createUser2(User user){
        return restTemplate.postForLocation("http://localhost:8080/user",user);
    }

    // 3.如果想要获取新添加的资源以及资源地址及更多信息，使用postForEntity()
    public User createUser3(User user){
        ResponseEntity<User> responseEntity = restTemplate.postForEntity("http://localhost:8080/user",user,User.class);
        log.info("资源创建时间： " + responseEntity.getHeaders().getLocation());
        return responseEntity.getBody();
    }
}

 

⒉Traverson

　　Spring HATEOAS提供的支持超链接、同步的REST客户端，其灵感来源于同名的JavaScript库

　　当所消费的API在响应中包含了超链接，那么RestTemplate就力所不及了，我们可以使用RestTemplate获取详细的资源数据，然后手动创建逻辑来处理里面所包含的内容和链接。但这个过程并不简单，与其使用RestTemplate来处理超媒体API不如选择一个专门关注该领域的工具，那就是Traverson。

　　Traverson来源于Spring Data HATEOAS项目，是Spring应用中开箱即用的消费超媒体API的解决方案，这个基于Java的库灵感来源于同名的JavaScript库。

　　Traverson的名字有点类似于“tracerse on”，这种叫法其实可以很好地描述它的用法。它将会以遍历API关系名的方式来消费API。

@RestController
@Log
public class UserController {

    private RestTemplate restTemplate = new RestTemplate();
    //使用API的基础URI来实例化一个Traverson对象
    private Traverson traverson = new Traverson(URI.create("http://localhost:8080/api"), MediaTypes.HAL_JSON);

    //获取用户列表
    public Collection<User> getUsers(){
        ParameterizedTypeReference<CollectionModel<User>> userType = new ParameterizedTypeReference<CollectionModel<User>>() {};
        //通过follow()方法，就可以导航至链接关系名为users的资源，然后通过toObject()来提取资源。
        CollectionModel<User> userRes = traverson.follow("users").toObject(userType);
        Collection<User> users = userRes.getContent();
        return users;
    }

    //获取最近创建的用户
    public Collection<User> getNewUsers(){
        ParameterizedTypeReference<CollectionModel<User>> userType = new ParameterizedTypeReference<CollectionModel<User>>() {};
        //CollectionModel<User> userRes = traverson.follow("users").follow("recents").toObject(userType);   //可以简写
        CollectionModel<User> userRes = traverson.follow("users","recents").toObject(userType);
        Collection<User> users = userRes.getContent();
        return users;
    }

    //添加新用户
    public User createUser(User user){
        //通过asLink()方法得到链接本身，然后getHref()得到链接的URL
        String createUserUrl = traverson.follow("users").asLink().getHref();
        return restTemplate.postForObject(createUserUrl, user, User.class);
    }

}

　　Traverson能够很容器地导航HATEOAS的API并消费其资源，但它并没有提供这些API写入或删除资源的方法。相反，RestTemplate能够写入和删除资源，但是在导航API方面支持得并不太好。

　　当既要导航API有需要更新或删除资源时，就需要组合使用RestTemplate和Traverson。Traverson仍然可以导航至创建新资源的链接。然后，可以将这个链接传递给RestTemplate来执行PUST、PUT、DELETE或任何其他需要的HTTP请求。【参见上面代码中的`添加新用户`节点】

⒊WebClient

　　Spring 5 所引入的反应式、异步REST客户端。【未完待续】