介绍

  • 开发中JPA用的较多，所以对它做了一定的封装
    • 定义了常用的实体类
    • 自定义了数据库操作的方法
    • 自定义了简单的动态查询工具
    • 定义了实体的快速转换方法
  • 我只验证了MySQL数据库

    引入依赖

    ```xml
org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-test test cn.jdevelops caches-jpa-server 2.0.4

mysql mysql-connector-java 

  1. <a name="B7oCq"></a>
  2. # 前置操作
  3. <a name="J8crA"></a>
  4. ## ✨主要就是配置数据库的连接，这是常规操作
  5. > **如果要自定建库 ，请参考** [自动建库](https://www.yuque.com/tanning/yg9ipo/os495n?view=doc_embed)
  7. ```yaml
  8. server.port=1238
  9. spring.jpa.show-sql=true
  10. spring.jpa.hibernate.ddl-auto=update
  11. spring.datasource.password=root
  12. spring.datasource.username=root
  13. spring.datasource.url=jdbc:mysql://192.168.0.3:3306/hjpa?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf8&useSSL=false
  14. spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

数据初始化（测试项目）

  1. INSERT INTO `hjpa`.`sys_user`(`id`, `create_time`, `create_user_name`, `update_time`, `update_user_name`, `address`, `login_name`, `login_pwd`, `name`, `phone`, `user_icon`, `user_no`) VALUES (1, '2021-11-17 11:08:38', 'admin', '2021-12-03 14:02:22', 'admin', '重庆s', 'admin', '123', '超级管理员', '15888888888', NULL, 'admin');
  2. INSERT INTO `hjpa`.`sys_user`(`id`, `create_time`, `create_user_name`, `update_time`, `update_user_name`, `address`, `login_name`, `login_pwd`, `name`, `phone`, `user_icon`, `user_no`) VALUES (2, '2021-12-03 13:48:14', 'admin', '2021-12-03 13:50:01', 'admin', '', 'user', '123', '用户1', '231', NULL, '1466645430750781440');
  3. INSERT INTO `hjpa`.`sys_user`(`id`, `create_time`, `create_user_name`, `update_time`, `update_user_name`, `address`, `login_name`, `login_pwd`, `name`, `phone`, `user_icon`, `user_no`) VALUES (3, '2021-12-03 14:05:23', 'admin', '2021-12-03 14:05:43', 'admin', '', 'user02', '123', '用户2', '12321', NULL, '1466649744075108352');
  4. INSERT INTO `hjpa`.`sys_user`(`id`, `create_time`, `create_user_name`, `update_time`, `update_user_name`, `address`, `login_name`, `login_pwd`, `name`, `phone`, `user_icon`, `user_no`) VALUES (4, '2021-12-10 15:02:39', 'admin', '2021-12-10 15:02:39', 'admin', '', 'SH-01', '123', '111', '', NULL, '1469200870634397696');
  5. INSERT INTO `hjpa`.`sys_user`(`id`, `create_time`, `create_user_name`, `update_time`, `update_user_name`, `address`, `login_name`, `login_pwd`, `name`, `phone`, `user_icon`, `user_no`) VALUES (5, '2021-12-10 15:02:49', 'admin', '2021-12-10 15:03:00', 'admin', '222', 'LR-01', '1231', '111', '1312', NULL, '1469200914007695360');

全局异常处理

全局异常捕获

基础配置

实体继承JpaAuditFields可选

