Spring-data-jpa入门（一）

转x33g5p2x  于2022-06-08 转载在 Spring  
字(11.7k)|赞(0)|评价(0)|浏览(548)

啥是JPA

我这个小白没有听说过，全英文名叫Java Persistence API，就是java持久化api，是SUN公司推出的一套基于ORM的规范。

持久化想必如雷贯耳，都2022年了，谁还不用个持久化框架啊，举起mybatis。

ORM呢？全英文名为Object-Relational Mapping：对象关系映射，简单来说为了不用JDBC那一套原始方法来操作数据库，ORM框架横空出世（mybatis、hibernate等等）。

然而ORM框架出的太多了，百花齐放，琳琅满目，你一套标准我一套标准，要是想换一套框架实现项目，可能要从头再写。啊这？入土吧。

百度这样介绍SUN的JPA规范：

Sun引入新的JPA ORM规范出于两个原因：

其一，简化现有Java EE和Java SE应用开发工作；

其二，Sun希望整合ORM技术，实现天下归一。

spring-data-jpa

学jpa哪家强？哪家简单学哪家，spring-data-jpa最简单。介绍如下：

Spring Data JPA是Spring Data家族的一部分，可以轻松实现基于JPA的存储库。 此模块处理对基于JPA的数据访问层的增强支持。 它使构建使用数据访问技术的Spring驱动应用程序变得更加容易。

总的来说JPA是ORM规范，Hibernate、TopLink等是JPA规范的具体实现，这样的好处是开发者可以面向JPA规范进行持久层的开发，而底层的实现则是可以切换的。Spring Data Jpa则是在JPA之上添加另一层抽象（Repository层的实现），极大地简化持久层开发及ORM框架切换的成本。

也就是如下图所示：

配置环境

话不多说，使用Maven管理包，使用springboot框架，建个空maven项目就行

POM信息

  1. <parent>
  2.         <groupId>org.springframework.boot</groupId>
  3.         <artifactId>spring-boot-starter-parent</artifactId>
  4.         <version>2.2.4.RELEASE</version>
  5.         <relativePath/> <!-- lookup parent from repository -->
  6.     </parent>
  8.     <dependencies>
  9.         <!--web-->
  10.         <dependency>
  11.             <groupId>org.springframework.boot</groupId>
  12.             <artifactId>spring-boot-starter-web</artifactId>
  13.         </dependency>
  14.         <!--spring-data-jpa-->
  15.         <dependency>
  16.             <groupId>org.springframework.boot</groupId>
  17.             <artifactId>spring-boot-starter-data-jpa</artifactId>
  18.         </dependency>
  19.         <!--druid连接池-->
  20.         <dependency>
  21.             <groupId>com.alibaba</groupId>
  22.             <artifactId>druid-spring-boot-starter</artifactId>
  23.             <version>1.1.23</version>
  24.         </dependency>
  25.         <!--oracle桥接器-->
  26.         <dependency>
  27.             <groupId>com.oracle.ojdbc</groupId>
  28.             <artifactId>ojdbc8</artifactId>
  29.             <scope>runtime</scope>
  30.         </dependency>
  31.         <!--lombok-->
  32.         <dependency>
  33.             <groupId>org.projectlombok</groupId>
  34.             <artifactId>lombok</artifactId>
  35.             <optional>true</optional>
  36.         </dependency>
  38.     </dependencies>

application.yml

  1. spring:
  2.   datasource:
  3.     type: com.alibaba.druid.pool.DruidDataSource
  4.     url: jdbc:oracle:thin:@localhost:1521:XE
  5.     username: JPADEMO
  6.     password: oracle
  7.     driver-class-name: oracle.jdbc.OracleDriver
  8.   jpa:
  9.     hibernate:
  10.       ddl-auto: update #自动更新
  11.     show-sql: true  #日志中显示sql语句
  12.   application:
  13.     name: spring-data-jpa-demo
  14. server:
  15.   port: 2333 #端口号

目录结构如下

  • 标准的MVC结构，有助于解耦的实现；
  • 实体类放在 pojo/entity 下
  • dao（数据访问对象 data access object）在JPA中叫做repository，请遵守这个规范，就像mybaits的dao叫mapper一样。

创建数据库和表

复习一下oracle建数据库和表的操作吧

1.创建数据库

Jpa支持mySQL和Oracle数据库，这里使用Oracle做例子

