Spring Boot实战:Restful API的构建

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

本文就来演示一下Spring boot如何实现这种模式,本文重点会讲解如何设计一个Restful的API,并通过Spring boot来实现相关的API。不过,为了大家更好的了解Restful风格的API,我们先设计一个传统的数据返回接口,这样大家可以对比着来理解。

一、非Restful接口的支持

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

  1. @Controller

  2. @RequestMapping("/article")

  3. public class ArticleController {


  4.    @Autowired

  5.    private ArticleService articleService;


  6.    @RequestMapping("/list.json")

  7.    @ResponseBody

  8.    public List<Article> listArticles(String title, Integer pageSize, Integer pageNum) {

  9.        if (pageSize == null) {

  10.            pageSize = 10;

  11.        }

  12.        if (pageNum == null) {

  13.            pageNum = 1;

  14.        }

  15.        int offset = (pageNum - 1) * pageSize;

  16.        return articleService.getArticles(title, 1L, offset, pageSize);

  17.    }

  18. }

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

  1. @Service

  2. public class ArticleServiceImpl implements ArticleService {


  3.    @Autowired

  4.    private ArticleMapper articleMapper;


  5.    @Override

  6.    public Long saveArticle(@RequestBody Article article) {

  7.        return articleMapper.insertArticle(article);

  8.    }


  9.    @Override

  10.    public List<Article> getArticles(String title,Long userId,int offset,int pageSize) {

  11.        Article article = new Article();

  12.        article.setTitle(title);

  13.        article.setUserId(userId);

  14.        return articleMapper.queryArticlesByPage(article,offset,pageSize);

  15.    }


  16.    @Override

  17.    public Article getById(Long id) {

  18.        return articleMapper.queryById(id);

  19.    }


  20.    @Override

  21.    public void updateArticle(Article article) {

  22.        article.setUpdateTime(new Date());

  23.        articleMapper.updateArticleById(article);

  24.    }

  25. }

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

640?wx_fmt=jpeg

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. <dependency>

  2.      <groupId>org.springframework.boot</groupId>

  3.      <artifactId>spring-boot-starter-web</artifactId>

  4. </dependency>

这个是所有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:

640?wx_fmt=png

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

三、Restful API实现

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

  1. @RestController

  2. @RequestMapping("/rest")

  3. public class ArticleRestController {


  4.    @Autowired

  5.    private ArticleService articleService;


  6.    @RequestMapping(value = "/article", method = POST, produces = "application/json")

  7.    public WebResponse<Map<String, Object>> saveArticle(@RequestBody Article article) {

  8.        article.setUserId(1L);

  9.        articleService.saveArticle(article);

  10.        Map<String, Object> ret = new HashMap<>();

  11.        ret.put("id", article.getId());

  12.        WebResponse<Map<String, Object>> response = WebResponse.getSuccessResponse(ret);

  13.        return response;

  14.    }


  15.    @RequestMapping(value = "/article/{id}", method = DELETE, produces = "application/json")

  16.    public WebResponse<?> deleteArticle(@PathVariable Long id) {

  17.        Article article = articleService.getById(id);

  18.        article.setStatus(-1);

  19.        articleService.updateArticle(article);

  20.        WebResponse<Object> response = WebResponse.getSuccessResponse(null);

  21.        return response;

  22.    }


  23.    @RequestMapping(value = "/article/{id}", method = PUT, produces = "application/json")

  24.    public WebResponse<Object> updateArticle(@PathVariable Long id, @RequestBody Article article) {

  25.        article.setId(id);

  26.        articleService.updateArticle(article);

  27.        WebResponse<Object> response = WebResponse.getSuccessResponse(null);

  28.        return response;

  29.    }


  30.    @RequestMapping(value = "/article/{id}", method = GET, produces = "application/json")

  31.    public WebResponse<Article> getArticle(@PathVariable Long id) {

  32.        Article article = articleService.getById(id);

  33.        WebResponse<Article> response = WebResponse.getSuccessResponse(article);

  34.        return response;

  35.    }

  36. }

我们再来分析一下这段代码,这段代码和之前代码的区别在于:

  • 我们使用的是@RestController这个注解,而不是@Controller,不过这个注解同样不是Spring boot提供的,而是Spring MVC4中的提供的注解,表示一个支持Restful的控制器。

  • 这个类中有三个URL映射是相同的,即都是/article/{id},这在@Controller标识的类中是不允许出现的。这里的可以通过method来进行区分,produces的作用是表示返回结果的类型是JSON。

  • @PathVariable这个注解,也是Spring MVC提供的,其作用是表示该变量的值是从访问路径中获取。

所以看来看去,这个代码还是跟Spring boot没太多的关系,Spring boot也仅仅是提供自动配置的功能,这也是Spring boot用起来很舒服的一个很重要的原因,因为它的侵入性非常非常小,你基本感觉不到它的存在。

四、测试

