10 行代码构建 RESTful 风格应用

作者：松哥
来源：牧码小子
广而告之：由于此订阅号换了个皮肤，系统自动取消了读者的公众号置顶。导致用户接受文章不及时。可以打开订阅号，选择置顶（标星）公众号，重磅干货，第一时间送达！
RESTful ，到现在相信已经没人不知道这个东西了吧！关于 RESTful 的概念，我这里就不做过多介绍了，传统的 Struts 对 RESTful 支持不够友好，但是 SpringMVC 对于 RESTful 提供了很好的支持，常见的相关注解有：

1. @RestController
复制代码
1. @GetMapping
复制代码
1. @PutMapping
复制代码
1. @PostMapping
复制代码
1. @DeleteMapping
复制代码
1. @ResponseBody
复制代码
1. ...
复制代码

这些注解都是和 RESTful 相关的，在移动互联网中，RESTful 得到了非常广泛的使用。RESTful 这个概念提出来很早，但是以前没有移动互联网时，我们做的大部分应用都是前后端不分的，在这种架构的应用中，数据基本上都是在后端渲染好返回给前端展示的，此时 RESTful 在 Web 应用中基本就没用武之地，移动互联网的兴起，让我们一套后台对应多个前端项目，因此前后端分离，RESTful 顺利走上前台。
Spring Boot 继承自 Spring + SpringMVC， SpringMVC 中对于 RESTful 支持的特性在 Spring Boot 中全盘接收，同时，结合 Jpa 和自动化配置，对于 RESTful 还提供了更多的支持，使得开发者几乎不需要写代码（很少几行），就能快速实现一个 RESTful 风格的增删改查。
接下来，松哥通过一个简单的案例，来向大家展示 Spring Boot 对于 RESTful 的支持。
实战[h1]创建工程[/h1]首先创建一个 Spring Boot 工程，引入

Web

复制代码

、

Jpa

复制代码

、

MySQL

复制代码

、

RestRepositories

复制代码

依赖：

创建完成后，还需要锁定 MySQL 驱动的版本以及加入 Druid 数据库连接池，完整依赖如下：

1. [/code]
2. [*][code]
复制代码
1. org.springframework.boot
复制代码
1. spring-boot-starter-data-jpa
复制代码
复制代码
复制代码
1. org.springframework.boot
复制代码
1. spring-boot-starter-data-rest
复制代码
复制代码
复制代码
1. org.springframework.boot
复制代码
1. spring-boot-starter-web
复制代码
复制代码
复制代码
1. com.alibaba
复制代码
1. druid-spring-boot-starter
复制代码
1. 1.1.10
复制代码
复制代码
复制代码
1. mysql
复制代码
1. mysql-connector-java
复制代码
1. runtime
复制代码
1. 5.1.27
复制代码
复制代码
1. [/code]
2. [/list][h1][b]配置数据库[/b][/h1]主要配置两个，一个是数据库，另一个是 Jpa：
3. [list=1][*][code]spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
复制代码
1. spring.datasource.username=root
复制代码
1. spring.datasource.password=root
复制代码
1. spring.datasource.url=jdbc:mysql:///test01
复制代码
1. spring.datasource.driver-class-name=com.mysql.jdbc.Driver
复制代码
1. spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL57Dialect
复制代码
1. spring.jpa.show-sql=true
复制代码
1. spring.jpa.hibernate.ddl-auto=update
复制代码
1. spring.jpa.database-platform=mysql
复制代码
1. spring.jpa.database=mysql
复制代码

这里的配置，和 Jpa 中的基本一致。
前面五行配置了数据库的基本信息，包括数据库连接池、数据库用户名、数据库密码、数据库连接地址以及数据库驱动名称。
接下来的五行配置了 JPA 的基本信息，分别表示生成 SQL 的方言、打印出生成的 SQL 、每次启动项目时根据实际情况选择是否更新表、数据库平台是 MySQL。
这两段配置是关于 MySQL + JPA 的配置，没用过 JPA 的小伙伴可以参考松哥之前的 JPA 文章：http://www.javaboy.org/2019/0407/springboot-jpa.html
[h1]构建实体类[/h1]