如果不使用基础字段，一定要继承 SerializableVO，因为有些功能用到了里面的内置方法

  1. package cn.tannn.hjpa.entity;
  3. import lombok.Data;
  4. import lombok.EqualsAndHashCode;
  5. import org.hibernate.annotations.DynamicInsert;
  6. import org.hibernate.annotations.DynamicUpdate;
  8. import javax.persistence.Column;
  9. import javax.persistence.Entity;
  10. import javax.persistence.Index;
  11. import javax.persistence.Table;
  13. /**
  14.  * 用户表
  15.  * @author : tn
  16.  * @date : 2021-9-10
  17.  */
  18. @Entity
  19. @Table(name = "sys_user",
  20.         indexes = {
  21.                 @Index(name = "user_no_index", columnList = "userNo", unique = true),
  22.         })
  23. @org.hibernate.annotations.Table(appliesTo = "sys_user", comment = "用户表")
  24. @Data
  25. @EqualsAndHashCode(callSuper = true)
  26. @DynamicUpdate
  27. @DynamicInsert
  28. public class User extends JpaAuditFields<User> {
  30.     @Id
  31.     @GeneratedValue(strategy = GenerationType.IDENTITY)
  32.     @Column(columnDefinition="int(11) COMMENT '主键，自动生成'")
  33.     private Integer id;
  35.     /**
  36.      * 用户编号
  37.      */
  38.     @Column(columnDefinition = " varchar(50)  not null   comment ' 用户编号' ")
  39.     private String userNo;
  41.     /**
  42.      * 姓名
  43.      */
  44.     @Column(columnDefinition = " varchar(100)  not null   comment ' 姓名' ")
  45.     private String name;
  47.     /**
  48.      * 地址
  49.      */
  50.     @Column(columnDefinition = " varchar(100)   comment ' 地址' ")
  51.     private String address;
  53.     /**
  54.      * 登录名称
  55.      */
  56.     @Column(columnDefinition = " varchar(100)  not null comment '登录名称' ")
  57.     private String loginName;
  59.     /**
  60.      * 登录密码
  61.      */
  62.     @Column(columnDefinition = " varchar(100)  not null comment '登录密码' ")
  63.     private String loginPwd;
  66.     /**
  67.      * 手机号/联系电话
  68.      */
  69.     @Column(columnDefinition = " varchar(15)  comment ' 手机号/联系电话 ' ")
  70.     private String phone;
  72.     /**
  73.      * 用户头像
  74.      */
  75.     @Column(columnDefinition = " varchar(60)   comment ' 用户头像' ")
  76.     private String userIcon;
  78. }

Repository继承JpaBasicsDao

如果实体不使用基础字段，一定要继承 SerializableVO，因为有些功能用到了里面的内置方法

  1. package cn.tannn.hjpa.dao;
  4. import cn.jdevelops.jpa.server.dao.JpaBasicsDao;
  5. import cn.tannn.hjpa.entity.User;
  7. /**
  8.  * 用户表
  9.  *
  10.  * @author tan
  11.  * @date 2021-09-10 1StudentDao1:08
  12.  */
  13. public interface UserDao extends JpaBasicsDao<User, Integer> {
  15. }

Service 继承 J2Service

有个JService 也可以用，但是后期可能会被删除

  1. package cn.tannn.hjpa.service;
  3. import cn.jdevelops.jpa.server.service.J2Service;
  4. import cn.tannn.hjpa.entity.User;
  6. /**
  7.  * 用户表
  8.  *
  9.  * @author lxw
  10.  * @className 用户表
  11.  * @date 2021-09-10 11:24
  12.  */
  13. public interface UserService extends J2Service<User> {
  16. }

ServiceImpl 继承 J2ServiceImpl

service 使用的是 J2Service则 实现就必须继承 J2ServiceImpl

  1. package cn.tannn.hjpa.service.impl;
  3. import cn.jdevelops.jpa.server.service.impl.J2ServiceImpl;
  4. import cn.tannn.hjpa.dao.UserDao;
  5. import cn.tannn.hjpa.entity.User;
  6. import cn.tannn.hjpa.service.UserService;
  7. import lombok.AllArgsConstructor;
  8. import lombok.extern.slf4j.Slf4j;
  9. import org.springframework.stereotype.Service;
  12. /**
  13.  * 用户表
  14.  *
  15.  * @author lxw
  16.  * @className * 用户表
  17.  * @date 2021-09-10 11:41
  18.  */
  19. @Slf4j
  20. @Service
  21. public class UserServiceImpl extends J2ServiceImpl<UserDao, User, Integer> implements UserService {
  23. }

使用演示

自带的方法基本都一看都懂，我这儿演示下动态查询个 service中 直接使用 Repository

  • 细节情况本文档的下层文档

JPAUtilExpandCriteria 查询

  1. @Autowired
  2. private UserService userService;
  5. @PostMapping("dyFind")
  6. public ResultVO<List<UserVO>> dyFind(UserFindDTO user){
  7.     User to = user.to(User.class);
  8.     JPAUtilExpandCriteria<User> selectBean = CommUtils.getSelectBean(to);
  9.     List<User> all = userService.getJpaBasicsDao().findAll(selectBean);
  10.     return ResultVO.successForData(User.to(all, UserVO.class));
  11. }

简单使用

