JPA中实体类属性相关注解与数据表列映射详解

① @Entity

@Entity 标注用于实体类声明语句之前,指出该Java 类为实体类,将映射到指定的数据库表。

如声明一个实体类 Customer,它将映射到数据库中的 customer 表上。

@Entity //告诉JPA这是一个实体类(和数据表映射的类)
@Table(name = "tb_customer ") 
//@Table来指定和哪个数据表对应;如果省略默认表名就是customer;
public class Customer implements Serializable{

  

② @Table

当实体类与其映射的数据库表名不同名时需要使用 @Table 标注说明,该标注与 @Entity 标注并列使用,置于实体类声明语句之前,可写于单独语句行,也可与声明语句同行。

@Table 标注的常用选项是 name,用于指明数据库的表名。

@Table标注还有一个两个选项 catalog 和 schema 用于设置表所属的数据库目录或模式,通常为数据库名。uniqueConstraints 选项用于设置约束条件,通常不须设置。

@Table(name="JPA_CUTOMERS")
@Entity
public class Customer {
//...
}

③ @Id

@Id 标注用于声明一个实体类的属性映射为数据库的主键列。

该属性通常置于属性声明语句之前,可与声明语句同行,也可写在单独行上。

@Id标注也可置于属性的getter方法之前。


④ @GeneratedValue

@GeneratedValue 用于标注主键的生成策略,通过 strategy 属性指定。

默认情况下,JPA 自动选择一个最适合底层数据库的主键生成策略:SqlServer 对应 identity,MySQL 对应 auto increment。

在 javax.persistence.GenerationType 中定义了以下几种可供选择的策略:

IDENTITY:采用数据库 ID自增长的方式来自增主键字段,Oracle 不支持这种方式;

AUTO: JPA自动选择合适的策略,是默认选项;

SEQUENCE:通过序列产生主键,通过 @SequenceGenerator 注解指定序列名,MySql 不支持这种方式;

TABLE:通过表产生主键,框架借由表模拟序列产生主键,使用该策略可以使应用更易于数据库移植。

实例如下:

//主键自增方式
@GeneratedValue(strategy=GenerationType.IDENTITY)
@Id
public Integer getId() {
	return id;
}

⑤ @Column

当实体的属性与其映射的数据库表的列不同名时需要使用@Column 标注说明,该属性通常置于实体的属性声明语句之前,还可与 @Id 标注一起使用。

@Column 标注的常用属性是 name,用于设置映射数据库表的列名。此外,该标注还包含其它多个属性,如:unique(唯一约束) 、nullable(非空)、length(字段长度) 等。

@Column 标注的 columnDefinition 属性: 表示该字段在数据库中的实际类型。

通常 ORM 框架可以根据属性类型自动判断数据库中字段的类型,但是对于Date类型仍无法确定数据库中字段类型究竟是DATE,TIME还是TIMESTAMP。

此外,String的默认映射类型为VARCHAR, 如果要将 String 类型映射到特定数据库的 BLOB 或TEXT 字段类型。

@Column标注也可置于属性的getter方法之前

@Column(name="ID")
@GeneratedValue(strategy=GenerationType.IDENTITY)
@Id
public Integer getId() {
	return id;
}

⑥ @Basic

@Basic 表示一个简单的属性到数据库表的字段的映射,对于没有任何标注的 getXxxx() 方法,默认即为@Basic。

**fetch: **表示该属性的读取策略,有 EAGER 和 LAZY 两种,分别表示主支抓取和延迟加载,默认为 EAGER。

**optional:**表示该属性是否允许为null, 默认为true。


⑦ @Transient

表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性。

如果一个属性并非数据库表的字段映射,就务必将其标示为@Transient,否则,ORM框架默认其注解为@Basic。

对于该注解,可以联想一下序列化中的transient修饰符。


⑧ @Temporal

在核心的 Java API 中并没有定义 Date 类型的精度(temporal precision)。

而在数据库中,表示 Date 类型的数据有 DATE, TIME, 和 TIMESTAMP 三种精度(即单纯的日期,时间,或者两者 兼备)。

在进行属性映射时可使用@Temporal注解来调整精度。

@Temporal(TemporalType.TIMESTAMP)
public Date getCreatedTime() {
	return createdTime;
}

public void setCreatedTime(Date createdTime) {
	this.createdTime = createdTime;
}

@Temporal(TemporalType.DATE)
public Date getBirth() {
	return birth;
}

public void setBirth(Date birth) {
	this.birth = birth;
}

⑨ @MappedSuperclass

基于代码复用和模型分离的思想,在项目开发中使用JPA的@MappedSuperclass注解将实体类的多个属性分别封装到不同的非实体类中。可以将一些共有属性封装到父类中,让其他实体继承。

有几点需要注意:

