JPA实体的常用注解

1 、 @Entity(name="EntityName")

     
     
  1. 必须 ,name 为可选 , 对应数据库中一的个表

2 、 @Table(name="",catalog="",schema="")

     
     
  1. 可选 , 通常和 @Entity 配合使用 , 只能标注在实体的 class 定义处 , 表示实体对应的数据库表的信息
  2. name: 可选 , 表示表的名称 . 默认地 , 表名和实体名称一致 , 只有在不一致的情况下才需要指定表名
  3. catalog: 可选 , 表示 Catalog 名称 , 默认为 Catalog("").
  4. schema: 可选 , 表示 Schema 名称 , 默认为 Schema("").

3 、 @id

     
     
  1. 必须
  2. @id 定义了映射到数据库表的主键的属性 , 一个实体只能有一个属性被映射为主键 . 置于 getXxxx() .

4 、 @GeneratedValue(strategy=GenerationType,generator="")

     
     
  1. 可选
  2. strategy: 表示主键生成策略 , AUTO,INDENTITY,SEQUENCE TABLE 4 , 
  3. 分别表示
    1. AUTO-- ORM 框架自动选择,
    2. INDENTITY--根据数据库的 Identity 字段生成 , 
    3. SEQUENCE --根据数据库表的 Sequence 字段生成 ,
    4. TABLE --以有根据一个额外的表生成主键 , 
    1. 默认为AUTO
  4. generator: 表示主键生成器的名称 , 这个属性通常和 ORM 框架相关 , 
  5. 例如 ,Hibernate 可以指定 uuid 等主键生成方式 .

     
     
  1. 示例 :
  2. @Id
  3. @GeneratedValues(strategy=StrategyType.SEQUENCE)
  4. public int getPk() {
  5. return pk;
  6. }

5 、 @Basic(fetch=FetchType,optional=true)

     
     
  1. 可选
  2. @Basic 表示一个简单的属性到数据库表的字段的映射 , 
  3. 对于没有任何标注的 getXxxx() 方法 , 默认即为 @Basic
  4. fetch: 表示该属性的读取策略 , EAGER LAZY 两种 , 
  5. 分别表示立即抓取延迟加载 , 默认为 EAGER.
  6. optional: 表示该属性是否允许为 null, 默认为 true
      
      
  1. 示例 :
  2. @Basic(optional=false)
  3. public String getAddress() {
  4. return address;
  5. }

6 、 @Column

     
     
  1. 可选
  2. @Column 描述了数据库表中该字段的详细定义 , 
  3. 这对于根据 JPA 注解生成数据库表结构的工具非常有作用 .
  4. name: 表示数据库表中该字段的名称 , 默认情形属性名称一致
  5. nullable: 表示该字段是否允许为 null, 默认为 true
  6. unique: 表示该字段是否是唯一标识 , 默认为 false
  7. length: 表示该字段的大小 , 仅对 String 类型的字段有效
  8. insertable: 表示在 ORM 框架执行插入操作时 , 该字段是否应出现 INSETRT 语句中 , 默认为 true
  9. updateable: 表示在 ORM 框架执行更新操作时 , 该字段是否应该出现在 UPDATE 语句中 , 默认为 true. 
  10. 对于一经创建就不可以更改的字段 , 该属性非常有用 , 如对于 birthday 字段 .
  11. columnDefinition: 表示该字段在数据库中的实际类型 . 
  12. 通常 ORM 框架可以根据属性类型自动判断数据库中字段的类型 , 
  13. 但是对于 Date 类型仍无法确定数据库中字段类型究竟是 DATE,TIME 还是 TIMESTAMP.
  14. 此外 ,String 的默认映射类型为 VARCHAR, 如果要将 String 类型映射到特定数据库的 BLOB TEXT 字段类型 , 
  15. 该属性非常有用 .
      
      
  1. 示例 :
  2. @Column(name="BIRTH",nullable="false",columnDefinition="DATE")
  3. public String getBithday() {
  4. return birthday;
  5. }