1. @Entity(name = "t_book")
复制代码
1. public class Book {
复制代码
1. @Id
复制代码
1. @GeneratedValue(strategy = GenerationType.IDENTITY)
复制代码
1. private Long id;
复制代码
1. @Column(name = "book_name")
复制代码
1. private String name;
复制代码
1. private String author;
复制代码
1. //省略 getter/setter
复制代码
1. }
复制代码
1. public interface BookRepository extends JpaRepository {
复制代码
1. }
复制代码

这里一个是配置了一个实体类 Book，另一个则是配置了一个 BookRepository ，项目启动成功后，框架会根据 Book 类的定义，在数据库中自动创建相应的表，BookRepository 接口则是继承自 JpaRepository ，JpaRepository 中自带了一些基本的增删改查方法。
好了，代码写完了。
啥？你好像啥都没写啊？是的，啥都没写，啥都不用写，一个 RESTful 风格的增删改查应用就有了，这就是 Spring Boot 的魅力！
[h1]测试[/h1]此时，我们就可以启动项目进行测试了，使用 POSTMAN 来测试（大家也可以自行选择趁手的 HTTP 请求工具）。
此时我们的项目已经默认具备了一些接口，我们分别来看：
[h3]根据 id 查询接口[/h3]

http://127.0.0.1:8080/books/{id}

这个接口表示根据 id 查询某一本书：

[h3]分页查询[/h3]

http://127.0.0.1:8080/books

这是一个批量查询接口，默认请求路径是类名首字母小写，并且再加一个 s 后缀。这个接口实际上是一个分页查询接口，没有传参数，表示查询第一页，每页 20 条数据。

查询结果中，除了该有的数据之外，也包含了分页数据：

分页数据中：

size 表示每页查询记录数
totalElements 表示总记录数
totalPages 表示总页数
number 表示当前页数，从0开始计

如果要分页或者排序查询，可以使用 _links 中的链接。

http://127.0.0.1:8080/books?page=1&size=3&sort=id,desc

复制代码

。

[h3]添加[/h3]也可以添加数据，添加是 POST 请求，数据通过 JSON 的形式传递，如下：

添加成功之后，默认会返回添加成功的数据。
[h3]修改[/h3]修改接口默认也是存在的，数据修改请求是一个 PUT 请求，修改的参数也是通过 JSON 的形式传递：

默认情况下，修改成功后，会返回修改成功的数据。
[h3]删除[/h3]当然也可以通过 DELETE 请求根据 id 删除数据：

删除成功后，是没有返回值的。
不需要几行代码，一个基本的增删改查就有了。
这些都是默认的配置，这些默认的配置实际上都是在 JpaRepository 的基础上实现的，实际项目中，我们还可以对这些功能进行定制。
[h1]查询定制[/h1]最广泛的定制，就是查询，因为增删改操作的变化不像查询这么丰富。对于查询的定制，非常容易，只需要提供相关的方法即可。例如根据作者查询书籍：

1. public interface BookRepository extends JpaRepository {
复制代码
1. List findBookByAuthorContaining(@Param("author") String author);
复制代码
1. }
复制代码

注意，方法的定义，参数要有 @Param 注解。
定制完成后，重启项目，此时就多了一个查询接口，开发者可以通过 http://localhost:8080/books/search 来查看和 book 相关的自定义接口都有哪些：

查询结果表示，只有一个自定义接口，接口名就是方法名，而且查询结果还给出了接口调用的示例。我们来尝试调用一下自己定义的查询接口：

开发者可以根据实际情况，在 BookRepository 中定义任意多个查询方法，查询方法的定义规则和 Jpa 中一模一样。但是，这样有一个缺陷，就是 Jpa 中方法名太长，因此，如果不想使用方法名作为接口名，则可以自定义接口名：

1. public interface BookRepository extends JpaRepository {
复制代码
1. @RestResource(rel = "byauthor",path = "byauthor")
复制代码
1. List findBookByAuthorContaining(@Param("author") String author);
复制代码
1. }
复制代码

