RestTemplate用法

╰+哭是因爲堅強的太久メ 2023-10-01 12:13 7阅读 0赞

### Rest ###

REST（RepresentationalState Transfer）是Roy Fielding 提出的一个描述互联系统架构风格的名词。REST定义了一组体系架构原则，您可以根据这些原则设计以系统资源为中心的Web 服务，包括使用不同语言编写的客户端如何通过 HTTP处理和传输资源状态。

为什么称为 REST？Web本质上由各种各样的资源组成，资源由URI 唯一标识。浏览器（或者任何其它类似于浏览器的应用程序）将展示出该资源的一种表现方式，或者一种表现状态。如果用户在该页面中定向到指向其它资源的链接，则将访问该资源，并表现出它的状态。这意味着客户端应用程序随着每个资源表现状态的不同而发生状态转移，也即所谓REST。

### HTTP请求的方法 ###

*  GET：通过请求URI得到资源
 *  POST：用于添加新的内容
 *  PUT：用于修改某个内容，若不存在则添加
 *  DELETE：删除某个内容
 *  OPTIONS ：询问可以执行哪些方法
 *  HEAD ：类似于GET, 但是不返回body信息，用于检查对象是否存在，以及得到对象的元数据
 *  CONNECT ：用于代理进行传输，如使用SSL
 *  TRACE：用于远程诊断服务器

### RestTemplate ###

`RestTemplate` 是从 Spring3.0 开始支持的一个 HTTP 请求工具，它提供了常见的REST请求方案的模版，例如 GET 请求、POST 请求、PUT 请求、DELETE 请求以及一些通用的请求执行方法 exchange 以及 execute。RestTemplate 继承自 InterceptingHttpAccessor 并且实现了 RestOperations 接口，其中 RestOperations 接口定义了基本的 RESTful 操作，这些操作在 RestTemplate 中都得到了实现。

### 使用 ###

1.  新建 config.ApplicationContextConfig.java

@Configuration
    public class ApplicationContextConfig {
        
    
        @Bean // applicationContext.xml <bean id="" class="">
        public RestTemplate restTemplate() {
        
            return new RestTemplate();
        }
    }

1.  使用

@Resource
        private RestTemplate restTemplate;
    
        @GetMapping(value = "/consumer/payment/create")
        public CommonResult<Payment> create(Payment payment) {
        
            return restTemplate.postForObject(“http://localhost:8080” + "/payment/get/" + id, payment, CommonResult.class);
            
            // (url, requestMap, ResponseBean.class) 这三个参数分别代表
            // REST请求地址、请求参数、HTTP响应被转换成的对象类型
            // 支持的方法很多，不一一列举了
        }
        @GetMapping(value = "/consumer/payment/getForEntity/{id}")
        public CommonResult getpaymentlist2(@PathVariable("id") Long id) {
        
            ResponseEntity<CommonResult> entity = restTemplate.getForEntity(PAYMENT_URL + "/payment/get/" + id, CommonResult.class);
    
            if (entity.getStatusCode().is2xxSuccessful()){
        
            	// log.info(entity.getHeaders());
                return entity.getBody();
            }else {
        
                return new CommonResult(444,"查询失败");
            }
        }

1.  添加请求头和body

import org.springframework.http.HttpEntity;
    import org.springframework.http.HttpHeaders;
    import org.springframework.http.MediaType;
    import org.springframework.util.LinkedMultiValueMap;
    import org.springframework.util.MultiValueMap;
    import org.springframework.web.client.RestTemplate;
    
    
    private static String formUpload(){
        
        HttpHeaders httpHeaders = new HttpHeaders();
        
        httpHeaders.set("token","123");
        httpHeaders.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
        
         //  封装参数，千万不要替换为Map与HashMap，否则参数无法传递
        MultiValueMap<String, Object> multiValueMap = new LinkedMultiValueMap<>();
        multiValueMap.add("api_key", API_KEY);
        multiValueMap.add("api_secret", API_SECRET);
        
        HttpEntity<MultiValueMap<String, Object>> httpEntity = new HttpEntity<>(multiValueMap, httpHeaders);
        return restTemplate.postForObject(serverUrl, httpEntity, String.class);
    }