Spring Boot整合JPA实现rest风格对数据库操作

工作四五年,除了第一年用过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> {

}

使用测试

首先说两个知识点:

  1. 如果dao层不额外指定,那么默认的请求路径是实体类名称小写+s.比如我先不指定路径。下面是测试demo:
    不指定路径

    其实这个我们可以自查一下路径。而上面我说的注释的作用path是可以改成指定的路径,collectionResourceRel 是可以修改返回值集合的key。下面我再放一张图做对比。
    指定路径和返回集合的key

get请求查询

当然了我一直尝试的都是get请求,默认是返回列表的。而且其实还可以设置分页。直接拼接在路径上page和size就行了,如下是demo:


分页查询

我不知道你们注意没注意我这个测试表里是三条数据的,现在第0页展示2条。所以是生效了的。

注意get请求是列表。如果想指定id查询可以后面拼id:


get指定id查询

post请求保存

这个也是常规的定义。如果想要保存一条新记录用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

大概简单的使用就是这样了,官网上还有很多内容,不过我这里就浅试一下啦。本篇笔记就记到这里,如果稍微帮到你了记得点个喜欢点个关注。也祝大家工作顺顺利利~

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容