REST风格案例
案例代码「Maven项目」下载
1 REST简介
1.1 REST介绍
- REST(Representational State Transfer),表现形式状态转换
- 传统风格资源描述形式
http://localhost/user/getById?id=1
http://localhost/user/saveUser - REST风格描述形式
http://localhost/user/1
http://localhost/user
- 传统风格资源描述形式
- 优点:
- 隐藏资源的访问行为,无法通过地址得知对资源是何种操作
- 书写简化
1.2 RESTful介绍
- 按照REST风格访问资源时使用行为动作区分对资源进行了何种操作
http://localhost/books 「GET」查询全部书目信息 (查询)
http://localhost/books/1 「GET」查询指定书目信息(查询)
http://localhost/books 「POST」添加书目信息(新增/保存)
http://localhost/books 「PUT」修改书目信息(修改/更新)
http://localhost/books/1 「DELETE」删除书目信息(删除) - 根据REST风格对资源进行访问称为RESTful
2 RESTful入门案例
问题导入
Rest风格如何通过路径传递参数?
2.1 快速入门
做法:在Controller中定义方法时设定"http请求动作(请求方式)“和"设定请求参数(路径变量)”
@Controller
public class UserController {
//设置当前请求方法为POST,表示REST风格中的添加操作
@RequestMapping(value = "/users",method = RequestMethod.POST)
@ResponseBody
public String save(){
System.out.println("user save...");
return "{'module':'user save'}";
}
//设置当前请求方法为DELETE,表示REST风格中的删除操作
//@PathVariable注解用于设置路径变量(路径参数),要求路径上设置对应的占位符,并且占位符名称与方法形参名称相同
@RequestMapping(value = "/users/{id}",method = RequestMethod.DELETE)
@ResponseBody
public String delete(@PathVariable Integer id){
System.out.println("user delete..." + id);
return "{'module':'user delete'}";
}
//设置当前请求方法为PUT,表示REST风格中的修改操作
@RequestMapping(value = "/users",method = RequestMethod.PUT)
@ResponseBody
public String update(@RequestBody User user){
System.out.println("user update..."+user);
return "{'module':'user update'}";
}
//设置当前请求方法为GET,表示REST风格中的查询操作
//@PathVariable注解用于设置路径变量(路径参数),要求路径上设置对应的占位符,并且占位符名称与方法形参名称相同
@RequestMapping(value = "/users/{id}" ,method = RequestMethod.GET)
@ResponseBody
public String getById(@PathVariable Integer id){
System.out.println("user getById..."+id);
return "{'module':'user getById'}";
}
//设置当前请求方法为GET,表示REST风格中的查询操作
@RequestMapping(value = "/users",method = RequestMethod.GET)
@ResponseBody
public String getAll(){
System.out.println("user getAll...");
return "{'module':'user getAll'}";
}
}
2.2 @PathVariable介绍
- 名称:@PathVariable
- 类型:形参注解
- 位置:SpringMVC控制器方法形参定义前面
- 作用:绑定路径参数与处理器方法形参间的关系,要求路径参数名与形参名一一对应

2.3 @RequestBody、@RequestParam、@PathVariable区别和应用
- 区别
@RequestParam用于接收url地址传参或表单传参
@RequestBody用于接收json数据
@PathVariable用于接收路径参数,使用{参数名称}描述路径参数 - 应用
后期开发中,发送请求参数超过1个时,以json格式为主,@RequestBody应用较广
如果发送非json格式数据,选用@RequestParam接收请求参数
采用RESTful进行开发,当参数数量较少时,例如1个,可以采用@PathVariable接收请求路径变量,通常用于传递id值
3 REST快速开发【重点】
3.1 代码中的问题

