Spring Boot实战：Restful API的构建

在现在的开发流程中，为了最大程度实现前后端的分离，通常后端接口只提供数据接口，由前端通过Ajax请求从后端获取数据并进行渲染再展示给用户。我们用的最多的方式就是后端会返回给前端一个JSON字符串，前端解析JSON字符串生成JavaScript的对象，然后再做处理。本文就来演示一下Spring boot如何实现这种模式，本文重点会讲解如何设计一个Restful的API，并通过Spring boot来实现相关的API。不过，为了大家更好的了解Restful风格的API，我们先设计一个传统的数据返回接口，这样大家可以对比着来理解。

一、非Restful接口的支持

我们这里以文章列表为例，实现一个返回文章列表的接口，代码如下：

@Controller
@RequestMapping("/article")
public class ArticleController {

@Autowired
private ArticleService articleService;

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

}
　　这个ArticleService的实现很简单，就是简单的封装了ArticleMapper的操作，ArticleMapper的内容大家可以参考上一篇的文章，ArticleService的实现类如下：

@Service
public class ArticleServiceImpl implements ArticleService {

@Autowired
private ArticleMapper articleMapper;

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

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

@Override
public Article getById(Long id) {
    return articleMapper.queryById(id);
}

@Override
public void updateArticle(Article article) {
    article.setUpdateTime(new Date());
    articleMapper.updateArticleById(article);
}

}
　　运行Application.java这个类，然后访问：http://locahost:8080/article/list.json，就可以看到如下的结果：

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

@Controller 标识一个类为控制器。

@RequestMapping URL的映射。

@ResponseBody 返回结果转换为JSON字符串。

@RequestBody 表示接收JSON格式字符串参数。

通过这个三个注解，我们就能轻松的实现通过URL给前端返回JSON格式数据的功能。不过大家肯定有点疑惑，这不都是Spring MVC的东西吗？跟Spring boot有什么关系？其实Spring boot的作用就是为我们省去了配置的过程，其他功能确实都是Spring与Spring MVC来为我们提供的，大家应该记得Spring boot通过各种starter来为我们提供自动配置的服务，我们的工程里面之前引入过这个依赖：

1
2
3
4

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

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

二、Restful API设计

好了，我们现在再来看看如何实现Restful API。实际上Restful本身不是一项什么高深的技术，而只是一种编程风格，或者说是一种设计风格。在传统的http接口设计中，我们一般只使用了get和post两个方法，然后用我们自己定义的词汇来表示不同的操作，比如上面查询文章的接口，我们定义了article/list.json来表示查询文章列表，可以通过get或者post方法来访问。而Restful API的设计则通过HTTP的方法来表示CRUD相关的操作。因此，除了get和post方法外，还会用到其他的HTTP方法，如PUT、DELETE、HEAD等，通过不同的HTTP方法来表示不同含义的操作。下面是我设计的一组对文章的增删改查的Restful API：

接口URL HTTP方法 接口说明
/article POST 保存文章
/article/{id} GET 查询文章列表
/article/{id} DELETE 删除文章
/article/{id} PUT 更新文章信息
　　这里可以看出，URL仅仅是标识资源的路劲，而具体的行为由HTTP方法来指定。

三、Restful API实现

现在我们再来看看如何实现上面的接口，其他就不多说，直接看代码：

@RestController
@RequestMapping("/rest")
public class ArticleRestController {

@Autowired
private ArticleService articleService;

@RequestMapping(value = "/article", method = POST, produces = "application/json")
public WebResponse> saveArticle(@RequestBody Article article) {
    article.setUserId(1L);
    articleService.saveArticle(article);
    Map ret = new HashMap<>();
    ret.put("id", article.getId());
    WebResponse> response = WebResponse.getSuccessResponse(ret);
    return response;
}

@RequestMapping(value = "/article/{id}", method = DELETE, produces = "application/json")
public WebResponse deleteArticle(@PathVariable Long id) {
    Article article = articleService.getById(id);
    article.setStatus(-1);
    articleService.updateArticle(article);
    WebResponse