7 、 @Transient

     
     
  1. 可选
  2. @Transient 表示该属性并非一个到数据库表的字段的映射 ,ORM 框架将忽略该属性 .
  3. 如果一个属性并非数据库表的字段映射 , 就务必将其标示为 @Transient, 
  4. 否则 ,ORM 框架默认其注解为 @Basic
      
      
  1. 示例 :
  2. // 根据 birth 计算出 age 属性
  3. @Transient
  4. public int getAge() {
  5. return getYear(new Date()) - getYear(birth);
  6. }
       
       
  1.  例如,我们string对应到数据库中的text就可以这样写,@Column(columnDefinition="text")

7 、其他
      
      
  1. @Temporal
  2.   指定时间类型,例如,@Temporal(TemporalType.Date)
  3. @Enumerated(EmumType.STRING) 注解指定枚举类型
  4.   其中,EmumTypes表示保存到数据库中是索引还是字符串
  5. @Lob声明属性对应的数据库字段为大文本类型,可以存放大的数据(文本和字节)



8 、 @ManyToOne(fetch=FetchType,cascade=CascadeType )

     
     
  1. 可选
  2. @ManyToOne 表示一个多对一的映射 , 该注解标注的属性通常是数据库表的外键
  3. optional: 是否允许该字段为 null, 该属性应该根据数据库表的外键约束来确定 , 默认为 true
  4. fetch: 表示抓取策略 , 默认为 FetchType.EAGER
  5. cascade: 表示默认的级联操作策略 , 
  6. 可以指定为 ALL,PERSIST,MERGE,REFRESH REMOVE 中的若干组合 , 默认为无级联操作
  7. targetEntity: 表示该属性关联的实体类型 . 
  8. 该属性通常不必指定 ,ORM 框架根据属性类型自动判断targetEntity.
      
      
  1. 示例 :
  2. // 订单 Order 和用户 User 是一个 ManyToOne 的关系
  3. // 在 Order 类中定义
  4. @ManyToOne()
  5. @JoinColumn(name="USER")
  6. public User getUser() {
  7. return user;
  8. }

9 、 @JoinColumn

     
     
  1. 可选
  2. @JoinColumn @Column 类似 , 但他描述的不是一个简单字段 , 而一一个关联字段 , 
  3. 例如 . 描述一个@ManyToOne 的字段 .
  4. name: 该字段的名称 . 由于 @JoinColumn 描述的是一个关联字段 , 
  5. ManyToOne, 则默认的名称由其关联的实体决定 .
  6. 例如 , 实体 Order 有一个 user 属性来关联实体 User, Order user 属性为一个外键 ,
  7. 其默认的名称实体 User 的名称 + 下划线 + 实体 User 的主键名称
      
      
  1. 示例 :
  2. @ManyToOne


10 、 @OneToMany(fetch=FetchType,cascade=CascadeType)

     
     
  1. 可选
  2. @OneToMany 描述一个一对多的关联 , 该属性应该为集体类型 ,
  3. 在数据库中并没有实际字段 .
  4. fetch: 表示抓取策略 , 默认为 FetchType.LAZY, 
  5. 因为关联的多个对象通常不必从数据库预先读取到内存
  6. cascade: 表示级联操作策略 , 对于 OneToMany 类型的关联非常重要 , 
  7. 通常该实体更新或删除时 , 其关联的实体也应当被更新或删除
  8. 例如 : 实体 User Order OneToMany 的关系 , 
  9. 则实体 User 被删除时 , 其关联的实体 Order 也应该被全部删除
      
      
  1. 示例 :
  2. @OneTyMany(cascade=ALL)
  3. public List getOrders() {
  4. return orders;
  5. }


11 、 @OneToOne(fetch=FetchType,cascade=CascadeType)

     
     
  1. 可选
  2. @OneToOne 描述一个一对一的关联
  3. fetch: 表示抓取策略 , 默认为 FetchType.LAZY
  4. cascade: 表示级联操作策略
      
      
  1. 示例 :
  2. @OneToOne(fetch=FetchType.LAZY)
  3. public Blog getBlog() {
  4. return blog;
  5. }

