结合网上的一些知识,与实际应用情况,对JPA注解做了一些总结:
1.设置Pojo为实体
@Entity //标识这个pojo是一个jpa实体 public class Users implements Serializable { }
2.设置表名
@Entity @Table(name = "users") //指定表名为users public class Users implements Serializable { }
3.设置主键
public class Users implements Serializable { @Id private String userCode;
4. 设置字段类型
通过@Column注解设置,包含的设置如下
name:表示数据库表中该字段的名称,默认情形属性名称一致
unique:表示该字段是否是唯一标识,默认为false
nullable:表示该字段是否允许为null,默认为true
length: 表示该字段的大小,仅对String类型的字段有效
inserttable:表示在ORM框架执行插入操作时,该字段是否应出现INSETRT语句中,默认为true
updateable:表示在ORM框架执行更新操作时,该字段是否应该出现在UPDATE语句中,默认为true.对于一经创建就不可以更改的字段,该属性非常有用,如对于birthday字段
columnDefinition: 表示该字段在数据库中的实际类型.通常ORM框架可以根据属性类型自动判断数据库中字段的类型,但是对于Date类型仍无法确定数据库中字段类型究竟是DATE,TIME还是TIMESTAMP.此外,String的默认映射类型为VARCHAR,如果要将String类型映射到特定数据库的BLOB或TEXT字段类型,该属性非常有用
secondaryTable: 从表名。如果此列不建在主表上(默认建在主表),该属性定义该列所在从表的名字。
//设置属性userCode对应的字段为user_code,长度为32,非空 @Column(name = "user_code", nullable = false, length=32) private String userCode; //设置属性wages对应的字段为user_wages,12位数字可保留两位小数,可以为空 @Column(name = "user_wages", nullable = true, precision=12, scale=2) private double wages; //设置为时间类型,TemporalType有3种类型:TIMESTAMP,DATE,TIME @Temporal(TemporalType.DATE) private Date joinDate;
5.字段排序
在加载数据的时候可以为其指定顺序,使用@OrderBy注解实现
@Table(name = "USERS") public class User { @OrderBy(name = "group_name ASC, name DESC") private List books = new ArrayList(); }
Set集合为无序,不能使用@OrderBy.
6.主键生成策略
public class Users implements Serializable { @Id @GeneratedValue(strategy=GenerationType.IDENTITY)//主键自增,注意,这种方式依赖于具体的数据库,如果数据库不支持自增主键,那么这个类型是没法用的 @Column(name = "user_id", nullable = false) private int userId; public class Users implements Serializable { @Id @GeneratedValue(strategy=GenerationType.TABLE)//通过一个表来实现主键id的自增,这种方式不依赖于具体的数据库,可以解决数据迁移的问题 @Column(name = "user_code", nullable = false) private String userCode; public class Users implements Serializable { @Id @GeneratedValue(strategy=GenerationType.SEQUENCE)//通过Sequence来实现表主键自增,这种方式依赖于数据库是否有SEQUENCE,如果没有就不能用 @SequenceGenerator(name="seq_user") @Column(name = "user_id", nullable = false) private int userId;
7.一对多映射关系
有T_One和T_Many两个表,他们是一对多的关系,注解范例如下
主Pojo
@Entity @Table(name = "T_ONE") public class One implements Serializable { private static final long serialVersionUID = 1L; @Id @Column(name = "ONE_ID", nullable = false) private String oneId; @Column(name = "DESCRIPTION") private String description; @OneToMany(cascade = CascadeType.ALL, mappedBy = "oneId")//级联,指向多的那方的pojo的关联外键字段 private Collection<Many> manyCollection;
子Pojo
@Entity @Table(name = "T_MANY") public class Many implements Serializable { private static final long serialVersionUID = 1L; @Id @Column(name = "MANY_ID", nullable = false) private String manyId; @Column(name = "DESCRIPTION") private String description; //设置在“一方”pojo的外键字段上 @ManyToOne(cascade = {CascadeType.MERGE,CascadeType.REFRESH}) //cascade可不写 @JoinColumn(name = "ONE_ID", referencedColumnName = "ONE_ID")//设置对应数据表的列名和引用的数据表的列名,referencedColumnName可不写 private One oneId;
还有一种情况,当实体自关联时
@Entity @Table(name = "ZCPLT_APP_APPMENUGRP") public class AppMenuGroup extends BaseAuditEntity{ private static final long serialVersionUID = 5910574382097344580L; @Column(name = "SN") private int serialNumber; //序号,菜单分组排序 //optional:表示该属性是否允许为null,默认为true @ManyToOne(optional = true) @JoinColumn(name = "PARENT_ID") private AppMenuGroup parent; @OneToMany(cascade = CascadeType.REMOVE, fetch = FetchType.LAZY, mappedBy = "parent") private Set<AppMenuGroup> children = new HashSet<AppMenuGroup>();
8.多对多映射关系
多对多关系可以转换成两个一对多的关联关系。多对多关系可以不需要设置级联。
第一个Pojo
@Entity @Table(name = "T_MANYA") public class ManyA implements Serializable { private static final long serialVersionUID = 1L; @Id @Column(name = "MANYA_ID", nullable = false) private String manyaId; @Column(name = "DESCRIPTION") private String description; @ManyToMany(cascade = {CascadeType.MERGE, CascadeType.REFRESH}, fetch = FetchType.LAZY) // 只需设置MERGE、REFRESH级联即可,或者不设置 @JoinTable(name = "TMANY1_TMANY2", joinColumns = {@JoinColumn(name = "MANYA_ID", referencedColumnName = "MANYA_ID")}, inverseJoinColumns = {@JoinColumn(name = "MANYB_ID", referencedColumnName = "MANYB_ID")}) private Collection<ManyB> manybIdCollection;
第二个Pojo
@Entity @Table(name = "T_MANYB") public class ManyB implements Serializable { private static final long serialVersionUID = 1L; @Id @Column(name = "MANYB_ID", nullable = false) private String manybId; @Column(name = "DESCRIPTION") private String description; @ManyToMany(cascade = {CascadeType.MERGE, CascadeType.REFRESH}, fetch = FetchType.LAZY, mappedBy = "manybIdCollection") private Collection<ManyA> manyaIdCollection;
9.一对一映射关系
单向一对一:
我们只需要通过一个实体得到其对应的实体,而且并不需要反向执行这个操作的时候。我们就需要使用单向一对一关系。举例:人(man) 和 宠物(pet)。前提(一人只养一个宠物)
@Entity @Table(name = "people") public class People (){ @Id //JPA注释: 主键 @GeneratedValue(strategy = GenerationType.AUTO) //设置 id 为自增长 private Long id; private String name; //由于,people 是这个一对一的关系的主控方,所以,在people表中添加了一个 pet 的外键。 //通过这个外键来维护 people和pet的一对一关系,而不是用第三张码表。这个是通过@JoinColumn注释实现的。 @OneToOne //JPA注释: 一对一 关系 @JoinColumn(name="pet_fk" )// 在pepole中,添加一个外键 "pet_fk" private Pet pet; //省略 get / set 方法... }
@Entity @Table(name = "pet") public class Pet (){ @Id @GeneratedValue(strategy = GenerationType.AUTO) private Long id; private String name; //省略 get / set 方法... //因为这是一个单向的一对一关系,并且,是从 people 到 pet 的一对一关系。 //所以,在 pet 中没有与 people 管理的 属性。也就是说,无法通过 pet 找到 people }
双向一对一:
主Pojo
@Entity @Table(name = "T_ONEA") public class OneA implements Serializable { private static final long serialVersionUID = 1L; @Id @Column(name = "ONEA_ID", nullable = false) private String oneaId; @OneToOne(cascade = CascadeType.ALL) //级联 @JoinColumn(name = "ONEB_ID") //在表T_ONEA中,添加一个外键"ONEB_ID" private OneB oneB;
从Pojo
@Entity @Table(name = "T_ONEB") public class OneB implements Serializable { private static final long serialVersionUID = 1L; @Id @Column(name = "ONEB_ID", nullable = false) private String onebId; //注意:由于是双向的一对一关系。作为关系的被维护端。需要在OneB实体中添加和 OneA 关联的属性 //mappedBy 注释:指定了,这个实体是被关系维护端的那个属性所维护。 @OneToOne(mappedBy = "oneB") private OneA oneA;
10 大字段
Clob (Character Large Objects) 类型是长字符串类型,具体的java.sql.Clob, Character[], char[] 和 java.lang.String 将被持久化为 Clob 类型;
Blob (Binary Large Objects) 类型是字节类型,具体的java.sql.Blob, byte[] 和serializable type将被持久化为 Blob 类型。
注:mysql中没有clob
//对应Clob字段类型 @Lob @Column(name = "DESCRIPTION") private String description; //对应Blob字段类型 @Lob @Column(name = "PHOTO") private Serializable photo; @Lob @Basic(fetch = FetchType.LAZY) @Column(name = "LOGO") private byte[] logo;
11.瞬时字段
不需要与数据库映射的字段,在保存的时候不需要保存到数据库
@Transient private int tempValue; public int getTempValue(){ get tempValue; } public void setTempValue(int value){ this.tempValue = value; }
12.@MappedSuperclass将超类的JPA注解传递给子类
可选,@MappedSuperclass可以将超类的JPA注解传递给子类,使子类能够继承超类的JPA注解
@MappedSuperclass public class Employee() { .... } @Entity public class Engineer extends Employee { ..... } @Entity public class Manager extends Employee { ..... }