SpringDataJPA在Entity中常用的注解介绍


Posted in Java/Android onDecember 06, 2021

首先我们常用的注解包括

@Entity、@Table、@Id、@IdClass、@GeneratedValue、@Basic、@Transient、@Column、@Temporal、@Enumerated、@Lob

  • @Entity使用此注解定义的对象将会成为被JPA管理的实体,将映射到指定的数据库表@Entity(name =“user”)其中name默认是此实体类的名字,全局唯一。
  • @Table指定此实体类对应的数据库的表名。若注解不加名字则系统认为表名和实体类的名字相同
  • @Id定义字段为数据库的主键,一个实体里面必须有一个。
  • @IdClass利用外部类的联合主键,其中外部类必须满足一下几点要求

必须实现Serializable接口。

必须有默认的public无参数的构造方法。

必须覆盖equals和hashCode方法。equals方法用于判断两个对象是否相同,EntityManger通过find方法来查找Entity时是根据equals的返回值来判断的。hashCode方法返回当前对象的哈希码,生成的hashCode相同的概率越小越好,算法可以进行优化。

  • @GeneratedValue为主键生成策略

默认为AUTO即JPA自动选择合适的策略

IDENTITY 适用于MySQL,策略为自增

SEQUENCE 通过序列生成主键通过@SquenceGenerator指定序列名MySQL不支持

TABLE 框架由表模拟产生主键,使用该策略有利于数据库移植

  • @Basic表示此字段是映射到数据库,如果实体字段上没有任何注解默认为@Basic。其中可选参数为@Basic(fetch =FetchType.LAZY, optional =false)其中fetch默认为EAGER立即加载,LAZY为延迟加载、optional表示该字段是否可以为null
  • @Transient和@Basic的作用相反,表示该字段不是一个到数据库表的字段映射,JPA映射数据库的时候忽略此字段。
  • @Column定义实体内字段对应的数据库中的列名
@Column(name = "real_name", unique = true, nullable = false, insertable = false, updatable = false, columnDefinition = "varchar", length = 100)

name对应数据库的字段名,可选默认字段名和实体属性名一样

unique是否唯一,默认false,可选

nullable是否允许为空。可选,默认为true

insertable执行insert的时候是否包含此字段。可选,默认true

updatable执行update的时候是否包含此字段。可选,默认true

columnDefinition表示该字段在数据库中的实际类型

length数据库字段的长度,可选,默认25

  • @Temporal用来设置Date类型的属性映射到对应精度的字段
@Temporal(TemporalType.DATE)    //映射为只有日期
@Temporal(TemporalType.TIME)    //映射为只有时间
@Temporal(TemporalType.TIMESTAMP)  //映射为日期+时间
  • @Lob将字段映射成数据库支持的大对象类型,支持一下两种数据库类型的字段。(注意:Clob、Blob占用的内存空间较大,一般配合@Basic(fetch= FetchType.LAZY)将其设置为延迟加载)

Clob:字段类型为Character[]、char[]、String将被映射为Clob

Blob:字段类型为Byte[]、byte[]和实现了Serializable接口的类型将被映射为Blob类型

接下来介绍关联关系注解

@JoinColumn、@OneToOne、@OneToMany、@ManyToOne、@ManyToMany、@JoinTable、@OrderBy

1.@JoinColumn定义外键关联字段名称,其中属性意义如下

  • name表示目标表的字段名,必填
  • referencedColumnName本实体表的字段名,非必填,默认是本表的ID
  • unique外键字段是否唯一,可选,默认false
  • nullable外键字段是否允许为空,可选,默认true
  • insertable新增操作的时候是否跟随一起新增,可选,默认true
  • updatable更新时候是否一起更新。可选,默认true
  • @JoinColumn主要配合@OneToOne、@ManyToOne、@OneToMany一起使用,单独使用没有任何意义。
  • @JoinColumns定义多个字段的关联关系

2.@OneToOne一对一关联关系