12 、 @ManyToMany

     
     
  1. 可选
  2. @ManyToMany 描述一个多对多的关联 . 多对多关联上是两个一对多关联 , 
  3. 但是在 ManyToMany 描述中 , 中间表是由ORM 框架自动处理
  4. targetEntity: 表示多对多关联的另一个实体类的全名 , 例如 :package.Book.class
  5. mappedBy: 表示多对多关联的另一个实体类的对应集合属性名称
      
      
  1. 示例 :
  2. User 实体表示用户 ,Book 实体表示书籍 , 为了描述用户收藏的书籍 , 可以在 User Book 之间建立ManyToMany 关联
  3.           
              
    1. @Entity
    2. public class User {
    3. private List books;
    4. @ManyToMany(targetEntity=package.Book.class)
    5. public List getBooks() {
    6. return books;
    7. }
    8. public void setBooks(List books) {
    9. this.books=books;
    10. }
    11. }

  4.           
              
    1. @Entity
    2. public class Book {
    3. private List users;
    4. @ManyToMany(targetEntity=package.Users.class, mappedBy="books")
    5. public List getUsers() {
    6. return users;
    7. }
    8. public void setUsers(List users) {
    9. this.users=users;
    10. }
    11. }

       
       
  1. 两个实体间相互关联的属性必须标记为 @ManyToMany, 并相互指定 targetEntity 属性 ,
  2. 需要注意的是 , 有且只有一个实体的 @ManyToMany 注解需要指定 mappedBy 属性

13、@TransactionAttribute

     
     
  1. 事务管理服务
  2. 最有用的容器服务可能就是事务管理服务,当应用出现失败或异常时,它保证了数据库的完整性。
  3. 你可以简单地将为一个 POJO方法申明它的事务属性。这样容器就可以在合适的上下文中运行这个方法。
  4. 最常见的事务是定义在 session bean 的方法上,方法中所有的数据库操作只有在方法正常退出时才会提交,
  5. 如果方法抛出未捕获的异常,事务管理将回滚所有的变更。
      
      
  1. @TransactionAttribute 注释用作定义一个需要事务的方法。例如:
  2. @TransactionAttribute(TransactionAttributeType.REQUIRED)
  3. public void insertProduct(String name, Float price, boolean error) {
  4. }
       
       
  1. 它可以有以下参数:
  2. a. REQUIRED : 方法在一个事务中执行,如果调用的方法已经在一个事务中,则使用该事务,否则将创建一个新的事务。
  3. b. MANDATORY : 方法必须在一个事务中执行,也就是说调用的方法必须已经有一个事务,否则新抛出一个错误(ERROR )。
  4. c. REQUIRESNEW : 方法将在一个新的事务中执行,如果调用的方法已经在一个事务中,则暂停旧的事务。
  5. d. SUPPORTS : 如果方法在一个事务中被调用,则使用该事务,否则不使用事务。
  6. e. NOT_SUPPORTED 如果方法在一个事务中被调用,将抛出一个错误( ERROR
  7. 如果没有指定参数, @TransactionAttribute 注释使用 REQUIRED 作为默认参数。

14、@PersistenceContextType

     
     
  1. PersistenceContextType.EXTENDED
  2. 在默认情况下,EntityManagersTRANSACTION PersistenceContextType来创建。
  3. 这样做也就表示,只有当有活动的事务处理在进行时,实体才是可托管的。
  4. 事务处理一结束,实体就与实 体管理程序脱离,这样我们就可以丢弃它。
  5. EXTENDED上下文类型表示这种脱离不会发生,即使在事务处理结束后实体仍然是可托管的。
  6. 这就意味着你不需要 担心集合是否被暂缓取回,因为实体管理程序可以用来完成所需要的取回操作。
  7. 当我们想要保持和更新/合并实体,或者从数据库里删除实体的时候,我们仍然需要 获得EntityTransaction

      
      
  1. 例如我们想要保存一个新的Application实体:
  2. public void saveApplication(Application a) {
  3. EntityTransaction tx=em.getTransaction();
  4. tx.begin();
  5. em.persist(a);
  6. tx.commit();
  7. }

猜你喜欢

转载自www.cnblogs.com/jpfss/p/10895336.html
今日推荐