前言:
springmvc对注解的支持非常灵活和飘逸, 也得web编程少了以往很大一坨配置项. 另一方面移动互联网的到来, 使得REST API变得流行, 甚至成为主流. 因此我们来关注下springmvc对rest api的支持程度, 以及需要做的工作评估.
样例设计和准备:
springmvc学习笔记系列的文章目录:
• idea创建springmvc项目
REST API的设计原则遵循之前的博文来实现
• 移动互联网实战--Web Restful API设计和基础架构
初步设计一个查询系统, 通过userid, 返回该用户的详细信息.
请求url:
http://{host}:{port}/rest/demo/query_user_by_id?user_id={user_id}
响应结果:
{
success:true,
errCode:0,
errMsg:"OK",
value:{
username:"lilei",
userId:"1001",
age:18
}
}
样例中, 请求参数扁平化(HTTP request params), 结果采用JSON来组织.
编程:
按之前博文"idea创建springmvc项目"创建springmvc项目.
先在mvc-dispatcher-servlet.xml中, 添加如下项
<context:annotation-config>
<mvc:annotation-driven />
注: 支持各类注解类, 如ResponseBody, RequestBody, JSON/XMl转化.
添加实体类TResult和UserInfo类.
TResult类设计如下:
public class TResult<T> {
private boolean success = false;
private int errCode = 0;
private String errMsg = "OK";
private T value = null;
}
注: 这边省略了各个属性成员的getter和setter, 需要补上.
UserInfo类的定义如下:
public class UserInfo {
private String userId;
private String username;
private int age;
}
注: 这边省略了各个属性成员的getter和setter, 需要补上.
编写自定义的Controller类RestController.
@Controller
@RequestMapping(value = "/rest/demo")
public class RestController {
@RequestMapping(value="/query_user_by_id", method=RequestMethod.GET)
public @ResponseBody TResult<UserInfo> queryUserById(@RequestParam(value="user_id") String userId) {
TResult<UserInfo> result = new TResult<UserInfo>();
UserInfo userInfo = new UserInfo();
userInfo.setUserId(userId);
userInfo.setUsername("李雷");
userInfo.setAge(18);
result.setValue(userInfo);
result.setSuccess(true);
return result;
}
}
定义了queryUesrById的方法, 返回实体TResult<UserInfo>, 指定注解@ResponseBody, SpringMVC会帮助将其默认转化为JSON格式.
测试和迭代:
在浏览器中, 输入http://127.0.0.1:8080/rest/demo/query_user_by_id?user_id=1001, 结果如下所示:
出现了http status 406(Not Acceptable)的错误.
网上搜了一圈后, 尝试各种灵丹妙药后, 大多不灵光. 究其原因, springmvc的版本不一致.
由于我的springmvc为4.1.1, 则依照博文"Spring WebMVC 4.1返回json时导致的 406(Not Acceptable)问题"的说法, 添加fasterxml的jackson包即可解决.
在pom.xml中, 添加如下依赖项:
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.5.4</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.5.4</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.5.1</version>
</dependency>
重新部署, 再次测试, 这次正常了.
该案例就正式通过了, 值得庆幸.
问题汇总:
web开发中, 最让人头痛的就是中文乱码问题了, 所幸这次没有碰到. 不过居安思危, 防范于未然. 这边也总结下.
若返回的JSON字符串中有中文乱码, 可以在@RequestMapping中, 添加项 produces = "application/json;charset=UTF-8", 构成如下形式:
@RequestMapping(value="/query_user_by_id", method=RequestMethod.GET, produces = "application/json;charset=UTF-8")
当然也可能是字符编码本身非UTF-8导致, 比如编辑器的文字编码为GBK时, 你按UTF-8返回, 就有可能乱码.
这可以通过神器idea的右下角编码类型来修改.
对于JAVA实体类转化为JSON格式, 需要该JAVA的POJO类, 需要完备该类的getter/setter方法. 避免莫名其妙的情况.
总结:
springmvc编写REST API确实方便, 特别是注解类的大量使用, 使得配置精简, 编码灵活. 后续如果有机会, 尝试测试一下springmvc整体的QPS, 看看其作为接入层, 整体的服务能力是多少, 以及如何优化.
写在最后：
如果你觉得这篇文章对你有帮助, 请小小打赏下. 其实我想试试, 看看写博客能否给自己带来一点小小的收益. 无论多少, 都是对楼主一种由衷的肯定.