@OneToOne(targetEntity = SysRole.class, cascade = {CascadeType.PERSIST,CascadeType.REMOVE,CascadeType.REFRESH,CascadeType.MERGE},fetch = FetchType.LAZY,optional = false,mappedBy = "userId",orphanRemoval = true)
  • targetEntity非必填,默认为该字段的类型
  • cascade级联操作策略CascadeType.PERSIST级联新建,CascadeType.REMOVE级联删除,CascadeType.REFRESH级联刷新,CascadeType.MERGE级联更新,CascadeType.ALL四项全选
  • fetch数据加载方式,默认EAGER(立即加载),LAZY(延迟加载)
  • optional是否允许为空。可选,默认为true
  • mappedBy关联关系被谁维护,非必填,一般不需要特别指定。注意:只有关系维护方才能操作两者的关系,被维护方即使设置了维护方的属性进行存储也不会更新外键关联。mappedBy不能与@JoinColumn或者@JoinTable同时使用。mappedBy的值指的是另一方的实体里面属性的字段,而不是数据库字段,也不是实体对象的名字,即另一方配置了@JoinColumn或者@JoinTable注解的属性的字段名称
  • orphanRemoval是否级联删除,和CascadeType.REMOVE效果一样,两种只要配置一种就会自动级联删除
  • @OneToOne需要配合@JoinColumn一起使用,可以双向关联,也可以只配置一方。下面我们举一个例子:假设一个用户只拥有一个角色SysUser如下
@OneToOne
@JoinColumn(name = "role_id",referencedColumnName = "user_id")
private SysRole role;
//若需要双向关联则SysRole的内容如下
@OneToOne(mappedBy = "role")
private SysUser user;
//当然也可以不用选择mappedBy,使用下面效果也一样
@OneToOne
@JoinColumn(name = "user_id",referencedColumnName = "role_id")
private SysUser user;

3.@OneToMany和@ManyToOne一对多和多对一的关联关系

@Entity
@Table(name="user")
class User implements Serializable{
    private Long userId;
    @OneToMany(cascade = CascadeType.ALL,fetch = FetchType.LAZY,mappedBy = "user")
    private Set<Role> setRole;
}
@Entity
@Table(name="role")
class Role{
    private Long roleId;
    @ManyToOne(cascade = CascadeType.ALL,fetch = FetchType.EAGER)
    @JoinColumn(name = "user_id")//user_id字段作为外键
    private User user;
}

4.@OrderBy关联查询的时候排序,一般和@OneToMany一起使用

@Entity
@Table(name="user")
class User implements Serializable{
    private Long userId;
    @OneToMany(cascade = CascadeType.ALL,fetch = FetchType.LAZY,mappedBy = "user")
    @OrderBy("role_name DESC")
    private Set<Role> setRole;
}

5.@JoinTable关联关系表一般和@ManyToMany一起使用

@ManyToMany表示多对多,也有单双向之分,单双向和注解无关,只看实体类之间是否相互引用

@JoinTable(name = "sys_user_role",
  joinColumns = {@JoinColumn(name = "user_id", referencedColumnName = "id")},
        inverseJoinColumns = {@JoinColumn(name = "role_id", referencedColumnName = "id")})
@ManyToMany(cascade = {CascadeType.REFRESH}, fetch = FetchType.EAGER)
private List<SysRole> roles;
  • @JoinTable中name表示中间关联关系表名
  • @JoinTable中的joinColumns表示主链接表的字段,即当前对象内对应的连接字段
  • @JoinTable中inverseJoinColumns表示被连接的表的外键字段

6.Left Join、Inner join和@EntityGraph

当使用@ManyToMany、@ManytoOne、@OneToMany、@OneToOne关联关系的时候SQL执行查询的时候总是一条主查询语句和N条子查询语句组成,运行的效率较地下,如果子对象有N个就会执行N+1条SQL,JPA2.1推出的@EntityGraph、@NamedEntityGraph用来提高查询效率@NamedEntityGraph配置在@Entity上面,而@EntityGraph配置在Repository的查询方法上面

@NamedEntityGraph(name = "User.addressEntityList",attributeNodes = {@NamedAttributeNode("setRole"),@NamedAttributeNode("dept")})
@Entity
@Table(name="user")
public class User implements Serializable{
    private Long userId;
    @OneToMany(cascade = CascadeType.ALL,fetch = FetchType.LAZY,mappedBy = "user")
    @OrderBy("role_name DESC")
    private Set<Role> setRole;
    @OneToOne
    @JoinColumn(name = "dept_id",referencedColumnName = "user_id")
    private Department dept;
}

然后只需要在Repository查询方法上面加上@EntityGraph注解即可,其中value就是@NamedEntityGraph中的Name,配置如下

@EntityGraph(value ="User.addressEntityList")
List<User> findAll();

对于关系查询需要注意以下事项:

  • 所有的注解要么全部配置在字段上,要么全部配置在get方法上面,不能混用,混用项目就会启动不起来
  • 所有关联都支持单双向关联。当JSON序列化的时候使用双向注解会产生死循环,需要人为手动转换一次,或者使用@JsonIgnore
  • 所有的关联表一般不需要建立外键索引

