springboot接收多对象_实战：SpringBootRestfulAPI构建示例

优质文章&＃xff0c;及时送达

作者 | liuxiaopeng

链接 | cnblogs.com/paddix/p/8215245.html

在现在的开发流程中&＃xff0c;为了最大程度实现前后端的分离&＃xff0c;通常后端接口只提供数据接口&＃xff0c;由前端通过Ajax请求从后端获取数据并进行渲染再展示给用户。我们用的最多的方式就是后端会返回给前端一个JSON字符串&＃xff0c;前端解析JSON字符串生成Javascript的对象&＃xff0c;然后再做处理。

本文就来演示一下Spring boot如何实现这种模式&＃xff0c;本文重点会讲解如何设计一个Restful的API&＃xff0c;并通过Spring boot来实现相关的API。

不过&＃xff0c;为了大家更好的了解Restful风格的API&＃xff0c;我们先设计一个传统的数据返回接口&＃xff0c;这样大家可以对比着来理解。

我们这里以文章列表为例&＃xff0c;实现一个返回文章列表的接口&＃xff0c;代码如下&＃xff1a;

&＃64;Controller
&＃64;RequestMapping("/article")
publicclassArticleController{

&＃64;Autowired
private ArticleService articleService;

&＃64;RequestMapping("/list.json")
&＃64;ResponseBody
public List listArticles(String title, Integer pageSize, Integer pageNum) {
if (pageSize &＃61;&＃61; ) {
pageSize &＃61; 10;
}
if (pageNum &＃61;&＃61; ) {
pageNum &＃61; 1;
}
int offset &＃61; (pageNum - 1) * pageSize;
return articleService.getArticles(title, 1L, offset, pageSize);
}
}

这个ArticleService的实现很简单&＃xff0c;就是简单的封装了ArticleMapper的操作&＃xff0c;ArticleService的实现类如下&＃xff1a;

&＃64;Service
publicclassArticleServiceImplimplementsArticleService{

&＃64;Autowired
private ArticleMapper articleMapper;

&＃64;Override
public Long saveArticle(&＃64;RequestBody Article article) {
return articleMapper.insertArticle(article);
}

&＃64;Override
public List getArticles(String title,Long userId,int offset,int pageSize) {
Article article &＃61; new Article;
article.setTitle(title);
article.setUserId(userId);
return articleMapper.queryArticlesByPage(article,offset,pageSize);
}

&＃64;Override
public Article getById(Long id) {
return articleMapper.queryById(id);
}

&＃64;Override
publicvoidupdateArticle(Article article) {
article.setUpdateTime(new Date);
articleMapper.updateArticleById(article);
}
}

运行Application.java这个类&＃xff0c;然后访问&＃xff1a;http://locahost:8080/article/list.json&＃xff0c;就可以看到如下的结果&＃xff1a;

ArticleServiceImpl这个类是一个很普通的类&＃xff0c;只有一个Spring的注解&＃64;Service&＃xff0c;标识为一个bean以便于通过Spring IoC容器来管理。我们再来看看ArticleController这个类&＃xff0c;其实用过Spring MVC的人应该都熟悉这几个注解&＃xff0c;这里简单解释一下&＃xff1a;

• &＃64;Controller 标识一个类为控制器。

• &＃64;RequestMapping URL的映射。

• &＃64;ResponseBody 返回结果转换为JSON字符串。

• &＃64;RequestBody 表示接收JSON格式字符串参数。

通过这个三个注解&＃xff0c;我们就能轻松的实现通过URL给前端返回JSON格式数据的功能。不过大家肯定有点疑惑&＃xff0c;这不都是Spring MVC的东西吗&＃xff1f;跟Spring boot有什么关系&＃xff1f;

其实Spring boot的作用就是为我们省去了配置的过程&＃xff0c;其他功能确实都是Spring与Spring MVC来为我们提供的&＃xff0c;大家应该记得Spring boot通过各种starter来为我们提供自动配置的服务&＃xff0c;我们的工程里面之前引入过这个依赖&＃xff1a;

org.springframework.boot
spring-boot-starter-web

这个是所有Spring boot的web工程都需要引入的jar包&＃xff0c;也就是说只要是Spring boot的web的工程&＃xff0c;都默认支持上述的功能。这里我们进一步发现&＃xff0c;通过Spring boot来开发web工程&＃xff0c;确实为我们省了许多配置的工作。

好了&＃xff0c;我们现在再来看看如何实现Restful API。实际上Restful本身不是一项什么高深的技术&＃xff0c;而只是一种编程风格&＃xff0c;或者说是一种设计风格。

在传统的http接口设计中&＃xff0c;我们一般只使用了get和post两个方法&＃xff0c;然后用我们自己定义的词汇来表示不同的操作&＃xff0c;比如上面查询文章的接口&＃xff0c;我们定义了article/list.json来表示查询文章列表&＃xff0c;可以通过get或者post方法来访问。而Restful API的设计则通过HTTP的方法来表示CRUD相关的操作。

因此&＃xff0c;除了get和post方法外&＃xff0c;还会用到其他的HTTP方法&＃xff0c;如PUT、DELETE、HEAD等&＃xff0c;通过不同的HTTP方法来表示不同含义的操作。下面是我设计的一组对文章的增删改查的Restful API&＃xff1a;

这里可以看出&＃xff0c;URL仅仅是标识资源的路劲&＃xff0c;而具体的行为由HTTP方法来指定。

现在我们再来看看如何实现上面的接口&＃xff0c;其他就不多说&＃xff0c;直接看代码&＃xff1a;

&＃64;RestController
&＃64;RequestMapping("/rest")
public class ArticleRestController {

&＃64;Autowired
private ArticleService articleService;

&＃64;RequestMapping(value &＃61; "/article