mysql数据库也就实体类的主键声明和使用的桥接器不同，之后的章节会做具体解释

1.1 建库前先看一下这个库存不存在

  1. -- 查看当前已有的用户
  2. SELECT Username FROM dba_users;

1.2 oracle建数据库语句

  1. -- 创建用户（schema）账号：JPADEMO 密码：oracle
  2. create user JPADEMO identified by oracle
  3. -- 授权
  4. grant create session to JPADEMO;
  5. grant create table to JPADEMO;
  6. grant create sequence to JPADEMO;
  7. grant unlimited tablespace to JPADEMO;

2.创建表

2.1 建一张用户表吧

  1. -- 创建一张表
  2. create table JPA_USER
  3. (
  4.     id                number not null,
  5.     name              varchar2(100),
  6.     object_version    number not null,
  7.     created_by        varchar2(50),
  8.     created_date      date,
  9.     last_updated_by   varchar2(50),
  10.     last_updated_date date
  12. );
  13. -- 给表加主键 单列主键 主键命名为JPA_USER_PK1 
  14. alter table JPA_USER add constraint JPA_USER_PK1 primary key (id);
  15. -- 给表加注释
  16. COMMENT ON table JPA_USER IS '用户信息表';
  17. -- 给字段加注释
  18. comment on column JPA_USER.id  is 'id';
  19. comment on column JPA_USER.name is '用户名称';
  20. -- 创建序列 命名为JPA_USER_S
  21. create sequence JPA_USER_S
  22.     minvalue 1
  23.     maxvalue 9999999999999999999999999999
  24.     start with 1
  25.     increment by 1
  26.     cache 20;
  27. --创建索引 命名为JPA_USER_INDEX1 
  28. create index JPA_USER_INDEX1 on JPA_USER(name);

1.4 运行sql，成功！

环境配好了，开始demo吧！

代码

1.Springboot启动类

SpringContextApplication

  1. /**
  2.  * 启动类
  3.  */
  4. @EnableJpaAuditing
  5. @SpringBootApplication
  6. public class SpringContextApplication {
  7.     public static void main(String[] args) {
  8.         SpringApplication.run(SpringContextApplication.class, args);
  9.     }
  10. }

注意注意：

除了@SpringBootApplication启动注解外，

还有一个注解@EnableJpaAuditing，它是用来启动Jpa的审计功能，比如说在使用建表中经常会加入 版本号、创建时间、修改时间 、创建者、修改者 这五个字段。因此为了简化开发， 我们可以将其交给jpa来自动填充。

审计功能的创建人和修改者的注入方式下一节再讲哦，贪多嚼不烂。

2.entity实体类

自下而上，先把实体创建

JpaUser

  1. package org.example.jpademo.pojo.entity;
  3. import com.fasterxml.jackson.annotation.JsonFormat;
  4. import lombok.Data;
  5. import org.springframework.data.annotation.CreatedBy;
  6. import org.springframework.data.annotation.CreatedDate;
  7. import org.springframework.data.annotation.LastModifiedBy;
  8. import org.springframework.data.annotation.LastModifiedDate;
  9. import org.springframework.data.jpa.domain.support.AuditingEntityListener;
  11. import javax.persistence.*;
  12. import java.util.Date;
  14. /**
  15.  * @Classname JpaUser
  16.  * @Description TODO 用户实体类
  17.  */
  18. @Data
  19. @Entity
  20. @Table(name = "JPA_USER")
  21. @EntityListeners(AuditingEntityListener.class)
  22. public class JpaUser {
  24.     @Id
  25.     @Column(name = "ID")
  26.     @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "JPA_USER_S")
  27.     @SequenceGenerator(sequenceName = "JPA_USER_S", name = "JPA_USER_S", allocationSize = 1)
  28.     private Long id;
  30.     @Column(name = "NAME")
  31.     private String name;
  33.     @Column(name = "OBJECT_VERSION" )
  34.     @Version
  35.     private Long objectVersion;
  37.     @Column(name = "CREATED_BY")
  38.     @CreatedBy
  39.     private String createdBy;
  41.     @Column(name = "CREATED_DATE")
  42.     @CreatedDate
  43.     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
  44.     private Date createdDate;
  46.     @Column(name = "LAST_UPDATED_BY" )
  47.     @LastModifiedBy
  48.     private String lastUpdatedBy;
  50.     @Column(name = "LAST_UPDATED_DATE" )
  51.     @LastModifiedDate
  52.     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
  53.     private Date lastUpdatedDate;
  54. }

