JPA persistence.xml 文件初学者指南

JPA persistence.xml 文件初学者指南

JPA(Java Persistence API)是 Java EE 5.0 规范中引入的一种持久化技术，它提供了一种简单、统一的方式来访问数据库，persistence.xml 文件是 JPA 的核心配置文件，用于指定数据源、实体管理器工厂、事务管理器等相关信息，本文将为初学者介绍如何创建和配置 persistence.xml 文件，以及一些常用的配置选项。

persistence.xml 文件的基本结构

persistence.xml 文件通常位于项目的 resources 目录下，其基本结构如下：

<?xml version="1.0" encoding="UTF-8"?>
<persistence version="2.1" xmlns="http://xmlns.jcp.org/xml/ns/persistence" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/persistence http://xmlns.jcp.org/xml/ns/persistence/persistence_2_1.xsd">
  <persistence-unit name="myPU" transaction-type="RESOURCE_LOCAL">
    <provider>org.hibernate.jpa.HibernatePersistenceProvider</provider>
    <properties>
      <!-数据源配置 -->
      <property name="javax.persistence.jdbc.driver" value="com.mysql.jdbc.Driver"/>
      <property name="javax.persistence.jdbc.url" value="jdbc:mysql://localhost:3306/mydb"/>
      <property name="javax.persistence.jdbc.user" value="username"/>
      <property name="javax.persistence.jdbc.password" value="password"/>
      <!-实体管理器工厂配置 -->
      <property name="hibernate.dialect" value="org.hibernate.dialect.MySQL5Dialect"/>
      <property name="hibernate.hbm2ddl.auto" value="update"/>
      <property name="hibernate.show_sql" value="true"/>
      <property name="hibernate.format_sql" value="true"/>
      <!-其他配置选项 -->
    </properties>
  </persistence-unit>
</persistence>

常用配置选项说明

1、dataSource(数据源)

dataSource 是 JPA 与数据库之间的连接桥梁，通常在 applicationContext.xml 文件中进行配置，在本例中，我们将其放在 persistence.xml 文件中进行配置，以下是一个简单的 dataSource 配置示例：

<property name="javax.persistence.jdbc.driver" value="com.mysql.jdbc.Driver"/>
<property name="javax.persistence.jdbc.url" value="jdbc:mysql://localhost:3306/mydb"/>
<property name="javax.persistence.jdbc.user" value="username"/>
<property name="javax.persistence.jdbc.password" value="password"/>

2、provider(提供者)

provider 是 JPA 实现的类，用于创建实体管理器和事务管理器，在本例中，我们使用的是 Hibernate 作为实现，需要配置 provider 为 org.hibernate.jpa.HibernatePersistenceProvider。

3、dialect(方言)

dialect 是 JPA 在与数据库交互时使用的 SQL 方言，本例中，我们使用的是 MySQL5Dialect，其他常见的方言还包括 Oracle、PostgreSQL 等，根据实际使用的数据库类型选择相应的方言即可。

4、hbm2ddl(Hibernate 映射文件)自动更新策略

hbm2ddl 是Hibernate用来将Java对象持久化到数据库中的XML映射文件，在本例中，我们设置了 hbm2ddlAuto 为 update,表示每次启动应用时，Hibernate会自动根据当前数据库结构生成对应的映射文件，如果希望手动更新映射文件，可以将此选项设置为 validate、create、update。

5、show_sql(显示SQL语句)和 format_sql(格式化SQL语句)属性

这两个属性用于控制是否在控制台输出执行的 SQL 语句以及是否对 SQL 语句进行格式化，默认情况下，它们都设置为 false，开启这两个属性可以方便地查看和调试 SQL 语句，但请注意，开启这两个属性可能会暴露敏感信息，因此在生产环境中谨慎使用。