代码写完了,怎么测试?除了GET的方法外,都不能直接通过浏览器来访问,当然,我们可以直接通过postman来发送各种http请求。不过我还是比较支持通过单元测试类来测试各个方法。这里我们就通过Junit来测试各个方法:

  1. @RunWith(SpringJUnit4ClassRunner.class)

  2. @SpringBootTest(classes = Application.class)

  3. public class ArticleControllerTest {


  4.    @Autowired

  5.    private ArticleRestController restController;


  6.    private MockMvc mvc;


  7.    @Before

  8.    public void setUp() throws Exception {

  9.        mvc = MockMvcBuilders.standaloneSetup(restController).build();

  10.    }


  11.    @Test

  12.    public void testAddArticle() throws Exception {

  13.        Article article = new Article();

  14.        article.setTitle("测试文章000000");

  15.        article.setType(1);

  16.        article.setStatus(2);

  17.        article.setSummary("这是一篇测试文章");

  18.        Gson gosn = new Gson();

  19.        RequestBuilder builder = MockMvcRequestBuilders

  20.                .post("/rest/article")

  21.                .accept(MediaType.APPLICATION_JSON)

  22.                .contentType(MediaType.APPLICATION_JSON_UTF8)

  23.                .content(gosn.toJson(article));


  24.        MvcResult result = mvc.perform(builder).andReturn();

  25.        System.out.println(result.getResponse().getContentAsString());

  26.    }


  27.    @Test

  28.    public void testUpdateArticle() throws Exception {

  29.        Article article = new Article();

  30.        article.setTitle("更新测试文章");

  31.        article.setType(1);

  32.        article.setStatus(2);

  33.        article.setSummary("这是一篇更新测试文章");

  34.        Gson gosn = new Gson();

  35.        RequestBuilder builder = MockMvcRequestBuilders

  36.                .put("/rest/article/1")

  37.                .accept(MediaType.APPLICATION_JSON)

  38.                .contentType(MediaType.APPLICATION_JSON_UTF8)

  39.                .content(gosn.toJson(article));

  40.        MvcResult result = mvc.perform(builder).andReturn();

  41.    }


  42.    @Test

  43.    public void testQueryArticle() throws Exception {

  44.        RequestBuilder builder = MockMvcRequestBuilders

  45.                .get("/rest/article/1")

  46.                .accept(MediaType.APPLICATION_JSON)

  47.                .contentType(MediaType.APPLICATION_JSON_UTF8);

  48.        MvcResult result = mvc.perform(builder).andReturn();

  49.        System.out.println(result.getResponse().getContentAsString());

  50.    }


  51.    @Test

  52.    public void testDeleteArticle() throws Exception {

  53.        RequestBuilder builder = MockMvcRequestBuilders

  54.                .delete("/rest/article/1")

  55.                .accept(MediaType.APPLICATION_JSON)

  56.                .contentType(MediaType.APPLICATION_JSON_UTF8);

  57.        MvcResult result = mvc.perform(builder).andReturn();

  58.    }

  59. }

执行结果这里就不给大家贴了,大家有兴趣的话可以自己实验一下。整个类要说明的点还是很少,主要这些东西都与Spring boot没关系,支持这些操作的原因还是上一篇文章中提到的引入对应的starter:

  1. <dependency>

  2.      <groupId>org.springframework.boot</groupId>

  3.      <artifactId>spring-boot-starter-test</artifactId>

  4.      <scope>test</scope>

  5. </dependency>

因为要执行HTTP请求,所以这里使用了MockMvc,ArticleRestController通过注入的方式实例化,不能直接new,否则ArticleRestController就不能通过Spring IoC容器来管理,因而其依赖的其他类也无法正常注入。通过MockMvc我们就可以轻松的实现HTTP的DELETE/PUT/POST等方法了。

640?wx_fmt=jpeg

五、总结

本文讲解了如果通过Spring boot来实现Restful的API,其实大部分东西都是Spring和Spring MVC提供的,Spring boot只是提供自动配置的功能。但是,正是这种自动配置,为我们减少了很多的开发和维护工作,使我们能更加简单、高效的实现一个web工程,从而让我们能够更加专注于业务本身的开发,而不需要去关心框架的东西。这篇文章中我们提到了可以通过postman和junit的方式来访问Restful 接口,下篇文章我们会介绍另外一种方式来访问,有兴趣的可以继续关注一下。


扩展阅读

springboot知识点整理

Springboot Mybatis整合(完整版)

Spring Boot配置随机数那些小技巧

给你一份详细的Spring Boot知识清单

Spring MVC到Spring BOOT的简化之路


来源:https://www.cnblogs.com/paddix/p/8215245.html

文章来源网络,版权归作者本人所有,如侵犯到原作者权益,请与我们联系删除

640?wx_fmt=jpeg

展开阅读全文
©️2020 CSDN 皮肤主题: 大白 设计师: CSDN官方博客 返回首页
实付0元
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值