SpringBoot 构建 RESTful 服务

REST (Representational State Transfer) 表述性状态传递 一种 Web 软件架构风格

在 REST 中，资源是由 URI 来指定的，对资源的增删改查操作可以通过 HTTP 协议提供的

GET <=> 查询
POST <=> 增添 
PUT <=> 修改
DELETE <=> 删除等方法来实现

下面我们来介绍一下，JPA 实现 REST（使用 Spring Data JPA 和 Spring Data Rest 可以快速构建出一个 RESTful 应用）

1. 创建项目

添加依赖：

<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</artifactId>
	<version>1.1.9</version>
</dependency>
<dependency>
	<groupId>mysql</groupId>
	<artifactId>mysql-connector-java</artifactId>
	<scope>runtime</scope>
</dependency>
<dependency>
	<groupId>org.projectlombok</groupId>
	<artifactId>lombok</artifactId>
	<optional>true</optional>
</dependency>

数据库连接配置：

spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql:///springboot?useUnicode=true&serverTimezone=UTC&characterEncoding=utf-8&nullCatalogMeansCurrent=true
spring.jpa.hibernate.ddl-auto=update
spring.jpa.database=mysql
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL57Dialect
spring.jpa.show-sql=true

2. 代码编写

创建 Book 实体类：

package mr.s.rest.entity;

import lombok.Data;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

/**
 * @author Mr.S
 * @date 2019/11/12
 */
@Data
@Entity(name = "t_book")
public class Book {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;
    private String name;
    private String author;
}

创建 BookRepository 接口：

package mr.s.rest.repository;

import mr.s.rest.entity.Book;
import org.springframework.data.jpa.repository.JpaRepository;

/**
 * @author Mr.S
 * @date 2019/11/12
 */
public interface BookRepository extends JpaRepository<Book, Integer> {
}

3. 测试

上面的基本配置已经完成了，现在来测试一下，我们使用 Postman 软件来测试

• POST：添加一本书

 

• GET：查询，localhost:8080/books 这个是分页查询，localhost:8080/books/1 这个是根据 id 进行唯一查询

分页查询：

分页信息： 

看到上面的分页信息了吗？其实可以这么请求：

http://localhost:8080/books?page=0&size=2

还可以加上条件进行排序查询

http://localhost:8080/books?page=0&size=3&sort=id,desc

重要的一点，page=0，0表示的是从第一页算起的！！！

唯一查询： 

 

•  PUT 修改：对 id = 3的记录进行修改

 

• DELETE 删除：删除 id = 1 的记录

 

 4. 其他配置

上面我们介绍了一些 JPA REST 的基本用法，但是我们还想自定义一些接口什么的，那么我们怎么来实现呢？

• 自定义查询方法（修改 BookRepository 接口）

package mr.s.rest.repository;

import mr.s.rest.entity.Book;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.repository.query.Param;

/**
 * @author Mr.S
 * @date 2019/11/12
 */
public interface BookRepository extends JpaRepository<Book, Integer> {
    /**
     * 根据书名查询书籍
     * @param name 书名
     * @return 对应书
     */
    Book findBookByName(@Param("name") String name);
}

接下来我们查看一下我们自定义的接口如何调用！

上面的接口 /search 可以查出我们自定义了哪些接口，以及调用方式，下面我们调用一下我们自定义的接口！

 

和我们普通的调用也差不多，就是拼接参数进行条件查询而已

• Spring Data Rest 其他的配置信息 (在 application.properties 中进行配置)

# 每页默认记录数，默认值为 20
spring.data.rest.default-page-size=2
# 分页查询页码参数名，默认值为 page
spring.data.rest.page-param-name=page
# 分页查询记录参数名，默认值为 size
spring.data.rest.limit-param-name=size
# 分页查询排序参数名，默认值为 sort
spring.data.rest.sort-param-name=sort
# base-path 表示给所有请求路径都加上前缀 /api
spring.data.rest.base-path=/api
# 添加成功后是否返回添加内容
spring.data.rest.return-body-on-create=true
# 更新成功后是否返回更新内容
spring.data.rest.return-body-on-update=true

ok，到这里介绍已经完毕了，其实 rest 还有很多其他的自定义配置，这里只叙述了一些基本常用的配置，其他的配置信息可以百度去搜索，谢谢观看！