这里把引入的包也贴了出来，防止大家导错包，

可以看到有非常多的注解，他们各个是什么意思呢？请看下方表格：

注解作用常用属性
@Data给实体类加get/set/toString/EqualsAndHashCode方法，是lombok的注解
@Entity指定当前类是实体类
@Table指定实体类和表之间的对应关系name：指定数据库表的名称
@EntityListeners在实体类增删改的时候监听，为创建人/创建时间等基础字段赋值value：指定监听类
@Id指定当前字段是主键
@SequenceGenerator指定数据库序列别名sequenceName：数据库序列名 name：取的别名
@GeneratedValue指定主键的生成方式strategy ：指定主键生成策略 generator：选择主键别名
@Column指定实体类属性和数据库表之间的对应关系name：指定数据库表的列名称。 unique：是否唯一 nullable：是否可以为空 nserttable：是否可以插入 updateable：是否可以更新 columnDefinition: 定义建表时创建此列的DDL
@CreatedBy自动插入创建人
@CreatedDate自动插入创建时间
@LastModifiedBy自动修改更新人
@LastModifiedDate自动修改更细时间
@Version自动更新版本号
@JsonFormat插入/修改/读取的时间转换成想要的格式pattern：展示格式 timezone：国际时间

注意：

有了@EntityListeners(AuditingEntityListener.class)这个注解，@CreatedBy、@CreatedDate 、@LastModifiedBy 、@LastModifiedDate才生效哦，而且创建人和更新人需要另作注入操作，此篇埋个伏笔。

3.repository 数据访问层

此处便是整个spring-data-jpa中最令人虎躯一震的地方！

震惊，一个接口居然可以实现常用的所有操作！

明天来UC上班（我把槽都吐了，你们就没得吐了）

JpaUserRepository代码如下：

  1. import org.example.jpademo.pojo.entity.JpaUser;
  2. import org.springframework.data.jpa.repository.JpaRepository;
  4. /**
  5.  * @Classname JpaUserRepository
  6.  * @Description TODO
  7.  */
  8. public interface JpaUserRepository extends JpaRepository<JpaUser, Long> {
  9. }

你以为才开始吗？不，已经结束了。

可以看到，这个接口继承了JpaRepository<实体,ID>，spring-data-jpa只需要这个信息，就可以帮你完成常用的操作：增删查改。

这一节不具体展开JpaRepository中所包含的所有方法，单纯使用最简单的增删查改来过瘾

4.Service业务逻辑层

业务逻辑层是程序的逻辑核心，所有的重要的逻辑操作都应该往Service中写，而不是写到Controller控制层里去哦。

而且Service层是需要分层的：接口和实现类，这个不必多说，规范！规范！

我们实现最简单的新增、删除、修改、查询功能

接口如下：

JpaUserService

  1. public interface JpaUserService {
  2.     /**
  3.      * 新增用户
  4.      * @param user 用户对象
  5.      */
  6.     JpaUser insertUser(JpaUser user);
  8.     /**
  9.      * 删除用户
  10.      * @param id 删除id
  11.      */
  12.     void deleteUser(Long id);
  14.     /**
  15.      * 修改用户
  16.      * @param user 用户信息
  17.      */
  18.     JpaUser updateUser(JpaUser user);
  20.     /**
  21.      * 查询所有用户
  22.      */
  23.     List<JpaUser> findAllUser();
  25.     /**
  26.      * 通过id查询用户
  27.      * @param id 用户id
  28.      */
  29.     JpaUser findUserById(Long id);
  30. }

接口实现：

JpaUserServiceImpl

  1. @Service
  2. public class JpaUserServiceImpl implements JpaUserService {
  3.     @Resource
  4.     private JpaUserRepository jpaUserRepository;
  6.     @Override
  7.     public JpaUser insertUser(JpaUser user) {
  8.         return jpaUserRepository.save(user);
  9.     }
  11.     @Override
  12.     public void deleteUser(Long id) {
  13.         jpaUserRepository.deleteById(id);
  14.     }
  16.     @Override
  17.     public JpaUser updateUser(JpaUser user) {
  18.         return jpaUserRepository.save(user);
  19.     }
  21.     @Override
  22.     public List<JpaUser> findAllUser() {
  23.         return jpaUserRepository.findAll();
  24.     }
  26.     @Override
  27.     public JpaUser findUserById(Long id) {
  28.         return jpaUserRepository.findById(id).orElse(null);
  29.     }
  30. }