@RestResource 注解中，两个参数的含义：

rel 表示接口查询中，这个方法的 key
path 表示请求路径

这样定义完成后，表示接口名为 byauthor ，重启项目，继续查询接口：

除了

rel

复制代码

和

path

复制代码

两个属性之外，

@RestResource

复制代码

中还有一个属性，

exported

复制代码

表示是否暴露接口，默认为

true

复制代码

，表示暴露接口，即方法可以在前端调用，如果仅仅只是想定义一个方法，不需要在前端调用这个方法，可以设置

exported

复制代码

属性为

false

复制代码

。
如果不想暴露官方定义好的方法，例如根据

id

复制代码

删除数据，只需要在自定义接口中重写该方法，然后在该方法上加

@RestResource

复制代码

注解并且配置相关属性即可。

1. public interface BookRepository extends JpaRepository {
复制代码
1. @RestResource(rel = "byauthor",path = "byauthor")
复制代码
1. List findBookByAuthorContaining(@Param("author") String author);
复制代码
1. @Override
复制代码
1. @RestResource(exported = false)
复制代码
1. void deleteById(Long aLong);
复制代码
1. }
复制代码

另外生成的 JSON 字符串中的集合名和单个

item

复制代码

的名字都是可以自定义的：

1. @RepositoryRestResource(collectionResourceRel = "bs",itemResourceRel = "b",path = "bs")
复制代码
1. public interface BookRepository extends JpaRepository {
复制代码
1. @RestResource(rel = "byauthor",path = "byauthor")
复制代码
1. List findBookByAuthorContaining(@Param("author") String author);
复制代码
1. @Override
复制代码
1. @RestResource(exported = false)
复制代码
1. void deleteById(Long aLong);
复制代码
1. }
复制代码

path

复制代码

属性表示请求路径，请求路径默认是类名首字母小写+s，可以在这里自己重新定义。

[h1]其他配置[/h1][h1]最后，也可以在 application.properties 中配置 REST 基本参数：
[/h1]

1. spring.data.rest.base-path=/api
复制代码
1. spring.data.rest.sort-param-name=sort
复制代码
1. spring.data.rest.page-param-name=page
复制代码
1. spring.data.rest.limit-param-name=size
复制代码
1. spring.data.rest.max-page-size=20
复制代码
1. spring.data.rest.default-page-size=0
复制代码
1. spring.data.rest.return-body-on-update=true
复制代码
1. spring.data.rest.return-body-on-create=true
复制代码

配置含义，从上往下，依次是：

给所有的接口添加统一的前缀
配置排序参数的 key ，默认是 sort
配置分页查询时页码的 key，默认是 page
配置分页查询时每页查询页数的 key，默认是size
配置每页最大查询记录数，默认是 20 条
分页查询时默认的页码
更新成功时是否返回更新记录
添加成功时是否返回添加记录

总结本文主要向大家介绍了 Spring Boot 中快速实现一个 RESTful 风格的增删改查应用的方案，整体来说还是比较简单的，并不难。相关案例我已上传到 GitHub 上了，小伙伴可以自行下载：https://github.com/lenve/javaboy-code-samples。
关于本文，有问题欢迎留言讨论。
https://mp.weixin.qq.com/s/7uO87SOu93XH2Y3iWxWicg?tdsourcetag=s_pcqq_aiomsg

https://mp.weixin.qq.com/s/7uO87SOu93XH2Y3iWxWicg?tdsourcetag=s_pcqq_aiomsg
原文链接

福利时刻：欢迎大家关注微信订阅号「Web项目聚集地」，关注后回复「Java」「Python」「前端」等关键字即可获取相关技术栈资源，具体资源目录回复「全栈」即可免费获取，定时更新！
如何置顶、标星公众号？

推荐阅读
1. 免费送 66 实体书，邮费我出！
2. 图解 Java 垃圾回收机制
3. 百万级数据，分页如何处理？
4. Spring Boot 他爹有多大背景？