spring-in-action-day05-REST
1.创建RESTFUL端点
(1)创建get端点
(2)创建post端点
(3)创建put/patch端点
(4)创建delete端点
2.启用超媒体
3.消费REST端点
3.1使用RestTemplate消费端点
(1)消费get端点
(2)消费put端点
(3)消费delete端点
(4)消费post端点
(5) Resttemplate设置连接超时
3.2使用Traverson导航超媒体REST API
1.创建RESTFUL端点
(1)创建get端点
package tacos.web; import java.util.ArrayList;
import java.util.List;
import java.util.Optional; import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping; import tacos.User; @org.springframework.web.bind.annotation.RestController
//@RestController 1.表示是controller组件 2.告诉spring所有的返回数据都会被写入响应体中-类似@responsebody的作用
@RequestMapping(value="/design",produces="application/json")
//@RequestMapping 1.指定路径 2.指定返回的格式-这里可以是一个数组,包含多种格式produces={"application/json,text/xml}"
@CrossOrigin(origins="*") //允许所有跨域请求
public class RestController { @GetMapping(value="recent/{id}",produces="application/json")
//@GetMapping 1.指定get请求 2.指定路径 3.指定请求Accept必须有application/json
public ResponseEntity<List<User>> recentTacos(@PathVariable("id") Integer id) {
//获取数据li
List<User> li = new ArrayList<User>(); if(li != null && li.size() > 0){
return new ResponseEntity<>(li,HttpStatus.OK) ;
//返回 ResponseEntity对象,可以自己定义状态码,在结果为空的情况下,返回null或者空集合不合适,就可以这样返回NOT_FOUND的状态码
}else{
return new ResponseEntity<>(li,HttpStatus.NOT_FOUND) ;
}
}
//这个控制器智慧处理 /design/recent/{id}的get请求 {id}是参数占位符
//请求访问http://localhost:8080/design/recent/1
}
(2)创建post端点
@PostMapping(value="recent",consumes="application/json")
//@PostMapping 1.指定post请求 2.指定路径 3指定请求Content-Type属性是application/json
@ResponseStatus(HttpStatus.CREATED)
//@ResponseStatus当成功时,返回的状态码是201CREATED而不是200,这样描述的更清楚,表示请求不但成功,而且创建了一个资源
public User recentTacos(@RequestBody User user) { //@RequestBody 将请求的参数绑定到User对象
//保存数据
return user;
}
//值得注意的@ResponseStatus(HttpStatus.CREATED),更符合rest标准
(3)创建put/patch端点
1)为什么会有put和patch两种更新呢?
PATCH方法是新引入的,是对PUT方法的补充,用来对已知资源进行局部更新
假设我们有一个UserInfo,里面有userId, userName, userGender等10个字段。可你的编辑功能因为需求,在某个特别的页面里只能修改userName,这时候的更新怎么做?
人们通常(为徒省事)把一个包含了修改后userName的完整userInfo对象传给后端,做完整更新。但仔细想想,这种做法感觉有点二,而且真心浪费带宽
于是patch诞生,只传一个userName到指定资源去,表示该请求是一个局部更新,后端仅更新接收到的字段。
而put虽然也是更新资源,但要求前端提供的一定是一个完整的资源对象,理论上说,如果你用了put,但却没有提供完整的UserInfo,那么缺了的那些字段应该被清空。
也就是说put是对一个对象的所有属性进行更新,没有传来的属性用null替代。
最后再补充一句,restful只是标准,标准的意思是如果在大家都依此行事的话,沟通成本会很低,开发效率就高。但并非强制(也没人强制得了)。
所以你说在你的程序里把方法名从put改成patch没有任何影响,那是自然,因为你的后端程序并没有按照标准对两个方法做不同处理,那也不影响程序的运行
2)PUT端点
@PutMapping(value="recent",consumes="application/json")
//@PutMapping 1.指定put请求 2.指定路径 3指定请求Content-Type属性是application/json
public User putrecentTacos(@RequestBody User user) { //@RequestBody 将请求的参数绑定到User对象
//更新数据
return user;
}
3)PATCH端点
@PatchMapping(value="recent",consumes="application/json")
//@PatchMapping 1.指定patch请求 2.指定路径 3指定请求Content-Type属性是application/json
public User patchrecentTacos(@RequestBody User user) { //@RequestBody 将请求的参数绑定到User对象
//局部更新数据
if(user.getList() != null){
//更新list
}
if(user.getUsername() != null){
//更新username
}
if(user.getPassword() != null){
//更新password
}
return user;
} //可以看到PUT直接把user整体进行更新,而PATCH只对接收到的属性进行局部更新
(4)创建delete端点
@DeleteMapping(value="recent/{id}") //@DeleteMapping 1.指定delete请求 2.指定路径3.指定参数占位符
@ResponseStatus(HttpStatus.NO_CONTENT) //由于删除后没有资源返回所有我们返回状态码HttpStatus.NO_CONTENT 204清 晰的表示资源已不存在,而不是返回200仅表示成功
public void patchrecentTacos(@PathVariable("id") Integer id) { //@PathVariable将参数占位符绑定到方法参数上
//根据id删除
}
2.启用超媒体(不详细说明)
hateoas
3.消费REST端点
(1)使用RestTemplate消费rest端点
1)消费get端点
被消费的端点
private RestTemplate temp = new RestTemplate(); //为了简便这里是直接创建-也可以注入获取对象
@RequestMapping(value="orgdetail/{orgid}")
@ResponseBody
public Organization findOrgDetail(@PathVariable("orgid") Integer orgid,HttpServletResponse resp) {
//获取数据li
System.out.println("id=" + orgid);
return new Organization(1,"机构" + orgid);
}
消费方法1-仅获取返回值
@GetMapping(value="mygetrest")
public void mygetrest() {
System.out.println("haha");
Integer id = 1;
//temp.getMessageConverters().add(new MyHttpMessageConverter());
Organization forObject = temp.getForObject("http://localhost:8080/design/orgdetail/{orgid}",Organization.class,id );
//参数1:路径,参数2,返回值类型,参数3:请求参数
System.out.println("jieguo:" + forObject.toString());
//jieguo:Organization [orgid=1, orgname=机构1]
}
消费方法2-获取返回值和其它信息
@GetMapping(value="mygetrest2")
public void mygetrest2() {
Integer id = 1;
//temp.getMessageConverters().add(new MyHttpMessageConverter());
ResponseEntity<Organization> entity = temp.getForEntity("http://localhost:8080/design/orgdetail/{orgid}",Organization.class,id );
//参数1:路径,参数2,返回值类型,参数3:请求参数
System.out.println("body:" + entity.getBody());
//body:Organization [orgid=1, orgname=机构1]
System.out.println("date:" + entity.getHeaders().getDate());
//date:1600856875000
System.out.println("header:" + entity.getHeaders());
//header:{Content-Type=[application/json;charset=UTF-8], Transfer-Encoding=[chunked], Date=[Wed, 23 Sep 2020 10:27:55 GMT]} }
2)消费put端点
被消费的端点
@PutMapping(value="recent",consumes="application/json") //@PutMapping 1.指定put请求 2.指定路径 3指定请求Content-Type属性是application/json
public void putrecentTacos(@RequestBody User user) { //@RequestBody 将请求的参数绑定到User对象
//整体更新数据
user.setUsername("gxin");
System.out.println(user.getUsername());
}
消费
@GetMapping(value="Myrecent")
public void Myrecent() { User u = new User();
u.setId(1L);
u.setUsername("keyi");
System.out.println("调用put方法");
temp.put("http://localhost:8080/design/recent", u); } //temp.put没有返回值
3)消费delete端点
被消费的端点
@DeleteMapping(value="/{id}") //@DeleteMapping 1.指定delete请求 2.指定路径3.指定参数占位符
@ResponseStatus(HttpStatus.NO_CONTENT) //由于删除后没有资源返回所有我们返回状态码HttpStatus.NO_CONTENT 204清 晰的表示资源已不存在,而不是返回200仅表示成功
public void patchrecentTacos(@PathVariable("id") Integer id) { //@PathVariable将参数占位符绑定到方法参数上
//根据id删除
System.out.println(id);
}
消费
@GetMapping(value="Mydelete")
public void Mydelete() {
System.out.println("调用delete方法");
temp.delete("http://localhost:8080/design/{id}", 11);
//参数1:路径 参数2:请求的参数 }
//temp.delete没有返回值
4)消费post端点
被消费的端点
@PostMapping(value="recent",consumes="application/json") //@PostMapping 1.指定post请求 2.指定路径 3指定请求Content-Type属性是application/json
@ResponseStatus(HttpStatus.CREATED) //@ResponseStatus当成功时,返回的状态码是201CREATED而不是200,这样描述的更清楚,表示请求不但成功,而且创建了一个资源
public User recentTacos(@RequestBody User user) { //@RequestBody 将请求的参数绑定到User对象
//保存数据
return user; }
消费方法1
@GetMapping(value="MyPost")
public void MyPost() {
User u = new User();
u.setId(1L);
u.setUsername("keyi");
System.out.println("调用put方法");
User postForObject = temp.postForObject("http://localhost:8080/design/recent", u,User.class);
//参数1:路径 ,参数2:post请求参数 ,参数3:返回值class
System.out.println(postForObject.getUsername()); }
消费方法2
@GetMapping(value="MyPost2")
public void MyPost2() {
//整体更新数据 User u = new User();
u.setId(1L);
u.setUsername("keyi");
System.out.println("调用put方法");
ResponseEntity<User> postForEntity = temp.postForEntity("http://localhost:8080/design/recent", u,User.class);
//参数1:路径 ,参数2:post请求参数 ,参数3:返回值class
System.out.println(postForEntity.getBody().getUsername()); }
5)设置连接超时
方法一:配置类,之后直接注入获取RestTemplate实例
@Configuration
public class AppConfig{
@Bean
public RestTemplate customRestTemplate(){
HttpComponentsClientHttpRequestFactory httpRequestFactory = new HttpComponentsClientHttpRequestFactory();
httpRequestFactory.setConnectionRequestTimeout(3000);
httpRequestFactory.setConnectTimeout(3000);
httpRequestFactory.setReadTimeout(3000); return new RestTemplate(httpRequestFactory);
}
}
方法2:配置属性+配置类
属性配置
custom.rest.connection.connection-request-timeout=3000
custom.rest.connection.connect-timeout=3000
custom.rest.connection.read-timeout=3000 配置类
@Configuration
public class AppConfig{
@Bean
@ConfigurationProperties(prefix = "custom.rest.connection")
public HttpComponentsClientHttpRequestFactory customHttpRequestFactory() {
return new HttpComponentsClientHttpRequestFactory();
} @Bean
public RestTemplate customRestTemplate(){
return new RestTemplate(customHttpRequestFactory());
}
}
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
</dependency>
(2)使用Traverson导航超媒体REST API
知道有这个东西就好,不做说明了
@RequestMapping(value="orgdetail/{orgid}") @ResponseBody public Organization findOrgDetail(@PathVariable("orgid") Integer orgid,HttpServletResponse resp) { //获取数据li System.out.println("id=" + orgid); return new Organization(1,"机构" + orgid); }
spring-in-action-day05-REST的更多相关文章
- 1、Spring In Action 4th笔记(1)
Spring In Action 4th笔记(1) 2016-12-28 1.Spring是一个框架,致力于减轻JEE的开发,它有4个特点: 1.1 基于POJO(Plain Ordinary Jav ...
- spring in action 4th --- quick start
读spring in action. 环境搭建 quick-start依赖注入 面向切面 1.环境搭建 jdk1.8 gradle 2.12 Intelij idea 2016.2.1 1.1创建一个 ...
- ssh整合随笔(注解方式,Spring 管理action)
Web.xml<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns:xsi=" ...
- Spring in action记录
最近一段时间重新学习了一遍SPRING,现在对这些笔记整理一下,一来算是对之前的学习有一个交代,二来当是重新学习一次,三来可以留下备份 这次学习中以SPRING IN ACTION 4这学习资料,整书 ...
- Spring in Action 4th 学习笔记 之 AOP
前提:本文中的AOP仅限于Spring AOP. 先说说为什么需要AOP 最简单的一个例子就是日志记录,如果想记录一些方法的执行情况,最笨的办法就是修改每一个需要记录的方法.但这,真的很笨... 好的 ...
- 学习spring in action 第一天
这段时间,开始学习java吧,因为C sharp 学习了java的大量语法格式,所以,留意下,就不会错了,java 有的c sharp也有,而且之前我也学习过java的桌面开发,但是一下子上来就要自己 ...
- spring in action学习笔记十五:配置DispatcherServlet和ContextLoaderListener的几种方式。
在spring in action中论述了:DispatcherServlet和ContextLoaderListener的关系,简言之就是DispatcherServlet是用于加载web层的组件的 ...
- spring in action 学习笔记十四:用纯注解的方式实现spring mvc
在讲用纯注解的方式实现springmvc之前先介绍一个类:AbstractAnnotationDispatcherServletInitializer.这个类的作用是:任何一个类继承AbstractA ...
- spring in action 学习十一:property placeholder Xml方式实现避免注入外部属性硬代码化
这里用到了placeholder特有的一个语言或者将表达形式:${},spring in action 描述如下: In spring wiring ,placeholder values are p ...
- spring in action学习笔记一:DI(Dependency Injection)依赖注入之CI(Constructor Injection)构造器注入
一:这里先说一下DI(Dependency Injection)依赖注入有种表现形式:一种是CI(Constructor Injection)构造方法注入,另一种是SI(Set Injection) ...
随机推荐
- Windows版CheatSheet——一键显示当前程序快捷键列表
Windows系统上的各种软件有太多的快捷键,想要记住是几乎不可能的,推荐一个一键显示当前软件快捷键的软件,在使用其他程序的时候,只要按下Ctrl+`就可以理解弹出该软件的所有快捷键列表,还支持收藏功 ...
- kubernetes_CoreDNS全解析
一.前言 kubernetes CoreDNS 是 kube-system 命令空间里面的一个Pod,用于域名解析. kubernetes自带三个命名空间(用kubeadm安装的Kubernetes集 ...
- 云原生学习笔记-1-docker
一.基础环境说明 1.操作系统:Centos7.6:1master:2node 2.docker版本:docker-ce 19.03.8-3 二.docker安装 1.使用阿里镜像仓库,mirror. ...
- js拓展-Dom与事件,字符串,数组方法,object对象,作用域
js-扩展-Dom与事件 ```text # dom 文档对象模型,document object model ### 获取dom(js中的选择器) js let list=document.getE ...
- 用excel表画一个乐高
一.背景:在商场看到一个超级玛丽的乐高图感觉使用excel的颜色填充也能画出来,并且可以借助python来实现 二.excel表如何绘制正方形:1.统一设置行高与列宽excel表单元格的行与列的默认计 ...
- 【数据库】Postgresql、PG的分区操作:创建、删除指定分区,非分区表转分区表
〇.参考链接 一.为表创建指定分区 -- 表创建分区 参数 表名 分区序列 例如: ltc_customer , 20220915 则创建 ltc_customer_20220915 分区表 CREA ...
- Kettle基础及快速入门
(一)概述 1.ETL ETL(Extract-Transform-Load的缩写,即数据抽取.转换.装载的过程) ETL工具:Sqoop,DataX,Kettle,Talend等 2.Kettle介 ...
- vba + ado +sql 连接数据库的常用操作方式
vba + ado +sql 连接Access.MySQL.Oracle Private Sub Connection_DBA() '********************************* ...
- troubleshoot:PVC动态扩容报错
目录 一.问题描述 二.解决方法 一.问题描述 动态扩容PVC的时候报错(kubectl edit pvc pvcname):"error: persistentvolumeclaims & ...
- PTA散列表平方探测法解决冲突
PTA散列表平方探测法解决冲突 核心问题 当所有的位置都被填上了,且不能插入关键词,要进入死循环了怎么办? 题目 本题的任务很简单:将给定的无重复正整数序列插入一个散列表,输出每个输入的数字在 ...