以上为个人经验,希望能给大家一个参考,也希望大家多多支持三水点靠木。

Java/Android 相关文章推荐
分析Java中Map的遍历性能问题
Jun 26 Java/Android
简单总结SpringMVC拦截器的使用方法
Jun 28 Java/Android
SpringBoot+VUE实现数据表格的实战
Aug 02 Java/Android
springboot layui hutool Excel导入的实现
Mar 31 Java/Android
MyBatis配置文件解析与MyBatis实例演示
Apr 07 Java/Android
Spring Boot配合PageHelper优化大表查询数据分页
Apr 20 Java/Android
IDEA 2022 Translation 未知错误 翻译文档失败
Apr 24 Java/Android
Java由浅入深通关抽象类与接口(上篇)
Apr 26 Java/Android
解决Springboot PostMapping无法获取数据的问题
May 06 Java/Android
Android studio 简单计算器的编写
May 20 Java/Android
spring IOC容器的Bean管理XML自动装配过程
May 30 Java/Android
Android开发手册TextInputLayout样式使用示例
Jun 10 Java/Android
Java中try catch处理异常示例
Dec 06 #Java/Android
SpringDataJPA实体类关系映射配置方式
Dec 06 #Java/Android
Java异常处理try catch的基本用法
Dec 06 #Java/Android
Mybatis是这样防止sql注入的
Dec 06 #Java/Android
Java tomcat手动配置servlet详解
Nov 27 #Java/Android
使用jpa之动态插入与修改(重写save)
Nov 23 #Java/Android
Jpa Specification如何实现and和or同时使用查询
Nov 23 #Java/Android
You might like
各种战术和打法的原创者
2020/03/04 星际争霸
PHP取二进制文件头快速判断文件类型的实现代码
2013/08/05 PHP
php实现的树形结构数据存取类实例
2014/11/29 PHP
PHP-CGI远程代码执行漏洞分析与防范
2017/05/07 PHP
Laravel框架Auth用户认证操作实例分析
2019/09/29 PHP
Laravel5.5 实现后台管理登录的方法(自定义用户表登录)
2019/09/30 PHP
jQuery建立一个按字母顺序排列的友好页面索引(兼容IE6/7/8)
2013/02/26 Javascript
jsp网页搜索结果中实现选中一行使其高亮
2014/02/17 Javascript
手写的一个兼容各种浏览器的javascript getStyle函数(获取元素的样式)
2014/06/06 Javascript
手机端实现Bootstrap简单图片轮播效果
2016/10/13 Javascript
Java中int与integer的区别(基本数据类型与引用数据类型)
2017/02/19 Javascript
Bootstrap下拉菜单Dropdowns的实现代码
2017/03/17 Javascript
使用原生js+canvas实现模拟心电图的实例
2017/09/20 Javascript
layer实现关闭弹出层刷新父界面功能详解
2017/11/15 Javascript
详解vue移动端日期选择组件
2018/02/22 Javascript
Vue props用法详解(小结)
2018/07/03 Javascript
vue模仿网易云音乐的单页面应用
2019/04/24 Javascript
Vue-Cli项目优化操作的实现
2019/10/27 Javascript
vue实现点击按钮“查看详情”弹窗展示详情列表操作
2020/09/09 Javascript
在vue中实现清除echarts上次保留的数据(亲测有效)
2020/09/09 Javascript
python 实现一个贴吧图片爬虫的示例
2017/10/12 Python
python实现随机森林random forest的原理及方法
2017/12/21 Python
Python AES加密实例解析
2018/01/18 Python
实践Vim配置python开发环境
2018/07/02 Python
python traceback捕获并打印异常的方法
2018/08/31 Python
Python设计模式之命令模式原理与用法实例分析
2019/01/11 Python
Django 框架模型操作入门教程
2019/11/05 Python
Python print不能立即打印的解决方式
2020/02/19 Python
详解CSS3媒体查询响应式布局bootstrap 框架原理实战(推荐)
2020/11/16 HTML / CSS
HTML5 Canvas 起步(2) - 路径
2009/05/12 HTML / CSS
客户代表自我评价范例
2013/09/24 职场文书
门面房租房协议书
2014/12/01 职场文书
汽车修理厂管理制度
2015/08/05 职场文书
保险公司岗前培训工作总结
2015/10/24 职场文书
《小蝌蚪找妈妈》教学反思
2016/02/23 职场文书
JavaScript实现栈结构详细过程
2021/12/06 Javascript