调用接口：Post : http://127.0.0.1:8080/dyFind
curl —location —request POST ‘http://127.0.0.1:8080/dyFind‘ —header ‘Content-Type: application/json’ —data-raw ‘{}’

不存参数

查询所有 Hibernate: select user0_.id as id1_0_, user0_.create_time as create_t2_0_, user0_.create_user_name as create_u3_0_, user0_.update_time as update_t4_0_, user0_.update_user_name as update_u5_0_, user0_.address as address6_0_, user0_.login_name as login_na7_0_, user0_.login_pwd as login_pw8_0_, user0_.name as name9_0_, user0_.phone as phone10_0_, user0_.user_icon as user_ic11_0_, user0_.user_no as user_no12_0_ from sys_user user0_ where 1=1

image.png

选择传入

默认 and and 相连 Hibernate: select user0_.id as id1_0_, user0_.create_time as create_t2_0_, user0_.create_user_name as create_u3_0_, user0_.update_time as update_t4_0_, user0_.update_user_name as update_u5_0_, user0_.address as address6_0_, user0_.login_name as login_na7_0_, user0_.login_pwd as login_pw8_0_, user0_.name as name9_0_, user0_.phone as phone10_0_, user0_.user_icon as user_ic11_0_, user0_.user_no as user_no12_0_ from sys_user user0_ where user0_.address=? and user0_.phone=?

image.png

高阶使用

设置条件的 连接符 和 运算符

  1. 在实体中加入 @JpaSelectOperator_(_operator = SQLOperator._EQ_,ignoreNull = true, connect = SQLConnect._AND)_
    1. 详情请看注解注释’
    2. image.png
  2. 传参测试
    1. {
    2.  "name": "超",
    3.  "userNo": "146664"
    4. }
    1. SELECT
    2.  user0_.id AS id1_0_,
    3.  user0_.create_time AS create_t2_0_,
    4.  user0_.create_user_name AS create_u3_0_,
    5.  user0_.update_time AS update_t4_0_,
    6.  user0_.update_user_name AS update_u5_0_,
    7.  user0_.address AS address6_0_,
    8.  user0_.login_name AS login_na7_0_,
    9.  user0_.login_pwd AS login_pw8_0_,
    10.  user0_.NAME AS name9_0_,
    11.  user0_.phone AS phone10_0_,
    12.  user0_.user_icon AS user_ic11_0_,
    13.  user0_.user_no AS user_no12_0_ 
    14. FROM
    15.  sys_user user0_ 
    16. WHERE
    17.  user0_.address =? 
    18.  AND user0_.phone =? Hibernate : SELECT
    19.  user0_.id AS id1_0_,
    20.  user0_.create_time AS create_t2_0_,
    21.  user0_.create_user_name AS create_u3_0_,
    22.  user0_.update_time AS update_t4_0_,
    23.  user0_.update_user_name AS update_u5_0_,
    24.  user0_.address AS address6_0_,
    25.  user0_.login_name AS login_na7_0_,
    26.  user0_.login_pwd AS login_pw8_0_,
    27.  user0_.NAME AS name9_0_,
    28.  user0_.phone AS phone10_0_,
    29.  user0_.user_icon AS user_ic11_0_,
    30.  user0_.user_no AS user_no12_0_ 
    31. FROM
    32.  sys_user user0_ 
    33. WHERE
    34.  user0_.user_no LIKE ? 
    35.  OR user0_.NAME LIKE ?
    image.png

SpecificationUtil 查询

只写了个简单的测试用例，具体使用，等项目中用到了再来补充