  • @MappedSuperclass注解只能标准在类上:@Target({java.lang.annotation.ElementType.TYPE})

  • 标注为@MappedSuperclass的类将不是一个完整的实体类,他将不会映射到数据库表,但是他的属性都将映射到其子类的数据库字段中。

  • 标注为@MappedSuperclass的类不能再标注@Entity或@Table注解,也无需实现序列化接口。

但是如果一个标注为@MappedSuperclass的类继承了另外一个实体类或者另外一个同样标注了@MappedSuperclass的类的话,他将可以使用@AttributeOverride或@AttributeOverrides注解重定义其父类(无论是否是实体类)的属性映射到数据库表中的字段。

父类实例如下:

@MappedSuperclass
public abstract class IdEntity {

    protected Long id;
    protected Date createTime;
    protected Date updateTime;

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+08:00")
    public Date getCreateTime() {
        return createTime;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }

    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+08:00")
    public Date getUpdateTime() {
        return updateTime;
    }

    public void setUpdateTime(Date updateTime) {
        this.updateTime = updateTime;
    }
}

⑩ @TableGenerator

将当前主键的值单独保存到一个数据库的表中,主键的值每次都是从指定的表中查询来获得。

这种方法生成主键的策略可以适用于任何数据库,不必担心不同数据库不兼容造成的问题。

注意与③④区别。

	@TableGenerator(name="ID_GENERATOR",
			table="jpa_id_generators",
			pkColumnName="PK_NAME",
			pkColumnValue="CUSTOMER_ID",
			valueColumnName="PK_VALUE",
			initialValue=1,
			allocationSize=1)		     
	@GeneratedValue(strategy=GenerationType.TABLE,
			generator="ID_GENERATOR")
	@Id
	public Integer getId() {
		return id;
	}

@TableGenerator属性解释:

name 属性表示该主键生成策略的名称,它被引用在@GeneratedValue中设置的generator 值中;

table 属性表示生成策略所持久化的表名;

pkColumnName 属性的值表示在持久化表中,该主键生成策略所对应键值的名称;

pkColumnValue 属性的值表示在持久化表中,该生成策略所对应的主键名称;

-- pkColumnName和pkColumnValue确定生成的主键名称是什么。--

valueColumnName 属性的值表示在持久化表中,该主键当前所生成的值,它的值将会随着每次创建累加;

initialValue属性的值表示主键生成时的初始值,默认为0;

allocationSize 表示每次主键值增加的大小, 默认值为 50。例如设置成1,则表示每次创建新记录后自动加1。



这里写图片描述


如下先手动创建表:jpa_id_generators

这里写图片描述


使用main方法执行:

import java.util.Date;

import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;
import javax.persistence.EntityTransaction;
import javax.persistence.Persistence;

public class Main {
	
	public static void main(String[] args) {
		
		//1. 创建 EntitymanagerFactory
		String persistenceUnitName = "jpa-1";
		
		EntityManagerFactory entityManagerFactory = 
				Persistence.createEntityManagerFactory(persistenceUnitName);
		
		//2. 创建EntityManager. 对应 Hibernate 的 SessionFactory
		EntityManager entityManager = entityManagerFactory.createEntityManager();
		
		//3. 开启事务
		EntityTransaction transaction = entityManager.getTransaction();
		transaction.begin();
		
		//4. 进行持久化操作
		Customer customer = new Customer();
		customer.setAge(12);
		customer.setEmail("tom@163.com");
		customer.setLastName("Tom");
		customer.setBirth(new Date());
		customer.setCreatedTime(new Date());
		
		entityManager.persist(customer);
		
		//5. 提交事务
		transaction.commit();
		
		//6. 关闭EntityManager
		entityManager.close();
		
		//7.关闭 EntityManagerFactory
		entityManagerFactory.close();
	}
	
}

Customer 实体类如下:


import java.util.Date;
import java.util.HashSet;
import java.util.Set;

import javax.persistence.Cacheable;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.NamedQuery;
import javax.persistence.OneToMany;
import javax.persistence.Table;
import javax.persistence.TableGenerator;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.persistence.Transient;
 
@NamedQuery(name="testNamedQuery", query="FROM Customer c WHERE c.id = ?")
@Cacheable(true)
@Table(name="jpa_cutomers")
@Entity
public class Customer {

	private Integer id;
	private String lastName;

	private String email;
	private int age;
	
	private Date createdTime;
	private Date birth;
	
	public Customer() {
	}
	
	public Customer(String lastName, int age) {
		super();
		this.lastName = lastName;
		this.age = age;
	}

