工作四五年,除了第一年用过jpa,剩下一直都是mybatis,后来变成mybatis plus。今天维护一个老项目才发现jpa又出了一个非常实用的功能:自动将repository转换为rest资源,可不提供controller层接口直接访问数据。下面的具体的实现。
这里因为我也是项目中遇到了所以打算研究下功能,所以是从空项目开始构建。基本配置是springboot 2.7,jdk8,数据库用的mysql,个人习惯用lombok。
引入依赖
第一步肯定是导包。上面说了是rest和jpa的整合,所以这两个包必不可少,我用的mysql,所以要引入mysql驱动。为了测出效果web模块也要添加。下面就是最基本的依赖了。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</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-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.29</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
配置数据库连接
我是用配置文件的方式配置的。而且为了测试也就一个数据源,几乎我这里都是最简配置。
server:
port: 1234
spring:
data:
rest:
base-path: /api
datasource:
driverClassName: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://127.0.0.1:3306/test?allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone= GMT%2B8
username: root
password: 123456
指定端口和数据库连接就不说了。这里我配置了个spring.data.rest.base-path=/api
简单说下这个是spring官方文档建议配置的。如果配置了的话,所有rest访问的接口都要加这个前缀。不配置也可以。一会儿我会上两个对比图。
建立entity和dao层
我这里为了测试所以建立了一个最简单的kv表。如下代码:
entity类,好久不用jpa都忘了怎么用了,一开始主键我都不想设置的,但是发现没主键报错,所以。。反正这些个注解一个都不能少。
@Data
@Entity
public class t_keyvalue_b implements Serializable {
private static final long serialVersionUID = 1L;
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private long id;
@Column
private String TYPE;
@Column
private String VALUE;
}
dao接口:这里有两个重点:一个是继承PagingAndSortingRepository类,按照这个名称也能看出来支持分页和排序。另一个是这个注解:@RepositoryRestResource
@RepositoryRestResource(collectionResourceRel = "kv", path = "kv")
public interface TKeyvalueRepository extends PagingAndSortingRepository<t_keyvalue_b, Long> {
}
使用测试
首先说两个知识点:
-
如果dao层不额外指定,那么默认的请求路径是实体类名称小写+s.比如我先不指定路径。下面是测试demo:
其实这个我们可以自查一下路径。而上面我说的注释的作用path是可以改成指定的路径,collectionResourceRel 是可以修改返回值集合的key。下面我再放一张图做对比。
get请求查询
当然了我一直尝试的都是get请求,默认是返回列表的。而且其实还可以设置分页。直接拼接在路径上page和size就行了,如下是demo:
我不知道你们注意没注意我这个测试表里是三条数据的,现在第0页展示2条。所以是生效了的。
注意get请求是列表。如果想指定id查询可以后面拼id:
post请求保存
这个也是常规的定义。如果想要保存一条新记录用post请求。
put请求修改
注意修改是要根据id修改的,所以必须带id。这个我就不测了,有点麻烦。
delete请求删除
删除直接带id就行。
如果我们不想暴露某个方法的话,可以在方法上添加注解;
@RestResource(exported = false)
如果不想暴露整个dao的话,可以在接口上添加注解:
@RepositoryRestResource (exported =false)
当然了rest还可以有一些别的配置:
#每页默认记录数,默认值为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 表示给所有请求路径都加上前缀
spring.data.rest.base-path=/api
#添加成功时是否返回添加内容
spring.data.rest.return-body-on-create=true
#更新成功时是否返回更新内容
spring.data.rest.return-body-on-update=true
大概简单的使用就是这样了,官网上还有很多内容,不过我这里就浅试一下啦。本篇笔记就记到这里,如果稍微帮到你了记得点个喜欢点个关注。也祝大家工作顺顺利利~