是滴，你没有看错，一个sql语句也没有见着，直接通过jpaUserRepository接口把方法点了出来。

这一点比mybatis做的好，不过你要硬说mybatis-plus牛逼我也没办法。

数据访问层（dao）被确确实实的优化的很简便，这是spring-data-jpa很大的亮点。

细心的同学可能发现了，新增和修改都调用的save()方法，jpa靠什么区分是insert还是update呢？

靠的是主键id有没有赋值判断~id有值为update，id无值为insert。

5.Controller控制层

控制层是前后台交互的层，我采用的是restful编写格式的接口，对于资源的具体操作类型，由HTTP动词表示。

简单借用晨瑞大佬文章中的解释：

  • GET（SELECT）：从服务器取出资源（一项或多项）。
  • POST（CREATE）：在服务器新建一个资源。
  • PUT（UPDATE）：在服务器更新完整资源（客户端提供改变后的完整资源）。
  • PATCH（UPDATE）：在服务器更新部分资源（客户端提供改变的属性）。
  • DELETE（DELETE）：从服务器删除资源。

简化一下：

  • GET：查询
  • POST：插入、新建
  • PUT：完全更新
  • PATCH：部分更新
  • DELETE：删除

举个栗子：

  • GET /zoos：获取所有动物园
  • POST /zoos：新建一个动物园
  • GET /zoos/ID：获取此ID的动物园信息
  • PUT /zoos/ID：更新此ID动物园部分信息（提供该动物园的全部信息）
  • PATCH /zoos/ID：更新此ID动物园全部信息（提供该动物园的部分信息）
  • DELETE /zoos/ID：删除此ID的动物园信息
  • GET /zoos/ID/animals：获取此ID动物园的所有动物
  • DELETE /zoos/ID/animals/ID：删除ID(前者)动物园的ID(后者)动物

好，如果你看懂了什么是restful编写格式，那么就看看控制层代码：

JpaUserController

  1. @RestController
  2. @RequestMapping("/user")
  3. public class JpaUserController {
  4.     @Resource
  5.     private JpaUserService jpaUserService;
  7.     /**
  8.      * 新增用户
  9.      */
  10.     @PostMapping("")
  11.     public JpaUser addUser(@RequestBody JpaUser user){
  12.         return jpaUserService.insertUser(user);
  13.     }
  15.     /**
  16.      * 删除用户
  17.      */
  18.     @DeleteMapping("/{id}")
  19.     public void deleteUser(@PathVariable("id") Long id){
  20.         jpaUserService.deleteUser(id);
  21.     }
  23.     /**
  24.      * 修改用户
  25.      */
  26.     @PutMapping("")
  27.     public JpaUser updateUser(@RequestBody JpaUser user){
  28.         return jpaUserService.updateUser(user);
  29.     }
  31.     /**
  32.      * 全查用户
  33.      */
  34.     @GetMapping("")
  35.     public List<JpaUser> findAll(){
  36.         return jpaUserService.findAllUser();
  37.     }
  39.     /**
  40.      * id查用户
  41.      */
  42.     @GetMapping("/{id}")
  43.     public JpaUser findbyId(@PathVariable("id") Long id){
  44.         return jpaUserService.findUserById(id);
  45.     }
  47. }

代码ok，开始测试！

测试

单单讲spring-data-jpa的话，就没有加swagger注解了，那么测试我们就使用postman来进行

1.用户插入

POST提交

URL：localhost:2333/user

body数据：

  1. {
  2.     "name":"orange4"
  3. }

返回数据：

  1. {
  2.     "id": 4,
  3.     "name": "orange4",
  4.     "objectVersion": 0,
  5.     "createdBy": null,
  6.     "createdDate": "2020-08-13 16:58:35",
  7.     "lastUpdatedBy": null,
  8.     "lastUpdatedDate": "2020-08-13 16:58:35"
  9. }

分析：

id自动通过序列生成，

name是提交的数据，

版本号自动插入为0，

createdBy,lastUpdatedBy由于还未配置完整，暂时没有数据，

