Spring 4 创建REST API
什么是REST
- 全称:表述性状态转移 (Representational State Transfer), 将资源的状态以最适合客户端或服务端的形式从服务器端转移到客户端(或者反过来)。
- 面向资源,而不是面向行为
- 资源通过URL进行识别和定位,
- 一般URL中都使用名词,不使用动词
- 对资源采取的行为使用HTTP方法来定义,如GET, POST, DELETE, PUT
Spring MVC REST API示例
以用户增删改查为例,设计 REST API.
这里,我们主要关注Spring Mvc中的Controller的设计:
UserController类:
@RestController
@RequestMapping(value = "/users")
public class UserController extends BaseController
{
@Autowired
private IUserService userService;
...
}
这里使用了@RestController注解,Spring将会为该Controller的所有处理方法应用消息转换功能,因此我们可以不必为每个方法都添加@ResponseBody。
Spring支持多种资源表述形式(JSON/XML/HTML...),不过一般使用JSON形式。
查询所有用户
对应请求的URL示例(无分页):http://localhost:8080/webbf/users
对应的URL示例(有分页):http://localhost:8080/webbf/users?offset=0&limit=10
使用的HTTP方法:GET
如果查询不到用户,返回状态码204,No Content
否则,返回状态码200, OK,返回的数据类型为 application/json;charset=utf-8
@RequestMapping(method = RequestMethod.GET, produces = "application/json; charset=utf-8")
public ResponseEntity<List<User>> getUserList(
@RequestParam(value = "offset", defaultValue = "0") long offset,
@RequestParam(value = "limit", defaultValue = MAX_LONG_AS_STRING) long limit)
{
Map<String, Object> param = new HashMap<String, Object>();
param.put("offset", offset);
param.put("limit", limit);
List<User> userList = userService.query(param);
if (userList.size() == 0)
{
return new ResponseEntity<List<User>>(HttpStatus.NO_CONTENT);
}
return new ResponseEntity<List<User>>(userList, HttpStatus.OK);
}
查询单个用户
对应请求的URL示例:http://localhost:8080/webbf/users/1
使用的HTTP方法:GET
如果查询不到用户,返回状态码404,Not Found
否则,返回状态码200, OK,返回的数据类型为 application/json;charset=utf-8
@RequestMapping(value = "/{id}", method = RequestMethod.GET, produces = "application/json; charset=utf-8")
public ResponseEntity<User> getUserById(@PathVariable Long id)
{ User user = userService.findById(id);
if (user == null)
{
return new ResponseEntity<User>(HttpStatus.NOT_FOUND);
}
return new ResponseEntity<User>(userService.findById(id), HttpStatus.OK);
}
删除用户
对应请求的URL示例:http://localhost:8080/webbf/users/1
使用的HTTP方法:DELETE
如果查询不到被删除的用户,返回状态码404,Not Found
否则,删除成功,返回状态码204, No Content
@RequestMapping(value = "/{id}", method = RequestMethod.DELETE, produces = "application/json; charset=utf-8")
public ResponseEntity<User> deleteUser(@PathVariable Long id)
{
User user = userService.findById(id);
if (user == null)
{
return new ResponseEntity<User>(HttpStatus.NOT_FOUND);
}
userService.deleteUser(id);
return new ResponseEntity<User>(HttpStatus.NO_CONTENT);
}
保存用户
对应请求的URL示例:http://localhost:8080/webbf/users
请求体:
{
"name":"1",
"address":"aa"
}
Content-Type: application/json
使用的HTTP方法:POST
响应的body为新创建的用户;
响应头的Location:http://localhost:8080/webbf/users/60
//如果用户已存在,返回状态码,409, Conflict
保存成功,返回状态码201, Created,返回的数据类型为 application/json;charset=utf-8
@RequestMapping(method = RequestMethod.POST, consumes = "application/json; charset=utf-8")
public ResponseEntity<User> saveUser(@RequestBody User user, UriComponentsBuilder ucb)
{ // if (userService.isUserExist(user)) {
// System.out.println("A User with name " + user.getName() +
// " already exist");
// return new ResponseEntity<User>(user, HttpStatus.CONFLICT);
// }
User saved = userService.saveUser(user); HttpHeaders headers = new HttpHeaders();
URI locationUri = ucb.path("/users/").path(String.valueOf(saved.getId())).build().toUri();
headers.setLocation(locationUri); ResponseEntity<User> responseEntity = new ResponseEntity<User>(saved, headers,
HttpStatus.CREATED);
return responseEntity;
}
修改用户
对应请求的URL示例:http://localhost:8080/webbf/users/1
请求体:
{
"name":"1",
"address":"aa"
}
Content-Type: application/json
使用的HTTP方法:PUT
响应的body为新创建的用户;
如果查询不到被修改的用户,返回状态码404,Not Found
保存成功,返回状态码201, Created,返回的数据类型为 application/json;charset=utf-8
@RequestMapping(value = "/{id}", method = RequestMethod.PUT, consumes = "application/json; charset=utf-8")
public ResponseEntity<User> updateUser(@PathVariable("id") long id, @RequestBody User user)
{
User currentUser = userService.findById(id); if (currentUser == null)
{
return new ResponseEntity<User>(HttpStatus.NOT_FOUND);
} currentUser.setId(id);
currentUser.setName(user.getName());
currentUser.setAddress(user.getAddress()); userService.updateUser(currentUser);
return new ResponseEntity<User>(currentUser, HttpStatus.OK);
}
异常处理
请求中发生异常,返回500 Internal Server Error。
@ExceptionHandler(Exception.class)
@ResponseBody
public ResponseEntity<Exception> handleException(HttpServletRequest request, Exception e)
{
logger.error("Request FAILD, URL = {} method = {}", request.getRequestURI(), request.getMethod());
logger.error(e.toString(), e);
return new ResponseEntity<Exception>(e, HttpStatus.INTERNAL_SERVER_ERROR);
}
前端测试工具
因为我喜欢用fireFox, 所以我用restclient测试工具测试 REST API:
chrom的话,可以使用Postman。
修改用户测试
新增用户测试
查询单个用户
前端AJAX调用 REST API 示例
查询用户
$.ajax({
async: false,
type : "get",
url : "/webbf/users",
data: {},
datatype : 'json', success : function(data,textStatus) {
this.trigger({userList:data});
}.bind(this), error: function(jqXHR, textStatus, errorThrown) {
alert(jqXHR.status + ' ' + jqXHR.responseText);
} });
删除用户
$.ajax({
async: false,
type : "delete",
url : "/webbf/users/" + userId,
data: {},
datatype : 'json',
success : function(data) { alert("删除成功");
this.getAllUser(); }.bind(this), error: function(jqXHR, textStatus, errorThrown) {
alert(jqXHR.status + ' ' + jqXHR.responseText);
}
});
新增用户
$.ajax({
async: false,
contentType: "application/json; charset=utf-8",
type : "post",
url : "/webbf/users",
data: JSON.stringify({name:userName,address:address}),
datatype : 'json',
success : function(data) { alert("操作成功");
this.openAddModal(false);
this.getAllUser(); }.bind(this), error: function(jqXHR, textStatus, errorThrown) {
alert(jqXHR.status + ' ' + jqXHR.responseText);
}
});
参考资料
Spring in action 4
Spring 4 创建REST API的更多相关文章
- 使用Spring MVC创建 REST API
1.REST的基础知识 当谈论REST时,有一种常见的错误就是将其视为“基于URL的Web服务”——将REST作为另一种类型的远程过程调用(remote procedurecall,RPC)机制,就像 ...
- 第16章-使用Spring MVC创建REST API
1 了解REST 1.1 REST的基础知识 REST与RPC几乎没有任何关系.RPC是面向服务的,并关注于行为和动作:而REST是面向资源的,强调描述应用程序的事物和名词. 为了理解REST是什么, ...
- 利用spring boot创建java app
利用spring boot创建java app 背景 在使用spring框架开发的过程中,随着功能以及业务逻辑的日益复杂,应用伴随着大量的XML配置和复杂的bean依赖关系,特别是在使用mvc的时候各 ...
- Spring Boot 处理 REST API 错误的正确姿势
摘要:如何正确的处理API的返回信息,让返回的错误信息提供更多的含义是一个非常值得做的功能.默认一般返回的都是难以理解的堆栈信息,然而这些信息也许对于API的客户端来说有可能并没有多大用途,并没有多大 ...
- spring如何创建RESTful Service
REST REST,是指REpresentational State Transfer,有个精辟的解释什么是RESTful, 看url就知道要什么 看method就知道干什么 看status code ...
- 使用Spring MVC开发RESTful API
第3章 使用Spring MVC开发RESTful API Restful简介 第一印象 左侧是传统写法,右侧是RESTful写法 用url描述资源,而不是行为 用http方法描述行为,使用http状 ...
- Spring mvc创建的web项目,如何获知其web的项目名称,访问具体的链接地址?
Spring mvc创建的web项目,如何获知其web的项目名称,访问具体的链接地址? 访问URL: http://localhost:8090/firstapp/login 在eclipse集成的 ...
- ASP.NET 5系列教程 (六): 在 MVC6 中创建 Web API
ASP.NET 5.0 的主要目标之一是统一MVC 和 Web API 框架应用. 接下来几篇文章中您会了解以下内容: ASP.NET MVC 6 中创建简单的web API. 如何从空的项目模板中启 ...
- spring cloud教程之使用spring boot创建一个应用
<7天学会spring cloud>第一天,熟悉spring boot,并使用spring boot创建一个应用. Spring Boot是Spring团队推出的新框架,它所使用的核心技术 ...
随机推荐
- 转 10 个最佳的 Node.js 的 MVC 框架
10 个最佳的 Node.js 的 MVC 框架 oschina 发布于: 2014年02月24日 (33评) 分享到: 收藏 +322 Node.js 是一个基于Chrome JavaScri ...
- 跟我一起ggplot2(1)
ggplot2 R的作图工具包,可以使用非常简单的语句实现非常复杂漂亮的效果. qplot 加载qplot library(ggplot2) # 测试数据集,ggplot2内置的钻石数据 qplot( ...
- ABP源码分析八:Logger集成
ABP使用Castle日志记录工具,并且可以使用不同的日志类库,比如:Log4Net, NLog, Serilog... 等等.对于所有的日志类库,Castle提供了一个通用的接口来实现,我们可以很方 ...
- 定时管理器框架-Task.MainForm
入住博客园4年多了,一直都是看别人的博客,学习别人的知识,为各个默默无私贡献自己技术总结的朋友们顶一个:这几天突然觉得是时候加入该队列中,贡献出自己微弱的力量,努力做到每个月有不同学习总结,知识学习的 ...
- C#字符串的倒序输出
介绍 在本文中,我将演示如何将字符串的单词倒序输出.在这里我不是要将“John” 这样的字符串倒序为成“nhoJ”,.这是不一样的,因为它完全倒序了整个字符串.而以下代码将教你如何将“你 好 我是 缇 ...
- Unity3D中使用委托和事件
前言: 本来早就想写写和代码设计相关的东西了,以前做2DX的时候就有过写写观察者设计模式的想法,但是实践不多.现在转到U3D的怀抱中,倒是接触了不少委托事件的写法,那干脆就在此总结一下吧. 1.C#中 ...
- docker对数据卷进行还原操作
转载请注明出处 数据卷容器备份数据后,备份数据查看 http://www.cnblogs.com/zhuxiaojie/p/5947138.html 我们可能要把这个备份的数据,还原到另一台的do ...
- git 出错误“值对于Uint32太大或太小”
提交git代码的时候报的错误 这是因为修改的东西太少的原因,应该多修改一些就可以提交了 例如:只是删除了一个空格或者一个字符就提交git代码的话就会提示这个错误 解决方法:多多的改变一下代码,比如增加 ...
- C# 本质论 第二章 数据类型
浮点数的精度由有效数字的个数决定.除非用分数表示时,分母恰好是2的整数次幂,否则用二进制浮点类型无法准确地表示该数(0.1,表示成分数是1/10,分母10不能用有限二进制表示),二进制浮点类型无法准确 ...
- 修复 Visual Studio Error “No exports were found that match the constraint”
清空Visual Studio 文件缓存目录 Just delete or rename this folder: %AppData%\..\Local\Microsoft\VisualStudio\ ...