JPA的入门案例

1.1    需求介绍

本章节我们是实现的功能是保存一个客户到数据库的客户表中。

1.2    开发包介绍

由于JPA是sun公司制定的API规范，所以我们不需要导入额外的JPA相关的jar包，只需要导入JPA的提供商的jar包。我们选择Hibernate作为JPA的提供商，所以需要导入Hibernate的相关jar包。

1.3    搭建开发环境[重点]

1.3.1     导入jar包

对于JPA操作，只需要从hibernate提供的资料中找到我们需要的jar导入到工程中即可。

• 传统工程导入jar包

　　

• maven工程导入坐标

 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>

     <groupId>cn.itheima</groupId>
     <artifactId>jpa-test</artifactId>
     <version>1.0-SNAPSHOT</version>

     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.hibernate.version>5.0.7.Final</project.hibernate.version>
     </properties>

     <dependencies>
         <!-- junit -->
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
             <version>4.12</version>
             <scope>test</scope>
         </dependency>

         <!-- hibernate对jpa的支持包 -->
         <dependency>
             <groupId>org.hibernate</groupId>
             <artifactId>hibernate-entitymanager</artifactId>
             <version>${project.hibernate.version}</version>
         </dependency>

         <!-- c3p0 -->
         <dependency>
             <groupId>org.hibernate</groupId>
             <artifactId>hibernate-c3p0</artifactId>
             <version>${project.hibernate.version}</version>
         </dependency>

         <!-- log日志 -->
         <dependency>
             <groupId>log4j</groupId>
             <artifactId>log4j</artifactId>
             <version>1.2.17</version>
         </dependency>

         <!-- Mysql and MariaDB -->
         <dependency>
             <groupId>mysql</groupId>
             <artifactId>mysql-connector-java</artifactId>
             <version>5.1.6</version>
         </dependency>

         <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
         <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>
             <version>1.18.8</version>
             <scope>provided</scope>
         </dependency>

     </dependencies>

 </project>

1.3.2     创建客户的数据库表和客户的实体类

