RESTful 这个概念提出来很早,但是以前没有移动互联网时,我们做的大部分应用都是前后端不分的,在这种架构的应用中,数据基本上都是在后端渲染好返回给前端展示的,此时 RESTful 在 Web 应用中基本就没用武之地,移动互联网的兴起,让我们一套后台对应多个前端项目,因此前后端分离,RESTful 顺利走上前台。
之前在SpringMVC中学习了restful的概念,SpringMVC 对于 RESTful 提供了很好的支持,常见的相关注解有:
@RestController
@GetMapping
@PutMapping
@PostMapping
@DeleteMapping
@ResponseBody
…
Spring Boot 继承自 Spring + SpringMVC, SpringMVC 中对于 RESTful 支持的特性在 Spring Boot 中全盘接收,同时,结合 Jpa 和 自动化配置,对于 RESTful 还提供了更多的支持,使得开发者几乎不需要写代码(很少几行),就能快速实现一个 RESTful 风格的增删改查。
创建工程
首先创建一个 Spring Boot 工程,引入 Web 、 Jpa 、 MySQL 、Rest Repositories 依赖:
创建完成后,还需要锁定 MySQL 驱动的版本以及加入 Druid 数据库连接池,完整依赖如下:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-rest</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.10</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.27</version>
<scope>runtime</scope>
</dependency>
配置数据库
主要配置两个,一个是数据库,另一个是 Jpa:
# 数据库的基本配置
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF-8
# JPA配置
spring.jpa.database=mysql
# 在控制台打印SQL
spring.jpa.show-sql=true
# 数据库平台
spring.jpa.database-platform=mysql
# 每次启动项目时,数据库初始化策略,例如,有表就更新,没有就创建
spring.jpa.hibernate.ddl-auto=update
# 指定默认的存储引擎为InnoDB
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL57Dialect
前面四行配置了数据库的基本信息,包括数据库连接池、数据库用户名、数据库密码、数据库连接地址以及数据库驱动名称。
接下来的五行配置了 JPA 的基本信息,表示生成 SQL 的方言、打印出生成的 SQL 、每次启动项目时根据实际情况选择是否更新表、数据库平台是 MySQL。
参考前面的文章。
构建实体类
@Entity(name = "t_student")
public class Student {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Integer id;
private String name;
private int age;
这里一个是配置了一个实体类Student,另一个则是配置了一个 StudentDao ,项目启动成功后,框架会根据 Student类的定义,在数据库中自动创建相应的表,StudentDao接口则是继承自 JpaRepository ,JpaRepository 中自带了一些基本的增删改查方法。
public interface StudentDao extends JpaRepository<Student, Integer> {
}
l两个参数,一个是实体类,一个是主键的类型。
啥都不用写,一个 RESTful 风格的增删改查应用就有了,这就是 Spring Boot 的魅力!
测试
此时,我们就可以启动项目进行测试了,使用 POSTMAN 来测试,我们的项目已经默认具备了一些接口,我们分别来看:
1、分页查询
- http://localhost:8080/students
这是一个批量查询接口,默认请求路径是类名首字母小写,并且再加一个 s 后缀。这个接口实际上是一个分页查询接口,没有传参数,表示查询第一页,每页 20 条数据。
查询结果中,除了该有的数据之外,也包含了分页数据:
分页数据中:
size 表示每页查询记录数
totalElements 表示总记录数
totalPages 表示总页数
number 表示当前页数,从0开始计
如果要分页或者排序查询,可以使用 _links 中的链接。http://localhost:8080/students?page=0&size=3&sort=id,desc
2、根据 id 查询接口
- http://localhost:8080/students/{id}
这个接口表示根据 id 查询某一学生:
添加
也可以添加数据,添加是 POST 请求,数据通过 JSON 的形式传递,如下:
添加成功之后,默认会返回添加成功的数据。
修改
修改接口默认也是存在的,数据修改请求是一个 PUT 请求,修改的参数也是通过 JSON 的形式传递:
默认情况下,修改成功后,会返回修改成功的数据。
删除
当然也可以通过 DELETE 请求根据 id 删除数据:
删除成功后,是没有返回值的。
不需要几行代码,一个基本的增删改查就有了。
这些都是默认的配置,这些默认的配置实际上都是在 JpaRepository 的基础上实现的,实际项目中,我们还可以对这些功能进行定制。