HjpaApplicationTests(示例项目中测试类)

  1. package cn.tannn.hjpa;
  3. import cn.jdevelops.jap.core.util.JPAUtilExpandCriteria;
  4. import cn.jdevelops.jap.core.util.SpecificationUtil;
  5. import cn.jdevelops.jap.core.util.criteria.Restrictions;
  6. import cn.tannn.hjpa.entity.User;
  7. import cn.tannn.hjpa.service.UserService;
  8. import org.junit.jupiter.api.Test;
  9. import org.springframework.beans.factory.annotation.Autowired;
  10. import org.springframework.boot.test.context.SpringBootTest;
  11. import org.springframework.data.jpa.domain.Specification;
  12. import org.springframework.transaction.annotation.Transactional;
  14. @SpringBootTest
  15. @Transactional(rollbackFor = Exception.class)
  16. class HjpaApplicationTests {
  18.     @Autowired
  19.     private UserService userService;
  22.     @Test
  23.     void testSpecificationUtil() {
  24.         /**
  25.          *
  26.          WHERE
  27.          ( address LIKE '%重庆%' )
  28.          AND (
  29.          NAME = '用户'
  30.          OR login_pwd = '123'
  31.          OR phone = '123'
  32.          OR user_no = '123')
  33.          */
  34. //        address().and(
  35. //        name().or(loginPwd()).or(phone()).or(userNo())
  36. //        )
  37.         SpecificationUtil<User> instance = SpecificationUtil.getInstance();
  38.         Specification<User> and = instance.like("address", "重庆", true)
  39.                 .and(instance.eq("name", "用户", true)
  40.                         .or(instance.eq("loginPwd", "123", true))
  41.                         .or(instance.eq("phone", "123", true))
  42.                         .or(instance.eq("userNo", "123", true))
  43.                 );
  44.         userService.getJpaBasicsDao().findAll(and).forEach(System.out::println);
  45.     }
  49.     @Test
  50.     void testAndOr1() {
  51.         /**
  52.          * WHERE
  53.          *     ( address LIKE '重庆' )
  54.          *     AND (
  55.          *         NAME LIKE '%用户%'
  56.          *         OR login_pwd LIKE '123'
  57.          *         OR phone LIKE '123'
  58.          *         OR phone LIKE '123'
  59.          *         )
  60.          */
  61.         userService.getJpaBasicsDao().findAll(
  62.              address().and(name().or(loginPwd()).or(phone()).or(userNo()) )
  63.         ).forEach(System.out::println);
  64.     }
  67.     @Test
  68.     void testAndOr2() {
  69.         userService.getJpaBasicsDao().findAll(
  70.                 address().and(
  71.                         loginPwd().or(phone()).or(name())
  72.                 ).or(
  73.                         loginPwd().and(
  74.                                 phone().or(name())
  75.                         )
  76.                 )
  77.         ).forEach(System.out::println);
  78.     }
  79.     @Test
  80.     void test3() {
  81.         Specification<User>  test = (root, criteriaQuery, criteriaBuilder) -> criteriaQuery.getRestriction();;
  82.         userService.getJpaBasicsDao().findAll(test).forEach(System.out::println);
  83.     }
  85.     public static Specification<User> name() {
  86.         return (root, query, builder) -> builder.like(root.get("name"), "%用户%");
  87.     }
  89.     public static Specification<User> loginPwd() {
  90.         return (root, query, builder) -> builder.like(root.get("loginPwd"), "123");
  91.     }
  93.     public static Specification<User> address() {
  94.         return (root, query, builder) -> builder.like(root.get("address"), "重庆");
  95.     }
  97.     public static Specification<User> phone() {
  98.         return (root, query, builder) -> builder.like(root.get("phone"), "123");
  99.     }
  101.     public static Specification<User> userNo() {
  102.         return (root, query, builder) -> builder.like(root.get("phone"), "123");
  103.     }
  106. }

其他

SerializableVO

实体互转方法to JpaExample to = jpaExampleVo.to(JpaExample.class);

  • to(list, Bvo.Class) List转List
  • to(b, Bvo.Class) B转Bvo
  • to(Page, Bvo.Class) JPA的Page转 Page

  • ·········

    JpaAuditFields

    2.   /**
    3.    * 表示该字段为创建时间字段，在这个实体被insert的时候，会自动为其赋值
    4.    */
    5.   @ApiModelProperty(value = "创建时间",hidden=true)
    6.   private LocalDateTime createTime;
    8.   /**
    9.    * 表示该字段为创建人，在这个实体被insert的时候，会自动为其赋值
    10.    */
    11.   @ApiModelProperty(value = "创建人",hidden=true)
    12.   private String createUserName;
    14.   /**
    15.    * 表示该字段为修改时间字段，在这个实体被update的时候，会自动为其赋值
    16.    */
    17.   @ApiModelProperty(value = "修改时间",hidden=true)
    18.   private LocalDateTime updateTime;
    20.   /**
    21.    * 表示该字段为修改人，在这个实体被update的时候，会自动为其赋值
    22.    */
    23.   @ApiModelProperty(value = "修改人",hidden=true)
    24.   private String updateUserName;

    JPA的预处理使用的MySQL版本选择测试

    示例项目地址

    https://github.com/en-o/Jdevelops-Example/tree/main/HJPA