createdDate,lastUpdatedDate在插入时皆为当前时间

2.用户删除

DELETE提交

URL：localhost:2333/user/4

返回数据：状态码 200

分析：

状态码200，代表服务器响应正确，删除成功

3.用户查询（全查）

GET提交

URL：localhost:2333/user

返回数据：

  1. [
  2.     {
  3.         "id": 2,
  4.         "name": "banana",
  5.         "objectVersion": 1,
  6.         "createdBy": null,
  7.         "createdDate": "2020-08-13 15:35:44",
  8.         "lastUpdatedBy": null,
  9.         "lastUpdatedDate": "2020-08-13 16:39:55"
  10.     },
  11.     {
  12.         "id": 3,
  13.         "name": "orange2",
  14.         "objectVersion": 0,
  15.         "createdBy": null,
  16.         "createdDate": "2020-08-13 15:36:00",
  17.         "lastUpdatedBy": null,
  18.         "lastUpdatedDate": "2020-08-13 15:36:00"
  19.     }
  20. ]

分析：

上面插入的id为4的用户此处全查没有，也代表着删除操作的成功

4.用户修改

修改的时候需要全部实体数据哦，因为jpa的save()是全部修改，前端少传一个字段，数据库更新可能就变成null了，特别注意。之后会讲部分更新的实现。

PUT提交

URL：localhost:2333/user

body数据：

  1. {
  2.     "id": 2,
  3.     "name": "banana-update",
  4.     "objectVersion": 1,
  5.     "createdBy": null,
  6.     "createdDate": "2020-08-13 15:35:44",
  7.     "lastUpdatedBy": null,
  8.     "lastUpdatedDate": "2020-08-13 16:39:55"
  9. }

返回数据：

  1. {
  2.     "id": 2,
  3.     "name": "banana-update",
  4.     "objectVersion": 2,
  5.     "createdBy": null,
  6.     "createdDate": "2020-08-13 15:35:44",
  7.     "lastUpdatedBy": null,
  8.     "lastUpdatedDate": "2020-08-13 20:08:18"
  9. }

分析：

因为有了id值，save()方法变为了修改方法，

name的值从banana修改成banana-update，

objectVersion版本号因为@Version注解，从1变为了2，

createdBy和createdDate别看没变，是因为前端传的字段中带了值，如果不传值，数据库会被清成null，切记切记，

lastUpdatedBy和lastUpdatedDate不需要管，传不传值都会自动更新。

注意点：

@Version注解加上后开启乐观锁，更新必须加上objectVersion字段，且值一定要和数据库中的版本号一致，这样才会触发更新操作。

如果不加objectVersion字段，且后端没有验证操作，id值会被忽略，从更新操作变为新增操作，这是一个坑。

5.用户查询（id查）

GET提交

URL：localhost:2333/user/2

返回数据：

  1. {
  2.     "id": 2,
  3.     "name": "banana-update",
  4.     "objectVersion": 2,
  5.     "createdBy": null,
  6.     "createdDate": "2020-08-13 15:35:44",
  7.     "lastUpdatedBy": null,
  8.     "lastUpdatedDate": "2020-08-13 20:08:18"
  9. }

分析：

和修改后的数据一样，就是个简单的id查询

总结

总的来说，jpa带给我的惊喜很多，惊吓也很多，和mybaits各有所长，你们选择哪一个呢？

小孩子才做选择，我全都要！

真·总结：

1.@Version注解加上后，更新操作一定要带上注解修饰的字段，且要与数据库中的值一致。

2.@CreatedBy和@CreatedDate会在更新时一并更新，需要主动去维护，或者在@Column注解中加上updatable = false，比如这样@Column(name = "CREATED_DATE",updatable = false)。

版权说明 : 本文为转载文章, 版权归原作者所有 版权申明

原文链接 : https://lebron.blog.csdn.net/article/details/125147225

内容来源于网络，如有侵权，请联系作者删除！

Javaspringjpa

相关文章

    查看更多

    热门标签

    更多
    JavaquerypythonNode开发语言requestUtil数据库Table后端算法LoggerMessageElementParser

    最新文章

    更多
    • 蜀ICP备13028337号-1 大数据知识库 https://www.saoniuhuo.com © All rights reserved
    • 本站内容来源互联网,如果侵犯您的权益请联系我们删除, 联系方式：448109455@qq.com