springBoot集成RestTemplate

@RestController
public class DepetController{
	
	@Resource
	private DeptService deptService;
	
	/**
	 * 根据Id查找
	 * @param id 
	 * @return
	 */
	@GetMapping("/dept/{id}")
	public Dept getDept(@PathVariable("id")Integer id){
		Dept dept = deptService.getDeptById(id);
		return dept;
	}
	
	/**
	 * 分页获取列表
	 * @param pageNum
	 * @param pageSize
	 * @return
	 */
	@GetMapping("/dept")
	public List<Dept> getDeptList(Integer pageNum,Integer pageSize){
		return deptService.getDeptList(pageNum,pageSize);
	}
	
	
	/**
	 * 添加dept
	 * @param dept
	 * @return
	 */
	@PostMapping("/dept")
	public Dept addDepet(@RequestBody Dept dept){
		Dept dept1=deptService.addDept(dept);
		return dept1;
	}
	
	
	/**
	 * 修改dept
	 * @param dept
	 * @return
	 */
	@PutMapping("/dept")
	public boolean modifyDept(@RequestBody Dept dept){
		return deptService.modifyDept(dept);
	}
	
	
	/**
	 * 根据Id删除
	 * @param id
	 * @return
	 */
	@DeleteMapping("/dept/{id}")
	public boolean deleteDept(@PathVariable("id")Integer id){
		return deptService.deleteDept(id);
	}
}

注入

  • 在使用之前需要在配置文件中注入,如下:
@Configuration
public class RestConfig{
	@Bean
    public RestTemplate restTemplate(ClientHttpRequestFactory factory){
        return new RestTemplate(factory);
    }

    @Bean
    public ClientHttpRequestFactory simpleClientHttpRequestFactory(){
        SimpleClientHttpRequestFactory factory = new SimpleClientHttpRequestFactory();
        factory.setReadTimeout(5000);//单位为ms
        factory.setConnectTimeout(5000);//单位为ms
        return factory;
    }
}
  • 注入之后即可直接使用了

详解

GET(获取数据

生产

  • 安全幂等操作
  • 先创建一个GET请求的controller,如下:
/**
 * 通过get请求方式
 * @param id 
 * @param name
 * @return
 */
@GetMapping("/dept/{id}/{name}")
public Dept getDept(@PathVariable("id")Integer id,@PathVariable("name")String name){
	Dept dept=new Dept();
	dept.setDepetId(id);
	dept.setDepetName(name);
	return dept;
}

消费

  • public <T> T getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables)
/**
 * 使用RestTemplate的getForObject()发出get请求
 */
@GetMapping("/consumer/{id}/{name}")
public Dept getDept(@PathVariable("id")Integer id,@PathVariable("name")String name)throws RestClientException, URISyntaxException{
	//使用一个Map封装Get请求的参数,其中key一定要和uri中的占位符一致
	Map<String, Object> params=new HashMap<String, Object>();
	params.put("id", id);
	params.put("name", name);
	Dept dept = restTemplate.getForObject(URL_PRFIX+"{id}/{name}", Dept.class,params);
	return dept;
}
  • public <T> T getForObject(URI url, Class<T> responseType)
/**
 * 使用RestTemplate的getForObject()发出get请求
 */
@GetMapping("/consumer/{id}/{name}")
public Dept getDept(@PathVariable("id")Integer id,@PathVariable("name")String name)throws RestClientException, URISyntaxException{
	//直接在uri中拼接参数
	Dept dept = restTemplate.getForObject(URL_PRFIX+id+"/"+name, Dept.class);
	return dept;
}
  • public <T> T getForObject(String url, Class<T> responseType, Object... uriVariables)
/**
 * 使用RestTemplate的getForObject()发出get请求
 */
@GetMapping("/consumer/{id}/{name}")
public Dept getDept(@PathVariable("id")Integer id,@PathVariable("name")String name)throws RestClientException, URISyntaxException{
	//使用{id}作为一个占位符,第三个参数是用来设置这个占位符的值,当然可以有多个占位符
	Dept dept = restTemplate.getForObject(URL_PRFIX+"{id}/{name}", Dept.class, id,name);
	return dept;
}
  • 以上三种形式的请求都是大同小异的,只是入参的方式不同罢了

POST(新建、添加)

  • 不安全
  • public <T> T postForObject(URI url, @Nullable Object request, Class<T> responseType)

    • 第一个参数是请求的uri
    • 第二个参数是添加的数据
    • 第三个是返回的数据类型
  • public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType,Map<String, ?> uriVariables)

    • 前三个参数同上
    • 第四个参数是用来封装过滤参数的(?后面的)
  • public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType,Object... uriVariables)

    • 同上
/**
 * 新建数据
 */
@PostMapping("/dept")
public Dept addDept(@RequestBody Dept dept)throws RestClientException, URISyntaxException{
	Dept dept2 = restTemplate.postForObject(new URI(URL_PRFIX), dept, Dept.class);
	return dept2;
}

PUT(更新)

  • public void put(URI url, @Nullable Object request)

    • 第一个参数是地址
    • 第二个参数是更新需要提交的数据
  • public void put(String url, @Nullable Object request, Object... uriVariables)

    • 前两个参数同上
    • 第二个参数是封装需要过滤的数据(?后面的数据)
/**
 * 更新数据
 * @param dept
 * @throws RestClientException
 * @throws URISyntaxException
 */
@PutMapping("/dept")
public void modifyDept(@RequestBody Dept dept)throws RestClientException, URISyntaxException{
	restTemplate.put(new URI(URL_PRFIX), dept);
}

DELETE(删除)

  • public void delete(URI url)

    • 第一个参数是地址
  • public void delete(String url, Object... uriVariables)

    • 第一个参数是地址
    • 第二个参数是过滤参数(?后面的)
  • public void delete(String url, Map<String, ?> uriVariables)

    • 第二个参数是过滤参数(?后面的)
/**
 * 删除数据
 * @param id
 */
@DeleteMapping("/dept/{id}")
public void delete(@PathVariable("id")Integer id){
	restTemplate.delete(URL_PRFIX+"/{id}", id);
}

参考文章

  • RESTful API 最佳实践
  • https://www.cnblogs.com/softidea/p/5977375.html

  • https://blog.csdn.net/itguangit/article/details/80198895

原文 

https://chenjiabing666.github.io/2018/12/03/springBoot集成RestTemplate/

本站部分文章源于互联网,本着传播知识、有益学习和研究的目的进行的转载,为网友免费提供。如有著作权人或出版方提出异议,本站将立即删除。如果您对文章转载有任何疑问请告之我们,以便我们及时纠正。

PS:推荐一个微信公众号: askHarries 或者qq群:474807195,里面会分享一些资深架构师录制的视频录像:有Spring,MyBatis,Netty源码分析,高并发、高性能、分布式、微服务架构的原理,JVM性能优化这些成为架构师必备的知识体系。还能领取免费的学习资源,目前受益良多

转载请注明原文出处:Harries Blog™ » springBoot集成RestTemplate

赞 (0)
分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址