请选择 进入手机版 | 继续访问电脑版
本站特色:极好的技术研究氛围!所有技术交流,必有回复!

疯狂Java联盟

 找回密码
 加入联盟
查看: 222|回复: 1

构建RESTful API

[复制链接]
发表于 2018-7-10 16:37:23 | 显示全部楼层 |阅读模式
本帖最后由 IT侠客 于 2018-7-10 16:38 编辑

首先,回顾并详细说明一下在快速入门中使用的@Controller、@RestController、@RequestMapping注解。如果您对Spring MVC不熟悉并且还没有尝试过快速入门案例,建议先看一下快速入门的内容。

  • @Controller:修饰class,用来创建处理http请求的对象
  • @RestController:Spring4之后加入的注解,原来在@Controller中返回json需要@ResponseBody来配合,如果直接用@RestController替代@Controller就不需要再配置@ResponseBody,默认返回json格式。
  • @RequestMapping:配置url映射

下面我们尝试使用Spring MVC来实现一组对User对象操作的RESTful API,配合注释详细说明在Spring MVC中如何映射HTTP请求、如何传参、如何编写单元测试。

RESTful API具体设计如下:

请求类型.png

User实体定义:

  1. public class User {

  2.     private Long id;
  3.     private String name;
  4.     private Integer age;

  5.     // 省略setter和getter
  6.      
  7. }
复制代码

实现对User对象的操作接口

  1. @RestController
  2. @RequestMapping(value="/users")     // 通过这里配置使下面的映射都在/users下
  3. public class UserController {

  4.     // 创建线程安全的Map
  5.     static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>());

  6.     @RequestMapping(value="/", method=RequestMethod.GET)
  7.     public List<User> getUserList() {
  8.         // 处理"/users/"的GET请求,用来获取用户列表
  9.         // 还可以通过@RequestParam从页面中传递参数来进行查询条件或者翻页信息的传递
  10.         List<User> r = new ArrayList<User>(users.values());
  11.         return r;
  12.     }

  13.     @RequestMapping(value="/", method=RequestMethod.POST)
  14.     public String postUser(@ModelAttribute User user) {
  15.         // 处理"/users/"的POST请求,用来创建User
  16.         // 除了@ModelAttribute绑定参数之外,还可以通过@RequestParam从页面中传递参数
  17.         users.put(user.getId(), user);
  18.         return "success";
  19.     }

  20.     @RequestMapping(value="/{id}", method=RequestMethod.GET)
  21.     public User getUser(@PathVariable Long id) {
  22.         // 处理"/users/{id}"的GET请求,用来获取url中id值的User信息
  23.         // url中的id可通过@PathVariable绑定到函数的参数中
  24.         return users.get(id);
  25.     }

  26.     @RequestMapping(value="/{id}", method=RequestMethod.PUT)
  27.     public String putUser(@PathVariable Long id, @ModelAttribute User user) {
  28.         // 处理"/users/{id}"的PUT请求,用来更新User信息
  29.         User u = users.get(id);
  30.         u.setName(user.getName());
  31.         u.setAge(user.getAge());
  32.         users.put(id, u);
  33.         return "success";
  34.     }

  35.     @RequestMapping(value="/{id}", method=RequestMethod.DELETE)
  36.     public String deleteUser(@PathVariable Long id) {
  37.         // 处理"/users/{id}"的DELETE请求,用来删除User
  38.         users.remove(id);
  39.         return "success";
  40.     }

  41. }
复制代码
 楼主| 发表于 2018-7-10 16:39:00 | 显示全部楼层
喜欢文章的朋友可以持续关注内容更新
您需要登录后才可以回帖 登录 | 加入联盟

本版积分规则

小黑屋|手机版|Archiver|疯狂Java联盟 ( 粤ICP备11094030号 )

GMT+8, 2018-11-21 11:56 , Processed in 0.139289 second(s), 8 queries , File On.

快速回复 返回顶部 返回列表