• 创建客户的数据库表

     /*创建客户表*/
     CREATE TABLE cst_customer (
       cust_id bigint(32) NOT NULL AUTO_INCREMENT COMMENT '客户编号(主键)',
       cust_name varchar(32) NOT NULL COMMENT '客户名称(公司名称)',
       cust_source varchar(32) DEFAULT NULL COMMENT '客户信息来源',
       cust_industry varchar(32) DEFAULT NULL COMMENT '客户所属行业',
       cust_level varchar(32) DEFAULT NULL COMMENT '客户级别',
       cust_address varchar(128) DEFAULT NULL COMMENT '客户联系地址',
       cust_phone varchar(64) DEFAULT NULL COMMENT '客户联系电话',
       PRIMARY KEY (`cust_id`)
     ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

• 创建客户的实体类

 public class Customer implements Serializable {

     private Long custId;
     private String custName;
     private String custSource;
     private String custIndustry;
     private String custLevel;
     private String custAddress;
     private String custPhone;

     public Long getCustId() {
         return custId;
     }
     public void setCustId(Long custId) {
         this.custId = custId;
     }
     public String getCustName() {
         return custName;
     }
     public void setCustName(String custName) {
         this.custName = custName;
     }
     public String getCustSource() {
         return custSource;
     }
     public void setCustSource(String custSource) {
         this.custSource = custSource;
     }
     public String getCustIndustry() {
         return custIndustry;
     }
     public void setCustIndustry(String custIndustry) {
         this.custIndustry = custIndustry;
     }
     public String getCustLevel() {
         return custLevel;
     }
     public void setCustLevel(String custLevel) {
         this.custLevel = custLevel;
     }
     public String getCustAddress() {
         return custAddress;
     }
     public void setCustAddress(String custAddress) {
         this.custAddress = custAddress;
     }
     public String getCustPhone() {
         return custPhone;
     }
     public void setCustPhone(String custPhone) {
         this.custPhone = custPhone;
     }
 }

1.3.3     编写实体类和数据库表的映射配置[重点]

• 在实体类上使用JPA注解的形式配置映射关系

 /**
 *        * 所有的注解都是使用JPA的规范提供的注解，
  *        * 所以在导入注解包的时候，一定要导入javax.persistence下的
  */
 @Entity //声明实体类
 @Table(name="cst_customer") //建立实体类和表的映射关系
 public class Customer {

     @Id//声明当前私有属性为主键
     @GeneratedValue(strategy=GenerationType.IDENTITY) //配置主键的生成策略
     @Column(name="cust_id") //指定和表中cust_id字段的映射关系
     private Long custId;

     @Column(name="cust_name") //指定和表中cust_name字段的映射关系
     private String custName;

     @Column(name="cust_source")//指定和表中cust_source字段的映射关系
     private String custSource;

     @Column(name="cust_industry")//指定和表中cust_industry字段的映射关系
     private String custIndustry;

     @Column(name="cust_level")//指定和表中cust_level字段的映射关系
     private String custLevel;

     @Column(name="cust_address")//指定和表中cust_address字段的映射关系
     private String custAddress;

     @Column(name="cust_phone")//指定和表中cust_phone字段的映射关系
     private String custPhone;

     public Long getCustId() {
         return custId;
     }
     public void setCustId(Long custId) {
         this.custId = custId;
     }
     public String getCustName() {
         return custName;
     }
     public void setCustName(String custName) {
         this.custName = custName;
     }
     public String getCustSource() {
         return custSource;
     }
     public void setCustSource(String custSource) {
         this.custSource = custSource;
     }
     public String getCustIndustry() {
         return custIndustry;
     }
     public void setCustIndustry(String custIndustry) {
         this.custIndustry = custIndustry;
     }
     public String getCustLevel() {
         return custLevel;
     }
     public void setCustLevel(String custLevel) {
         this.custLevel = custLevel;
     }
     public String getCustAddress() {
         return custAddress;
     }
     public void setCustAddress(String custAddress) {
         this.custAddress = custAddress;
     }
     public String getCustPhone() {
         return custPhone;
     }
     public void setCustPhone(String custPhone) {
         this.custPhone = custPhone;
     }
 }

• 使用lombok（idea插件需要配置，还要引入jar包，最终版）

 package cn.itcast.domain;

 import lombok.Getter;
 import lombok.Setter;
 import lombok.ToString;

 import javax.persistence.*;

 /**
  * 客户的实体类
  *      配置映射关系
  *
  *
  *   1.实体类和表的映射关系
  *      @Entity:声明实体类
  *      @Table : 配置实体类和表的映射关系
  *          name : 配置数据库表的名称
  *   2.实体类中属性和表中字段的映射关系
  *
  *
  */
 @Entity
 @Setter
 @Getter
 @ToString
 @Table(name = "cst_customer")
 public class Customer {

     /**
      * @Id：声明主键的配置
      * @GeneratedValue:配置主键的生成策略
      *      strategy
      *          GenerationType.IDENTITY ：自增，mysql
      *                 * 底层数据库必须支持自动增长（底层数据库支持的自动增长方式，对id自增）
      *          GenerationType.SEQUENCE : 序列，oracle
      *                  * 底层数据库必须支持序列
      *          GenerationType.TABLE : jpa提供的一种机制，通过一张数据库表的形式帮助我们完成主键自增
      *          GenerationType.AUTO ： 由程序自动的帮助我们选择主键生成策略
      * @Column:配置属性和字段的映射关系
      *      name：数据库表中字段的名称
      */
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     @Column(name = "cust_id")
     private Long custId; //客户的主键

     @Column(name = "cust_name")
     private String custName;//客户名称

     @Column(name="cust_source")
     private String custSource;//客户来源

     @Column(name="cust_level")
     private String custLevel;//客户级别

     @Column(name="cust_industry")
     private String custIndustry;//客户所属行业

     @Column(name="cust_phone")
     private String custPhone;//客户的联系方式

     @Column(name="cust_address")
     private String custAddress;//客户地址

 }

• 常用注解的说明

        @Entity
            作用：指定当前类是实体类。
        @Table
            作用：指定实体类和表之间的对应关系。
            属性：
                name：指定数据库表的名称
        @Id
            作用：指定当前字段是主键。
        @GeneratedValue
            作用：指定主键的生成方式。。
            属性：
                strategy ：指定主键生成策略。
        @Column
            作用：指定实体类属性和数据库表之间的对应关系
            属性：
                name：指定数据库表的列名称。
                unique：是否唯一
                nullable：是否可以为空
                inserttable：是否可以插入
                updateable：是否可以更新
                columnDefinition: 定义建表时创建此列的DDL
                secondaryTable: 从表名。如果此列不建在主表上（默认建在主表），该属性定义该列所在从表的名字搭建开发环境[重点]

1.3.4     配置JPA的核心配置文件

在java工程的src路径下创建一个名为META-INF的文件夹，在此文件夹下创建一个名为persistence.xml的配置文件

 <?xml version="1.0" encoding="UTF-8"?>
 <persistence xmlns="http://java.sun.com/xml/ns/persistence" version="2.0">
     <!--需要配置persistence-unit节点
         持久化单元：
             name：持久化单元名称
             transaction-type：事务管理的方式
                     JTA：分布式事务管理（（不同的表分不到不同的数据库，使用分布式事务管理））
                     RESOURCE_LOCAL：本地事务管理
     -->
     <persistence-unit name="myJpa" transaction-type="RESOURCE_LOCAL">
         <!--jpa的实现方式 -->
         <provider>org.hibernate.jpa.HibernatePersistenceProvider</provider>

         <!--可选配置：配置jpa实现方的配置信息-->
         <properties>
             <!-- 数据库信息
                 用户名，javax.persistence.jdbc.user
                 密码，  javax.persistence.jdbc.password
                 驱动，  javax.persistence.jdbc.driver
                 数据库地址   javax.persistence.jdbc.url
             -->
             <property name="javax.persistence.jdbc.user" value="root"/>
             <property name="javax.persistence.jdbc.password" value="root"/>
             <property name="javax.persistence.jdbc.driver" value="com.mysql.jdbc.Driver"/>
             <property name="javax.persistence.jdbc.url" value="jdbc:mysql:///jpa"/>

             <!--配置jpa实现方(hibernate)的配置信息
                 显示sql           ：   false|true
                 自动创建数据库表    ：  hibernate.hbm2ddl.auto
                         create      : 程序运行时创建数据库表（如果有表，先删除表再创建）
                         update      ：程序运行时创建表（如果有表，不会创建表）
                         none        ：不会创建表

             -->
             <property name="hibernate.show_sql" value="true" />
             <property name="hibernate.hbm2ddl.auto" value="update" />
         </properties>
     </persistence-unit>
 </persistence>

1.4    实现保存操作

 package cn.itheima.test;

 import cn.itcast.domain.Customer;
 import org.junit.Test;

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

 public class JpaTest {

     /**
      * 测试jpa的保存
      * 案例：保存一个客户到数据库中
      * Jpa的操作步骤
      * 1.加载配置文件创建工厂（实体管理器工厂）对象
      * 2.通过实体管理器工厂获取实体管理器
      * 3.获取事务对象，开启事务
      * 4.完成增删改查操作
      * 5.提交事务（回滚事务）
      * 6.释放资源
      */
     @Test
     public void testSave() {
         //1.加载配置文件创建工厂（实体管理器工厂）对象
         EntityManagerFactory factory = Persistence.createEntityManagerFactory("myJpa");
         //2.通过实体管理器工厂获取实体管理器
         EntityManager em = factory.createEntityManager();
         //3.获取事务对象，开启事务
         EntityTransaction tx = em.getTransaction(); //获取事务对象
         tx.begin();
         //4.完成增删改查操作：保存一个客户到数据库中
         Customer customer = new Customer();
         customer.setCustName("传智播客3");
         customer.setCustIndustry("教育");
         //保存，
         em.persist(customer); //保存操作
         //5.提交事务
         tx.commit();
         //6.释放资源
         em.close();
         factory.close();

     }
 }