	@TableGenerator(name="ID_GENERATOR",
			table="jpa_id_generators",
			pkColumnName="PK_NAME",
			pkColumnValue="CUSTOMER_ID",
			valueColumnName="PK_VALUE",
			initialValue=1,
			allocationSize=1)
	@GeneratedValue(strategy=GenerationType.TABLE,generator="ID_GENERATOR")
//	@GeneratedValue(strategy=GenerationType.AUTO)
	@Id
	public Integer getId() {
		return id;
	}

	public void setId(Integer id) {
		this.id = id;
	}

	@Column(name="last_name",length=50,nullable=false)
	public String getLastName() {
		return lastName;
	}

	public void setLastName(String lastName) {
		this.lastName = lastName;
	}

	@Column(name="email",length=50)
	public String getEmail() {
		return email;
	}

	public void setEmail(String email) {
		this.email = email;
	}

	public int getAge() {
		return age;
	}

	public void setAge(int age) {
		this.age = age;
	}
	
	@Column(name="created_time")
	@Temporal(TemporalType.TIMESTAMP)
	public Date getCreatedTime() {
		return createdTime;
	}

	
	public void setCreatedTime(Date createdTime) {
		this.createdTime = createdTime;
	}

	@Temporal(TemporalType.DATE)
	public Date getBirth() {
		return birth;
	}

	public void setBirth(Date birth) {
		this.birth = birth;
	}

	//
	@Transient
	public String getInfo(){
		return "lastName: " + lastName + ", email: " + email;
	}
}


persistence.xml

<?xml version="1.0" encoding="UTF-8"?>
<persistence version="2.0"
	xmlns="http://java.sun.com/xml/ns/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_2_0.xsd">
	<persistence-unit name="jpa-1" transaction-type="RESOURCE_LOCAL">
		<!-- 
		配置使用什么 ORM 产品来作为 JPA 的实现 
		1. 实际上配置的是  javax.persistence.spi.PersistenceProvider 接口的实现类
		2. 若 JPA 项目中只有一个 JPA 的实现产品, 则也可以不配置该节点. 
		-->
		<provider>org.hibernate.ejb.HibernatePersistence</provider>
	
		<!-- 添加持久化类 -->
		<class>com.entity.Customer</class>
		
		<!-- 
		配置二级缓存的策略 
		ALL:所有的实体类都被缓存
		NONE:所有的实体类都不被缓存. 
		ENABLE_SELECTIVE:标识 @Cacheable(true) 注解的实体类将被缓存
		DISABLE_SELECTIVE:缓存除标识 @Cacheable(false) 以外的所有实体类
		UNSPECIFIED:默认值,JPA 产品默认值将被使用
		-->
		<shared-cache-mode>ENABLE_SELECTIVE</shared-cache-mode>
	
		<properties>
			<!-- 连接数据库的基本信息 -->
			<property name="javax.persistence.jdbc.driver" value="com.mysql.jdbc.Driver"/>
			<property name="javax.persistence.jdbc.url" value="jdbc:mysql:///jpa"/>
			<property name="javax.persistence.jdbc.user" value="root"/>
			<property name="javax.persistence.jdbc.password" value="123456"/>
			
			<!-- 配置 JPA 实现产品的基本属性. 配置 hibernate 的基本属性 -->
			<property name="hibernate.format_sql" value="true"/>
			<property name="hibernate.show_sql" value="true"/>
			<property name="hibernate.hbm2ddl.auto" value="update"/>
			
			<!-- 二级缓存相关 -->
			<property name="hibernate.cache.use_second_level_cache" value="true"/>
			<property name="hibernate.cache.region.factory_class" value="org.hibernate.cache.ehcache.EhCacheRegionFactory"/>
			<property name="hibernate.cache.use_query_cache" value="true"/>
		</properties>
	</persistence-unit>
</persistence>


jar如下:

这里写图片描述


控制台日志如下:

这里写图片描述


数据库表变化如下:

这里写图片描述

这里写图片描述


再次运行main方法:

这里写图片描述

可知,PK_VALUE为每次+1,存在initialValue属性值时,第一次id的值为该属性值,以后id值为当前id最大值+allocationSize。


测试2,删除生成的表jpa_customer,并将PK_VALUE改为1。

@TableGenerator属性修改如下:

	@TableGenerator(name="ID_GENERATOR",
			table="jpa_id_generators",
			pkColumnName="PK_NAME",
			pkColumnValue="CUSTOMER_ID",
			valueColumnName="PK_VALUE",
//			initialValue=1,
			allocationSize=2)

运行结果如下:

这里写图片描述

没有initialValue时,id第一次生成的值为 :0(initialValue 默认值)+allocationSize。


测试3,不先手动创建表jpa_id_generators情况下:

控制台日志输出如下:

这里写图片描述


数据库显示如下:

这里写图片描述


再次运行main方法:

控制台日志如下:

这里写图片描述


数据表显示如下:

这里写图片描述

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

流烟默

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值