以上截图中的代码和我们之前写的UserController中的方法类似,其中图中两个方法都有三处是有问题的,可以进行优化。存在的问题如下:
问题1:每个方法的@RequestMapping注解中都定义了访问路径/books,重复性太高。
问题2:每个方法的@RequestMapping注解中都要使用method属性定义请求方式,重复性太高。
问题3:每个方法响应json都需要加上@ResponseBody注解,重复性太高。
3.2 Rest快速开发
解决以上三个问题
解决问题1:在Controller类上使用@RequestMapping定义共同的访问路径。
@Controller
@RequestMapping("/books")
public class BookController {
@RequestMapping(method = RequestMethod.POST)
public String save(@RequestBody Book book){
System.out.println("book save..." + book);
return "{'module':'book save'}";
}
@RequestMapping(value = "/{id}" ,method = RequestMethod.DELETE)
public String delete(@PathVariable Integer id){
System.out.println("book delete..." + id);
return "{'module':'book delete'}";
}
@RequestMapping(method = RequestMethod.PUT)
public String update(@RequestBody Book book){
System.out.println("book update..."+book);
return "{'module':'book update'}";
}
@RequestMapping(value = "/{id}" ,method = RequestMethod.GET)
public String getById(@PathVariable Integer id){
System.out.println("book getById..."+id);
return "{'module':'book getById'}";
}
@RequestMapping(method = RequestMethod.GET)
public String getAll(){
System.out.println("book getAll...");
return "{'module':'book getAll'}";
}
}
解决问题2:使用@GetMapping @PostMapping @PutMapping @DeleteMapping代替@RequestMapping(method=RequestMethod.XXX)
@Controller
@RequestMapping("/books")
public class BookController {
// @RequestMapping( method = RequestMethod.POST)
@PostMapping//使用@PostMapping简化Post请求方法对应的映射配置
public String save(@RequestBody Book book){
System.out.println("book save..." + book);
return "{'module':'book save'}";
}
// @RequestMapping(value = "/{id}" ,method = RequestMethod.DELETE)
@DeleteMapping("/{id}") //使用@DeleteMapping简化DELETE请求方法对应的映射配置
public String delete(@PathVariable Integer id){
System.out.println("book delete..." + id);
return "{'module':'book delete'}";
}
// @RequestMapping(method = RequestMethod.PUT)
@PutMapping //使用@PutMapping简化Put请求方法对应的映射配置
public String update(@RequestBody Book book){
System.out.println("book update..."+book);
return "{'module':'book update'}";
}
// @RequestMapping(value = "/{id}" ,method = RequestMethod.GET)
@GetMapping("/{id}") //使用@GetMapping简化GET请求方法对应的映射配置
public String getById(@PathVariable Integer id){
System.out.println("book getById..."+id);
return "{'module':'book getById'}";
}
// @RequestMapping(method = RequestMethod.GET)
@GetMapping //使用@GetMapping简化GET请求方法对应的映射配置
public String getAll(){
System.out.println("book getAll...");
return "{'module':'book getAll'}";
}
}
- 名称:@GetMapping @PostMapping @PutMapping @DeleteMapping
- 类型:方法注解
- 位置:基于SpringMVC的RESTful开发控制器方法定义上方
- 作用:设置当前控制器方法请求访问路径与请求动作,每种对应一个请求动作,例如@GetMapping对应GET请求
- 属性:
value(默认):请求访问路径
解决问题3:在Controller类上使用@RestController注解,等同于@Controller与@ResponseBody两个注解组合功能
@RestController //使用@RestController注解替换@Controller与@ResponseBody注解,简化书写
@RequestMapping("/books")
public class BookController {
//方法省略了没写
}
- 名称:@RestController
- 类型:类注解
- 位置:基于SpringMVC的RESTful开发控制器类定义上方
- 作用:设置当前控制器类为RESTful风格,等同于@Controller与@ResponseBody两个注解组合功能
4.添加虚拟数据
@RestController
@RequestMapping("/books")
public class BookController {
private List<Book> books = new ArrayList<>();
private int MAX_index = 3;
{
books.add(new Book(1,"计算机","springMVC入门","小试牛刀"));
books.add(new Book(2,"计算机","springMVC实战","一代宗师"));
books.add(new Book(3,"计算机丛书","springMVC进阶","一代宗师呕心创作"));
}
@GetMapping
public List<Book> findAll(){
return books;
}
@PostMapping
public String save(@RequestBody Book book){
books.add(book);
return "添加成功!";
}
@PutMapping
public String upadte(@RequestBody Book book){
for (int i = 0; i < books.size(); i++) {
if(books.get(i).getId() == book.getId()){
books.set(i,book);
break;
}
}
return "修改成功";
}
@DeleteMapping("/{id}")
public String delete(@PathVariable Integer id){
for (int i = 0; i < books.size(); i++) {
if(books.get(i).getId() == id){
books.remove(i);
break;
}
}
return "删除成功!";
}
@GetMapping("/{id}")
public Book findById(@PathVariable Integer id){
return books.stream().filter(book -> book.getId() == id).findFirst().get();
}
}
案例测试
idea导入文件 file -> open -> 选择Postman文件中的pom.xml打开
1.配置Tomcat

2.部署项目


3.设置项目路径

4.运行项目

5.测试
查询全部

查询单个

添加

修改

删除

7067

被折叠的 条评论
为什么被折叠?



