[hibernate-commits] Hibernate SVN: r14081 - in core/trunk/documentation/manual/zh-CN: src/main and 3 other directories.

Author: steve.ebersole(a)jboss.com Date: 2007-10-09 16:10:34 -0400 (Tue, 09 Oct 2007) New Revision: 14081 Added: core/trunk/documentation/manual/zh-CN/glossary.txt core/trunk/documentation/manual/zh-CN/src/main/docbook/Hibernate_Reference.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/architecture.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/association_mapping.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/basic_mapping.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/batch.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/best_practices.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/collection_mapping.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/component_mapping.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/configuration.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/events.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/example_mappings.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/example_parentchild.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/example_weblog.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/filters.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/inheritance_mapping.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/performance.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/persistent_classes.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/preface.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/query_criteria.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/query_hql.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/query_sql.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/quickstart.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/session_api.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/toolset_guide.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/transactions.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/tutorial.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/content/xml.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/images/ core/trunk/documentation/manual/zh-CN/src/main/docbook/images/AuthorWork.png core/trunk/documentation/manual/zh-CN/src/main/docbook/images/AuthorWork.zargo core/trunk/documentation/manual/zh-CN/src/main/docbook/images/CustomerOrderProduct.png core/trunk/documentation/manual/zh-CN/src/main/docbook/images/CustomerOrderProduct.zargo core/trunk/documentation/manual/zh-CN/src/main/docbook/images/EmployerEmployee.png core/trunk/documentation/manual/zh-CN/src/main/docbook/images/EmployerEmployee.zargo core/trunk/documentation/manual/zh-CN/src/main/docbook/images/full_cream.png core/trunk/documentation/manual/zh-CN/src/main/docbook/images/full_cream.svg core/trunk/documentation/manual/zh-CN/src/main/docbook/images/hibernate_logo_a.png core/trunk/documentation/manual/zh-CN/src/main/docbook/images/lite.png core/trunk/documentation/manual/zh-CN/src/main/docbook/images/lite.svg core/trunk/documentation/manual/zh-CN/src/main/docbook/images/overview.png core/trunk/documentation/manual/zh-CN/src/main/docbook/images/overview.svg core/trunk/documentation/manual/zh-CN/src/main/docbook/legal_notice.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/translators.xml Removed: core/trunk/documentation/manual/zh-CN/src/main/docbook/glossary.txt core/trunk/documentation/manual/zh-CN/src/main/docbook/master.xml core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/ core/trunk/documentation/manual/zh-CN/src/main/resources/ Log: new docbook layout (prep for translations migration to PO) Copied: core/trunk/documentation/manual/zh-CN/glossary.txt (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/glossary.txt) =================================================================== --- core/trunk/documentation/manual/zh-CN/glossary.txt (rev 0) +++ core/trunk/documentation/manual/zh-CN/glossary.txt 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,27 @@ +O/R Mapping 对象/关系数据库映射 +identifier property: 标识属性 +discriminator: 辨别标志(不使用"鉴别器") + +join-subclass,union-subclass,join: 不翻译 + +fine-grained 细粒度 +domain model 领域模型 +business object 业务对象(v2的时候翻译为"商业对象",被无数人痛骂....) +annotations 注解(这个词还比较新,也见到有翻译为"特殊注释"/"标注"的) + +Aggregate functions 统计函数 (聚集函数?聚合函数? 还是翻译为统计函数才能让人看懂) +Criteria Queries 条件查询(标准查询?这里Criteria是"判据"的含义,而非"标准",意译为条件查询更加明白) + +session flush session清洗 +lazy fetching 延迟加载(懒加载,翻译很直白,但是却不易理解) + +对象状态： + persistent class 持久化类 + persistent object 持久对象 (体现这是与某个持久化设备联系的,掉电之后不消失) + transient object 瞬时对象 (其含义是仅在内存中存在的,掉电之后消失,翻译为瞬时对象比较好) + detached object 脱管对象(与session脱离的对象) + +outer-join fetching 外连接抓取 (fetch一般翻译为"获取",v2翻译的时候,为了突出其主动获取的特点,翻译为"抓取") + +class hierarchy 类分层结构 http://www.umlchina.com/xprogrammer/glossary1.htm +inheritance hierarchy 继承层次 http://www-128.ibm.com/developerworks/cn/java/j-aopwork4/?ca=dwcn-newslet... Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/Hibernate_Reference.xml (from rev 14073, core/trunk/documentation/manual/en-US/src/main/docbook/Hibernate_Reference.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/Hibernate_Reference.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/Hibernate_Reference.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,72 @@ +<?xml version='1.0' encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ + <!ENTITY versionNumber "3.3.0.alpha1"> + <!ENTITY copyrightYear "2004"> + <!ENTITY copyrightHolder "Red Hat Middleware, LLC."> +]> + +<book> + + <bookinfo> + <title>HIBERNATE - 符合Java习惯的关系数据库持久化</title> + <subtitle>Hibernate参考文档</subtitle> + <releaseinfo>&versionNumber;</releaseinfo> + <productnumber>&versionNumber;</productnumber> + <issuenum>1</issuenum> + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="images/hibernate_logo_a.png" align="center" /> + </imageobject> + <imageobject role="html"> + <imagedata fileref="images/hibernate_logo_a.png" depth="3cm" /> + </imageobject> + </mediaobject> + <copyright> + <year>&copyrightYear;</year> + <holder>&copyrightHolder;</holder> + </copyright> + <xi:include href="translators.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="legal_notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </bookinfo> + + <toc/> + + <xi:include href="content/preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/tutorial.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/architecture.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/configuration.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/persistent_classes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/basic_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/collection_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/association_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/component_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/inheritance_mapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/session_api.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/transactions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/events.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/batch.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/query_hql.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/query_criteria.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/query_sql.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/filters.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/xml.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/performance.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/toolset_guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/example_parentchild.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/example_weblog.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="content/example_mappings.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <xi:include href="content/best_practices.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + +</book> + Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/architecture.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/architecture.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/architecture.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/architecture.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,284 @@ +<chapter id="architecture"> + + <title>体系结构(Architecture)</title> + <sect1 id="architecture-overview" revision="1"> + <title>概况(Overview)</title> + + <para> + 一个非常简要的Hibernate体系结构的概要图： + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="images/overview.svg" format="SVG" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../shared/images/overview.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + 从这个图可以看出，Hibernate使用数据库和配置信息来为应用程序提供持久化服务（以及持久的对象）。 + </para> + + <para> + 我们来更详细地看一下Hibernate运行时体系结构。由于Hibernate非常灵活，且支持多种应用方案， + 所以我们这只描述一下两种极端的情况。“轻型”的体系结构方案，要求应用程序提供自己的JDBC + 连接并管理自己的事务。这种方案使用了Hibernate API的最小子集： + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="images/lite.svg" format="SVG" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../shared/images/lite.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + “全面解决”的体系结构方案，将应用层从底层的JDBC/JTA API中抽象出来，而让Hibernate来处理这些细节。 + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="images/full_cream.svg" format="SVG" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../shared/images/full_cream.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + 图中各个对象的定义如下： + + <variablelist spacing="compact"> + <varlistentry> + <term>SessionFactory (<literal>org.hibernate.SessionFactory</literal>)</term> + <listitem> + <para> + 针对单个数据库映射关系经过编译后的内存镜像，是线程安全的（不可变）。 + 它是生成<literal>Session</literal>的工厂，本身要用到<literal>ConnectionProvider</literal>。 + 该对象可以在进程或集群的级别上，为那些事务之间可以重用的数据提供可选的二级缓存。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Session (<literal>org.hibernate.Session</literal>)</term> + <listitem> + <para> + 表示应用程序与持久储存层之间交互操作的一个单线程对象，此对象生存期很短。 + 其隐藏了JDBC连接，也是<literal>Transaction</literal>的工厂。 + 其会持有一个针对持久化对象的必选（第一级）缓存，在遍历对象图或者根据持久化标识查找对象时会用到。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>持久的对象及其集合</term> + <listitem> + <para> + 带有持久化状态的、具有业务功能的单线程对象，此对象生存期很短。 + 这些对象可能是普通的JavaBeans/POJO，唯一特殊的是他们正与（仅仅一个）<literal>Session</literal>相关联。 + 一旦这个<literal>Session</literal>被关闭，这些对象就会脱离持久化状态，这样就可被应用程序的任何层自由使用。 + （例如，用作跟表示层打交道的数据传输对象。） + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>瞬态(transient)和脱管(detached)的对象及其集合</term> + <listitem> + <para> + 那些目前没有与session关联的持久化类实例。 + 他们可能是在被应用程序实例化后，尚未进行持久化的对象。 + 也可能是因为实例化他们的<literal>Session</literal>已经被关闭而脱离持久化的对象。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>事务Transaction (<literal>org.hibernate.Transaction</literal>)</term> + <listitem> + <para> + （可选的）应用程序用来指定原子操作单元范围的对象，它是单线程的，生命周期很短。 + 它通过抽象将应用从底层具体的JDBC、JTA以及CORBA事务隔离开。 + 某些情况下，一个<literal>Session</literal>之内可能包含多个<literal>Transaction</literal>对象。 + 尽管是否使用该对象是可选的，但无论是使用底层的API还是使用<literal>Transaction</literal>对象，事务边界的开启与关闭是必不可少的。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>ConnectionProvider (<literal>org.hibernate.connection.ConnectionProvider</literal>)</term> + <listitem> + <para> + （可选的）生成JDBC连接的工厂（同时也起到连接池的作用）。 + 它通过抽象将应用从底层的<literal>Datasource</literal>或<literal>DriverManager</literal>隔离开。 + 仅供开发者扩展/实现用，并不暴露给应用程序使用。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>TransactionFactory (<literal>org.hibernate.TransactionFactory</literal>)</term> + <listitem> + <para> + （可选的）生成<literal>Transaction</literal>对象实例的工厂。 + 仅供开发者扩展/实现用，并不暴露给应用程序使用。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><emphasis>扩展接口</emphasis></term> + <listitem> + <para> + Hibernate提供了很多可选的扩展接口，你可以通过实现它们来定制你的持久层的行为。 + 具体请参考API文档。 + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + + <para> + 在特定“轻型”的体系结构中，应用程序可能绕过 + <literal>Transaction</literal>/<literal>TransactionFactory</literal> 以及 + <literal>ConnectionProvider</literal> 等API直接跟JTA或JDBC打交道。 + </para> + </sect1> + + <sect1 id="architecture-states" revision="1"> + <title>实例状态</title> + <para> + 一个持久化类的实例可能处于三种不同状态中的某一种。 + 这三种状态的定义则与所谓的<emphasis>持久化上下文(persistence context)</emphasis>有关。 + Hibernate的<literal>Session</literal>对象就是这个所谓的持久化上下文： + </para> + + <variablelist spacing="compact"> + <varlistentry> + <term>瞬态（transient）</term> + <listitem> + <para> + 该实例从未与任何持久化上下文关联过。它没有持久化标识（相当于主键值）。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>持久化(persistent)</term> + <listitem> + <para> + 实例目前与某个持久化上下文有关联。 + 它拥有持久化标识（相当于主键值），并且可能在数据库中有一个对应的行。 + 对于某一个特定的持久化上下文，Hibernate<emphasis>保证</emphasis>持久化标识与Java标识（其值代表对象在内存中的位置）等价。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>脱管(detached)</term> + <listitem> + <para> + 实例曾经与某个持久化上下文发生过关联，不过那个上下文被关闭了， + 或者这个实例是被序列化(serialize)到另外的进程。 + 它拥有持久化标识，并且在数据库中可能存在一个对应的行。 + 对于脱管状态的实例，Hibernate不保证任何持久化标识和Java标识的关系。 + </para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 id="architecture-jmx" revision="1"> + <title>JMX整合</title> + + <para> + JMX是管理Java组件(Java components)的J2EE标准。 Hibernate 可以通过一个JMX标准服务来管理。 + 在这个发行版本中，我们提供了一个MBean接口的实现,即 + <literal>org.hibernate.jmx.HibernateService</literal>。 + </para> + + <para> + 想要看如何在JBoss应用服务器上将Hibernate部署为一个JMX服务的例子，您可以参考JBoss用户指南。 + 我们现在说一下在Jboss应用服务器上，使用JMX来部署Hibernate的好处： + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Session管理：</emphasis> Hibernate的<literal>Session</literal>对象的生命周期可以 + 自动跟一个JTA事务边界绑定。这意味着你无需手工开关<literal>Session</literal>了, 这项 + 工作会由JBoss EJB 拦截器来完成。你再也不用担心你的代码中的事务边界了(除非你想利用Hibernate提供可选 + 的<literal>Transaction</literal> API来自己写一个便于移植的的持久层)。 + 你通过调用<literal>HibernateContext</literal>来访问<literal>Session</literal>。 + </para> + </listitem> + <listitem> + <para> + <emphasis>HAR 部署:</emphasis> 通常情况下，你会使用JBoss的服务部署描述符（在EAR或/和SAR文件中）来部署Hibernate JMX服务。 + 这种部署方式支持所有常见的Hibernate <literal>SessionFactory</literal>的配置选项。 + 不过，你仍需在部署描述符中，列出你所有的映射文件的名字。如果你使用HAR部署方式, JBoss + 会自动探测出你的HAR文件中所有的映射文件。 + </para> + </listitem> + </itemizedlist> + + <para> + 这些选项更多的描述，请参考JBoss 应用程序用户指南。 + </para> + + <para> + 将Hibernate以部署为JMX服务的另一个好处，是可以查看Hibernate的运行时统计信息。参看 + <xref linkend="configuration-optional-statistics"/>. + </para> + </sect1> + + <sect1 id="architecture-jca" revision="1"> + <title>对JCA的支持</title> + <para> + Hibernate也可以被配置为一个JCA连接器（JCA connector）。更多信息请参看网站。 + 请注意，Hibernate对JCA的支持，仍处于实验性阶段。 + </para> + </sect1> + <sect1 id="architecture-current-session" revision="2"> + <title>上下文相关的（Contextual）Session</title> + <para> + 使用Hibernate的大多数应用程序需要某种形式的“上下文相关的” session，特定的session在整个特定的上下文范围内始终有效。然而，对不同类型的应用程序而言，要为什么是组成这种“上下文”下一个定义通常是困难的；不同的上下文对“当前”这个概念定义了不同的范围。在3.0版本之前，使用Hibernate的程序要么采用自行编写的基于<literal>ThreadLocal</literal>的上下文session，要么采用<literal>HibernateUtil</literal>这样的辅助类，要么采用第三方框架（比如Spring或Pico)，它们提供了基于代理(proxy)或者基于拦截器(interception)的上下文相关session。 + </para> + <para> + 从3.0.1版本开始，Hibernate增加了<literal>SessionFactory.getCurrentSession()</literal>方法。一开始，它假定了采用<literal>JTA</literal>事务，<literal>JTA</literal>事务定义了当前session的范围和上下文(scope and context)。Hibernate开发团队坚信，因为有好几个独立的<literal>JTA TransactionManager</literal>实现稳定可用，不论是否被部署到一个<literal>J2EE</literal>容器中，大多数(假若不是所有的）应用程序都应该采用<literal>JTA</literal>事务管理。基于这一点，采用<literal>JTA</literal>的上下文相关session可以满足你一切需要。 + </para> + <para> + 更好的是，从3.1开始，<literal>SessionFactory.getCurrentSession()</literal>的后台实现是可拔插的。因此，我们引入了新的扩展接口(<literal>org.hibernate.context.CurrentSessionContext</literal>)和新的配置参数(<literal>hibernate.current_session_context_class</literal>)，以便对什么是“当前session”的范围和上下文(scope and context)的定义进行拔插。 + </para> + <para> + 请参阅<literal>org.hibernate.context.CurrentSessionContext</literal>接口的Javadoc,那里有关于它的契约的详细讨论。它定义了单一的方法，<literal>currentSession()</literal>，特定的实现用它来负责跟踪当前的上下文session。Hibernate内置了此接口的三种实现。 + </para> + + <itemizedlist> + <listitem> + <para> + <literal>org.hibernate.context.JTASessionContext</literal> - 当前session根据<literal>JTA</literal>来跟踪和界定。这和以前的仅支持JTA的方法是完全一样的。详情请参阅Javadoc。 + </para> + </listitem> + <listitem> + <para> + <literal>org.hibernate.context.ThreadLocalSessionContext</literal> - 当前session通过当前执行的线程来跟踪和界定。详情也请参阅Javadoc。 + </para> + </listitem> + <listitem> + <para> + <literal>org.hibernate.context.ManagedSessionContext</literal> - 当前session通过当前执行的线程来跟踪和界定。但是，你需要负责使用这个类的静态方法将<literal>Session</literal>实例绑定、或者取消绑定，它并不会打开(open)、flush或者关闭(close)任何<literal>Session</literal>。 + </para> + </listitem> + </itemizedlist> + + <para> + 前两种实现都提供了“每数据库事务对应一个session”的编程模型，也称作<emphasis>每次请求一个session</emphasis>。Hibernate session的起始和终结由数据库事务的生存来控制。假若你在纯粹的 Java SE之上采用自行编写代码来管理事务,而不使用JTA，建议你使用Hibernate <literal>Transaction</literal> API来把底层事务实现从你的代码中隐藏掉。如果你使用JTA，请使用JTA借口来管理Transaction。如果你在支持CMT的EJB容器中执行代码，事务边界是声明式定义的，你不需要在代码中进行任何事务或session管理操作。请参阅<xref linkend="transactions"/>一节来阅读更多的内容和示例代码。 + </para> + + <para> + <literal>hibernate.current_session_context_class</literal>配置参数定义了应该采用哪个<literal>org.hibernate.context.CurrentSessionContext</literal>实现。注意，为了向下兼容，如果未配置此参数，但是存在<literal>org.hibernate.transaction.TransactionManagerLookup</literal>的配置，Hibernate会采用<literal>org.hibernate.context.JTASessionContext</literal>。一般而言，此参数的值指明了要使用的实现类的全名，但那三种内置的实现可以使用简写，即"jta"、"thread"和"managed"。 + + </para> + + </sect1> + +</chapter> + + Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/association_mapping.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/association_mapping.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/association_mapping.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/association_mapping.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,579 @@ +<chapter id="associations"> + + <title>关联关系映射</title> + + <sect1 id="assoc-intro" revision="1"> + <title>介绍</title> + + <para> + 关联关系映射通常情况是最难配置正确的。在这个部分中，我们从单向关系映射开始，然后考虑双向关系映射，由浅至深讲述一遍典型的案例。在所有的例子中，我们都使用 <literal>Person</literal>和<literal>Address</literal>。 + </para> + + <para> + 我们根据映射关系是否涉及连接表以及多样性来划分关联类型。 + </para> + + <para> + 在传统的数据建模中，允许为Null值的外键被认为是一种不好的实践，因此我们所有的例子中都使用不允许为Null的外键。这并不是Hibernate的要求，即使你删除掉不允许为Null的约束，Hibernate映射一样可以工作的很好。 + </para> + + </sect1> + + <sect1 id="assoc-unidirectional" revision="1"> + <title>单向关联（Unidirectional associations）</title> + + <sect2 id="assoc-unidirectional-m21"> + <title>多对一(many to one)</title> + + <para> + <emphasis>单向many-to-one关联</emphasis>是最常见的单向关联关系。 + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <many-to-one name="address" + column="addressId" + not-null="true"/> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key, addressId bigint not null ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-121"> + <title>一对一（one to one）</title> + + <para> + <emphasis>基于外键关联的单向一对一关联</emphasis>和<emphasis>单向多对一关联</emphasis>几乎是一样的。唯一的不同就是单向一对一关联中的外键字段具有唯一性约束。 + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <many-to-one name="address" + column="addressId" + unique="true" + not-null="true"/> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key, addressId bigint not null unique ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + <para> + <emphasis>基于主键关联的单向一对一关联</emphasis>通常使用一个特定的id生成器。（请注意，在这个例子中我们掉换了关联的方向。） + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> +</class> + +<class name="Address"> + <id name="id" column="personId"> + <generator class="foreign"> + <param name="property">person</param> + </generator> + </id> + <one-to-one name="person" constrained="true"/> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table Address ( personId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-12m"> + <title>一对多（one to many）</title> + + <para> + <emphasis>基于外键关联的单向一对多关联</emphasis>是一种很少见的情况，并不推荐使用。 + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses"> + <key column="personId" + not-null="true"/> + <one-to-many class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table Address ( addressId bigint not null primary key, personId bigint not null ) + ]]></programlisting> + + <para> + 我们认为对于这种关联关系最好使用连接表。 + </para> + + </sect2> + + </sect1> + + <sect1 id="assoc-unidirectional-join" revision="1"> + <title>使用连接表的单向关联（Unidirectional associations with join tables）</title> + + <sect2 id="assoc-unidirectional-join-12m"> + <title>一对多(one to many)</title> + + <para> + <emphasis>基于连接表的单向一对多关联</emphasis> 应该优先被采用。请注意，通过指定<literal>unique="true"</literal>，我们可以把多样性从多对多改变为一对多。 + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses" table="PersonAddress"> + <key column="personId"/> + <many-to-many column="addressId" + unique="true" + class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId not null, addressId bigint not null primary key ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-join-m21"> + <title>多对一（many to one）</title> + + <para> + <emphasis>基于连接表的单向多对一关联</emphasis>在关联关系可选的情况下应用也很普遍。 + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + optional="true"> + <key column="personId" unique="true"/> + <many-to-one name="address" + column="addressId" + not-null="true"/> + </join> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null primary key, addressId bigint not null ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-join-121"> + <title>一对一（one to one）</title> + + <para> + <emphasis>基于连接表的单向一对一关联</emphasis>非常少见，但也是可行的。 + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + optional="true"> + <key column="personId" + unique="true"/> + <many-to-one name="address" + column="addressId" + not-null="true" + unique="true"/> + </join> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null primary key, addressId bigint not null unique ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-unidirectional-join-m2m"> + <title>多对多（many to many）</title> + + <para> + 最后，还有 <emphasis>单向多对多关联</emphasis>. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses" table="PersonAddress"> + <key column="personId"/> + <many-to-many column="addressId" + class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null, addressId bigint not null, primary key (personId, addressId) ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + </sect1> + + <sect1 id="assoc-bidirectional" revision="1"> + <title>双向关联（Bidirectional associations）</title> + + <sect2 id="assoc-bidirectional-m21" revision="2"> + <title>一对多（one to many) / 多对一（many to one）</title> + + <para> + <emphasis>双向多对一关联</emphasis> 是最常见的关联关系。（这也是标准的父/子关联关系。） + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <many-to-one name="address" + column="addressId" + not-null="true"/> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <set name="people" inverse="true"> + <key column="addressId"/> + <one-to-many class="Person"/> + </set> +</class>]]></programlisting> + + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key, addressId bigint not null ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + <para> + 如果你使用<literal>List</literal>(或者其他有序集合类)，你需要设置外键对应的<literal>key</literal>列为 <literal>not null</literal>,让Hibernate来从集合端管理关联，维护每个元素的索引（通过设置<literal>update="false"</literal> and <literal>insert="false"</literal>来对另一端反向操作）。 + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id"/> + ... + <many-to-one name="address" + column="addressId" + not-null="true" + insert="false" + update="false"/> +</class> + +<class name="Address"> + <id name="id"/> + ... + <list name="people"> + <key column="addressId" not-null="true"/> + <list-index column="peopleIdx"/> + <one-to-many class="Person"/> + </list> +</class>]]></programlisting> + + <para> + 假若集合映射的<literal>&lt;key&gt;</literal>元素对应的底层外键字段是<literal>NOT NULL</literal>的，那么为这一key元素定义<literal>not-null="true"</literal>是很重要的。不要仅仅为可能的嵌套<literal>&lt;column&gt;</literal>元素定义<literal>not-null="true"</literal>，<literal>&lt;key&gt;</literal>元素也是需要的。 + </para> + + </sect2> + + <sect2 id="assoc-bidirectional-121"> + <title>一对一（one to one）</title> + + <para> + <emphasis>基于外键关联的双向一对一关联</emphasis>也很常见。 + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <many-to-one name="address" + column="addressId" + unique="true" + not-null="true"/> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <one-to-one name="person" + property-ref="address"/> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key, addressId bigint not null unique ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + <para> + <emphasis>基于主键关联的一对一关联</emphasis>需要使用特定的id生成器。 + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <one-to-one name="address"/> +</class> + +<class name="Address"> + <id name="id" column="personId"> + <generator class="foreign"> + <param name="property">person</param> + </generator> + </id> + <one-to-one name="person" + constrained="true"/> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table Address ( personId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + </sect1> + + <sect1 id="assoc-bidirectional-join" revision="1"> + <title>使用连接表的双向关联（Bidirectional associations with join tables）</title> + + <sect2 id="assoc-bidirectional-join-12m"> + <title>一对多（one to many） /多对一（ many to one）</title> + + <para> + <emphasis>基于连接表的双向一对多关联</emphasis>。注意<literal>inverse="true"</literal>可以出现在关联的任意一端，即collection端或者join端。 + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses" + table="PersonAddress"> + <key column="personId"/> + <many-to-many column="addressId" + unique="true" + class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + inverse="true" + optional="true"> + <key column="addressId"/> + <many-to-one name="person" + column="personId" + not-null="true"/> + </join> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null, addressId bigint not null primary key ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-bidirectional-join-121"> + <title>一对一（one to one）</title> + + <para> + <emphasis>基于连接表的双向一对一关联</emphasis>极为罕见，但也是可行的。 + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + optional="true"> + <key column="personId" + unique="true"/> + <many-to-one name="address" + column="addressId" + not-null="true" + unique="true"/> + </join> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <join table="PersonAddress" + optional="true" + inverse="true"> + <key column="addressId" + unique="true"/> + <many-to-one name="person" + column="personId" + not-null="true" + unique="true"/> + </join> +</class>]]></programlisting> + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null primary key, addressId bigint not null unique ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + <sect2 id="assoc-bidirectional-join-m2m" revision="1"> + <title>多对多（many to many）</title> + + <para> + 最后，还有 <emphasis>双向多对多关联</emphasis>. + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id" column="personId"> + <generator class="native"/> + </id> + <set name="addresses" table="PersonAddress"> + <key column="personId"/> + <many-to-many column="addressId" + class="Address"/> + </set> +</class> + +<class name="Address"> + <id name="id" column="addressId"> + <generator class="native"/> + </id> + <set name="people" inverse="true" table="PersonAddress"> + <key column="addressId"/> + <many-to-many column="personId" + class="Person"/> + </set> +</class>]]></programlisting> + + <programlisting><![CDATA[ +create table Person ( personId bigint not null primary key ) +create table PersonAddress ( personId bigint not null, addressId bigint not null, primary key (personId, addressId) ) +create table Address ( addressId bigint not null primary key ) + ]]></programlisting> + + </sect2> + + </sect1> + <sect1 id="assoc-complex"> + <title>更复杂的关联映射</title> + + <para> + 更复杂的关联连接<emphasis>极为</emphasis>罕见。 + 通过在映射文档中嵌入SQL片断，Hibernate也可以处理更为复杂的情况。比如，假若包含历史帐户数据的表定义了<literal>accountNumber</literal>, <literal>effectiveEndDate</literal> 和<literal>effectiveStartDate</literal>字段，按照下面映射： + </para> + + <programlisting><![CDATA[<properties name="currentAccountKey"> + <property name="accountNumber" type="string" not-null="true"/> + <property name="currentAccount" type="boolean"> + <formula>case when effectiveEndDate is null then 1 else 0 end</formula> + </property> +</properties> +<property name="effectiveEndDate" type="date"/> +<property name="effectiveStateDate" type="date" not-null="true"/>]]></programlisting> + + <para> + 那么我们可以对<emphasis>目前(current)</emphasis>实例(其<literal>effectiveEndDate</literal>为null)使用这样的关联映射: + </para> + + <programlisting><![CDATA[<many-to-one name="currentAccountInfo" + property-ref="currentAccountKey" + class="AccountInfo"> + <column name="accountNumber"/> + <formula>'1'</formula> +</many-to-one>]]></programlisting> + + <para> + 更复杂的例子,假想<literal>Employee</literal>和<literal>Organization</literal>之间的关联是通过一个<literal>Employment</literal>中间表维护的,而中间表中填充了很多历史雇员数据。那“雇员的<emphasis>最新</emphasis>雇主”这个关联（最新雇主就是<literal>startDate</literal>最后的那个）可以这样映射： + </para> + + <programlisting><![CDATA[<join> + <key column="employeeId"/> + <subselect> + select employeeId, orgId + from Employments + group by orgId + having startDate = max(startDate) + </subselect> + <many-to-one name="mostRecentEmployer" + class="Organization" + column="orgId"/> +</join>]]></programlisting> + + <para> + 使用这一功能时可以充满创意，但通常更加实用的是用HQL或条件查询来处理这些情形。 + </para> + + </sect1> + + +</chapter> + Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/basic_mapping.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/basic_mapping.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/basic_mapping.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/basic_mapping.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,2982 @@ +<chapter id="mapping"> + <title>对象/关系数据库映射基础(Basic O/R Mapping)</title> + + <sect1 id="mapping-declaration" revision="1"> + <title>映射定义（Mapping declaration）</title> + + <para> + 对象和关系数据库之间的映射通常是用一个XML文档(XML document)来定义的。这个映射文档被设计为易读的， + 并且可以手工修改。映射语言是以Java为中心，这意味着映射文档是按照持久化类的定义来创建的， + 而非表的定义。 + </para> + + + <para> + 请注意，虽然很多Hibernate用户选择手写XML映射文档，但也有一些工具可以用来生成映射文档， + 包括XDoclet,Middlegen和AndroMDA。 + </para> + + <para> + 让我们从一个映射的例子开始： + </para> + + <programlisting id="mapping-declaration-ex1" revision="1"><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="eg"> + + <class name="Cat" + table="cats" + discriminator-value="C"> + + <id name="id"> + <generator class="native"/> + </id> + + <discriminator column="subclass" + type="character"/> + + <property name="weight"/> + + <property name="birthdate" + type="date" + not-null="true" + update="false"/> + + <property name="color" + type="eg.types.ColorUserType" + not-null="true" + update="false"/> + + <property name="sex" + not-null="true" + update="false"/> + + <property name="litterId" + column="litterId" + update="false"/> + + <many-to-one name="mother" + column="mother_id" + update="false"/> + + <set name="kittens" + inverse="true" + order-by="litter_id"> + <key column="mother_id"/> + <one-to-many class="Cat"/> + </set> + + <subclass name="DomesticCat" + discriminator-value="D"> + + <property name="name" + type="string"/> + + </subclass> + + </class> + + <class name="Dog"> + <!-- mapping for Dog could go here --> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + 我们现在开始讨论映射文档的内容。我们只描述Hibernate在运行时用到的文档元素和属性。 + 映射文档还包括一些额外的可选属性和元素，它们在使用schema导出工具的时候会影响导出的数据库schema结果。 + （比如，<literal> not-null</literal> 属性。） + </para> + + + + <sect2 id="mapping-declaration-doctype" revision="3"> + <title>Doctype</title> + + <para> + 所有的XML映射都需要定义如上所示的doctype。DTD可以从上述URL中获取， + 也可以从<literal>hibernate-x.x.x/src/net/sf/hibernate</literal>目录中、 + 或<literal>hibernate.jar</literal>文件中找到。Hibernate总是会首先在它的classptah中搜索DTD文件。 + 如果你发现它是通过连接Internet查找DTD文件，就对照你的classpath目录检查XML文件里的DTD声明。 + </para> + + <sect3 id="mapping-declaration-entity-resolution"> + <title>EntityResolver</title> + <para> + As mentioned previously, Hibernate will first attempt to resolve DTDs in its classpath. The + manner in which it does this is by registering a custom <literal>org.xml.sax.EntityResolver</literal> + implementation with the SAXReader it uses to read in the xml files. This custom + <literal>EntityResolver</literal> recognizes two different systemId namespaces. + 如前所述,Hibernate首先在其classpath中查找DTD。其行为是依靠在系统中注册的<literal>org.xml.sax.EntityResolver</literal>的一个具体实现，SAXReader依靠它来读取xml文件。这一 <literal>EntityResolver</literal> 实现能辨认两种不同的 systenId命名空间。 + </para> + <itemizedlist> + <listitem> + <para> + 若resolver遇到了一个以<literal>http://hibernate.sourceforge.net/</literal>为开头的systemId，它会辨认出是<literal>hibernate namespace</literal>，resolver就试图通过加载Hibernate类的classloader来查找这些实体。 + </para> + </listitem> + <listitem> + <para> + + 若resolver遇到了一个使用<literal>classpath://</literal>URL协议的systemId，它会辨认出这是<literal>user namespace</literal>,resolver试图通过(1)当前线程上下文的classloader和(2)加载Hibernate class的classloader来查找这些实体。 + </para> + </listitem> + </itemizedlist> + <para> + 使用user namespace(用户命名空间)的例子： + </para> + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd" [ + <!ENTITY types SYSTEM "classpath://your/domain/types.xml"> +]> + +<hibernate-mapping package="your.domain"> + <class name="MyEntity"> + <id name="id" type="my-custom-id-type"> + ... + </id> + <class> + &types; +</hibernate-mapping>]]></programlisting> + <para> + <literal>types.xml</literal>是<literal>your.domain</literal>包中的一个资源，它包含了一个定制的<xref linkend="mapping-types-custom">typedef</xref>。 + </para> + + </sect3> + + </sect2> + + <sect2 id="mapping-declaration-mapping" revision="3"> + <title>hibernate-mapping</title> + + <para> + 这个元素包括一些可选的属性。<literal>schema</literal>和<literal>catalog</literal>属性， + 指明了这个映射所连接（refer）的表所在的schema和/或catalog名称。 + 假若指定了这个属性，表名会加上所指定的schema和catalog的名字扩展为全限定名。假若没有指定，表名就不会使用全限定名。 + <literal>default-cascade</literal>指定了未明确注明<literal>cascade</literal>属性的Java属性和 + 集合类Hibernate会采取什么样的默认级联风格。<literal>auto-import</literal>属性默认让我们在查询语言中可以使用 + 非全限定名的类名。 + </para> + + + <programlistingco> + <areaspec> + <area id="hm1" coords="2 55"/> + <area id="hm2" coords="3 55"/> + <area id="hm3" coords="4 55"/> + <area id="hm4" coords="5 55"/> + <area id="hm5" coords="6 55"/> + <area id="hm6" coords="7 55"/> + <area id="hm7" coords="8 55"/> + </areaspec> + <programlisting><![CDATA[<hibernate-mapping + schema="schemaName" + catalog="catalogName" + default-cascade="cascade_style" + default-access="field|property|ClassName" + default-lazy="true|false" + auto-import="true|false" + package="package.name" + />]]></programlisting> + <calloutlist> + <callout arearefs="hm1"> + <para> + <literal>schema</literal> (可选): 数据库schema的名称。 + </para> + </callout> + <callout arearefs="hm2"> + <para> + <literal>catalog</literal> (可选): 数据库catalog的名称。 + </para> + </callout> + <callout arearefs="hm3"> + <para> + <literal>default-cascade</literal> (可选 - 默认为 <literal>none</literal>): + 默认的级联风格。 + </para> + </callout> + <callout arearefs="hm4"> + <para> + <literal>default-access</literal> (可选 - 默认为 <literal>property</literal>): + Hibernate用来访问所有属性的策略。可以通过实现<literal>PropertyAccessor</literal>接口 + 自定义。 + </para> + </callout> + <callout arearefs="hm5"> + <para> + <literal>default-lazy</literal> (可选 - 默认为 <literal>true</literal>): + 指定了未明确注明<literal>lazy</literal>属性的Java属性和集合类， + Hibernate会采取什么样的默认加载风格。 + </para> + </callout> + <callout arearefs="hm6"> + <para> + <literal>auto-import</literal> (可选 - 默认为 <literal>true</literal>): + 指定我们是否可以在查询语言中使用非全限定的类名（仅限于本映射文件中的类）。 + </para> + </callout> + <callout arearefs="hm7"> + <para> + <literal>package</literal> (可选): 指定一个包前缀，如果在映射文档中没有指定全限定的类名， + 就使用这个作为包名。 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + 假若你有两个持久化类，它们的非全限定名是一样的（就是两个类的名字一样，所在的包不一样--译者注）， + 你应该设置<literal>auto-import="false"</literal>。如果你把一个“import过”的名字同时对应两个类， + Hibernate会抛出一个异常。 + </para> + + <para> + 注意<literal>hibernate-mapping</literal> 元素允许你嵌套多个如上所示的 + <literal>&lt;class&gt;</literal>映射。但是最好的做法（也许一些工具需要的）是一个 + 持久化类（或一个类的继承层次）对应一个映射文件，并以持久化的超类名称命名，例如： + <literal>Cat.hbm.xml</literal>， + <literal>Dog.hbm.xml</literal>，或者如果使用继承，<literal>Animal.hbm.xml</literal>。 + </para> + + </sect2> + + <sect2 id="mapping-declaration-class" revision="3"> + <title>class</title> + + <para> + 你可以使用<literal>class</literal>元素来定义一个持久化类： + </para> + + + <programlistingco> + <areaspec> + <area id="class1" coords="2 55"/> + <area id="class2" coords="3 55" /> + <area id="class3" coords="4 55"/> + <area id="class4" coords="5 55" /> + <area id="class5" coords="6 55"/> + <area id="class6" coords="7 55" /> + <area id="class7" coords="8 55"/> + <area id="class8" coords="9 55" /> + <area id="class9" coords="10 55" /> + <area id="class10" coords="11 55"/> + <area id="class11" coords="12 55"/> + <area id="class12" coords="13 55"/> + <area id="class13" coords="14 55"/> + <area id="class14" coords="15 55"/> + <area id="class15" coords="16 55"/> + <area id="class16" coords="17 55"/> + <area id="class17" coords="18 55"/> + <area id="class18" coords="19 55"/> + <area id="class19" coords="20 55"/> + <area id="class20" coords="21 55"/> + <area id="class21" coords="22 55"/> + </areaspec> + <programlisting><![CDATA[<class + name="ClassName" + table="tableName" + discriminator-value="discriminator_value" + mutable="true|false" + schema="owner" + catalog="catalog" + proxy="ProxyInterface" + dynamic-update="true|false" + dynamic-insert="true|false" + select-before-update="true|false" + polymorphism="implicit|explicit" + where="arbitrary sql where condition" + persister="PersisterClass" + batch-size="N" + optimistic-lock="none|version|dirty|all" + lazy="true|false" + entity-name="EntityName" + check="arbitrary sql check condition" + rowid="rowid" + subselect="SQL expression" + abstract="true|false" + node="element-name" +/>]]></programlisting> + <calloutlist> + <callout arearefs="class1"> + <para> + <literal>name</literal> (可选): 持久化类（或者接口）的Java全限定名。 + 如果这个属性不存在，Hibernate将假定这是一个非POJO的实体映射。 + </para> + </callout> + <callout arearefs="class2"> + <para> + <literal>table</literal> (可选 - 默认是类的非全限定名): 对应的数据库表名。 + </para> + </callout> + <callout arearefs="class3"> + <para> + <literal>discriminator-value</literal> (可选 - 默认和类名一样): + 一个用于区分不同的子类的值，在多态行为时使用。它可以接受的值包括 + <literal>null</literal> 和 <literal>not null</literal>。 + </para> + </callout> + <callout arearefs="class4"> + <para> + <literal>mutable</literal> (可选，默认值为<literal>true</literal>): + 表明该类的实例是可变的或者不可变的。 + </para> + </callout> + <callout arearefs="class5"> + <para> + <literal>schema</literal> (可选): + 覆盖在根<literal>&lt;hibernate-mapping&gt;</literal>元素中指定的schema名字。 + </para> + </callout> + <callout arearefs="class6"> + <para> + <literal>catalog</literal> (可选): + 覆盖在根<literal>&lt;hibernate-mapping&gt;</literal>元素中指定的catalog名字。 + </para> + </callout> + <callout arearefs="class7"> + <para> + <literal>proxy</literal> (可选): 指定一个接口，在延迟装载时作为代理使用。 + 你可以在这里使用该类自己的名字。 + </para> + </callout> + <callout arearefs="class8"> + <para> + <literal>dynamic-update</literal> (可选, 默认为 <literal>false</literal>): + 指定用于<literal>UPDATE</literal> 的SQL将会在运行时动态生成，并且只更新那些改变过的字段。 + </para> + </callout> + <callout arearefs="class9"> + <para> + <literal>dynamic-insert</literal> (可选, 默认为 <literal>false</literal>): + 指定用于<literal>INSERT</literal>的 SQL 将会在运行时动态生成，并且只包含那些非空值字段。 + </para> + </callout> + <callout arearefs="class10"> + <para> + <literal>select-before-update</literal> (可选, 默认为 <literal>false</literal>): + 指定Hibernate除非确定对象真正被修改了（如果该值为true－译注），否则<emphasis>不会</emphasis>执行SQL + <literal>UPDATE</literal>操作。在特定场合（实际上，它只在一个瞬时对象（transient object）关联到一个 + 新的session中时执行的update()中生效），这说明Hibernate会在<literal>UPDATE</literal> + 之前执行一次额外的SQL <literal>SELECT</literal>操作，来决定是否应该执行 + <literal>UPDATE</literal>。 + </para> + </callout> + <callout arearefs="class11"> + <para> + <literal>polymorphism（多态）</literal> (可选, 默认值为 <literal>implicit (隐式) + </literal>): 界定是隐式还是显式的使用多态查询（这只在Hibernate的具体表继承策略中用到－译注）。 + </para> + </callout> + <callout arearefs="class12"> + <para> + <literal>where</literal> (可选) 指定一个附加的SQL<literal>WHERE</literal> 条件， + 在抓取这个类的对象时会一直增加这个条件。 + </para> + </callout> + <callout arearefs="class13"> + <para> + <literal>persister</literal> (可选): 指定一个定制的<literal>ClassPersister</literal>。 + </para> + </callout> + <callout arearefs="class14"> + <para> + <literal>batch-size</literal> (可选,默认是<literal>1</literal>) 指定一个用于 + 根据标识符（identifier）抓取实例时使用的"batch size"（批次抓取数量）。 + </para> + </callout> + <callout arearefs="class15"> + <para> + <literal>optimistic-lock（乐观锁定）</literal> + (可选，默认是<literal>version</literal>): 决定乐观锁定的策略。 + </para> + </callout> + <callout arearefs="class16"> + <para> + <literal>lazy</literal> (可选): 通过设置<literal>lazy="false"</literal>， + 所有的延迟加载（Lazy fetching）功能将被全部禁用（disabled）。 + </para> + </callout> + <callout arearefs="class17"> + <para> + <literal>entity-name</literal> (可选，默认为类名): Hibernate3允许一个类进行多次映射（ + 前提是映射到不同的表），并且允许使用Maps或XML代替Java层次的实体映射 + （也就是实现动态领域模型，不用写持久化类－译注）。 + 更多信息请看<xref linkend="persistent-classes-dynamicmodels"/> and <xref linkend="xml"/>。 + </para> + </callout> + <callout arearefs="class18"> + <para> + <literal>check</literal> (可选): 这是一个SQL表达式， + 用于为自动生成的schema添加多行（multi-row）约束<emphasis>检查</emphasis>。 + </para> + </callout> + <callout arearefs="class19"> + <para> + <literal>rowid</literal> (可选): Hibernate可以使用数据库支持的所谓的ROWIDs，例如： + Oracle数据库，如果你设置这个可选的<literal>rowid</literal>， + Hibernate可以使用额外的字段<literal>rowid</literal>实现快速更新。ROWID是这个功能实现的重点， + 它代表了一个存储元组（tuple）的物理位置。 + </para> + </callout> + <callout arearefs="class20"> + <para> + <literal>subselect</literal> (可选): 它将一个不可变（immutable）并且只读的实体映射到一个数据库的 + 子查询中。当你想用视图代替一张基本表的时候，这是有用的，但最好不要这样做。更多的介绍请看下面内容。 + </para> + </callout> + <callout arearefs="class21"> + <para> + <literal>abstract</literal> (可选): 用于在<literal>&lt;union-subclass&gt;</literal>的继承结构 + （hierarchies）中标识抽象超类。 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + 若指明的持久化类实际上是一个接口，这也是完全可以接受的。 + 之后你可以用元素<literal>&lt;subclass&gt;</literal>来指定该接口的实际实现类。 + 你可以持久化任何<emphasis>static</emphasis>（静态的）内部类。 + 你应该使用标准的类名格式来指定类名，<literal>比如：Foo$Bar</literal>。 + </para> + <para> + 不可变类，<literal>mutable="false"</literal>不可以被应用程序更新或者删除。 + 这可以让Hibernate做一些小小的性能优化。 + </para> + + <para> + 可选的<literal>proxy</literal>属性允许延迟加载类的持久化实例。 + Hibernate开始会返回实现了这个命名接口的CGLIB代理。当代理的某个方法被实际调用的时候， + 真实的持久化对象才会被装载。参见下面的“用于延迟装载的代理”。 + </para> + + <para><emphasis>Implicit</emphasis> (隐式)的多态是指，如果查询时给出的是任何超类、该类实现的接口或者该类的 + 名字，都会返回这个类的实例；如果查询中给出的是子类的名字，则会返回子类的实例。 + <emphasis>Explicit</emphasis> （显式）的多态是指，只有在查询时给出明确的该类名字时才会返回这个类的实例； + 同时只有在这个<literal>&lt;class&gt;</literal>的定义中作为<literal>&lt;subclass&gt;</literal> + 或者<literal>&lt;joined-subclass&gt;</literal>出现的子类，才会可能返回。 + 在大多数情况下，默认的<literal>polymorphism="implicit"</literal>都是合适的。 + 显式的多态在有两个不同的类映射到同一个表的时候很有用。（允许一个“轻型”的类，只包含部分表字段）。 + </para> + + <para> + <literal>persister</literal>属性可以让你定制这个类使用的持久化策略。 + 你可以指定你自己实现 + <literal>org.hibernate.persister.EntityPersister</literal>的子类，你甚至可以完全从头开始编写一个 + <literal>org.hibernate.persister.ClassPersister</literal>接口的实现， + 比如是用储存过程调用、序列化到文件或者LDAP数据库来实现。 + 参阅<literal>org.hibernate.test.CustomPersister</literal>，这是一个简单的例子 + （“持久化”到一个<literal>Hashtable</literal>）。 + </para> + + <para> + 请注意<literal>dynamic-update</literal>和<literal>dynamic-insert</literal>的设置并不会继承到子类， + 所以在<literal>&lt;subclass&gt;</literal>或者<literal>&lt;joined-subclass&gt;</literal>元素中可能 + 需要再次设置。这些设置是否能够提高效率要视情形而定。请用你的智慧决定是否使用。 + </para> + + <para> + 使用<literal>select-before-update</literal>通常会降低性能。如果你重新连接一个脱管（detache）对象实例 + 到一个<literal>Session</literal>中时，它可以防止数据库不必要的触发update。 + 这就很有用了。 + </para> + + <para> + 如果你打开了<literal>dynamic-update</literal>，你可以选择几种乐观锁定的策略： + </para> + <itemizedlist> + <listitem> + <para> + <literal>version（版本检查）</literal> 检查version/timestamp字段 + </para> + </listitem> + <listitem> + <para> + <literal>all（全部）</literal> 检查全部字段 + </para> + </listitem> + <listitem> + <para> + <literal>dirty（脏检查）</literal>只检察修改过的字段 + </para> + </listitem> + <listitem> + <para> + <literal>none（不检查）</literal>不使用乐观锁定 + </para> + </listitem> + </itemizedlist> + <para> + 我们<emphasis>非常</emphasis>强烈建议你在Hibernate中使用version/timestamp字段来进行乐观锁定。 + 对性能来说，这是最好的选择，并且这也是唯一能够处理在session外进行操作的策略（例如： + 在使用<literal>Session.merge()</literal>的时候）。 + </para> + + <para> + 对Hibernate映射来说视图和表是没有区别的，这是因为它们在数据层都是透明的（ + 注意：一些数据库不支持视图属性，特别是更新的时候）。有时你想使用视图，但却不能在数据库 + 中创建它（例如：在遗留的schema中）。这样的话，你可以映射一个不可变的（immutable）并且是 + 只读的实体到一个给定的SQL子查询表达式： + </para> + + <programlisting><![CDATA[<class name="Summary"> + <subselect> + select item.name, max(bid.amount), count(*) + from item + join bid on bid.item_id = item.id + group by item.name + </subselect> + <synchronize table="item"/> + <synchronize table="bid"/> + <id name="name"/> + ... +</class>]]></programlisting> + + <para> + 定义这个实体用到的表为同步（synchronize），确保自动刷新（auto-flush）正确执行， + 并且依赖原实体的查询不会返回过期数据。<literal>&lt;subselect&gt;</literal>在属性元素 + 和一个嵌套映射元素中都可见。 + </para> + + </sect2> + + <sect2 id="mapping-declaration-id" revision="4"> + <title>id</title> + + <para> + 被映射的类<emphasis>必须</emphasis>定义对应数据库表主键字段。大多数类有一个JavaBeans风格的属性， + 为每一个实例包含唯一的标识。<literal>&lt;id&gt;</literal> 元素定义了该属性到数据库表主键字段的映射。 + </para> + + <programlistingco> + <areaspec> + <area id="id1" coords="2 70"/> + <area id="id2" coords="3 70" /> + <area id="id3" coords="4 70"/> + <area id="id4" coords="5 70" /> + <area id="id5" coords="6 70" /> + </areaspec> + <programlisting><![CDATA[<id + name="propertyName" + type="typename" + column="column_name" + unsaved-value="null|any|none|undefined|id_value" + access="field|property|ClassName" + node=&quot;element-name|@attribute-name|element/(a)attribute|.&quot;&gt; + + <generator class="generatorClass"/> +</id>]]></programlisting> + <calloutlist> + <callout arearefs="id1"> + <para> + <literal>name</literal> (可选): 标识属性的名字。 + </para> + </callout> + <callout arearefs="id2"> + <para> + <literal>type</literal> (可选): 标识Hibernate类型的名字。 + </para> + </callout> + <callout arearefs="id3"> + <para> + <literal>column</literal> (可选 - 默认为属性名): 主键字段的名字。 + </para> + </callout> + <callout arearefs="id4"> + <para> + <literal>unsaved-value</literal> (可选 - 默认为一个切合实际（sensible）的值): + 一个特定的标识属性值，用来标志该实例是刚刚创建的，尚未保存。 + 这可以把这种实例和从以前的session中装载过（可能又做过修改--译者注） + 但未再次持久化的实例区分开来。 + </para> + </callout> + <callout arearefs="id5"> + <para> + <literal>access</literal> (可选 - 默认为<literal>property</literal>): + Hibernate用来访问属性值的策略。 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + 如果 <literal>name</literal>属性不存在，会认为这个类没有标识属性。 + </para> + + <para> + <literal>unsaved-value</literal> 属性在Hibernate3中几乎不再需要。 + </para> + + <para> + 还有一个另外的<literal>&lt;composite-id&gt;</literal>定义可以访问旧式的多主键数据。 + 我们强烈不建议使用这种方式。 + </para> + + <sect3 id="mapping-declaration-id-generator" revision="2"> + <title>Generator</title> + + <para> + 可选的<literal>&lt;generator&gt;</literal>子元素是一个Java类的名字， + 用来为该持久化类的实例生成唯一的标识。如果这个生成器实例需要某些配置值或者初始化参数， + 用<literal>&lt;param&gt;</literal>元素来传递。 + </para> + + <programlisting><![CDATA[<id name="id" type="long" column="cat_id"> + <generator class="org.hibernate.id.TableHiLoGenerator"> + <param name="table">uid_table</param> + <param name="column">next_hi_value_column</param> + </generator> +</id>]]></programlisting> + + <para> + + 所有的生成器都实现<literal>org.hibernate.id.IdentifierGenerator</literal>接口。 + 这是一个非常简单的接口；某些应用程序可以选择提供他们自己特定的实现。当然， + Hibernate提供了很多内置的实现。下面是一些内置生成器的快捷名字： + + <variablelist> + <varlistentry> + <term><literal>increment</literal></term> + <listitem> + <para> + 用于为<literal>long</literal>, <literal>short</literal>或者<literal>int</literal>类型生成 + 唯一标识。只有在没有其他进程往同一张表中插入数据时才能使用。 + <emphasis>在集群下不要使用。</emphasis> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>identity</literal></term> + <listitem> + <para> + 对DB2,MySQL, MS SQL Server, Sybase和HypersonicSQL的内置标识字段提供支持。 + 返回的标识符是<literal>long</literal>, <literal>short</literal> 或者<literal>int</literal>类型的。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>sequence</literal></term> + <listitem> + <para> + 在DB2,PostgreSQL, Oracle, SAP DB, McKoi中使用序列（sequence)， + 而在Interbase中使用生成器(generator)。返回的标识符是<literal>long</literal>, + <literal>short</literal>或者 <literal>int</literal>类型的。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>hilo</literal></term> + <listitem> + <para id="mapping-declaration-id-hilodescription" revision="1"> + 使用一个高/低位算法高效的生成<literal>long</literal>, <literal>short</literal> + 或者 <literal>int</literal>类型的标识符。给定一个表和字段（默认分别是 + <literal>hibernate_unique_key</literal> 和<literal>next_hi</literal>）作为高位值的来源。 + 高/低位算法生成的标识符只在一个特定的数据库中是唯一的。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>seqhilo</literal></term> + <listitem> + <para> + 使用一个高/低位算法来高效的生成<literal>long</literal>, <literal>short</literal> + 或者 <literal>int</literal>类型的标识符，给定一个数据库序列（sequence)的名字。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>uuid</literal></term> + <listitem> + <para> + 用一个128-bit的UUID算法生成字符串类型的标识符， + 这在一个网络中是唯一的（使用了IP地址）。UUID被编码为一个32位16进制数字的字符串。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>guid</literal></term> + <listitem> + <para> + 在MS SQL Server 和 MySQL 中使用数据库生成的GUID字符串。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>native</literal></term> + <listitem> + <para> + 根据底层数据库的能力选择<literal>identity</literal>, <literal>sequence</literal> + 或者<literal>hilo</literal>中的一个。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>assigned</literal></term> + <listitem> + <para> + 让应用程序在<literal>save()</literal>之前为对象分配一个标示符。这是 + <literal>&lt;generator&gt;</literal>元素没有指定时的默认生成策略。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>select</literal></term> + <listitem> + <para> + 通过数据库触发器选择一些唯一主键的行并返回主键值来分配一个主键。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>foreign</literal></term> + <listitem> + <para> + 使用另外一个相关联的对象的标识符。通常和<literal>&lt;one-to-one&gt;</literal>联合起来使用。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>sequence-identity</literal></term> + <listitem> + <para> + 一种特别的序列生成策略,使用数据库序列来生成实际值,但将它和JDBC3的getGeneratedKeys结合在一起,使得在插入语句执行的时候就返回生成的值。目前为止只有面向JDK 1.4的Oracle 10g驱动支持这一策略。注意，因为Oracle驱动程序的一个bug，这些插入语句的注释被关闭了。（原文：Note comments on these insert statements are disabled due to a bug in the Oracle drivers.） + </para> + </listitem> + </varlistentry> + + </variablelist> + + </para> + </sect3> + + <sect3 id="mapping-declaration-id-hilo" revision="1"> + <title>高/低位算法（Hi/Lo Algorithm）</title> + <para> + <literal>hilo</literal> 和 <literal>seqhilo</literal>生成器给出了两种hi/lo算法的实现， + 这是一种很令人满意的标识符生成算法。第一种实现需要一个“特殊”的数据库表来保存下一个可用的“hi”值。 + 第二种实现使用一个Oracle风格的序列（在被支持的情况下）。 + </para> + + <programlisting><![CDATA[<id name="id" type="long" column="cat_id"> + <generator class="hilo"> + <param name="table">hi_value</param> + <param name="column">next_value</param> + <param name="max_lo">100</param> + </generator> +</id>]]></programlisting> + + <programlisting><![CDATA[<id name="id" type="long" column="cat_id"> + <generator class="seqhilo"> + <param name="sequence">hi_value</param> + <param name="max_lo">100</param> + </generator> +</id>]]></programlisting> + + <para> + 很不幸，你在为Hibernate自行提供<literal>Connection</literal>时无法使用<literal>hilo</literal>。 + 当Hibernate使用JTA获取应用服务器的数据源连接时,你必须正确地配置 + <literal>hibernate.transaction.manager_lookup_class</literal>。 + </para> + </sect3> + + <sect3 id="mapping-declaration-id-uuid"> + <title>UUID算法（UUID Algorithm ）</title> + <para> + UUID包含：IP地址，JVM的启动时间（精确到1/4秒），系统时间和一个计数器值（在JVM中唯一）。 + 在Java代码中不可能获得MAC地址或者内存地址，所以这已经是我们在不使用JNI的前提下的能做的最好实现了。 + </para> + </sect3> + + <sect3 id="mapping-declaration-id-sequences"> + <title>标识字段和序列（Identity columns and Sequences）</title> + <para> + 对于内部支持标识字段的数据库(DB2,MySQL,Sybase,MS SQL)，你可以使用<literal>identity</literal>关键字生成。 + 对于内部支持序列的数据库（DB2,Oracle, PostgreSQL, Interbase, McKoi,SAP DB), + 你可以使用<literal>sequence</literal>风格的关键字生成。 + 这两种方式对于插入一个新的对象都需要两次SQL查询。 + </para> + + <programlisting><![CDATA[<id name="id" type="long" column="person_id"> + <generator class="sequence"> + <param name="sequence">person_id_sequence</param> + </generator> +</id>]]></programlisting> + + <programlisting><![CDATA[<id name="id" type="long" column="person_id" unsaved-value="0"> + <generator class="identity"/> +</id>]]></programlisting> + <para> + 对于跨平台开发，<literal>native</literal>策略会从<literal>identity</literal>, + <literal>sequence</literal> 和<literal>hilo</literal>中进行选择，选择哪一个，这取决于底层数据库的支持能力。 + </para> + </sect3> + + <sect3 id="mapping-declaration-id-assigned"> + <title>程序分配的标识符（Assigned Identifiers）</title> + <para> + 如果你需要应用程序分配一个标示符（而非Hibernate来生成），你可以使用<literal>assigned</literal> + 生成器。这种特殊的生成器会使用已经分配给对象的标识符属性的标识符值。 + 这个生成器使用一个自然键（natural key，有商业意义的列－译注）作为主键，而不是使用一个代理键（ + surrogate key，没有商业意义的列－译注）。这是没有指定<literal>&lt;generator&gt;</literal>元素时的默认行为 + </para> + + <para> + 当选择<literal>assigned</literal>生成器时，除非有一个version或timestamp属性，或者你定义了 + <literal>Interceptor.isUnsaved()</literal>，否则需要让Hiberante使用 + <literal>unsaved-value="undefined"</literal>，强制Hibernatet查询数据库来确定一个实例是瞬时的（transient） + 还是脱管的（detached）。 + </para> + </sect3> + + <sect3 id="mapping-declaration-id-select"> + <title>触发器实现的主键生成器（Primary keys assigned by triggers）</title> + <para> + 仅仅用于遗留的schema中 (Hibernate不能使用触发器生成DDL)。 + </para> + + <programlisting><![CDATA[<id name="id" type="long" column="person_id"> + <generator class="select"> + <param name="key">socialSecurityNumber</param> + </generator> +</id>]]></programlisting> + + <para> + 在上面的例子中，类定义了一个命名为<literal>socialSecurityNumber</literal>的唯一值属性， + 它是一个自然键（natural key），命名为<literal>person_id</literal>的代理键（surrogate key） + 的值由触发器生成。 + </para> + + </sect3> + + </sect2> + + <sect2 id="mapping-declaration-compositeid" revision="3"> + <title>composite-id</title> + + <programlisting><![CDATA[<composite-id + name="propertyName" + class="ClassName" + mapped="true|false" + access="field|property|ClassName" + node="element-name|." + > + + <key-property name="propertyName" type="typename" column="column_name"/> + <key-many-to-one name="propertyName class="ClassName" column="column_name"/> + ...... +</composite-id>]]></programlisting> + + <para> + 如果表使用联合主键，你可以映射类的多个属性为标识符属性。 + <literal>&lt;composite-id&gt;</literal>元素接受<literal>&lt;key-property&gt;</literal> + 属性映射和<literal>&lt;key-many-to-one&gt;</literal>属性映射作为子元素。 + </para> + + <programlisting><![CDATA[<composite-id> + <key-property name="medicareNumber"/> + <key-property name="dependent"/> +</composite-id>]]></programlisting> + + <para> + 你的持久化类<emphasis>必须</emphasis>重载<literal>equals()</literal>和 + <literal>hashCode()</literal>方法，来实现组合的标识符的相等判断。 + 实现<literal>Serializable</literal>接口也是必须的。 + </para> + + <para> + 不幸的是，这种组合关键字的方法意味着一个持久化类是它自己的标识。除了对象自己之外， + 没有什么方便的“把手”可用。你必须初始化持久化类的实例，填充它的标识符属性，再<literal>load()</literal> + 组合关键字关联的持久状态。我们把这种方法称为<emphasis>embedded（嵌入式）</emphasis>的组合标识符，在重要的应用中不鼓励使用这种用法。 + </para> + + <para> + 第二种方法我们称为<emphasis>mapped(映射式)</emphasis>组合标识符 (mapped composite identifier),<literal>&lt;composite-id&gt;</literal>元素中列出的标识属性不但在持久化类出现，还形成一个独立的标识符类。 + </para> + + <programlisting><![CDATA[<composite-id class="MedicareId" mapped="true"> + <key-property name="medicareNumber"/> + <key-property name="dependent"/> +</composite-id>]]></programlisting> + + <para> + 在这个例子中，组合标识符类<literal>MedicareId</literal>和实体类都含有<literal>medicareNumber</literal>和<literal>dependent</literal>属性。标识符类必须重载<literal>equals()</literal>和<literal>hashCode()</literal>并且实现<literal>Serializable</literal>接口。这种方法的缺点是出现了明显的代码重复。 + </para> + + <para> + 下面列出的属性是用来指定一个映射式组合标识符的： + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>mapped</literal> (可选, 默认为<literal>false</literal>): + 指明使用一个映射式组合标识符，其包含的属性映射同时在实体类和组合标识符类中出现。 + </para> + </listitem> + <listitem> + <para> + <literal>class</literal> (可选,但对映射式组合标识符必须指定): + 作为组合标识符类使用的类名. + </para> + </listitem> + </itemizedlist> + + <para> + 在<xref linkend="components-compositeid"/>一节中,我们会描述第三种方式,那就是把组合标识符实现为一个组件(component)类,这是更方便的方法。下面的属性仅对第三种方法有效： + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>name</literal> (可选,但对这种方法而言必须): 包含此组件标识符的组件类型的名字 (参阅第9章). + + </para> + </listitem> + <listitem> + <para> + <literal>access</literal> (可选 - 默认为<literal>property</literal>): + Hibernate应该使用的访问此属性值的策略 + </para> + </listitem> + <listitem> + <para> + <literal>class</literal> (可选 - 默认会用反射来自动判定属性类型 + ): 用来作为组合标识符的组件类的类名（参阅下一节） + + </para> + </listitem> + </itemizedlist> + + <para> + 第三种方式，被称为<emphasis>identifier component(标识符组件)</emphasis>是我们对几乎所有应用都推荐使用的方式。 + </para> + + </sect2> + + <sect2 id="mapping-declaration-discriminator" revision="3"> + <title>鉴别器（discriminator）</title> + + <para> + 在"一棵对象继承树对应一个表"的策略中,<literal>&lt;discriminator&gt;</literal>元素是必需的, + 它定义了表的鉴别器字段。鉴别器字段包含标志值，用于告知持久化层应该为某个特定的行创建哪一个子类的实例。 + 如下这些受到限制的类型可以使用： + <literal>string</literal>, <literal>character</literal>, <literal>integer</literal>, + <literal>byte</literal>, <literal>short</literal>, <literal>boolean</literal>, + <literal>yes_no</literal>, <literal>true_false</literal>. + </para> + + <programlistingco> + <areaspec> + <area id="discriminator1" coords="2 60"/> + <area id="discriminator2" coords="3 60" /> + <area id="discriminator3" coords="4 60" /> + <area id="discriminator4" coords="5 60" /> + <area id="discriminator5" coords="6 60" /> + </areaspec> + <programlisting><![CDATA[<discriminator + column="discriminator_column" + type="discriminator_type" + force="true|false" + insert="true|false" + formula="arbitrary sql expression" +/>]]></programlisting> + <calloutlist> + <callout arearefs="discriminator1"> + <para> + <literal>column</literal> (可选 - 默认为 <literal>class</literal>) 鉴别器字段的名字 + </para> + </callout> + <callout arearefs="discriminator2"> + <para> + <literal>type</literal> (可选 - 默认为 <literal>string</literal>) 一个Hibernate字段类型的名字 + </para> + </callout> + <callout arearefs="discriminator3"> + <para> + <literal>force(强制)</literal> (可选 - 默认为 <literal>false</literal>) + "强制"Hibernate指定允许的鉴别器值,即使当取得的所有实例都是根类的。 + </para> + </callout> + <callout arearefs="discriminator4"> + <para> + <literal>insert</literal> (可选 - 默认为<literal>true</literal>) + 如果你的鉴别器字段也是映射为复合标识（composite identifier）的一部分，则需将 + 这个值设为<literal>false</literal>。（告诉Hibernate在做SQL <literal>INSERT</literal> + 时不包含该列） + </para> + </callout> + <callout arearefs="discriminator5"> + <para> + <literal>formula</literal> (可选) + 一个SQL表达式，在类型判断（判断是父类还是具体子类－译注）时执行。可用于基于内容的鉴别器。 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + 鉴别器字段的实际值是根据<literal>&lt;class&gt;</literal>和<literal>&lt;subclass&gt;</literal>元素中 + 的<literal>discriminator-value</literal>属性得来的。 + </para> + + <para> + <literal>force</literal>属性仅仅在这种情况下有用的：表中包含没有被映射到持久化类的附加辨别器值。 + 这种情况不会经常遇到。 + </para> + + <para> + 使用<literal>formula</literal>属性你可以定义一个SQL表达式，用来判断一个行数据的类型。 + </para> + + <programlisting><![CDATA[<discriminator + formula="case when CLASS_TYPE in ('a', 'b', 'c') then 0 else 1 end" + type="integer"/>]]></programlisting> + + </sect2> + + <sect2 id="mapping-declaration-version" revision="4"> + <title>版本（version）(可选)</title> + + <para> + <literal>&lt;version&gt;</literal>元素是可选的，表明表中包含附带版本信息的数据。 + 这在你准备使用<emphasis> 长事务（long transactions）</emphasis>的时候特别有用。（见后） + </para> + + <programlistingco> + <areaspec> + <area id="version1" coords="2 70"/> + <area id="version2" coords="3 70"/> + <area id="version3" coords="4 70"/> + <area id="version4" coords="5 70"/> + <area id="version5" coords="6 70"/> + <area id="version6" coords="7 70"/> + <area id="version7" coords="8 70"/> + </areaspec> + <programlisting><![CDATA[<version + column="version_column" + name="propertyName" + type="typename" + access="field|property|ClassName" + unsaved-value="null|negative|undefined" + generated="never|always" + insert="true|false" + node=&quot;element-name|@attribute-name|element/(a)attribute|.&quot; +/>]]></programlisting> + <calloutlist> + <callout arearefs="version1"> + <para> + <literal>column</literal> (可选 - 默认为属性名): 指定持有版本号的字段名。 + </para> + </callout> + <callout arearefs="version2"> + <para> + <literal>name</literal>: 持久化类的属性名。 + </para> + </callout> + <callout arearefs="version3"> + <para> + <literal>type</literal> (可选 - 默认是 <literal>integer</literal>): 版本号的类型。 + </para> + </callout> + <callout arearefs="version4"> + <para> + <literal>access</literal> (可选 - 默认是 <literal>property</literal>): + Hibernate用于访问属性值的策略。 + </para> + </callout> + <callout arearefs="version5"> + <para> + <literal>unsaved-value</literal> (可选 - 默认是<literal>undefined</literal>): + 用于标明某个实例时刚刚被实例化的（尚未保存）版本属性值，依靠这个值就可以把这种情况 + 和已经在先前的session中保存或装载的脱管（detached）实例区分开来。 + （<literal>undefined</literal>指明应被使用的标识属性值。） + </para> + </callout> + <callout arearefs="version6"> + <para> + <literal>generated</literal> (可选 - 默认是 <literal>never</literal>): + 表明此版本属性值是否实际上是由数据库生成的。请参阅<xref linkend="mapping-generated">generated properties</xref>部分的讨论。 + </para> + </callout> + <callout arearefs="version7"> + <para> + <literal>insert</literal> (可选 - 默认是 <literal>true</literal>): + 表明此版本列应该包含在SQL插入语句中。只有当数据库字段有默认值<literal>0</literal>的时候，才可以设置为<literal>false</literal>。 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + 版本号必须是以下类型：<literal>long</literal>, <literal>integer</literal>, + <literal>short</literal>, <literal>timestamp</literal>或者<literal>calendar</literal>。 + </para> + + <para> + 一个脱管（detached）实例的version或timestamp属性不能为空（null），因为Hibernate不管 + <literal>unsaved-value</literal>被指定为何种策略，它将任何属性为空的version或timestamp + 实例看作为瞬时（transient）实例。 + <emphasis>避免Hibernate中的传递重附（transitive reattachment）问题的一个简单方法是 + 定义一个不能为空的version或timestamp属性，特别是在人们使用程序分配的标识符（assigned identifiers） + 或复合主键时非常有用！</emphasis> + </para> + </sect2> + + <sect2 id="mapping-declaration-timestamp" revision="4"> + <title>timestamp (可选)</title> + + <para> + 可选的<literal>&lt;timestamp&gt;</literal>元素指明了表中包含时间戳数据。 + 这用来作为版本的替代。时间戳本质上是一种对乐观锁定的一种不是特别安全的实现。当然， + 有时候应用程序可能在其他方面使用时间戳。 + </para> + + <programlistingco> + <areaspec> + <area id="timestamp1" coords="2 70"/> + <area id="timestamp2" coords="3 70" /> + <area id="timestamp3" coords="4 70" /> + <area id="timestamp4" coords="5 70" /> + <area id="timestamp5" coords="6 70" /> + <area id="timestamp6" coords="7 70" /> + </areaspec> + <programlisting><![CDATA[<timestamp + column="timestamp_column" + name="propertyName" + access="field|property|ClassName" + unsaved-value="null|undefined" + source="vm|db" + generated="never|always" + node=&quot;element-name|@attribute-name|element/(a)attribute|.&quot; +/>]]></programlisting> + <calloutlist> + <callout arearefs="timestamp1"> + <para> + <literal>column</literal> (可选 - 默认为属性名): 持有时间戳的字段名。 + </para> + </callout> + <callout arearefs="timestamp2"> + <para> + <literal>name</literal>: 在持久化类中的JavaBeans风格的属性名， + 其Java类型是 <literal>Date</literal> 或者 <literal>Timestamp</literal>的。 + </para> + </callout> + <callout arearefs="timestamp3"> + <para> + <literal>access</literal> (可选 - 默认是 <literal>property</literal>): + Hibernate用于访问属性值的策略。 + </para> + </callout> + <callout arearefs="timestamp4"> + <para> + <literal>unsaved-value</literal> (可选 - 默认是<literal>null</literal>): + 用于标明某个实例时刚刚被实例化的（尚未保存）版本属性值，依靠这个值就可以把这种情况和 + 已经在先前的session中保存或装载的脱管（detached）实例区分开来。（<literal>undefined</literal> + 指明使用标识属性值进行这种判断。） + </para> + </callout> + <callout arearefs="timestamp5"> + <para> + <literal>source</literal> (可选 - 默认是 <literal>vm</literal>): + Hibernate如何才能获取到时间戳的值呢？从数据库，还是当前JVM？从数据库获取会带来一些负担，因为Hibernate必须访问数据库来获得“下一个值”，但是在集群环境中会更安全些。还要注意，并不是所有的<literal>Dialect（方言）</literal>都支持获得数据库的当前时间戳的，而支持的数据库中又有一部分因为精度不足,用于锁定是不安全的（例如Oracle 8）。 + </para> + </callout> + <callout arearefs="timestamp6"> + <para> + <literal>generated</literal> (可选 - 默认是 <literal>never</literal>): + 指出时间戳值是否实际上是由数据库生成的.请参阅<xref linkend="mapping-generated">generated properties</xref>的讨论。 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + 注意，<literal>&lt;timestamp&gt;</literal> 和<literal>&lt;version type="timestamp"&gt;</literal>是等价的。并且<literal>&lt;timestamp source="db"&gt;</literal>和<literal>&lt;version type="dbtimestamp"&gt;</literal>是等价的。 + </para> + </sect2> + + + <sect2 id="mapping-declaration-property" revision="4"> + <title>property</title> + + <para> + <literal>&lt;property&gt;</literal>元素为类定义了一个持久化的,JavaBean风格的属性。 + </para> + + <programlistingco> + <areaspec> + <area id="property1" coords="2 70"/> + <area id="property2" coords="3 70"/> + <area id="property3" coords="4 70"/> + <areaset id="property4-5" coords=""> + <area id="property4" coords='5 70'/> + <area id="property5" coords='6 70'/> + </areaset> + <area id="property6" coords="7 70"/> + <area id="property7" coords="8 70"/> + <area id="property8" coords="9 70"/> + <area id="property9" coords="10 70"/> + <area id="property10" coords="11 70"/> + <area id="property11" coords="12 70"/> + <area id="property12" coords="13 70"/> + </areaspec> + <programlisting><![CDATA[<property + name="propertyName" + column="column_name" + type="typename" + update="true|false" + insert="true|false" + formula="arbitrary SQL expression" + access="field|property|ClassName" + lazy="true|false" + unique="true|false" + not-null="true|false" + optimistic-lock="true|false" + generated="never|insert|always" + node=&quot;element-name|@attribute-name|element/(a)attribute|.&quot; + + index="index_name" + unique_key="unique_key_id" + length="L" + precision="P" + scale="S" +/>]]></programlisting> + <calloutlist> + <callout arearefs="property1"> + <para> + <literal>name</literal>: 属性的名字,以小写字母开头。 + </para> + </callout> + <callout arearefs="property2"> + <para> + <literal>column</literal> (可选 - 默认为属性名字): 对应的数据库字段名。 + 也可以通过嵌套的<literal>&lt;column&gt;</literal>元素指定。 + </para> + </callout> + <callout arearefs="property3"> + <para> + <literal>type</literal> (可选): 一个Hibernate类型的名字。 + </para> + </callout> + <callout arearefs="property4-5"> + <para> + <literal>update, insert</literal> (可选 - 默认为 <literal>true</literal>) : + 表明用于<literal>UPDATE</literal> 和/或 <literal>INSERT</literal> + 的SQL语句中是否包含这个被映射了的字段。这二者如果都设置为<literal>false</literal> + 则表明这是一个“外源性（derived）”的属性，它的值来源于映射到同一个（或多个） + 字段的某些其他属性，或者通过一个trigger(触发器）或其他程序生成。 + </para> + </callout> + <callout arearefs="property6"> + <para> + <literal>formula</literal> (可选): 一个SQL表达式，定义了这个<emphasis>计算 + （computed）</emphasis> 属性的值。计算属性没有和它对应的数据库字段。 + </para> + </callout> + <callout arearefs="property7"> + <para> + <literal>access</literal> (可选 - 默认值为 <literal>property</literal>): + Hibernate用来访问属性值的策略。 + </para> + </callout> + <callout arearefs="property8"> + <para> + <literal>lazy</literal> (可选 - 默认为 <literal>false</literal>): 指定 + 指定实例变量第一次被访问时，这个属性是否延迟抓取（fetched lazily）（ + 需要运行时字节码增强）。 + </para> + </callout> + <callout arearefs="property9"> + <para> + <literal>unique</literal> (可选): 使用DDL为该字段添加唯一的约束。 + 同样，允许它作为<literal>property-ref</literal>引用的目标。 + </para> + </callout> + <callout arearefs="property10"> + <para> + <literal>not-null</literal> (可选): 使用DDL为该字段添加可否为空（nullability）的约束。 + </para> + </callout> + <callout arearefs="property11"> + <para> + <literal>optimistic-lock</literal> (可选 - 默认为 <literal>true</literal>): + 指定这个属性在做更新时是否需要获得乐观锁定（optimistic lock）。 + 换句话说，它决定这个属性发生脏数据时版本（version）的值是否增长。 + </para> + </callout> + <callout arearefs="property12"> + <para> + <literal>generated</literal> (可选 - 默认为 <literal>never</literal>): + 表明此属性值是否实际上是由数据库生成的。请参阅<xref linkend="mapping-generated">generated properties</xref>的讨论。 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + <emphasis>typename</emphasis>可以是如下几种： + </para> + + <orderedlist spacing="compact"> + <listitem> + <para> + Hibernate基本类型名（比如：<literal>integer, string, character,date, timestamp, + float, binary, serializable, object, blob</literal>）。 + </para> + </listitem> + <listitem> + <para> + 一个Java类的名字，这个类属于一种默认基础类型 + (比如： <literal>int, float,char, java.lang.String, java.util.Date, java.lang.Integer, + java.sql.Clob</literal>)。 + </para> + </listitem> + <listitem> + <para> + 一个可以序列化的Java类的名字。 + </para> + </listitem> + <listitem> + <para> + 一个自定义类型的类的名字。（比如： <literal>com.illflow.type.MyCustomType</literal>)。 + </para> + </listitem> + </orderedlist> + + <para> + 如果你没有指定类型，Hibernarte会使用反射来得到这个名字的属性，以此来猜测正确的Hibernate类型。 + Hibernate会按照规则2,3,4的顺序对属性读取器(getter方法）的返回类进行解释。然而，这还不够。 + 在某些情况下你仍然需要<literal>type</literal>属性。（比如，为了区别<literal>Hibernate.DATE</literal> + 和<literal>Hibernate.TIMESTAMP</literal>,或者为了指定一个自定义类型。） + </para> + + <para> + <literal>access</literal>属性用来让你控制Hibernate如何在运行时访问属性。在默认情况下， + Hibernate会使用属性的get/set方法对（pair）。如果你指明<literal>access="field"</literal>, + Hibernate会忽略get/set方法对，直接使用反射来访问成员变量。你也可以指定你自己的策略， + 这就需要你自己实现<literal>org.hibernate.property.PropertyAccessor</literal>接口， + 再在access中设置你自定义策略类的名字。 + </para> + + <para> + 衍生属性（derive propertie）是一个特别强大的特征。这些属性应该定义为只读，属性值在装载时计算生成。 + 你用一个SQL表达式生成计算的结果，它会在这个实例转载时翻译成一个SQL查询的<literal>SELECT</literal> + 子查询语句。 + </para> + + <programlisting><![CDATA[ +<property name="totalPrice" + formula="( SELECT SUM (li.quantity*p.price) FROM LineItem li, Product p + WHERE li.productId = p.productId + AND li.customerId = customerId + AND li.orderNumber = orderNumber )"/>]]></programlisting> + + <para> + 注意，你可以使用实体自己的表，而不用为这个特别的列定义别名（ + 上面例子中的<literal>customerId</literal>）。同时注意，如果你不喜欢使用属性， + 你可以使用嵌套的<literal>&lt;formula&gt;</literal>映射元素。 + </para> + + </sect2> + + <sect2 id="mapping-declaration-manytoone" revision="5"> + <title>多对一（many-to-one）</title> + + <para> + 通过<literal>many-to-one</literal>元素,可以定义一种常见的与另一个持久化类的关联。 + 这种关系模型是多对一关联（实际上是一个对象引用－译注）：这个表的一个外键引用目标表的 + 主键字段。 + </para> + + <programlistingco> + <areaspec> + <area id="manytoone1" coords="2 70"/> + <area id="manytoone2" coords="3 70"/> + <area id="manytoone3" coords="4 70"/> + <area id="manytoone4" coords="5 70"/> + <area id="manytoone5" coords="6 70"/> + <areaset id="manytoone6-7" coords=""> + <area id="manytoone6" coords='7 70'/> + <area id="manytoone7" coords='8 70'/> + </areaset> + <area id="manytoone8" coords="9 70"/> + <area id="manytoone9" coords="10 70"/> + <area id="manytoone10" coords="11 70"/> + <area id="manytoone11" coords="12 70"/> + <area id="manytoone12" coords="13 70"/> + <area id="manytoone13" coords="14 70"/> + <area id="manytoone14" coords="15 70"/> + <area id="manytoone15" coords="16 70"/> + <area id="manytoone16" coords="17 70"/> + </areaspec> + <programlisting><![CDATA[<many-to-one + name="propertyName" + column="column_name" + class="ClassName" + cascade="cascade_style" + fetch="join|select" + update="true|false" + insert="true|false" + property-ref="propertyNameFromAssociatedClass" + access="field|property|ClassName" + unique="true|false" + not-null="true|false" + optimistic-lock="true|false" + lazy="proxy|no-proxy|false" + not-found="ignore|exception" + entity-name="EntityName" + formula="arbitrary SQL expression" + node=&quot;element-name|@attribute-name|element/(a)attribute|.&quot; + + embed-xml="true|false" + index="index_name" + unique_key="unique_key_id" + foreign-key="foreign_key_name" + +/>]]></programlisting> + <calloutlist> + <callout arearefs="manytoone1"> + <para> + <literal>name</literal>: 属性名。 + </para> + </callout> + <callout arearefs="manytoone2"> + <para> + <literal>column</literal> (可选): 外间字段名。它也可以通过嵌套的 + <literal>&lt;column&gt;</literal>元素指定。 + </para> + </callout> + <callout arearefs="manytoone3"> + <para> + <literal>class</literal> (可选 - 默认是通过反射得到属性类型): 关联的类的名字。 + </para> + </callout> + <callout arearefs="manytoone4"> + <para> + <literal>cascade（级联）</literal> (可选): 指明哪些操作会从父对象级联到关联的对象。 + </para> + </callout> + <callout arearefs="manytoone5"> + <para> + <literal>fetch</literal> (可选 - 默认为 <literal>select</literal>): + 在外连接抓取（outer-join fetching）和序列选择抓取（sequential select fetching）两者中选择其一。 + </para> + </callout> + <callout arearefs="manytoone6"> + <para> + <literal>update, insert</literal> (可选 - 默认为 <literal>true</literal>) + 指定对应的字段是否包含在用于<literal>UPDATE</literal> 和/或 <literal>INSERT</literal> + 的SQL语句中。如果二者都是<literal>false</literal>,则这是一个纯粹的 + “外源性（derived）”关联，它的值是通过映射到同一个（或多个）字段的某些其他属性得到 + 或者通过trigger(触发器）、或其他程序生成。 + </para> + </callout> + <callout arearefs="manytoone7"> + <para> + <literal>property-ref</literal>: (可选) 指定关联类的一个属性，这个属性将会和本外键相对应。 + 如果没有指定，会使用对方关联类的主键。 + </para> + </callout> + <callout arearefs="manytoone8"> + <para> + <literal>access</literal> (可选 - 默认是 <literal>property</literal>): + Hibernate用来访问属性的策略。 + </para> + </callout> + <callout arearefs="manytoone9"> + <para> + <literal>unique</literal> (可选): 使用DDL为外键字段生成一个唯一约束。此外， + 这也可以用作<literal>property-ref</literal>的目标属性。这使关联同时具有 + 一对一的效果。 + </para> + </callout> + <callout arearefs="manytoone10"> + <para> + <literal>not-null</literal> (可选): 使用DDL为外键字段生成一个非空约束。 + </para> + </callout> + <callout arearefs="manytoone11"> + <para> + <literal>optimistic-lock</literal> (可选 - 默认为 <literal>true</literal>): + 指定这个属性在做更新时是否需要获得乐观锁定（optimistic lock）。 + 换句话说，它决定这个属性发生脏数据时版本（version）的值是否增长。 + </para> + </callout> + <callout arearefs="manytoone12"> + <para> + <literal>lazy</literal> (可选 - 默认为 <literal>proxy</literal>): + 默认情况下，单点关联是经过代理的。<literal>lazy="no-proxy"</literal>指定此属性应该在实例变量第一次被访问时应该延迟抓取（fetche lazily）（需要运行时字节码的增强）。 + <literal>lazy="false"</literal>指定此关联总是被预先抓取。 + </para> + </callout> + <callout arearefs="manytoone13"> + <para> + <literal>not-found</literal> (可选 - 默认为 <literal>exception</literal>): + 指定外键引用的数据不存在时如何处理： + <literal>ignore</literal>会将行数据不存在视为一个空（null）关联。 + </para> + </callout> + <callout arearefs="manytoone14"> + <para> + <literal>entity-name</literal> (可选): 被关联的类的实体名。 + </para> + </callout> + <callout arearefs="manytoone15"> + <para> + <literal>formula</literal> (可选): + SQL表达式，用于定义<emphasis>computed（计算出的）</emphasis>外键值。 + </para> + </callout> + + </calloutlist> + </programlistingco> + + + <para> + <literal>cascade</literal>属性设置为除了<literal>none</literal>以外任何有意义的值， + 它将把特定的操作传递到关联对象中。这个值就代表着Hibernate基本操作的名称， + <literal>persist, merge, delete, save-update, evict, replicate, lock, refresh</literal>， + 以及特别的值<literal>delete-orphan</literal>和<literal>all</literal>，并且可以用逗号分隔符 + 来组合这些操作，例如，<literal>cascade="persist,merge,evict"</literal>或 + <literal>cascade="all,delete-orphan"</literal>。更全面的解释请参考<xref linkend="objectstate-transitive"/>. 注意，单值关联 (many-to-one 和 + one-to-one 关联) 不支持删除孤儿（orphan delete，删除不再被引用的值）. + + + </para> + + <para> + 一个典型的简单<literal>many-to-one</literal>定义例子： + </para> + + <programlisting><![CDATA[<many-to-one name="product" class="Product" column="PRODUCT_ID"/>]]></programlisting> + + <para> + <literal>property-ref</literal>属性只应该用来对付遗留下来的数据库系统， + 可能有外键指向对方关联表的是个非主键字段（但是应该是一个惟一关键字）的情况下。 + 这是一种十分丑陋的关系模型。比如说，假设<literal>Product</literal>类有一个惟一的序列号， + 它并不是主键。（<literal>unique</literal>属性控制Hibernate通过SchemaExport工具进行的DDL生成。） + </para> + + + <programlisting><![CDATA[<property name="serialNumber" unique="true" type="string" column="SERIAL_NUMBER"/>]]></programlisting> + + <para> + 那么关于<literal>OrderItem</literal> 的映射可能是： + </para> + + <programlisting><![CDATA[<many-to-one name="product" property-ref="serialNumber" column="PRODUCT_SERIAL_NUMBER"/>]]></programlisting> + + <para> + 当然，我们决不鼓励这种用法。 + </para> + + + <para> + 如果被引用的唯一主键由关联实体的多个属性组成，你应该在名称为<literal>&lt;properties&gt;</literal>的元素 + 里面映射所有关联的属性。 + </para> + + <para> + 假若被引用的唯一主键是组件的属性，你可以指定属性路径： + </para> + + <programlisting><![CDATA[<many-to-one name="owner" property-ref="identity.ssn" column="OWNER_SSN"/>]]></programlisting> + + </sect2> + +<sect2 id="mapping-declaration-onetoone" revision="3"> + <title>一对一</title> + + <para> + 持久化对象之间一对一的关联关系是通过<literal>one-to-one</literal>元素定义的。 + </para> + + <programlistingco> + <areaspec> + <area id="onetoone1" coords="2 70"/> + <area id="onetoone2" coords="3 70"/> + <area id="onetoone3" coords="4 70"/> + <area id="onetoone4" coords="5 70"/> + <area id="onetoone5" coords="6 70"/> + <area id="onetoone6" coords="7 70"/> + <area id="onetoone7" coords="8 70"/> + <area id="onetoone8" coords="9 70"/> + <area id="onetoone9" coords="10 70"/> + <area id="onetoone10" coords="11 70"/> + </areaspec> + <programlisting><![CDATA[<one-to-one + name="propertyName" + class="ClassName" + cascade="cascade_style" + constrained="true|false" + fetch="join|select" + property-ref="propertyNameFromAssociatedClass" + access="field|property|ClassName" + formula="any SQL expression" + lazy="proxy|no-proxy|false" + entity-name="EntityName" + node=&quot;element-name|@attribute-name|element/(a)attribute|.&quot; + + embed-xml="true|false" + foreign-key="foreign_key_name" +/>]]></programlisting> + <calloutlist> + <callout arearefs="onetoone1"> + <para> + <literal>name</literal>: 属性的名字。 + </para> + </callout> + <callout arearefs="onetoone2"> + <para> + <literal>class</literal> (可选 - 默认是通过反射得到的属性类型)：被关联的类的名字。 + </para> + </callout> + <callout arearefs="onetoone3"> + <para> + <literal>cascade(级联)</literal> (可选) 表明操作是否从父对象级联到被关联的对象。 + </para> + </callout> + <callout arearefs="onetoone4"> + <para> + <literal>constrained(约束)</literal> (可选) 表明该类对应的表对应的数据库表，和被关联的对象所对应的数据库表之间，通过一个外键引用对主键进行约束。 + 这个选项影响<literal>save()</literal>和<literal>delete()</literal>在级联执行时的先后顺序以及 + 决定该关联能否被委托(也在schema export tool中被使用). + </para> + </callout> + <callout arearefs="onetoone5"> + <para> + <literal>fetch</literal> (可选 - 默认设置为<literal>选择</literal>): + 在外连接抓取或者序列选择抓取选择其一. + </para> + </callout> + <callout arearefs="onetoone6"> + <para> + <literal>property-ref</literal>: (可选) 指定关联类的属性名，这个属性将会和本类的主键相对应。如果没有指定，会使用对方关联类的主键。 + </para> + </callout> + <callout arearefs="onetoone7"> + <para> + <literal>access</literal> (可选 - 默认是 <literal>property</literal>): Hibernate用来访问属性的策略。 + </para> + </callout> + <callout arearefs="onetoone8"> + <para> + <literal>formula </literal> (可选):绝大多数一对一的关联都指向其实体的主键。在一些少见的情况中， 你可能会指向其他的一个或多个字段，或者是一个表达式，这些情况下，你可以用一个SQL公式来表示。 （可以在org.hibernate.test.onetooneformula找到例子） + + </para> + </callout> + <callout arearefs="onetoone9"> + <para> + <literal>lazy</literal> (可选 - 默认为 <literal>proxy</literal>): + 默认情况下，单点关联是经过代理的。<literal>lazy="no-proxy"</literal>指定此属性应该在实例变量第一次被访问时应该延迟抓取（fetche lazily）（需要运行时字节码的增强）。 + <literal>lazy="false"</literal>指定此关联总是被预先抓取。<emphasis>注意，如果<literal>constrained="false"</literal>, + 不可能使用代理，Hibernate会采取预先抓取！</emphasis> + </para> + </callout> + <callout arearefs="onetoone10"> + <para> + <literal>entity-name</literal> (可选): 被关联的类的实体名。 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + 有两种不同的一对一关联： + </para> + <itemizedlist> + <listitem> + <para> + 主键关联 + </para></listitem> + <listitem> + <para> + 惟一外键关联 + </para></listitem> + </itemizedlist> + + <para> + 主键关联不需要额外的表字段；如果两行是通过这种一对一关系相关联的，那么这两行就共享同样的主关键字值。所以如果你希望两个对象通过主键一对一关联，你必须确认它们被赋予同样的标识值！ + </para> + + <para> + 比如说，对下面的<literal>Employee</literal>和<literal>Person</literal>进行主键一对一关联: + </para> + + + <programlisting><![CDATA[<one-to-one name="person" class="Person"/>]]></programlisting> + <programlisting><![CDATA[<one-to-one name="employee" class="Employee" constrained="true"/>]]></programlisting> + + <para> + 现在我们必须确保PERSON和EMPLOYEE中相关的字段是相等的。我们使用一个被成为<literal>foreign</literal>的特殊的hibernate标识符生成策略： + </para> + + <programlisting><![CDATA[<class name="person" table="PERSON"> + <id name="id" column="PERSON_ID"> + <generator class="foreign"> + <param name="property">employee</param> + </generator> + </id> + ... + <one-to-one name="employee" + class="Employee" + constrained="true"/> +</class>]]></programlisting> + + <para> + 一个刚刚保存的<literal>Person</literal>实例被赋予和该<literal>Person</literal>的<literal>employee</literal>属性所指向的<literal>Employee</literal>实例同样的关键字值。 + </para> + + <para> + 另一种方式是一个外键和一个惟一关键字对应，上面的<literal>Employee</literal>和<literal>Person</literal>的例子，如果使用这种关联方式，可以表达成： + </para> + + <programlisting><![CDATA[<many-to-one name="person" class="Person" column="PERSON_ID" unique="true"/>]]></programlisting> + + <para> + 如果在<literal>Person</literal>的映射加入下面几句，这种关联就是双向的： + </para> + + <programlisting><![CDATA[<one-to-one name="employee" class="Employee" property-ref="person"/>]]></programlisting> + + </sect2> + + <sect2 id="mapping-declaration-naturalid"> + <title>自然ID(natural-id)</title> + + <programlisting><![CDATA[<natural-id mutable="true|false"/> + <property ... /> + <many-to-one ... /> + ...... +</natural-id>]]></programlisting> + + <para> + 我们建议使用代用键（键值不具备实际意义）作为主键，我们仍然应该尝试为所有的实体采用自然的键值作为（附加——译者注）标示。自然键（natural key）是单个或组合属性，他们必须唯一且非空。如果它还是不可变的那就更理想了。在<literal>&lt;natural-id&gt;</literal>元素中列出自然键的属性。Hibernate会帮你生成必须的唯一键值和非空约束，你的映射会更加的明显易懂（原文是self-documenting，自我注解）。 + </para> + + <para> + 我们强烈建议你实现<literal>equals()</literal> 和<literal>hashCode()</literal>方法,来比较实体的自然键属性。 + </para> + + <para> + 这一映射不是为了把自然键作为主键而准备的。 + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>mutable</literal> (可选, 默认为<literal>false</literal>): + 默认情况下，自然标识属性被假定为不可变的（常量）。 + </para> + </listitem> + </itemizedlist> + + </sect2> + + + <sect2 id="mapping-declaration-component" revision="2"> + <title>组件(component), 动态组件(dynamic-component)</title> + + <para> + <literal>&lt;component&gt;</literal>元素把子对象的一些元素与父类对应的表的一些字段映射起来。 然后组件可以定义它们自己的属性、组件或者集合。参见后面的“Components”一章。 + </para> + + <programlistingco> + <areaspec> + <area id="component1" coords="2 45"/> + <area id="component2" coords="3 45"/> + <area id="component3" coords="4 45"/> + <area id="component4" coords="5 45"/> + <area id="component5" coords="6 45"/> + <area id="component6" coords="7 45"/> + <area id="component7" coords="8 45"/> + <area id="component8" coords="9 45"/> + </areaspec> + <programlisting><![CDATA[<component + name="propertyName" + class="className" + insert="true|false" + update="true|false" + access="field|property|ClassName" + lazy="true|false" + optimistic-lock="true|false" + unique="true|false" + node="element-name|." +> + + <property ...../> + <many-to-one .... /> + ........ +</component>]]></programlisting> + <calloutlist> + <callout arearefs="component1"> + <para> + <literal>name</literal>: 属性名 + </para> + + </callout> + <callout arearefs="component2"> + <para> + <literal>class</literal> (可选 - 默认为通过反射得到的属性类型):组件(子)类的名字。 + </para> + </callout> + <callout arearefs="component3"> + <para> + <literal>insert</literal>: 被映射的字段是否出现在SQL的<literal>INSERT</literal>语句中? + </para> + </callout> + <callout arearefs="component4"> + <para> + <literal>update</literal>: 被映射的字段是否出现在SQL的<literal>UPDATE</literal>语句中? + </para> + </callout> + <callout arearefs="component5"> + <para> + <literal>access</literal> (可选 - 默认是 <literal>property</literal>): Hibernate用来访问属性的策略。 + </para> + </callout> + <callout arearefs="component6"> + <para> + <literal>lazy</literal> (可选 - 默认是 <literal>false</literal>): 表明此组件应在实例变量第一次被访问的时候延迟加载(需要编译时字节码装置器) + </para> + </callout> + <callout arearefs="component7"> + <para> + <literal>optimistic-lock</literal> (可选 - 默认是 <literal>true</literal>):表明更新此组件是否需要获取乐观锁。换句话说，当这个属性变脏时，是否增加版本号(Version) + </para> + </callout> + <callout arearefs="component8"> + <para> + <literal>unique</literal> (可选 - 默认是 <literal>false</literal>):表明组件映射的所有字段上都有唯一性约束 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + 其<literal>&lt;property&gt;</literal>子标签为子类的一些属性与表字段之间建立映射。 + </para> + + <para> + <literal>&lt;component&gt;</literal>元素允许加入一个<literal>&lt;parent&gt;</literal>子元素，在组件类内部就可以有一个指向其容器的实体的反向引用。 + </para> + + <para> + <literal>&lt;dynamic-component&gt;</literal>元素允许把一个<literal>Map</literal>映射为组件，其属性名对应map的键值。 + 参见<xref linkend="components-dynamic"/>. + </para> + + </sect2> + + <sect2 id="mapping-declaration-properties" revision="2"> + <title>properties</title> + + <para> + <literal>&lt;properties&gt;</literal> 元素允许定义一个命名的逻辑分组(grouping)包含一个类中的多个属性。 + 这个元素最重要的用处是允许多个属性的组合作为<literal>property-ref</literal>的目标(target)。 + 这也是定义多字段唯一约束的一种方便途径。 + </para> + + <programlistingco> + <areaspec> + <area id="properties1" coords="2 45"/> + <area id="properties2" coords="3 45"/> + <area id="properties3" coords="4 45"/> + <area id="properties4" coords="5 45"/> + <area id="properties5" coords="6 45"/> + </areaspec> + <programlisting><![CDATA[<properties + name="logicalName" + insert="true|false" + update="true|false" + optimistic-lock="true|false" + unique="true|false" +> + + <property ...../> + <many-to-one .... /> + ........ +</properties>]]></programlisting> + <calloutlist> + <callout arearefs="properties1"> + <para> + <literal>name</literal>: 分组的逻辑名称 - + <emphasis>不是</emphasis> 实际属性的名称. + </para> + </callout> + <callout arearefs="properties2"> + <para> + <literal>insert</literal>: 被映射的字段是否出现在SQL的 + <literal>INSERT</literal>语句中? + </para> + </callout> + <callout arearefs="properties3"> + <para> + <literal>update</literal>: 被映射的字段是否出现在SQL的 + <literal>UPDATE</literal>语句中? + </para> + </callout> + <callout arearefs="properties4"> + <para> + <literal>optimistic-lock</literal> (可选 - 默认是 <literal>true</literal>):表明更新此组件是否需要获取乐观锁。换句话说，当这个属性变脏时，是否增加版本号(Version) + </para> + </callout> + <callout arearefs="properties5"> + <para> + <literal>unique</literal> (可选 - 默认是 <literal>false</literal>):表明组件映射的所有字段上都有唯一性约束 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + 例如，如果我们有如下的<literal>&lt;properties&gt;</literal>映射: + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="personNumber"/> + ... + <properties name="name" + unique="true" update="false"> + <property name="firstName"/> + <property name="initial"/> + <property name="lastName"/> + </properties> +</class>]]></programlisting> + + <para> + 然后，我们可能有一些遗留的数据关联，引用 <literal>Person</literal>表的这个唯一键，而不是主键。 + </para> + <programlisting><![CDATA[<many-to-one name="person" + class="Person" property-ref="name"> + <column name="firstName"/> + <column name="initial"/> + <column name="lastName"/> +</many-to-one>]]></programlisting> + + <para> + 我们并不推荐这样使用，除非在映射遗留数据的情况下。 + </para> + + </sect2> + + <sect2 id="mapping-declaration-subclass" revision="4"> + <title>子类(subclass)</title> + + <para> + 最后，多态持久化需要为父类的每个子类都进行定义。对于“每一棵类继承树对应一个表”的策略来说，就需要使用<literal>&lt;subclass&gt;</literal>定义。 + </para> + + <programlistingco> + <areaspec> + <area id="subclass1" coords="2 55"/> + <area id="subclass2" coords="3 55"/> + <area id="subclass3" coords="4 55"/> + <area id="subclass4" coords="5 55"/> + </areaspec> + <programlisting><![CDATA[<subclass + name="ClassName" + discriminator-value="discriminator_value" + proxy="ProxyInterface" + lazy="true|false" + dynamic-update="true|false" + dynamic-insert="true|false" + entity-name="EntityName" + node="element-name" + extends="SuperclassName"> + + <property .... /> + ..... +</subclass>]]></programlisting> + <calloutlist> + <callout arearefs="subclass1"> + <para> + <literal>name</literal>: 子类的全限定名。 + </para> + </callout> + <callout arearefs="subclass2"> + <para> + <literal>discriminator-value(辨别标志)</literal> (可选 - 默认为类名):一个用于区分每个独立的子类的值。 + </para> + </callout> + <callout arearefs="subclass3"> + <para> + <literal>proxy(代理)</literal> (可选): 指定一个类或者接口，在延迟装载时作为代理使用。 + </para> + </callout> + <callout arearefs="subclass4"> + <para> + <literal>lazy</literal> (可选, 默认是<literal>true</literal>): 设置为 + <literal>lazy="false"</literal> 禁止使用延迟抓取 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + 每个子类都应该定义它自己的持久化属性和子类。 + <literal>&lt;version&gt;</literal> 和<literal>&lt;id&gt;</literal> 属性可以从根父类继承下来。在一棵继承树上的每个子类都必须定义一个唯一的<literal>discriminator-value</literal>。如果没有指定，就会使用Java类的全限定名。 + </para> + + + <para> + 更多关于继承映射的信息, 参考 <xref linkend="inheritance"/>章节. + </para> + </sect2> + + <sect2 id="mapping-declaration-joinedsubclass" revision="3"> + <title>连接的子类(joined-subclass)</title> + + <para> + 此外，每个子类可能被映射到他自己的表中(每个子类一个表的策略)。被继承的状态通过和超类的表关联得到。我们使用<literal>&lt;joined-subclass&gt;</literal>元素。 + </para> + <programlistingco> + <areaspec> + <area id="joinedsubclass1" coords="2 45"/> + <area id="joinedsubclass2" coords="3 45"/> + <area id="joinedsubclass3" coords="4 45"/> + <area id="joinedsubclass4" coords="5 45"/> + </areaspec> + <programlisting><![CDATA[<joined-subclass + name="ClassName" + table="tablename" + proxy="ProxyInterface" + lazy="true|false" + dynamic-update="true|false" + dynamic-insert="true|false" + schema="schema" + catalog="catalog" + extends="SuperclassName" + persister="ClassName" + subselect="SQL expression" + entity-name="EntityName" + node="element-name"> + + <key .... > + + <property .... /> + ..... +</joined-subclass>]]></programlisting> + <calloutlist> + <callout arearefs="joinedsubclass1"> + <para> + <literal>name</literal>: 子类的全限定名。 + </para> + </callout> + <callout arearefs="joinedsubclass2"> + <para> + <literal>table</literal>: 子类的表名. + </para> + </callout> + <callout arearefs="joinedsubclass3"> + <para> + <literal>proxy</literal> (可选): 指定一个类或者接口，在延迟装载时作为代理使用。 + </para> + </callout> + <callout arearefs="joinedsubclass4"> + <para> + <literal>lazy</literal> (可选, 默认是 <literal>true</literal>): 设置为 + <literal>lazy="false"</literal> 禁止使用延迟装载。 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + 这种映射策略不需要指定辨别标志(discriminator)字段。但是，每一个子类都必须使用<literal>&lt;key&gt;</literal>元素指定一个表字段来持有对象的标识符。本章开始的映射可以被用如下方式重写： + </para> + + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="eg"> + + <class name="Cat" table="CATS"> + <id name="id" column="uid" type="long"> + <generator class="hilo"/> + </id> + <property name="birthdate" type="date"/> + <property name="color" not-null="true"/> + <property name="sex" not-null="true"/> + <property name="weight"/> + <many-to-one name="mate"/> + <set name="kittens"> + <key column="MOTHER"/> + <one-to-many class="Cat"/> + </set> + <joined-subclass name="DomesticCat" table="DOMESTIC_CATS"> + <key column="CAT"/> + <property name="name" type="string"/> + </joined-subclass> + </class> + + <class name="eg.Dog"> + <!-- mapping for Dog could go here --> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + 更多关于继承映射的信息，参考<xref linkend="inheritance"/>。 + </para> + </sect2> + + <sect2 id="mapping-declaration-unionsubclass" revision="2"> + <title>联合子类(union-subclass)</title> + + <para> + 第三种选择是仅仅映射类继承树中具体类部分到表中(每个具体类一张表的策略)。其中，每张表定义了类的所有持久化状态，包括继承的状态。在 Hibernate 中，并不需要完全显式地映射这样的继承树。你可以简单地使用单独的<literal>&lt;class&gt;</literal>定义映射每个类。然而，如果你想使用多态关联(例如，一个对类继承树中超类的关联)，你需要使用<literal>&lt;union-subclass&gt;</literal>映射。 + </para> + <programlistingco> + <areaspec> + <area id="unionsubclass1" coords="2 45"/> + <area id="unionsubclass2" coords="3 45"/> + <area id="unionsubclass3" coords="4 45"/> + <area id="unionsubclass4" coords="5 45"/> + </areaspec> + <programlisting><![CDATA[<union-subclass + name="ClassName" + table="tablename" + proxy="ProxyInterface" + lazy="true|false" + dynamic-update="true|false" + dynamic-insert="true|false" + schema="schema" + catalog="catalog" + extends="SuperclassName" + abstract="true|false" + persister="ClassName" + subselect="SQL expression" + entity-name="EntityName" + node="element-name"> + + <property .... /> + ..... +</union-subclass>]]></programlisting> + <calloutlist> + <callout arearefs="unionsubclass1"> + <para> + <literal>name</literal>: 子类的全限定名。 + </para> + </callout> + <callout arearefs="unionsubclass2"> + <para> + <literal>table</literal>: 子类的表名 + </para> + </callout> + <callout arearefs="unionsubclass3"> + <para> + <literal>proxy</literal> (可选): 指定一个类或者接口，在延迟装载时作为代理使用。 + </para> + </callout> + <callout arearefs="unionsubclass4"> + <para> + <literal>lazy</literal> (可选, 默认是 <literal>true</literal>): 设置为 + <literal>lazy="false"</literal> 禁止使用延迟装载。 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + 这种映射策略不需要指定辨别标志(discriminator)字段。 + </para> + <para> + 更多关于继承映射的信息，参考<xref linkend="inheritance"/>。 + </para> + </sect2> + + <sect2 id="mapping-declaration-join" revision="3"> + <title>连接(join)</title> + + <para> + 使用 <literal>&lt;join&gt;</literal> 元素，假若在表之间存在一对一关联,可以将一个类的属性映射到多张表中。 + </para> + + <programlistingco> + <areaspec> + <area id="join1" coords="2 50"/> + <area id="join2" coords="3 50"/> + <area id="join3" coords="4 50"/> + <area id="join4" coords="5 50"/> + <area id="join5" coords="6 50"/> + <area id="join6" coords="7 50"/> + </areaspec> + <programlisting><![CDATA[<join + table="tablename" + schema="owner" + catalog="catalog" + fetch="join|select" + inverse="true|false" + optional="true|false"> + + <key ... /> + + <property ... /> + ... +</join>]]></programlisting> + + <calloutlist> + <callout arearefs="join1"> + <para> + <literal>table</literal>: 被连接表的名称。 + </para> + </callout> + <callout arearefs="join2"> + <para> + <literal>schema</literal> (可选):覆盖由根<literal>&lt;hibernate-mapping&gt;</literal>元素指定的模式名称。 + </para> + </callout> + <callout arearefs="join3"> + <para> + <literal>catalog</literal> (可选): 覆盖由根 <literal>&lt;hibernate-mapping&gt;</literal>元素指定的目录名称。 + </para> + </callout> + <callout arearefs="join4"> + <para> + <literal>fetch</literal> (可选 - 默认是 <literal>join</literal>): + 如果设置为默认值<literal>join</literal>， Hibernate 将使用一个内连接来得到这个类或其超类定义的<literal>&lt;join&gt;</literal>，而使用一个外连接来得到其子类定义的<literal>&lt;join&gt;</literal>。如果设置为<literal>select</literal>，则 Hibernate 将为子类定义的 <literal>&lt;join&gt;</literal>使用顺序选择。这仅在一行数据表示一个子类的对象的时候才会发生。对这个类和其超类定义的<literal>&lt;join&gt;</literal>，依然会使用内连接得到。 + </para> + </callout> + <callout arearefs="join5"> + <para> + <literal>inverse</literal> (可选 - 默认是 <literal>false</literal>): + 如果打开，Hibernate 不会插入或者更新此连接定义的属性。 + </para> + </callout> + <callout arearefs="join6"> + <para> + <literal>optional</literal> (可选 - 默认是 <literal>false</literal>): + 如果打开，Hibernate 只会在此连接定义的属性非空时插入一行数据，并且总是使用一个外连接来得到这些属性。 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + 例如，一个人(person)的地址(address)信息可以被映射到单独的表中(并保留所有属性的值类型语义)： + </para> + + <programlisting><![CDATA[<class name="Person" + table="PERSON"> + + <id name="id" column="PERSON_ID">...</id> + + <join table="ADDRESS"> + <key column="ADDRESS_ID"/> + <property name="address"/> + <property name="zip"/> + <property name="country"/> + </join> + ...]]></programlisting> + + <para> + 此特性常常对遗留数据模型有用，我们推荐表个数比类个数少，以及细粒度的领域模型。然而，在单独的继承树上切换继承映射策略是有用的，后面会解释这点。 + </para> + </sect2> + + <sect2 id="mapping-declaration-key"> + <title>键(key)</title> + + <para> + 我们目前已经见到过<literal>&lt;key&gt;</literal>元素多次了。 这个元素在父映射元素定义了对新表的连接，并且在被连接表中定义了一个外键引用原表的主键的情况下经常使用。 + </para> + + <programlistingco> + <areaspec> + <area id="key1" coords="2 50"/> + <area id="key2" coords="3 50"/> + <area id="key3" coords="4 50"/> + <area id="key4" coords="5 50"/> + <area id="key5" coords="6 50"/> + <area id="key6" coords="7 50"/> + </areaspec> + <programlisting><![CDATA[<key + column="columnname" + on-delete="noaction|cascade" + property-ref="propertyName" + not-null="true|false" + update="true|false" + unique="true|false" +/>]]></programlisting> + + <calloutlist> + <callout arearefs="key1"> + <para> + <literal>column</literal> (可选): 外键字段的名称。也可以通过嵌套的 <literal>&lt;column&gt;</literal>指定。 + </para> + </callout> + <callout arearefs="key2"> + <para> + <literal>on-delete</literal> (可选, 默认是 <literal>noaction</literal>): + 表明外键关联是否打开数据库级别的级联删除。 + </para> + </callout> + <callout arearefs="key3"> + <para> + <literal>property-ref</literal> (可选): 表明外键引用的字段不是原表的主键(提供给遗留数据)。 + </para> + </callout> + <callout arearefs="key4"> + <para> + <literal>not-null</literal> (可选): 表明外键的字段不可为空(这意味着无论何时外键都是主键的一部分)。 + </para> + </callout> + <callout arearefs="key5"> + <para> + <literal>update</literal> (可选): 表明外键决不应该被更新(这意味着无论何时外键都是主键的一部分)。 + </para> + </callout> + <callout arearefs="key6"> + <para> + <literal>unique</literal> (可选): 表明外键应有唯一性约束 (这意味着无论何时外键都是主键的一部分)。 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + 对那些看重删除性能的系统，我们推荐所有的键都应该定义为<literal>on-delete="cascade"</literal>，这样 Hibernate 将使用数据库级的<literal>ON CASCADE DELETE</literal>约束，而不是多个<literal>DELETE</literal>语句。 注意，这个特性会绕过 Hibernate 通常对版本数据(versioned data)采用的乐观锁策略。 + </para> + <para> + <literal>not-null</literal> 和 <literal>update</literal> 属性在映射单向一对多关联的时候有用。如果你映射一个单向一对多关联到非空的(non-nullable)外键，你<emphasis>必须</emphasis> 用<literal>&lt;key not-null="true"&gt;</literal>定义此键字段。 + </para> + </sect2> + + <sect2 id="mapping-column" revision="4"> + <title>字段和规则元素（column and formula elements）</title> + <para> + 任何接受<literal>column</literal>属性的映射元素都可以选择接受<literal>&lt;column&gt;</literal> 子元素。同样的，<literal>formula</literal>子元素也可以替换<literal>&lt;formula&gt;</literal>属性。 + </para> + <programlisting><![CDATA[<column + name="column_name" + length="N" + precision="N" + scale="N" + not-null="true|false" + unique="true|false" + unique-key="multicolumn_unique_key_name" + index="index_name" + sql-type="sql_type_name" + check="SQL expression" + default="SQL expression"/>]]></programlisting> + + <programlisting><![CDATA[<formula>SQL expression</formula>]]></programlisting> + <para> + <literal>column</literal> 和 <literal>formula</literal> 属性甚至可以在同一个属性或关联映射中被合并来表达，例如，一些奇异的连接条件。 + </para> + <programlisting><![CDATA[<many-to-one name="homeAddress" class="Address" + insert="false" update="false"> + <column name="person_id" not-null="true" length="10"/> + <formula>'MAILING'</formula> +</many-to-one>]]></programlisting> + + </sect2> + + <sect2 id="mapping-declaration-import"> + <title>引用(import)</title> + + <para> + 假设你的应用程序有两个同样名字的持久化类，但是你不想在Hibernate查询中使用他们的全限定名。除了依赖<literal>auto-import="true"</literal>以外，类也可以被显式地“import(引用)”。你甚至可以引用没有被明确映射的类和接口。 + </para> + + <programlisting><![CDATA[<import class="java.lang.Object" rename="Universe"/>]]></programlisting> + + <programlistingco> + <areaspec> + <area id="import1" coords="2 40"/> + <area id="import2" coords="3 40"/> + </areaspec> + <programlisting><![CDATA[<import + class="ClassName" + rename="ShortName" +/>]]></programlisting> + <calloutlist> + <callout arearefs="import1"> + <para> + <literal>class</literal>: 任何Java类的全限定名。 + </para> + </callout> + <callout arearefs="import2"> + <para> + <literal>rename</literal> (可选 - 默认为类的全限定名): + 在查询语句中可以使用的名字。 + </para> + </callout> + </calloutlist> + </programlistingco> + + </sect2> + + <sect2 id="mapping-types-anymapping" revision="2"> + <title>any</title> + <para> + 这是属性映射的又一种类型。<literal>&lt;any&gt;</literal> 映射元素定义了一种从多个表到类的多态关联。这种类型的映射常常需要多于一个字段。第一个字段持有被关联实体的类型，其他的字段持有标识符。对这种类型的关联来说，不可能指定一个外键约束，所以这当然不是映射(多态)关联的通常的方式。你只应该在非常特殊的情况下使用它(比如，审计log，用户会话数据等等)。 + </para> + <para> + <literal>meta-type</literal> 属性使得应用程序能指定一个将数据库字段的值映射到持久化类的自定义类型。这个持久化类包含有用<literal>id-type</literal>指定的标识符属性。 + 你必须指定从meta-type的值到类名的映射。 + </para> + + <programlisting><![CDATA[<any name="being" id-type="long" meta-type="string"> + <meta-value value="TBL_ANIMAL" class="Animal"/> + <meta-value value="TBL_HUMAN" class="Human"/> + <meta-value value="TBL_ALIEN" class="Alien"/> + <column name="table_name"/> + <column name="id"/> +</any>]]></programlisting> + + <programlistingco> + <areaspec> + <area id="any1" coords="2 50"/> + <area id="any2" coords="3 50"/> + <area id="any3" coords="4 50"/> + <area id="any4" coords="5 50"/> + <area id="any5" coords="6 50"/> + <area id="any6" coords="7 50"/> + </areaspec> + <programlisting><![CDATA[<any + name="propertyName" + id-type="idtypename" + meta-type="metatypename" + cascade="cascade_style" + access="field|property|ClassName" + optimistic-lock="true|false" +> + <meta-value ... /> + <meta-value ... /> + ..... + <column .... /> + <column .... /> + ..... +</any>]]></programlisting> + <calloutlist> + <callout arearefs="any1"> + <para> + <literal>name</literal>: 属性名 + </para> + </callout> + <callout arearefs="any2"> + <para> + <literal>id-type</literal>: 标识符类型 + </para> + </callout> + <callout arearefs="any3"> + <para> + <literal>meta-type</literal> (可选 -默认是 <literal>string</literal>): + 允许辨别标志(discriminator)映射的任何类型 + </para> + </callout> + <callout arearefs="any4"> + <para> + <literal>cascade</literal> (可选 -默认是<literal>none</literal>): + 级联的类型 + </para> + </callout> + <callout arearefs="any5"> + <para> + <literal>access</literal> (可选 -默认是 <literal>property</literal>): Hibernate 用来访问属性值的策略。 + </para> + </callout> + <callout arearefs="any6"> + <para> + <literal>optimistic-lock</literal> (可选 -默认是 <literal>true</literal>): 表明更新此组件是否需要获取乐观锁。换句话说，当这个属性变脏时，是否增加版本号(Version) + </para> + </callout> + </calloutlist> + </programlistingco> + + </sect2> + + </sect1> + + <sect1 id="mapping-types"> + <title>Hibernate 的类型</title> + <sect2 id="mapping-types-entitiesvalues" revision="1"> + <title>实体(Entities)和值(values)</title> + + <para> + 为了理解很多与持久化服务相关的Java语言级对象的行为，我们需要把它们分为两类： + </para> + + <para> + <emphasis>实体entity</emphasis> 独立于任何持有实体引用的对象。与通常的Java模型相比，不再被引用的对象会被当作垃圾收集掉。实体必须被显式的保存和删除(除非保存和删除是从父实体向子实体引发的<emphasis>级联</emphasis>)。这和ODMG模型中关于对象通过可触及保持持久性有一些不同——比较起来更加接近应用程序对象通常在一个大系统中的使用方法。实体支持循环引用和交叉引用，它们也可以加上版本信息。 + </para> + + <para> + 一个实体的持久状态包含指向其他实体和<emphasis>值</emphasis>类型实例的引用。值可以是原始类型，集合(不是集合中的对象)，组件或者特定的不可变对象。与实体不同，值(特别是集合和组件)是通过可触及性来进行持久化和删除的。因为值对象(和原始类型数据)是随着包含他们的实体而被持久化和删除的，他们不能被独立的加上版本信息。值没有独立的标识，所以他们不能被两个实体或者集合共享。 + </para> + + <para> + 直到现在，我们都一直使用术语“持久类”(persistent class)来代表实体。我们仍然会这么做。 然而严格说来，不是所有的用户自定义的，带有持久化状态的类都是实体。<emphasis>组件</emphasis>就是用户自定义类，却是值语义的。<literal>java.lang.String</literal>类型的java属性也是值语义的。给了这个定义以后，我们可以说所有JDK提供的类型(类)都是值类型的语义，而用于自定义类型可能被映射为实体类型或值类型语义。采用哪种类型的语义取决于开发人员。在领域模型中，寻找实体类的一个好线索是共享引用指向这个类的单一实例，而组合或聚合通常被转化为值类型。 + </para> + + <para> + 我们会在本文档中重复碰到这两个概念。 + </para> + + <para> + 挑战在于将java类型系统(和开发者定义的实体和值类型)映射到 SQL/数据库类型系统。Hibernate提供了连接两个系统之间的桥梁：对于实体类型，我们使用<literal>&lt;class&gt;</literal>, <literal>&lt;subclass&gt;</literal> 等等。对于值类型，我们使用 <literal>&lt;property&gt;</literal>, <literal>&lt;component&gt;</literal> 及其他，通常跟随着<literal>type</literal>属性。这个属性的值是Hibernate 的<emphasis>映射类型</emphasis>的名字。Hibernate提供了许多现成的映射(标准的JDK值类型)。你也可以编写自己的映射类型并实现自定义的变换策略，随后我们会看到这点。 + </para> + <para> + 所有的Hibernate内建类型，除了collections以外，都支持空(null)语义。 + </para> + </sect2> + + <sect2 id="mapping-types-basictypes" revision="3"> + <title>基本值类型</title> + + <para> + 内建的 <emphasis>基本映射类型</emphasis>可以大致分为 + <variablelist> + <varlistentry> + <term><literal>integer, long, short, float, double, character, byte, + boolean, yes_no, true_false</literal></term> + <listitem> + <para> + 这些类型都对应Java的原始类型或者其封装类，来符合(特定厂商的)SQL 字段类型。<literal>boolean, yes_no</literal> 和 <literal>true_false</literal>都是Java 中<literal>boolean</literal> 或者<literal>java.lang.Boolean</literal>的另外说法。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>string</literal></term> + <listitem> + <para> + 从<literal>java.lang.String</literal> 到 + <literal>VARCHAR</literal> (或者 Oracle的 <literal>VARCHAR2</literal>)的映射。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>date, time, timestamp</literal></term> + <listitem> + <para> + 从<literal>java.util.Date</literal>和其子类到SQL类型<literal>DATE</literal>, <literal>TIME</literal> 和<literal>TIMESTAMP</literal> (或等价类型)的映射。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>calendar, calendar_date</literal></term> + <listitem> + <para> + 从<literal>java.util.Calendar</literal> 到SQL 类型<literal>TIMESTAMP</literal>和 <literal>DATE</literal>(或等价类型)的映射。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>big_decimal, big_integer</literal></term> + <listitem> + <para> + 从<literal>java.math.BigDecimal</literal>和<literal>java.math.BigInteger</literal>到<literal>NUMERIC</literal> (或者 Oracle 的<literal>NUMBER</literal>类型)的映射。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>locale, timezone, currency</literal></term> + <listitem> + <para> + 从<literal>java.util.Locale</literal>, <literal>java.util.TimeZone</literal> 和<literal>java.util.Currency</literal> 到<literal>VARCHAR</literal> (或者 Oracle 的<literal>VARCHAR2</literal>类型)的映射. + <literal>Locale</literal>和 <literal>Currency</literal> 的实例被映射为它们的ISO代码。<literal>TimeZone</literal>的实例被影射为它的<literal>ID</literal>。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>class</literal></term> + <listitem> + <para> + 从<literal>java.lang.Class</literal> 到 + <literal>VARCHAR</literal> (或者 Oracle 的<literal>VARCHAR2</literal>类型)的映射。<literal>Class</literal>被映射为它的全限定名。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>binary</literal></term> + <listitem> + <para> + 把字节数组(byte arrays)映射为对应的 SQL二进制类型。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>text</literal></term> + <listitem> + <para> + 把长Java字符串映射为SQL的<literal>CLOB</literal>或者<literal>TEXT</literal>类型。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>serializable</literal></term> + <listitem> + <para> + 把可序列化的Java类型映射到对应的SQL二进制类型。你也可以为一个并非默认为基本类型的可序列化Java类或者接口指定Hibernate类型<literal>serializable</literal>。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>clob, blob</literal></term> + <listitem> + <para> + JDBC 类 <literal>java.sql.Clob</literal> 和 <literal>java.sql.Blob</literal>的映射。某些程序可能不适合使用这个类型，因为blob和clob对象可能在一个事务之外是无法重用的。(而且, 驱动程序对这种类型的支持充满着补丁和前后矛盾。) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>imm_date, imm_time, imm_timestamp, imm_calendar, imm_calendar_date, + imm_serializable, imm_binary</literal> + </term> + <listitem> + <para> + 一般来说，映射类型被假定为是可变的Java类型，只有对不可变Java类型，Hibernate会采取特定的优化措施，应用程序会把这些对象作为不可变对象处理。比如，你不应该对作为<literal>imm_timestamp</literal>映射的Date执行<literal>Date.setTime()</literal>。要改变属性的值，并且保存这一改变，应用程序必须对这一属性重新设置一个新的（不一样的）对象。 + </para> + </listitem> + </varlistentry> + + </variablelist> + + </para> + + <para> + 实体及其集合的唯一标识可以是除了<literal>binary</literal>、 <literal>blob</literal> 和 <literal>clob</literal>之外的任何基础类型。(联合标识也是允许的，后面会说到。) + </para> + + <para> + 在<literal>org.hibernate.Hibernate</literal>中，定义了基础类型对应的<literal>Type</literal>常量。比如，<literal>Hibernate.STRING</literal>代表<literal>string</literal> 类型。 + </para> + + </sect2> + + <sect2 id="mapping-types-custom" revision="2"> + <title>自定义值类型</title> + + <para> + 开发者创建属于他们自己的值类型也是很容易的。比如说，你可能希望持久化<literal>java.lang.BigInteger</literal>类型的属性，持久化成为<literal>VARCHAR</literal>字段。Hibernate没有内置这样一种类型。自定义类型能够映射一个属性(或集合元素)到不止一个数据库表字段。比如说，你可能有这样的Java属性：<literal>getName()</literal>/<literal>setName()</literal>，这是<literal>java.lang.String</literal>类型的，对应的持久化到三个字段：<literal>FIRST_NAME</literal>, <literal>INITIAL</literal>, <literal>SURNAME</literal>。 + </para> + + <para> + 要实现一个自定义类型，可以实现<literal>org.hibernate.UserType</literal>或<literal>org.hibernate.CompositeUserType</literal>中的任一个，并且使用类型的Java全限定类名来定义属性。请查看<literal>org.hibernate.test.DoubleStringType</literal>这个例子，看看它是怎么做的。 + </para> + + <programlisting><![CDATA[<property name="twoStrings" type="org.hibernate.test.DoubleStringType"> + <column name="first_string"/> + <column name="second_string"/> +</property>]]></programlisting> + + <para> + 注意使用<literal>&lt;column&gt;</literal>标签来把一个属性映射到多个字段的做法。 + </para> + + <para> + <literal>CompositeUserType</literal>, <literal>EnhancedUserType</literal>, + <literal>UserCollectionType</literal>, 和 <literal>UserVersionType</literal> 接口为更特殊的使用方式提供支持。 + </para> + <para> + 你甚至可以在一个映射文件中提供参数给一个<literal>UserType</literal>。 为了这样做，你的<literal>UserType</literal>必须实现<literal>org.hibernate.usertype.ParameterizedType</literal>接口。为了给自定义类型提供参数，你可以在映射文件中使用<literal>&lt;type&gt;</literal>元素。 + </para> + <programlisting><![CDATA[<property name="priority"> + <type name="com.mycompany.usertypes.DefaultValueIntegerType"> + <param name="default">0</param> + </type> +</property>]]></programlisting> + + <para> + 现在，<literal>UserType</literal> 可以从传入的<literal>Properties</literal>对象中得到<literal>default</literal> 参数的值。 + </para> + <para> + 如果你非常频繁地使用某一<literal>UserType</literal>，可以为他定义一个简称。这可以通过使用 <literal>&lt;typedef&gt;</literal>元素来实现。Typedefs为一自定义类型赋予一个名称，并且如果此类型是参数化的，还可以包含一系列默认的参数值。 + </para> + <programlisting><![CDATA[<typedef class="com.mycompany.usertypes.DefaultValueIntegerType" name="default_zero"> + <param name="default">0</param> +</typedef>]]></programlisting> + + <programlisting><![CDATA[<property name="priority" type="default_zero"/>]]></programlisting> + + <para> + 也可以根据具体案例通过属性映射中的类型参数覆盖在typedef中提供的参数。 + </para> + <para> + 尽管 Hibernate 内建的丰富的类型和对组件的支持意味着你可能很少 <emphasis>需要</emphasis>使用自定义类型。不过，为那些在你的应用中经常出现的(非实体)类使用自定义类型也是一个好方法。例如，一个<literal>MonetaryAmount</literal>类使用<literal>CompositeUserType</literal>来映射是不错的选择，虽然他可以很容易地被映射成组件。这样做的动机之一是抽象。使用自定义类型，以后假若你改变表示金额的方法时，它可以保证映射文件不需要修改。 + </para> + </sect2> + + </sect1> + + <sect1 id="mapping-entityname"> + <title>多次映射同一个类</title> + <para> + 对特定的持久化类，映射多次是允许的。这种情形下，你必须指定<emphasis>entity name</emphasis>来区别不同映射实体的对象实例。（默认情况下，实体名字和类名是相同的。） + Hibernate在操作持久化对象、编写查询条件，或者把关联映射到指定实体时，允许你指定这个entity name（实体名字）。 + </para> + + <programlisting><![CDATA[<class name="Contract" table="Contracts" + entity-name="CurrentContract"> + ... + <set name="history" inverse="true" + order-by="effectiveEndDate desc"> + <key column="currentContractId"/> + <one-to-many entity-name="HistoricalContract"/> + </set> +</class> + +<class name="Contract" table="ContractHistory" + entity-name="HistoricalContract"> + ... + <many-to-one name="currentContract" + column="currentContractId" + entity-name="CurrentContract"/> +</class>]]></programlisting> + + <para> + 注意这里关联是如何用<literal>entity-name</literal>来代替<literal>class</literal>的。 + </para> + + </sect1> + + <sect1 id="mapping-quotedidentifiers"> + <title>SQL中引号包围的标识符</title> + <para> + 你可通过在映射文档中使用反向引号(`)把表名或者字段名包围起来，以强制Hibernate在生成的SQL中把标识符用引号包围起来。Hibernate会使用相应的SQL<literal>Dialect</literal>(方言)来使用正确的引号风格(通常是双引号，但是在SQL Server中是括号，MySQL中是反向引号)。 + </para> + + <programlisting><![CDATA[<class name="LineItem" table="`Line Item`"> + <id name="id" column="`Item Id`"/><generator class="assigned"/></id> + <property name="itemNumber" column="`Item #`"/> + ... +</class>]]></programlisting> + + </sect1> + + + <sect1 id="mapping-alternatives"> + <title>其他元数据(Metadata)</title> + + <para> + XML 并不适用于所有人, 因此有其他定义Hibernate O/R 映射元数据(metadata)的方法。 + </para> + + <sect2 id="mapping-xdoclet"> + <title>使用 XDoclet 标记</title> + + <para> + 很多Hibernate使用者更喜欢使用XDoclet<literal>@hibernate.tags</literal>将映射信息直接嵌入到源代码中。我们不会在本文档中涉及这个方法，因为严格说来，这属于XDoclet的一部分。然而，我们包含了如下使用XDoclet映射的<literal>Cat</literal>类的例子。 + </para> + <programlisting><![CDATA[package eg; +import java.util.Set; +import java.util.Date; + +/** + * @hibernate.class + * table="CATS" + */ +public class Cat { + private Long id; // identifier + private Date birthdate; + private Cat mother; + private Set kittens + private Color color; + private char sex; + private float weight; + + /* + * @hibernate.id + * generator-class="native" + * column="CAT_ID" + */ + public Long getId() { + return id; + } + private void setId(Long id) { + this.id=id; + } + + /** + * @hibernate.many-to-one + * column="PARENT_ID" + */ + public Cat getMother() { + return mother; + } + void setMother(Cat mother) { + this.mother = mother; + } + + /** + * @hibernate.property + * column="BIRTH_DATE" + */ + public Date getBirthdate() { + return birthdate; + } + void setBirthdate(Date date) { + birthdate = date; + } + /** + * @hibernate.property + * column="WEIGHT" + */ + public float getWeight() { + return weight; + } + void setWeight(float weight) { + this.weight = weight; + } + + /** + * @hibernate.property + * column="COLOR" + * not-null="true" + */ + public Color getColor() { + return color; + } + void setColor(Color color) { + this.color = color; + } + /** + * @hibernate.set + * inverse="true" + * order-by="BIRTH_DATE" + * @hibernate.collection-key + * column="PARENT_ID" + * @hibernate.collection-one-to-many + */ + public Set getKittens() { + return kittens; + } + void setKittens(Set kittens) { + this.kittens = kittens; + } + // addKitten not needed by Hibernate + public void addKitten(Cat kitten) { + kittens.add(kitten); + } + + /** + * @hibernate.property + * column="SEX" + * not-null="true" + * update="false" + */ + public char getSex() { + return sex; + } + void setSex(char sex) { + this.sex=sex; + } +}]]></programlisting> + + <para> + 参考Hibernate网站更多的Xdoclet和Hibernate的例子 + </para> + </sect2> + + <sect2 id="mapping-annotations" revision="2"> + <title>使用 JDK 5.0 的注解(Annotation)</title> + + <para> + JDK 5.0 在语言级别引入了 XDoclet 风格的标注，并且是类型安全的，在编译期进行检查。这一机制比XDoclet的注解更为强大，有更好的工具和IDE支持。例如， IntelliJ IDEA，支持JDK 5.0注解的自动完成和语法高亮 。EJB规范的新修订版(JSR-220)使用 JDK 5.0的注解作为entity beans的主要元数据(metadata)机制。Hibernate 3 实现了JSR-220 (the persistence API)的<literal>EntityManager</literal>，支持通过<emphasis>Hibernate Annotations</emphasis>包定义映射元数据。这个包作为单独的部分下载，支持EJB3 (JSR-220)和Hibernate3的元数据。 + </para> + <para> + 这是一个被注解为EJB entity bean 的POJO类的例子 + </para> + <programlisting><![CDATA[@Entity(access = AccessType.FIELD) +public class Customer implements Serializable { + + @Id; + Long id; + + String firstName; + String lastName; + Date birthday; + + @Transient + Integer age; + + @Embedded + private Address homeAddress; + + @OneToMany(cascade=CascadeType.ALL) + @JoinColumn(name="CUSTOMER_ID") + Set<Order> orders; + + // Getter/setter and business methods +}]]></programlisting> + + <para> + 注意：对 JDK 5.0 注解 (和 JSR-220)支持的工作仍然在进行中,并未完成。更多细节请参阅Hibernate Annotations 模块。 + </para> + </sect2> + </sect1> + <sect1 id="mapping-generated" revision="1"> + <title>数据库生成属性（Generated Properties）</title> + <para> + Generated properties指的是其值由数据库生成的属性。一般来说，如果对象有任何属性由数据库生成值，Hibernate应用程序需要进行<literal>刷新(refresh)</literal>。但如果把属性标明为generated，就可以转由Hibernate来负责这个动作。实际上。对定义了generated properties的实体,每当Hibernate执行一条SQL INSERT或者UPDATE语句，会立刻执行一条select来获得生成的值。 + </para> + <para> + 被标明为generated的属性还必须是 non-insertable和 non-updateable的。只有<xref linkend="mapping-declaration-version">versions</xref>，<xref linkend="mapping-declaration-timestamp">timestamps</xref>和<xref linkend="mapping-declaration-property">简单属性（simple properties）</xref>可以被标明为generated。 + </para> + <para> + <literal>never</literal> (默认) 标明此属性值不是从数据库中生成。 + </para> + <para> + <literal>insert</literal> - 标明此属性值在insert的时候生成，但是不会在随后的update时重新生成。比如说创建日期就归属于这类。注意虽然<xref linkend="mapping-declaration-version">version</xref>和<xref linkend="mapping-declaration-timestamp">timestamp</xref>属性可以被标注为generated，但是不适用这个选项... + </para> + <para> + <literal>always</literal> - 标明此属性值在insert和update时都会被生成。 + </para> + </sect1> + + <sect1 id="mapping-database-object"> + <title>辅助数据库对象(Auxiliary Database Objects)</title> + <para> + Allows CREATE and DROP of arbitrary database objects, in conjunction with + Hibernate's schema evolution tools, to provide the ability to fully define + a user schema within the Hibernate mapping files. Although designed specifically + for creating and dropping things like triggers or stored procedures, really any + SQL command that can be run via a <literal>java.sql.Statement.execute()</literal> + method is valid here (ALTERs, INSERTS, etc). There are essentially two modes for + defining auxiliary database objects... + 帮助CREATE和DROP任意数据库对象，与Hibernate的schema交互工具组合起来，可以提供在Hibernate映射文件中完全定义用户schema的能力。虽然这是为创建和销毁trigger(触发器）或stored procedure(存储过程）等特别设计的，实际上任何可以在<literal>java.sql.Statement.execute()</literal>方法中执行的SQL命令都可以在此使用（比如ALTER, INSERT，等等）。本质上有两种模式来定义辅助数据库对象... + </para> + <para> + 第一种模式是在映射文件中显式声明CREATE和DROP命令： + </para> + <programlisting><![CDATA[<hibernate-mapping> + ... + <database-object> + <create>CREATE TRIGGER my_trigger ...</create> + <drop>DROP TRIGGER my_trigger</drop> + </database-object> +</hibernate-mapping>]]></programlisting> + <para> + 第二种模式是提供一个类，这个类知道如何组织CREATE和DROP命令。这个特别类必须实现<literal>org.hibernate.mapping.AuxiliaryDatabaseObject</literal>接口。 + </para> + <programlisting><![CDATA[<hibernate-mapping> + ... + <database-object> + <definition class="MyTriggerDefinition"/> + </database-object> +</hibernate-mapping>]]></programlisting> + <para> + 还有，这些数据库对象可以特别指定为仅在特定的方言中才使用。 + </para> + <programlisting><![CDATA[<hibernate-mapping> + ... + <database-object> + <definition class="MyTriggerDefinition"/> + <dialect-scope name="org.hibernate.dialect.Oracle9Dialect"/> + <dialect-scope name="org.hibernate.dialect.OracleDialect"/> + </database-object> +</hibernate-mapping>]]></programlisting> + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/batch.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/batch.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/batch.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/batch.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,282 @@ +<chapter id="batch"> + <title>批量处理（Batch processing）</title> + <para> + 使用Hibernate将 100 000 条记录插入到数据库的一个很自然的做法可能是这样的 + </para> + +<programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); +for ( int i=0; i<100000; i++ ) { + Customer customer = new Customer(.....); + session.save(customer); +} +tx.commit(); +session.close();]]></programlisting> + + <para> + 这段程序大概运行到 50 000 条记录左右会失败并抛出 <literal>内存溢出异常（OutOfMemoryException）</literal> 。 + 这是因为 Hibernate 把所有新插入的 <literal>客户（Customer）</literal>实例在 session级别的缓存区进行了缓存的缘故。 + </para> + + <para> + 我们会在本章告诉你如何避免此类问题。首先，如果你要执行批量处理并且想要达到一个理想的性能， + 那么使用JDBC的批量（batching）功能是至关重要。将JDBC的批量抓取数量（batch size）参数设置到一个合适值 + （比如，10-50之间）： + </para> + +<programlisting><![CDATA[hibernate.jdbc.batch_size 20]]></programlisting> + + <para id="disablebatching" revision="1"> + 注意,假若你使用了<literal>identiy</literal>标识符生成器,Hibernate在JDBC级别透明的关闭插入语句的批量执行。 + </para> + + <para> + 你也可能想在执行批量处理时关闭二级缓存： + </para> + +<programlisting><![CDATA[hibernate.cache.use_second_level_cache false]]></programlisting> + <para> + 但是，这不是绝对必须的，因为我们可以显式设置<literal>CacheMode</literal>来关闭与二级缓存的交互。 + </para> + + + <sect1 id="batch-inserts"> + <title>批量插入（Batch inserts）</title> + + <para> + 如果要将很多对象持久化，你必须通过经常的调用 <literal>flush()</literal> 以及稍后调用 + <literal>clear()</literal> 来控制第一级缓存的大小。 + </para> + +<programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); + +for ( int i=0; i<100000; i++ ) { + Customer customer = new Customer(.....); + session.save(customer); + if ( i % 20 == 0 ) { //20, same as the JDBC batch size //20,与JDBC批量设置相同 + //flush a batch of inserts and release memory: + //将本批插入的对象立即写入数据库并释放内存 + session.flush(); + session.clear(); + } +} + +tx.commit(); +session.close();]]></programlisting> + + </sect1> + + <sect1 id="batch-update" > + <title>批量更新（Batch updates）</title> + + <para> + 此方法同样适用于检索和更新数据。此外，在进行会返回很多行数据的查询时， + 你需要使用 <literal>scroll()</literal> 方法以便充分利用服务器端游标所带来的好处。 + </para> + +<programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); + +ScrollableResults customers = session.getNamedQuery("GetCustomers") + .setCacheMode(CacheMode.IGNORE) + .scroll(ScrollMode.FORWARD_ONLY); +int count=0; +while ( customers.next() ) { + Customer customer = (Customer) customers.get(0); + customer.updateStuff(...); + if ( ++count % 20 == 0 ) { + //flush a batch of updates and release memory: + session.flush(); + session.clear(); + } +} + +tx.commit(); +session.close();]]></programlisting> + + </sect1> + + <sect1 id="batch-statelesssession"> + <title>StatelessSession (无状态session)接口</title> + <para> + 作为选择，Hibernate提供了基于命令的API，可以用detached object的形式把数据以流的方法加入到数据库，或从数据库输出。<literal>StatelessSession</literal>没有持久化上下文，也不提供多少高层的生命周期语义。特别是，无状态session不实现第一级cache,也不和第二级缓存，或者查询缓存交互。它不实现事务化写，也不实现脏数据检查。用stateless session进行的操作甚至不级联到关联实例。stateless session忽略集合类(Collections)。通过stateless session进行的操作不触发Hibernate的事件模型和拦截器。无状态session对数据的混淆现象免疫，因为它没有第一级缓存。无状态session是低层的抽象，和低层JDBC相当接近。 + </para> + +<programlisting><![CDATA[StatelessSession session = sessionFactory.openStatelessSession(); +Transaction tx = session.beginTransaction(); + +ScrollableResults customers = session.getNamedQuery("GetCustomers") + .scroll(ScrollMode.FORWARD_ONLY); +while ( customers.next() ) { + Customer customer = (Customer) customers.get(0); + customer.updateStuff(...); + session.update(customer); +} + +tx.commit(); +session.close();]]></programlisting> + + <para> + 注意在上面的例子中，查询返回的<literal>Customer</literal>实例立即被脱管(detach)。它们与任何持久化上下文都没有关系。 + </para> + + <para> + <literal>StatelessSession</literal> 接口定义的<literal>insert(), update()</literal> 和 <literal>delete()</literal>操作是直接的数据库行级别操作，其结果是立刻执行一条<literal>INSERT, UPDATE</literal> 或 <literal>DELETE</literal> 语句。因此，它们的语义和<literal>Session</literal> 接口定义的<literal>save(), saveOrUpdate()</literal> 和<literal>delete()</literal> 操作有很大的不同。 + </para> + + </sect1> + + <sect1 id="batch-direct" revision="3"> + <title>DML(数据操作语言)风格的操作(DML-style operations)</title> + + <para> + hence manipulating (using the SQL <literal>Data Manipulation Language</literal> + (DML) statements: <literal>INSERT</literal>, <literal>UPDATE</literal>, <literal>DELETE</literal>) + data directly in the database will not affect in-memory state. However, Hibernate provides methods + for bulk SQL-style DML statement execution which are performed through the + Hibernate Query Language (<xref linkend="queryhql">HQL</xref>). + + + 就像已经讨论的那样，自动和透明的 对象/关系 映射（object/relational mapping）关注于管理对象的状态。 + 这就意味着对象的状态存在于内存，因此直接操作 (使用 SQL <literal>Data Manipulation Language</literal>(DML,数据操作语言）语句 ：<literal>INSERT</literal> ,<literal>UPDATE</literal> 和 + <literal>DELETE</literal>) 数据库中的数据将不会影响内存中的对象状态和对象数据。 + 不过，Hibernate提供通过Hibernate查询语言（<xref linkend="queryhql">HQL</xref>）来执行大批 + 量SQL风格的DML语句的方法。 + </para> + + <para> + <literal>UPDATE</literal> 和 <literal>DELETE</literal>语句的语法为： + <literal>( UPDATE | DELETE ) FROM? EntityName (WHERE where_conditions)?</literal> + 有几点说明： + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + 在FROM子句（from-clause）中，FROM关键字是可选的 + </para> + </listitem> + <listitem> + <para> + 在FROM子句（from-clause）中只能有一个实体名，它可以是别名。如果实体名是别名，那么任何被引用的属性都必须加上此别名的前缀；如果不是别名，那么任何有前缀的属性引用都是非法的。 + </para> + </listitem> + <listitem> + <para> + 不能在大批量HQL语句中使用<xref linkend="queryhql-joins-forms">连接(join)</xref>（显式或者隐式的都不行）。不过在WHERE子句中可以使用子查询。可以在where子句中使用子查询，子查询本身可以包含join。 + + </para> + </listitem> + <listitem> + <para> + 整个WHERE子句是可选的。 + </para> + </listitem> + </itemizedlist> + + <para> + 举个例子，使用<literal>Query.executeUpdate()</literal>方法执行一个HQL + <literal>UPDATE</literal>语句(： + (方法命名是来源于JDBC's <literal>PreparedStatement.executeUpdate()</literal>): + </para> + + <programlisting><![CDATA[Session session = sessionFactory.openSession(); + Transaction tx = session.beginTransaction(); + + String hqlUpdate = "update Customer c set c.name = :newName where c.name = :oldName"; + // or String hqlUpdate = "update Customer set name = :newName where name = :oldName"; + int updatedEntities = s.createQuery( hqlUpdate ) + .setString( "newName", newName ) + .setString( "oldName", oldName ) + .executeUpdate(); + tx.commit(); + session.close();]]></programlisting> + + <para> + HQL <literal>UPDATE</literal>语句，默认不会影响更新实体的<xref linkend="mapping-declaration-version">version</xref>或者<xref linkend="mapping-declaration-timestamp">timestamp</xref>属性值。这和EJB3规范是一致的。但是，通过使用<literal>versioned update</literal>，你可以强制Hibernate正确的重置<literal>version</literal>或者<literal>timestamp</literal>属性值。这通过在<literal>UPDATE</literal>关键字后面增加<literal>VERSIONED</literal>关键字来实现的。 + </para> +<programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); +String hqlVersionedUpdate = "update versioned Customer set name = :newName where name = :oldName"; +int updatedEntities = s.createQuery( hqlUpdate ) + .setString( "newName", newName ) + .setString( "oldName", oldName ) + .executeUpdate(); +tx.commit(); +session.close();]]></programlisting> + + <para> + 注意，自定义的版本类型(<literal>org.hibernate.usertype.UserVersionType</literal>)不允许和<literal>update versioned</literal>语句联用。 + </para> + + <para> + 执行一个HQL <literal>DELETE</literal>，同样使用 <literal>Query.executeUpdate()</literal> 方法: + </para> + + <programlisting><![CDATA[Session session = sessionFactory.openSession(); + Transaction tx = session.beginTransaction(); + + String hqlDelete = "delete Customer c where c.name = :oldName"; + // or String hqlDelete = "delete Customer where name = :oldName"; + int deletedEntities = s.createQuery( hqlDelete ) + .setString( "oldName", oldName ) + .executeUpdate(); + tx.commit(); + session.close();]]></programlisting> + + <para> + 由<literal>Query.executeUpdate()</literal>方法返回的<literal>整型</literal>值表明了受此操作影响的记录数量。 + 注意这个数值可能与数据库中被（最后一条SQL语句）影响了的“行”数有关，也可能没有。一个大批量HQL操作可能导致多条实际的SQL语句被执行， + 举个例子，对joined-subclass映射方式的类进行的此类操作。这个返回值代表了实际被语句影响了的记录数量。在那个joined-subclass的例子中， + 对一个子类的删除实际上可能不仅仅会删除子类映射到的表而且会影响“根”表，还有可能影响与之有继承关系的joined-subclass映射方式的子类的表。 + </para> + + <para> + <literal>INSERT</literal>语句的伪码是: + <literal>INSERT INTO EntityName properties_list select_statement</literal>. + 要注意的是: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + 只支持INSERT INTO ... SELECT ...形式,不支持INSERT INTO ... VALUES ...形式. + </para> + <para> + properties_list和SQL <literal>INSERT</literal>语句中的<literal>字段定义(column speficiation)</literal>类似。对参与继承树映射的实体而言，只有直接定义在给定的类级别的属性才能直接在properties_list中使用。超类的属性不被支持；子类的属性无意义。换句话说，<literal>INSERT</literal>天生不支持多态。 + </para> + </listitem> + <listitem> + <para> + select_statement可以是任何合法的HQL选择查询，不过要保证返回类型必须和要插入的类型完全匹配。目前，这一检查是在查询编译的时候进行的，而不是把它交给数据库。注意，在Hibernate<literal>Type</literal>间如果只是<emphasis>等价（equivalent）</emphasis>而非<emphasis>相等(equal)</emphasis>，会导致问题。定义为<literal>org.hibernate.type.DateType</literal>和<literal>org.hibernate.type.TimestampType</literal>的两个属性可能会产生类型不匹配错误，虽然数据库级可能不加区分或者可以处理这种转换。 + </para> + </listitem> + <listitem> + <para> + 对id属性来说,insert语句给你两个选择。你可以明确地在properties_list表中指定id属性（这样它的值是从对应的select表达式中获得），或者在properties_list中省略它（此时使用生成指）。后一种选择只有当使用在数据库中生成值的id产生器时才能使用；如果是“内存”中计算的类型生成器，在解析时会抛出一个异常。注意，为了说明这一问题，数据库产生值的生成器是<literal>org.hibernate.id.SequenceGenerator</literal>（和它的子类），以及任何<literal>org.hibernate.id.PostInsertIdentifierGenerator</literal>接口的实现。这儿最值得注意的意外是<literal>org.hibernate.id.TableHiLoGenerator</literal>，它不能在此使用，因为它没有得到其值的途径。 + </para> + </listitem> + <listitem> + <para> + 对映射为<literal>version</literal> 或 <literal>timestamp</literal>的属性来说，insert语句也给你两个选择，你可以在properties_list表中指定（此时其值从对应的select表达式中获得），或者在properties_list中省略它（此时，使用在<literal>org.hibernate.type.VersionType</literal> 中定义的<literal>seed value(种子值)</literal>）。 + </para> + </listitem> + </itemizedlist> + + <para> + 执行HQL <literal>INSERT</literal>语句的例子如下： + </para> + +<programlisting><![CDATA[Session session = sessionFactory.openSession(); +Transaction tx = session.beginTransaction(); + +String hqlInsert = "insert into DelinquentAccount (id, name) select c.id, c.name from Customer c where ..."; +int createdEntities = s.createQuery( hqlInsert ) + .executeUpdate(); +tx.commit(); +session.close();]]></programlisting> + + </sect1> + +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/best_practices.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/best_practices.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/best_practices.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/best_practices.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,175 @@ +<chapter id="best-practices" revision="2"> + <title>最佳实践(Best Practices)</title> + + <variablelist spacing="compact"> + <varlistentry> + <term>设计细颗粒度的持久类并且使用<literal>&lt;component&gt;</literal>来实现映射。</term> + <listitem> + <para> + 使用一个<literal>Address</literal>持久类来封装 <literal>street</literal>, + <literal>suburb</literal>, <literal>state</literal>, <literal>postcode</literal>. + 这将有利于代码重用和简化代码重构(refactoring)的工作。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>对持久类声明标识符属性( identifier properties)。</term> + <listitem> + <para> + Hibernate中标识符属性是可选的，不过有很多原因来说明你应该使用标识符属性。我们建议标识符应该是“人造”的(自动生成，不涉及业务含义)。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>使用自然键(natural keys)标识</term> + <listitem> + <para> + 对所有的实体都标识出自然键，用<literal>&lt;natural-id&gt;</literal>进行映射。实现<literal>equals()</literal>和<literal>hashCode()</literal>，在其中用组成自然键的属性进行比较。 + </para> + </listitem> + Y00008051221000980 2.7，89，100万 + </varlistentry> + + <varlistentry> + <term>为每个持久类写一个映射文件</term> + <listitem> + <para> + 不要把所有的持久类映射都写到一个大文件中。把 <literal>com.eg.Foo</literal> 映射到<literal>com/eg/Foo.hbm.xml</literal>中， 在团队开发环境中，这一点显得特别有意义。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>把映射文件作为资源加载</term> + <listitem> + <para> + 把映射文件和他们的映射类放在一起进行部署。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>考虑把查询字符串放在程序外面</term> + <listitem> + <para> + 如果你的查询中调用了非ANSI标准的SQL函数，那么这条实践经验对你适用。把查询字符串放在映射文件中可以让程序具有更好的可移植性。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>使用绑定变量</term> + <listitem> + <para> + 就像在JDBC编程中一样，应该总是用占位符"?"来替换非常量值，不要在查询中用字符串值来构造非常量值！更好的办法是在查询中使用命名参数。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>不要自己来管理JDBC connections</term> + <listitem> + <para> + Hibernate允许应用程序自己来管理JDBC connections，但是应该作为最后没有办法的办法。如果你不能使用Hibernate内建的connections providers，那么考虑实现自己来实现<literal>org.hibernate.connection.ConnectionProvider</literal> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>考虑使用用户自定义类型(custom type)</term> + <listitem> + <para> + 假设你有一个Java类型，来自某些类库，需要被持久化，但是该类没有提供映射操作需要的存取方法。那么你应该考虑实现<literal>org.hibernate.UserType</literal>接口。这种办法使程序代码写起来更加自如，不再需要考虑类与Hibernate type之间的相互转换。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>在性能瓶颈的地方使用硬编码的JDBC</term> + <listitem> + <para> + In performance-critical areas of the system, some kinds of operations might benefit from + direct JDBC. But please, wait until you <emphasis>know</emphasis> something is a bottleneck. + And don't assume that direct JDBC is necessarily faster. If you need to use direct JDBC, it might + be worth opening a Hibernate <literal>Session</literal> and using that JDBC connection. That + way you can still use the same transaction strategy and underlying connection provider. + + 在系统中对性能要求很严格的一些部分，某些操作也许直接使用JDBC会更好。但是请先<emphasis>确认</emphasis>这的确是一个瓶颈，并且不要想当然认为JDBC一定会更快。如果确实需要直接使用JDBC，那么最好打开一个 +Hibernate <literal>Session</literal> 然后从 <literal>Session</literal>获得connection，按照这种办法你仍然可以使用同样的transaction策略和底层的connection provider。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>理解<literal>Session</literal>清洗（ flushing）</term> + <listitem> + <para> + Session会不时的向数据库同步持久化状态，如果这种操作进行的过于频繁，性能会受到一定的影响。有时候你可以通过禁止自动flushing，尽量最小化非必要的flushing操作，或者更进一步，在一个特定的transaction中改变查询和其它操作的顺序。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>在三层结构中，考虑使用托管对象（detached object）</term> + <listitem> + <para> + 当使用一个servlet / session bean 类型的架构的时候, 你可以把已加载的持久对象在session bean层和servlet / JSP 层之间来回传递。使用新的session来为每个请求服务，使用 <literal>Session.merge()</literal> 或者<literal>Session.saveOrUpdate()</literal>来与数据库同步。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>在两层结构中，考虑使用长持久上下文(long persistence contexts).</term> + <listitem> + <para> + 为了得到最佳的可伸缩性，数据库事务(Database Transaction)应该尽可能的短。但是，程序常常需要实现长时间运行的<emphasis>“应用程序事务(Application Transaction)”</emphasis>，包含一个从用户的观点来看的原子操作。这个应用程序事务可能跨越多次从用户请求到得到反馈的循环。用脱管对象(与session脱离的对象)来实现应用程序事务是常见的。或者，尤其在两层结构中，把Hibernate Session从JDBC连接中脱离开，下次需要用的时候再连接上。绝不要把一个Session用在多个应用程序事务(Application Transaction)中，否则你的数据可能会过期失效。 + </para> + + </listitem> + </varlistentry> + <varlistentry> + <term>不要把异常看成可恢复的</term> + <listitem> + <para> + 这一点甚至比“最佳实践”还要重要，这是“必备常识”。当异常发生的时候，必须要回滚 <literal>Transaction</literal> ，关闭<literal>Session</literal>。如果你不这样做的话，Hibernate无法保证内存状态精确的反应持久状态。尤其不要使用<literal>Session.load()</literal>来判断一个给定标识符的对象实例在数据库中是否存在，应该使用<literal>Session.get()</literal>或者进行一次查询. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>对于关联优先考虑lazy fetching </term> + <listitem> + <para> + 谨慎的使用主动抓取(eager fetching)。对于关联来说，若其目标是无法在第二级缓存中完全缓存所有实例的类，应该使用代理(proxies)与/或具有延迟加载属性的集合(lazy collections)。若目标是可以被缓存的，尤其是缓存的命中率非常高的情况下，应该使用<literal>lazy="false"</literal>，明确的禁止掉eager fetching。如果那些特殊的确实适合使用join fetch 的场合，请在查询中使用<literal>left join fetch</literal>。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + 使用<emphasis>open session in view</emphasis>模式，或者执行严格的<emphasis>装配期(assembly phase)</emphasis>策略来避免再次抓取数据带来的问题 + </term> + <listitem> + <para> + + Hibernate让开发者们摆脱了繁琐的<emphasis>Data Transfer Objects</emphasis> (DTO)。在传统的EJB结构中，DTO有双重作用：首先，他们解决了entity bean无法序列化的问题；其次，他们隐含地定义了一个装配期，在此期间，所有在view层需要用到的数据，都被抓取、集中到了DTO中，然后控制才被装到表示层。Hibernate终结了第一个作用。然而，除非你做好了在整个渲染过程中都维护一个打开的持久化上下文(session)的准备，你仍然需要一个装配期（想象一下，你的业务方法与你的表示层有严格的契约，数据总是被放置到托管对象中）。这并非是Hibernate的限制！这是实现安全的事务化数据访问的基本需求。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>考虑把Hibernate代码从业务逻辑代码中抽象出来</term> + <listitem> + <para> + 把Hibernate的数据存取代码隐藏到接口(interface)的后面，组合使用<emphasis>DAO</emphasis>和<emphasis>Thread Local Session</emphasis>模式。通过Hibernate的<literal>UserType</literal>，你甚至可以用硬编码的JDBC来持久化那些本该被Hibernate持久化的类。 (该建议更适用于规模足够大应用软件中，对于那些只有5张表的应用程序并不适合。) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>不要用怪异的连接映射</term> + <listitem> + <para> + 多对多连接用得好的例子实际上相当少见。大多数时候你在“连接表”中需要保存额外的信息。这种情况下，用两个指向中介类的一对多的连接比较好。实际上，我们认为绝大多数的连接是一对多和多对一的，你应该谨慎使用其它连接风格，用之前问自己一句，是否真的必须这么做。 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>偏爱双向关联</term> + <listitem> + <para> + 单向关联更加难于查询。在大型应用中，几乎所有的关联必须在查询中可以双向导航。 + </para> + </listitem> + </varlistentry> + </variablelist> + +</chapter> + Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/collection_mapping.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/collection_mapping.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/collection_mapping.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/collection_mapping.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,1081 @@ + <chapter id="collections"> + <title>集合类(Collections)映射</title> + + + <sect1 id="collections-persistent" revision="3"> + <title>持久化集合类(Persistent collections)</title> + + <para id="collections-persistent-translate-comment"> + (译者注：在阅读本章的时候，以后整个手册的阅读过程中，我们都会面临一个名词方面的问题，那就是“集合”。"Collections"和"Set"在中文里对应都被翻译为“集合”，但是他们的含义很不一样。Collections是一个超集，Set是其中的一种。大部分情况下，本译稿中泛指的未加英文注明的“集合”，都应当理解为“Collections”。在有些二者同时出现，可能造成混淆的地方，我们用“集合类”来特指“Collecions”,“集合(Set)”来指"Set"，一般都会在后面的括号中给出英文。希望大家在阅读时联系上下文理解，不要造成误解。 + 与此同时，“元素”一词对应的英文“element”，也有两个不同的含义。其一为集合的元素，是内存中的一个变量；另一含义则是XML文档中的一个标签所代表的元素。也请注意区别。 + 本章中,特别是后半部分是需要反复阅读才能理解清楚的。如果遇到任何疑问,请记住,英文版本的reference是惟一标准的参考资料。) + </para> + + <para> + Hibernate要求持久化集合值字段必须声明为接口，比如： + </para> + + <programlisting><![CDATA[public class Product { + private String serialNumber; + private Set parts = new HashSet(); + + public Set getParts() { return parts; } + void setParts(Set parts) { this.parts = parts; } + public String getSerialNumber() { return serialNumber; } + void setSerialNumber(String sn) { serialNumber = sn; } +}]]></programlisting> + + <para> + 实际的接口可能是<literal>java.util.Set</literal>, + <literal>java.util.Collection</literal>, <literal>java.util.List</literal>, + <literal>java.util.Map</literal>, <literal>java.util.SortedSet</literal>, + <literal>java.util.SortedMap</literal> 或者...任何你喜欢的类型！("任何你喜欢的类型" 代表你需要编写 <literal>org.hibernate.usertype.UserCollectionType</literal>的实现.) + </para> + + <para> + 注意我们是如何用一个<literal>HashSet</literal>实例来初始化实例变量的.这是用于初始化新创建(尚未持久化)的类实例中集合值属性的最佳方法。当你持久化这个实例时——比如通过调用<literal>persist()</literal>——Hibernate 会自动把<literal>HashSet</literal>替换为Hibernate自己的<literal>Set</literal>实现。观察下面的错误： + </para> + + + <programlisting><![CDATA[Cat cat = new DomesticCat(); +Cat kitten = new DomesticCat(); +.... +Set kittens = new HashSet(); +kittens.add(kitten); +cat.setKittens(kittens); +session.persist(cat); +kittens = cat.getKittens(); //Okay, kittens collection is a Set +(HashSet) cat.getKittens(); //Error!]]></programlisting> + + <para> + 根据不同的接口类型，被Hibernate注射的持久化集合类的表现类似<literal>HashMap</literal>, <literal>HashSet</literal>, + <literal>TreeMap</literal>, <literal>TreeSet</literal> or + <literal>ArrayList</literal>。 + </para> + + <para> + 集合类实例具有值类型的通常行为。当被持久化对象引用后，他们会自动被持久化，当不再被引用后，自动被删除。假若实例被从一个持久化对象传递到另一个，它的元素可能从一个表转移到另一个表。两个实体不能共享同一个集合类实例的引用。因为底层关系数据库模型的原因，集合值属性无法支持空值语义；Hibernate对空的集合引用和空集合不加区别。 + </para> + + <para> + 你不需要过多的为此担心。就如同你平时使用普通的Java集合类一样来使用持久化集合类。只是要确认你理解了双向关联的语义（后文讨论）。 + </para> + + </sect1> + + <sect1 id="collections-mapping" revision="4"> + <title>集合映射（ Collection mappings ）</title> + + <para> + 用于映射集合类的Hibernate映射元素取决于接口的类型。比如， <literal>&lt;set&gt;</literal> 元素用来映射<literal>Set</literal>类型的属性。 + </para> + + <programlisting><![CDATA[<class name="Product"> + <id name="serialNumber" column="productSerialNumber"/> + <set name="parts"> + <key column="productSerialNumber" not-null="true"/> + <one-to-many class="Part"/> + </set> +</class>]]></programlisting> + + <para> + 除了<literal>&lt;set&gt;</literal>,还有<literal>&lt;list&gt;</literal>, <literal>&lt;map&gt;</literal>, <literal>&lt;bag&gt;</literal>, <literal>&lt;array&gt;</literal> 和 + <literal>&lt;primitive-array&gt;</literal> 映射元素。<literal>&lt;map&gt;</literal>具有代表性： + </para> + + + <programlistingco> + <areaspec> + <area id="mappingcollection1" coords="2 65"/> + <area id="mappingcollection2" coords="3 65"/> + <area id="mappingcollection3" coords="4 65"/> + <area id="mappingcollection4" coords="5 65"/> + <area id="mappingcollection5" coords="6 65"/> + <area id="mappingcollection6" coords="7 65"/> + <area id="mappingcollection7" coords="8 65"/> + <area id="mappingcollection8" coords="9 65"/> + <area id="mappingcollection9" coords="10 65"/> + <area id="mappingcollection10" coords="11 65"/> + <area id="mappingcollection11" coords="12 65"/> + <area id="mappingcollection12" coords="13 65"/> + <area id="mappingcollection13" coords="14 65"/> + <area id="mappingcollection14" coords="15 65"/> + + </areaspec> + <programlisting><![CDATA[<map + name="propertyName" + table="table_name" + schema="schema_name" + lazy="true|extra|false" + inverse="true|false" + cascade="all|none|save-update|delete|all-delete-orphan|delete-orphan" + sort="unsorted|natural|comparatorClass" + order-by="column_name asc|desc" + where="arbitrary sql where condition" + fetch="join|select|subselect" + batch-size="N" + access="field|property|ClassName" + optimistic-lock="true|false" + mutable="true|false" + node="element-name|." + embed-xml="true|false" +> + + <key .... /> + <map-key .... /> + <element .... /> +</map>]]></programlisting> + <calloutlist> + <callout arearefs="mappingcollection1"> + <para> + <literal>name</literal> 集合属性的名称 + </para> + </callout> + <callout arearefs="mappingcollection2"> + <para> + <literal>table</literal> （可选——默认为属性的名称）这个集合表的名称(不能在一对多的关联关系中使用) + </para> + </callout> + <callout arearefs="mappingcollection3"> + <para> + <literal>schema</literal> (可选) 表的schema的名称, 他将覆盖在根元素中定义的schema + </para> + </callout> + <callout arearefs="mappingcollection4"> + <para> + <literal>lazy</literal> (可选--默认为true) 可以用来关闭延迟加载(false)，指定一直使用预先抓取,或者打开"extra-lazy" 抓取，此时大多数操作不会初始化集合类(适用于非常大的集合) + </para> + </callout> + <callout arearefs="mappingcollection5"> + <para> + <literal>inverse</literal> (可选——默认为<literal>false</literal>) + 标记这个集合作为双向关联关系中的方向一端。 + + </para> + </callout> + <callout arearefs="mappingcollection6"> + <para> + <literal>cascade</literal> (可选——默认为<literal>none</literal>) + 让操作级联到子实体 + </para> + </callout> + <callout arearefs="mappingcollection7"> + <para> + <literal>sort</literal>(可选)指定集合的排序顺序, 其可以为自然的(<literal>natural</literal>)或者给定一个用来比较的类。 + + </para> + </callout> + <callout arearefs="mappingcollection8"> + <para> + <literal>order-by</literal> (可选, 仅用于jdk1.4) 指定表的字段(一个或几个)再加上asc或者desc(可选), 定义Map,Set和Bag的迭代顺序 + </para> + </callout> + <callout arearefs="mappingcollection9"> + <para> + <literal>where</literal> (可选) 指定任意的SQL where条件, 该条件将在重新载入或者删除这个集合时使用(当集合中的数据仅仅是所有可用数据的一个子集时这个条件非常有用) + </para> + </callout> + <callout arearefs="mappingcollection10"> + <para> + <literal>fetch</literal> (可选, 默认为<literal>select</literal>) 用于在外连接抓取、通过后续select抓取和通过后续subselect抓取之间选择。 + </para> + </callout> + <callout arearefs="mappingcollection11"> + <para> + <literal>batch-size</literal> (可选, 默认为<literal>1</literal>) 指定通过延迟加载取得集合实例的批处理块大小（"batch size"）。 + </para> + </callout> + <callout arearefs="mappingcollection12"> + <para> + <literal>access</literal>(可选-默认为属性property):Hibernate取得集合属性值时使用的策略 + </para> + </callout> + <callout arearefs="mappingcollection13"> + <para> + <literal>乐观锁</literal> (可选 - 默认为 <literal>true</literal>): + 对集合的状态的改变会是否导致其所属的实体的版本增长。 (对一对多关联来说，关闭这个属性常常是有理的) + </para> + </callout> + <callout arearefs="mappingcollection14"> + <para> + <literal>mutable(可变）</literal> (可选 - 默认为<literal>true</literal>): + 若值为<literal>false</literal>,表明集合中的元素不会改变（在某些情况下可以进行一些小的性能优化）。 + </para> + </callout> + + </calloutlist> + </programlistingco> + + <sect2 id="collections-foreignkeys" > + <title>集合外键(Collection foreign keys)</title> + + <para> + 集合实例在数据库中依靠持有集合的实体的外键加以辨别。此外键作为<emphasis>集合关键字段（collection key column）</emphasis>（或多个字段）加以引用。集合关键字段通过<literal>&lt;key&gt;</literal> 元素映射。 + </para> + + <para> + 在外键字段上可能具有非空约束。对于大多数集合来说，这是隐含的。对单向一对多关联来说，外键字段默认是可以为空的，因此你可能需要指明 <literal>not-null="true"</literal>。 + </para> + + <programlisting><![CDATA[<key column="productSerialNumber" not-null="true"/>]]></programlisting> + + <para> + 外键约束可以使用<literal>ON DELETE CASCADE</literal>。 + </para> + + <programlisting><![CDATA[<key column="productSerialNumber" on-delete="cascade"/>]]></programlisting> + + <para> + 对<literal>&lt;key&gt;</literal> 元素的完整定义，请参阅前面的章节。 + </para> + + </sect2> + + <sect2 id="collections-elements" > + <title>集合元素（Collection elements）</title> + + <para> + 集合几乎可以包含任何其他的Hibernate类型，包括所有的基本类型、自定义类型、组件，当然还有对其他实体的引用。存在一个重要的区别：位于集合中的对象可能是根据“值”语义来操作（其声明周期完全依赖于集合持有者），或者它可能是指向另一个实体的引用，具有其自己的生命周期。在后者的情况下，被作为集合持有的状态考虑的，只有两个对象之间的“连接”。 + </para> + + + <para> + 被包容的类型被称为<emphasis>集合元素类型（collection element type）</emphasis>。集合元素通过<literal>&lt;element&gt;</literal>或<literal>&lt;composite-element&gt;</literal>映射，或在其是实体引用的时候，通过<literal>&lt;one-to-many&gt;</literal> 或<literal>&lt;many-to-many&gt;</literal>映射。前两种用于使用值语义映射元素，后两种用于映射实体关联。 + </para> + + </sect2> + + <sect2 id="collections-indexed"> + <title>索引集合类(Indexed collections)</title> + + + <para> + 所有的集合映射，除了set和bag语义的以外，都需要指定一个集合表的<emphasis>索引字段(index column)</emphasis>——用于对应到数组索引，或者<literal>List</literal>的索引，或者<literal>Map</literal>的关键字。通过<literal>&lt;map-key&gt;</literal>,<literal>Map</literal> 的索引可以是任何基础类型；若通过<literal>&lt;map-key-many-to-many&gt;</literal>，它也可以是一个实体引用；若通过<literal>&lt;composite-map-key&gt;</literal>，它还可以是一个组合类型。数组或列表的索引必须是<literal>integer</literal>类型，并且使用 <literal>&lt;list-index&gt;</literal>元素定义映射。被映射的字段包含有顺序排列的整数（默认从0开始）。 + </para> + + + <programlistingco> + <areaspec> + <area id="mapkey1" coords="2 45"/> + <area id="mapkey2" coords="3 45"/> + <area id="mapkey3" coords="4 45"/> + </areaspec> + <programlisting><![CDATA[<map-key + column="column_name" + formula="any SQL expression" + type="type_name" + node="@attribute-name" + length="N"/>]]></programlisting> + <calloutlist> + <callout arearefs="mapkey1"> + <para> + <literal>column</literal>(可选):保存集合索引值的字段名。 + </para> + </callout> + <callout arearefs="mapkey2"> + <para> + <literal>formula</literal> (可选): 用于计算map关键字的SQL公式 + </para> + </callout> + + <callout arearefs="mapkey3"> + <para> + <literal>type</literal> (必须):映射键(map key)的类型。 + </para> + </callout> + </calloutlist> + </programlistingco> + + <programlistingco> + <areaspec> + <area id="indexmanytomany1" coords="2 45"/> + <area id="indexmanytomany2" coords="3 45"/> + <area id="indexmanytomany3" coords="3 45"/> + </areaspec> + <programlisting><![CDATA[<map-key-many-to-many + column="column_name" + formula="any SQL expression" + class="ClassName" +/>]]></programlisting> + <calloutlist> + <callout arearefs="indexmanytomany1"> + <para> + <literal>column</literal>(可选):集合索引值中外键字段的名称 + </para> + </callout> + <callout arearefs="indexmanytomany2"> + <para> + <literal>formula</literal> (可选): 用于计算map关键字的外键的SQL公式 + </para> + </callout> + <callout arearefs="indexmanytomany3"> + <para> + <literal>class</literal> (必需):映射的键(map key)使用的实体类。 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + 假若你的表没有一个索引字段,当你仍然希望使用<literal>List</literal>作为属性类型,你应该把此属性映射为Hibernate <emphasis>&lt;bag&gt;</emphasis>。从数据库中获取的时候，bag不维护其顺序，但也可选择性的进行排序。 + </para> + + </sect2> + + + <para> + 从集合类可以产生很大一部分映射，覆盖了很多常见的关系模型。我们建议你试验schema生成工具，来体会一下不同的映射声明是如何被翻译为数据库表的。 + </para> + + <sect2 id="collections-ofvalues" revision="2"> + <title>值集合于多对多关联(Collections of values and many-to-many associations)</title> + + + <para> + 任何值集合或者多对多关联需要专用的具有一个或多个外键字段的<emphasis>collection table</emphasis>、一个或多个<emphasis>collection element column</emphasis>，以及还可能有一个或多个索引字段。 + </para> + + + <para> + 对于一个值集合, 我们使用<literal>&lt;element&gt;</literal>标签。 + </para> + + <programlistingco> + <areaspec> + <area id="element1b" coords="2 50"/> + <area id="element2b" coords="3 50"/> + <area id="element3b" coords="4 50"/> + </areaspec> + <programlisting><![CDATA[<element + column="column_name" + formula="any SQL expression" + type="typename" + length="L" + precision="P" + scale="S" + not-null="true|false" + unique="true|false" + node="element-name" +/>]]></programlisting> + <calloutlist> + <callout arearefs="element1b"> + <para> + <literal>column</literal>(可选):保存集合元素值的字段名。 + </para> + </callout> + <callout arearefs="element2b"> + <para> + <literal>formula</literal> (可选): 用于计算元素的SQL公式 + </para> + </callout> + <callout arearefs="element3b"> + <para> + <literal>type</literal> (必需):集合元素的类型 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + <emphasis>多对多关联(many-to-many association)</emphasis> 使用 + <literal>&lt;many-to-many&gt;</literal>元素定义. + </para> + + <programlistingco> + <areaspec> + <area id="manytomany1" coords="2 60"/> + <area id="manytomany2" coords="3 60"/> + <area id="manytomany3" coords="4 60"/> + <area id="manytomany4" coords="5 60"/> + <area id="manytomany5" coords="6 60"/> + <area id="manytomany6" coords="7 60"/> + <area id="manytomany7" coords="8 60"/> + <area id="manytomany8" coords="9 60"/> + </areaspec> + <programlisting><![CDATA[<many-to-many + column="column_name" + formula="any SQL expression" + class="ClassName" + fetch="select|join" + unique="true|false" + not-found="ignore|exception" + entity-name="EntityName" + property-ref="propertyNameFromAssociatedClass" + node="element-name" + embed-xml="true|false" + />]]></programlisting> + <calloutlist> + <callout arearefs="manytomany1"> + <para> + <literal>column</literal>(可选): 这个元素的外键关键字段名 + </para> + </callout> + <callout arearefs="manytomany2"> + <para> + <literal>formula</literal> (可选): 用于计算元素外键值的SQL公式. + </para> + </callout> + + <callout arearefs="manytomany3"> + <para> + <literal>class</literal> (必需): 关联类的名称 + </para> + </callout> + <callout arearefs="manytomany3"> + <para> + <literal>outer-join</literal> (可选 - 默认为<literal>auto</literal>): + 在Hibernate系统参数中<literal>hibernate.use_outer_join</literal>被打开的情况下,该参数用来允许使用outer join来载入此集合的数据。 + </para> + </callout> + <callout arearefs="manytomany4"> + <para> + 为此关联打开外连接抓取或者后续select抓取。这是特殊情况；对于一个实体及其指向其他实体的多对多关联进全预先抓取（使用一条单独的<literal>SELECT</literal>)，你不仅需要对集合自身打开<literal>join</literal>，也需要对<literal>&lt;many-to-many&gt;</literal>这个内嵌元素打开此属性。 + </para> + </callout> + <callout arearefs="manytomany5"> + <para> + 对外键字段允许DDL生成的时候生成一个惟一约束。这使关联变成了一个高效的一对多关联。（此句存疑：原文为This makes the association multiplicity effectively one to many.) + </para> + </callout> + <callout arearefs="manytomany6"> + <para> + <literal>not-found</literal> (可选 - 默认为 <literal>exception</literal>): 指明引用的外键中缺少某些行该如何处理： + <literal>ignore</literal> 会把缺失的行作为一个空引用处理。 + </para> + + </callout> + <callout arearefs="manytomany7"> + <para> + <literal>entity-name</literal> (可选): 被关联的类的实体名，作为<literal>class</literal>的替代。 + </para> + </callout> + <callout arearefs="manytomany8"> + <para> + <literal>property-ref</literal>: (可选) 被关联到此外键(foreign key)的类中的对应属性的名字。若未指定，使用被关联类的主键。 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + 例子：首先, 一组字符串： + </para> + + <programlisting><![CDATA[<set name="names" table="NAMES"> + <key column="GROUPID"/> + <element column="NAME" type="string"/> +</set>]]></programlisting> + + <para> + 包含一组整数的bag(还设置了<literal>order-by</literal>参数指定了迭代的顺序)： + </para> + + <programlisting><![CDATA[<bag name="sizes" + table="item_sizes" + order-by="size asc"> + <key column="item_id"/> + <element column="size" type="integer"/> +</bag>]]></programlisting> + + <para> + 一个实体数组,在这个案例中是一个多对多的关联(注意这里的实体是自动管理生命周期的对象（life cycle objects）,<literal>cascade="all"</literal>): + </para> + + + <programlisting><![CDATA[<array name="addresses" + table="PersonAddress" + cascade="persist"> + <key column="personId"/> + <list-index column="sortOrder"/> + <many-to-many column="addressId" class="Address"/> +</array>]]></programlisting> + + <para> + 一个map,通过字符串的索引来指明日期： + </para> + + + <programlisting><![CDATA[<map name="holidays" + table="holidays" + schema="dbo" + order-by="hol_name asc"> + <key column="id"/> + <map-key column="hol_name" type="string"/> + <element column="hol_date" type="date"/> +</map>]]></programlisting> + + <para> + 一个组件的列表：（下一章讨论） + </para> + + <programlisting><![CDATA[<list name="carComponents" + table="CarComponents"> + <key column="carId"/> + <list-index column="sortOrder"/> + <composite-element class="CarComponent"> + <property name="price"/> + <property name="type"/> + <property name="serialNumber" column="serialNum"/> + </composite-element> +</list>]]></programlisting> + + + </sect2> + + + <sect2 id="collections-onetomany"> + <title>一对多关联（One-to-many Associations）</title> + + + <para> + <emphasis>一对多关联</emphasis><emphasis>通过外键</emphasis>连接两个类对应的表,而没有中间集合表。 这个关系模型失去了一些Java集合的语义: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + 一个被包含的实体的实例只能被包含在一个集合的实例中 + </para> + </listitem> + <listitem> + <para> + 一个被包含的实体的实例只能对应于集合索引的一个值中 + </para> + </listitem> + </itemizedlist> + <para> + 一个从<literal>Product</literal>到<literal>Part</literal>的关联需要关键字字段,可能还有一个索引字段指向<literal>Part</literal>所对应的表。 <literal>&lt;one-to-many&gt;</literal>标记指明了一个一对多的关联。 + </para> + + <programlistingco> + <areaspec> + <area id="onetomany1" coords="2 60"/> + <area id="onetomany2" coords="3 60"/> + <area id="onetomany3" coords="4 60"/> + </areaspec> + <programlisting><![CDATA[<one-to-many + class="ClassName" + not-found="ignore|exception" + entity-name="EntityName" + node="element-name" + embed-xml="true|false" + />]]></programlisting> + <calloutlist> + <callout arearefs="onetomany1"> + <para> + <literal>class</literal>(必须):被关联类的名称。 + </para> + </callout> + <callout arearefs="onetomany2"> + <para> + <literal>not-found</literal> (可选 - 默认为<literal>exception</literal>): + 指明若缓存的标示值关联的行缺失,该如何处理: + <literal>ignore</literal> 会把缺失的行作为一个空关联处理。 + </para> + </callout> + <callout arearefs="onetomany3"> + <para> + <literal>entity-name</literal> (可选): 被关联的类的实体名，作为<literal>class</literal>的替代。 + </para> + </callout> + </calloutlist> + </programlistingco> + + + <para> + 例子 + </para> + + <programlisting><![CDATA[<set name="bars"> + <key column="foo_id"/> + <one-to-many class="org.hibernate.Bar"/> +</set>]]></programlisting> + + <para> + 注意:<literal>&lt;one-to-many&gt;</literal>元素不需要定义任何字段。 也不需要指定表名。 + + </para> + + <para> + <emphasis>重要提示</emphasis>:如果<literal>一对多</literal>关联中的外键字段定义成<literal>NOT NULL</literal>,你必须把<literal>&lt;key&gt;</literal>映射声明为<literal>not-null="true"</literal>,或者使用<emphasis>双向关联</emphasis>，并且标明<literal>inverse="true"</literal>。参阅本章后面关于双向关联的讨论。 + </para> + + <para> + 下面的例子展示一个<literal>Part</literal>实体的map,把name作为关键字。( <literal>partName</literal> 是<literal>Part</literal>的持久化属性)。注意其中的基于公式的索引的用法。 + </para> + + <programlisting><![CDATA[<map name="parts" + cascade="all"> + <key column="productId" not-null="true"/> + <map-key formula="partName"/> + <one-to-many class="Part"/> +</map>]]></programlisting> + </sect2> + + </sect1> + + <sect1 id="collections-advancedmappings"> + <title>高级集合映射（Advanced collection mappings）</title> + + <sect2 id="collections-sorted" revision="2"> + <title>有序集合（Sorted collections）</title> + + <para> + Hibernate支持实现<literal>java.util.SortedMap</literal>和<literal>java.util.SortedSet</literal>的集合。 +你必须在映射文件中指定一个比较器： + </para> + + <programlisting><![CDATA[<set name="aliases" + table="person_aliases" + sort="natural"> + <key column="person"/> + <element column="name" type="string"/> +</set> + +<map name="holidays" sort="my.custom.HolidayComparator"> + <key column="year_id"/> + <map-key column="hol_name" type="string"/> + <element column="hol_date" type="date"/> +</map>]]></programlisting> + + <para> + <literal>sort</literal>属性中允许的值包括<literal>unsorted</literal>,<literal>natural</literal>和某个实现了<literal>java.util.Comparator</literal>的类的名称。 + </para> + + <para> + 分类集合的行为事实上象<literal>java.util.TreeSet</literal>或者<literal>java.util.TreeMap</literal>。 + </para> + + <para> + 如果你希望数据库自己对集合元素排序，可以利用<literal>set</literal>,<literal>bag</literal>或者<literal>map</literal>映射中的<literal>order-by</literal>属性。这个解决方案只能在jdk1.4或者更高的jdk版本中才可以实现(通过LinkedHashSet或者 +LinkedHashMap实现)。 它是在SQL查询中完成排序，而不是在内存中。 + </para> + + <programlisting><![CDATA[<set name="aliases" table="person_aliases" order-by="lower(name) asc"> + <key column="person"/> + <element column="name" type="string"/> +</set> + +<map name="holidays" order-by="hol_date, hol_name"> + <key column="year_id"/> + <map-key column="hol_name" type="string"/> + <element column="hol_date" type="date"/> +</map>]]></programlisting> + + <para> + 注意: 这个<literal>order-by</literal>属性的值是一个SQL排序子句而不是HQL的！ + </para> + + <para> + 关联还可以在运行时使用集合<literal>filter()</literal>根据任意的条件来排序。 + </para> + + <programlisting><![CDATA[sortedUsers = s.createFilter( group.getUsers(), "order by this.name" ).list();]]></programlisting> + + </sect2> + + <sect2 id="collections-bidirectional" revision="1"> + <title>双向关联（Bidirectional associations）</title> + + <para> + <emphasis>双向关联</emphasis>允许通过关联的任一端访问另外一端。在Hibernate中, 支持两种类型的双向关联: + + <variablelist> + <varlistentry> + <term>一对多（one-to-many）</term> + <listitem> + <para> + Set或者bag值在一端, 单独值(非集合)在另外一端 + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>多对多（many-to-many）</term> + <listitem> + <para> + 两端都是set或bag值 + </para> + </listitem> + </varlistentry> + </variablelist> + + </para> + + <para> + 要建立一个双向的多对多关联，只需要映射两个many-to-many关联到同一个数据库表中，并再定义其中的一端为<emphasis>inverse</emphasis>(使用哪一端要根据你的选择，但它不能是一个索引集合)。 + </para> + + + + <para> + 这里有一个many-to-many的双向关联的例子;每一个category都可以有很多items,每一个items可以属于很多categories： + </para> + + + <programlisting><![CDATA[<class name="Category"> + <id name="id" column="CATEGORY_ID"/> + ... + <bag name="items" table="CATEGORY_ITEM"> + <key column="CATEGORY_ID"/> + <many-to-many class="Item" column="ITEM_ID"/> + </bag> +</class> + +<class name="Item"> + <id name="id" column="ITEM_ID"/> + ... + + <!-- inverse end --> + <bag name="categories" table="CATEGORY_ITEM" inverse="true"> + <key column="ITEM_ID"/> + <many-to-many class="Category" column="CATEGORY_ID"/> + </bag> +</class>]]></programlisting> + + <para> + 如果只对关联的反向端进行了改变，这个改变<emphasis>不会</emphasis>被持久化。 + 这表示Hibernate为每个双向关联在内存中存在两次表现,一个从A连接到B,另一个从B连接到A。如果你回想一下Java对象模型，我们是如何在Java中创建多对多关系的，这可以让你更容易理解： + + </para> + + <programlisting><![CDATA[ +category.getItems().add(item); // The category now "knows" about the relationship +item.getCategories().add(category); // The item now "knows" about the relationship + +session.persist(item); // The relationship won''t be saved! +session.persist(category); // The relationship will be saved]]></programlisting> + + <para> + 非反向端用于把内存中的表示保存到数据库中。 + </para> + + <para> + 要建立一个一对多的双向关联，你可以通过把一个一对多关联，作为一个多对一关联映射到到同一张表的字段上，并且在"多"的那一端定义<literal>inverse="true"</literal>。 + </para> + + <programlisting><![CDATA[<class name="Parent"> + <id name="id" column="parent_id"/> + .... + <set name="children" inverse="true"> + <key column="parent_id"/> + <one-to-many class="Child"/> + </set> +</class> + +<class name="Child"> + <id name="id" column="child_id"/> + .... + <many-to-one name="parent" + class="Parent" + column="parent_id" + not-null="true"/> +</class>]]></programlisting> + + + + <para> + 在“一”这一端定义<literal>inverse="true"</literal>不会影响级联操作，二者是正交的概念！ + </para> + + </sect2> + + <sect2 id="collections-indexedbidirectional"> + <title>双向关联，涉及有序集合类</title> + <para> + 对于有一端是<literal>&lt;list&gt;</literal>或者<literal>&lt;map&gt;</literal>的双向关联，需要加以特别考虑。假若子类中的一个属性映射到索引字段，没问题，我们仍然可以在集合类映射上使用<literal>inverse="true"</literal>： + </para> + + <programlisting><![CDATA[<class name="Parent"> + <id name="id" column="parent_id"/> + .... + <map name="children" inverse="true"> + <key column="parent_id"/> + <map-key column="name" + type="string"/> + <one-to-many class="Child"/> + </map> +</class> + +<class name="Child"> + <id name="id" column="child_id"/> + .... + <property name="name" + not-null="true"/> + <many-to-one name="parent" + class="Parent" + column="parent_id" + not-null="true"/> +</class>]]></programlisting> + + <para> + 但是，假若子类中没有这样的属性存在，我们不能认为这个关联是真正的双向关联（信息不对称，在关联的一端有一些另外一端没有的信息）。在这种情况下，我们不能使用<literal>inverse="true"</literal>。我们需要这样用： + </para> + + <programlisting><![CDATA[<class name="Parent"> + <id name="id" column="parent_id"/> + .... + <map name="children"> + <key column="parent_id" + not-null="true"/> + <map-key column="name" + type="string"/> + <one-to-many class="Child"/> + </map> +</class> + +<class name="Child"> + <id name="id" column="child_id"/> + .... + <many-to-one name="parent" + class="Parent" + column="parent_id" + insert="false" + update="false" + not-null="true"/> +</class>]]></programlisting> + + <para> + 注意在这个映射中，关联中集合类"值"一端负责来更新外键.TODO: Does this really result in some unnecessary update statements? + </para> + + </sect2> + + + <sect2 id="collections-ternary"> + <title>三重关联（Ternary associations）</title> + + <para> + 有三种可能的途径来映射一个三重关联。第一种是使用一个<literal>Map</literal>，把一个关联作为其索引： + </para> + + <programlisting><![CDATA[<map name="contracts"> + <key column="employer_id" not-null="true"/> + <map-key-many-to-many column="employee_id" class="Employee"/> + <one-to-many class="Contract"/> +</map>]]></programlisting> + + <programlisting><![CDATA[<map name="connections"> + <key column="incoming_node_id"/> + <map-key-many-to-many column="outgoing_node_id" class="Node"/> + <many-to-many column="connection_id" class="Connection"/> +</map>]]></programlisting> + + <para> + 第二种方法是简单的把关联重新建模为一个实体类。这使我们最经常使用的方法。 + </para> + <para> + 最后一种选择是使用复合元素，我们会在后面讨论 + </para> + + </sect2> + + <sect2 id="collections-idbag" revision="1"> + <title><literal>使用&lt;idbag&gt;</literal></title> + <para> + 如果你完全信奉我们对于“联合主键（composite keys）是个坏东西”，和“实体应该使用（无机的）自己生成的代用标识符（surrogate keys）”的观点，也许你会感到有一些奇怪，我们目前为止展示的多对多关联和值集合都是映射成为带有联合主键的表的！现在，这一点非常值得争辩；看上去一个单纯的关联表并不能从代用标识符中获得什么好处（虽然使用组合值的集合<emphasis>可能</emphasis>会获得一点好处）。不过，Hibernate提供了一个（一点点试验性质的）功能，让你把多对多关联和值集合应得到一个使用代用标识符的表去。 + </para> + + <para> + <literal>&lt;idbag&gt;</literal> 属性让你使用bag语义来映射一个<literal>List</literal> (或<literal>Collection</literal>)。 + </para> + +<programlisting><![CDATA[<idbag name="lovers" table="LOVERS"> + <collection-id column="ID" type="long"> + <generator class="sequence"/> + </collection-id> + <key column="PERSON1"/> + <many-to-many column="PERSON2" class="Person" fetch="join"/> +</idbag>]]></programlisting> + + <para> + 你可以理解，<literal>&lt;idbag&gt;</literal>人工的id生成器，就好像是实体类一样！集合的每一行都有一个不同的人造关键字。但是，Hibernate没有提供任何机制来让你取得某个特定行的人造关键字。 + </para> + + <para> + 注意<literal>&lt;idbag&gt;</literal>的更新性能要比普通的<literal>&lt;bag&gt;</literal>高得多！Hibernate可以有效的定位到不同的行，分别进行更新或删除工作，就如同处理一个list, map或者set一样。 + + </para> + + <para> + 在目前的实现中，还不支持使用<literal>identity</literal>标识符生成器策略来生成<literal>&lt;idbag&gt;</literal>集合的标识符。 + </para> + + </sect2> + + </sect1> + <!--undocumenting this stuff --> + <!--sect1 id="collections-heterogeneous"> + <title>异类关联(Heterogeneous Associations)</title> + + <para> + <literal>&lt;many-to-any&gt;</literal>和<literal>&lt;index-many-to-any&gt;</literal>元素提供真正的异类关联。这些元素和<literal>&lt;any&gt;</literal>元素工作方式是同样的,他们都应该很少用到。 + </para> + </sect1--> + + <sect1 id="collections-example" revision="1"> + <title>集合例子（Collection example）</title> + + <para> + 在前面的几个章节的确非常令人迷惑。 因此让我们来看一个例子。这个类： + </para> + + <programlisting><![CDATA[package eg; +import java.util.Set; + +public class Parent { + private long id; + private Set children; + + public long getId() { return id; } + private void setId(long id) { this.id=id; } + + private Set getChildren() { return children; } + private void setChildren(Set children) { this.children=children; } + + .... + .... +}]]></programlisting> + + <para> + 这个类有一个<literal>Child</literal>的实例集合。如果每一个子实例至多有一个父实例, 那么最自然的映射是一个one-to-many的关联关系： + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Parent"> + <id name="id"> + <generator class="sequence"/> + </id> + <set name="children"> + <key column="parent_id"/> + <one-to-many class="Child"/> + </set> + </class> + + <class name="Child"> + <id name="id"> + <generator class="sequence"/> + </id> + <property name="name"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + 在以下的表定义中反应了这个映射关系： + </para> + + <programlisting><![CDATA[create table parent ( id bigint not null primary key ) +create table child ( id bigint not null primary key, name varchar(255), parent_id bigint ) +alter table child add constraint childfk0 (parent_id) references parent]]></programlisting> + + <para> + 如果父亲是<emphasis>必须</emphasis>的, 那么就可以使用双向one-to-many的关联了： + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Parent"> + <id name="id"> + <generator class="sequence"/> + </id> + <set name="children" inverse="true"> + <key column="parent_id"/> + <one-to-many class="Child"/> + </set> + </class> + + <class name="Child"> + <id name="id"> + <generator class="sequence"/> + </id> + <property name="name"/> + <many-to-one name="parent" class="Parent" column="parent_id" not-null="true"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + 请注意<literal>NOT NULL</literal>的约束: + </para> + + <programlisting><![CDATA[create table parent ( id bigint not null primary key ) +create table child ( id bigint not null + primary key, + name varchar(255), + parent_id bigint not null ) +alter table child add constraint childfk0 (parent_id) references parent]]></programlisting> + + + <para> + 另外，如果你绝对坚持这个关联应该是单向的，你可以对<literal>&lt;key&gt;</literal>映射声明<literal>NOT NULL</literal>约束： + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Parent"> + <id name="id"> + <generator class="sequence"/> + </id> + <set name="children"> + <key column="parent_id" not-null="true"/> + <one-to-many class="Child"/> + </set> + </class> + + <class name="Child"> + <id name="id"> + <generator class="sequence"/> + </id> + <property name="name"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + 另外一方面,如果一个子实例可能有多个父实例, 那么就应该使用many-to-many关联： + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Parent"> + <id name="id"> + <generator class="sequence"/> + </id> + <set name="children" table="childset"> + <key column="parent_id"/> + <many-to-many class="Child" column="child_id"/> + </set> + </class> + + <class name="Child"> + <id name="id"> + <generator class="sequence"/> + </id> + <property name="name"/> + </class> + +</hibernate-mapping>]]></programlisting> + <para> + 表定义： + </para> + + <programlisting><![CDATA[create table parent ( id bigint not null primary key ) +create table child ( id bigint not null primary key, name varchar(255) ) +create table childset ( parent_id bigint not null, + child_id bigint not null, + primary key ( parent_id, child_id ) ) +alter table childset add constraint childsetfk0 (parent_id) references parent +alter table childset add constraint childsetfk1 (child_id) references child]]></programlisting> + + <para> + 更多的例子,以及一个完整的父/子关系映射的排练,请参阅<xref linkend="example-parentchild"/>. + </para> + + <para> + 甚至可能出现更加复杂的关联映射,我们会在下一章中列出所有可能性。 + </para> + + </sect1> + + </chapter> Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/component_mapping.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/component_mapping.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/component_mapping.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/component_mapping.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,339 @@ +<chapter id="components"> + <title>组件（Component）映射</title> + + <para> + <emphasis>组件</emphasis>(Component)这个概念在Hibernate中几处不同的地方为了不同的目的被重复使用. + </para> + + <sect1 id="components-dependentobjects" revision="2"> + <title>依赖对象（Dependent objects）</title> + + <para> + 组件(Component)是一个被包含的对象，在持久化的过程中，它被当作值类型，而并非一个实体的引用。在这篇文档中，组件这一术语指的是面向对象的合成概念（而并不是系统构架层次上的组件的概念）。举个例子, 你对人(Person)这个概念可以像下面这样来建模： + </para> + + <programlisting><![CDATA[public class Person { + private java.util.Date birthday; + private Name name; + private String key; + public String getKey() { + return key; + } + private void setKey(String key) { + this.key=key; + } + public java.util.Date getBirthday() { + return birthday; + } + public void setBirthday(java.util.Date birthday) { + this.birthday = birthday; + } + public Name getName() { + return name; + } + public void setName(Name name) { + this.name = name; + } + ...... + ...... +}]]></programlisting> + + <programlisting><![CDATA[public class Name { + char initial; + String first; + String last; + public String getFirst() { + return first; + } + void setFirst(String first) { + this.first = first; + } + public String getLast() { + return last; + } + void setLast(String last) { + this.last = last; + } + public char getInitial() { + return initial; + } + void setInitial(char initial) { + this.initial = initial; + } +}]]></programlisting> + + <para> + 在持久化的过程中,<literal>姓名(Name)</literal>可以作为<literal>人(Person)</literal>的一个组件。需要注意的是:你应该为<literal>姓名</literal>的持久化属性定义getter和setter方法,但是你不需要实现任何的接口或申明标识符字段。 + </para> + + <para> + 以下是这个例子的Hibernate映射文件: + </para> + + <programlisting><![CDATA[<class name="eg.Person" table="person"> + <id name="Key" column="pid" type="string"> + <generator class="uuid"/> + </id> + <property name="birthday" type="date"/> + <component name="Name" class="eg.Name"> <!-- class attribute optional --> + <property name="initial"/> + <property name="first"/> + <property name="last"/> + </component> +</class>]]></programlisting> + + <para> + 人员(Person)表中将包括<literal>pid</literal>, + <literal>birthday</literal>, + <literal>initial</literal>, + <literal>first</literal>和 + <literal>last</literal>等字段。</para> + + <para> + 就像所有的值类型一样, 组件不支持共享引用。 + 换句话说，两个人可能重名，但是两个Person对象应该包含两个独立的Name对象，只不过这两个Name对象具有“同样”的值。 + 组件的值可以为空，其定义如下。 + 每当Hibernate重新加载一个包含组件的对象,如果该组件的所有字段为空，Hibernate将假定整个组件为空。 + 在大多数情况下,这样假定应该是没有问题的。 + </para> + + <para> + 组件的属性可以是任意一种Hibernate类型（包括集合, 多对多关联， + 以及其它组件等等）。嵌套组件不应该被当作一种特殊的应用(Nested components should not be considered an + exotic usage)。 Hibernate倾向于支持细致的(fine-grained)对象模型。 + </para> + + <para> + <literal>&lt;component&gt;</literal> 元素还允许有 <literal>&lt;parent&gt;</literal>子元素，用来表明component类中的一个属性是指向包含它的实体的引用。 + </para> + + <programlisting><![CDATA[<class name="eg.Person" table="person"> + <id name="Key" column="pid" type="string"> + <generator class="uuid"/> + </id> + <property name="birthday" type="date"> + <component name="Name" class="eg.Name" unique="true"> + <parent name="namedPerson"/> <!-- reference back to the Person --> + <property name="initial"/> + <property name="first"/> + <property name="last"/> + </component&gt; +</class>]]></programlisting> + + </sect1> + + <sect1 id="components-incollections" revision="1"> + <title>在集合中出现的依赖对象 (Collections of dependent objects)</title> + + <para> + Hibernate支持组件的集合(例如: 一个元素是姓名(Name)这种类型的数组)。 + 你可以使用<literal>&lt;composite-element&gt;</literal>标签替代<literal>&lt;element&gt;</literal>标签来定义你的组件集合。 + </para> + + <programlisting><![CDATA[<set name="someNames" table="some_names" lazy="true"> + <key column="id"/&gt; + <composite-element class="eg.Name"> <!-- class attribute required --> + <property name="initial"/> + <property name="first"/> + <property name="last"/>; + </composite-element> +</set>]]></programlisting> + + <para> + 注意，如果你定义的Set包含组合元素(composite-element)，正确地实现<literal>equals()</literal>和<literal>hashCode()</literal>是非常重要的。 + </para> + + <para> + 组合元素可以包含组件，但是不能包含集合。如果你的组合元素自身包含组件, 你必须使用<literal>&lt;nested-composite-element&gt;</literal>标签。这是一个相当特殊的案例 - 在一个组件的集合里，那些组件本身又可以包含其他的组件。这个时候你就应该考虑一下使用one-to-many关联是否会更恰当。 + 尝试对这个组合元素重新建模为一个实体－但是需要注意的是，虽然Java模型和重新建模前是一样的，关系模型和持久性语义会有细微的变化。 + </para> + + <para> + 请注意如果你使用<literal>&lt;set&gt;</literal>标签,一个组合元素的映射不支持可能为空的属性. 当删除对象时， Hibernate必须使用每一个字段的值来确定一条记录(在组合元素表中，没有单独的关键字段)， + 如果有为null的字段，这样做就不可能了。你必须作出一个选择，要么在组合元素中使用不能为空的属性，要么选择使用<literal>&lt;list&gt;</literal>,<literal>&lt;map&gt;</literal>,<literal>&lt;bag&gt;</literal> 或者 <literal>&lt;idbag&gt;</literal>而不是 <literal>&lt;set&gt;</literal>。 + </para> + + <para> + 组合元素有个特别的用法是它可以包含一个<literal>&lt;many-to-one&gt;</literal>元素。类似这样的映射允许你将一个many-to-many关联表映射为组合元素的集合。(A mapping like this allows you to map extra columns of a many-to-many association table to the composite element class.) 接下来的的例子是从<literal>Order</literal>到<literal>Item</literal>的一个多对多的关联关系, 关联属性是 <literal>purchaseDate</literal>, <literal>price</literal> 和 <literal>quantity</literal> 。 + </para> + + <programlisting><![CDATA[<class name="eg.Order" .... > + .... + <set name="purchasedItems" table="purchase_items" lazy="true"> + <key column="order_id"> + <composite-element class="eg.Purchase"> + <property name="purchaseDate"/> + <property name="price"/> + <property name="quantity"/> + <many-to-one name="item" class="eg.Item"/> <!-- class attribute is optional --> + </composite-element> + </set> +</class>]]></programlisting> + <para> + 当然，当你定义Item时，你无法引用这些purchase，因此你无法实现双向关联查询。记住组件是值类型，并且不允许共享引用。某一个特定的<literal>Purchase</literal> 可以放在<literal>Order</literal>的集合中，但它不能同时被<literal>Item</literal>所引用。 + </para> + + <para>其实组合元素的这个用法可以扩展到三重或多重关联:</para> + + <programlisting><![CDATA[<class name="eg.Order" .... > + .... + <set name="purchasedItems" table="purchase_items" lazy="true"> + <key column="order_id"> + <composite-element class="eg.OrderLine"> + <many-to-one name="purchaseDetails" class="eg.Purchase"/> + <many-to-one name="item" class="eg.Item"/> + </composite-element> + </set> +</class>]]></programlisting> + + <para> + 在查询中，表达组合元素的语法和关联到其他实体的语法是一样的。 + </para> + + </sect1> + + <sect1 id="components-asmapindex"> + <title>组件作为Map的索引（Components as Map indices ）</title> + + <para> + <literal>&lt;composite-map-key&gt;</literal>元素允许你映射一个组件类作为一个<literal>Map</literal>的key，前提是你必须正确的在这个类中重写了<literal>hashCode()</literal> 和 <literal>equals()</literal>方法。 + </para> + </sect1> + + <sect1 id="components-compositeid" revision="1"> + <title>组件作为联合标识符(Components as composite identifiers)</title> + + <para> + 你可以使用一个组件作为一个实体类的标识符。 你的组件类必须满足以下要求： + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + 它必须实现<literal>java.io.Serializable</literal>接口 + </para> + </listitem> + <listitem> + <para> + 它必须重新实现<literal>equals()</literal>和<literal>hashCode()</literal>方法, 始终和组合关键字在数据库中的概念保持一致 + </para> + </listitem> + </itemizedlist> + + <para> + <emphasis>注意：在Hibernate3中，第二个要求并非是Hibernate强制必须的。但最好这样做。</emphasis> + </para> + + <para> + 你不能使用一个<literal>IdentifierGenerator</literal>产生组合关键字。一个应用程序必须分配它自己的标识符。 + </para> + + <para> + 使用<literal>&lt;composite-id&gt;</literal> 标签(并且内嵌<literal>&lt;key-property&gt;</literal>元素)代替通常的<literal>&lt;id&gt;</literal>标签。比如,<literal>OrderLine</literal>类具有一个主键，这个主键依赖于<literal>Order</literal>的(联合)主键。 + </para> + + <programlisting><![CDATA[<class name="OrderLine"> + + <composite-id name="id" class="OrderLineId"> + <key-property name="lineId"/> + <key-property name="orderId"/> + <key-property name="customerId"/> + </composite-id> + + <property name="name"/> + + <many-to-one name="order" class="Order" + insert="false" update="false"> + <column name="orderId"/> + <column name="customerId"/> + </many-to-one> + .... + +</class>]]></programlisting> + + <para> + 现在，任何指向<literal>OrderLine</literal>的外键都是复合的。在你的映射文件中，必须为其他类也这样声明。例如，一个指向<literal>OrderLine</literal>的关联可能被这样映射： + </para> + + <programlisting><![CDATA[<many-to-one name="orderLine" class="OrderLine"> +<!-- the "class" attribute is optional, as usual --> + <column name="lineId"/> + <column name="orderId"/> + <column name="customerId"/> +</many-to-one>]]></programlisting> + + <para> + （注意在各个地方<literal>&lt;column&gt;</literal>标签都是<literal>column</literal>属性的替代写法。） + </para> + + <para> + 指向<literal>OrderLine</literal>的<literal>多对多</literal>关联也使用联合外键: + </para> + + <programlisting><![CDATA[<set name="undeliveredOrderLines"> + <key column name="warehouseId"/> + <many-to-many class="OrderLine"> + <column name="lineId"/> + <column name="orderId"/> + <column name="customerId"/> + </many-to-many> +</set>]]></programlisting> + + <para> + 在<literal>Order</literal>中,<literal>OrderLine</literal>的集合则是这样: + </para> + + <programlisting><![CDATA[<set name="orderLines" inverse="true"> + <key> + <column name="orderId"/> + <column name="customerId"/> + </key> + <one-to-many class="OrderLine"/> +</set>]]></programlisting> + + <para> + (与通常一样,<literal>&lt;one-to-many&gt;</literal>元素不声明任何列.) + </para> + + <para> + 假若<literal>OrderLine</literal>本身拥有一个集合,它也具有组合外键。 + </para> + + <programlisting><![CDATA[<class name="OrderLine"> + .... + .... + <list name="deliveryAttempts"> + <key> <!-- a collection inherits the composite key type --> + <column name="lineId"/> + <column name="orderId"/> + <column name="customerId"/> + </key> + <list-index column="attemptId" base="1"/> + <composite-element class="DeliveryAttempt"> + ... + </composite-element> + </set> +</class>]]></programlisting> + + </sect1> + + <sect1 id="components-dynamic" revision="1"> + <title>动态组件 （Dynamic components）</title> + + <para> + 你甚至可以映射<literal>Map</literal>类型的属性： + </para> + + <programlisting><![CDATA[<dynamic-component name="userAttributes"> + <property name="foo" column="FOO" type="string"/> + <property name="bar" column="BAR" type="integer"/> + <many-to-one name="baz" class="Baz" column="BAZ_ID"/> +</dynamic-component>]]></programlisting> + + <para> + 从<literal>&lt;dynamic-component&gt;</literal>映射的语义上来讲，它和<literal>&lt;component&gt;</literal>是相同的。 + 这种映射类型的优点在于通过修改映射文件，就可以具有在部署时检测真实属性的能力。利用一个DOM解析器，也可以在程序运行时操作映射文件。 + 更好的是，你可以通过<literal>Configuration</literal>对象来访问（或者修改）Hibernate的运行时元模型。 + </para> + </sect1> +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/configuration.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/configuration.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/configuration.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/configuration.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,1694 @@ +<chapter id="session-configuration" revision="1"> + + <title> + 配置 + </title> + + <para> + 由于Hibernate是为了能在各种不同环境下工作而设计的, 因此存在着大量的配置参数. 幸运的是多数配置参数都 + 有比较直观的默认值, 并有随Hibernate一同分发的配置样例<literal>hibernate.properties</literal> + (位于<literal>etc/</literal>)来展示各种配置选项. 所需做的仅仅是将这个样例文件复制到类路径 + (classpath)下并做一些自定义的修改. + </para> + + <sect1 id="configuration-programmatic" revision="1"> + <title> + 可编程的配置方式 + </title> + + <para> + 一个<literal>org.hibernate.cfg.Configuration</literal>实例代表了一个应用程序中Java类型 + 到SQL数据库映射的完整集合. <literal>Configuration</literal>被用来构建一个(不可变的 + (immutable))<literal>SessionFactory</literal>. 映射定义则由不同的XML映射定义文件编译而来. + </para> + + <para> + 你可以直接实例化<literal>Configuration</literal>来获取一个实例，并为它指定XML映射定义 + 文件. 如果映射定 + 义文件在类路径(classpath)中, 请使用<literal>addResource()</literal>: + </para> + + <programlisting><![CDATA[Configuration cfg = new Configuration() + .addResource("Item.hbm.xml") + .addResource("Bid.hbm.xml");]]></programlisting> + + <para> + 一个替代方法（有时是更好的选择）是，指定被映射的类，让Hibernate帮你寻找映射定义文件: + </para> + + <programlisting><![CDATA[Configuration cfg = new Configuration() + .addClass(org.hibernate.auction.Item.class) + .addClass(org.hibernate.auction.Bid.class);]]></programlisting> + + <para> + Hibernate将会在类路径(classpath)中寻找名字为 + <literal>/org/hibernate/auction/Item.hbm.xml</literal>和 + <literal>/org/hibernate/auction/Bid.hbm.xml</literal>映射定义文件. + 这种方式消除了任何对文件名的硬编码(hardcoded). + </para> + + <para> + <literal>Configuration</literal>也允许你指定配置属性: + </para> + + <programlisting><![CDATA[Configuration cfg = new Configuration() + .addClass(org.hibernate.auction.Item.class) + .addClass(org.hibernate.auction.Bid.class) + .setProperty("hibernate.dialect", "org.hibernate.dialect.MySQLInnoDBDialect") + .setProperty("hibernate.connection.datasource", "java:comp/env/jdbc/test") + .setProperty("hibernate.order_updates", "true");]]></programlisting> + + <para> + 当然这不是唯一的传递Hibernate配置属性的方式, 其他可选方式还包括: + </para> + + <orderedlist spacing="compact"> + <listitem> + <para> + 传一个<literal>java.util.Properties</literal>实例给 + <literal>Configuration.setProperties()</literal>. + </para> + </listitem> + <listitem> + <para> + 将<literal>hibernate.properties</literal>放置在类路径(classpath)的根目录下 + (root directory). + </para> + </listitem> + <listitem> + <para> + 通过<literal>java -Dproperty=value</literal>来设置系统 + (<literal>System</literal>)属性. + </para> + </listitem> + <listitem> + <para> + 在<literal>hibernate.cfg.xml</literal>中加入元素 + <literal>&lt;property&gt;</literal> (稍后讨论). + </para> + </listitem> + </orderedlist> + + <para> + 如果想尽快体验Hibernate, <literal>hibernate.properties</literal>是最简单的方式. + </para> + + <para> + <literal>Configuration</literal>实例被设计成启动期间（startup-time）对象, + 一旦<literal>SessionFactory</literal>创建完成它就被丢弃了. + </para> + + </sect1> + + <sect1 id="configuration-sessionfactory"> + <title> + 获得SessionFactory + </title> + + + <para> + 当所有映射定义被<literal>Configuration</literal>解析后, + 应用程序必须获得一个用于构造<literal>Session</literal>实例的工厂. + 这个工厂将被应用程序的所有线程共享: + </para> + + <programlisting><![CDATA[SessionFactory sessions = cfg.buildSessionFactory();]]></programlisting> + + <para> + Hibernate允许你的应用程序创建多个<literal>SessionFactory</literal>实例. 这对 + 使用多个数据库的应用来说很有用. + </para> + + </sect1> + + <sect1 id="configuration-hibernatejdbc" revision="1"> + <title> + JDBC连接 + </title> + + <para> + 通常你希望<literal>SessionFactory</literal>来为你创建和缓存(pool)JDBC连接. 如果你采用这种方式, + 只需要如下例所示那样，打开一个<literal>Session</literal>: + </para> + + <programlisting><![CDATA[Session session = sessions.openSession(); // open a new Session]]></programlisting> + + <para> + 一旦你需要进行数据访问时, 就会从连接池(connection pool)获得一个JDBC连接. + </para> + + <para> + 为了使这种方式工作起来, 我们需要向Hibernate传递一些JDBC连接的属性. + 所有Hibernate属性的名字和语义都在<literal>org.hibernate.cfg.Environment</literal>中定义. + 我们现在将描述JDBC连接配置中最重要的设置. + </para> + + <para> + 如果你设置如下属性，Hibernate将使用<literal>java.sql.DriverManager</literal>来获得(和缓存)JDBC连接 : + </para> + + <table frame="topbot"> + <title> + Hibernate JDBC属性 + </title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry> + 属性名 + </entry> + <entry> + 用途 + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.connection.driver_class</literal> + </entry> + <entry> + <emphasis>jdbc驱动类</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.url</literal> + </entry> + <entry> + <emphasis>jdbc URL</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.username</literal> + </entry> + <entry> + <emphasis>数据库用户</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.password</literal> + </entry> + <entry> + <emphasis>数据库用户密码</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.pool_size</literal> + </entry> + <entry> + <emphasis>连接池容量上限数目</emphasis> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + 但Hibernate自带的连接池算法相当不成熟. + 它只是为了让你快些上手<emphasis>，并不适合用于产品系统</emphasis>或性能测试中。 + 出于最佳性能和稳定性考虑你应该使用第三方的连接池。只需要用特定连接池的设置替换 + <literal>hibernate.connection.pool_size</literal>即可。这将关闭Hibernate自带的连接池. + 例如, 你可能会想用C3P0. + </para> + + <para> + C3P0是一个随Hibernate一同分发的开源的JDBC连接池, 它位于<literal>lib</literal>目录下。 + 如果你设置了<literal>hibernate.c3p0.*</literal>相关的属性, Hibernate将使用 + <literal>C3P0ConnectionProvider</literal>来缓存JDBC连接. 如果你更原意使用Proxool, 请参考发 + 行包中的<literal>hibernate.properties</literal>并到Hibernate网站获取更多的信息. + </para> + + <para> + 这是一个使用C3P0的<literal>hibernate.properties</literal>样例文件: + </para> + + <programlisting id="c3p0-configuration" revision="1"><![CDATA[hibernate.connection.driver_class = org.postgresql.Driver +hibernate.connection.url = jdbc:postgresql://localhost/mydatabase +hibernate.connection.username = myuser +hibernate.connection.password = secret +hibernate.c3p0.min_size=5 +hibernate.c3p0.max_size=20 +hibernate.c3p0.timeout=1800 +hibernate.c3p0.max_statements=50 +hibernate.dialect = org.hibernate.dialect.PostgreSQLDialect]]></programlisting> + + <para> + 为了能在应用程序服务器(application server)中使用Hibernate, 应当总是将Hibernate + 配置成从注册在JNDI中的<literal>Datasource</literal>处获得连接，你至少需要设置下列属性中的一个: + </para> + + <table frame="topbot"> + <title> + Hibernate数据源属性 + </title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry> + 属性名 + </entry> + <entry> + 用途 + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.connection.datasource</literal> + </entry> + <entry> + <emphasis>数据源JNDI名字</emphasis> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jndi.url</literal> + </entry> + <entry> + <emphasis>JNDI提供者的URL</emphasis> (可选) + </entry> + </row> + <row> + <entry> + <literal>hibernate.jndi.class</literal> + </entry> + <entry> + <emphasis>JNDI <literal>InitialContextFactory</literal>类</emphasis> (可选) + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.username</literal> + </entry> + <entry> + <emphasis>数据库用户</emphasis> (可选) + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.password</literal> + </entry> + <entry> + <emphasis>数据库用户密码</emphasis> (可选) + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + 这是一个使用应用程序服务器提供的JNDI数据源的<literal>hibernate.properties</literal>样例文件: + </para> + + <programlisting><![CDATA[hibernate.connection.datasource = java:/comp/env/jdbc/test +hibernate.transaction.factory_class = \ + org.hibernate.transaction.JTATransactionFactory +hibernate.transaction.manager_lookup_class = \ + org.hibernate.transaction.JBossTransactionManagerLookup +hibernate.dialect = org.hibernate.dialect.PostgreSQLDialect]]></programlisting> + + <para> + 从JNDI数据源获得的JDBC连接将自动参与到应用程序服务器中容器管理的事务(container-managed transactions)中去. + </para> + + <para> + 任何连接(connection)属性的属性名都要以"<literal>hibernate.connnection</literal>"开头. + 例如, 你可能会使用<literal>hibernate.connection.charSet</literal>来指定字符集<literal>charSet</literal>. + </para> + + <para> + 通过实现<literal>org.hibernate.connection.ConnectionProvider</literal>接口，你可以定义属于 + 你自己的获得JDBC连接的插件策略。通过设置<literal>hibernate.connection.provider_class</literal>， + 你可以选择一个自定义的实现. + </para> + + </sect1> + + <sect1 id="configuration-optional" revision="1"> + <title> + 可选的配置属性 + </title> + + <para> + 有大量属性能用来控制Hibernate在运行期的行为. 它们都是可选的, 并拥有适当的默认值. + </para> + + <para> + <emphasis>警告: 其中一些属性是"系统级(system-level)的".</emphasis> + 系统级属性只能通过<literal>java -Dproperty=value</literal>或 + <literal>hibernate.properties</literal>来设置, 而<emphasis>不能</emphasis>用上面描述的其他方法来设置. + </para> + + <table frame="topbot" id="configuration-optional-properties" revision="8"> + <title> + Hibernate配置属性 + </title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry> + 属性名 + </entry> + <entry> + 用途 + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.dialect</literal> + </entry> + <entry> + 一个Hibernate <literal>Dialect</literal>类名允许Hibernate针对特定的关系数据库生成优化的SQL. + <para> + <emphasis role="strong">取值</emphasis> + <literal>full.classname.of.Dialect</literal> + + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.show_sql</literal> + </entry> + <entry> + 输出所有SQL语句到控制台. + 有一个另外的选择是把<literal>org.hibernate.SQL</literal>这个log category设为<literal>debug</literal>。 + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.format_sql</literal> + </entry> + <entry> + 在log和console中打印出更漂亮的SQL。 + <para> + <emphasis role="strong">取值</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.default_schema</literal> + </entry> + <entry> + 在生成的SQL中, 将给定的schema/tablespace附加于非全限定名的表名上. + <para> + <emphasis role="strong">取值</emphasis> + <literal>SCHEMA_NAME</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.default_catalog</literal> + </entry> + <entry> + 在生成的SQL中, 将给定的catalog附加于非全限定名的表名上. + <para> + <emphasis role="strong">取值</emphasis> + <literal>CATALOG_NAME</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.session_factory_name</literal> + </entry> + <entry> + <literal>SessionFactory</literal>创建后，将自动使用这个名字绑定到JNDI中. + <para> + <emphasis role="strong">取值</emphasis> + <literal>jndi/composite/name</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.max_fetch_depth</literal> + </entry> + <entry> + 为单向关联(一对一, 多对一)的外连接抓取（outer join fetch）树设置最大深度. + 值为<literal>0</literal>意味着将关闭默认的外连接抓取. + <para> + <emphasis role="strong">取值</emphasis> + 建议在<literal>0</literal>到<literal>3</literal>之间取值 + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.default_batch_fetch_size</literal> + </entry> + <entry> + 为Hibernate关联的批量抓取设置默认数量. + <para> + <emphasis role="strong">取值</emphasis> + 建议的取值为<literal>4</literal>, <literal>8</literal>, + 和<literal>16</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.default_entity_mode</literal> + </entry> + <entry> + 为由这个<literal>SessionFactory</literal>打开的所有Session指定默认的实体表现模式. + <para> + <emphasis role="strong">取值</emphasis> + <literal>dynamic-map</literal>, <literal>dom4j</literal>, + <literal>pojo</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.order_updates</literal> + </entry> + <entry> + 强制Hibernate按照被更新数据的主键，为SQL更新排序。这么做将减少在高并发系统中事务的死锁。 + <para> + <emphasis role="strong">取值</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.generate_statistics</literal> + </entry> + <entry> + 如果开启, Hibernate将收集有助于性能调节的统计数据. + <para> + <emphasis role="strong">取值</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.use_identifer_rollback</literal> + </entry> + <entry> + 如果开启, 在对象被删除时生成的标识属性将被重设为默认值. + <para> + <emphasis role="strong">取值</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.use_sql_comments</literal> + </entry> + <entry> + 如果开启, Hibernate将在SQL中生成有助于调试的注释信息, 默认值为<literal>false</literal>. + <para> + <emphasis role="strong">取值</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table frame="topbot" id="configuration-jdbc-properties" revision="8"> + <title> + Hibernate JDBC和连接(connection)属性 + </title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry> + 属性名 + </entry> + <entry> + 用途 + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.jdbc.fetch_size</literal> + </entry> + <entry> + 非零值，指定JDBC抓取数量的大小 (调用<literal>Statement.setFetchSize()</literal>). + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.batch_size</literal> + </entry> + <entry> + 非零值，允许Hibernate使用JDBC2的批量更新. + <para> + <emphasis role="strong">取值</emphasis> + 建议取<literal>5</literal>到<literal>30</literal>之间的值 + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.batch_versioned_data</literal> + </entry> + <entry> + 如果你想让你的JDBC驱动从<literal>executeBatch()</literal>返回正确的行计数 , + 那么将此属性设为<literal>true</literal>(开启这个选项通常是安全的). + 同时，Hibernate将为自动版本化的数据使用批量DML. 默认值为<literal>false</literal>. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.factory_class</literal> + </entry> + <entry> + 选择一个自定义的<literal>Batcher</literal>. 多数应用程序不需要这个配置属性. + <para> + <emphasis role="strong">eg.</emphasis> + <literal>classname.of.BatcherFactory</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.use_scrollable_resultset</literal> + </entry> + <entry> + 允许Hibernate使用JDBC2的可滚动结果集. + 只有在使用用户提供的JDBC连接时，这个选项才是必要的, + 否则Hibernate会使用连接的元数据. + <para> + <emphasis role="strong">取值</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.use_streams_for_binary</literal> + </entry> + <entry> + 在JDBC读写<literal>binary (二进制)</literal>或<literal>serializable (可序列化)</literal> + 的类型时使用流(stream)(系统级属性). + <para> + <emphasis role="strong">取值</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.jdbc.use_get_generated_keys</literal> + </entry> + <entry> + 在数据插入数据库之后，允许使用JDBC3 <literal>PreparedStatement.getGeneratedKeys()</literal> + 来获取数据库生成的key(键)。需要JDBC3+驱动和JRE1.4+, 如果你的数据库驱动在使用Hibernate的标 + 识生成器时遇到问题，请将此值设为false. 默认情况下将使用连接的元数据来判定驱动的能力. + <para> + <emphasis role="strong">取值</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.provider_class</literal> + </entry> + <entry> + 自定义<literal>ConnectionProvider</literal>的类名, 此类用来向Hibernate提供JDBC连接. + <para> + <emphasis role="strong">取值</emphasis> + <literal>classname.of.ConnectionProvider</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.isolation</literal> + </entry> + <entry> + 设置JDBC事务隔离级别. 查看<literal>java.sql.Connection</literal>来了解各个值的具体意义, + 但请注意多数数据库都不支持所有的隔离级别. + <para> + <emphasis role="strong">取值</emphasis> + <literal>1, 2, 4, 8</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.autocommit</literal> + </entry> + <entry> + 允许被缓存的JDBC连接开启自动提交(autocommit) (不建议). + <para> + <emphasis role="strong">取值</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.release_mode</literal> + </entry> + <entry> + 指定Hibernate在何时释放JDBC连接. 默认情况下,直到Session被显式关闭或被断开连接时,才会释放JDBC连接. + 对于应用程序服务器的JTA数据源, 你应当使用<literal>after_statement</literal>, 这样在每次JDBC调用后，都会主动的释放连接. + 对于非JTA的连接, 使用<literal>after_transaction</literal>在每个事务结束时释放连接是合理的. + <literal>auto</literal>将为JTA和CMT事务策略选择<literal>after_statement</literal>, + 为JDBC事务策略选择<literal>after_transaction</literal>. + <para> + <emphasis role="strong">取值</emphasis> + <literal>auto</literal> (默认) | <literal>on_close</literal> | + <literal>after_transaction</literal> | <literal>after_statement</literal> + </para> + <para> + + 注意,这些设置仅对通过<literal>SessionFactory.openSession</literal>得到的<literal>Session</literal>起作用。对于通过<literal>SessionFactory.getCurrentSession</literal>得到的<literal>Session</literal>，所配置的<literal>CurrentSessionContext</literal>实现控制这些<literal>Session</literal>的连接释放模式。请参阅<xref linkend="architecture-current-session"/>。 + </para> + + + </entry> + </row> + <row> + <entry> + <literal>hibernate.connection.<emphasis>&lt;propertyName&gt;</emphasis></literal> + </entry> + <entry> + 将JDBC属性<literal>propertyName</literal>传递到<literal>DriverManager.getConnection()</literal>中去. + </entry> + </row> + <row> + <entry> + <literal>hibernate.jndi.<emphasis>&lt;propertyName&gt;</emphasis></literal> + </entry> + <entry> + 将属性<literal>propertyName</literal>传递到JNDI <literal>InitialContextFactory</literal>中去. + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table frame="topbot" id="configuration-cache-properties" revision="7"> + <title> + Hibernate缓存属性 + </title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry> + 属性名 + </entry> + <entry> + 用途 + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.cache.provider_class</literal> + </entry> + <entry> + 自定义的<literal>CacheProvider</literal>的类名. + <para> + <emphasis role="strong">取值</emphasis> + <literal>classname.of.CacheProvider</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.use_minimal_puts</literal> + </entry> + <entry> + 以频繁的读操作为代价, 优化二级缓存来最小化写操作. 在Hibernate3中，这个设置对的集群缓存非常有用, + 对集群缓存的实现而言，默认是开启的. + <para> + <emphasis role="strong">取值</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.use_query_cache</literal> + </entry> + <entry> + 允许查询缓存, 个别查询仍然需要被设置为可缓存的. + <para> + <emphasis role="strong">取值</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.use_second_level_cache</literal> + </entry> + <entry> + 能用来完全禁止使用二级缓存. 对那些在类的映射定义中指定<literal>&lt;cache&gt;</literal>的类，会默认开启二级缓存. + <para> + <emphasis role="strong">取值</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.query_cache_factory</literal> + </entry> + <entry> + 自定义实现<literal>QueryCache</literal>接口的类名, + 默认为内建的<literal>StandardQueryCache</literal>. + <para> + <emphasis role="strong">取值</emphasis> + <literal>classname.of.QueryCache</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.region_prefix</literal> + </entry> + <entry> + 二级缓存区域名的前缀. + <para> + <emphasis role="strong">取值</emphasis> + <literal>prefix</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cache.use_structured_entries</literal> + </entry> + <entry> + 强制Hibernate以更人性化的格式将数据存入二级缓存. + <para> + <emphasis role="strong">取值</emphasis> + <literal>true|false</literal> + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table frame="topbot" id="configuration-transaction-properties" revision="9"> + <title> + Hibernate事务属性 + </title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry> + 属性名 + </entry> + <entry> + 用途 + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.transaction.factory_class</literal> + </entry> + <entry> + 一个<literal>TransactionFactory</literal>的类名, 用于Hibernate <literal>Transaction</literal> API + (默认为<literal>JDBCTransactionFactory</literal>). + <para> + <emphasis role="strong">取值</emphasis> + <literal>classname.of.TransactionFactory</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>jta.UserTransaction</literal> + </entry> + <entry> + 一个JNDI名字，被<literal>JTATransactionFactory</literal>用来从应用服务器获取JTA <literal>UserTransaction</literal>. + <para> + <emphasis role="strong">取值</emphasis> + <literal>jndi/composite/name</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.transaction.manager_lookup_class</literal> + </entry> + <entry> + 一个<literal>TransactionManagerLookup</literal>的类名 + - 当使用JVM级缓存，或在JTA环境中使用hilo生成器的时候需要该类. + <para> + <emphasis role="strong">取值</emphasis> + <literal>classname.of.TransactionManagerLookup</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.transaction.flush_before_completion</literal> + </entry> + <entry> + 如果开启, session在事务完成后将被自动清洗(flush)。 现在更好的方法是使用自动session上下文管理。请参见<xref linkend="architecture-current-session"/>。 + <para> + <emphasis role="strong">取值</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.transaction.auto_close_session</literal> + </entry> + <entry> + 如果开启, session在事务完成后将被自动关闭。 现在更好的方法是使用自动session上下文管理。请参见<xref linkend="architecture-current-session"/>。 + <para> + <emphasis role="strong">取值</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <table frame="topbot" id="configuration-misc-properties" revision="10"> + <title> + 其他属性 + </title> + + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="1*"/> + <thead> + <row> + <entry> + 属性名 + </entry> + <entry> + 用途 + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <literal>hibernate.current_session_context_class</literal> + </entry> + <entry> + 为"当前" + <literal>Session</literal>指定一个(自定义的)策略。关于内置策略的详情，请参见<xref linkend="architecture-current-session"/> 。 + <para> + <emphasis role="strong">eg.</emphasis> + <literal>jta</literal> | <literal>thread</literal> | + <literal>managed</literal> | <literal>custom.Class</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.query.factory_class</literal> + </entry> + <entry> + 选择HQL解析器的实现. + <para> + <emphasis role="strong">取值</emphasis> + <literal>org.hibernate.hql.ast.ASTQueryTranslatorFactory</literal> or + <literal>org.hibernate.hql.classic.ClassicQueryTranslatorFactory</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.query.substitutions</literal> + </entry> + <entry> + 将Hibernate查询中的符号映射到SQL查询中的符号 + (符号可能是函数名或常量名字). + <para> + <emphasis role="strong">取值</emphasis> + <literal>hqlLiteral=SQL_LITERAL, hqlFunction=SQLFUNC</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.hbm2ddl.auto</literal> + </entry> + <entry> + 在<literal>SessionFactory</literal>创建时，自动检查数据库结构，或者将数据库schema的DDL导出到数据库. 使用 + <literal>create-drop</literal>时,在显式关闭<literal>SessionFactory</literal>时，将drop掉数据库schema. + <para> + <emphasis role="strong">取值</emphasis> + <literal>validate</literal> | <literal>update</literal> | + <literal>create</literal> | <literal>create-drop</literal> + </para> + </entry> + </row> + <row> + <entry> + <literal>hibernate.cglib.use_reflection_optimizer</literal> + </entry> + <entry> + 开启CGLIB来替代运行时反射机制(系统级属性). 反射机制有时在除错时比较有用. + 注意即使关闭这个优化, Hibernate还是需要CGLIB. 你不能在<literal>hibernate.cfg.xml</literal>中设置此属性. + <para> + <emphasis role="strong">取值</emphasis> + <literal>true</literal> | <literal>false</literal> + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <sect2 id="configuration-optional-dialects" revision="1"> + <title> + SQL方言 + </title> + + <para> + 你应当总是为你的数据库将<literal>hibernate.dialect</literal>属性设置成正确的 + <literal>org.hibernate.dialect.Dialect</literal>子类. 如果你指定一种方言, + Hibernate将为上面列出的一些属性使用合理的默认值, 为你省去了手工指定它们的功夫. + </para> + + <table frame="topbot" id="sql-dialects" revision="2"> + <title> + Hibernate SQL方言 (<literal>hibernate.dialect</literal>) + </title> + <tgroup cols="2"> + <colspec colwidth="1*"/> + <colspec colwidth="2.5*"/> + <thead> + <row> + <entry>RDBMS</entry> + <entry> + 方言 + </entry> + </row> + </thead> + <tbody> + <row> + <entry>DB2</entry> <entry><literal>org.hibernate.dialect.DB2Dialect</literal></entry> + </row> + <row> + <entry>DB2 AS/400</entry> <entry><literal>org.hibernate.dialect.DB2400Dialect</literal></entry> + </row> + <row> + <entry>DB2 OS390</entry> <entry><literal>org.hibernate.dialect.DB2390Dialect</literal></entry> + </row> + <row> + <entry>PostgreSQL</entry> <entry><literal>org.hibernate.dialect.PostgreSQLDialect</literal></entry> + </row> + <row> + <entry>MySQL</entry> <entry><literal>org.hibernate.dialect.MySQLDialect</literal></entry> + </row> + <row> + <entry>MySQL with InnoDB</entry> <entry><literal>org.hibernate.dialect.MySQLInnoDBDialect</literal></entry> + </row> + <row> + <entry>MySQL with MyISAM</entry> <entry><literal>org.hibernate.dialect.MySQLMyISAMDialect</literal></entry> + </row> + <row> + <entry>Oracle (any version)</entry> <entry><literal>org.hibernate.dialect.OracleDialect</literal></entry> + </row> + <row> + <entry>Oracle 9i/10g</entry> <entry><literal>org.hibernate.dialect.Oracle9Dialect</literal></entry> + </row> + <row> + <entry>Sybase</entry> <entry><literal>org.hibernate.dialect.SybaseDialect</literal></entry> + </row> + <row> + <entry>Sybase Anywhere</entry> <entry><literal>org.hibernate.dialect.SybaseAnywhereDialect</literal></entry> + </row> + <row> + <entry>Microsoft SQL Server</entry> <entry><literal>org.hibernate.dialect.SQLServerDialect</literal></entry> + </row> + <row> + <entry>SAP DB</entry> <entry><literal>org.hibernate.dialect.SAPDBDialect</literal></entry> + </row> + <row> + <entry>Informix</entry> <entry><literal>org.hibernate.dialect.InformixDialect</literal></entry> + </row> + <row> + <entry>HypersonicSQL</entry> <entry><literal>org.hibernate.dialect.HSQLDialect</literal></entry> + </row> + <row> + <entry>Ingres</entry> <entry><literal>org.hibernate.dialect.IngresDialect</literal></entry> + </row> + <row> + <entry>Progress</entry> <entry><literal>org.hibernate.dialect.ProgressDialect</literal></entry> + </row> + <row> + <entry>Mckoi SQL</entry> <entry><literal>org.hibernate.dialect.MckoiDialect</literal></entry> + </row> + <row> + <entry>Interbase</entry> <entry><literal>org.hibernate.dialect.InterbaseDialect</literal></entry> + </row> + <row> + <entry>Pointbase</entry> <entry><literal>org.hibernate.dialect.PointbaseDialect</literal></entry> + </row> + <row> + <entry>FrontBase</entry> <entry><literal>org.hibernate.dialect.FrontbaseDialect</literal></entry> + </row> + <row> + <entry>Firebird</entry> <entry><literal>org.hibernate.dialect.FirebirdDialect</literal></entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + + <sect2 id="configuration-optional-outerjoin" revision="4"> + <title> + 外连接抓取(Outer Join Fetching) + </title> + + <para> + 如果你的数据库支持ANSI, Oracle或Sybase风格的外连接, <emphasis>外连接抓取</emphasis>通常能通过限制往返数据库次数 + (更多的工作交由数据库自己来完成)来提高效率. 外连接抓取允许在单个<literal>SELECT</literal>SQL语句中， + 通过many-to-one, one-to-many, many-to-many和one-to-one关联获取连接对象的整个对象图. + </para> + + <para> + 将<literal>hibernate.max_fetch_depth</literal>设为<literal>0</literal>能在<emphasis>全局</emphasis> + 范围内禁止外连接抓取. 设为<literal>1</literal>或更高值能启用one-to-one和many-to-oneouter关联的外连接抓取, 它们通过 + <literal>fetch="join"</literal>来映射. + </para> + + <para> + 参见<xref linkend="performance-fetching"/>获得更多信息. + </para> + + </sect2> + + <sect2 id="configuration-optional-binarystreams" revision="1"> + <title> + 二进制流 (Binary Streams) + </title> + + <para> + Oracle限制那些通过JDBC驱动传输的<literal>字节</literal>数组的数目. 如果你希望使用<literal>二进值 (binary)</literal>或 + <literal>可序列化的 (serializable)</literal>类型的大对象, 你应该开启 + <literal>hibernate.jdbc.use_streams_for_binary</literal>属性. + <emphasis>这是系统级属性.</emphasis> + </para> + + </sect2> + + <sect2 id="configuration-optional-cacheprovider" revision="2"> + <title> + 二级缓存与查询缓存 + </title> + + <para> + 以<literal>hibernate.cache</literal>为前缀的属性允许你在Hibernate中，使用进程或群集范围内的二级缓存系统. + 参见<xref linkend="performance-cache"/>获取更多的详情. + </para> + + </sect2> + + <sect2 id="configuration-optional-querysubstitution"> + <title> + 查询语言中的替换 + </title> + + <para> + 你可以使用<literal>hibernate.query.substitutions</literal>在Hibernate中定义新的查询符号. + 例如: + </para> + + <programlisting>hibernate.query.substitutions true=1, false=0</programlisting> + + <para> + 将导致符号<literal>true</literal>和<literal>false</literal>在生成的SQL中被翻译成整数常量. + </para> + + <programlisting>hibernate.query.substitutions toLowercase=LOWER</programlisting> + + <para> + 将允许你重命名SQL中的<literal>LOWER</literal>函数. + </para> + + </sect2> + + <sect2 id="configuration-optional-statistics" revision="2"> + <title> + Hibernate的统计(statistics)机制 + </title> + + <para> + 如果你开启<literal>hibernate.generate_statistics</literal>, 那么当你通过 + <literal>SessionFactory.getStatistics()</literal>调整正在运行的系统时，Hibernate将导出大量有用的数据. + Hibernate甚至能被配置成通过JMX导出这些统计信息. 参考<literal>org.hibernate.stats</literal>中接口的Javadoc，以获得更多信息. + </para> + + </sect2> + </sect1> + + <sect1 id="configuration-logging"> + <title> + 日志 + </title> + + <para> + Hibernate使用Apache commons-logging来为各种事件记录日志. + </para> + + <para> + commons-logging将直接输出到Apache Log4j(如果在类路径中包括<literal>log4j.jar</literal>)或 + JDK1.4 logging (如果运行在JDK1.4或以上的环境下). 你可以从<literal>http://jakarta.apache.org</literal> + 下载Log4j. 要使用Log4j，你需要将<literal>log4j.properties</literal>文件放置在类路径下, 随Hibernate + 一同分发的样例属性文件在<literal>src/</literal>目录下. + </para> + + <para> + 我们强烈建议你熟悉一下Hibernate的日志消息. 在不失可读性的前提下， + 我们做了很多工作，使Hibernate的日志可能地详细. 这是必要的查错利器. + 最令人感兴趣的日志分类有如下这些: + </para> + + <table frame="topbot" id="log-categories" revision="2"> + <title> + Hibernate日志类别 + </title> + <tgroup cols="2"> + <colspec colwidth="1*"/> + <colspec colwidth="2.5*"/> + <thead> + <row> + <entry> + 类别 + </entry> + <entry> + 功能 + </entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>org.hibernate.SQL</literal></entry> + <entry> + 在所有SQL DML语句被执行时为它们记录日志 + </entry> + </row> + <row> + <entry><literal>org.hibernate.type</literal></entry> + <entry> + 为所有JDBC参数记录日志 + </entry> + </row> + <row> + <entry><literal>org.hibernate.tool.hbm2ddl</literal></entry> + <entry> + 在所有SQL DDL语句执行时为它们记录日志 + </entry> + </row> + <row> + <entry><literal>org.hibernate.pretty</literal></entry> + <entry> + 在session清洗(flush)时，为所有与其关联的实体(最多20个)的状态记录日志 + </entry> + </row> + <row> + <entry><literal>org.hibernate.cache</literal></entry> + <entry> + 为所有二级缓存的活动记录日志 + </entry> + </row> + <row> + <entry><literal>org.hibernate.transaction</literal></entry> + <entry> + 为事务相关的活动记录日志 + </entry> + </row> + <row> + <entry><literal>org.hibernate.jdbc</literal></entry> + <entry> + 为所有JDBC资源的获取记录日志 + </entry> + </row> + <row> + <entry><literal>org.hibernate.hql.AST</literal></entry> + <entry> + 在解析查询的时候,记录HQL和SQL的AST分析日志 + </entry> + </row> + <row> + <entry><literal>org.hibernate.secure</literal></entry> + <entry> + 为JAAS认证请求做日志 + </entry> + </row> + <row> + <entry><literal>org.hibernate</literal></entry> + <entry> + 为任何Hibernate相关信息做日志 (信息量较大, 但对查错非常有帮助) + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + 在使用Hibernate开发应用程序时, 你应当总是为<literal>org.hibernate.SQL</literal> + 开启<literal>debug</literal>级别的日志记录,或者开启<literal>hibernate.show_sql</literal>属性。 + </para> + + </sect1> + + <sect1 id="configuration-namingstrategy"> + <title> + 实现<literal>NamingStrategy</literal> + </title> + + <para> + <literal>org.hibernate.cfg.NamingStrategy</literal>接口允许你为数据库中的对象和schema + 元素指定一个“命名标准”. + </para> + + <para> + 你可能会提供一些通过Java标识生成数据库标识或将映射定义文件中"逻辑"表/列名处理成"物理"表/列名的规则. + 这个特性有助于减少冗长的映射定义文件. + </para> + + <para> + 在加入映射定义前，你可以调用 + <literal>Configuration.setNamingStrategy()</literal>指定一个不同的命名策略: + </para> + + <programlisting><![CDATA[SessionFactory sf = new Configuration() + .setNamingStrategy(ImprovedNamingStrategy.INSTANCE) + .addFile("Item.hbm.xml") + .addFile("Bid.hbm.xml") + .buildSessionFactory();]]></programlisting> + + <para> + <literal>org.hibernate.cfg.ImprovedNamingStrategy</literal>是一个内建的命名策略, 对 + 一些应用程序而言，可能是非常有用的起点. + </para> + + </sect1> + + <sect1 id="configuration-xmlconfig" revision="2"> + <title> + XML配置文件 + </title> + + <para> + 另一个配置方法是在<literal>hibernate.cfg.xml</literal>文件中指定一套完整的配置. + 这个文件可以当成<literal>hibernate.properties</literal>的替代。 若两个文件同时存在，它将覆盖前者的属性. + </para> + + <para> + XML配置文件被默认是放在<literal>CLASSPATH</literal>的根目录下. 这是一个例子: + </para> + <para> + + </para> + + <programlisting><![CDATA[<?xml version='1.0' encoding='utf-8'?> +<!DOCTYPE hibernate-configuration PUBLIC + "-//Hibernate/Hibernate Configuration DTD//EN" + "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"> + +<hibernate-configuration> + + <!-- 以/jndi/name绑定到JNDI的SessionFactory实例 --> + <session-factory + name="java:hibernate/SessionFactory"> + + <!-- 属性 --> + <property name="connection.datasource">java:/comp/env/jdbc/MyDB</property> + <property name="dialect">org.hibernate.dialect.MySQLDialect</property> + <property name="show_sql">false</property> + <property name="transaction.factory_class"> + org.hibernate.transaction.JTATransactionFactory + </property> + <property name="jta.UserTransaction">java:comp/UserTransaction</property> + + <!-- 映射定义文件 --> + <mapping resource="org/hibernate/auction/Item.hbm.xml"/> + <mapping resource="org/hibernate/auction/Bid.hbm.xml"/> + + <!-- 缓存设置 --> + <class-cache class="org.hibernate.auction.Item" usage="read-write"/> + <class-cache class="org.hibernate.auction.Bid" usage="read-only"/> + <collection-cache collection="org.hibernate.auction.Item.bids" usage="read-write"/> + + </session-factory> + +</hibernate-configuration>]]></programlisting> + + <para> + 如你所见, 这个方法优势在于，在配置文件中指出了映射定义文件的名字. 一旦你需要调整Hibernate的缓存， + <literal>hibernate.cfg.xml</literal>也是更方便. 注意，使用<literal>hibernate.properties</literal>还是 + <literal>hibernate.cfg.xml</literal>完全是由你来决定, 除了上面提到的XML语法的优势之外, 两者是等价的. + </para> + + <para> + 使用XML配置，使得启动Hibernate变的异常简单, 如下所示，一行代码就可以搞定： + </para> + + <programlisting><![CDATA[SessionFactory sf = new Configuration().configure().buildSessionFactory();]]></programlisting> + + <para> + 你可以使用如下代码来添加一个不同的XML配置文件 + </para> + + <programlisting><![CDATA[SessionFactory sf = new Configuration() + .configure("catdb.cfg.xml") + .buildSessionFactory();]]></programlisting> + + </sect1> + + <sect1 id="configuration-j2ee" revision="1"> + <title> + J2EE应用程序服务器的集成 + </title> + + <para> + 针对J2EE体系,Hibernate有如下几个集成的方面: + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>容器管理的数据源(Container-managed datasources)</emphasis>: + Hibernate能使用通过容器管理，并由JNDI提供的JDBC连接. 通常, 特别是当处理多个数据源的分布式事务的时候, + 由一个JTA兼容的<literal>TransactionManager</literal>和一个 + <literal>ResourceManager</literal>来处理事务管理(CMT, 容器管理的事务). 当然你可以通过 + 编程方式来划分事务边界(BMT, Bean管理的事务). 或者为了代码的可移植性，你也也许会想使用可选的 + Hibernate <literal>Transaction</literal> API. + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + <emphasis>自动JNDI绑定</emphasis>: Hibernate可以在启动后将 + <literal>SessionFactory</literal>绑定到JNDI. + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + <emphasis>JTA Session绑定:</emphasis> Hibernate <literal>Session</literal> + 可以自动绑定到JTA事务作用的范围. 只需简单地从JNDI查找<literal>SessionFactory</literal>并获得当前的 + <literal>Session</literal>. 当JTA事务完成时, 让Hibernate来处理 + <literal>Session</literal>的清洗(flush)与关闭. 事务的划分可以是声明式的(CMT),也可以是编程式的(BMT/UserTransaction). + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + <emphasis>JMX部署:</emphasis> 如果你使用支持JMX应用程序服务器(如, JBoss AS), 那么你可以选择将Hibernate部署成托管MBean. + 这将为你省去一行从<literal>Configuration</literal>构建<literal>SessionFactory</literal>的启动代码. + 容器将启动你的<literal>HibernateService</literal>, 并完美地处理好服务间的依赖关系 (在Hibernate启动前，数据源必须是可用的，等等). + </para> + </listitem> + </itemizedlist> + <para> + 如果应用程序服务器抛出"connection containment"异常, 根据你的环境，也许该将配置属性 + <literal>hibernate.connection.release_mode</literal>设为<literal>after_statement</literal>. + </para> + <sect2 id="configuration-optional-transactionstrategy" revision="3"> + <title> + 事务策略配置 + </title> + + <para> + 在你的架构中，Hibernate的<literal>Session</literal> API是独立于任何事务分界系统的. + 如果你让Hibernate通过连接池直接使用JDBC, 你需要调用JDBC API来打开和关闭你的事务. + 如果你运行在J2EE应用程序服务器中, 你也许想用Bean管理的事务并在需要的时候调用JTA API和<literal>UserTransaction</literal>. + </para> + + <para> + 为了让你的代码在两种(或其他)环境中可以移植，我们建议使用可选的Hibernate <literal>Transaction</literal> API, + 它包装并隐藏了底层系统. 你必须通过设置Hibernate配置属性<literal>hibernate.transaction.factory_class</literal>来指定 + 一个<literal>Transaction</literal>实例的工厂类. + </para> + + <para> + 有三个标准(内建)的选择: + </para> + + <variablelist spacing="compact"> + <varlistentry> + <term><literal>org.hibernate.transaction.JDBCTransactionFactory</literal></term> + <listitem> + <para> + 委托给数据库(JDBC)事务（默认） + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>org.hibernate.transaction.JTATransactionFactory</literal></term> + <listitem> + <para> + 如果在上下文环境中存在运行着的事务(如, EJB会话Bean的方法), 则委托给容器管 + 理的事务, 否则，将启动一个新的事务，并使用Bean管理的事务. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>org.hibernate.transaction.CMTTransactionFactory</literal></term> + <listitem> + <para> + 委托给容器管理的JTA事务 + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + 你也可以定义属于你自己的事务策略 (如, 针对CORBA的事务服务) + </para> + + <para> + Hibernate的一些特性 (比如二级缓存, Contextual Sessions with JTA等等)需要访问在托管环境中的JTA <literal>TransactionManager</literal>. + 由于J2EE没有标准化一个单一的机制,Hibernate在应用程序服务器中，你必须指定Hibernate如何获得<literal>TransactionManager</literal>的引用: + </para> + + <table frame="topbot" id="jtamanagerlookup" revision="1"> + <title>JTA TransactionManagers</title> + <tgroup cols="2"> + <colspec colwidth="2.5*"/> + <colspec colwidth="1*"/> + <thead> + <row> + <entry> + Transaction工厂类 + </entry> + <entry align="center"> + 应用程序服务器 + </entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>org.hibernate.transaction.JBossTransactionManagerLookup</literal></entry> + <entry align="center">JBoss</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.WeblogicTransactionManagerLookup</literal></entry> + <entry align="center">Weblogic</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.WebSphereTransactionManagerLookup</literal></entry> + <entry align="center">WebSphere</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.WebSphereExtendedJTATransactionLookup</literal></entry> + <entry align="center">WebSphere 6</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.OrionTransactionManagerLookup</literal></entry> + <entry align="center">Orion</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.ResinTransactionManagerLookup</literal></entry> + <entry align="center">Resin</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.JOTMTransactionManagerLookup</literal></entry> + <entry align="center">JOTM</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.JOnASTransactionManagerLookup</literal></entry> + <entry align="center">JOnAS</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.JRun4TransactionManagerLookup</literal></entry> + <entry align="center">JRun4</entry> + </row> + <row> + <entry><literal>org.hibernate.transaction.BESTransactionManagerLookup</literal></entry> + <entry align="center">Borland ES</entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + + <sect2 id="configuration-optional-jndi" revision="3"> + <title> + JNDI绑定的<literal>SessionFactory</literal> + </title> + + + <para> + 与JNDI绑定的Hibernate的<literal>SessionFactory</literal>能简化工厂的查询，简化创建新的<literal>Session</literal>. + 需要注意的是这与JNDI绑定<literal>Datasource</literal>没有关系, 它们只是恰巧用了相同的注册表! + </para> + + <para> + 如果你希望将<literal>SessionFactory</literal>绑定到一个JNDI的名字空间, + 用属性<literal>hibernate.session_factory_name</literal>指定一个名字(如, <literal>java:hibernate/SessionFactory</literal>). + 如果不设置这个属性, <literal>SessionFactory</literal>将不会被绑定到JNDI中. (在以只读JNDI为默认实现的环境中，这个设置尤其有用, 如Tomcat.) + </para> + + <para> + 在将<literal>SessionFactory</literal>绑定至JNDI时, Hibernate将使用<literal>hibernate.jndi.url</literal>, + 和<literal>hibernate.jndi.class</literal>的值来实例化初始环境(initial context). + 如果它们没有被指定, 将使用默认的<literal>InitialContext</literal>. + </para> + + <para> + 在你调用<literal>cfg.buildSessionFactory()</literal>后, Hibernate会自动将<literal>SessionFactory</literal>注册到JNDI. + 这意味这你至少需要在你应用程序的启动代码(或工具类)中完成这个调用, 除非你使用<literal>HibernateService</literal>来做JMX部署 (见后面讨论). + </para> + + <para> + 假若你使用JNDI <literal>SessionFactory</literal>,EJB或者任何其它类都可以从JNDI中找到此<literal>SessionFactory</literal>。 + </para> + + <para> + 我们建议，在受管理的环境中，把<literal>SessionFactory</literal>绑定到JNDI，在其它情况下，使用一个<literal>static(静态的)</literal>singleton。为了在你的应用程序代码中隐藏这些细节，我们还建议你用一个helper类把实际查找<literal>SessionFactory</literal>的代码隐藏起来,比如<literal>HibernateUtil.getSessionFactory()</literal>。注意，这个类也就可以方便地启动Hibernate，参见第一章。 + </para> + + </sect2> + + <sect2 id="configuration-j2ee-currentsession" revision="4"> + <title>在JTA环境下使用Current Session context (当前session上下文)管理</title> + + <para> + 在Hibernate中，管理<literal>Session</literal>和transaction最好的方法是自动的"当前"<literal>Session</literal>管理。请参见<xref linkend="architecture-current-session">contextual sessions</xref>一节的讨论。使用<literal>"jta"</literal>session上下文，假若在当前JTA事务中还没有Hibernate<literal>Session</literal>关联，第一次<literal>sessionFactory.getCurrentSession()</literal>调用会启动一个Session,并关联到当前的JTA事务。在<literal>"jta"</literal>上下文中调用<literal>getCurrentSession()</literal>获得的<literal>Session</literal>，会被设置为在transaction关闭的时候自动flush（清洗）、在transaction关闭之后自动关闭，每句语句之后主动释放JDBC连接。这就可以根据JTA事务的生命周期来管理与之关联的<literal>Session</literal>，用户代码中就可以不再考虑这些管理。你的代码也可以通过<literal>UserTransaction</literal>用编�! �方式使用JTA，或者(我们建议，为了便于移植代码）使用Hibernate的<literal>Transaction</literal> API来设置transaction边界。如果你的代码运行在EJB容器中，建议对CMT使用声明式事务声明。 + + </para> + </sect2> + <sect2 id="configuration-j2ee-jmx" revision="1"> + <title> + JMX部署 + </title> + + <para> + 为了将<literal>SessionFactory</literal>注册到JNDI中，<literal>cfg.buildSessionFactory()</literal>这行代码仍需在某处被执行. + 你可在一个<literal>static</literal>初始化块(像<literal>HibernateUtil</literal>中的那样)中执行它或将Hibernate部署为一个<emphasis>托管的服务</emphasis>. + </para> + + <para> + 为了部署在一个支持JMX的应用程序服务器上，Hibernate和 + <literal>org.hibernate.jmx.HibernateService</literal>一同分发，如Jboss AS。 + 实际的部署和配置是由应用程序服务器提供者指定的. 这里是JBoss 4.0.x的<literal>jboss-service.xml</literal>样例: + </para> + + <programlisting><![CDATA[<?xml version="1.0"?> +<server> + +<mbean code="org.hibernate.jmx.HibernateService" + name="jboss.jca:service=HibernateFactory,name=HibernateFactory"> + + <!-- 必须的服务 --> + <depends>jboss.jca:service=RARDeployer</depends> + <depends>jboss.jca:service=LocalTxCM,name=HsqlDS</depends> + + <!-- 将Hibernate服务绑定到JNDI --> + <attribute name="JndiName">java:/hibernate/SessionFactory</attribute> + + <!-- 数据源设置 --> + <attribute name="Datasource">java:HsqlDS</attribute> + <attribute name="Dialect">org.hibernate.dialect.HSQLDialect</attribute> + + <!-- 事务集成 --> + <attribute name="TransactionStrategy"> + org.hibernate.transaction.JTATransactionFactory</attribute> + <attribute name="TransactionManagerLookupStrategy"> + org.hibernate.transaction.JBossTransactionManagerLookup</attribute> + <attribute name="FlushBeforeCompletionEnabled">true</attribute> + <attribute name="AutoCloseSessionEnabled">true</attribute> + + <!-- 抓取选项 --> + <attribute name="MaximumFetchDepth">5</attribute> + + <!-- 二级缓存 --> + <attribute name="SecondLevelCacheEnabled">true</attribute> + <attribute name="CacheProviderClass">org.hibernate.cache.EhCacheProvider</attribute> + <attribute name="QueryCacheEnabled">true</attribute> + + <!-- 日志 --> + <attribute name="ShowSqlEnabled">true</attribute> + + <!-- 映射定义文件 --> + <attribute name="MapResources">auction/Item.hbm.xml,auction/Category.hbm.xml</attribute> + +</mbean> + +</server>]]></programlisting> + + <para> + 这个文件是部署在<literal>META-INF</literal>目录下的, 并会被打包到以<literal>.sar</literal> (service archive)为扩展名的JAR文件中. + 同时，你需要将Hibernate、它所需要的第三方库、你编译好的持久化类以及你的映射定义文件打包进同一个文档. + 你的企业Bean(一般为会话Bean)可能会被打包成它们自己的JAR文件, 但你也许会将EJB JAR文件一同包含进能独立(热)部署的主服务文档. + 参考JBoss AS文档以了解更多的JMX服务与EJB部署的信息. + </para> + + </sect2> + + </sect1> + +</chapter> Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/events.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/events.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/events.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/events.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,247 @@ +<chapter id="events"> + <title> + 拦截器与事件(Interceptors and events) + </title> + + <para> + 应用程序能够响应Hibernate内部产生的特定事件是非常有用的。这样就允许实现某些通用的功能 + 以及允许对Hibernate功能进行扩展。 + </para> + + <sect1 id="objectstate-interceptors" revision="3"> + <title> + 拦截器(Interceptors) + </title> + + <para> + <literal>Interceptor</literal>接口提供了从会话(session)回调(callback)应用程序(application)的机制， + 这种回调机制可以允许应用程序在持久化对象被保存、更新、删除或是加载之前，检查并（或）修改其 + 属性。一个可能的用途，就是用来跟踪审核(auditing)信息。例如：下面的这个<literal>拦截器</literal>，会在一个实现了 + <literal>Auditable</literal>接口的对象被创建时自动地设置<literal>createTimestamp</literal>属性，并在实现了 + <literal>Auditable</literal>接口的对象被更新时，同步更新<literal>lastUpdateTimestamp</literal>属性。 + </para> + + <para> + 你可以直接实现<literal>Interceptor</literal>接口，也可以（最好）继承自<literal>EmptyInterceptor</literal>。 + </para> + + <programlisting><![CDATA[package org.hibernate.test; + +import java.io.Serializable; +import java.util.Date; +import java.util.Iterator; + +import org.hibernate.EmptyInterceptor; +import org.hibernate.Transaction; +import org.hibernate.type.Type; + +public class AuditInterceptor extends EmptyInterceptor { + + private int updates; + private int creates; + private int loads; + + public void onDelete(Object entity, + Serializable id, + Object[] state, + String[] propertyNames, + Type[] types) { + // do nothing + } + + public boolean onFlushDirty(Object entity, + Serializable id, + Object[] currentState, + Object[] previousState, + String[] propertyNames, + Type[] types) { + + if ( entity instanceof Auditable ) { + updates++; + for ( int i=0; i < propertyNames.length; i++ ) { + if ( "lastUpdateTimestamp".equals( propertyNames[i] ) ) { + currentState[i] = new Date(); + return true; + } + } + } + return false; + } + + public boolean onLoad(Object entity, + Serializable id, + Object[] state, + String[] propertyNames, + Type[] types) { + if ( entity instanceof Auditable ) { + loads++; + } + return false; + } + + public boolean onSave(Object entity, + Serializable id, + Object[] state, + String[] propertyNames, + Type[] types) { + + if ( entity instanceof Auditable ) { + creates++; + for ( int i=0; i<propertyNames.length; i++ ) { + if ( "createTimestamp".equals( propertyNames[i] ) ) { + state[i] = new Date(); + return true; + } + } + } + return false; + } + + public void afterTransactionCompletion(Transaction tx) { + if ( tx.wasCommitted() ) { + System.out.println("Creations: " + creates + ", Updates: " + updates, "Loads: " + loads); + } + updates=0; + creates=0; + loads=0; + } + +}]]></programlisting> + + + <para> + 拦截器可以有两种:<literal>Session</literal>范围内的，和<literal>SessionFactory</literal>范围内的。 + </para> + + <para> + 当使用某个重载的SessionFactory.openSession()使用<literal>Interceptor</literal>作为参数调用打开一个session的时候，就指定了<literal>Session</literal>范围内的拦截器。 + + </para> + + <programlisting><![CDATA[Session session = sf.openSession( new AuditInterceptor() );]]></programlisting> + + <para> + <literal>SessionFactory</literal>范围内的拦截器要通过<literal>Configuration</literal>中注册，而这必须在创建<literal>SessionFactory</literal>之前。在这种情况下，给出的拦截器会被这个<literal>SessionFactory</literal>所打开的所有session使用了；除非session打开时明确指明了使用的拦截器。<literal>SessionFactory</literal>范围内的拦截器，必须是线程安全的，因为多个session可能并发使用这个拦截器，要因此小心不要保存与session相关的状态。 + </para> + + <programlisting><![CDATA[new Configuration().setInterceptor( new AuditInterceptor() );]]></programlisting> + + </sect1> + + <sect1 id="objectstate-events" revision="4"> + <title> + 事件系统(Event system) + </title> + + <para> + 如果需要响应持久层的某些特殊事件，你也可以使用Hibernate3的事件框架。 + 该事件系统可以用来替代拦截器，也可以作为拦截器的补充来使用。 + + </para> + + <para> + 基本上，<literal>Session</literal>接口的每个方法都有相对应的事件。比如 + <literal>LoadEvent</literal>，<literal>FlushEvent</literal>，等等（查阅XML配置文件 + 的DTD，以及<literal>org.hibernate.event</literal>包来获得所有已定义的事件的列表）。当某个方 + 法被调用时，Hibernate <literal>Session</literal>会生成一个相对应的事件并激活所 + 有配置好的事件监听器。系统预设的监听器实现的处理过程就是被监听的方法要做的（被监听的方法所做的其实仅仅是激活监听器， + “实际”的工作是由监听器完成的）。不过，你可以自由地选择实现 + 一个自己定制的监听器（比如，实现并注册用来处理处理<literal>LoadEvent</literal>的<literal>LoadEventListener</literal>接口）， + 来负责处理所有的调用<literal>Session</literal>的<literal>load()</literal>方法的请求。 + </para> + + <para> + 监听器应该被看作是单例(singleton)对象，也就是说，所有同类型的事件的处理共享同一个监听器实例，因此监听器 + 不应该保存任何状态（也就是不应该使用成员变量）。 + </para> + + <para> + 用户定制的监听器应该实现与所要处理的事件相对应的接口，或者从一个合适的基类继承（甚至是从Hibernate自带的默认事件监听器类继承， + 为了方便你这样做，这些类都被声明成non-final的了）。用户定制的监听器可以通过编程使用<literal>Configuration</literal>对象 + 来注册，也可以在Hibernate的XML格式的配置文件中进行声明（不支持在Properties格式的配置文件声明监听器）。 + 下面是一个用户定制的加载事件(load event)的监听器： + </para> + + <programlisting><![CDATA[public class MyLoadListener implements LoadEventListener { + // this is the single method defined by the LoadEventListener interface + public void onLoad(LoadEvent event, LoadEventListener.LoadType loadType) + throws HibernateException { + if ( !MySecurity.isAuthorized( event.getEntityClassName(), event.getEntityId() ) ) { + throw MySecurityException("Unauthorized access"); + } + } +}]]></programlisting> + + <para> + 你还需要修改一处配置，来告诉Hibernate，除了默认的监听器，还要附加选定的监听器。 + </para> + +<programlisting><![CDATA[<hibernate-configuration> + <session-factory> + ... + <event type="load"> + <listener class="com.eg.MyLoadListener"/> + <listener class="org.hibernate.event.def.DefaultLoadEventListener"/> + </event> + </session-factory> +</hibernate-configuration>]]></programlisting> + + <para> + 看看用另一种方式，通过编程的方式来注册它。 + </para> + + <programlisting><![CDATA[Configuration cfg = new Configuration(); +LoadEventListener[] stack = { new MyLoadListener(), new DefaultLoadEventListener() }; +cfg.EventListeners().setLoadEventListeners(stack);]]></programlisting> + + <para> + 通过在XML配置文件声明而注册的监听器不能共享实例。如果在多个<literal>&lt;listener/&gt;</literal>节点中使用 + 了相同的类的名字，则每一个引用都将会产生一个独立的实例。如果你需要在多个监听器类型之间共享 + 监听器的实例，则你必须使用编程的方式来进行注册。 + </para> + + <para> + 为什么我们实现了特定监听器的接口，在注册的时候还要明确指出我们要注册哪个事件的监听器呢？ + 这是因为一个类可能实现多个监听器的接口。在注册的时候明确指定要监听的事件，可以让启用或者禁用对某个事件的监听的配置工作简单些。 + </para> + + </sect1> + + <sect1 id="objectstate-decl-security" revision="2"> + <title> + Hibernate的声明式安全机制 + </title> + <para> + 通常，Hibernate应用程序的声明式安全机制由会话外观层(session facade)所管理。 + 现在，Hibernate3允许某些特定的行为由JACC进行许可管理，由JAAS进行授权管理。 + 本功能是一个建立在事件框架之上的可选的功能。 + </para> + + <para> + 首先，你必须要配置适当的事件监听器（event listener），来激活使用JAAS管理授权的功能。 + </para> + + <programlisting><![CDATA[<listener type="pre-delete" class="org.hibernate.secure.JACCPreDeleteEventListener"/> +<listener type="pre-update" class="org.hibernate.secure.JACCPreUpdateEventListener"/> +<listener type="pre-insert" class="org.hibernate.secure.JACCPreInsertEventListener"/> +<listener type="pre-load" class="org.hibernate.secure.JACCPreLoadEventListener"/>]]></programlisting> + + <para> + 注意，<literal>&lt;listener type="..." class="..."/&gt;</literal>只是<literal>&lt;event type="..."&gt;&lt;listener class="..."/&gt;&lt;/event&gt;</literal>的简写，对每一个事件类型都必须严格的有一个监听器与之对应。 + </para> + + <para> + 接下来，仍然在<literal>hibernate.cfg.xml</literal>文件中，绑定角色的权限： + </para> + + <programlisting><![CDATA[<grant role="admin" entity-name="User" actions="insert,update,read"/> +<grant role="su" entity-name="User" actions="*"/>]]></programlisting> + + <para> + 这些角色的名字就是你的JACC provider所定义的角色的名字。 + </para> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/example_mappings.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/example_mappings.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/example_mappings.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/example_mappings.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,650 @@ +<chapter id="example-mappings"> + <title>示例：复杂映射实例</title> + <para> + 本章展示了一些较为复杂的关系映射。 + </para> + + <sect1 id="example-mappings-emp"> + <title>Employer（雇主)/Employee(雇员)</title> + + <para> + 下面关于<literal>Employer</literal> 和 <literal>Employee</literal>的关系模型使用了一个真实的实体类 + (<literal>Employment</literal>)来表述，这是因为对于相同的雇员和雇主可能会有多个雇佣时间段。 + 对于金额和雇员姓名，用Components建模。 + + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="images/EmployerEmployee.gif" format="GIF" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../shared/images/EmployerEmployee.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + 映射文件可能是这样: + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Employer" table="employers"> + <id name="id"> + <generator class="sequence"> + <param name="sequence">employer_id_seq</param> + </generator> + </id> + <property name="name"/> + </class> + + <class name="Employment" table="employment_periods"> + + <id name="id"> + <generator class="sequence"> + <param name="sequence">employment_id_seq</param> + </generator> + </id> + <property name="startDate" column="start_date"/> + <property name="endDate" column="end_date"/> + + <component name="hourlyRate" class="MonetaryAmount"> + <property name="amount"> + <column name="hourly_rate" sql-type="NUMERIC(12, 2)"/> + </property> + <property name="currency" length="12"/> + </component> + + <many-to-one name="employer" column="employer_id" not-null="true"/> + <many-to-one name="employee" column="employee_id" not-null="true"/> + + </class> + + <class name="Employee" table="employees"> + <id name="id"> + <generator class="sequence"> + <param name="sequence">employee_id_seq</param> + </generator> + </id> + <property name="taxfileNumber"/> + <component name="name" class="Name"> + <property name="firstName"/> + <property name="initial"/> + <property name="lastName"/> + </component> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + 用<literal>SchemaExport</literal>生成表结构。 + </para> + + <programlisting><![CDATA[create table employers ( + id BIGINT not null, + name VARCHAR(255), + primary key (id) +) + +create table employment_periods ( + id BIGINT not null, + hourly_rate NUMERIC(12, 2), + currency VARCHAR(12), + employee_id BIGINT not null, + employer_id BIGINT not null, + end_date TIMESTAMP, + start_date TIMESTAMP, + primary key (id) +) + +create table employees ( + id BIGINT not null, + firstName VARCHAR(255), + initial CHAR(1), + lastName VARCHAR(255), + taxfileNumber VARCHAR(255), + primary key (id) +) + +alter table employment_periods + add constraint employment_periodsFK0 foreign key (employer_id) references employers +alter table employment_periods + add constraint employment_periodsFK1 foreign key (employee_id) references employees +create sequence employee_id_seq +create sequence employment_id_seq +create sequence employer_id_seq]]></programlisting> + + </sect1> + + <sect1 id="example-mappings-authorwork"> + <title>Author(作家)/Work(作品)</title> + + <para> + + 考虑下面的<literal>Work</literal>,<literal>Author</literal> 和 <literal>Person</literal>模型的关系。 + 我们用多对多关系来描述<literal>Work</literal> 和 <literal>Author</literal>， + 用一对一关系来描述<literal>Author</literal> 和 <literal>Person</literal>， + 另一种可能性是<literal>Author</literal>继承<literal>Person</literal>。 + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="images/AuthorWork.gif" format="GIF" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../shared/images/AuthorWork.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + 下面的映射文件正确的描述了这些关系： + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Work" table="works" discriminator-value="W"> + + <id name="id" column="id"> + <generator class="native"/> + </id> + <discriminator column="type" type="character"/> + + <property name="title"/> + <set name="authors" table="author_work"> + <key column name="work_id"/> + <many-to-many class="Author" column name="author_id"/> + </set> + + <subclass name="Book" discriminator-value="B"> + <property name="text"/> + </subclass> + + <subclass name="Song" discriminator-value="S"> + <property name="tempo"/> + <property name="genre"/> + </subclass> + + </class> + + <class name="Author" table="authors"> + + <id name="id" column="id"> + <!-- The Author must have the same identifier as the Person --> + <generator class="assigned"/> + </id> + + <property name="alias"/> + <one-to-one name="person" constrained="true"/> + + <set name="works" table="author_work" inverse="true"> + <key column="author_id"/> + <many-to-many class="Work" column="work_id"/> + </set> + + </class> + + <class name="Person" table="persons"> + <id name="id" column="id"> + <generator class="native"/> + </id> + <property name="name"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + + 映射中有4个表。<literal>works</literal>, <literal>authors</literal> 和 <literal>persons</literal> + 分别保存着work，author和person的数据。<literal>author_work</literal>是authors和works的关联表。 + 表结构是由<literal>SchemaExport</literal>生成的。 + </para> + + <programlisting><![CDATA[create table works ( + id BIGINT not null generated by default as identity, + tempo FLOAT, + genre VARCHAR(255), + text INTEGER, + title VARCHAR(255), + type CHAR(1) not null, + primary key (id) +) + +create table author_work ( + author_id BIGINT not null, + work_id BIGINT not null, + primary key (work_id, author_id) +) + +create table authors ( + id BIGINT not null generated by default as identity, + alias VARCHAR(255), + primary key (id) +) + +create table persons ( + id BIGINT not null generated by default as identity, + name VARCHAR(255), + primary key (id) +) + +alter table authors + add constraint authorsFK0 foreign key (id) references persons +alter table author_work + add constraint author_workFK0 foreign key (author_id) references authors +alter table author_work + add constraint author_workFK1 foreign key (work_id) references works]]></programlisting> + + </sect1> + + <sect1 id="example-mappings-customerorderproduct"> + <title>Customer(客户)/Order(订单)/Product(产品)</title> + + <para> + + 现在来考虑<literal>Customer</literal>,<literal>Order</literal> ， <literal>LineItem</literal> + 和 <literal>Product</literal>关系的模型。<literal>Customer</literal> 和 <literal>Order</literal>之间 + 是一对多的关系，但是我们怎么来描述<literal>Order</literal> / <literal>LineItem</literal> / <literal>Product</literal>呢？ + 我可以把<literal>LineItem</literal>作为描述<literal>Order</literal> 和 <literal>Product</literal> + 多对多关系的关联类，在Hibernate，这叫做组合元素。 + </para> + + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="images/CustomerOrderProduct.gif" format="GIF" align="center"/> + </imageobject> + <imageobject role="html"> + <imagedata fileref="../shared/images/CustomerOrderProduct.gif" format="GIF" align="center"/> + </imageobject> + </mediaobject> + + <para> + 映射文件如下： + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="Customer" table="customers"> + <id name="id"> + <generator class="native"/> + </id> + <property name="name"/> + <set name="orders" inverse="true"> + <key column="customer_id"/> + <one-to-many class="Order"/> + </set> + </class> + + <class name="Order" table="orders"> + <id name="id"> + <generator class="native"/> + </id> + <property name="date"/> + <many-to-one name="customer" column="customer_id"/> + <list name="lineItems" table="line_items"> + <key column="order_id"/> + <list-index column="line_number"/> + <composite-element class="LineItem"> + <property name="quantity"/> + <many-to-one name="product" column="product_id"/> + </composite-element> + </list> + </class> + + <class name="Product" table="products"> + <id name="id"> + <generator class="native"/> + </id> + <property name="serialNumber"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + <literal>customers</literal>, <literal>orders</literal>, <literal>line_items</literal> 和 + <literal>products</literal> 分别保存着customer, order, order line item 和 product的数据。 + <literal>line_items</literal>也作为连接orders 和 products的关联表。 + </para> + + <programlisting><![CDATA[create table customers ( + id BIGINT not null generated by default as identity, + name VARCHAR(255), + primary key (id) +) + +create table orders ( + id BIGINT not null generated by default as identity, + customer_id BIGINT, + date TIMESTAMP, + primary key (id) +) + +create table line_items ( + line_number INTEGER not null, + order_id BIGINT not null, + product_id BIGINT, + quantity INTEGER, + primary key (order_id, line_number) +) + +create table products ( + id BIGINT not null generated by default as identity, + serialNumber VARCHAR(255), + primary key (id) +) + +alter table orders + add constraint ordersFK0 foreign key (customer_id) references customers +alter table line_items + add constraint line_itemsFK0 foreign key (product_id) references products +alter table line_items + add constraint line_itemsFK1 foreign key (order_id) references orders]]></programlisting> + + </sect1> + + <sect1 id="misc"> + <title>杂例</title> + + <para> + 这些例子全部来自于Hibernate的test suite，同时你也可以找到其他有用的例子。 + 可以参考Hibernate的<literal>test</literal>目录。 + </para> + + <para>TODO: put words around this stuff</para> + + <sect2 id="example-mappings-typed-onetone"> + <title>"Typed" one-to-one association</title> +<programlisting><![CDATA[<class name="Person"> + <id name="name"/> + <one-to-one name="address" + cascade="all"> + <formula>name</formula> + <formula>'HOME'</formula> + </one-to-one> + <one-to-one name="mailingAddress" + cascade="all"> + <formula>name</formula> + <formula>'MAILING'</formula> + </one-to-one> +</class> + +<class name="Address" batch-size="2" + check="addressType in ('MAILING', 'HOME', 'BUSINESS')"> + <composite-id> + <key-many-to-one name="person" + column="personName"/> + <key-property name="type" + column="addressType"/> + </composite-id> + <property name="street" type="text"/> + <property name="state"/> + <property name="zip"/> +</class>]]></programlisting> + </sect2> + + <sect2 id="example-mappings-composite-key"> + <title>Composite key example</title> +<programlisting><![CDATA[<class name="Customer"> + + <id name="customerId" + length="10"> + <generator class="assigned"/> + </id> + + <property name="name" not-null="true" length="100"/> + <property name="address" not-null="true" length="200"/> + + <list name="orders" + inverse="true" + cascade="save-update"> + <key column="customerId"/> + <index column="orderNumber"/> + <one-to-many class="Order"/> + </list> + +</class> + +<class name="Order" table="CustomerOrder" lazy="true"> + <synchronize table="LineItem"/> + <synchronize table="Product"/> + + <composite-id name="id" + class="Order$Id"> + <key-property name="customerId" length="10"/> + <key-property name="orderNumber"/> + </composite-id> + + <property name="orderDate" + type="calendar_date" + not-null="true"/> + + <property name="total"> + <formula> + ( select sum(li.quantity*p.price) + from LineItem li, Product p + where li.productId = p.productId + and li.customerId = customerId + and li.orderNumber = orderNumber ) + </formula> + </property> + + <many-to-one name="customer" + column="customerId" + insert="false" + update="false" + not-null="true"/> + + <bag name="lineItems" + fetch="join" + inverse="true" + cascade="save-update"> + <key> + <column name="customerId"/> + <column name="orderNumber"/> + </key> + <one-to-many class="LineItem"/> + </bag> + +</class> + +<class name="LineItem"> + + <composite-id name="id" + class="LineItem$Id"> + <key-property name="customerId" length="10"/> + <key-property name="orderNumber"/> + <key-property name="productId" length="10"/> + </composite-id> + + <property name="quantity"/> + + <many-to-one name="order" + insert="false" + update="false" + not-null="true"> + <column name="customerId"/> + <column name="orderNumber"/> + </many-to-one> + + <many-to-one name="product" + insert="false" + update="false" + not-null="true" + column="productId"/> + +</class> + +<class name="Product"> + <synchronize table="LineItem"/> + + <id name="productId" + length="10"> + <generator class="assigned"/> + </id> + + <property name="description" + not-null="true" + length="200"/> + <property name="price" length="3"/> + <property name="numberAvailable"/> + + <property name="numberOrdered"> + <formula> + ( select sum(li.quantity) + from LineItem li + where li.productId = productId ) + </formula> + </property> + +</class>]]></programlisting> + </sect2> + + <sect2 id="example-mappings-composite-key-manytomany"> + <title>共有组合键属性的多对多(Many-to-many with shared composite key attribute)</title> + +<programlisting><![CDATA[<class name="User" table="`User`"> + <composite-id> + <key-property name="name"/> + <key-property name="org"/> + </composite-id> + <set name="groups" table="UserGroup"> + <key> + <column name="userName"/> + <column name="org"/> + </key> + <many-to-many class="Group"> + <column name="groupName"/> + <formula>org</formula> + </many-to-many> + </set> +</class> + +<class name="Group" table="`Group`"> + <composite-id> + <key-property name="name"/> + <key-property name="org"/> + </composite-id> + <property name="description"/> + <set name="users" table="UserGroup" inverse="true"> + <key> + <column name="groupName"/> + <column name="org"/> + </key> + <many-to-many class="User"> + <column name="userName"/> + <formula>org</formula> + </many-to-many> + </set> +</class> +]]></programlisting> + </sect2> + + <sect2 id="example-mappings-content-discrimination"> + <title>Content based discrimination</title> +<programlisting><![CDATA[<class name="Person" + discriminator-value="P"> + + <id name="id" + column="person_id" + unsaved-value="0"> + <generator class="native"/> + </id> + + + <discriminator + type="character"> + <formula> + case + when title is not null then 'E' + when salesperson is not null then 'C' + else 'P' + end + </formula> + </discriminator> + + <property name="name" + not-null="true" + length="80"/> + + <property name="sex" + not-null="true" + update="false"/> + + <component name="address"> + <property name="address"/> + <property name="zip"/> + <property name="country"/> + </component> + + <subclass name="Employee" + discriminator-value="E"> + <property name="title" + length="20"/> + <property name="salary"/> + <many-to-one name="manager"/> + </subclass> + + <subclass name="Customer" + discriminator-value="C"> + <property name="comments"/> + <many-to-one name="salesperson"/> + </subclass> + +</class>]]></programlisting> + </sect2> + + <sect2 id="example-mappings-association-alternatekeys" revision="2"> + <title>Associations on alternate keys</title> +<programlisting><![CDATA[<class name="Person"> + + <id name="id"> + <generator class="hilo"/> + </id> + + <property name="name" length="100"/> + + <one-to-one name="address" + property-ref="person" + cascade="all" + fetch="join"/> + + <set name="accounts" + inverse="true"> + <key column="userId" + property-ref="userId"/> + <one-to-many class="Account"/> + </set> + + <property name="userId" length="8"/> + +</class> + +<class name="Address"> + + <id name="id"> + <generator class="hilo"/> + </id> + + <property name="address" length="300"/> + <property name="zip" length="5"/> + <property name="country" length="25"/> + <many-to-one name="person" unique="true" not-null="true"/> + +</class> + +<class name="Account"> + <id name="accountId" length="32"> + <generator class="uuid"/> + </id> + + <many-to-one name="user" + column="userId" + property-ref="userId"/> + + <property name="type" not-null="true"/> + +</class>]]></programlisting> + </sect2> + + </sect1> + +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/example_parentchild.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/example_parentchild.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/example_parentchild.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/example_parentchild.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,306 @@ +<chapter id="example-parentchild"> + <title>示例：父子关系(Parent Child Relationships)</title> + <para> + 刚刚接触Hibernate的人大多是从父子关系（parent / child type relationship）的建模入手的。父子关系的建模有两种方法。由于种种原因，最方便的方法是把<literal>Parent</literal>和<literal>Child</literal>都建模成实体类，并创建一个从<literal>Parent</literal>指向<literal>Child</literal>的&lt;one-to-many&gt;关联，对新手来说尤其如此。还有一种方法，就是将<literal>Child</literal>声明为一个<literal>&lt;composite-element&gt;</literal>（组合元素）。 事实上在Hibernate中one to many关联的默认语义远没有composite element贴近parent / child关系的通常语义。下面我们会阐述如何使用<emphasis>带有级联的双向一对多关联(bidirectional one to many association with cascades)</emphasis>去建立有效、优美的parent / child关系。这一点也不难！ + </para> + + <sect1 id="example-parentchild-collections"> + <title>关于collections需要注意的一点</title> + <para> + Hibernate collections被当作其所属实体而不是其包含实体的一个逻辑部分。这非常重要！它主要体现为以下几点： + </para> + <itemizedlist> + <listitem> + <para> + 当删除或增加collection中对象的时候，collection所属者的版本值会递增。 + </para> + </listitem> + <listitem> + <para> + 如果一个从collection中移除的对象是一个值类型(value type)的实例，比如composite element，那么这个对象的持久化状态将会终止，其在数据库中对应的记录会被删除。同样的，向collection增加一个value type的实例将会使之立即被持久化。 + </para> + </listitem> + <listitem> + <para> + 另一方面，如果从一对多或多对多关联的collection中移除一个实体，在缺省情况下这个对象并不会被删除。这个行为是完全合乎逻辑的－－改变一个实体的内部状态不应该使与它关联的实体消失掉！同样的，向collection增加一个实体不会使之被持久化。 + </para> + </listitem> + </itemizedlist> + + <para> + 实际上，向Collection增加一个实体的缺省动作只是在两个实体之间创建一个连接而已，同样移除的时候也只是删除连接。这种处理对于所有的情况都是合适的。对于父子关系则是完全不适合的，在这种关系下，子对象的生存绑定于父对象的生存周期。 + </para> + + </sect1> + <sect1 id="example-parentchild-bidir"> + <title>双向的一对多关系(Bidirectional one-to-many)</title> + + <para> + 假设我们要实现一个简单的从Parent到Child的&lt;one-to-many&gt;关联。 + </para> + + <programlisting><![CDATA[<set name="children"> + <key column="parent_id"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + 如果我们运行下面的代码 + </para> + + <programlisting><![CDATA[Parent p = .....; +Child c = new Child(); +p.getChildren().add(c); +session.save(c); +session.flush();]]></programlisting> + + <para> + Hibernate会产生两条SQL语句： + </para> + + <itemizedlist> + <listitem> + <para>一条<literal>INSERT</literal>语句，为<literal>c</literal>创建一条记录</para> + </listitem> + <listitem> + <para> + 一条<literal>UPDATE</literal>语句，创建从<literal>p</literal>到<literal>c</literal>的连接 + </para> + </listitem> + </itemizedlist> + + <para> + 这样做不仅效率低，而且违反了列<literal>parent_id</literal>非空的限制。我们可以通过在集合类映射上指定<literal>not-null="true"</literal>来解决违反非空约束的问题： + </para> + + <programlisting><![CDATA[<set name="children"> + <key column="parent_id" not-null="true"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + 然而，这并非是推荐的解决方法。 + </para> + + <para> 这种现象的根本原因是从<literal>p</literal>到<literal>c</literal>的连接（外键parent_id）没有被当作<literal>Child</literal>对象状态的一部分，因而没有在INSERT语句中被创建。因此解决的办法就是把这个连接添加到Child的映射中。 + </para> + + <programlisting><![CDATA[<many-to-one name="parent" column="parent_id" not-null="true"/>]]></programlisting> + + <para> + （我们还需要为类<literal>Child</literal>添加<literal>parent</literal>属性） + </para> + + <para> + 现在实体<literal>Child</literal>在管理连接的状态，为了使collection不更新连接，我们使用<literal>inverse</literal>属性。 + </para> + + <programlisting><![CDATA[<set name="children" inverse="true"> + <key column="parent_id"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + 下面的代码是用来添加一个新的<literal>Child</literal> + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = new Child(); +c.setParent(p); +p.getChildren().add(c); +session.save(c); +session.flush();]]></programlisting> + + <para> + 现在，只会有一条<literal>INSERT</literal>语句被执行！ + </para> + + <para> + 为了让事情变得井井有条，可以为<literal>Parent</literal>加一个<literal>addChild()</literal>方法。 + </para> + + <programlisting><![CDATA[public void addChild(Child c) { + c.setParent(this); + children.add(c); +}]]></programlisting> + + <para> + 现在，添加<literal>Child</literal>的代码就是这样 + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = new Child(); +p.addChild(c); +session.save(c); +session.flush();]]></programlisting> + + </sect1> + + <sect1 id="example-parentchild-cascades"> + <title>级联生命周期（Cascading life cycle）</title> + <para> + 需要显式调用<literal>save()</literal>仍然很麻烦，我们可以用级联来解决这个问题。 + </para> + + <programlisting><![CDATA[<set name="children" inverse="true" cascade="all"> + <key column="parent_id"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + 这样上面的代码可以简化为： + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = new Child(); +p.addChild(c); +session.flush();]]></programlisting> + + <para> + 同样的，保存或删除<literal>Parent</literal>对象的时候并不需要遍历其子对象。 + 下面的代码会删除对象<literal>p</literal>及其所有子对象对应的数据库记录。 + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +session.delete(p); +session.flush();]]></programlisting> + + <para> + 然而，这段代码 + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = (Child) p.getChildren().iterator().next(); +p.getChildren().remove(c); +c.setParent(null); +session.flush();]]></programlisting> + + <para> + 不会从数据库删除<literal>c</literal>；它只会删除与<literal>p</literal>之间的连接（并且会导致违反<literal>NOT NULL</literal>约束，在这个例子中）。你需要显式调用<literal>delete()</literal>来删除<literal>Child</literal>。 <!--，因为Hibernate并没有设计垃圾回收器！代码如下：--> + </para> + + <programlisting><![CDATA[Parent p = (Parent) session.load(Parent.class, pid); +Child c = (Child) p.getChildren().iterator().next(); +p.getChildren().remove(c); +session.delete(c); +session.flush();]]></programlisting> + + + <para> + 在我们的例子中，如果没有父对象，子对象就不应该存在，如果将子对象从collection中移除，实际上我们是想删除它。要实现这种要求，就必须使用<literal>cascade="all-delete-orphan"</literal>。 + </para> + + + <programlisting><![CDATA[<set name="children" inverse="true" cascade="all-delete-orphan"> + <key column="parent_id"/> + <one-to-many class="Child"/> +</set>]]></programlisting> + + <para> + 注意：即使在collection一方的映射中指定<literal>inverse="true"</literal>，级联仍然是通过遍历collection中的元素来处理的。如果你想要通过级联进行子对象的插入、删除、更新操作，就必须把它加到collection中，只调用<literal>setParent()</literal>是不够的。 + </para> + + </sect1> + + <sect1 id="example-parentchild-update"> + <title>级联与<literal>未保存值</literal>（Cascades and <literal>unsaved-value</literal>）</title> + + <para> + 假设我们从<literal>Session</literal>中装入了一个<literal>Parent</literal>对象，用户界面对其进行了修改，然后希望在一个新的Session里面调用<literal>update()</literal>来保存这些修改。对象<literal>Parent</literal>包含了子对象的集合，由于打开了级联更新，Hibernate需要知道哪些Child对象是新实例化的，哪些代表数据库中已经存在的记录。我们假设<literal>Parent</literal>和<literal>Child</literal>对象的标识属性都是自动生成的，类型为<literal>java.lang.Long</literal>。Hibernate会使用标识属性的值，和version 或 timestamp 属性，来判断哪些子对象是新的。(参见<xref linkend="objectstate-saveorupdate"/>.) <emphasis>在 Hibernate3 中,显式指定<literal>unsaved-value</literal>不再是必须的了。</emphasis> + </para> + + <para> + 下面的代码会更新<literal>parent</literal>和<literal>child</literal>对象，并且插入<literal>newChild</literal>对象。 + </para> + + <programlisting><![CDATA[//parent and child were both loaded in a previous session +parent.addChild(child); +Child newChild = new Child(); +parent.addChild(newChild); +session.update(parent); +session.flush();]]></programlisting> + + <para> + Well, that's all very well for the case of a generated identifier, but what about assigned identifiers + and composite identifiers? This is more difficult, since Hibernate can't use the identifier property to + distinguish between a newly instantiated object (with an identifier assigned by the user) and an + object loaded in a previous session. In this case, Hibernate will either use the timestamp or version + property, or will actually query the second-level cache or, worst case, the database, to see if the + row exists. + </para> + <para> + 这对于自动生成标识的情况是非常好的，但是自分配的标识和复合标识怎么办呢？这是有点麻烦，因为Hibernate没有办法区分新实例化的对象（标识被用户指定了）和前一个Session装入的对象。在这种情况下，Hibernate会使用timestamp或version属性，或者查询第二级缓存，或者最坏的情况，查询数据库，来确认是否此行存在。</para> + + <!-- undocumenting + + <para> + 还有一种可能情况，有一个名为<literal>isUnsaved()</literal>的<literal>新的拦截器（Interceptor）</literal>方法，它允许应用程序自己实现新实例的判断。比如，你可以自己定义一个持久类的祖先类： + </para> + + <programlisting><![CDATA[public class Persistent { + private boolean _saved = false; + public void onSave() { + _saved=true; + } + public void onLoad() { + _saved=true; + } + ...... + public boolean isSaved() { + return _saved; + } +}]]></programlisting> + + <para> + （<literal>saved</literal>属性是不会被持久化的。) + 现在在<literal>onLoad()</literal>和<literal>onSave()</literal>外，还要实现<literal>isUnsaved()</literal>。 + </para> + + <programlisting><![CDATA[public Boolean isUnsaved(Object entity) { + if (entity instanceof Persistent) { + return new Boolean( !( (Persistent) entity ).isSaved() ); + } + else { + return null; + } +} + +public boolean onLoad(Object entity, + Serializable id, + Object[] state, + String[] propertyNames, + Type[] types) { + + if (entity instanceof Persistent) ( (Persistent) entity ).onLoad(); + return false; +} + +public boolean onSave(Object entity, + Serializable id, + Object[] state, + String[] propertyNames, + Type[] types) { + + if (entity instanceof Persistent) ( (Persistent) entity ).onSave(); + return false; +}]]></programlisting> + + <para> + Don't worry; in Hibernate3 you don't need to write any of this kind of code if you don't want to. + 别担心，在Hibernate3中，假若你不愿意，你不需要编写任何这类代码。 + </para> + --> + + </sect1> + + + <sect1 id="example-parentchild-conclusion"> + <title>结论</title> + <para> 这里有不少东西需要融会贯通，可能会让新手感到迷惑。但是在实践中它们都工作地非常好。大部分Hibernate应用程序都会经常用到父子对象模式。 + </para> + <para> + 在第一段中我们曾经提到另一个方案。上面的这些问题都不会出现在<literal>&lt;composite-element&gt;</literal>映射中，它准确地表达了父子关系的语义。很不幸复合元素还有两个重大限制:复合元素不能拥有collections，并且，除了用于惟一的父对象外，它们不能再作为其它任何实体的子对象。 + </para> + </sect1> + +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/example_weblog.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/example_weblog.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/example_weblog.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/example_weblog.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,424 @@ +<chapter id="example-weblog"> + <title>示例：Weblog 应用程序</title> + + <sect1 id="example-weblog-classes"> + <title>持久化类</title> + + <para> 下面的持久化类表示一个weblog和在其中张贴的一个贴子。他们是标准的父/子关系模型，但是我们会用一个有序包（ordered bag)而非集合(set)。 + </para> + + <programlisting><![CDATA[package eg; + +import java.util.List; + +public class Blog { + private Long _id; + private String _name; + private List _items; + + public Long getId() { + return _id; + } + public List getItems() { + return _items; + } + public String getName() { + return _name; + } + public void setId(Long long1) { + _id = long1; + } + public void setItems(List list) { + _items = list; + } + public void setName(String string) { + _name = string; + } +}]]></programlisting> + + <programlisting><![CDATA[package eg; + +import java.text.DateFormat; +import java.util.Calendar; + +public class BlogItem { + private Long _id; + private Calendar _datetime; + private String _text; + private String _title; + private Blog _blog; + + public Blog getBlog() { + return _blog; + } + public Calendar getDatetime() { + return _datetime; + } + public Long getId() { + return _id; + } + public String getText() { + return _text; + } + public String getTitle() { + return _title; + } + public void setBlog(Blog blog) { + _blog = blog; + } + public void setDatetime(Calendar calendar) { + _datetime = calendar; + } + public void setId(Long long1) { + _id = long1; + } + public void setText(String string) { + _text = string; + } + public void setTitle(String string) { + _title = string; + } +}]]></programlisting> + + </sect1> + <sect1 id="example-weblog-mappings"> + <title>Hibernate 映射</title> + + <para> + 下列的XML映射应该是很直白的。 + </para> + + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="eg"> + <class + name="Blog" + table="BLOGS" > + + <id + name="id" + column="BLOG_ID"> + + <generator class="native"/> + + </id> + + <property + name="name" + column="NAME" + not-null="true" + unique="true"/> + + <bag + name="items" + inverse="true" + order-by="DATE_TIME" + cascade="all"> + + <key column="BLOG_ID"/> + <one-to-many class="BlogItem"/> + + </bag> + + </class> + +</hibernate-mapping>]]></programlisting> + + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping package="eg"> + + <class + name="BlogItem" + table="BLOG_ITEMS" + dynamic-update="true"> + + <id + name="id" + column="BLOG_ITEM_ID"> + + <generator class="native"/> + + </id> + + <property + name="title" + column="TITLE" + not-null="true"/> + + <property + name="text" + column="TEXT" + not-null="true"/> + + <property + name="datetime" + column="DATE_TIME" + not-null="true"/> + + <many-to-one + name="blog" + column="BLOG_ID" + not-null="true"/> + + </class> + +</hibernate-mapping>]]></programlisting> + + </sect1> + + <sect1 id="example-weblog-code"> + <title>Hibernate 代码</title> + + <para> + 下面的类演示了我们可以使用Hibernate对这些类进行的一些操作。 + </para> + + <programlisting><![CDATA[package eg; + +import java.util.ArrayList; +import java.util.Calendar; +import java.util.Iterator; +import java.util.List; + +import org.hibernate.HibernateException; +import org.hibernate.Query; +import org.hibernate.Session; +import org.hibernate.SessionFactory; +import org.hibernate.Transaction; +import org.hibernate.cfg.Configuration; +import org.hibernate.tool.hbm2ddl.SchemaExport; + +public class BlogMain { + + private SessionFactory _sessions; + + public void configure() throws HibernateException { + _sessions = new Configuration() + .addClass(Blog.class) + .addClass(BlogItem.class) + .buildSessionFactory(); + } + + public void exportTables() throws HibernateException { + Configuration cfg = new Configuration() + .addClass(Blog.class) + .addClass(BlogItem.class); + new SchemaExport(cfg).create(true, true); + } + + public Blog createBlog(String name) throws HibernateException { + + Blog blog = new Blog(); + blog.setName(name); + blog.setItems( new ArrayList() ); + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + session.persist(blog); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return blog; + } + + public BlogItem createBlogItem(Blog blog, String title, String text) + throws HibernateException { + + BlogItem item = new BlogItem(); + item.setTitle(title); + item.setText(text); + item.setBlog(blog); + item.setDatetime( Calendar.getInstance() ); + blog.getItems().add(item); + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + session.update(blog); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return item; + } + + public BlogItem createBlogItem(Long blogid, String title, String text) + throws HibernateException { + + BlogItem item = new BlogItem(); + item.setTitle(title); + item.setText(text); + item.setDatetime( Calendar.getInstance() ); + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + Blog blog = (Blog) session.load(Blog.class, blogid); + item.setBlog(blog); + blog.getItems().add(item); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return item; + } + + public void updateBlogItem(BlogItem item, String text) + throws HibernateException { + + item.setText(text); + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + session.update(item); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + } + + public void updateBlogItem(Long itemid, String text) + throws HibernateException { + + Session session = _sessions.openSession(); + Transaction tx = null; + try { + tx = session.beginTransaction(); + BlogItem item = (BlogItem) session.load(BlogItem.class, itemid); + item.setText(text); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + } + + public List listAllBlogNamesAndItemCounts(int max) + throws HibernateException { + + Session session = _sessions.openSession(); + Transaction tx = null; + List result = null; + try { + tx = session.beginTransaction(); + Query q = session.createQuery( + "select blog.id, blog.name, count(blogItem) " + + "from Blog as blog " + + "left outer join blog.items as blogItem " + + "group by blog.name, blog.id " + + "order by max(blogItem.datetime)" + ); + q.setMaxResults(max); + result = q.list(); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return result; + } + + public Blog getBlogAndAllItems(Long blogid) + throws HibernateException { + + Session session = _sessions.openSession(); + Transaction tx = null; + Blog blog = null; + try { + tx = session.beginTransaction(); + Query q = session.createQuery( + "from Blog as blog " + + "left outer join fetch blog.items " + + "where blog.id = :blogid" + ); + q.setParameter("blogid", blogid); + blog = (Blog) q.uniqueResult(); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return blog; + } + + public List listBlogsAndRecentItems() throws HibernateException { + + Session session = _sessions.openSession(); + Transaction tx = null; + List result = null; + try { + tx = session.beginTransaction(); + Query q = session.createQuery( + "from Blog as blog " + + "inner join blog.items as blogItem " + + "where blogItem.datetime > :minDate" + ); + + Calendar cal = Calendar.getInstance(); + cal.roll(Calendar.MONTH, false); + q.setCalendar("minDate", cal); + + result = q.list(); + tx.commit(); + } + catch (HibernateException he) { + if (tx!=null) tx.rollback(); + throw he; + } + finally { + session.close(); + } + return result; + } +}]]></programlisting> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/filters.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/filters.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/filters.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/filters.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,140 @@ +<chapter id="filters"> + <title>过滤数据</title> + <para> + + Hibernate3 提供了一种创新的方式来处理具有“显性(visibility)”规则的数据，那就是使用<emphasis>Hibernate filter</emphasis>。 + <emphasis>Hibernate filter</emphasis>是全局有效的、具有名字、可以带参数的过滤器， + 对于某个特定的Hibernate session您可以选择是否启用（或禁用）某个过滤器。 + </para> + + <sect1 id="objectstate-filters" revision="1"> + <title>Hibernate 过滤器(filters)</title> + + <para> + Hibernate3新增了对某个类或者集合使用预先定义的过滤器条件(filter criteria)的功能。过滤器条件相当于定义一个 + 非常类似于类和各种集合上的“where”属性的约束子句，但是过滤器条件可以带参数。 + 应用程序可以在运行时决定是否启用给定的过滤器，以及使用什么样的参数值。 + 过滤器的用法很像数据库视图，只不过是在应用程序中确定使用什么样的参数的。 + + </para> + + <para> + + 要使用过滤器，必须首先在相应的映射节点中定义。而定义一个过滤器，要用到位于<literal>&lt;hibernate-mapping/&gt;</literal> + 节点之内的<literal>&lt;filter-def/&gt;</literal>节点： + </para> + + <programlisting><![CDATA[<filter-def name="myFilter"> + <filter-param name="myFilterParam" type="string"/> +</filter-def>]]></programlisting> + + <para> + 定义好之后，就可以在某个类中使用这个过滤器： + </para> + + <programlisting><![CDATA[<class name="myClass" ...> + ... + <filter name="myFilter" condition=":myFilterParam = MY_FILTERED_COLUMN"/> +</class>]]></programlisting> + + <para> + 也可以在某个集合使用它： + </para> + + <programlisting><![CDATA[<set ...> + <filter name="myFilter" condition=":myFilterParam = MY_FILTERED_COLUMN"/> +</set>]]></programlisting> + + <para> + 可以在多个类或集合中使用某个过滤器；某个类或者集合中也可以使用多个过滤器。 + </para> + + <para> + + <literal>Session</literal>对象中会用到的方法有：<literal>enableFilter(String filterName)</literal>, + <literal>getEnabledFilter(String filterName)</literal>, 和 <literal>disableFilter(String filterName)</literal>. + Session中默认是<emphasis>不</emphasis>启用过滤器的，必须通过<literal>Session.enabledFilter()</literal>方法显式的启用。 + 该方法返回被启用的<literal>Filter</literal>的实例。以上文定义的过滤器为例： + </para> + + <programlisting><![CDATA[session.enableFilter("myFilter").setParameter("myFilterParam", "some-value");]]></programlisting> + + <para> + 注意，org.hibernate.Filter的方法允许链式方法调用。（类似上面例子中启用Filter之后设定Filter参数这个“方法链”） + Hibernate的其他部分也大多有这个特性。 + </para> + + <para> + 下面是一个比较完整的例子，使用了记录生效日期模式过滤有时效的数据： + </para> + + <programlisting><![CDATA[<filter-def name="effectiveDate"> + <filter-param name="asOfDate" type="date"/> +</filter-def> + +<class name="Employee" ...> +... + <many-to-one name="department" column="dept_id" class="Department"/> + <property name="effectiveStartDate" type="date" column="eff_start_dt"/> + <property name="effectiveEndDate" type="date" column="eff_end_dt"/> +... + <!-- + Note that this assumes non-terminal records have an eff_end_dt set to + a max db date for simplicity-sake + + 注意，为了简单起见，此处假设雇用关系生效期尚未结束的记录的eff_end_dt字段的值等于数据库最大的日期 + --> + <filter name="effectiveDate" + condition=":asOfDate BETWEEN eff_start_dt and eff_end_dt"/> +</class> + +<class name="Department" ...> +... + <set name="employees" lazy="true"> + <key column="dept_id"/> + <one-to-many class="Employee"/> + <filter name="effectiveDate" + condition=":asOfDate BETWEEN eff_start_dt and eff_end_dt"/> + </set> +</class>]]></programlisting> + + <para> + 定义好后，如果想要保证取回的都是目前处于生效期的记录，只需在获取雇员数据的操作之前先开启过滤器即可： + </para> + +<programlisting><![CDATA[Session session = ...; +session.enabledFilter("effectiveDate").setParameter("asOfDate", new Date()); +List results = session.createQuery("from Employee as e where e.salary > :targetSalary") + .setLong("targetSalary", new Long(1000000)) + .list(); +]]></programlisting> + + <para> + + 在上面的HQL中，虽然我们仅仅显式的使用了一个薪水条件，但因为启用了过滤器，查询将仅返回那些目前雇用 + 关系处于生效期的，并且薪水高于一百万美刀的雇员的数据。 + + </para> + + <para> + + 注意：如果你打算在使用外连接（或者通过HQL或load fetching）的同时使用过滤器，要注意条件表达式的方向（左还是右）。 + 最安全的方式是使用左外连接（left outer joining）。并且通常来说，先写参数， + 然后是操作符，最后写数据库字段名。 + </para> + + <para> + 在Filter定义之后,它可能被附加到多个实体和/或集合类,每个都有自己的条件。假若这些条件都是一样的，每次都要定义就显得很繁琐。因此，<literal>&lt;filter-def/&gt;</literal>被用来定义一个默认条件，它可能作为属性或者CDATA出现： + </para> + + <programlisting><![CDATA[<filter-def name="myFilter" condition="abc > xyz">...</filter-def> +<filter-def name="myOtherFilter">abc=xyz</filter-def>]]></programlisting> + + <para> + 当这个filter被附加到任何目的地，而又没有指明条件时，这个条件就会被使用。注意，换句话说，你可以通过给filter附加特别的条件来重载默认条件。 + </para> + + + </sect1> + +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/inheritance_mapping.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/inheritance_mapping.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/inheritance_mapping.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/inheritance_mapping.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,467 @@ + <chapter id="inheritance"> + <title>继承映射(Inheritance Mappings)</title> + + <sect1 id="inheritance-strategies" revision="3"> + <title> 三种策略</title> + + + <para> + Hibernate支持三种基本的继承映射策略： + </para> + + <itemizedlist> + <listitem> + <para> + 每个类分层结构一张表(table per class hierarchy) + </para> + </listitem> + <listitem> + <para> + 每个子类一张表(table per subclass) + </para> + </listitem> + <listitem> + <para> + 每个具体类一张表(table per concrete class) + </para> + </listitem> + </itemizedlist> + <para> + 此外，Hibernate还支持第四种稍有不同的多态映射策略： + </para> + + <itemizedlist> + <listitem> + <para> + 隐式多态(implicit polymorphism) + </para> + </listitem> + </itemizedlist> + + <para> + 对于同一个继承层次内的不同分支，可以采用不同的映射策略，然后用隐式多 + 态来完成跨越整个层次的多态。但是在同一个<literal>&lt;class&gt;</literal>根元素 + 下，Hibernate不支持混合了元素<literal>&lt;subclass&gt;</literal>、 + <literal>&lt;joined-subclass&gt;</literal>和<literal>&lt;union-subclass&gt;</literal> + 的映射。在同一个<literal>&lt;class&gt;</literal>元素下，可以混合使用 + “每个类分层结构一张表”（table per hierarchy） 和“每个子类一张表”（table per subclass） + 这两种映射策略，这是通过结合元素<literal>&lt;subclass&gt;</literal>和 + <literal>&lt;join&gt;</literal>来实现的（见后）。 + + </para> + + <para> + 在多个映射文件中，可以直接在<literal>hibernate-mapping</literal>根下定义<literal>subclass</literal>，<literal>union-subclass</literal>和<literal>joined-subclass</literal>。也就是说，你可以仅加入一个新的映射文件来扩展类层次。你必须在subclass的映射中指明<literal>extends</literal>属性，给出一个之前定义的超类的名字。注意，在以前，这一功能对映射文件的顺序有严格的要求，从Hibernate 3开始，使用extends关键字的时侯，对映射文件的顺序不再有要求；但在每个映射文件里，超类必须在子类之前定义。 + </para> + + <programlisting><![CDATA[ + <hibernate-mapping> + <subclass name="DomesticCat" extends="Cat" discriminator-value="D"> + <property name="name" type="string"/> + </subclass> + </hibernate-mapping>]]></programlisting> + + <sect2 id="inheritance-tableperclass" > + <title>每个类分层结构一张表(Table per class hierarchy)</title> + + + <para> + 假设我们有接口<literal>Payment</literal>和它的几个实现类： + <literal>CreditCardPayment</literal>, <literal>CashPayment</literal>, + 和<literal>ChequePayment</literal>。则“每个类分层结构一张表”(Table per + class hierarchy)的映射代码如下所示： + </para> + + <programlisting><![CDATA[<class name="Payment" table="PAYMENT"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="native"/> + </id> + <discriminator column="PAYMENT_TYPE" type="string"/> + <property name="amount" column="AMOUNT"/> + ... + <subclass name="CreditCardPayment" discriminator-value="CREDIT"> + <property name="creditCardType" column="CCTYPE"/> + ... + </subclass> + <subclass name="CashPayment" discriminator-value="CASH"> + ... + </subclass> + <subclass name="ChequePayment" discriminator-value="CHEQUE"> + ... + </subclass> +</class>]]></programlisting> + + <para> + 采用这种策略只需要一张表即可。它有一个很大的限制：要求那些由子类定义的字段， + 如<literal>CCTYPE</literal>，不能有<literal>非空(NOT NULL)</literal>约束。 + </para> + + </sect2> + + <sect2 id="inheritance-tablepersubclass"> + + <title>每个子类一张表(Table per subclass)</title> + + + <para> + 对于上例中的几个类而言，采用“每个子类一张表”的映射策略，代码如下所示： + </para> + + <programlisting><![CDATA[<class name="Payment" table="PAYMENT"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="native"/> + </id> + <property name="amount" column="AMOUNT"/> + ... + <joined-subclass name="CreditCardPayment" table="CREDIT_PAYMENT"> + <key column="PAYMENT_ID"/> + ... + </joined-subclass> + <joined-subclass name="CashPayment" table="CASH_PAYMENT"> + <key column="PAYMENT_ID"/> + <property name="creditCardType" column="CCTYPE"/> + ... + </joined-subclass> + <joined-subclass name="ChequePayment" table="CHEQUE_PAYMENT"> + <key column="PAYMENT_ID"/> + ... + </joined-subclass> +</class>]]></programlisting> + <para> + 需要四张表。三个子类表通过主键关联到超类表(因而关系模型实际上是一对一关联)。 + </para> + + </sect2> + + <sect2 id="inheritance-tablepersubclass-discriminator" revision="2"> + + <title>每个子类一张表(Table per subclass)，使用辨别标志(Discriminator)</title> + + <para> + 注意，对“每个子类一张表”的映射策略，Hibernate的实现不需要辨别字段，而其他 + 的对象/关系映射工具使用了一种不同于Hibernate的实现方法，该方法要求在超类 + 表中有一个类型辨别字段(type discriminator column)。Hibernate采用的方法更 + 难实现，但从关系（数据库）的角度来看，按理说它更正确。若你愿意使用带有辨别字 + 段的“每个子类一张表”的策略，你可以结合使用<literal>&lt;subclass&gt;</literal> + 与<literal>&lt;join&gt;</literal>，如下所示： + </para> + + <programlisting><![CDATA[<class name="Payment" table="PAYMENT"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="native"/> + </id> + <discriminator column="PAYMENT_TYPE" type="string"/> + <property name="amount" column="AMOUNT"/> + ... + <subclass name="CreditCardPayment" discriminator-value="CREDIT"> + <join table="CREDIT_PAYMENT"> + <key column="PAYMENT_ID"/> + <property name="creditCardType" column="CCTYPE"/> + ... + </join> + </subclass> + <subclass name="CashPayment" discriminator-value="CASH"> + <join table="CASH_PAYMENT"> + <key column="PAYMENT_ID"/> + ... + </join> + </subclass> + <subclass name="ChequePayment" discriminator-value="CHEQUE"> + <join table="CHEQUE_PAYMENT" fetch="select"> + <key column="PAYMENT_ID"/> + ... + </join> + </subclass> +</class>]]></programlisting> + + + <para> + 可选的声明<literal>fetch="select"</literal>，是用来告诉Hibernate，在查询超类时， + 不要使用外部连接(outer join)来抓取子类<literal>ChequePayment</literal>的数据。 + </para> + + </sect2> + + <sect2 id="inheritance-mixing-tableperclass-tablepersubclass"> + <title>混合使用“每个类分层结构一张表”和“每个子类一张表”</title> + + <para> + 你甚至可以采取如下方法混和使用“每个类分层结构一张表”和“每个子类一张表”这两种策略： + </para> + + <programlisting><![CDATA[<class name="Payment" table="PAYMENT"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="native"/> + </id> + <discriminator column="PAYMENT_TYPE" type="string"/> + <property name="amount" column="AMOUNT"/> + ... + <subclass name="CreditCardPayment" discriminator-value="CREDIT"> + <join table="CREDIT_PAYMENT"> + <property name="creditCardType" column="CCTYPE"/> + ... + </join> + </subclass> + <subclass name="CashPayment" discriminator-value="CASH"> + ... + </subclass> + <subclass name="ChequePayment" discriminator-value="CHEQUE"> + ... + </subclass> +</class>]]></programlisting> + + <para> + 对上述任何一种映射策略而言，指向根类<literal>Payment</literal>的 + 关联是使用<literal>&lt;many-to-one&gt;</literal>进行映射的。 + </para> + + <programlisting><![CDATA[<many-to-one name="payment" column="PAYMENT_ID" class="Payment"/>]]></programlisting> + + </sect2> + + <sect2 id="inheritance-tableperconcrete" revision="2"> + <title>每个具体类一张表(Table per concrete class)</title> + + <para> + 对于“每个具体类一张表”的映射策略，可以采用两种方法。第一种方法是使用 + <literal>&lt;union-subclass&gt;</literal>。 + </para> + + <programlisting><![CDATA[<class name="Payment"> + <id name="id" type="long" column="PAYMENT_ID"> + <generator class="sequence"/> + </id> + <property name="amount" column="AMOUNT"/> + ... + <union-subclass name="CreditCardPayment" table="CREDIT_PAYMENT"> + <property name="creditCardType" column="CCTYPE"/> + ... + </union-subclass> + <union-subclass name="CashPayment" table="CASH_PAYMENT"> + ... + </union-subclass> + <union-subclass name="ChequePayment" table="CHEQUE_PAYMENT"> + ... + </union-subclass> +</class>]]></programlisting> + + <para> + 这里涉及三张与子类相关的表。每张表为对应类的所有属性（包括从超类继承的属性）定义相应字段。 + </para> + + <para> + 这种方式的局限在于，如果一个属性在超类中做了映射，其字段名必须与所有子类 + 表中定义的相同。(我们可能会在Hibernate的后续发布版本中放宽此限制。) + 不允许在联合子类(union subclass)的继承层次中使用标识生成器策略(identity generator strategy), + 实际上, 主键的种子(primary key seed)不得不为同一继承层次中的全部被联合子类所共用. + </para> + + <para> + 假若超类是抽象类，请使用<literal>abstract="true"</literal>。当然，假若它不是抽象的，需要一个额外的表（上面的例子中，默认是<literal>PAYMENT</literal>），来保存超类的实例。 + </para> + + </sect2> + + <sect2 id="inheritance-tableperconcreate-polymorphism"> + <title>Table per concrete class, using implicit polymorphism</title> + <title>每个具体类一张表，使用隐式多态</title> + + <para> + 另一种可供选择的方法是采用隐式多态： + </para> + + <programlisting><![CDATA[<class name="CreditCardPayment" table="CREDIT_PAYMENT"> + <id name="id" type="long" column="CREDIT_PAYMENT_ID"> + <generator class="native"/> + </id> + <property name="amount" column="CREDIT_AMOUNT"/> + ... +</class> + +<class name="CashPayment" table="CASH_PAYMENT"> + <id name="id" type="long" column="CASH_PAYMENT_ID"> + <generator class="native"/> + </id> + <property name="amount" column="CASH_AMOUNT"/> + ... +</class> + +<class name="ChequePayment" table="CHEQUE_PAYMENT"> + <id name="id" type="long" column="CHEQUE_PAYMENT_ID"> + <generator class="native"/> + </id> + <property name="amount" column="CHEQUE_AMOUNT"/> + ... +</class>]]></programlisting> + + <para> + 注意，我们没有在任何地方明确的提及接口<literal>Payment</literal>。同时注意 + <literal>Payment</literal>的属性在每个子类中都进行了映射。如果你想避免重复， + 可以考虑使用XML实体(例如：位于<literal>DOCTYPE</literal>声明内的 + <literal>[ &lt;!ENTITY allproperties SYSTEM "allproperties.xml"&gt; ]</literal> + 和映射中的<literal>&amp;allproperties;</literal>)。 + </para> + + <para> + 这种方法的缺陷在于，在Hibernate执行多态查询时(polymorphic queries)无法生成带 + <literal>UNION</literal>的SQL语句。 + </para> + + <para> + 对于这种映射策略而言，通常用<literal>&lt;any&gt;</literal>来实现到 + <literal>Payment</literal>的多态关联映射。 + </para> + + <programlisting><![CDATA[<any name="payment" meta-type="string" id-type="long"> + <meta-value value="CREDIT" class="CreditCardPayment"/> + <meta-value value="CASH" class="CashPayment"/> + <meta-value value="CHEQUE" class="ChequePayment"/> + <column name="PAYMENT_CLASS"/> + <column name="PAYMENT_ID"/> +</any>]]></programlisting> + + </sect2> + + <sect2 id="inheritace-mixingpolymorphism"> + <title>隐式多态和其他继承映射混合使用</title> + + <para> + 对这一映射还有一点需要注意。因为每个子类都在各自独立的元素<literal>&lt;class&gt;</literal> + 中映射(并且<literal>Payment</literal>只是一个接口)，每个子类可以很容易的成为另一 + 个继承体系中的一部分！(你仍然可以对接口<literal>Payment</literal>使用多态查询。) + </para> + + <programlisting><![CDATA[<class name="CreditCardPayment" table="CREDIT_PAYMENT"> + <id name="id" type="long" column="CREDIT_PAYMENT_ID"> + <generator class="native"/> + </id> + <discriminator column="CREDIT_CARD" type="string"/> + <property name="amount" column="CREDIT_AMOUNT"/> + ... + <subclass name="MasterCardPayment" discriminator-value="MDC"/> + <subclass name="VisaPayment" discriminator-value="VISA"/> +</class> + +<class name="NonelectronicTransaction" table="NONELECTRONIC_TXN"> + <id name="id" type="long" column="TXN_ID"> + <generator class="native"/> + </id> + ... + <joined-subclass name="CashPayment" table="CASH_PAYMENT"> + <key column="PAYMENT_ID"/> + <property name="amount" column="CASH_AMOUNT"/> + ... + </joined-subclass> + <joined-subclass name="ChequePayment" table="CHEQUE_PAYMENT"> + <key column="PAYMENT_ID"/> + <property name="amount" column="CHEQUE_AMOUNT"/> + ... + </joined-subclass> +</class>]]></programlisting> + + <para> + 我们还是没有明确的提到<literal>Payment</literal>。 + 如果我们针对接口<literal>Payment</literal>执行查询 + ——如<literal>from Payment</literal>—— Hibernate + 自动返回<literal>CreditCardPayment</literal>(和它的子类，因为 + 它们也实现了接口<literal>Payment</literal>)、 + <literal>CashPayment</literal>和<literal>Chequepayment</literal>的实例， + 但不返回<literal>NonelectronicTransaction</literal>的实例。 + </para> + + </sect2> + + </sect1> + + <sect1 id="inheritance-limitations"> + <title>限制</title> + + <para> + 对“每个具体类映射一张表”（table per concrete-class）的映射策略而言，隐式多态的 + 方式有一定的限制。而<literal>&lt;union-subclass&gt;</literal>映射的限制则没有那 + 么严格。 + </para> + + <para> + 下面表格中列出了在Hibernte中“每个具体类一张表”的策略和隐式多态的限制。 + </para> + + <table frame="topbot"> + <title>继承映射特性(Features of inheritance mappings) </title> + <tgroup cols='8' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="1*"/> + <colspec colname='c3' colwidth="1*"/> + <colspec colname='c4' colwidth="1*"/> + <colspec colname='c5' colwidth="1*"/> + <colspec colname='c6' colwidth="1*"/> + <colspec colname='c7' colwidth="1*"/> + <colspec colname='c8' colwidth="1*"/> + <thead> + <row> + <entry>继承策略(Inheritance strategy)</entry> + <entry>多态多对一</entry> + <entry>多态一对一</entry> + <entry>多态一对多</entry> + <entry>多态多对多</entry> + <entry>多态 <literal>load()/get()</literal></entry> + <entry>多态查询</entry> + <entry>多态连接(join)</entry> + <entry>外连接(Outer join)读取</entry> + </row> + </thead> + <tbody> + <row> + + <entry>每个类分层结构一张表</entry> + <entry><literal>&lt;many-to-one&gt;</literal></entry> + <entry><literal>&lt;one-to-one&gt;</literal></entry> + <entry><literal>&lt;one-to-many&gt;</literal></entry> + <entry><literal>&lt;many-to-many&gt;</literal></entry> + <entry><literal>s.get(Payment.class, id)</literal></entry> + <entry><literal>from Payment p</literal></entry> + <entry><literal>from Order o join o.payment p</literal></entry> + <entry><emphasis>支持</emphasis></entry> + </row> + <row> + <entry>每个子类一张表</entry> + <entry><literal>&lt;many-to-one&gt;</literal></entry> + <entry><literal>&lt;one-to-one&gt;</literal></entry> + <entry><literal>&lt;one-to-many&gt;</literal></entry> + <entry><literal>&lt;many-to-many&gt;</literal></entry> + <entry><literal>s.get(Payment.class, id)</literal></entry> + <entry><literal>from Payment p</literal></entry> + <entry><literal>from Order o join o.payment p</literal></entry> + <entry><emphasis>支持</emphasis></entry> + </row> + <row> + + <entry>每个具体类一张表(union-subclass)</entry> + <entry><literal>&lt;many-to-one&gt;</literal></entry> + <entry><literal>&lt;one-to-one&gt;</literal></entry> + <entry><literal>&lt;one-to-many&gt;</literal> (仅对于<literal>inverse="true"</literal>的情况)</entry> + <entry><literal>&lt;many-to-many&gt;</literal></entry> + <entry><literal>s.get(Payment.class, id)</literal></entry> + <entry><literal>from Payment p</literal></entry> + <entry><literal>from Order o join o.payment p</literal></entry> + <entry><emphasis>支持</emphasis></entry> + </row> + <row> + + <entry>每个具体类一张表(隐式多态)</entry> + <entry><literal>&lt;any&gt;</literal></entry> + <entry><emphasis>不支持</emphasis></entry> + <entry><emphasis>不支持</emphasis></entry> + <entry><literal>&lt;many-to-any&gt;</literal></entry> + <entry><literal>s.createCriteria(Payment.class).add( Restrictions.idEq(id) ).uniqueResult()</literal></entry> + <entry><literal>from Payment p</literal></entry> + <entry><emphasis>不支持</emphasis></entry> + <entry><emphasis>不支持</emphasis></entry> + </row> + </tbody> + </tgroup> + </table> + + </sect1> + + </chapter> Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/performance.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/performance.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/performance.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/performance.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,1315 @@ +<chapter id="performance"> + <title>提升性能 + </title> + <sect1 id="performance-fetching" revision="2"> + <title> + 抓取策略(Fetching strategies) + </title> + + <para> + + <emphasis>抓取策略（fetching strategy）</emphasis> 是指：当应用程序需要在（Hibernate实体对象图的）关联关系间进行导航的时候， + Hibernate如何获取关联对象的策略。抓取策略可以在O/R映射的元数据中声明，也可以在特定的HQL + 或<literal>条件查询（Criteria Query）</literal>中重载声明。 + </para> + + <para> + Hibernate3 定义了如下几种抓取策略： + </para> + + <itemizedlist> + <listitem> + <para> + + <emphasis>连接抓取（Join fetching）</emphasis> - Hibernate通过 + 在<literal>SELECT</literal>语句使用<literal>OUTER JOIN</literal>（外连接）来 + 获得对象的关联实例或者关联集合。 + </para> + </listitem> + <listitem> + <para> + + <emphasis>查询抓取（Select fetching）</emphasis> - 另外发送一条 <literal>SELECT</literal> + 语句抓取当前对象的关联实体或集合。除非你显式的指定<literal>lazy="false"</literal>禁止 + 延迟抓取（lazy fetching），否则只有当你真正访问关联关系的时候，才会执行第二条select语句。 + </para> + </listitem> + <listitem> + <para> + <emphasis>子查询抓取（Subselect fetching）</emphasis> - 另外发送一条<literal>SELECT</literal> + 语句抓取在前面查询到（或者抓取到）的所有实体对象的关联集合。除非你显式的指定<literal>lazy="false"</literal> + 禁止延迟抓取（lazy fetching），否则只有当你真正访问关联关系的时候，才会执行第二条select语句。 + </para> + </listitem> + <listitem> + <para> + + <emphasis>批量抓取（Batch fetching）</emphasis> - 对查询抓取的优化方案， + 通过指定一个主键或外键列表，Hibernate使用单条<literal>SELECT</literal>语句获取一批对象实例或集合。 + </para> + </listitem> + </itemizedlist> + + <para> + Hibernate会区分下列各种情况： + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Immediate fetching，立即抓取</emphasis> - 当宿主被加载时，关联、集合或属性被立即抓取。 + </para> + </listitem> + <listitem> + <para> + <emphasis>Lazy collection fetching，延迟集合抓取</emphasis>- 直到应用程序对集合进行了一次操作时，集合才被抓取。（对集合而言这是默认行为。） + </para> + </listitem> + <listitem> + <para> + <emphasis>"Extra-lazy" collection fetching,"Extra-lazy"集合抓取</emphasis> -对集合类中的每个元素而言，都是直到需要时才去访问数据库。除非绝对必要，Hibernate不会试图去把整个集合都抓取到内存里来（适用于非常大的集合）。 + </para> + </listitem> + <listitem> + <para> + <emphasis>Proxy fetching，代理抓取</emphasis> - 对返回单值的关联而言，当其某个方法被调用，而非对其关键字进行get操作时才抓取。 + </para> + </listitem> + <listitem> + <para> + <emphasis>"No-proxy" fetching,非代理抓取</emphasis> - 对返回单值的关联而言，当实例变量被访问的时候进行抓取。与上面的代理抓取相比，这种方法没有那么“延迟”得厉害(就算只访问标识符，也会导致关联抓取)但是更加透明，因为对应用程序来说，不再看到proxy。这种方法需要在编译期间进行字节码增强操作，因此很少需要用到。 + </para> + </listitem> + <listitem> + <para> + <emphasis>Lazy attribute fetching，属性延迟加载</emphasis> - 对属性或返回单值的关联而言，当其实例变量被访问的时候进行抓取。需要编译期字节码强化，因此这一方法很少是必要的。 + </para> + </listitem> + </itemizedlist> + + <para> + 这里有两个正交的概念：关联<emphasis>何时</emphasis>被抓取，以及被<emphasis>如何</emphasis>抓取（会采用什么样的SQL语句）。不要混淆它们！我们使用<literal>抓取</literal>来改善性能。我们使用<literal>延迟</literal>来定义一些契约，对某特定类的某个脱管的实例，知道有哪些数据是可以使用的。 + </para> + + <sect2 id="performance-fetching-lazy"> + <title>操作延迟加载的关联</title> + + <para> + 默认情况下，Hibernate 3对集合使用延迟select抓取，对返回单值的关联使用延迟代理抓取。对几乎是所有的应用而言，其绝大多数的关联，这种策略都是有效的。 + </para> + + <para> + <emphasis>注意:</emphasis>假若你设置了<literal>hibernate.default_batch_fetch_size</literal>,Hibernate会对延迟加载采取批量抓取优化措施（这种优化也可能会在更细化的级别打开）。 + </para> + + <para> + 然而，你必须了解延迟抓取带来的一个问题。在一个打开的Hibernate session上下文之外调用延迟集合会导致一次意外。比如： + </para> + + <programlisting><![CDATA[s = sessions.openSession(); +Transaction tx = s.beginTransaction(); + +User u = (User) s.createQuery("from User u where u.name=:userName") + .setString("userName", userName).uniqueResult(); +Map permissions = u.getPermissions(); + +tx.commit(); +s.close(); + +Integer accessLevel = (Integer) permissions.get("accounts"); // Error!]]></programlisting> + + <para> + 在<literal>Session</literal>关闭后，permessions集合将是未实例化的、不再可用，因此无法正常载入其状态。 + <emphasis>Hibernate对脱管对象不支持延迟实例化</emphasis>. 这里的修改方法是：将permissions读取数据的代码 + 移到tx.commit()之前。 + </para> + + <para> + 除此之外，通过对关联映射指定<literal>lazy="false"</literal>,我们也可以使用非延迟的集合或关联。但是， + 对绝大部分集合来说，更推荐使用延迟方式抓取数据。如果在你的对象模型中定义了太多的非延迟关联，Hibernate最终几乎需要在每个事务中载入整个数据库到内存中！ + </para> + + <para> + + 但是，另一方面，在一些特殊的事务中，我们也经常需要使用到连接抓取（它本身上就是非延迟的），以代替查询抓取。 + 下面我们将会很快明白如何具体的定制Hibernate中的抓取策略。在Hibernate3中，具体选择哪种抓取策略的机制是和选择 + 单值关联或集合关联相一致的。 + </para> + </sect2> + + + <sect2 id="performance-fetching-custom" revision="4"> + <title> + + 调整抓取策略（Tuning fetch strategies） + </title> + + <para> + + 查询抓取（默认的）在N+1查询的情况下是极其脆弱的，因此我们可能会要求在映射文档中定义使用连接抓取： + </para> + <programlisting><![CDATA[<set name="permissions" + fetch="join"> + <key column="userId"/> + <one-to-many class="Permission"/> +</set]]></programlisting> + + <programlisting><![CDATA[<many-to-one name="mother" class="Cat" fetch="join"/>]]></programlisting> + + <para> + 在映射文档中定义的<literal>抓取</literal>策略将会对以下列表条目产生影响： + </para> + + <itemizedlist> + <listitem> + <para> + + 通过<literal>get()</literal>或<literal>load()</literal>方法取得数据。 + </para> + </listitem> + <listitem> + <para> + 只有在关联之间进行导航时，才会隐式的取得数据。 + </para> + </listitem> + <listitem> + <para> + <literal>条件查询</literal> + </para> + </listitem> + <listitem> + <para> + 使用了<literal>subselect</literal>抓取的HQL查询 + </para> + </listitem> + </itemizedlist> + + <para> + 不管你使用哪种抓取策略，定义为非延迟的类图会被保证一定装载入内存。注意这可能意味着在一条HQL查询后紧跟着一系列的查询。 + </para> + + <para> + 通常情况下，我们并不使用映射文档进行抓取策略的定制。更多的是，保持其默认值，然后在特定的事务中， + 使用HQL的<literal>左连接抓取（left join fetch）</literal> 对其进行重载。这将通知 + Hibernate在第一次查询中使用外部关联（outer join），直接得到其关联数据。 + 在<literal>条件查询</literal> API中，应该调用 <literal>setFetchMode(FetchMode.JOIN)</literal>语句。 + </para> + + <para> + 也许你喜欢仅仅通过条件查询，就可以改变<literal>get()</literal> + 或 <literal>load()</literal>语句中的数据抓取策略。例如： + </para> + + <programlisting><![CDATA[User user = (User) session.createCriteria(User.class) + .setFetchMode("permissions", FetchMode.JOIN) + .add( Restrictions.idEq(userId) ) + .uniqueResult();]]></programlisting> + + <para> + + （这就是其他ORM解决方案的“抓取计划(fetch plan)”在Hibernate中的等价物。） + </para> + + + <para> + 截然不同的一种避免N+1次查询的方法是，使用二级缓存。 + </para> + + </sect2> + + <sect2 id="performance-fetching-proxies" revision="2"> + <title>单端关联代理（Single-ended association proxies） + </title> + + <para> + 在Hinerbate中，对集合的延迟抓取的采用了自己的实现方法。但是，对于单端关联的延迟抓取，则需要采用 + 其他不同的机制。单端关联的目标实体必须使用代理，Hihernate在运行期二进制级（通过优异的CGLIB库）， + 为持久对象实现了延迟载入代理。 + </para> + + <para> + 默认的，Hibernate3将会为所有的持久对象产生代理（在启动阶段），然后使用他们实现 + <literal>多对一（many-to-one）</literal>关联和<literal>一对一（one-to-one）</literal> + 关联的延迟抓取。 + </para> + + <para> + 在映射文件中，可以通过设置<literal>proxy</literal>属性为目标class声明一个接口供代理接口使用。 + 默认的，Hibernate将会使用该类的一个子类。 + <emphasis>注意：被代理的类必须实现一个至少包可见的默认构造函数，我们建议所有的持久类都应拥有这样的构造函数</emphasis> + </para> + + <para> + 在如此方式定义一个多态类的时候，有许多值得注意的常见性的问题，例如： + </para> + + <programlisting><![CDATA[<class name="Cat" proxy="Cat"> + ...... + <subclass name="DomesticCat"> + ..... + </subclass> +</class>]]></programlisting> + + <para> + 首先，<literal>Cat</literal>实例永远不可以被强制转换为<literal>DomesticCat</literal>, + 即使它本身就是<literal>DomesticCat</literal>实例。 + </para> + + <programlisting><![CDATA[Cat cat = (Cat) session.load(Cat.class, id); // instantiate a proxy (does not hit the db) +if ( cat.isDomesticCat() ) { // hit the db to initialize the proxy + DomesticCat dc = (DomesticCat) cat; // Error! + .... +}]]></programlisting> + + <para> + 其次，代理的“<literal>==</literal>”可能不再成立。 + </para> + + <programlisting><![CDATA[Cat cat = (Cat) session.load(Cat.class, id); // instantiate a Cat proxy +DomesticCat dc = + (DomesticCat) session.load(DomesticCat.class, id); // acquire new DomesticCat proxy! +System.out.println(cat==dc); // false]]></programlisting> + + <para> + 虽然如此，但实际情况并没有看上去那么糟糕。虽然我们现在有两个不同的引用，分别指向这两个不同的代理对象， + 但实际上，其底层应该是同一个实例对象： + </para> + + <programlisting><![CDATA[cat.setWeight(11.0); // hit the db to initialize the proxy +System.out.println( dc.getWeight() ); // 11.0]]></programlisting> + + <para> + 第三，你不能对“final类”或“具有final方法的类”使用CGLIB代理。 + </para> + + <para> + 最后，如果你的持久化对象在实例化时需要某些资源（例如，在实例化方法、默认构造方法中）， + 那么代理对象也同样需要使用这些资源。实际上，代理类是持久化类的子类。 + </para> + + <para> + + 这些问题都源于Java的单根继承模型的天生限制。如果你希望避免这些问题，那么你的每个持久化类必须实现一个接口， + 在此接口中已经声明了其业务方法。然后，你需要在映射文档中再指定这些接口。例如： + </para> + + <programlisting><![CDATA[<class name="CatImpl" proxy="Cat"> + ...... + <subclass name="DomesticCatImpl" proxy="DomesticCat"> + ..... + </subclass> +</class>]]></programlisting> + + <para> + + 这里<literal>CatImpl</literal>实现了<literal>Cat</literal>接口， + <literal>DomesticCatImpl</literal>实现<literal>DomesticCat</literal>接口。 + 在<literal>load()</literal>、<literal>iterate()</literal>方法中就会返回 + <literal>Cat</literal>和<literal>DomesticCat</literal>的代理对象。 + (注意<literal>list()</literal>并不会返回代理对象。) + </para> + + <programlisting><![CDATA[Cat cat = (Cat) session.load(CatImpl.class, catid); +Iterator iter = session.createQuery("from CatImpl as cat where cat.name='fritz'").iterate(); +Cat fritz = (Cat) iter.next();]]></programlisting> + + <para> + + 这里，对象之间的关系也将被延迟载入。这就意味着，你应该将属性声明为<literal>Cat</literal>，而不是<literal>CatImpl</literal>。 + </para> + + <para> + + 但是，在有些方法中是<emphasis>不需要</emphasis>使用代理的。例如： + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>equals()</literal>方法，如果持久类没有重载<literal>equals()</literal>方法。 + </para> + </listitem> + <listitem> + <para> + <literal>hashCode()</literal>方法，如果持久类没有重载<literal>hashCode()</literal>方法。 + </para> + </listitem> + <listitem> + <para> + 标志符的getter方法。 + </para> + </listitem> + </itemizedlist> + + <para> + Hibernate将会识别出那些重载了<literal>equals()</literal>、或<literal>hashCode()</literal>方法的持久化类。 + </para> + <para> + 若选择<literal>lazy="no-proxy"</literal>而非默认的<literal>lazy="proxy"</literal>，我们可以避免类型转换带来的问题。然而，这样我们就需要编译期字节码增强，并且所有的操作都会导致立刻进行代理初始化。 + + </para> + + </sect2> + + <sect2 id="performance-fetching-initialization" revision="1"> + <title>实例化集合和代理（Initializing collections and proxies） + </title> + + <para> + 在<literal>Session</literal>范围之外访问未初始化的集合或代理，Hibernate将会抛出<literal>LazyInitializationException</literal>异常。 + 也就是说，在分离状态下，访问一个实体所拥有的集合，或者访问其指向代理的属性时，会引发此异常。 + </para> + + <para> + + 有时候我们需要保证某个代理或者集合在Session关闭前就已经被初始化了。 + 当然，我们可以通过强行调用<literal>cat.getSex()</literal>或者<literal>cat.getKittens().size()</literal>之类的方法来确保这一点。 + 但是这样的程序会造成读者的疑惑，也不符合通常的代码规范。 + </para> + + <para> + + 静态方法<literal>Hibernate.initialized()</literal> + 为你的应用程序提供了一个便捷的途径来延迟加载集合或代理。 + 只要它的Session处于open状态，<literal>Hibernate.initialize(cat)</literal> 将会为cat强制对代理实例化。 + 同样，<literal>Hibernate.initialize( cat.getKittens() )</literal> 对kittens的集合具有同样的功能。 + </para> + + <para> + + 还有另外一种选择，就是保持<literal>Session</literal>一直处于open状态，直到所有需要的集合或代理都被载入。 + 在某些应用架构中，特别是对于那些使用Hibernate进行数据访问的代码，以及那些在不同应用层和不同物理进程中使用Hibernate的代码。 + 在集合实例化时，如何保证<literal>Session</literal>处于open状态经常会是一个问题。有两种方法可以解决此问题： + </para> + + <itemizedlist> + <listitem> + <para> + 在一个基于Web的应用中，可以利用servlet过滤器（filter），在用户请求（request）结束、页面生成 + 结束时关闭<literal>Session</literal>（这里使用了<emphasis>在展示层保持打开Session模式（Open Session in View）</emphasis>）， + 当然，这将依赖于应用框架中异常需要被正确的处理。在返回界面给用户之前，乃至在生成界面过程中发生异常的情况下， + 正确关闭<literal>Session</literal>和结束事务将是非常重要的， + 请参见Hibernate wiki上的"Open Session in View"模式，你可以找到示例。 + </para> + </listitem> + <listitem> + <para> + + 在一个拥有单独业务层的应用中，业务层必须在返回之前，为web层“准备”好其所需的数据集合。这就意味着 + 业务层应该载入所有表现层/web层所需的数据，并将这些已实例化完毕的数据返回。通常，应用程序应该 + 为web层所需的每个集合调用<literal>Hibernate.initialize()</literal>（这个调用必须发生咱session关闭之前）； + 或者使用带有<literal>FETCH</literal>从句，或<literal>FetchMode.JOIN</literal>的Hibernate查询， + 事先取得所有的数据集合。如果你在应用中使用了<emphasis>Command</emphasis>模式，代替<emphasis>Session Facade</emphasis> ， + 那么这项任务将会变得简单的多。 + </para> + </listitem> + <listitem> + <para> + 你也可以通过<literal>merge()</literal>或<literal>lock()</literal>方法，在访问未实例化的集合（或代理）之前， + 为先前载入的对象绑定一个新的<literal>Session</literal>。 + 显然，Hibernate将不会，也不<emphasis>应该</emphasis>自动完成这些任务，因为这将引入一个特殊的事务语义。 + </para> + </listitem> + </itemizedlist> + + <para> + 有时候，你并不需要完全实例化整个大的集合，仅需要了解它的部分信息（例如其大小）、或者集合的部分内容。 + </para> + + <para> + + 你可以使用集合过滤器得到其集合的大小，而不必实例化整个集合： + </para> + + <programlisting><![CDATA[( (Integer) s.createFilter( collection, "select count(*)" ).list().get(0) ).intValue()]]></programlisting> + + <para> + 这里的<literal>createFilter()</literal>方法也可以被用来有效的抓取集合的部分内容，而无需实例化整个集合： + </para> + + <programlisting><![CDATA[s.createFilter( lazyCollection, "").setFirstResult(0).setMaxResults(10).list();]]></programlisting> + + </sect2> + + <sect2 id="performance-fetching-batch"> + <title>使用批量抓取（Using batch fetching） + </title> + + <para> + Hibernate可以充分有效的使用批量抓取，也就是说，如果仅一个访问代理（或集合），那么Hibernate将不载入其他未实例化的代理。 + 批量抓取是延迟查询抓取的优化方案，你可以在两种批量抓取方案之间进行选择：在类级别和集合级别。 + </para> + + <para> + + 类/实体级别的批量抓取很容易理解。假设你在运行时将需要面对下面的问题：你在一个<literal>Session</literal>中载入了25个 + <literal>Cat</literal>实例，每个<literal>Cat</literal>实例都拥有一个引用成员<literal>owner</literal>， + 其指向<literal>Person</literal>，而<literal>Person</literal>类是代理，同时<literal>lazy="true"</literal>。 + 如果你必须遍历整个cats集合，对每个元素调用<literal>getOwner()</literal>方法，Hibernate将会默认的执行25次<literal>SELECT</literal>查询， + 得到其owner的代理对象。这时，你可以通过在映射文件的<literal>Person</literal>属性，显式声明<literal>batch-size</literal>，改变其行为： + + </para> + + <programlisting><![CDATA[<class name="Person" batch-size="10">...</class>]]></programlisting> + + <para> + 随之，Hibernate将只需要执行三次查询，分别为10、10、 5。 + </para> + + <para> + 你也可以在集合级别定义批量抓取。例如，如果每个<literal>Person</literal>都拥有一个延迟载入的<literal>Cats</literal>集合， + 现在，<literal>Sesssion</literal>中载入了10个person对象，遍历person集合将会引起10次<literal>SELECT</literal>查询， + 每次查询都会调用<literal>getCats()</literal>方法。如果你在<literal>Person</literal>的映射定义部分，允许对<literal>cats</literal>批量抓取, + 那么，Hibernate将可以预先抓取整个集合。请看例子： + </para> + + <programlisting><![CDATA[<class name="Person"> + <set name="cats" batch-size="3"> + ... + </set> +</class>]]></programlisting> + + <para> + 如果整个的<literal>batch-size</literal>是3（笔误？），那么Hibernate将会分四次执行<literal>SELECT</literal>查询， + 按照3、3、3、1的大小分别载入数据。这里的每次载入的数据量还具体依赖于当前<literal>Session</literal>中未实例化集合的个数。 + </para> + + <para> + 如果你的模型中有嵌套的树状结构，例如典型的帐单－原料结构（bill-of-materials pattern），集合的批量抓取是非常有用的。 + （尽管在更多情况下对树进行读取时，<emphasis>嵌套集合（nested set）</emphasis>或<emphasis>原料路径(materialized path)</emphasis>（××） + 是更好的解决方法。） + </para> + + </sect2> + + <sect2 id="performance-fetching-subselect"> + <title>使用子查询抓取（Using subselect fetching） + </title> + <para> + 假若一个延迟集合或单值代理需要抓取，Hibernate会使用一个subselect重新运行原来的查询，一次性读入所有的实例。这和批量抓取的实现方法是一样的，不会有破碎的加载。 + </para> + + <!-- TODO: Write more about this --> + </sect2> + + <sect2 id="performance-fetching-lazyproperties"> + <title>使用延迟属性抓取（Using lazy property fetching） + </title> + + <para> + Hibernate3对单独的属性支持延迟抓取，这项优化技术也被称为<emphasis>组抓取（fetch groups）</emphasis>。 + 请注意，该技术更多的属于市场特性。在实际应用中，优化行读取比优化列读取更重要。但是，仅载入类的部分属性在某些特定情况下会有用，例如在原有表中拥有几百列数据、数据模型无法改动的情况下。 + </para> + + <para> + + 可以在映射文件中对特定的属性设置<literal>lazy</literal>，定义该属性为延迟载入。 + </para> + + <programlisting><![CDATA[<class name="Document"> + <id name="id"> + <generator class="native"/> + </id> + <property name="name" not-null="true" length="50"/> + <property name="summary" not-null="true" length="200" lazy="true"/> + <property name="text" not-null="true" length="2000" lazy="true"/> +</class>]]></programlisting> + + <para> + + 属性的延迟载入要求在其代码构建时加入二进制指示指令（bytecode instrumentation），如果你的持久类代码中未含有这些指令， + Hibernate将会忽略这些属性的延迟设置，仍然将其直接载入。 + </para> + + <para> + 你可以在Ant的Task中，进行如下定义，对持久类代码加入“二进制指令。” + </para> + + <programlisting><![CDATA[<target name="instrument" depends="compile"> + <taskdef name="instrument" classname="org.hibernate.tool.instrument.InstrumentTask"> + <classpath path="${jar.path}"/> + <classpath path="${classes.dir}"/> + <classpath refid="lib.class.path"/> + </taskdef> + + <instrument verbose="true"> + <fileset dir="${testclasses.dir}/org/hibernate/auction/model"> + <include name="*.class"/> + </fileset> + </instrument> +</target>]]></programlisting> + + <para> + + 还有一种可以优化的方法，它使用HQL或条件查询的投影（projection）特性，可以避免读取非必要的列， + 这一点至少对只读事务是非常有用的。它无需在代码构建时“二进制指令”处理，因此是一个更加值得选择的解决方法。 + </para> + + <para> + 有时你需要在HQL中通过<literal>抓取所有属性</literal>，强行抓取所有内容。 + </para> + + </sect2> + + </sect1> + + <sect1 id="performance-cache" revision="1"> + <title>二级缓存（The Second Level Cache） + </title> + + <para> + Hibernate的<literal>Session</literal>在事务级别进行持久化数据的缓存操作。 + 当然，也有可能分别为每个类（或集合)，配置集群、或JVM级别(<literal>SessionFactory级别</literal>)的缓存。 + 你甚至可以为之插入一个集群的缓存。注意，缓存永远不知道其他应用程序对持久化仓库（数据库）可能进行的修改 + （即使可以将缓存数据设定为定期失效）。 + </para> + + <para revision="1"> + 通过在<literal>hibernate.cache.provider_class</literal>属性中指定<literal>org.hibernate.cache.CacheProvider</literal>的某个实现的类名,你可以选择让Hibernate使用哪个缓存实现。Hibernate打包一些开源缓存实现，提供对它们的内置支持（见下表）。除此之外，你也可以实现你自己的实现，将它们插入到系统中。注意，在3.2版本之前，默认使用EhCache 作为缓存实现，但从3.2起就不再这样了。 + </para> + + <table frame="topbot" id="cacheproviders" revision="1"> + <title> + 缓存策略提供商（Cache Providers） + </title> + <tgroup cols='5' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="3*"/> + <colspec colname='c3' colwidth="1*"/> + <colspec colname='c4' colwidth="1*"/> + <colspec colname='c5' colwidth="1*"/> + <thead> + <row> + <entry>Cache</entry> + <entry>Provider class</entry> + <entry>Type</entry> + <entry>Cluster Safe</entry> + <entry>Query Cache Supported</entry> + </row> + </thead> + <tbody> + <row> + <entry>Hashtable (not intended for production use)</entry> + <entry><literal>org.hibernate.cache.HashtableCacheProvider</literal></entry> + <entry>memory</entry> + <entry></entry> + <entry>yes</entry> + </row> + <row> + <entry>EHCache</entry> + <entry><literal>org.hibernate.cache.EhCacheProvider</literal></entry> + <entry>memory, disk</entry> + <entry></entry> + <entry>yes</entry> + </row> + <row> + <entry>OSCache</entry> + <entry><literal>org.hibernate.cache.OSCacheProvider</literal></entry> + <entry>memory, disk</entry> + <entry>yes (clustered invalidation)</entry> + <entry>yes</entry> + </row> + <row> + <entry>SwarmCache</entry> + <entry><literal>org.hibernate.cache.SwarmCacheProvider</literal></entry> + <entry>clustered (ip multicast)</entry> + <entry>yes (clustered invalidation)</entry> + <entry></entry> + </row> + <row> + <entry>JBoss TreeCache</entry> + <entry><literal>org.hibernate.cache.TreeCacheProvider</literal></entry> + <entry>clustered (ip multicast), transactional</entry> + <entry>yes (replication)</entry> + <entry>yes (clock sync req.)</entry> + </row> + </tbody> + </tgroup> + </table> + + <sect2 id="performance-cache-mapping" revision="2"> + <title>缓存映射（Cache mappings） + </title> + + <para> + 类或者集合映射的“<literal>&lt;cache&gt;</literal>元素”可以有下列形式： + </para> + + <programlistingco> + <areaspec> + <area id="cache1" coords="2 70"/> + <area id="cache2" coords="3 70"/> + <area id="cache3" coords="4 70"/> + </areaspec> + <programlisting><![CDATA[<cache + usage="transactional|read-write|nonstrict-read-write|read-only" + region="RegionName" + include="all|non-lazy" +/>]]></programlisting> + <calloutlist> + <callout arearefs="cache1"> + <para> + + <literal>usage</literal>(必须)说明了缓存的策略: + <literal>transactional</literal>、 + <literal>read-write</literal>、 + <literal>nonstrict-read-write</literal>或 + <literal>read-only</literal>。 + </para> + </callout> + <callout arearefs="cache2"> + <para> + <literal>region</literal> (可选, 默认为类或者集合的名字(class or + collection role name)) 指定第二级缓存的区域名(name of the second level cache + region) + + </para> + </callout> + <callout arearefs="cache3"> + <para> + <literal>include</literal> (可选,默认为 <literal>all</literal>) + <literal>non-lazy</literal> 当属性级延迟抓取打开时, 标记为<literal>lazy="true"</literal>的实体的属性可能无法被缓存 + </para> + </callout> + </calloutlist> + </programlistingco> + + <para> + 另外(首选?), 你可以在hibernate.cfg.xml中指定<literal>&lt;class-cache&gt;</literal>和 + <literal>&lt;collection-cache&gt;</literal> 元素。 + </para> + + <para> + + 这里的<literal>usage</literal> 属性指明了<emphasis>缓存并发策略（cache concurrency strategy）</emphasis>。 + </para> + + </sect2> + + <sect2 id="performance-cache-readonly"> + <title>策略：只读缓存（Strategy: read only） + </title> + + <para> + 如果你的应用程序只需读取一个持久化类的实例，而无需对其修改， + 那么就可以对其进行<literal>只读</literal> 缓存。这是最简单，也是实用性最好的方法。甚至在集群中，它也能完美地运作。 + </para> + + <programlisting><![CDATA[<class name="eg.Immutable" mutable="false"> + <cache usage="read-only"/> + .... +</class>]]></programlisting> + + </sect2> + + + <sect2 id="performance-cache-readwrite"> + <title> + 策略:读/写缓存（Strategy: read/write） + </title> + + <para> + + 如果应用程序需要更新数据，那么使用<literal>读/写缓存</literal> 比较合适。 + 如果应用程序要求“序列化事务”的隔离级别（serializable transaction isolation level），那么就决不能使用这种缓存策略。 + 如果在JTA环境中使用缓存，你必须指定<literal>hibernate.transaction.manager_lookup_class</literal>属性的值， + 通过它，Hibernate才能知道该应用程序中JTA的<literal>TransactionManager</literal>的具体策略。 + 在其它环境中，你必须保证在<literal>Session.close()</literal>、或<literal>Session.disconnect()</literal>调用前， + 整个事务已经结束。 如果你想在集群环境中使用此策略，你必须保证底层的缓存实现支持锁定(locking)。Hibernate内置的缓存策略并不支持锁定功能。 + </para> + + <programlisting><![CDATA[<class name="eg.Cat" .... > + <cache usage="read-write"/> + .... + <set name="kittens" ... > + <cache usage="read-write"/> + .... + </set> +</class>]]></programlisting> + + </sect2> + + <sect2 id="performance-cache-nonstrict"> + <title> + 策略:非严格读/写缓存（Strategy: nonstrict read/write） + </title> + + <para> + + 如果应用程序只偶尔需要更新数据（也就是说，两个事务同时更新同一记录的情况很不常见），也不需要十分严格的事务隔离， + 那么比较适合使用<literal>非严格读/写缓存</literal>策略。如果在JTA环境中使用该策略， + 你必须为其指定<literal>hibernate.transaction.manager_lookup_class</literal>属性的值， + 在其它环境中，你必须保证在<literal>Session.close()</literal>、或<literal>Session.disconnect()</literal>调用前， + 整个事务已经结束。 + </para> + + </sect2> + + <sect2 id="performance-cache-transactional"> + <title> + + 策略:事务缓存（transactional） + </title> + + <para> + Hibernate的<literal>事务缓存</literal>策略提供了全事务的缓存支持， + 例如对JBoss TreeCache的支持。这样的缓存只能用于JTA环境中，你必须指定 + 为其<literal>hibernate.transaction.manager_lookup_class</literal>属性。 + </para> + + </sect2> + + <para> + 没有一种缓存提供商能够支持上列的所有缓存并发策略。下表中列出了各种提供器、及其各自适用的并发策略。 + </para> + + <table frame="topbot"> + <title> + 各种缓存提供商对缓存并发策略的支持情况（Cache Concurrency Strategy Support） + </title> + <tgroup cols='5' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="1*"/> + <colspec colname='c3' colwidth="1*"/> + <colspec colname='c4' colwidth="1*"/> + <colspec colname='c5' colwidth="1*"/> + <thead> + <row> + <entry>Cache</entry> + <entry>read-only</entry> + <entry>nonstrict-read-write</entry> + <entry>read-write</entry> + <entry>transactional</entry> + </row> + </thead> + <tbody> + <row> + <entry>Hashtable (not intended for production use)</entry> + <entry>yes</entry> + <entry>yes</entry> + <entry>yes</entry> + <entry></entry> + </row> + <row> + <entry>EHCache</entry> + <entry>yes</entry> + <entry>yes</entry> + <entry>yes</entry> + <entry></entry> + </row> + <row> + <entry>OSCache</entry> + <entry>yes</entry> + <entry>yes</entry> + <entry>yes</entry> + <entry></entry> + </row> + <row> + <entry>SwarmCache</entry> + <entry>yes</entry> + <entry>yes</entry> + <entry></entry> + <entry></entry> + </row> + <row> + <entry>JBoss TreeCache</entry> + <entry>yes</entry> + <entry></entry> + <entry></entry> + <entry>yes</entry> + </row> + </tbody> + </tgroup> + </table> + + </sect1> + + <sect1 id="performance-sessioncache" revision="2"> + <title> + 管理缓存（Managing the caches） + </title> + + <para> + 无论何时，当你给<literal>save()</literal>、<literal>update()</literal>或 + <literal>saveOrUpdate()</literal>方法传递一个对象时，或使用<literal>load()</literal>、 + <literal>get()</literal>、<literal>list()</literal>、<literal>iterate()</literal> + 或<literal>scroll()</literal>方法获得一个对象时, + 该对象都将被加入到<literal>Session</literal>的内部缓存中。 + </para> + <para> + 当随后flush()方法被调用时，对象的状态会和数据库取得同步。 + 如果你不希望此同步操作发生，或者你正处理大量对象、需要对有效管理内存时，你可以调用<literal>evict()</literal> + 方法，从一级缓存中去掉这些对象及其集合。 + </para> + + <programlisting><![CDATA[ScrollableResult cats = sess.createQuery("from Cat as cat").scroll(); //a huge result set +while ( cats.next() ) { + Cat cat = (Cat) cats.get(0); + doSomethingWithACat(cat); + sess.evict(cat); +}]]></programlisting> + + <para> + Session还提供了一个<literal>contains()</literal>方法，用来判断某个实例是否处于当前session的缓存中。 + </para> + + <para> + 如若要把所有的对象从session缓存中彻底清除，则需要调用<literal>Session.clear()</literal>。 + </para> + + <para> + 对于二级缓存来说，在<literal>SessionFactory</literal>中定义了许多方法， + 清除缓存中实例、整个类、集合实例或者整个集合。 + </para> + + <programlisting><![CDATA[sessionFactory.evict(Cat.class, catId); //evict a particular Cat +sessionFactory.evict(Cat.class); //evict all Cats +sessionFactory.evictCollection("Cat.kittens", catId); //evict a particular collection of kittens +sessionFactory.evictCollection("Cat.kittens"); //evict all kitten collections]]></programlisting> + + <para> + <literal>CacheMode</literal>参数用于控制具体的Session如何与二级缓存进行交互。 + </para> + + <itemizedlist> + <listitem> + <para> + <literal>CacheMode.NORMAL</literal> - 从二级缓存中读、写数据。 + </para> + </listitem> + <listitem> + <para> + <literal>CacheMode.GET</literal> - 从二级缓存中读取数据，仅在数据更新时对二级缓存写数据。 + </para> + </listitem> + <listitem> + <para> + <literal>CacheMode.PUT</literal> - 仅向二级缓存写数据，但不从二级缓存中读数据。 + </para> + </listitem> + <listitem> + <para> + <literal>CacheMode.REFRESH</literal> - 仅向二级缓存写数据，但不从二级缓存中读数据。通过 + <literal>hibernate.cache.use_minimal_puts</literal>的设置，强制二级缓存从数据库中读取数据，刷新缓存内容。 + </para> + </listitem> + </itemizedlist> + + <para> + 如若需要查看二级缓存或查询缓存区域的内容，你可以使用<literal>统计（Statistics）</literal> API。 + </para> + + <programlisting><![CDATA[Map cacheEntries = sessionFactory.getStatistics() + .getSecondLevelCacheStatistics(regionName) + .getEntries();]]></programlisting> + + <para> + 此时，你必须手工打开统计选项。可选的，你可以让Hibernate更人工可读的方式维护缓存内容。 + </para> + + <programlisting><![CDATA[hibernate.generate_statistics true +hibernate.cache.use_structured_entries true]]></programlisting> + + </sect1> + + <sect1 id="performance-querycache" revision="1"> + <title>查询缓存（The Query Cache） + </title> + + <para> + 查询的结果集也可以被缓存。只有当经常使用同样的参数进行查询时，这才会有些用处。 + 要使用查询缓存，首先你必须打开它： + </para> + + <programlisting><![CDATA[hibernate.cache.use_query_cache true]]></programlisting> + + <para> + + 该设置将会创建两个缓存区域 - 一个用于保存查询结果集(<literal>org.hibernate.cache.StandardQueryCache</literal>)； + 另一个则用于保存最近查询的一系列表的时间戳(<literal>org.hibernate.cache.UpdateTimestampsCache</literal>)。 + 请注意：在查询缓存中，它并不缓存结果集中所包含的实体的确切状态；它只缓存这些实体的标识符属性的值、以及各值类型的结果。 + 所以查询缓存通常会和二级缓存一起使用。 + </para> + + <para> + + 绝大多数的查询并不能从查询缓存中受益，所以Hibernate默认是不进行查询缓存的。如若需要进行缓存，请调用 + <literal>Query.setCacheable(true)</literal>方法。这个调用会让查询在执行过程中时先从缓存中查找结果， + 并将自己的结果集放到缓存中去。 + </para> + + <para> + + 如果你要对查询缓存的失效政策进行精确的控制，你必须调用<literal>Query.setCacheRegion()</literal>方法， + 为每个查询指定其命名的缓存区域。 + </para> + + <programlisting><![CDATA[List blogs = sess.createQuery("from Blog blog where blog.blogger = :blogger") + .setEntity("blogger", blogger) + .setMaxResults(15) + .setCacheable(true) + .setCacheRegion("frontpages") + .list();]]></programlisting> + + <para> + 如果查询需要强行刷新其查询缓存区域，那么你应该调用<literal>Query.setCacheMode(CacheMode.REFRESH)</literal>方法。 + 这对在其他进程中修改底层数据（例如，不通过Hibernate修改数据），或对那些需要选择性更新特定查询结果集的情况特别有用。 + 这是对<literal>SessionFactory.evictQueries()</literal>的更为有效的替代方案，同样可以清除查询缓存区域。 + </para> + + </sect1> + + <sect1 id="performance-collections"> + <title> + 理解集合性能（Understanding Collection performance） + </title> + + <para> + 前面我们已经对集合进行了足够的讨论。本段中，我们将着重讲述集合在运行时的事宜。 + </para> + + <sect2 id="performance-collections-taxonomy"> + <title> + + 分类（Taxonomy） + </title> + + <para> + + Hibernate定义了三种基本类型的集合： + </para> + + <itemizedlist> + <listitem> + <para> + + 值数据集合 + </para> + </listitem> + <listitem> + <para> + + 一对多关联 + </para> + </listitem> + <listitem> + <para> + + 多对多关联 + </para> + </listitem> + </itemizedlist> + + <para> + 这个分类是区分了不同的表和外键关系类型，但是它没有告诉我们关系模型的所有内容。 + 要完全理解他们的关系结构和性能特点，我们必须同时考虑“用于Hibernate更新或删除集合行数据的主键的结构”。 + 因此得到了如下的分类： + </para> + + <itemizedlist> + <listitem> + <para> + + 有序集合类 + </para> + </listitem> + <listitem> + <para> + + 集合（sets） + </para> + </listitem> + <listitem> + <para> + + 包（bags) + </para> + </listitem> + </itemizedlist> + + <para> + + 所有的有序集合类（maps, lists, arrays)都拥有一个由<literal>&lt;key&gt;</literal>和 + <literal>&lt;index&gt;</literal>组成的主键。 + 这种情况下集合类的更新是非常高效的——主键已经被有效的索引，因此当Hibernate试图更新或删除一行时，可以迅速找到该行数据。 + </para> + + <para> + + 集合(sets)的主键由<literal>&lt;key&gt;</literal>和其他元素字段构成。 + 对于有些元素类型来说，这很低效，特别是组合元素或者大文本、大二进制字段； + 数据库可能无法有效的对复杂的主键进行索引。 + 另一方面，对于一对多、多对多关联，特别是合成的标识符来说，集合也可以达到同样的高效性能。（ + 附注：如果你希望<literal>SchemaExport</literal>为你的<literal>&lt;set&gt;</literal>创建主键， + 你必须把所有的字段都声明为<literal>not-null="true"</literal>。） + </para> + + <para> + + <literal>&lt;idbag&gt;</literal>映射定义了代理键，因此它总是可以很高效的被更新。事实上， + <literal>&lt;idbag&gt;</literal>拥有着最好的性能表现。 + </para> + + <para> + Bag是最差的。因为bag允许重复的元素值，也没有索引字段，因此不可能定义主键。 + Hibernate无法判断出重复的行。当这种集合被更改时，Hibernate将会先完整地移除 + （通过一个(in a single <literal>DELETE</literal>)）整个集合，然后再重新创建整个集合。 + 因此Bag是非常低效的。 + </para> + + <para> + 请注意：对于一对多关联来说，“主键”很可能并不是数据库表的物理主键。 + 但就算在此情况下，上面的分类仍然是有用的。（它仍然反映了Hibernate在集合的各数据行中是如何进行“定位”的。） + </para> + + </sect2> + + <sect2 id="performance-collections-mostefficientupdate"> + <title> + Lists, maps 和sets用于更新效率最高 + </title> + + <para> + + 根据我们上面的讨论，显然有序集合类型和大多数set都可以在增加、删除、修改元素中拥有最好的性能。 + </para> + + <para> + 可论证的是对于多对多关联、值数据集合而言，有序集合类比集合(set)有一个好处。因为<literal>Set</literal>的内在结构， + 如果“改变”了一个元素，Hibernate并不会<literal>更新（UPDATE）</literal>这一行。 + 对于<literal>Set</literal>来说，只有在<literal>插入（INSERT）</literal>和<literal>删除（DELETE）</literal> + 操作时“改变”才有效。再次强调：这段讨论对“一对多关联”并不适用。 + </para> + + <para> + 注意到数组无法延迟载入，我们可以得出结论，list, map和idbags是最高效的（非反向）集合类型，set则紧随其后。 + 在Hibernate中，set应该时最通用的集合类型，这时因为“set”的语义在关系模型中是最自然的。 + </para> + + <para> + 但是，在设计良好的Hibernate领域模型中，我们通常可以看到更多的集合事实上是带有<literal>inverse="true"</literal> + 的一对多的关联。对于这些关联，更新操作将会在多对一的这一端进行处理。因此对于此类情况，无需考虑其集合的更新性能。 + </para> + + </sect2> + + <sect2 id="performance-collections-mostefficentinverse"> + <title> + Bag和list是反向集合类中效率最高的 + </title> + + <para> + 在把bag扔进水沟之前，你必须了解，在一种情况下，bag的性能(包括list)要比set高得多： + 对于指明了<literal>inverse="true"</literal>的集合类（比如说，标准的双向的一对多关联）， + 我们可以在未初始化(fetch)包元素的情况下直接向bag或list添加新元素！ + 这是因为<literal>Collection.add()</literal>)或者<literal>Collection.addAll()</literal> 方法 + 对bag或者List总是返回true（这点与与Set不同）。因此对于下面的相同代码来说，速度会快得多。 + </para> + + <programlisting><![CDATA[Parent p = (Parent) sess.load(Parent.class, id); + Child c = new Child(); + c.setParent(p); + p.getChildren().add(c); //no need to fetch the collection! + sess.flush();]]></programlisting> + + </sect2> + + <sect2 id="performance-collections-oneshotdelete"> + <title> + 一次性删除（One shot delete） + </title> + + <para> + 偶尔的，逐个删除集合类中的元素是相当低效的。Hibernate并没那么笨， + 如果你想要把整个集合都删除（比如说调用list.clear()），Hibernate只需要一个DELETE就搞定了。 + </para> + + <para> + 假设我们在一个长度为20的集合类中新增加了一个元素，然后再删除两个。 + Hibernate会安排一条<literal>INSERT</literal>语句和两条<literal>DELETE</literal>语句（除非集合类是一个bag)。 + 这当然是显而易见的。 + </para> + + <para> + 但是，假设我们删除了18个数据，只剩下2个，然后新增3个。则有两种处理方式： + </para> + + <itemizedlist> + <listitem> + <para> + 逐一的删除这18个数据，再新增三个； + </para> + </listitem> + <listitem> + <para> + 删除整个集合类（只用一句DELETE语句），然后增加5个数据。 + </para> + </listitem> + </itemizedlist> + + <para> + Hibernate还没那么聪明，知道第二种选择可能会比较快。 + （也许让Hibernate不这么聪明也是好事，否则可能会引发意外的“数据库触发器”之类的问题。） + </para> + + <para> + 幸运的是，你可以强制使用第二种策略。你需要取消原来的整个集合类（解除其引用）， + 然后再返回一个新的实例化的集合类，只包含需要的元素。有些时候这是非常有用的。 + </para> + + <para> + 显然，一次性删除并不适用于被映射为<literal>inverse="true"</literal>的集合。 + </para> + + </sect2> + + </sect1> + + <sect1 id="performance-monitoring" revision="1"> + <title> + 监测性能（Monitoring performance） + </title> + + <para> + 没有监测和性能参数而进行优化是毫无意义的。Hibernate为其内部操作提供了一系列的示意图，因此可以从 + 每个<literal>SessionFactory</literal>抓取其统计数据。 + </para> + + <sect2 id="performance-monitoring-sf" revision="2"> + <title> + 监测SessionFactory + </title> + + <para> + 你可以有两种方式访问<literal>SessionFactory</literal>的数据记录，第一种就是自己直接调用 + <literal>sessionFactory.getStatistics()</literal>方法读取、显示<literal>统计</literal>数据。 + </para> + + <para> + 此外，如果你打开<literal>StatisticsService</literal> MBean选项，那么Hibernate则可以使用JMX技术 + 发布其数据记录。你可以让应用中所有的<literal>SessionFactory</literal>同时共享一个MBean，也可以每个 + SessionFactory分配一个MBean。下面的代码即是其演示代码： + </para> + + <programlisting><![CDATA[// MBean service registration for a specific SessionFactory +Hashtable tb = new Hashtable(); +tb.put("type", "statistics"); +tb.put("sessionFactory", "myFinancialApp"); +ObjectName on = new ObjectName("hibernate", tb); // MBean object name + +StatisticsService stats = new StatisticsService(); // MBean implementation +stats.setSessionFactory(sessionFactory); // Bind the stats to a SessionFactory +server.registerMBean(stats, on); // Register the Mbean on the server]]></programlisting> + + +<programlisting><![CDATA[// MBean service registration for all SessionFactory's +Hashtable tb = new Hashtable(); +tb.put("type", "statistics"); +tb.put("sessionFactory", "all"); +ObjectName on = new ObjectName("hibernate", tb); // MBean object name + +StatisticsService stats = new StatisticsService(); // MBean implementation +server.registerMBean(stats, on); // Register the MBean on the server]]></programlisting> + + <para> + + TODO：仍需要说明的是：在第一个例子中，我们直接得到和使用MBean；而在第二个例子中，在使用MBean之前 + 我们则需要给出SessionFactory的JNDI名，使用<literal>hibernateStatsBean.setSessionFactoryJNDIName("my/JNDI/Name")</literal> + 得到SessionFactory，然后将MBean保存于其中。 + </para> + <para> + 你可以通过以下方法打开或关闭<literal>SessionFactory</literal>的监测功能： + </para> + <itemizedlist> + <listitem> + <para> + + 在配置期间，将<literal>hibernate.generate_statistics</literal>设置为<literal>true</literal>或<literal>false</literal>； + </para> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para> + + 在运行期间，则可以可以通过<literal>sf.getStatistics().setStatisticsEnabled(true)</literal> + 或<literal>hibernateStatsBean.setStatisticsEnabled(true)</literal> + </para> + </listitem> + </itemizedlist> + + <para> + 你也可以在程序中调用<literal>clear()</literal>方法重置统计数据，调用<literal>logSummary()</literal> + 在日志中记录（info级别）其总结。 + </para> + + </sect2> + + <sect2 id="performance-monitoring-metrics" revision="1"> + <title> + 数据记录（Metrics） + </title> + + <para> + Hibernate提供了一系列数据记录，其记录的内容包括从最基本的信息到与具体场景的特殊信息。所有的测量值都可以由 + <literal>Statistics</literal>接口进行访问，主要分为三类： + </para> + <itemizedlist> + <listitem> + <para> + 使用<literal>Session</literal>的普通数据记录，例如打开的Session的个数、取得的JDBC的连接数等； + </para> + </listitem> + <listitem> + <para> + 实体、集合、查询、缓存等内容的统一数据记录 + </para> + </listitem> + <listitem> + <para> + 和具体实体、集合、查询、缓存相关的详细数据记录 + </para> + </listitem> + </itemizedlist> + + <para> + 例如：你可以检查缓存的命中成功次数，缓存的命中失败次数，实体、集合和查询的使用概率，查询的平均时间等。请注意 + Java中时间的近似精度是毫秒。Hibernate的数据精度和具体的JVM有关，在有些平台上其精度甚至只能精确到10秒。 + </para> + + <para> + 你可以直接使用getter方法得到全局数据记录（例如，和具体的实体、集合、缓存区无关的数据），你也可以在具体查询中通过标记实体名、 + 或HQL、SQL语句得到某实体的数据记录。请参考<literal>Statistics</literal>、<literal>EntityStatistics</literal>、 + <literal>CollectionStatistics</literal>、<literal>SecondLevelCacheStatistics</literal>、 + 和<literal>QueryStatistics</literal>的API文档以抓取更多信息。下面的代码则是个简单的例子： + </para> + + <programlisting><![CDATA[Statistics stats = HibernateUtil.sessionFactory.getStatistics(); + +double queryCacheHitCount = stats.getQueryCacheHitCount(); +double queryCacheMissCount = stats.getQueryCacheMissCount(); +double queryCacheHitRatio = + queryCacheHitCount / (queryCacheHitCount + queryCacheMissCount); + +log.info("Query Hit ratio:" + queryCacheHitRatio); + +EntityStatistics entityStats = + stats.getEntityStatistics( Cat.class.getName() ); +long changes = + entityStats.getInsertCount() + + entityStats.getUpdateCount() + + entityStats.getDeleteCount(); +log.info(Cat.class.getName() + " changed " + changes + "times" );]]></programlisting> + + <para> + 如果你想得到所有实体、集合、查询和缓存区的数据，你可以通过以下方法获得实体、集合、查询和缓存区列表： + <literal>getQueries()</literal>、<literal>getEntityNames()</literal>、 + <literal>getCollectionRoleNames()</literal>和 + <literal>getSecondLevelCacheRegionNames()</literal>。 + </para> + + </sect2> + + </sect1> + +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/persistent_classes.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/persistent_classes.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/persistent_classes.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/persistent_classes.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,493 @@ +<chapter id="persistent-classes" revision="2"> + <title>持久化类(Persistent Classes)</title> + + <para> + 在应用程序中，用来实现业务问题实体的（如，在电子商务应用程序中的Customer和Order） + 类就是持久化类。不能认为所有的持久化类的实例都是持久的状态——一个实例的状态也可能 + 是瞬时的或脱管的。 + </para> + + + + <para> + 如果这些持久化类遵循一些简单的规则，Hibernate能够工作得更好，这些规则也被称作 + 简单传统Java对象(POJO:Plain Old Java Object)编程模型。但是这些规则并不是必需的。 + 实际上，Hibernate3对于你的持久化类几乎不做任何设想。你可以用其他的方法来表达领域模型： + 比如，使用<literal>Map</literal>实例的树型结构。 + </para> + + + <sect1 id="persistent-classes-pojo"> + <title>一个简单的POJO例子</title> + <para> + 大多数Java程序需要用一个持久化类来表示猫科动物。 + </para> + + + <programlisting><![CDATA[package eg; +import java.util.Set; +import java.util.Date; + +public class Cat { + private Long id; // identifier + + private Date birthdate; + private Color color; + private char sex; + private float weight; + private int litterId; + + private Cat mother; + private Set kittens = new HashSet(); + + private void setId(Long id) { + this.id=id; + } + public Long getId() { + return id; + } + + void setBirthdate(Date date) { + birthdate = date; + } + public Date getBirthdate() { + return birthdate; + } + + void setWeight(float weight) { + this.weight = weight; + } + public float getWeight() { + return weight; + } + + public Color getColor() { + return color; + } + void setColor(Color color) { + this.color = color; + } + + void setSex(char sex) { + this.sex=sex; + } + public char getSex() { + return sex; + } + + void setLitterId(int id) { + this.litterId = id; + } + public int getLitterId() { + return litterId; + } + + void setMother(Cat mother) { + this.mother = mother; + } + public Cat getMother() { + return mother; + } + void setKittens(Set kittens) { + this.kittens = kittens; + } + public Set getKittens() { + return kittens; + } + + // addKitten not needed by Hibernate + public void addKitten(Cat kitten) { + kitten.setMother(this); + kitten.setLitterId( kittens.size() ); + kittens.add(kitten); + } +}]]></programlisting> + + <para> + 这里要遵循四条主要的规则： + </para> + + + <sect2 id="persistent-classes-pojo-constructor" revision="1"> + <title>实现一个默认的（即无参数的）构造方法（constructor）</title> + + <para> + <literal>Cat</literal>有一个无参数的构造方法。所有的持久化类都必须有一个 + 默认的构造方法（可以不是public的），这样的话Hibernate就可以使用 + <literal>Constructor.newInstance()</literal>来实例化它们。 + 我们强烈建议，在Hibernate中，为了运行期代理的生成，构造方法至少是 + <emphasis>包(package)</emphasis>内可见的。 + </para> + + </sect2> + + <sect2 id="persistent-classes-pojo-identifier" revision="2"> + <title>提供一个标识属性（identifier property）（可选） </title> + + <para> + <literal>Cat</literal>有一个属性叫做<literal>id</literal>。这个属性映射数据库表的主 + 键字段。这个属性可以叫任何名字，其类型可以是任何的原始类型、原始类型的包装类型、 + <literal>java.lang.String</literal> 或者是 <literal>java.util.Date</literal>。 + （如果你的遗留数据库表有联合主键，你甚至可以用一个用户自定义的类，该类拥有这些类型 + 的属性。参见后面的关于联合标识符的章节。） + </para> + + + <para> + 标识符属性是可选的。可以不用管它，让Hibernate内部来追踪对象的识别。 + 但是我们并不推荐这样做。 + </para> + + <para> + 实际上，一些功能只对那些声明了标识符属性的类起作用： + </para> + + <itemizedlist spacing="compact"> + <listitem> + + <para> + 托管对象的传播性再连接（级联更新或级联合并） + ——参阅 <xref linkend="objectstate-transitive"/> + </para> + + </listitem> + <listitem> + <para> + <literal>Session.saveOrUpdate()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>Session.merge()</literal> + </para> + </listitem> + </itemizedlist> + + + <para> + 我们建议你对持久化类声明命名一致的标识属性。我们还建议你使用一 + 个可以为空（也就是说，不是原始类型）的类型。 + </para> + + </sect2> + + <sect2 id="persistent-classes-pojo-final"> + <title>使用非final的类 (可选)</title> + <para> + <emphasis>代理（proxies）</emphasis>是Hibernate的一个重要的功能，它依赖的条件是，持久 + 化类或者是非final的，或者是实现了一个所有方法都声明为public的接口。 + </para> + + + <para> + 你可以用Hibernate持久化一个没有实现任何接口的<literal>final</literal>类，但是你 + 不能使用代理来延迟关联加载，这会限制你进行性能优化的选择。 + </para> + + + <para> + 你也应该避免在非final类中声明 <literal>public final</literal>的方法。如果你想使用一 + 个有<literal>public final</literal>方法的类，你必须通过设置<literal>lazy="false"</literal> + 来明确地禁用代理。 + </para> + </sect2> + + <sect2 id="persistent-classes-pojo-accessors" revision="2"> + <title>为持久化字段声明访问器(accessors)和是否可变的标志(mutators)(可选)</title> + + <para> + <literal>Cat</literal>为它的所有持久化字段声明了访问方法。很多其他ORM工具直接对 + 实例变量进行持久化。我们相信，在关系数据库schema和类的内部数据结构之间引入间接层(原文为"非直接"，indirection)会好一些。默认情况下Hibernate持久化JavaBeans风格的属性，认可 + <literal>getFoo</literal>，<literal>isFoo</literal> 和 <literal>setFoo</literal>这种形式的方法名。 + 如果需要，你可以对某些特定属性实行直接字段访问。 + </para> + + + <para> + 属性<emphasis>不需要</emphasis>要声明为public的。Hibernate可以持久化一个有 + <literal>default</literal>、<literal>protected</literal>或<literal>private</literal>的get/set方法对 + 的属性进行持久化。 + </para> + </sect2> + </sect1> + + <sect1 id="persistent-classes-inheritance"> + <title>实现继承（Inheritance）</title> + + <para> + 子类也必须遵守第一条和第二条规则。它从超类<literal>Cat</literal>继承了标识属性。 + </para> + + <programlisting><![CDATA[package eg; + +public class DomesticCat extends Cat { + private String name; + + public String getName() { + return name; + } + protected void setName(String name) { + this.name=name; + } +}]]></programlisting> + </sect1> + + <sect1 id="persistent-classes-equalshashcode" revision="1"> + <title>实现<literal>equals()</literal>和<literal>hashCode()</literal></title> + + <para> + 如果你有如下需求，你必须重载 + <literal>equals()</literal> 和 <literal>hashCode()</literal>方法： + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + 想把持久类的实例放入<literal>Set</literal>中（当表示多值关联时，推荐这么做） + </para> + </listitem> + <listitem> + <para> + 想重用脱管实例 + </para> + </listitem> + </itemizedlist> + + <para> + Hibernate保证，仅在特定会话范围内，持久化标识（数据库的行）和Java标识是等价的。因此，一旦 + 我们混合了从不同会话中获取的实例，如果希望<literal>Set</literal>有明确的语义，就必 + 须实现<literal>equals()</literal> 和<literal>hashCode()</literal>。 + </para> + + <para> + 实现<literal>equals()</literal>/<literal>hashCode()</literal>最显而易见的方法是比较两个对象 + 标识符的值。如果值相同，则两个对象对应于数据库的同一行，因此它们是相等的（如果都被添加到 + <literal>Set</literal>，则在<literal>Set</literal>中只有一个元素）。不幸的是，对生成的标识不能 + 使用这种方法。Hibernate仅对那些持久化对象赋标识值，一个新创建的实例将不会有任何标识值。此外， + 如果一个实例没有被保存(unsaved)，并且它当前正在一个<literal>Set</literal>中，保存它将会给这个对象 + 赋一个标识值。如果<literal>equals()</literal> 和 <literal>hashCode()</literal>是基于标识值 + 实现的，则其哈希码将会改变，这违反了<literal>Set</literal>的契约。建议去Hibernate的站点阅读关于这个 + 问题的全部讨论。注意，这不是Hibernate的问题，而是一般的Java对象标识和Java对象等价的语义问题。 + </para> + <para> + 我们建议使用<emphasis>业务键值相等(Business key equality)</emphasis>来实现<literal>equals()</literal> + 和 <literal>hashCode()</literal>。业务键值相等的意思是，<literal>equals()</literal>方法 + 仅仅比较形成业务键的属性，它能在现实世界里标识我们的实例（是一个<emphasis>自然的</emphasis>候选码）。 + </para> + <programlisting><![CDATA[public class Cat { + + ... + public boolean equals(Object other) { + if (this == other) return true; + if ( !(other instanceof Cat) ) return false; + + final Cat cat = (Cat) other; + + if ( !cat.getLitterId().equals( getLitterId() ) ) return false; + if ( !cat.getMother().equals( getMother() ) ) return false; + + return true; + } + + public int hashCode() { + int result; + result = getMother().hashCode(); + result = 29 * result + getLitterId(); + return result; + } + +}]]></programlisting> + + <para> + 注意，业务键不必像数据库的主键那样固定不变（参见<xref linkend="transactions-basics-identity"/>）。 + 对业务键而言，不可变或唯一的属性是不错的选择。 + </para> + + </sect1> + + <sect1 id="persistent-classes-dynamicmodels"> + <title>动态模型(Dynamic models)</title> + <para> + <emphasis>注意，以下特性在当前处于试验阶段，将来可能会有变化。</emphasis> + </para> + + <para> + 运行期的持久化实体没有必要一定表示为像POJO类或JavaBean对象那样的形式。Hibernate也支持动态模型 + （在运行期使用<literal>Map</literal>的<literal>Map</literal>）和象DOM4J的树模型那 + 样的实体表示。使用这种方法，你不用写持久化类，只写映射文件就行了。 + </para> + + + <para> + Hibernate默认工作在普通POJO模式。你可以使用配置选项<literal>default_entity_mode</literal>， + 对特定的<literal>SessionFactory</literal>，设置一个默认的实体表示模式。 + （参见<xref linkend="configuration-optional-properties"/>。） + </para> + + <para> + 下面是用<literal>Map</literal>来表示的例子。首先，在映射文件中，要声明 + <literal>entity-name</literal>来代替一个类名（或作为一种附属）。 + </para> + <programlisting><![CDATA[<hibernate-mapping> + + <class entity-name="Customer"> + + <id name="id" + type="long" + column="ID"> + <generator class="sequence"/> + </id> + + <property name="name" + column="NAME" + type="string"/> + + <property name="address" + column="ADDRESS" + type="string"/> + + <many-to-one name="organization" + column="ORGANIZATION_ID" + class="Organization"/> + + <bag name="orders" + inverse="true" + lazy="false" + cascade="all"> + <key column="CUSTOMER_ID"/> + <one-to-many class="Order"/> + </bag> + + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + 注意，虽然是用目标类名来声明关联的，但是关联的目标类型除了是POJO之外，也可以 + 是一个动态的实体。 + </para> + + <para> + 在使用<literal>dynamic-map</literal>为<literal>SessionFactory</literal> + 设置了默认的实体模式之后，可以在运行期使用<literal>Map</literal>的 + <literal>Map</literal>。 + </para> + + <programlisting><![CDATA[Session s = openSession(); +Transaction tx = s.beginTransaction(); +Session s = openSession(); + +// Create a customer +Map david = new HashMap(); +david.put("name", "David"); + +// Create an organization +Map foobar = new HashMap(); +foobar.put("name", "Foobar Inc."); + +// Link both +david.put("organization", foobar); + +// Save both +s.save("Customer", david); +s.save("Organization", foobar); + +tx.commit(); +s.close();]]></programlisting> + + <para> + 动态映射的好处是，变化所需要的时间少了，因为原型不需要实现实体类。然而，你无法进行 + 编译期的类型检查，并可能由此会处理很多的运行期异常。幸亏有了Hibernate映射，它使得数 + 据库的schema能容易的规格化和合理化，并允许稍后在此之上添加合适的领域模型实现。 + </para> + + + <para> + 实体表示模式也能在每个<literal>Session</literal>的基础上设置： + </para> + <programlisting><![CDATA[Session dynamicSession = pojoSession.getSession(EntityMode.MAP); + +// Create a customer +Map david = new HashMap(); +david.put("name", "David"); +dynamicSession.save("Customer", david); +... +dynamicSession.flush(); +dynamicSession.close() +... +// Continue on pojoSession +]]></programlisting> + + + + <para> + 请注意，用<literal>EntityMode</literal>调用<literal>getSession()</literal>是在 + <literal>Session</literal>的API中，而不是<literal>SessionFactory</literal>。 + 这样，新的<literal>Session</literal>共享底层的JDBC连接，事务，和其他的上下文信 + 息。这意味着，你不需要在第二个<literal>Session</literal>中调用 + <literal>flush()</literal>和<literal>close()</literal>，同样的，把事务和连接的处理 + 交给原来的工作单元。 + </para> + + + <para> + 关于XML表示能力的更多信息可以在<xref linkend="xml"/>中找到。 + </para> + </sect1> + + <sect1 id="persistent-classes-tuplizers" revision="1"> + <title>元组片断映射(Tuplizers)</title> + + <para> + <literal>org.hibernate.tuple.Tuplizer</literal>，以及其子接口，负责根据给定的<literal>org.hibernate.EntityMode</literal>，来复现片断数据。如果给定的片断数据被认为其是一种数据结构，"tuplizer"就是一个知道如何创建这样的数据结构，以及如何给这个数据结构赋值的东西。比如说，对于POJO这种Entity Mode，对应的tuplizer知道通过其构造方法来创建一个POJO，再通过其属性访问器来访问POJO属性。有两大类高层Tuplizer，分别是<literal>org.hibernate.tuple.entity.EntityTuplizer</literal> 和<literal>org.hibernate.tuple.entity.ComponentTuplizer</literal>接口。<literal>EntityTuplizer</literal>负责管理上面提到的实体的契约，而<literal>ComponentTuplizer</literal>则是针对组件的。 + </para> + + <para> + 用户也可以插入其自定义的tuplizer。或许您需要一种不同于dynamic-map entity-mode中使用的<literal>java.util.HashMap</literal>的<literal>java.util.Map</literal>实现；或许您需要与默认策略不同的代理生成策略(proxy generation strategy)。通过自定义tuplizer实现，这两个目标您都可以达到。Tuplizer定义被附加到它们期望管理的entity或者component映射中。回到我们的customer entity例子： + </para> + + <programlisting><![CDATA[<hibernate-mapping> + <class entity-name="Customer"> + <!-- + Override the dynamic-map entity-mode + tuplizer for the customer entity + --> + <tuplizer entity-mode="dynamic-map" + class="CustomMapTuplizerImpl"/> + + <id name="id" type="long" column="ID"> + <generator class="sequence"/> + </id> + + <!-- other properties --> + ... + </class> +</hibernate-mapping> + + +public class CustomMapTuplizerImpl + extends org.hibernate.tuple.entity.DynamicMapEntityTuplizer { + // override the buildInstantiator() method to plug in our custom map... + protected final Instantiator buildInstantiator( + org.hibernate.mapping.PersistentClass mappingInfo) { + return new CustomMapInstantiator( mappingInfo ); + } + + private static final class CustomMapInstantiator + extends org.hibernate.tuple.DynamicMapInstantitor { + // override the generateMap() method to return our custom map... + protected final Map generateMap() { + return new CustomMap(); + } + } +}]]></programlisting> + + + </sect1> + + <para> + TODO：property和proxy包里的用户扩展框架文档。 + </para> + +</chapter> + Added: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/preface.xml =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/preface.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/preface.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,70 @@ +<?xml version='1.0' encoding="UTF-8"?> + +<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<preface id="preface" revision="2"> + <title>前言</title> + + <para> + 在今日的企业环境中，把面向对象的软件和关系数据库一起使用可能是相当麻烦、浪费时间的。Hibernate是一个面向Java环境的对象/关系数据库映射工具。对象/关系数据库映射(object/relational mapping (ORM))这个术语表示一种技术，用来把对象模型表示的对象映射到基于SQL的关系模型数据结构中去。 + </para> + + <para> + Hibernate不仅仅管理Java类到数据库表的映射（包括Java数据类型到SQL数据类型的映射），还提供数据查询和获取数据的方法，可以大幅度减少开发时人工使用SQL和JDBC处理数据的时间。 + </para> + + <para> + Hibernate的目标是对于开发者通常的数据持久化相关的编程任务，解放其中的95%。对于以数据为中心的程序来说,它们往往只在数据库中使用存储过程来实现商业逻辑,Hibernate可能不是最好的解决方案;对于那些在基于Java的中间层应用中，它们实现面向对象的业务模型和商业逻辑的应用，Hibernate是最有用的。不管怎样，Hibernate一定可以帮助你消除或者包装那些针对特定厂商的SQL代码，并且帮你把结果集从表格式的表示形式转换到一系列的对象去。 + </para> + + <para> + 如果你对Hibernate和对象/关系数据库映射还是个新手，或者甚至对Java也不熟悉，请按照下面的步骤来学习。 + </para> + + <orderedlist> + <listitem> + <para> + 阅读<xref linkend="tutorial"/>，这是一篇包含详细的逐步指导的指南。本指南的源代码包含在发行包中，你可以在<literal>doc/reference/tutorial/</literal>目录下找到。 </para> + </listitem> + <listitem> + <para> + 阅读<xref linkend="architecture"/>来理解Hibernate可以使用的环境。 + </para> + </listitem> + <listitem> + <para> + 查看Hibernate发行包中的<literal>eg/</literal>目录，里面有一个简单的独立运行的程序。把你的JDBC驱动拷贝到<literal>lib/</literal>目录下，修改一下<literal>src/hibernate.properties</literal>,指定其中你的数据库的信息。进入命令行，切换到你的发行包的目录，输入<literal>ant eg</literal>(使用了Ant），或者在Windows操作系统中使用<literal>build eg</literal>。 + </para> + </listitem> + <listitem> + <para> + 把这份参考文档作为你学习的主要信息来源。 + </para> + </listitem> + <listitem> + <para> + 在Hibernate 的网站上可以找到经常提问的问题与解答(FAQ)。 + </para> + </listitem> + <listitem> + <para> + 在Hibernate网站上还有第三方的演示、示例和教程的链接。 + </para> + </listitem> + <listitem> + <para> + Hibernate网站的“社区(Community Area)”是讨论关于设计模式以及很多整合方案(Tomcat, JBoss AS, Struts, EJB,等等)的好地方。 + </para> + </listitem> + </orderedlist> + + <para> + 如果你有问题，请使用Hibernate网站上链接的用户论坛。我们也提供一个JIRA问题追踪系统，来搜集bug报告和新功能请求。如果你对开发Hibernate有兴趣，请加入开发者的邮件列表。（Hibernate网站上的用户论坛有一个中文版面，JavaEye也有Hibernate中文版面,您可以在那里交流问题与经验。） + </para> + + <para> + 商业开发、产品支持和Hibernate培训可以通过JBoss Inc.获得。（请查阅：http://www.hibernate.org/SupportTraining/）。 + Hibernate是一个专业的开放源代码项目(Professional Open Source project)，也是JBoss Enterprise Middleware System(JEMS),JBoss企业级中间件系统的一个核心组件。 + </para> + +</preface> \ No newline at end of file Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/query_criteria.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/query_criteria.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/query_criteria.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/query_criteria.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,424 @@ +<chapter id="querycriteria"> + <title> + 条件查询(Criteria Queries) + </title> + <para> + 具有一个直观的、可扩展的条件查询API是Hibernate的特色。 + </para> + + <sect1 id="querycriteria-creating"> + <title>创建一个<literal>Criteria</literal> 实例</title> + + <para> + <literal>org.hibernate.Criteria</literal>接口表示特定持久类的一个查询。<literal>Session</literal>是 + <literal>Criteria</literal>实例的工厂。 + </para> + + <programlisting><![CDATA[Criteria crit = sess.createCriteria(Cat.class); +crit.setMaxResults(50); +List cats = crit.list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-narrowing"> + <title>限制结果集内容</title> + + <para> + 一个单独的查询条件是<literal>org.hibernate.criterion.Criterion</literal> + 接口的一个实例。<literal>org.hibernate.criterion.Restrictions</literal>类 + 定义了获得某些内置<literal>Criterion</literal>类型的工厂方法。 + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "Fritz%") ) + .add( Restrictions.between("weight", minWeight, maxWeight) ) + .list();]]></programlisting> + + <para> + 约束可以按逻辑分组。 + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "Fritz%") ) + .add( Restrictions.or( + Restrictions.eq( "age", new Integer(0) ), + Restrictions.isNull("age") + ) ) + .list();]]></programlisting> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.in( "name", new String[] { "Fritz", "Izi", "Pk" } ) ) + .add( Restrictions.disjunction() + .add( Restrictions.isNull("age") ) + .add( Restrictions.eq("age", new Integer(0) ) ) + .add( Restrictions.eq("age", new Integer(1) ) ) + .add( Restrictions.eq("age", new Integer(2) ) ) + ) ) + .list();]]></programlisting> + + <para> + Hibernate提供了相当多的内置criterion类型(<literal>Restrictions</literal> + 子类), 但是尤其有用的是可以允许你直接使用SQL。 + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.sqlRestriction("lower({alias}.name) like lower(?)", "Fritz%", Hibernate.STRING) ) + .list();]]></programlisting> + + <para> + <literal>{alias}</literal>占位符应当被替换为被查询实体的列别名。 + </para> + + <para> + + <literal>Property</literal>实例是获得一个条件的另外一种途径。你可以通过调用<literal>Property.forName()</literal> + 创建一个<literal>Property</literal>。 + + </para> + + <programlisting><![CDATA[ +Property age = Property.forName("age"); +List cats = sess.createCriteria(Cat.class) + .add( Restrictions.disjunction() + .add( age.isNull() ) + .add( age.eq( new Integer(0) ) ) + .add( age.eq( new Integer(1) ) ) + .add( age.eq( new Integer(2) ) ) + ) ) + .add( Property.forName("name").in( new String[] { "Fritz", "Izi", "Pk" } ) ) + .list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-ordering"> + <title>结果集排序</title> + + <para> + 你可以使用<literal>org.hibernate.criterion.Order</literal>来为查询结果排序。 + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "F%") + .addOrder( Order.asc("name") ) + .addOrder( Order.desc("age") ) + .setMaxResults(50) + .list();]]></programlisting> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Property.forName("name").like("F%") ) + .addOrder( Property.forName("name").asc() ) + .addOrder( Property.forName("age").desc() ) + .setMaxResults(50) + .list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-associations" revision="2"> + <title>关联</title> + + <para> + 你可以使用<literal>createCriteria()</literal>非常容易的在互相关联的实体间建立 + 约束。 + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "F%") ) + .createCriteria("kittens") + .add( Restrictions.like("name", "F%") ) + .list();]]></programlisting> + + <para> + 注意第二个 <literal>createCriteria()</literal>返回一个新的 + <literal>Criteria</literal>实例，该实例引用<literal>kittens</literal> 集合中的元素。 + </para> + + <para> + 接下来，替换形态在某些情况下也是很有用的。 + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .createAlias("kittens", "kt") + .createAlias("mate", "mt") + .add( Restrictions.eqProperty("kt.name", "mt.name") ) + .list();]]></programlisting> + + <para> + + (<literal>createAlias()</literal>并不创建一个新的 + <literal>Criteria</literal>实例。) + </para> + + <para> + <literal>Cat</literal>实例所保存的之前两次查询所返回的kittens集合是 + <emphasis>没有</emphasis>被条件预过滤的。如果你希望只获得符合条件的kittens， + 你必须使用<literal>ResultTransformer</literal>。 + + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .createCriteria("kittens", "kt") + .add( Restrictions.eq("name", "F%") ) + .setResultTransformer(Criteria.ALIAS_TO_ENTITY_MAP) + .list(); +Iterator iter = cats.iterator(); +while ( iter.hasNext() ) { + Map map = (Map) iter.next(); + Cat cat = (Cat) map.get(Criteria.ROOT_ALIAS); + Cat kitten = (Cat) map.get("kt"); +}]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-dynamicfetching" revision="1"> + <title>动态关联抓取</title> + + <para> + 你可以使用<literal>setFetchMode()</literal>在运行时定义动态关联抓取的语义。 + </para> + + <programlisting><![CDATA[List cats = sess.createCriteria(Cat.class) + .add( Restrictions.like("name", "Fritz%") ) + .setFetchMode("mate", FetchMode.EAGER) + .setFetchMode("kittens", FetchMode.EAGER) + .list();]]></programlisting> + + <para> + 这个查询可以通过外连接抓取<literal>mate</literal>和<literal>kittens</literal>。 + 查看<xref linkend="performance-fetching"/>可以获得更多信息。 + </para> + + </sect1> + + <sect1 id="querycriteria-examples"> + <title>查询示例</title> + + <para> + <literal>org.hibernate.criterion.Example</literal>类允许你通过一个给定实例 + 构建一个条件查询。 + </para> + + <programlisting><![CDATA[Cat cat = new Cat(); +cat.setSex('F'); +cat.setColor(Color.BLACK); +List results = session.createCriteria(Cat.class) + .add( Example.create(cat) ) + .list();]]></programlisting> + + <para> + 版本属性、标识符和关联被忽略。默认情况下值为null的属性将被排除。 + </para> + + <para> + 你可以自行调整<literal>Example</literal>使之更实用。 + </para> + + <programlisting><![CDATA[Example example = Example.create(cat) + .excludeZeroes() //exclude zero valued properties + .excludeProperty("color") //exclude the property named "color" + .ignoreCase() //perform case insensitive string comparisons + .enableLike(); //use like for string comparisons +List results = session.createCriteria(Cat.class) + .add(example) + .list();]]></programlisting> + + <para> + 你甚至可以使用examples在关联对象上放置条件。 + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .add( Example.create(cat) ) + .createCriteria("mate") + .add( Example.create( cat.getMate() ) ) + .list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-projection"> + <title>投影(Projections)、聚合（aggregation）和分组（grouping）</title> + <para> + <literal>org.hibernate.criterion.Projections</literal>是 + <literal>Projection</literal> 的实例工厂。我们通过调用 + <literal>setProjection()</literal>应用投影到一个查询。 + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.rowCount() ) + .add( Restrictions.eq("color", Color.BLACK) ) + .list();]]></programlisting> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.projectionList() + .add( Projections.rowCount() ) + .add( Projections.avg("weight") ) + .add( Projections.max("weight") ) + .add( Projections.groupProperty("color") ) + ) + .list();]]></programlisting> + + <para> + 在一个条件查询中没有必要显式的使用 "group by" 。某些投影类型就是被定义为<emphasis> + 分组投影</emphasis>，他们也出现在SQL的<literal>group by</literal>子句中。 + </para> + + <para> + 你可以选择把一个别名指派给一个投影，这样可以使投影值被约束或排序所引用。下面是两种不同的实现方式： + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.alias( Projections.groupProperty("color"), "colr" ) ) + .addOrder( Order.asc("colr") ) + .list();]]></programlisting> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.groupProperty("color").as("colr") ) + .addOrder( Order.asc("colr") ) + .list();]]></programlisting> + + <para> + <literal>alias()</literal>和<literal>as()</literal>方法简便的将一个投影实例包装到另外一个 + 别名的<literal>Projection</literal>实例中。简而言之，当你添加一个投影到一个投影列表中时 + 你可以为它指定一个别名： + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.projectionList() + .add( Projections.rowCount(), "catCountByColor" ) + .add( Projections.avg("weight"), "avgWeight" ) + .add( Projections.max("weight"), "maxWeight" ) + .add( Projections.groupProperty("color"), "color" ) + ) + .addOrder( Order.desc("catCountByColor") ) + .addOrder( Order.desc("avgWeight") ) + .list();]]></programlisting> + + <programlisting><![CDATA[List results = session.createCriteria(Domestic.class, "cat") + .createAlias("kittens", "kit") + .setProjection( Projections.projectionList() + .add( Projections.property("cat.name"), "catName" ) + .add( Projections.property("kit.name"), "kitName" ) + ) + .addOrder( Order.asc("catName") ) + .addOrder( Order.asc("kitName") ) + .list();]]></programlisting> + + <para> + 你也可以使用<literal>Property.forName()</literal>来表示投影： + </para> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Property.forName("name") ) + .add( Property.forName("color").eq(Color.BLACK) ) + .list();]]></programlisting> + + <programlisting><![CDATA[List results = session.createCriteria(Cat.class) + .setProjection( Projections.projectionList() + .add( Projections.rowCount().as("catCountByColor") ) + .add( Property.forName("weight").avg().as("avgWeight") ) + .add( Property.forName("weight").max().as("maxWeight") ) + .add( Property.forName("color").group().as("color" ) + ) + .addOrder( Order.desc("catCountByColor") ) + .addOrder( Order.desc("avgWeight") ) + .list();]]></programlisting> + + </sect1> + + <sect1 id="querycriteria-detachedqueries"> + <title>离线(detached)查询和子查询</title> + <para> + <literal>DetachedCriteria</literal>类使你在一个session范围之外创建一个查询，并且可以使用任意的 + <literal>Session</literal>来执行它。 + </para> + + <programlisting><![CDATA[DetachedCriteria query = DetachedCriteria.forClass(Cat.class) + .add( Property.forName("sex").eq('F') ); + +Session session = ....; +Transaction txn = session.beginTransaction(); +List results = query.getExecutableCriteria(session).setMaxResults(100).list(); +txn.commit(); +session.close();]]></programlisting> + + <para> + <literal>DetachedCriteria</literal>也可以用以表示子查询。条件实例包含子查询可以通过 + <literal>Subqueries</literal>或者<literal>Property</literal>获得。 + </para> + + <programlisting><![CDATA[DetachedCriteria avgWeight = DetachedCriteria.forClass(Cat.class) + .setProjection( Property.forName("weight").avg() ); +session.createCriteria(Cat.class) + .add( Property.forName("weight").gt(avgWeight) ) + .list();]]></programlisting> + + <programlisting><![CDATA[DetachedCriteria weights = DetachedCriteria.forClass(Cat.class) + .setProjection( Property.forName("weight") ); +session.createCriteria(Cat.class) + .add( Subqueries.geAll("weight", weights) ) + .list();]]></programlisting> + + <para> + 甚至相互关联的子查询也是有可能的： + </para> + + <programlisting><![CDATA[DetachedCriteria avgWeightForSex = DetachedCriteria.forClass(Cat.class, "cat2") + .setProjection( Property.forName("weight").avg() ) + .add( Property.forName("cat2.sex").eqProperty("cat.sex") ); +session.createCriteria(Cat.class, "cat") + .add( Property.forName("weight").gt(avgWeightForSex) ) + .list();]]></programlisting> + + </sect1> + + + <!--TODO: ResultSetTransformer + aliasing. AliasToBeanTransformer allow returning arbitrary + user objects - similar to setResultClass in JDO2. General use of ResultTransformer + could also be explained. --> + + <sect1 id="query-criteria-naturalid"> + <title>根据自然标识查询(Queries by natural identifier)</title> + + + <para> + 对大多数查询，包括条件查询而言，因为查询缓存的失效(invalidation)发生得太频繁，查询缓存不是非常高效。然而，有一种特别的查询，可以通过不变的自然键优化缓存的失效算法。在某些应用中，这种类型的查询比较常见。条件查询API对这种用例提供了特别规约。 + </para> + + <para> + 首先，你应该对你的entity使用<literal>&lt;natural-id&gt;</literal>来映射自然键，然后打开第二级缓存。 + </para> + + <programlisting><![CDATA[<class name="User"> + <cache usage="read-write"/> + <id name="id"> + <generator class="increment"/> + </id> + <natural-id> + <property name="name"/> + <property name="org"/> + </natural-id> + <property name="password"/> +</class>]]></programlisting> + + <para> + 注意,此功能对具有<emphasis>mutable</emphasis>自然键的entity并不适用。 + </para> + + <para> + 然后，打开Hibernate 查询缓存。 + </para> + + <para> + 现在，我们可以用<literal>Restrictions.naturalId()</literal>来使用更加高效的缓存算法。 + </para> + + <programlisting><![CDATA[session.createCriteria(User.class) + .add( Restrictions.naturalId() + .set("name", "gavin") + .set("org", "hb") + ).setCacheable(true) + .uniqueResult();]]></programlisting> + + </sect1> + + +</chapter> + Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/query_hql.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/query_hql.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/query_hql.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/query_hql.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,1088 @@ +<chapter id="queryhql"> + <title>HQL: Hibernate查询语言</title> + <para> + Hibernate配备了一种非常强大的查询语言，这种语言看上去很像SQL。但是不要被语法结构 + 上的相似所迷惑，HQL是非常有意识的被设计为完全面向对象的查询，它可以理解如继承、多态 + 和关联之类的概念。 + </para> + + <sect1 id="queryhql-casesensitivity"> + <title>大小写敏感性问题</title> + + <para> + 除了Java类与属性的名称外，查询语句对大小写并不敏感。 + 所以 <literal>SeLeCT</literal> 与 + <literal>sELEct</literal> 以及 + <literal>SELECT</literal> 是相同的，但是 + <literal>org.hibernate.eg.FOO</literal> 并不等价于 + <literal>org.hibernate.eg.Foo</literal> 并且 + <literal>foo.barSet</literal> 也不等价于 + <literal>foo.BARSET</literal>。 + </para> + + <para> + 本手册中的HQL关键字将使用小写字母. 很多用户发现使用完全大写的关键字会使查询语句 + 的可读性更强, 但我们发现，当把查询语句嵌入到Java语句中的时候使用大写关键字比较难看。 + </para> + + </sect1> + + <sect1 id="queryhql-from"> + <title>from子句</title> + + <para> + Hibernate中最简单的查询语句的形式如下： + </para> + + <programlisting><![CDATA[from eg.Cat]]></programlisting> + + <para> + 该子句简单的返回<literal>eg.Cat</literal>类的所有实例。 + 通常我们不需要使用类的全限定名, 因为 <literal>auto-import</literal>（自动引入） + 是缺省的情况。 所以我们几乎只使用如下的简单写法： + </para> + + <programlisting><![CDATA[from Cat]]></programlisting> + + <para> + 大多数情况下, 你需要指定一个<emphasis>别名</emphasis>, 原因是你可能需要 + 在查询语句的其它部分引用到<literal>Cat</literal> + </para> + + <programlisting><![CDATA[from Cat as cat]]></programlisting> + + <para> + 这个语句把别名<literal>cat</literal>指定给类<literal>Cat</literal> + 的实例, 这样我们就可以在随后的查询中使用此别名了。 关键字<literal>as</literal> + 是可选的，我们也可以这样写: + </para> + + <programlisting><![CDATA[from Cat cat]]></programlisting> + + <para> + 子句中可以同时出现多个类, 其查询结果是产生一个笛卡儿积或产生跨表的连接。 + </para> + + <programlisting><![CDATA[from Formula, Parameter]]></programlisting> + <programlisting><![CDATA[from Formula as form, Parameter as param]]></programlisting> + + <para> + 查询语句中别名的开头部分小写被认为是实践中的好习惯， + 这样做与Java变量的命名标准保持了一致 + (比如，<literal>domesticCat</literal>)。 + </para> + + </sect1> + + <sect1 id="queryhql-joins" revision="2"> + <title>关联(Association)与连接(Join)</title> + + <para> + 我们也可以为相关联的实体甚至是对一个集合中的全部元素指定一个别名, 这时要使用关键字<literal>join</literal>。 + </para> + + <programlisting><![CDATA[from Cat as cat + inner join cat.mate as mate + left outer join cat.kittens as kitten]]></programlisting> + + <programlisting><![CDATA[from Cat as cat left join cat.mate.kittens as kittens]]></programlisting> + + <programlisting><![CDATA[from Formula form full join form.parameter param]]></programlisting> + + <para> + 受支持的连接类型是从ANSI SQL中借鉴来的。 + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>inner join</literal>（内连接） + </para> + </listitem> + <listitem> + <para> + <literal>left outer join</literal>（左外连接） + </para> + </listitem> + <listitem> + <para> + <literal>right outer join</literal>（右外连接） + </para> + </listitem> + <listitem> + <para> + <literal>full join</literal> (全连接，并不常用) + </para> + </listitem> + </itemizedlist> + + <para> + 语句<literal>inner join</literal>, <literal>left outer join</literal> 以及 + <literal>right outer join</literal> 可以简写。 + </para> + + <programlisting><![CDATA[from Cat as cat + join cat.mate as mate + left join cat.kittens as kitten]]></programlisting> + + <para> + 通过HQL的<literal>with</literal>关键字，你可以提供额外的join条件。 + </para> + + <programlisting><![CDATA[from Cat as cat + left join cat.kittens as kitten + with kitten.bodyWeight > 10.0]]></programlisting> + + <para> + 还有，一个"fetch"连接允许仅仅使用一个选择语句就将相关联的对象或一组值的集合随着他们的父对象的初始化而被初始化，这种方法在使用到集合的情况下尤其有用，对于关联和集合来说，它有效的代替了映射文件中的外联接 + 与延迟声明（lazy declarations）. 查看 + <xref linkend="performance-fetching"/> 以获得等多的信息。 + </para> + + <programlisting><![CDATA[from Cat as cat + inner join fetch cat.mate + left join fetch cat.kittens]]></programlisting> + + <para> + 一个fetch连接通常不需要被指定别名, 因为相关联的对象不应当被用在 + <literal>where</literal> 子句 (或其它任何子句)中。同时，相关联的对象 + 并不在查询的结果中直接返回，但可以通过他们的父对象来访问到他们。 + </para> + + <programlisting><![CDATA[from Cat as cat + inner join fetch cat.mate + left join fetch cat.kittens child + left join fetch child.kittens]]></programlisting> + + + <para> + 假若使用<literal>iterate()</literal>来调用查询，请注意<literal>fetch</literal>构造是不能使用的(<literal>scroll()</literal> 可以使用)。<literal>fetch</literal>也不应该与<literal>setMaxResults()</literal> 或<literal>setFirstResult()</literal>共用，这是因为这些操作是基于结果集的，而在预先抓取集合类时可能包含重复的数据，也就是说无法预先知道精确的行数。<literal>fetch</literal>还不能与独立的 <literal>with</literal>条件一起使用。通过在一次查询中fetch多个集合，可以制造出笛卡尔积，因此请多加注意。对bag映射来说，同时join fetch多个集合角色可能在某些情况下给出并非预期的结果，也请小心。最后注意，使用<literal>full join fetch</literal> 与 <literal>right join fetch</literal>是没有意义的。 + </para> + + <para> + 如果你使用属性级别的延迟获取（lazy fetching）（这是通过重新编写字节码实现的），可以使用 <literal>fetch +all properties</literal> + 来强制Hibernate立即取得那些原本需要延迟加载的属性（在第一个查询中）。 + + </para> + + <programlisting><![CDATA[from Document fetch all properties order by name]]></programlisting> + <programlisting><![CDATA[from Document doc fetch all properties where lower(doc.name) like '%cats%']]></programlisting> + + </sect1> + + <sect1 id="queryhql-joins-forms"> + <title>join 语法的形式</title> + + <para> + HQL支持两种关联join的形式：<literal>implicit(隐式)</literal> 与<literal>explicit（显式）</literal>。 + </para> + + <para> + 上一节中给出的查询都是使用<literal>explicit(显式)</literal>形式的，其中form子句中明确给出了join关键字。这是建议使用的方式。 + </para> + + <para> + <literal>implicit（隐式）</literal>形式不使用join关键字。关联使用"点号"来进行“引用”。<literal>implicit</literal> join可以在任何HQL子句中出现.<literal>implicit</literal> join在最终的SQL语句中以inner join的方式出现。 + </para> + + <programlisting><![CDATA[from Cat as cat where cat.mate.name like '%s%']]></programlisting> + </sect1> + + <sect1 id="queryhql-select"> + <title>select子句</title> + + <para> + <literal>select</literal> 子句选择将哪些对象与属性返 + 回到查询结果集中. 考虑如下情况: + </para> + + <programlisting><![CDATA[select mate +from Cat as cat + inner join cat.mate as mate]]></programlisting> + + <para> + 该语句将选择<literal>mate</literal>s of other <literal>Cat</literal>s。（其他猫的配偶） + 实际上, 你可以更简洁的用以下的查询语句表达相同的含义: + </para> + + <programlisting><![CDATA[select cat.mate from Cat cat]]></programlisting> + + <para> + 查询语句可以返回值为任何类型的属性，包括返回类型为某种组件(Component)的属性: + </para> + + <programlisting><![CDATA[select cat.name from DomesticCat cat +where cat.name like 'fri%']]></programlisting> + + <programlisting><![CDATA[select cust.name.firstName from Customer as cust]]></programlisting> + + <para> + 查询语句可以返回多个对象和（或）属性，存放在 + <literal>Object[]</literal>队列中, + </para> + + <programlisting><![CDATA[select mother, offspr, mate.name +from DomesticCat as mother + inner join mother.mate as mate + left outer join mother.kittens as offspr]]></programlisting> + + <para> + 或存放在一个<literal>List</literal>对象中, + </para> + + <programlisting><![CDATA[select new list(mother, offspr, mate.name) +from DomesticCat as mother + inner join mother.mate as mate + left outer join mother.kittens as offspr]]></programlisting> + + <para> + 也可能直接返回一个实际的类型安全的Java对象, + </para> + + <programlisting><![CDATA[select new Family(mother, mate, offspr) +from DomesticCat as mother + join mother.mate as mate + left join mother.kittens as offspr]]></programlisting> + + <para> + 假设类<literal>Family</literal>有一个合适的构造函数. + </para> + + <para> + 你可以使用关键字<literal>as</literal>给“被选择了的表达式”指派别名: + </para> + + <programlisting><![CDATA[select max(bodyWeight) as max, min(bodyWeight) as min, count(*) as n +from Cat cat]]></programlisting> + + <para> + 这种做法在与子句<literal>select new map</literal>一起使用时最有用: + </para> + + <programlisting><![CDATA[select new map( max(bodyWeight) as max, min(bodyWeight) as min, count(*) as n ) +from Cat cat]]></programlisting> + + <para> + 该查询返回了一个<literal>Map</literal>的对象，内容是别名与被选择的值组成的名-值映射。 + </para> + + </sect1> + + <sect1 id="queryhql-aggregation"> + <title>聚集函数</title> + + <para> + HQL查询甚至可以返回作用于属性之上的聚集函数的计算结果: + </para> + + <programlisting><![CDATA[select avg(cat.weight), sum(cat.weight), max(cat.weight), count(cat) +from Cat cat]]></programlisting> + +<!-- 已经不再被继续支持 + <para> + 在<literal>select</literal>子句中，集合（Collections）也可以出现在聚集函数的内部。 + </para> + + <programlisting><![CDATA[select cat, count( elements(cat.kittens) ) +from Cat cat group by cat]]></programlisting> +--> + + <para> + 受支持的聚集函数如下： + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>avg(...), sum(...), min(...), max(...)</literal> + </para> + </listitem> + <listitem> + <para> + <literal>count(*)</literal> + </para> + </listitem> + <listitem> + <para> + <literal>count(...), count(distinct ...), count(all...)</literal> + </para> + </listitem> + </itemizedlist> + + <para> + 你可以在选择子句中使用数学操作符、连接以及经过验证的SQL函数： + </para> + + <programlisting><![CDATA[select cat.weight + sum(kitten.weight) +from Cat cat + join cat.kittens kitten +group by cat.id, cat.weight]]></programlisting> + + <programlisting><![CDATA[select firstName||' '||initial||' '||upper(lastName) from Person]]></programlisting> + + <para> + 关键字<literal>distinct</literal>与<literal>all</literal> 也可以使用，它们具有与SQL相同的语义. + </para> + + <programlisting><![CDATA[select distinct cat.name from Cat cat + +select count(distinct cat.name), count(cat) from Cat cat]]></programlisting> + + </sect1> + + <sect1 id="queryhql-polymorphism"> + <title>多态查询</title> + + <para> + 一个如下的查询语句: + </para> + + <programlisting><![CDATA[from Cat as cat]]></programlisting> + + <para> + 不仅返回<literal>Cat</literal>类的实例, 也同时返回子类 + <literal>DomesticCat</literal>的实例. Hibernate 可以在<literal>from</literal>子句中指定<emphasis>任何</emphasis> + Java 类或接口. 查询会返回继承了该类的所有持久化子类 + 的实例或返回声明了该接口的所有持久化类的实例。下面的查询语句返回所有的被持久化的对象： + </para> + + <programlisting><![CDATA[from java.lang.Object o]]></programlisting> + + <para> + 接口<literal>Named</literal> 可能被各种各样的持久化类声明： + </para> + + <programlisting><![CDATA[from Named n, Named m where n.name = m.name]]></programlisting> + + <para> + 注意，最后的两个查询将需要超过一个的SQL <literal>SELECT</literal>.这表明<literal>order by</literal>子句 + 没有对整个结果集进行正确的排序. + (这也说明你不能对这样的查询使用<literal>Query.scroll()</literal>方法.) + </para> + + </sect1> + + <sect1 id="queryhql-where"> + <title>where子句</title> + + <para> + <literal>where</literal>子句允许你将返回的实例列表的范围缩小. + 如果没有指定别名，你可以使用属性名来直接引用属性: + </para> + + <programlisting><![CDATA[from Cat where name='Fritz']]></programlisting> + + <para> + 如果指派了别名，需要使用完整的属性名: + </para> + + <programlisting><![CDATA[from Cat as cat where cat.name='Fritz']]></programlisting> + + <para> + 返回名为（属性name等于）'Fritz'的<literal>Cat</literal>类的实例。 + </para> + + <programlisting><![CDATA[select foo +from Foo foo, Bar bar +where foo.startDate = bar.date]]></programlisting> + + <para> + 将返回所有满足下面条件的<literal>Foo</literal>类的实例： + 存在如下的<literal>bar</literal>的一个实例，其<literal>date</literal>属性等于 + <literal>Foo</literal>的<literal>startDate</literal>属性。 + 复合路径表达式使得<literal>where</literal>子句非常的强大，考虑如下情况： + </para> + + <programlisting><![CDATA[from Cat cat where cat.mate.name is not null]]></programlisting> + + <para> + 该查询将被翻译成为一个含有表连接（内连接）的SQL查询。如果你打算写像这样的查询语句 + </para> + + <programlisting><![CDATA[from Foo foo +where foo.bar.baz.customer.address.city is not null]]></programlisting> + + <para> + 在SQL中，你为达此目的将需要进行一个四表连接的查询。 + </para> + + <para> + <literal>=</literal>运算符不仅可以被用来比较属性的值，也可以用来比较实例： + </para> + + <programlisting><![CDATA[from Cat cat, Cat rival where cat.mate = rival.mate]]></programlisting> + + <programlisting><![CDATA[select cat, mate +from Cat cat, Cat mate +where cat.mate = mate]]></programlisting> + + <para> + 特殊属性（小写）<literal>id</literal>可以用来表示一个对象的唯一的标识符。（你也可以使用该对象的属性名。） + </para> + + <programlisting><![CDATA[from Cat as cat where cat.id = 123 + +from Cat as cat where cat.mate.id = 69]]></programlisting> + + <para> + 第二个查询是有效的。此时不需要进行表连接！ + </para> + + <para> + 同样也可以使用复合标识符。比如<literal>Person</literal>类有一个复合标识符，它由<literal>country</literal>属性 + 与<literal>medicareNumber</literal>属性组成。 + </para> + + <programlisting><![CDATA[from bank.Person person +where person.id.country = 'AU' + and person.id.medicareNumber = 123456]]></programlisting> + + <programlisting><![CDATA[from bank.Account account +where account.owner.id.country = 'AU' + and account.owner.id.medicareNumber = 123456]]></programlisting> + + <para> + 第二个查询也不需要进行表连接。 + </para> + + <para> + 同样的，特殊属性<literal>class</literal>在进行多态持久化的情况下被用来存取一个实例的鉴别值（discriminator value）。 + 一个嵌入到where子句中的Java类的名字将被转换为该类的鉴别值。 + </para> + + <programlisting><![CDATA[from Cat cat where cat.class = DomesticCat]]></programlisting> + + <para> + 你也可以声明一个属性的类型是组件或者复合用户类型（以及由组件构成的组件等等）。永远不要尝试使用以组件类型来结尾的路径表达式（path-expression） + （与此相反，你应当使用组件的一个属性来结尾）。 + 举例来说，如果<literal>store.owner</literal>含有一个包含了组件的实体<literal>address</literal> + </para> + + <programlisting><![CDATA[store.owner.address.city // 正确 +store.owner.address // 错误!]]></programlisting> + + <para> + 一个“任意”类型有两个特殊的属性<literal>id</literal>和<literal>class</literal>, + 来允许我们按照下面的方式表达一个连接（<literal>AuditLog.item</literal> + 是一个属性，该属性被映射为<literal>&lt;any&gt;</literal>）。 + </para> + + <programlisting><![CDATA[from AuditLog log, Payment payment +where log.item.class = 'Payment' and log.item.id = payment.id]]></programlisting> + + <para> + 注意，在上面的查询与句中，<literal>log.item.class</literal> 和 <literal>payment.class</literal> + 将涉及到完全不同的数据库中的列。 + </para> + + </sect1> + + <sect1 id="queryhql-expressions"> + <title>表达式</title> + + <para> + 在<literal>where</literal>子句中允许使用的表达式包括 + 大多数你可以在SQL使用的表达式种类: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + 数学运算符<literal>+, -, *, /</literal> + </para> + </listitem> + <listitem> + <para> + 二进制比较运算符<literal>=, &gt;=, &lt;=, &lt;&gt;, !=, like</literal> + </para> + </listitem> + <listitem> + <para> + 逻辑运算符<literal>and, or, not</literal> + </para> + </listitem> + <listitem> + <para> + <literal>in</literal>, + <literal>not in</literal>, + <literal>between</literal>, + <literal>is null</literal>, + <literal>is not null</literal>, + <literal>is empty</literal>, + <literal>is not empty</literal>, + <literal>member of</literal> and + <literal>not member of</literal> + </para> + </listitem> + <listitem> + <para> + "简单的" case, <literal>case ... when ... then ... else ... end</literal>,和 + "搜索" case, <literal>case when ... then ... else ... end</literal> + </para> + </listitem> + <listitem> + <para> + 字符串连接符<literal>...||...</literal> or <literal>concat(...,...)</literal> + </para> + </listitem> + <listitem> + <para> + <literal>current_date()</literal>, <literal>current_time()</literal>, + <literal>current_timestamp()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>second(...)</literal>, <literal>minute(...)</literal>, + <literal>hour(...)</literal>, <literal>day(...)</literal>, + <literal>month(...)</literal>, <literal>year(...)</literal>, + </para> + </listitem> + <listitem> + <para> + EJB-QL 3.0定义的任何函数或操作：<literal>substring(), trim(), + lower(), upper(), length(), locate(), abs(), sqrt(), bit_length()， mod()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>coalesce()</literal> 和 <literal>nullif()</literal> + </para> + </listitem> + <listitem> + <para> + <literal>str()</literal> 把数字或者时间值转换为可读的字符串 + </para> + </listitem> + + <listitem> + <para> + <literal>cast(... as ...)</literal>, 其第二个参数是某Hibernate类型的名字，以及<literal>extract(... from ...)</literal>，只要ANSI + <literal>cast()</literal> 和 <literal>extract()</literal> 被底层数据库支持 + </para> + </listitem> + <listitem> + <para> + HQL <literal>index()</literal> 函数，作用于join的有序集合的别名。 + + </para> + </listitem> + <listitem> + <para> + HQL函数，把集合作为参数:<literal>size(), minelement(), maxelement(), minindex(), maxindex()</literal>,还有特别的<literal>elements()</literal> 和<literal>indices</literal>函数，可以与数量词加以限定：<literal>some, all, exists, any, in</literal>。 + + </para> + </listitem> + <listitem> + <para> + 任何数据库支持的SQL标量函数，比如<literal>sign()</literal>, + <literal>trunc()</literal>, <literal>rtrim()</literal>, <literal>sin()</literal> + </para> + </listitem> + <listitem> + <para> + JDBC风格的参数传入 <literal>?</literal> + </para> + </listitem> + <listitem> + <para> + 命名参数<literal>:name</literal>, <literal>:start_date</literal>, <literal>:x1</literal> + </para> + </listitem> + <listitem> + <para> + SQL 直接常量 <literal>'foo'</literal>, <literal>69</literal>, <literal>6.66E+2</literal>, <literal>'1970-01-01 10:00:01.0'</literal> + </para> + </listitem> + <listitem> + <para> + Java <literal>public static final</literal> 类型的常量 <literal>eg.Color.TABBY</literal> + </para> + </listitem> + </itemizedlist> + + <para> + 关键字<literal>in</literal>与<literal>between</literal>可按如下方法使用: + </para> + + <programlisting><![CDATA[from DomesticCat cat where cat.name between 'A' and 'B']]></programlisting> + + <programlisting><![CDATA[from DomesticCat cat where cat.name in ( 'Foo', 'Bar', 'Baz' )]]></programlisting> + + <para> + 而且否定的格式也可以如下书写： + </para> + + <programlisting><![CDATA[from DomesticCat cat where cat.name not between 'A' and 'B']]></programlisting> + + <programlisting><![CDATA[from DomesticCat cat where cat.name not in ( 'Foo', 'Bar', 'Baz' )]]></programlisting> + + <para> + 同样, 子句<literal>is null</literal>与<literal>is not null</literal>可以被用来测试空值(null). + </para> + + <para> + 在Hibernate配置文件中声明HQL“查询替代（query substitutions）”之后， + 布尔表达式（Booleans）可以在其他表达式中轻松的使用: + </para> + + <programlisting><![CDATA[<property name="hibernate.query.substitutions">true 1, false 0</property>]]></programlisting> + + <para> + 系统将该HQL转换为SQL语句时，该设置表明将用字符 <literal>1</literal> 和 +<literal>0</literal> 来 + 取代关键字<literal>true</literal> 和 <literal>false</literal>: + + </para> + + <programlisting><![CDATA[from Cat cat where cat.alive = true]]></programlisting> + + <para> + 你可以用特殊属性<literal>size</literal>, 或是特殊函数<literal>size()</literal>测试一个集合的大小。 + </para> + + <programlisting><![CDATA[from Cat cat where cat.kittens.size > 0]]></programlisting> + + <programlisting><![CDATA[from Cat cat where size(cat.kittens) > 0]]></programlisting> + + <para> + 对于索引了（有序）的集合，你可以使用<literal>minindex</literal> 与 <literal>maxindex</literal>函数来引用到最小与最大的索引序数。 + 同理，你可以使用<literal>minelement</literal> 与 <literal>maxelement</literal>函数来 +引用到一个基本数据类型的集合中最小与最大的元素。 + + </para> + + <programlisting><![CDATA[from Calendar cal where maxelement(cal.holidays) > current_date]]></programlisting> + + <programlisting><![CDATA[from Order order where maxindex(order.items) > 100]]></programlisting> + + <programlisting><![CDATA[from Order order where minelement(order.items) > 10000]]></programlisting> + + <para> +在传递一个集合的索引集或者是元素集(<literal>elements</literal>与<literal>indices</literal> 函数) + 或者传递一个子查询的结果的时候，可以使用SQL函数<literal>any, some, all, exists, in</literal> + + </para> + + <programlisting><![CDATA[select mother from Cat as mother, Cat as kit +where kit in elements(foo.kittens)]]></programlisting> + + <programlisting><![CDATA[select p from NameList list, Person p +where p.name = some elements(list.names)]]></programlisting> + + <programlisting><![CDATA[from Cat cat where exists elements(cat.kittens)]]></programlisting> + + <programlisting><![CDATA[from Player p where 3 > all elements(p.scores)]]></programlisting> + + <programlisting><![CDATA[from Show show where 'fizard' in indices(show.acts)]]></programlisting> + + <para> + 注意，在Hibernate3种，这些结构变量- <literal>size</literal>, <literal>elements</literal>, + <literal>indices</literal>, <literal>minindex</literal>, <literal>maxindex</literal>, + <literal>minelement</literal>, <literal>maxelement</literal> - 只能在where子句中使用。 + </para> + + <para> + 一个被索引过的（有序的）集合的元素(arrays, lists, maps)可以在其他索引中被引用（只能在where子句中）： + </para> + + <programlisting><![CDATA[from Order order where order.items[0].id = 1234]]></programlisting> + + <programlisting><![CDATA[select person from Person person, Calendar calendar +where calendar.holidays['national day'] = person.birthDay + and person.nationality.calendar = calendar]]></programlisting> + + <programlisting><![CDATA[select item from Item item, Order order +where order.items[ order.deliveredItemIndices[0] ] = item and order.id = 11]]></programlisting> + + <programlisting><![CDATA[select item from Item item, Order order +where order.items[ maxindex(order.items) ] = item and order.id = 11]]></programlisting> + + <para> + 在<literal>[]</literal>中的表达式甚至可以是一个算数表达式。 + </para> + + <programlisting><![CDATA[select item from Item item, Order order +where order.items[ size(order.items) - 1 ] = item]]></programlisting> + + <para> + 对于一个一对多的关联（one-to-many association）或是值的集合中的元素， + HQL也提供内建的<literal>index()</literal>函数， + </para> + + <programlisting><![CDATA[select item, index(item) from Order order + join order.items item +where index(item) < 5]]></programlisting> + + <para> + 如果底层数据库支持标量的SQL函数，它们也可以被使用 + </para> + + <programlisting><![CDATA[from DomesticCat cat where upper(cat.name) like 'FRI%']]></programlisting> + + <para> + 如果你还不能对所有的这些深信不疑，想想下面的查询。如果使用SQL，语句长度会增长多少，可读性会下降多少： + </para> + + <programlisting><![CDATA[select cust +from Product prod, + Store store + inner join store.customers cust +where prod.name = 'widget' + and store.location.name in ( 'Melbourne', 'Sydney' ) + and prod = all elements(cust.currentOrder.lineItems)]]></programlisting> + + <para> + <emphasis>提示:</emphasis> 会像如下的语句 + </para> + + <programlisting><![CDATA[SELECT cust.name, cust.address, cust.phone, cust.id, cust.current_order +FROM customers cust, + stores store, + locations loc, + store_customers sc, + product prod +WHERE prod.name = 'widget' + AND store.loc_id = loc.id + AND loc.name IN ( 'Melbourne', 'Sydney' ) + AND sc.store_id = store.id + AND sc.cust_id = cust.id + AND prod.id = ALL( + SELECT item.prod_id + FROM line_items item, orders o + WHERE item.order_id = o.id + AND cust.current_order = o.id + )]]></programlisting> + + </sect1> + + <sect1 id="queryhql-ordering"> + <title>order by子句</title> + + <para> + 查询返回的列表(list)可以按照一个返回的类或组件（components)中的任何属性（property）进行排序： + </para> + + <programlisting><![CDATA[from DomesticCat cat +order by cat.name asc, cat.weight desc, cat.birthdate]]></programlisting> + + <para> + 可选的<literal>asc</literal>或<literal>desc</literal>关键字指明了按照升序或降序进行排序. + </para> + </sect1> + + <sect1 id="queryhql-grouping" revision="1"> + <title>group by子句</title> + + <para> + 一个返回聚集值(aggregate values)的查询可以按照一个返回的类或组件（components)中的任何属性（property）进行分组： + </para> + + <programlisting><![CDATA[select cat.color, sum(cat.weight), count(cat) +from Cat cat +group by cat.color]]></programlisting> + + <programlisting><![CDATA[select foo.id, avg(name), max(name) +from Foo foo join foo.names name +group by foo.id]]></programlisting> + + <para> + <literal>having</literal>子句在这里也允许使用. + </para> + + <programlisting><![CDATA[select cat.color, sum(cat.weight), count(cat) +from Cat cat +group by cat.color +having cat.color in (eg.Color.TABBY, eg.Color.BLACK)]]></programlisting> + + <para> + 如果底层的数据库支持的话(例如不能在MySQL中使用)，SQL的一般函数与聚集函数也可以出现 + 在<literal>having</literal>与<literal>order by</literal> 子句中。 + </para> + + <programlisting><![CDATA[select cat +from Cat cat + join cat.kittens kitten +group by cat.id, cat.name, cat.other, cat.properties +having avg(kitten.weight) > 100 +order by count(kitten) asc, sum(kitten.weight) desc]]></programlisting> + + <para> + 注意<literal>group by</literal>子句与 + <literal>order by</literal>子句中都不能包含算术表达式（arithmetic expressions）. + + 也要注意Hibernate目前不会扩展group的实体,因此你不能写<literal>group by cat</literal>,除非<literal>cat</literal>的所有属性都不是聚集的(non-aggregated)。你必须明确的列出所有的非聚集属性。 + </para> + + </sect1> + + + <sect1 id="queryhql-subqueries" revision="2"> + <title>子查询</title> + + <para> + 对于支持子查询的数据库，Hibernate支持在查询中使用子查询。一个子查询必须被圆括号包围起来（经常是SQL聚集函数的圆括号）。 + 甚至相互关联的子查询（引用到外部查询中的别名的子查询）也是允许的。 + </para> + + <programlisting><![CDATA[from Cat as fatcat +where fatcat.weight > ( + select avg(cat.weight) from DomesticCat cat +)]]></programlisting> + + <programlisting><![CDATA[from DomesticCat as cat +where cat.name = some ( + select name.nickName from Name as name +)]]></programlisting> + + <programlisting><![CDATA[from Cat as cat +where not exists ( + from Cat as mate where mate.mate = cat +)]]></programlisting> + + <programlisting><![CDATA[from DomesticCat as cat +where cat.name not in ( + select name.nickName from Name as name +)]]></programlisting> + + <programlisting><![CDATA[select cat.id, (select max(kit.weight) from cat.kitten kit) +from Cat as cat]]></programlisting> + + <para> + 注意，HQL自查询只可以在select或者where子句中出现。 + </para> + + <para> + 在select列表中包含一个表达式以上的子查询，你可以使用一个元组构造符（tuple constructors）： + </para> + + <programlisting><![CDATA[from Cat as cat +where not ( cat.name, cat.color ) in ( + select cat.name, cat.color from DomesticCat cat +)]]></programlisting> + + <para> + 注意在某些数据库中（不包括Oracle与HSQL），你也可以在其他语境中使用元组构造符， + 比如查询用户类型的组件与组合： + </para> + + <programlisting><![CDATA[from Person where name = ('Gavin', 'A', 'King')]]></programlisting> + + <para> + 该查询等价于更复杂的： + </para> + + <programlisting><![CDATA[from Person where name.first = 'Gavin' and name.initial = 'A' and name.last = 'King')]]></programlisting> + + <para> + 有两个很好的理由使你不应当作这样的事情：首先，它不完全适用于各个数据库平台；其次，查询现在依赖于映射文件中属性的顺序。 + </para> + + </sect1> + + <sect1 id="queryhql-examples"> + <title>HQL示例</title> + + <para> + Hibernate查询可以非常的强大与复杂。实际上，Hibernate的一个主要卖点就是查询语句的威力。这里有一些例子，它们与我在最近的 + 一个项目中使用的查询非常相似。注意你能用到的大多数查询比这些要简单的多！ + </para> + + <para> + 下面的查询对于某个特定的客户的所有未支付的账单，在给定给最小总价值的情况下，返回订单的id，条目的数量和总价值， + 返回值按照总价值的结果进行排序。为了决定价格，查询使用了当前目录。作为转换结果的SQL查询，使用了<literal>ORDER</literal>, + <literal>ORDER_LINE</literal>, <literal>PRODUCT</literal>, <literal>CATALOG</literal> 和<literal>PRICE</literal> + 库表。 + </para> + + <programlisting><![CDATA[select order.id, sum(price.amount), count(item) +from Order as order + join order.lineItems as item + join item.product as product, + Catalog as catalog + join catalog.prices as price +where order.paid = false + and order.customer = :customer + and price.product = product + and catalog.effectiveDate < sysdate + and catalog.effectiveDate >= all ( + select cat.effectiveDate + from Catalog as cat + where cat.effectiveDate < sysdate + ) +group by order +having sum(price.amount) > :minAmount +order by sum(price.amount) desc]]></programlisting> + + <para> + 这简直是一个怪物！实际上，在现实生活中，我并不热衷于子查询，所以我的查询语句看起来更像这个： + </para> + + <programlisting><![CDATA[select order.id, sum(price.amount), count(item) +from Order as order + join order.lineItems as item + join item.product as product, + Catalog as catalog + join catalog.prices as price +where order.paid = false + and order.customer = :customer + and price.product = product + and catalog = :currentCatalog +group by order +having sum(price.amount) > :minAmount +order by sum(price.amount) desc]]></programlisting> + + <para> + 下面一个查询计算每一种状态下的支付的数目，除去所有处于<literal>AWAITING_APPROVAL</literal>状态的支付，因为在该状态下 + 当前的用户作出了状态的最新改变。该查询被转换成含有两个内连接以及一个相关联的子选择的SQL查询，该查询使用了表 + <literal>PAYMENT</literal>, <literal>PAYMENT_STATUS</literal> 以及 + <literal>PAYMENT_STATUS_CHANGE</literal>。 + </para> + + <programlisting><![CDATA[select count(payment), status.name +from Payment as payment + join payment.currentStatus as status + join payment.statusChanges as statusChange +where payment.status.name <> PaymentStatus.AWAITING_APPROVAL + or ( + statusChange.timeStamp = ( + select max(change.timeStamp) + from PaymentStatusChange change + where change.payment = payment + ) + and statusChange.user <> :currentUser + ) +group by status.name, status.sortOrder +order by status.sortOrder]]></programlisting> + + <para> + 如果我把<literal>statusChanges</literal>实例集映射为一个列表（list）而不是一个集合（set）, + 书写查询语句将更加简单. + </para> + + <programlisting><![CDATA[select count(payment), status.name +from Payment as payment + join payment.currentStatus as status +where payment.status.name <> PaymentStatus.AWAITING_APPROVAL + or payment.statusChanges[ maxIndex(payment.statusChanges) ].user <> :currentUser +group by status.name, status.sortOrder +order by status.sortOrder]]></programlisting> + + <para> + 下面一个查询使用了MS SQL Server的 <literal>isNull()</literal>函数用以返回当前用户所属组织的组织帐号及组织未支付的账。 + 它被转换成一个对表<literal>ACCOUNT</literal>, <literal>PAYMENT</literal>, <literal>PAYMENT_STATUS</literal>, + <literal>ACCOUNT_TYPE</literal>, <literal>ORGANIZATION</literal> 以及 <literal>ORG_USER</literal>进行的三个内连接， + 一个外连接和一个子选择的SQL查询。 + </para> + + <programlisting><![CDATA[select account, payment +from Account as account + left outer join account.payments as payment +where :currentUser in elements(account.holder.users) + and PaymentStatus.UNPAID = isNull(payment.currentStatus.name, PaymentStatus.UNPAID) +order by account.type.sortOrder, account.accountNumber, payment.dueDate]]></programlisting> + + <para> + 对于一些数据库，我们需要弃用（相关的）子选择。 + </para> + + <programlisting><![CDATA[select account, payment +from Account as account + join account.holder.users as user + left outer join account.payments as payment +where :currentUser = user + and PaymentStatus.UNPAID = isNull(payment.currentStatus.name, PaymentStatus.UNPAID) +order by account.type.sortOrder, account.accountNumber, payment.dueDate]]></programlisting> + + </sect1> + + <sect1 id="queryhql-bulk" revision="2"> + <title>批量的UPDATE和DELETE</title> + + <para> + HQL现在支持 <literal>update</literal>, <literal>delete</literal> 和 + <literal>insert ... select ...</literal>语句. 查阅 + <xref linkend="batch-direct"/> 以获得更多信息。 + </para> + </sect1> + + <sect1 id="queryhql-tipstricks"> + <title>小技巧 &amp; 小窍门</title> + + <para> + 你可以统计查询结果的数目而不必实际的返回他们： + </para> + + <programlisting><![CDATA[( (Integer) session.createQuery("select count(*) from ....").iterate().next() ).intValue()]]></programlisting> + + <para> + 若想根据一个集合的大小来进行排序，可以使用如下的语句： + </para> + + <programlisting><![CDATA[select usr.id, usr.name +from User as usr + left join usr.messages as msg +group by usr.id, usr.name +order by count(msg)]]></programlisting> + + <para> + 如果你的数据库支持子选择，你可以在你的查询的where子句中为选择的大小（selection size）指定一个条件: + </para> + + <programlisting><![CDATA[from User usr where size(usr.messages) >= 1]]></programlisting> + + <para> + 如果你的数据库不支持子选择语句，使用下面的查询： + </para> + + <programlisting><![CDATA[select usr.id, usr.name +from User usr.name + join usr.messages msg +group by usr.id, usr.name +having count(msg) >= 1]]></programlisting> + + <para> + 因为内连接（inner join）的原因，这个解决方案不能返回含有零个信息的<literal>User</literal> + 类的实例, 所以这种情况下使用下面的格式将是有帮助的: + </para> + + <programlisting><![CDATA[select usr.id, usr.name +from User as usr + left join usr.messages as msg +group by usr.id, usr.name +having count(msg) = 0]]></programlisting> + + <para> + JavaBean的属性可以被绑定到一个命名查询（named query）的参数上： + </para> + + <programlisting><![CDATA[Query q = s.createQuery("from foo Foo as foo where foo.name=:name and foo.size=:size"); +q.setProperties(fooBean); // fooBean包含方法getName()与getSize() +List foos = q.list();]]></programlisting> + + <para> + 通过将接口<literal>Query</literal>与一个过滤器（filter）一起使用，集合（Collections）是可以分页的： + </para> + + <programlisting><![CDATA[Query q = s.createFilter( collection, "" ); // 一个简单的过滤器 +q.setMaxResults(PAGE_SIZE); +q.setFirstResult(PAGE_SIZE * pageNumber); +List page = q.list();]]></programlisting> + + <para> + 通过使用查询过滤器（query filter）可以将集合（Collection）的原素分组或排序: + </para> + + <programlisting><![CDATA[Collection orderedCollection = s.filter( collection, "order by this.amount" ); +Collection counts = s.filter( collection, "select this.type, count(this) group by this.type" );]]></programlisting> + + <para> + 不用通过初始化，你就可以知道一个集合（Collection）的大小： + </para> + + <programlisting><![CDATA[( (Integer) session.createQuery("select count(*) from ....").iterate().next() ).intValue();]]></programlisting> + + </sect1> + +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/query_sql.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/query_sql.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/query_sql.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/query_sql.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,715 @@ +<chapter id="querysql" revision="2"> + <title>Native SQL查询</title> + <para> + 你也可以使用你的数据库的Native SQL语言来查询数据。这对你在要使用数据库的某些特性的时候(比如说在查询提示或者Oracle中的 + <literal>CONNECT</literal>关键字)，这是非常有用的。这就能够扫清你把原来直接使用SQL/JDBC 的程序迁移到基于 + Hibernate应用的道路上的障碍。 + </para> + + <para> + Hibernate3允许你使用手写的sql来完成所有的create,update,delete,和load操作（包括存储过程） + </para> + + <sect1 id="querysql-creating" revision="4"> + <title>使用<literal>SQLQuery</literal></title> + + <para>对原生SQL查询执行的控制是通过<literal>SQLQuery</literal>接口进行的，通过执行<literal>Session.createSQLQuery()</literal>获取这个接口。下面来描述如何使用这个API进行查询。</para> + + <sect2> + <title>标量查询（Scalar queries）</title> + + <para> + 最基本的SQL查询就是获得一个标量（数值）的列表。 </para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT * FROM CATS").list(); +sess.createSQLQuery("SELECT ID, NAME, BIRTHDATE FROM CATS").list(); +]]></programlisting> + + <para> + 它们都将返回一个Object数组(Object[])组成的List，数组每个元素都是CATS表的一个字段值。Hibernate会使用ResultSetMetadata来判定返回的标量值的实际顺序和类型。 + </para> + + <para> + 如果要避免过多的使用<literal>ResultSetMetadata</literal>,或者只是为了更加明确的指名返回值，可以使用<literal>addScalar()</literal>。 + </para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT * FROM CATS") + .addScalar("ID", Hibernate.LONG) + .addScalar("NAME", Hibernate.STRING) + .addScalar("BIRTHDATE", Hibernate.DATE) +]]></programlisting> + + + <para>这个查询指定了:</para> + + <itemizedlist> + <listitem> + <para>SQL查询字符串</para> + </listitem> + + <listitem> + <para>要返回的字段和类型</para> + </listitem> + </itemizedlist> + + <para> + 它仍然会返回Object数组,但是此时不再使用<literal>ResultSetMetdata</literal>,而是明确的将ID,NAME和BIRTHDATE按照Long,String和Short类型从resultset中取出。同时，也指明了就算query是使用<literal>*</literal>来查询的，可能获得超过列出的这三个字段，也仅仅会返回这三个字段。 + </para> + + <para> + 对全部或者部分的标量值不设置类型信息也是可以的。 + </para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT * FROM CATS") + .addScalar("ID", Hibernate.LONG) + .addScalar("NAME") + .addScalar("BIRTHDATE") +]]></programlisting> + + <para> + 基本上这和前面一个查询相同,只是此时使用<literal>ResultSetMetaData</literal>来决定NAME和BIRTHDATE的类型，而ID的类型是明确指出的。 + </para> + + <para> + 关于从ResultSetMetaData返回的java.sql.Types是如何映射到Hibernate类型，是由方言(Dialect)控制的。假若某个指定的类型没有被映射，或者不是你所预期的类型，你可以通过Dialet的<literal>registerHibernateType</literal>调用自行定义。 + </para> + + </sect2> + + <sect2> + <title>实体查询(Entity queries)</title> + + <para> + 上面的查询都是返回标量值的，也就是从resultset中返回的“裸”数据。下面展示如何通过<literal>addEntity()</literal>让原生查询返回实体对象。 + </para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT * FROM CATS").addEntity(Cat.class); +sess.createSQLQuery("SELECT ID, NAME, BIRTHDATE FROM CATS").addEntity(Cat.class); +]]></programlisting> + + <para>这个查询指定：</para> + + <itemizedlist> + <listitem> + <para>SQL查询字符串</para> + </listitem> + + <listitem> + <para>要返回的实体</para> + </listitem> + </itemizedlist> + + <para> + 假设Cat被映射为拥有ID,NAME和BIRTHDATE三个字段的类，以上的两个查询都返回一个List，每个元素都是一个Cat实体。 + </para> + + <para> + 假若实体在映射时有一个<literal>many-to-one</literal>的关联指向另外一个实体，在查询时必须也返回那个实体，否则会导致发生一个"column not found"的数据库错误。这些附加的字段可以使用*标注来自动返回，但我们希望还是明确指明，看下面这个具有指向<literal>Dog</literal>的<literal>many-to-one</literal>的例子： + </para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT ID, NAME, BIRTHDATE, DOG_ID FROM CATS").addEntity(Cat.class); +]]></programlisting> + + <para> + 这样cat.getDog()就能正常运作。 + </para> + </sect2> + + <sect2> + <title>处理关联和集合类(Handling associations and collections)</title> + + <para> + 通过提前抓取将<literal>Dog</literal>连接获得，而避免初始化proxy带来的额外开销也是可能的。这是通过<literal>addJoin()</literal>方法进行的，这个方法可以让你将关联或集合连接进来。 + </para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT c.ID, NAME, BIRTHDATE, DOG_ID, D_ID, D_NAME FROM CATS c, DOGS d WHERE c.DOG_ID = d.D_ID") + .addEntity("cat", Cat.class) + .addJoin("cat.dog"); +]]></programlisting> + + <para> + 上面这个例子中，返回的<literal>Cat</literal>对象，其<literal>dog</literal>属性被完全初始化了，不再需要数据库的额外操作。注意，我们加了一个别名("cat")，以便指明join的目标属性路径。通过同样的提前连接也可以作用于集合类，例如，假若<literal>Cat</literal>有一个指向<literal>Dog</literal>的一对多关联。 + </para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT ID, NAME, BIRTHDATE, D_ID, D_NAME, CAT_ID FROM CATS c, DOGS d WHERE c.ID = d.CAT_ID") + .addEntity("cat", Cat.class) + .addJoin("cat.dogs"); +]]></programlisting> + + <p> + 到此为止，我们碰到了天花板：若不对SQL查询进行增强，这些已经是在Hibernate中使用原生SQL查询所能做到的最大可能了。下面的问题即将出现：返回多个同样类型的实体怎么办？或者默认的别名/字段不够又怎么办？ + + </p> + </sect2> + + <sect2> + <title>返回多个实体(Returning multiple entities)</title> + + <para> + 到目前为止,结果集字段名被假定为和映射文件中指定的的字段名是一致的。假若SQL查询连接了多个表，同一个字段名可能在多个表中出现多次，这就会造成问题。 + </para> + + <para> + 下面的查询中需要使用字段别名注射（这个例子本身会失败）： + </para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT c.*, m.* FROM CATS c, CATS m WHERE c.MOTHER_ID = c.ID") + .addEntity("cat", Cat.class) + .addEntity("mother", Cat.class) +]]></programlisting> + + <para> + 这个查询的本意是希望每行返回两个Cat实例，一个是cat,另一个是它的妈妈。但是因为它们的字段名被映射为相同的，而且在某些数据库中，返回的字段别名是“c.ID”,"c.NAME"这样的形式，而它们和在映射文件中的名字（"ID"和"NAME"）不匹配，这就会造成失败。 + + </para> + + <para> + 下面的形式可以解决字段名重复： + </para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT {cat.*}, {mother.*} FROM CATS c, CATS m WHERE c.MOTHER_ID = c.ID") + .addEntity("cat", Cat.class) + .addEntity("mother", Cat.class) +]]></programlisting> + + <para>这个查询指明：</para> + + <itemizedlist> + <listitem> + <para> + SQL查询语句，其中包含占位附来让Hibernate注射字段别名</para> + </listitem> + + <listitem> + <para> + 查询返回的实体 + </para> + </listitem> + </itemizedlist> + + <para> + 上面使用的{cat.*}和{mother.*}标记是作为“所有属性”的简写形式出现的。当然你也可以明确地罗列出字段名，但在这个例子里面我们让Hibernate来为每个属性注射SQL字段别名。字段别名的占位符是属性名加上表别名的前缀。在下面的例子中，我们从另外一个表（cat_log）中通过映射元数据中的指定获取Cat和它的妈妈。注意，要是我们愿意，我们甚至可以在where子句中使用属性别名。 + + </para> + + <programlisting><![CDATA[String sql = "SELECT ID as {c.id}, NAME as {c.name}, " + + "BIRTHDATE as {c.birthDate}, MOTHER_ID as {c.mother}, {mother.*} " + + "FROM CAT_LOG c, CAT_LOG m WHERE {c.mother} = c.ID"; + +List loggedCats = sess.createSQLQuery(sql) + .addEntity("cat", Cat.class) + .addEntity("mother", Cat.class).list() +]]></programlisting> + + <sect3 id="querysql-aliasreferences" revision="2"> + <title>别名和属性引用(Alias and property references)</title> + + <para> + 大多数情况下，都需要上面的属性注射，但在使用更加复杂的映射，比如复合属性、通过标识符构造继承树，以及集合类等等情况下，也有一些特别的别名，来允许Hibernate注射合适的别名。 + </para> + + <para> + 下表列出了使用别名注射参数的不同可能性。注意：下面结果中的别名只是示例，实用时每个别名需要唯一并且不同的名字。 + </para> + + <table frame="topbot" id="aliasinjection-summary"> + <title>别名注射(alias injection names)</title> + + <tgroup cols="3"> + <colspec colwidth="1*" /> + + <colspec colwidth="1*" /> + + <colspec colwidth="2.5*" /> + + <thead> + <row> + <entry>描述</entry> + + <entry>语法</entry> + + <entry>示例</entry> + </row> + </thead> + <tbody> + <row> + <entry>简单属性</entry> + <entry><literal>{[aliasname].[propertyname]</literal></entry> + <entry><literal>A_NAME as {item.name}</literal></entry> + </row> + <row> + <entry>复合属性</entry> + <entry><literal>{[aliasname].[componentname].[propertyname]}</literal></entry> + <entry><literal>CURRENCY as {item.amount.currency}, VALUE as {item.amount.value}</literal></entry> + </row> + <row> + <entry>实体辨别器(Discriminator of an entity)</entry> + <entry><literal>{[aliasname].class}</literal></entry> + <entry><literal>DISC as {item.class}</literal></entry> + </row> + <row> + <entry>实体的所有属性</entry> + <entry><literal>{[aliasname].*}</literal></entry> + <entry><literal>{item.*}</literal></entry> + </row> + <row> + <entry>集合键(collection key)</entry> + <entry><literal>{[aliasname].key}</literal></entry> + <entry><literal>ORGID as {coll.key}</literal></entry> + </row> + <row> + <entry>集合id</entry> + <entry><literal>{[aliasname].id}</literal></entry> + <entry><literal>EMPID as {coll.id}</literal></entry> + </row> + <row> + <entry>集合元素</entry> + <entry><literal>{[aliasname].element}</literal></entry> + <entry><literal>XID as {coll.element}</literal></entry> + <entry></entry> + </row> + <row> + <entry>集合元素的属性</entry> + <entry><literal>{[aliasname].element.[propertyname]}</literal></entry> + <entry><literal>NAME as {coll.element.name}</literal></entry> + </row> + <row> + <entry>集合元素的所有属性</entry> + <entry><literal>{[aliasname].element.*}</literal></entry> + <entry><literal>{coll.element.*}</literal></entry> + </row> + <row> + <entry>集合的所有属性</entry> + <entry><literal>{[aliasname].*}</literal></entry> + <entry><literal>{coll.*}</literal></entry> + </row> + </tbody> + </tgroup> + </table> + + + </sect3> + </sect2> + + <sect2> + <title>返回非受管实体(Returning non-managed entities)</title> + + <para> + 可以对原生sql 查询使用ResultTransformer。这会返回不受Hibernate管理的实体。 + + </para> + + <programlisting><![CDATA[sess.createSQLQuery("SELECT NAME, BIRTHDATE FROM CATS") + .setResultTransformer(Transformers.aliasToBean(CatDTO.class))]]></programlisting> + + <para>这个查询指定：</para> + + <itemizedlist> + <listitem> + <para>SQL查询字符串</para> + </listitem> + + <listitem> + <para>结果转换器(result transformer)</para> + </listitem> + </itemizedlist> + + <para> + 上面的查询将会返回<literal>CatDTO</literal>的列表,它将被实例化并且将NAME和BIRTHDAY的值注射入对应的属性或者字段。 + </para> + </sect2> + + <sect2> + <title>处理继承（Handling inheritance）</title> + + <para> + 原生SQL查询假若其查询结果实体是继承树中的一部分，它必须包含基类和所有子类的所有属性。 + </para> + </sect2> + + <sect2> + <title>参数（Parameters）</title> + + <para> + 原生查询支持位置参数和命名参数： + </para> + + <programlisting><![CDATA[Query query = sess.createSQLQuery("SELECT * FROM CATS WHERE NAME like ?").addEntity(Cat.class); +List pusList = query.setString(0, "Pus%").list(); + +query = sess.createSQLQuery("SELECT * FROM CATS WHERE NAME like :name").addEntity(Cat.class); +List pusList = query.setString("name", "Pus%").list(); ]]></programlisting> + </sect2> + + + + </sect1> + + + <sect1 id="querysql-namedqueries" revision="3"> + <title>命名SQL查询</title> + + <para> + 可以在映射文档中定义查询的名字,然后就可以象调用一个命名的HQL查询一样直接调用命名SQL查询.在这种情况下,我们<emphasis>不</emphasis> + 需要调用<literal>addEntity()</literal>方法. + </para> + + <programlisting><![CDATA[<sql-query name="persons"> + <return alias="person" class="eg.Person"/> + SELECT person.NAME AS {person.name}, + person.AGE AS {person.age}, + person.SEX AS {person.sex} + FROM PERSON person + WHERE person.NAME LIKE :namePattern +</sql-query>]]></programlisting> + + <programlisting><![CDATA[List people = sess.getNamedQuery("persons") + .setString("namePattern", namePattern) + .setMaxResults(50) + .list();]]></programlisting> + + <para><literal>&lt;return-join&gt;</literal>和 + <literal>&lt;load-collection&gt;</literal> 元素是用来连接关联以及将查询定义为预先初始化各个集合的。</para> + + <programlisting><![CDATA[<sql-query name="personsWith"> + <return alias="person" class="eg.Person"/> + <return-join alias="address" property="person.mailingAddress"/> + SELECT person.NAME AS {person.name}, + person.AGE AS {person.age}, + person.SEX AS {person.sex}, + address.STREET AS {address.street}, + address.CITY AS {address.city}, + address.STATE AS {address.state}, + address.ZIP AS {address.zip} + FROM PERSON person + JOIN ADDRESS address + ON person.ID = address.PERSON_ID AND address.TYPE='MAILING' + WHERE person.NAME LIKE :namePattern +</sql-query>]]></programlisting> + + + <para> + 一个命名查询可能会返回一个标量值.你必须使用<literal>&lt;return-scalar&gt;</literal>元素来指定字段的别名和 + Hibernate类型 + </para> + + <programlisting><![CDATA[<sql-query name="mySqlQuery"> + <return-scalar column="name" type="string"/> + <return-scalar column="age" type="long"/> + SELECT p.NAME AS name, + p.AGE AS age, + FROM PERSON p WHERE p.NAME LIKE 'Hiber%' +</sql-query>]]></programlisting> + + <para> + 你可以把结果集映射的信息放在外部的<literal>&lt;resultset&gt;</literal>元素中，这样就可以在多个命名查询间，或者通过<literal>setResultSetMapping()</literal>API来访问。(此处原文即存疑。原文为：You can externalize the resultset mapping informations in a + <literal>&lt;resultset&gt;</literal> element to either reuse them accross + several named queries or through the + <literal>setResultSetMapping()</literal> API.) + </para> + + <programlisting><![CDATA[<resultset name="personAddress"> + <return alias="person" class="eg.Person"/> + <return-join alias="address" property="person.mailingAddress"/> +</resultset> + +<sql-query name="personsWith" resultset-ref="personAddress"> + SELECT person.NAME AS {person.name}, + person.AGE AS {person.age}, + person.SEX AS {person.sex}, + address.STREET AS {address.street}, + address.CITY AS {address.city}, + address.STATE AS {address.state}, + address.ZIP AS {address.zip} + FROM PERSON person + JOIN ADDRESS address + ON person.ID = address.PERSON_ID AND address.TYPE='MAILING' + WHERE person.NAME LIKE :namePattern +</sql-query>]]></programlisting> + + <para> + 另外,你可以在java代码中直接使用hbm文件中的结果集定义信息。 + </para> + + <programlisting><![CDATA[List cats = sess.createSQLQuery( + "select {cat.*}, {kitten.*} from cats cat, cats kitten where kitten.mother = cat.id" + ) + .setResultSetMapping("catAndKitten") + .list();]]></programlisting> + + <sect2 id="propertyresults"> + <title>使用return-property来明确地指定字段/别名</title> + + <para> + 使用<literal>&lt;return-property&gt;</literal>你可以明确的告诉Hibernate使用哪些字段别名,这取代了使用<literal>{}</literal>-语法 + 来让Hibernate注入它自己的别名. + </para> + + <programlisting><![CDATA[<sql-query name="mySqlQuery"> + <return alias="person" class="eg.Person"> + <return-property name="name" column="myName"/> + <return-property name="age" column="myAge"/> + <return-property name="sex" column="mySex"/> + </return> + SELECT person.NAME AS myName, + person.AGE AS myAge, + person.SEX AS mySex, + FROM PERSON person WHERE person.NAME LIKE :name +</sql-query> +]]></programlisting> + <literal>&lt;return-property&gt;</literal>也可用于多个字段,它解决了使用<literal>{}</literal>-语法不能细粒度控制多个字段的限制 + <programlisting><![CDATA[<sql-query name="organizationCurrentEmployments"> + <return alias="emp" class="Employment"> + <return-property name="salary"> + <return-column name="VALUE"/> + <return-column name="CURRENCY"/> + </return-property> + <return-property name="endDate" column="myEndDate"/> + </return> + SELECT EMPLOYEE AS {emp.employee}, EMPLOYER AS {emp.employer}, + STARTDATE AS {emp.startDate}, ENDDATE AS {emp.endDate}, + REGIONCODE as {emp.regionCode}, EID AS {emp.id}, VALUE, CURRENCY + FROM EMPLOYMENT + WHERE EMPLOYER = :id AND ENDDATE IS NULL + ORDER BY STARTDATE ASC +</sql-query>]]></programlisting> + + <para> + 注意在这个例子中,我们使用了<literal>&lt;return-property&gt;</literal>结合<literal>{}</literal>的注入语法. + 允许用户来选择如何引用字段以及属性. + </para> + + <para> + 如果你映射一个识别器(discriminator),你必须使用<literal>&lt;return-discriminator&gt;</literal> 来指定识别器字段 + </para> + </sect2> + + <sect2 id="sp_query" revision="1"> + <title>使用存储过程来查询</title> + + <para> + Hibernate 3引入了对存储过程查询(stored procedure)和函数(function)的支持.以下的说明中，这二者一般都适用。 + + 存储过程/函数必须返回一个结果集,作为Hibernate能够使用的第一个外部参数. + + 下面是一个Oracle9和更高版本的存储过程例子.</para> + + <programlisting><![CDATA[CREATE OR REPLACE FUNCTION selectAllEmployments + RETURN SYS_REFCURSOR +AS + st_cursor SYS_REFCURSOR; +BEGIN + OPEN st_cursor FOR + SELECT EMPLOYEE, EMPLOYER, + STARTDATE, ENDDATE, + REGIONCODE, EID, VALUE, CURRENCY + FROM EMPLOYMENT; + RETURN st_cursor; + END;]]></programlisting> + <para> + 在Hibernate里要要使用这个查询,你需要通过命名查询来映射它. + </para> + + <programlisting><![CDATA[<sql-query name="selectAllEmployees_SP" callable="true"> + <return alias="emp" class="Employment"> + <return-property name="employee" column="EMPLOYEE"/> + <return-property name="employer" column="EMPLOYER"/> + <return-property name="startDate" column="STARTDATE"/> + <return-property name="endDate" column="ENDDATE"/> + <return-property name="regionCode" column="REGIONCODE"/> + <return-property name="id" column="EID"/> + <return-property name="salary"> + <return-column name="VALUE"/> + <return-column name="CURRENCY"/> + </return-property> + </return> + { ? = call selectAllEmployments() } +</sql-query>]]></programlisting> + + <para> + 注意存储过程当前仅仅返回标量和实体.现在不支持<literal>&lt;return-join&gt;</literal>和<literal>&lt;load-collection&gt;</literal> + + </para> + + <sect3 id="querysql-limits-storedprocedures" revision="1"> + <title>使用存储过程的规则和限制</title> + + <para> + 为了在Hibernate中使用存储过程,你必须遵循一些规则.不遵循这些规则的存储过程将不可用.如果你仍然想要使用他们, + 你必须通过<literal>session.connection()</literal>来执行他们.这些规则针对于不同的数据库.因为数据库 + 提供商有各种不同的存储过程语法和语义. + </para> + + <para> + 对存储过程进行的查询无法使用<literal>setFirstResult()/setMaxResults()</literal>进行分页。 + </para> + + + <para>建议采用的调用方式是标准SQL92: <literal>{ ? = call + functionName(&lt;parameters&gt;) }</literal> 或者 <literal>{ ? = call + procedureName(&lt;parameters&gt;}</literal>.原生调用语法不被支持。</para> + + <para> + 对于Oracle有如下规则: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para>函数必须返回一个结果集。存储过程的第一个参数必须是<literal>OUT</literal>，它返回一个结果集。这是通过Oracle 9或10的<literal>SYS_REFCURSOR</literal>类型来完成的。在Oracle中你需要定义一个<literal>REF CURSOR</literal>类型，参见Oracle的手册。</para> + </listitem> + </itemizedlist> + + <para> + 对于Sybase或者MS SQL server有如下规则: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + 存储过程必须返回一个结果集。.注意这些servers可能返回多个结果集以及更新的数目.Hibernate将取出第一条结果集作为它的返回值， + 其他将被丢弃。 + </para> + </listitem> + <listitem> + <para> + 如果你能够在存储过程里设定<literal>SET NOCOUNT ON</literal>，这可能会效率更高，但这不是必需的。 + </para> + </listitem> + </itemizedlist> + </sect3> + </sect2> + + </sect1> + + <sect1 id="querysql-cud"> + <title>定制SQL用来create，update和delete</title> + + <para> + Hibernate3能够使用定制的SQL语句来执行create,update和delete操作。在Hibernate中，持久化的类和集合已经 + 包含了一套配置期产生的语句(insertsql, deletesql, updatesql等等)，这些映射标记 <literal>&lt;sql-insert&gt;</literal>, + <literal>&lt;sql-delete&gt;</literal>, and <literal>&lt;sql-update&gt;</literal>重载了 + 这些语句。 + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id"> + <generator class="increment"/> + </id> + <property name="name" not-null="true"/> + <sql-insert>INSERT INTO PERSON (NAME, ID) VALUES ( UPPER(?), ? )</sql-insert> + <sql-update>UPDATE PERSON SET NAME=UPPER(?) WHERE ID=?</sql-update> + <sql-delete>DELETE FROM PERSON WHERE ID=?</sql-delete> +</class>]]></programlisting> + + <para> + 这些SQL直接在你的数据库里执行，所以你可以自由的使用你喜欢的任意语法。但如果你使用数据库特定的语法， + 这当然会降低你映射的可移植性。 + </para> + + <para> + 如果设定<literal>callable</literal>，则能够支持存储过程了。 + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id"> + <generator class="increment"/> + </id> + <property name="name" not-null="true"/> + <sql-insert callable="true">{call createPerson (?, ?)}</sql-insert> + <sql-delete callable="true">{? = call deletePerson (?)}</sql-delete> + <sql-update callable="true">{? = call updatePerson (?, ?)}</sql-update> +</class>]]></programlisting> + + <para> + 参数的位置顺序是非常重要的，他们必须和Hibernate所期待的顺序相同。 + </para> + + <para> + 你能够通过设定日志调试级别为<literal>org.hiberante.persister.entity</literal>,来查看Hibernate所期待的顺序。在这个级别下， + Hibernate将会打印出create,update和delete实体的静态SQL。(如果想看到预计的顺序。记得不要将定制SQL包含在映射文件里， + 因为他们会重载Hibernate生成的静态SQL。) + </para> + + <para> + 在大多数情况下(最好这么做)，存储过程需要返回插入/更新/删除的行数，因为Hibernate对语句的成功执行有些运行时的检查。 + Hibernate常会把进行CUD操作的语句的第一个参数注册为一个数值型输出参数。 + </para> + + <programlisting><![CDATA[CREATE OR REPLACE FUNCTION updatePerson (uid IN NUMBER, uname IN VARCHAR2) + RETURN NUMBER IS +BEGIN + + update PERSON + set + NAME = uname, + where + ID = uid; + + return SQL%ROWCOUNT; + +END updatePerson;]]></programlisting> + + + </sect1> + + <sect1 id="querysql-load"> + <title>定制装载SQL</title> + + <para> + 你可能需要声明你自己的SQL(或HQL)来装载实体 + </para> + + <programlisting><![CDATA[<sql-query name="person"> + <return alias="pers" class="Person" lock-mode="upgrade"/> + SELECT NAME AS {pers.name}, ID AS {pers.id} + FROM PERSON + WHERE ID=? + FOR UPDATE +</sql-query>]]></programlisting> + + <para> + 这只是一个前面讨论过的命名查询声明，你可以在类映射里引用这个命名查询。 + </para> + + <programlisting><![CDATA[<class name="Person"> + <id name="id"> + <generator class="increment"/> + </id> + <property name="name" not-null="true"/> + <loader query-ref="person"/> +</class>]]></programlisting> + + <para> + 这也可以用于存储过程 + </para> + + <para>你甚至可以定一个用于集合装载的查询:</para> + + <programlisting><![CDATA[<set name="employments" inverse="true"> + <key/> + <one-to-many class="Employment"/> + <loader query-ref="employments"/> +</set>]]></programlisting> + + <programlisting><![CDATA[<sql-query name="employments"> + <load-collection alias="emp" role="Person.employments"/> + SELECT {emp.*} + FROM EMPLOYMENT emp + WHERE EMPLOYER = :id + ORDER BY STARTDATE ASC, EMPLOYEE ASC +</sql-query>]]></programlisting> + + <para>你甚至还可以定义一个实体装载器，它通过连接抓取装载一个集合:</para> + + <programlisting><![CDATA[<sql-query name="person"> + <return alias="pers" class="Person"/> + <return-join alias="emp" property="pers.employments"/> + SELECT NAME AS {pers.*}, {emp.*} + FROM PERSON pers + LEFT OUTER JOIN EMPLOYMENT emp + ON pers.ID = emp.PERSON_ID + WHERE ID=? +</sql-query>]]></programlisting> + </sect1> + +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/quickstart.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/quickstart.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/quickstart.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/quickstart.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,461 @@ +<chapter id="quickstart"> + <title>在Tomcat中快速上手</title> + + <sect1 id="quickstart-intro" revision="2"> + <title>开始Hibernate之旅</title> + + <para> + 这份教程描述如何在Apache Tomcat servlet容器中为web应用程序配置Hibernate 3.0(我们使用Tomcat 4.1版本，与5.0版本差别很小)。Hibernate在大多数主流J2EE应用服务器 + 的运行环境中都可以工作良好，甚至也可以在独立Java应用程序中使用。在本教程中使用的示例数据库系统是PostgreSQL 7.4,只需要修改Hibernate SQL语言配置与连接属性，就可以 + 很容易的支持其他数据库了。 + </para> + + <para> + 第一步，我们必须拷贝所有需要的库文件到Tomcat安装目录中。在这篇教程中，我们使用一个独立的web Context配置（<literal>webapps/quickstart</literal>）。我们确认全局库文件（<literal>TOMCAT/common/lib</literal>）和本web应用程序上下文的路径（对于jar来说是<literal>webapps/quickstart/WEB-INF/lib</literal>，对于class文件来说是<literal>webapps/quickstart/WEB-INF/classes</literal>）能够被类装载器检索到。我们把这两个类装载器级别分别称做全局类路径(global classpath)和上下文类路径(context classpath)。 + </para> + + <para> + 现在，把这些库文件copy到两个类路径去: + </para> + + <orderedlist> + <listitem> + <para> + 把数据库需要的JDBC驱动文件拷贝到全局类路径，这是tomcat捆绑的DBCP连接池所需要的。Hibernate使用JDBC连接数据库方式执行SQL语句，所以你要么提供外部连接池中的连接给Hibernate，或者配置Hibernate自带的连接池（C3PO,Proxool）。对于本教程来说，把<literal>pg74jdbc3.jar</literal>库文件（支持PostgreSQL 7.4和JDK 1.4)到全局类装载路径下即可。如果你希望使用其他的数据库，拷贝其相应的JDBC 驱动文件）。 + </para> + </listitem> + <listitem> + <para> + 永远不要拷贝任何其他东西到Tomcat的全局类路径下，否则你可能在使用其他一些工具上遇到麻烦，比如log4j, commons-logging等等。 + 一定要让每个web应用程序使用自己的上下文类路径，就是说把你自己需要的类库拷贝到<literal>WEB-INF/lib</literal>下去，把配置文件configuration/property等配置文件拷贝到<literal>WEB-INF/classes</literal>下面去。这两个目录都是当前程序缺省的上下文类路径。 + </para> + </listitem> + <listitem> + <para> + Hibernate本身打包成一个JAR类库。将<literal>hibernate3.jar</literal>文件拷贝到程序的上下文类路径下，和你应用程序的其他库文件放一起。在运行时，Hibernate还需要一些第三方类库，它们在Hibernate发行包的<literal>lib/</literal>目录下。参见<xref linkend="3rdpartylibs"/>。把所需要的第三方库文件也拷贝到上下文类路径下。 + </para> + </listitem> + </orderedlist> + + <table frame="topbot" id="3rdpartylibs"> + <title> + Hibernate 第三方类库 + </title> + <tgroup cols="2" rowsep="1" colsep="1"> + <colspec colname="c1" colwidth="1*"/> + <colspec colname="c2" colwidth="2*"/> + <thead> + <row> + <entry align="center"> + 类库 + </entry> + <entry align="center"> + 描述 + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + antlr (必需) + </entry> + <entry> + Hibernate使用ANTLR来产生查询分析器，这个类库在运行环境下时也是必需的。 + </entry> + </row> + <row> + <entry> + dom4j (必需) + </entry> + <entry> + Hibernate使用dom4j解析XML配置文件和XML映射元文件。 + </entry> + </row> + <row> + <entry> + CGLIB ,asm(必需) + </entry> + <entry> + Hibernate在运行时使用这个代码生成库增强类（与Java反射机制联合使用）。 + </entry> + </row> + <row> + <entry> + Commons Collections, Commons Logging (必需) + </entry> + <entry> + Hibernat使用Apache Jakarta Commons项目提供的多个工具类库。 + </entry> + </row> + <row> + <entry> + EHCache (必需) + </entry> + <entry> + Hibernate可以使用不同cache缓存工具作为二级缓存。EHCache是缺省的cache缓存工具。 + </entry> + </row> + <row> + <entry> + Log4j (可选) + </entry> + <entry> + Hibernate使用Commons Logging API,它也可以依次使用Log4j作为底层实施log的机制。如果上下文类目录中存在Log4j库，则Commons Logging使用Log4j和并它在上下文类路径中寻找的<literal>log4j.properties</literal>文件。你可以使用在Hibernate发行包中包含中的那个示例Log4j的配置文件。这样，把log4j.jar和它的配置文件（位于<literal>src/</literal>目录中）拷贝到你的上下文类路径下，就可以在后台看到底程序如何运行的。 + </entry> + </row> + <row> + <entry> + 其他文件是不是必需的？ + </entry> + <entry> + 请察看Hibernate发行包中的 lib/README.txt文件，这是一个Hibernate发行包中附带的第三方类库的列表，他们总是保持最新的。你可以在那里找到所有必需或者可选的类库(注意：其中的"buildtime required"指的是编译Hibernate时所需要而非编译你自己的程序所必需的类库）。 + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + 接下来我们来配置在Tomcat和Hibernate中共用的数据库连接池。也就是说Tomcat会提供经过池处理的JDBC连接（用它内置的DBCP连接池），Hibernate通过JNDI方式来请求获得JDBC连接。作为替代方案，你也可以让Hibernate自行管理连接池。Tomcat把连接池绑定到JNDI,我们要在Tomcat的主配置文件（<literal>TOMCAT/conf/server.xml</literal>）中加一个资源声明: + </para> + + <programlisting><![CDATA[<Context path="/quickstart" docBase="quickstart"> + <Resource name="jdbc/quickstart" scope="Shareable" type="javax.sql.DataSource"/> + <ResourceParams name="jdbc/quickstart"> + <parameter> + <name>factory</name> + <value>org.apache.commons.dbcp.BasicDataSourceFactory</value> + </parameter> + + <!-- DBCP database connection settings --> + <parameter> + <name>url</name> + <value>jdbc:postgresql://localhost/quickstart</value> + </parameter> + <parameter> + <name>driverClassName</name><value>org.postgresql.Driver</value> + </parameter> + <parameter> + <name>username</name> + <value>quickstart</value> + </parameter> + <parameter> + <name>password</name> + <value>secret</value> + </parameter> + + <!-- DBCP connection pooling options --> + <parameter> + <name>maxWait</name> + <value>3000</value> + </parameter> + <parameter> + <name>maxIdle</name> + <value>100</value> + </parameter> + <parameter> + <name>maxActive</name> + <value>10</value> + </parameter> + </ResourceParams> +</Context>]]></programlisting> + + <para> + 我们在这个例子中要配置的上下文叫做<literal>quickstart</literal>，它位于<literal>TOMCAT/webapp/quickstart</literal>目录下。如果要访问这个应用程序,在你的浏览器中输入<literal>http://localhost:8080/quickstart</literal>就可以了(当然，在后面加上在你的<literal>web.xml</literal>文件中配置好你的servlet)。你现在可以创建一个只含有空<literal>process()</literal>的简单servlet了。 + </para> + + <para> + Tomcat现在通过JNDI的方式：<literal>java:comp/env/jdbc/quickstart</literal>来提供连接。如果你在配置连接池遇到问题，请查阅Tomcat文档。如果你遇到了JDBC驱动所报的exception出错信息，请在没有Hibernate的环境下，先测试JDBC连接池本身是否配置正确。Tomcat和JDBC的配置教程可以在Web上查到。 + </para> + + <para> + 下一步就是配置Hibernate。首先Hibernate必须知道它如何获得JDBC连接，在这里我们使用基于XML格式的Hibernate配置文件。当然使用properties文件的进行配置，但缺少一些XML语法的特性。这个XML配置文件必须放在上下文类路径(<literal>WEB-INF/classes</literal>)下面，命名为<literal>hibernate.cfg.xml</literal>: + </para> + + <programlisting><![CDATA[<?xml version='1.0' encoding='utf-8'?> +<!DOCTYPE hibernate-configuration + PUBLIC "-//Hibernate/Hibernate Configuration DTD//EN" + "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"> + +<hibernate-configuration> + + <session-factory> + + <property name="connection.datasource">java:comp/env/jdbc/quickstart</property> + <property name="show_sql">false</property> + <property name="dialect">org.hibernate.dialect.PostgreSQLDialect</property> + + <!-- Mapping files --> + <mapping resource="Cat.hbm.xml"/> + + </session-factory> + +</hibernate-configuration>]]></programlisting> + + <para> + 在这里我们关闭了SQL命令的log，同时告诉Hibernate使用哪种SQL数据库用语(Dialet)，以及如何得到JDBC连接（通过Tomcat声明绑定的JNDI地址）。Dialet是必需配置的，因为不同的数据库都和"SQL标准"有一些出入。不用担心，Hibernate会替你处理这些差异，Hibernate支持所有主流的商业和开放源代码数据库。 + </para> + + <para> + <literal>SessionFactory</literal>是Hibernate的一个概念，表示对应一个数据存储源。通过创建多个XML配置文件并在你的程序中创建多个<literal>Configuration</literal>和<literal>SessionFactory</literal>对象，就可以支持多个数据库了。 + </para> + + <para> + 在<literal>hibernate.cfg.xml</literal>中的最后一个元素声明了<literal>Cat.hbm.xml</literal>，这是一个Hibernate XML映射文件，对应于持久化类<literal>Cat</literal>。这个文件包含了把<literal>Cat</literal> POJO类映射到数据库表（或多个数据库表）的元数据。我们稍后就回来看这个文件。下一步让我们先编写这个POJO类，然后在声明它的映射元数据。 + </para> + + </sect1> + + <sect1 id="quickstart-persistentclass" revision="1"> + <title>第一个持久化类</title> + + <para> + Hibernate使用简单的Java对象(Plain Old Java Objects ,就是POJOs,有时候也称作Plain Ordinary Java Objects）这种编程模型来进行持久化。一个POJO很像JavaBean,通过getter和setter方法访问其属性，对外则隐藏了内部实现的细节(假若需要的话,Hibernate也可以直接访问其属性字段)。 + </para> + + <programlisting><![CDATA[package org.hibernate.examples.quickstart; + +public class Cat { + + private String id; + private String name; + private char sex; + private float weight; + + public Cat() { + } + + public String getId() { + return id; + } + + private void setId(String id) { + this.id = id; + } + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public char getSex() { + return sex; + } + + public void setSex(char sex) { + this.sex = sex; + } + + public float getWeight() { + return weight; + } + + public void setWeight(float weight) { + this.weight = weight; + } + +}]]></programlisting> + + <para> + Hibernate对属性使用的类型不加任何限制。所有的Java JDK类型和原始类型（比如<literal>String</literal>,<literal>char</literal>和<literal>Date</literal>)都可以被映射，也包括Java 集合（Java collections framework)中的类。你可以把它们映射成为值，值集合，或者与其他实体类相关联。<literal>id</literal>是一个特殊的属性，代表了这个类的数据库标识符(主键)，对于类似于<literal>Cat</literal>这样的实体类我们强烈建议使用。Hibernate也可以使用内部标识符，但这样我们会失去一些程序架构方面的灵活性。 + </para> + + <para> + 持久化类不需要实现什么特别的接口，也不需要从一个特别的持久化根类继承下来。Hibernate也不需要使用任何编译期处理，比如字节码增强操作，它独立的使用Java反射机制和运行时类增强（通过CGLIB）。所以不依赖于Hibernate，我们就可以把POJO的类映射成为数据库表。 + </para> + + </sect1> + + <sect1 id="quickstart-mapping" revision="1"> + <title>映射cat</title> + + <para> + <literal>Cat.hbm.xml</literal>映射文件包含了对象/关系映射（O/R Mapping）所需的元数据。元数据包含持久化类的声明和属性到数据库的映射（指向字段和其他实体的外键关联）。 + </para> + + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping + PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping> + + <class name="org.hibernate.examples.quickstart.Cat" table="CAT"> + + <!-- A 32 hex character is our surrogate key. It's automatically + generated by Hibernate with the UUID pattern. --> + <id name="id" type="string" unsaved-value="null" > + <column name="CAT_ID" sql-type="char(32)" not-null="true"/> + <generator class="uuid.hex"/> + </id> + + <!-- A cat has to have a name, but it shouldn' be too long. --> + <property name="name"> + <column name="NAME" length="16" not-null="true"/> + </property> + + <property name="sex"/> + + <property name="weight"/> + + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + 每个持久化类都应该有一个标识属性（实际上，这个类只代表实体，而不是独立的值类型类，后者会被映射称为实体对象中的一个组件）。这个属性用来区分持久化对象：如果<literal>catA.getId().equals(catB.getId())</literal>结果是true的话，这两个Cat就是相同的。这个概念称为<emphasis>数据库标识</emphasis>。Hiernate附带了几种不同的标识符生成器，用于不同的场合（包括数据库本地的顺序(sequence)生成器、hi/lo高低位标识模式、和程序自己定义的标识符）。我们在这里使用UUID生成器（只在测试时建议使用，如果使用数据库自己生成的整数类型的键值更好），并指定<literal>CAT</literal>表中的<literal>CAT_ID</literal>字段（作为表的主键）存放生成的标识值。 + </para> + + <para> + <literal>Cat</literal>的其他属性都映射到同一个表的字段。对<literal>name</literal>属性来说，我们把它显式地声明映射到一个数据库字段。如果数据库schema是通过由映射声明使用Hibernate的<emphasis>SchemaExport</emphasis>工具自动生成的（作为SQL DDL指令）的话，这就特别有用。所有其它的属性都用Hibernate的默认值映射，大多数情况你都会这样做。数据库中的<literal>CAT</literal>表看起来是这样的： + </para> + + <programlisting><![CDATA[ Column | Type | Modifiers +--------+-----------------------+----------- + cat_id | character(32) | not null + name | character varying(16) | not null + sex | character(1) | + weight | real | +Indexes: cat_pkey primary key btree (cat_id)]]></programlisting> + + <para> + 你现在可以在你的数据库中手工创建这个表了，如果你需要使用<literal>hbm2ddl</literal>工具把这个步骤自动化，请参阅<xref linkend="toolsetguide"/>。这个工具能够创建完整的SQL DDL，包括表定义，自定义的字段类型约束，惟一约束和索引。 + </para> + + </sect1> + + <sect1 id="quickstart-playingwithcats" revision="2"> + <title>与Cat同乐</title> + + <para> + 我们现在可以开始Hibernate的<literal>Session</literal>了。它是一个<emphasis>持久化管理器</emphasis>，我们通过它来从数据库中存取<literal>Cat</literal>。首先，我们要从<literal>SessionFactory</literal>中获取一个<literal>Session</literal>（Hibernate的工作单元）。 + </para> + + <programlisting><![CDATA[SessionFactory sessionFactory = + new Configuration().configure().buildSessionFactory();]]></programlisting> + + <para> + 通过对<literal>configure()</literal>的调用来装载<literal>hibernate.cfg.xml</literal>配置文件,并初始化这个<literal>Configuration</literal>实例。 + 在创建 <literal>SessionFactory</literal><emphasis>之前</emphasis>（它是不可变的），你可以访问<literal>Configuration</literal>来设置其他属性（甚至修改映射的元数据）。我们应该在哪儿创建<literal>SessionFactory</literal>，在我们的程序中又如何访问它呢？ + <literal>SessionFactory</literal>通常只是被初始化一次，比如说通过一个<emphasis>load-on-startup</emphasis> servlet的来初始化。这意味着你不应该在serlvet中把它作为一个实例变量来持有，而应该放在其他地方。进一步的说，我们需要使用<emphasis>单例（Singleton）</emphasis>模式，我们才能更容易的在程序中访问<literal>SessionFactory</literal>。下面的方法就同时解决了两个问题：对<literal>SessionFactory</literal>的初始配置与便捷使用。 + </para> + + <para> + 我们实现一个<literal>HibernateUtil</literal>辅助类： + </para> + + + <programlisting><![CDATA[import org.hibernate.*; +import org.hibernate.cfg.*; + +public class HibernateUtil { + + private static Logger log = LoggerFactory.getLogger(HibernateUtil.class); + + private static final SessionFactory sessionFactory; + + static { + try { + // Create the SessionFactory + sessionFactory = new Configuration().configure().buildSessionFactory(); + } catch (Throwable ex) { + // Make sure you log the exception, as it might be swallowed + log.error("Initial SessionFactory creation failed.", ex); + throw new ExceptionInInitializerError(ex); + } + } + + public static final ThreadLocal session = new ThreadLocal(); + + public static Session currentSession() { + Session s = (Session) session.get(); + // Open a new Session, if this Thread has none yet + if (s == null) { + s = sessionFactory.openSession(); + session.set(s); + } + return s; + } + + public static void closeSession() { + Session s = (Session) session.get(); + if (s != null) + s.close(); + session.set(null); + } +}]]></programlisting> + + <para> + 这个类不但在它的静态初始器中使用了<literal>SessionFactory</literal>，还使用了一个<literal>ThreadLocal</literal>变量来保存<literal>Session</literal>做为当前工作线程。在你使用这个辅助类之前，请确保你理解了thread-local变量这个Java概念。你可以在<literal>CaveatEmptor</literal>(http://caveatemptor.hibernate.org/)上找到一个更加复杂和强大的 <literal>HibernateUtil</literal>。 + </para> + + <para> + <literal>SessionFactory</literal>是安全线程，可以由很多线程并发访问并获取到<literal>Sessions</literal>。单个<literal>Session</literal>不是安全线程对象，它只代表与数据库之间的一次操作。<literal>Session</literal>通过<literal>SessionFactory</literal>获得并在所有的工作完成后关闭。在你servlet的<literal>process()</literal>中可以象是这么写的(省略了异常情况处理): + </para> + + <programlisting><![CDATA[Session session = HibernateUtil.currentSession(); + +Transaction tx= session.beginTransaction(); + +Cat princess = new Cat(); +princess.setName("Princess"); +princess.setSex('F'); +princess.setWeight(7.4f); + +session.save(princess); +tx.commit(); + +HibernateUtil.closeSession();]]></programlisting> + + <para> + 在一个<literal>Session</literal>中，每个数据库操作都是在一个事务(transaction)中进行的，这样就可以隔离开不同的操作（甚至包括只读操作）。我们使用Hibernate的<literal>Transaction</literal> API来从底层的事务策略中（本例中是JDBC事务）脱身出来。这样，我们就不需要更改任何源代码，就可以把我们的程序部署到一个由容器管理事务的环境中去（使用JTA）。 + + </para> + + <para> + 这样你就可以随心所欲的多次调用<literal>HibernateUtil.currentSession();</literal>，你每次都会得到同一个当前线程的<literal>Session</literal>。不管是在你的servlet代码中，或者在servlet filter中还是在HTTP结果返回之前，你都必须确保这个<literal>Session</literal>在你的数据库访问工作完成后关闭。这样做还有一个好处就是可以容易的使用延迟装载（lazy initialization）：<literal>Session</literal>在渲染view层的时候仍然打开着的，所以你在遍历当前对象图的时候可以装载所需的对象。 + </para> + + <para> + Hibernate有不同的方法用来从数据库中取回对象。最灵活的方式就是使用Hibernate查询语言(HQL),这是一种容易学习的语言，是对SQL的面向对象的强大扩展。 + </para> + + <programlisting><![CDATA[Transaction tx= session.beginTransaction(); + +Query query = session.createQuery("select c from Cat as c where c.sex = :sex"); +query.setCharacter("sex", 'F'); +for (Iterator it = query.iterate(); it.hasNext();) { + Cat cat = (Cat) it.next(); + out.println("Female Cat: " + cat.getName() ); +} + +tx.commit();]]></programlisting> + + <para> + Hibernate也提供一种面向对象的<emphasis>按条件查询</emphasis>API，可以执行简洁安全类型的查询。当然，Hibernate在所有与数据库的交互中都使用<literal>PrepatedStatement</literal>和参数绑定。你也可以使用Hibernate的直接SQL查询特性，或者在特殊情况下从<literal>Session</literal>获取一个原始的JDBC连接。 + </para> + + </sect1> + + <sect1 id="quickstart-summary" revision="1"> + <title>结语</title> + + <para> + 在这个短小的教程中，我们对Hibernate浅尝即止。请注意我们没有在例子中包含任何servlet相关代码。你必须自行编写servlet，并插入适合你的Hibernate代码。 + </para> + + <para> + 请记住Hibernate作为一个数据库访问层，是与你的程序紧密相关的。通常情况下，所有其他层次都依赖持久机制。请确信你理解了这种设计的内涵。 + </para> + + <para> + 若希望学习更复杂的例子,请参阅http://caveatemptor.hibernate.org/ 。在 http://www.hibernate.org/Documentation 也可以得到其他教程的链接。 + + </para> + + </sect1> + +</chapter> \ No newline at end of file Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/session_api.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/session_api.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/session_api.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/session_api.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,1117 @@ +<chapter id="objectstate"> + + <title>与对象共事</title> + + <para> + Hibernate是完整的对象/关系映射解决方案，它提供了对象<emphasis>状态管理(state management)</emphasis>的功能，使开发者不再需要理会底层数据库系统的细节。 + 也就是说，相对于常见的JDBC/SQL持久层方案中需要<literal>管理SQL语句</literal>，Hibernate采用了更自然的面向对象的视角来持久化Java应用中的数据。 + </para> + + + <para> + 换句话说，使用Hibernate的开发者应该总是关注对象的<emphasis>状态(state)</emphasis>，不必考虑SQL语句的执行。 + 这部分细节已经由Hibernate掌管妥当，只有开发者在进行系统性能调优的时候才需要进行了解。 + </para> + + <sect1 id="objectstate-overview"> + + <title>Hibernate对象状态(object states)</title> + + + <para> + Hibernate定义并支持下列对象状态(state): + </para> + + <itemizedlist> + <listitem> + + <para> + <emphasis>瞬时(Transient)</emphasis> - 由<literal>new</literal>操作符创建，且尚未与Hibernate <literal>Session</literal> + 关联的对象被认定为瞬时(Transient)的。瞬时(Transient)对象不会被持久化到数据库中，也不会被赋予持久化标识(identifier)。 + 如果瞬时(Transient)对象在程序中没有被引用，它会被垃圾回收器(garbage collector)销毁。 + 使用Hibernate <literal>Session</literal>可以将其变为持久(Persistent)状态。(Hibernate会自动执行必要的SQL语句) + </para> + + </listitem> + <listitem> + + <para> + <emphasis>持久(Persistent)</emphasis> - 持久(Persistent)的实例在数据库中有对应的记录，并拥有一个持久化标识(identifier)。 + 持久(Persistent)的实例可能是刚被保存的，或刚被加载的，无论哪一种，按定义，它存在于相关联的<literal>Session</literal>作用范围内。 + Hibernate会检测到处于持久(Persistent)状态的对象的任何改动，在当前操作单元(unit of work)执行完毕时将对象数据(state)与数据库同步(synchronize)。 + 开发者不需要手动执行<literal>UPDATE</literal>。将对象从持久(Persistent)状态变成瞬时(Transient)状态同样也不需要手动执行<literal>DELETE</literal>语句。 + </para> + </listitem> + <listitem> + <para> + <emphasis>脱管(Detached)</emphasis> - 与持久(Persistent)对象关联的<literal>Session</literal>被关闭后，对象就变为脱管(Detached)的。 + 对脱管(Detached)对象的引用依然有效，对象可继续被修改。脱管(Detached)对象如果重新关联到某个新的<literal>Session</literal>上， + 会再次转变为持久(Persistent)的(在Detached其间的改动将被持久化到数据库)。 + 这个功能使得一种编程模型，即中间会给用户思考时间(user think-time)的长时间运行的操作单元(unit of work)的编程模型成为可能。 + 我们称之为<emphasis>应用程序事务</emphasis>，即从用户观点看是一个操作单元(unit of work)。 + </para> + + </listitem> + </itemizedlist> + + <para> + 接下来我们来细致的讨论下状态(states)及状态间的转换(state transitions)（以及触发状态转换的Hibernate方法）。 + </para> + + </sect1> + + <sect1 id="objectstate-makingpersistent" revision="1"> + <title>使对象持久化</title> + + <para> + Hibernate认为持久化类(persistent class)新实例化的对象是<emphasis>瞬时(Transient)</emphasis>的。 + 我们可通过将瞬时(Transient)对象与session关联而把它变为<emphasis>持久(Persistent)</emphasis>的。 + </para> + + <programlisting><![CDATA[DomesticCat fritz = new DomesticCat(); +fritz.setColor(Color.GINGER); +fritz.setSex('M'); +fritz.setName("Fritz"); +Long generatedId = (Long) sess.save(fritz);]]></programlisting> + + <para> + 如果<literal>Cat</literal>的持久化标识(identifier)是<literal>generated</literal>类型的， + 那么该标识(identifier)会自动在<literal>save()</literal>被调用时产生并分配给<literal>cat</literal>。 + 如果<literal>Cat</literal>的持久化标识(identifier)是<literal>assigned</literal>类型的，或是一个复合主键(composite key)， + 那么该标识(identifier)应当在调用<literal>save()</literal>之前手动赋予给<literal>cat</literal>。 + 你也可以按照EJB3 early draft中定义的语义，使用<literal>persist()</literal>替代<literal>save()</literal>。 + </para> + + + <para> + 此外，你可以用一个重载版本的<literal>save()</literal>方法。 + </para> + +<programlisting><![CDATA[DomesticCat pk = new DomesticCat(); +pk.setColor(Color.TABBY); +pk.setSex('F'); +pk.setName("PK"); +pk.setKittens( new HashSet() ); +pk.addKitten(fritz); +sess.save( pk, new Long(1234) );]]></programlisting> + + + <para> + 如果你持久化的对象有关联的对象(associated objects)（例如上例中的<literal>kittens</literal>集合） + 那么对这些对象（译注：pk和kittens）进行持久化的顺序是任意的（也就是说可以先对kittens进行持久化也可以先对pk进行持久化）， + 除非你在外键列上有<literal>NOT NULL</literal>约束。 + Hibernate不会违反外键约束，但是如果你用错误的顺序持久化对象（译注：在pk持久化之前持久化kitten），那么可能会违反<literal>NOT NULL</literal>约束。 + </para> + + <para> + 通常你不会为这些细节烦心，因为你很可能会使用Hibernate的 + <emphasis>传播性持久化(transitive persistence)</emphasis>功能自动保存相关联那些对象。 + 这样连违反<literal>NOT NULL</literal>约束的情况都不会出现了 - Hibernate会管好所有的事情。 + 传播性持久化(transitive persistence)将在本章稍后讨论。 + </para> + + </sect1> + + <sect1 id="objectstate-loading"> + <title>装载对象</title> + <para> + 如果你知道某个实例的持久化标识(identifier)，你就可以使用<literal>Session</literal>的<literal>load()</literal>方法 + 来获取它。 <literal>load()</literal>的另一个参数是指定类的.class对象。 + 本方法会创建指定类的持久化实例，并从数据库加载其数据(state)。 + </para> + + <programlisting><![CDATA[Cat fritz = (Cat) sess.load(Cat.class, generatedId);]]></programlisting> + +<programlisting><![CDATA[// you need to wrap primitive identifiers +long id = 1234; +DomesticCat pk = (DomesticCat) sess.load( DomesticCat.class, new Long(id) );]]></programlisting> + + <para> + 此外, 你可以把数据(state)加载到指定的对象实例上（覆盖掉该实例原来的数据）。 + </para> + +<programlisting><![CDATA[Cat cat = new DomesticCat(); +// load pk's state into cat +sess.load( cat, new Long(pkId) ); +Set kittens = cat.getKittens();]]></programlisting> + + + <para> + 请注意如果没有匹配的数据库记录，<literal>load()</literal>方法可能抛出无法恢复的异常(unrecoverable exception)。 + 如果类的映射使用了代理(proxy)，<literal>load()</literal>方法会返回一个未初始化的代理，直到你调用该代理的某方法时才会去访问数据库。 + 若你希望在某对象中创建一个指向另一个对象的关联，又不想在从数据库中装载该对象时同时装载相关联的那个对象，那么这种操作方式就用得上的了。 + 如果为相应类映射关系设置了<literal>batch-size</literal>， + 那么使用这种操作方式允许多个对象被一批装载（因为返回的是代理，无需从数据库中抓取所有对象的数据）。 + </para> + + + <para> + 如果你不确定是否有匹配的行存在，应该使用<literal>get()</literal>方法，它会立刻访问数据库，如果没有对应的记录，会返回null。 + </para> + + <programlisting><![CDATA[Cat cat = (Cat) sess.get(Cat.class, id); +if (cat==null) { + cat = new Cat(); + sess.save(cat, id); +} +return cat;]]></programlisting> + + <para> + 你甚至可以选用某个<literal>LockMode</literal>，用SQL的<literal>SELECT ... FOR UPDATE</literal>装载对象。 + 请查阅API文档以获取更多信息。 + </para> + + <programlisting><![CDATA[Cat cat = (Cat) sess.get(Cat.class, id, LockMode.UPGRADE);]]></programlisting> + + + <para> + 注意，任何关联的对象或者包含的集合都<emphasis>不会</emphasis>被以<literal>FOR UPDATE</literal>方式返回， + 除非你指定了<literal>lock</literal>或者<literal>all</literal>作为关联(association)的级联风格(cascade style)。 + </para> + + + <para> + 任何时候都可以使用<literal>refresh()</literal>方法强迫装载对象和它的集合。如果你使用数据库触发器功能来处理对象的某些属性，这个方法就很有用了。 + </para> + + <programlisting><![CDATA[sess.save(cat); +sess.flush(); //force the SQL INSERT +sess.refresh(cat); //re-read the state (after the trigger executes)]]></programlisting> + + + <para> + 此处通常会出现一个重要问题: Hibernate会从数据库中装载多少东西？会执行多少条相应的SQL<literal>SELECT</literal>语句？ + 这取决于<emphasis>抓取策略(fetching strategy)</emphasis>，会在<xref linkend="performance-fetching"/>中解释。 + </para> + + </sect1> + + <sect1 id="objectstate-querying" revision="1"> + <title>查询</title> + <para> + 如果不知道所要寻找的对象的持久化标识，那么你需要使用查询。Hibernate支持强大且易于使用的面向对象查询语言(HQL)。 + 如果希望通过编程的方式创建查询，Hibernate提供了完善的按条件(Query By Criteria, QBC)以及按样例(Query By Example, QBE)进行查询的功能。 + 你也可以用原生SQL(native SQL)描述查询，Hibernate额外提供了将结果集(result set)转化为对象的支持。 + </para> + + <sect2 id="objectstate-querying-executing" revision="1"> + <title>执行查询</title> + + <para> + HQL和原生SQL(native SQL)查询要通过为<literal>org.hibernate.Query</literal>的实例来表达。 + 这个接口提供了参数绑定、结果集处理以及运行实际查询的方法。 + 你总是可以通过当前<literal>Session</literal>获取一个<literal>Query</literal>对象： + </para> + + <programlisting><![CDATA[List cats = session.createQuery( + "from Cat as cat where cat.birthdate < ?") + .setDate(0, date) + .list(); + +List mothers = session.createQuery( + "select mother from Cat as cat join cat.mother as mother where cat.name = ?") + .setString(0, name) + .list(); + +List kittens = session.createQuery( + "from Cat as cat where cat.mother = ?") + .setEntity(0, pk) + .list(); + +Cat mother = (Cat) session.createQuery( + "select cat.mother from Cat as cat where cat = ?") + .setEntity(0, izi) + .uniqueResult();]] + +Query mothersWithKittens = (Cat) session.createQuery( + "select mother from Cat as mother left join fetch mother.kittens"); +Set uniqueMothers = new HashSet(mothersWithKittens.list());]]></programlisting> + + + <para> + 一个查询通常在调用<literal>list()</literal>时被执行，执行结果会完全装载进内存中的一个集合(collection)。 + 查询返回的对象处于持久(persistent)状态。如果你知道的查询只会返回一个对象，可使用<literal>list()</literal>的快捷方式<literal>uniqueResult()</literal>。 + 注意，使用集合预先抓取的查询往往会返回多次根对象（他们的集合类都被初始化了）。你可以通过一个集合来过滤这些重复对象。 + </para> + + <sect3 id="objectstate-querying-executing-iterate"> + + <title>迭代式获取结果(Iterating results)</title> + + <para> + 某些情况下，你可以使用<literal>iterate()</literal>方法得到更好的性能。 + 这通常是你预期返回的结果在session，或二级缓存(second-level cache)中已经存在时的情况。 + 如若不然，<literal>iterate()</literal>会比<literal>list()</literal>慢，而且可能简单查询也需要进行多次数据库访问： + <literal>iterate()</literal>会首先使用<emphasis>1</emphasis>条语句得到所有对象的持久化标识(identifiers)，再根据持久化标识执行<emphasis>n</emphasis>条附加的select语句实例化实际的对象。 + </para> + + <programlisting><![CDATA[// fetch ids +Iterator iter = sess.createQuery("from eg.Qux q order by q.likeliness").iterate(); +while ( iter.hasNext() ) { + Qux qux = (Qux) iter.next(); // fetch the object + // something we couldnt express in the query + if ( qux.calculateComplicatedAlgorithm() ) { + // delete the current instance + iter.remove(); + // dont need to process the rest + break; + } +}]]></programlisting> + </sect3> + + <sect3 id="objectstate-querying-executing-tuples"> + <title>返回元组(tuples)的查询</title> + + <para> + （译注：元组(tuples)指一条结果行包含多个对象） + Hibernate查询有时返回元组(tuples)，每个元组(tuples)以数组的形式返回: + </para> + + <programlisting><![CDATA[Iterator kittensAndMothers = sess.createQuery( + "select kitten, mother from Cat kitten join kitten.mother mother") + .list() + .iterator(); + +while ( kittensAndMothers.hasNext() ) { + Object[] tuple = (Object[]) kittensAndMothers.next(); + Cat kitten = (Cat) tuple[0]; + Cat mother = (Cat) tuple[1]; + .... +}]]></programlisting> + + </sect3> + + <sect3 id="objectstate-querying-executing-scalar" revision="1"> + <title>标量(Scalar)结果</title> + + <para> + 查询可在<literal>select</literal>从句中指定类的属性，甚至可以调用SQL统计(aggregate)函数。 + 属性或统计结果被认定为"标量(Scalar)"的结果（而不是持久(persistent state)的实体）。 + </para> + + <programlisting><![CDATA[Iterator results = sess.createQuery( + "select cat.color, min(cat.birthdate), count(cat) from Cat cat " + + "group by cat.color") + .list() + .iterator(); + +while ( results.hasNext() ) { + Object[] row = (Object[]) results.next(); + Color type = (Color) row[0]; + Date oldest = (Date) row[1]; + Integer count = (Integer) row[2]; + ..... +}]]></programlisting> + + </sect3> + + <sect3 id="objectstate-querying-executing-parameters"> + <title>绑定参数</title> + + <para> + 接口<literal>Query</literal>提供了对命名参数(named parameters)、JDBC风格的<literal>问号(?)</literal>参数进行绑定的方法。 + <emphasis>不同于JDBC，Hibernate对参数从0开始计数。</emphasis> + 命名参数(named parameters)在查询字符串中是形如<literal>:name</literal>的标识符。 + 命名参数(named parameters)的优点是: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + 命名参数(named parameters)与其在查询串中出现的顺序无关 + </para> + </listitem> + <listitem> + <para> + 它们可在同一查询串中多次出现 + </para> + </listitem> + <listitem> + <para> + 它们本身是自我说明的 + </para> + </listitem> + </itemizedlist> + + <programlisting><![CDATA[//named parameter (preferred) +Query q = sess.createQuery("from DomesticCat cat where cat.name = :name"); +q.setString("name", "Fritz"); +Iterator cats = q.iterate();]]></programlisting> + + <programlisting><![CDATA[//positional parameter +Query q = sess.createQuery("from DomesticCat cat where cat.name = ?"); +q.setString(0, "Izi"); +Iterator cats = q.iterate();]]></programlisting> + + <programlisting><![CDATA[//named parameter list +List names = new ArrayList(); +names.add("Izi"); +names.add("Fritz"); +Query q = sess.createQuery("from DomesticCat cat where cat.name in (:namesList)"); +q.setParameterList("namesList", names); +List cats = q.list();]]></programlisting> + + </sect3> + + <sect3 id="objectstate-querying-executing-pagination"> + <title>分页</title> + + <para> + 如果你需要指定结果集的范围（希望返回的最大行数/或开始的行数），应该使用<literal>Query</literal>接口提供的方法: + </para> + + <programlisting><![CDATA[Query q = sess.createQuery("from DomesticCat cat"); +q.setFirstResult(20); +q.setMaxResults(10); +List cats = q.list();]]></programlisting> + + <para> + Hibernate 知道如何将这个有限定条件的查询转换成你的数据库的原生SQL(native SQL)。 + </para> + + </sect3> + + <sect3 id="objectstate-querying-executing-scrolling"> + <title>可滚动遍历(Scrollable iteration)</title> + + + <para> + 如果你的JDBC驱动支持可滚动的<literal>ResuleSet</literal>，<literal>Query</literal>接口可以使用<literal>ScrollableResults</literal>，允许你在查询结果中灵活游走。 + </para> + + <programlisting><![CDATA[Query q = sess.createQuery("select cat.name, cat from DomesticCat cat " + + "order by cat.name"); +ScrollableResults cats = q.scroll(); +if ( cats.first() ) { + + // find the first name on each page of an alphabetical list of cats by name + firstNamesOfPages = new ArrayList(); + do { + String name = cats.getString(0); + firstNamesOfPages.add(name); + } + while ( cats.scroll(PAGE_SIZE) ); + + // Now get the first page of cats + pageOfCats = new ArrayList(); + cats.beforeFirst(); + int i=0; + while( ( PAGE_SIZE > i++ ) && cats.next() ) pageOfCats.add( cats.get(1) ); + +} +cats.close()]]></programlisting> + + <para> + 请注意，使用此功能需要保持数据库连接（以及游标(cursor)）处于一直打开状态。 + 如果你需要断开连接使用分页功能，请使用<literal>setMaxResult()</literal>/<literal>setFirstResult()</literal> + </para> + + </sect3> + + <sect3 id="objectstate-querying-executing-named" revision="1"> + <title>外置命名查询(Externalizing named queries)</title> + + <para> + 你可以在映射文件中定义命名查询(named queries)。 + （如果你的查询串中包含可能被解释为XML标记(markup)的字符，别忘了用<literal>CDATA</literal>包裹起来。） + </para> + + <programlisting><![CDATA[<query name="ByNameAndMaximumWeight"><![CDATA[ + from eg.DomesticCat as cat + where cat.name = ? + and cat.weight > ? +] ]></query>]]></programlisting> + + + <para> + 参数绑定及执行以编程方式(programatically)完成： + </para> + + <programlisting><![CDATA[Query q = sess.getNamedQuery("ByNameAndMaximumWeight"); +q.setString(0, name); +q.setInt(1, minWeight); +List cats = q.list();]]></programlisting> + + + <para> + 请注意实际的程序代码与所用的查询语言无关，你也可在元数据中定义原生SQL(native SQL)查询， + 或将原有的其他的查询语句放在配置文件中，这样就可以让Hibernate统一管理，达到迁移的目的。 + </para> + + <para> + + 也请注意在<literal>&lt;hibernate-mapping&gt;</literal>元素中声明的查询必须有一个全局唯一的名字,而在<literal>&lt;class&gt;</literal>元素中声明的查询自动具有全局名,是通过类的全名加以限定的。比如<literal>eg.Cat.ByNameAndMaximumWeight</literal>。 + </para> + + </sect3> + + </sect2> + + <sect2 id="objectstate-filtering" revision="1"> + <title>过滤集合</title> + + + <para> + 集合<emphasis>过滤器(filter)</emphasis>是一种用于一个持久化集合或者数组的特殊的查询。查询字符串中可以使用<literal>"this"</literal>来引用集合中的当前元素。 + </para> + + <programlisting><![CDATA[Collection blackKittens = session.createFilter( + pk.getKittens(), + "where this.color = ?") + .setParameter( Color.BLACK, Hibernate.custom(ColorUserType.class) ) + .list() +);]]></programlisting> + + + <para> + 返回的集合可以被认为是一个包(bag, 无顺序可重复的集合(collection))，它是所给集合的副本。 + 原来的集合不会被改动（这与“过滤器(filter)”的隐含的含义不符，不过与我们期待的行为一致）。 + </para> + + <para> + 请注意过滤器(filter)并不需要<literal>from</literal>子句（当然需要的话它们也可以加上）。过滤器(filter)不限定于只能返回集合元素本身。 + </para> + + <programlisting><![CDATA[Collection blackKittenMates = session.createFilter( + pk.getKittens(), + "select this.mate where this.color = eg.Color.BLACK.intValue") + .list();]]></programlisting> + + <para> + 即使无条件的过滤器(filter)也是有意义的。例如，用于加载一个大集合的子集： + </para> + + <programlisting><![CDATA[Collection tenKittens = session.createFilter( + mother.getKittens(), "") + .setFirstResult(0).setMaxResults(10) + .list();]]></programlisting> + + </sect2> + + <sect2 id="objecstate-querying-criteria" revision="1"> + <title>条件查询(Criteria queries)</title> + + <para> + HQL极为强大，但是有些人希望能够动态的使用一种面向对象API创建查询，而非在他们的Java代码中嵌入字符串。对于那部分人来说，Hibernate提供了直观的<literal>Criteria</literal>查询API。 + </para> + + <programlisting><![CDATA[Criteria crit = session.createCriteria(Cat.class); +crit.add( Restrictions.eq( "color", eg.Color.BLACK ) ); +crit.setMaxResults(10); +List cats = crit.list();]]></programlisting> + + + <para> + <literal>Criteria</literal>以及相关的<literal>样例(Example)</literal>API将会再<xref linkend="querycriteria"/>中详细讨论。 + </para> + + </sect2> + + <sect2 id="objectstate-querying-nativesql" revision="2"> + <title>使用原生SQL的查询</title> + + + <para> + 你可以使用<literal>createSQLQuery()</literal>方法，用SQL来描述查询，并由Hibernate将结果集转换成对象。 + 请注意，你可以在任何时候调用<literal>session.connection()</literal>来获得并使用JDBC <literal>Connection</literal>对象。 + 如果你选择使用Hibernate的API, 你必须把SQL别名用大括号包围起来: + </para> + + <programlisting><![CDATA[List cats = session.createSQLQuery("SELECT {cat.*} FROM CAT {cat} WHERE ROWNUM<10") + .addEntity("cat", Cat.class) +.list();]]></programlisting> + + <programlisting><![CDATA[List cats = session.createSQLQuery( + "SELECT {cat}.ID AS {cat.id}, {cat}.SEX AS {cat.sex}, " + + "{cat}.MATE AS {cat.mate}, {cat}.SUBCLASS AS {cat.class}, ... " + + "FROM CAT {cat} WHERE ROWNUM<10") + .addEntity("cat", Cat.class) +.list()]]></programlisting> + + <para> + 和Hibernate查询一样，SQL查询也可以包含命名参数和占位参数。 + 可以在<xref linkend="querysql"/>找到更多关于Hibernate中原生SQL(native SQL)的信息。 + </para> + + </sect2> + + </sect1> + + <sect1 id="objectstate-modifying" revision="1"> + <title>修改持久对象</title> + + <para> + <emphasis>事务中的持久实例</emphasis>（就是通过<literal>session</literal>装载、保存、创建或者查询出的对象） + 被应用程序操作所造成的任何修改都会在<literal>Session</literal>被<emphasis>刷出（flushed）</emphasis>的时候被持久化（本章后面会详细讨论）。 + 这里不需要调用某个特定的方法（比如<literal>update()</literal>，设计它的目的是不同的）将你的修改持久化。 + 所以最直接的更新一个对象的方法就是在<literal>Session</literal>处于打开状态时<literal>load()</literal>它，然后直接修改即可： + </para> + + <programlisting><![CDATA[DomesticCat cat = (DomesticCat) sess.load( Cat.class, new Long(69) ); +cat.setName("PK"); +sess.flush(); // changes to cat are automatically detected and persisted]]></programlisting> + + <para> + 有时这种程序模型效率低下，因为它在同一Session里需要一条SQL <literal>SELECT</literal>语句（用于加载对象） + 以及一条SQL <literal>UPDATE</literal>语句(持久化更新的状态)。 + 为此Hibernate提供了另一种途径，使用脱管(detached)实例。 + </para> + + + <para> + <emphasis>请注意Hibernate本身不提供直接执行<literal>UPDATE</literal>或<literal>DELETE</literal>语句的API。 + Hibernate提供的是<emphasis>状态管理(state management)</emphasis>服务，你不必考虑要使用的<emphasis>语句(statements)</emphasis>。 + JDBC是出色的执行SQL语句的API，任何时候调用<literal>session.connection()</literal>你都可以得到一个JDBC <literal>Connection</literal>对象。 + 此外，在联机事务处理(OLTP)程序中，大量操作(mass operations)与对象/关系映射的观点是相冲突的。 + Hibernate的将来版本可能会提供专门的进行大量操作(mass operation)的功能。 + 参考<xref linkend="batch"/>，寻找一些可用的批量(batch)操作技巧。</emphasis> + </para> + + </sect1> + + <sect1 id="objectstate-detached" revision="2"> + <title>修改脱管(Detached)对象</title> + + <para> + 很多程序需要在某个事务中获取对象，然后将对象发送到界面层去操作，最后在一个新的事务保存所做的修改。 + 在高并发访问的环境中使用这种方式，通常使用附带版本信息的数据来保证这些“长“工作单元之间的隔离。 + </para> + + <para> + Hibernate通过提供<literal>Session.update()</literal>或<literal>Session.merge()</literal> + 重新关联脱管实例的办法来支持这种模型。 + </para> + + + <programlisting><![CDATA[// in the first session +Cat cat = (Cat) firstSession.load(Cat.class, catId); +Cat potentialMate = new Cat(); +firstSession.save(potentialMate); + +// in a higher layer of the application +cat.setMate(potentialMate); + +// later, in a new session +secondSession.update(cat); // update cat +secondSession.update(mate); // update mate]]></programlisting> + + <para> + 如果具有<literal>catId</literal>持久化标识的<literal>Cat</literal>之前已经被<literal>另一Session(secondSession)</literal>装载了， + 应用程序进行重关联操作(reattach)的时候会抛出一个异常。 + </para> + + + <para> + 如果你确定当前session没有包含与之具有相同持久化标识的持久实例，使用<literal>update()</literal>。 + 如果想随时合并你的的改动而不考虑session的状态，使用<literal>merge()</literal>。 + 换句话说，在一个新session中通常第一个调用的是<literal>update()</literal>方法，以便保证重新关联脱管(detached)对象的操作首先被执行。 + </para> + + + <para> + 如果希望相关联的脱管对象（通过引用“可到达”的脱管对象）的数据也要更新到数据库时（并且也<emphasis>仅仅</emphasis>在这种情况）， + 可以对该相关联的脱管对象单独调用<literal>update()</literal> + 当然这些可以自动完成，即通过使用<emphasis>传播性持久化(transitive persistence)</emphasis>，请看<xref linkend="objectstate-transitive"/>。 + </para> + + + <para> + <literal>lock()</literal>方法也允许程序重新关联某个对象到一个新session上。不过，该脱管(detached)的对象必须是没有修改过的！ + </para> + + <programlisting><![CDATA[//just reassociate: +sess.lock(fritz, LockMode.NONE); +//do a version check, then reassociate: +sess.lock(izi, LockMode.READ); +//do a version check, using SELECT ... FOR UPDATE, then reassociate: +sess.lock(pk, LockMode.UPGRADE);]]></programlisting> + + + <para> + 请注意，<literal>lock()</literal>可以搭配多种<literal>LockMode</literal>， + 更多信息请阅读API文档以及关于事务处理(transaction handling)的章节。重新关联不是<literal>lock()</literal>的唯一用途。 + </para> + + + <para> + 其他用于长时间工作单元的模型会在<xref linkend="transactions-optimistic"/>中讨论。 + </para> + + </sect1> + + <sect1 id="objectstate-saveorupdate"> + <title>自动状态检测</title> + + + <para> + Hibernate的用户曾要求一个既可自动分配新持久化标识(identifier)保存瞬时(transient)对象，又可更新/重新关联脱管(detached)实例的通用方法。 + <literal>saveOrUpdate()</literal>方法实现了这个功能。 + </para> + + <programlisting><![CDATA[// in the first session +Cat cat = (Cat) firstSession.load(Cat.class, catID); + +// in a higher tier of the application +Cat mate = new Cat(); +cat.setMate(mate); + +// later, in a new session +secondSession.saveOrUpdate(cat); // update existing state (cat has a non-null id) +secondSession.saveOrUpdate(mate); // save the new instance (mate has a null id)]]></programlisting> + + + <para> + <literal>saveOrUpdate()</literal>用途和语义可能会使新用户感到迷惑。 + 首先，只要你没有尝试在某个session中使用来自另一session的实例，你就应该不需要使用<literal>update()</literal>， + <literal>saveOrUpdate()</literal>，或<literal>merge()</literal>。有些程序从来不用这些方法。 + </para> + + + <para> + 通常下面的场景会使用<literal>update()</literal>或<literal>saveOrUpdate()</literal>： + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + 程序在第一个session中加载对象 + </para> + </listitem> + <listitem> + <para> + 该对象被传递到表现层 + </para> + </listitem> + <listitem> + <para> + 对象发生了一些改动 + </para> + </listitem> + <listitem> + <para> + 该对象被返回到业务逻辑层 + </para> + </listitem> + <listitem> + <para> + 程序调用第二个session的<literal>update()</literal>方法持久这些改动 + </para> + </listitem> + </itemizedlist> + + <para> + <literal>saveOrUpdate()</literal>做下面的事: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + 如果对象已经在本session中持久化了，不做任何事 + </para> + </listitem> + <listitem> + <para> + 如果另一个与本session关联的对象拥有相同的持久化标识(identifier)，抛出一个异常 + </para> + </listitem> + <listitem> + <para> + 如果对象没有持久化标识(identifier)属性，对其调用<literal>save()</literal> + </para> + </listitem> + <listitem> + <para> + 如果对象的持久标识(identifier)表明其是一个新实例化的对象，对其调用<literal>save()</literal> + </para> + </listitem> + <listitem> + <para> + 如果对象是附带版本信息的（通过<literal>&lt;version&gt;</literal>或<literal>&lt;timestamp&gt;</literal>） + 并且版本属性的值表明其是一个新实例化的对象，<literal>save()</literal>它。 + </para> + </listitem> + <listitem> + <para> + 否则<literal>update()</literal> 这个对象 + </para> + </listitem> + </itemizedlist> + + + <para> + <literal>merge()</literal>可非常不同: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + 如果session中存在相同持久化标识(identifier)的实例，用用户给出的对象的状态覆盖旧有的持久实例 + </para> + </listitem> + <listitem> + <para> + 如果session没有相应的持久实例，则尝试从数据库中加载，或创建新的持久化实例 + </para> + </listitem> + <listitem> + <para> + 最后返回该持久实例 + </para> + </listitem> + <listitem> + <para> + 用户给出的这个对象没有被关联到session上，它依旧是脱管的 + </para> + </listitem> + </itemizedlist> + + </sect1> + + <sect1 id="objectstate-deleting" revision="1"> + <title>删除持久对象</title> + + <para> + 使用<literal>Session.delete()</literal>会把对象的状态从数据库中移除。 + 当然，你的应用程序可能仍然持有一个指向已删除对象的引用。所以，最好这样理解：<literal>delete()</literal>的用途是把一个持久实例变成瞬时(transient)实例。 + </para> + + <programlisting><![CDATA[sess.delete(cat);]]></programlisting> + + + <para> + 你可以用你喜欢的任何顺序删除对象，不用担心外键约束冲突。当然，如果你搞错了顺序，还是有可能引发在外键字段定义的<literal>NOT NULL</literal>约束冲突。 + 例如你删除了父对象，但是忘记删除孩子们。 + </para> + + </sect1> + + <sect1 id="objectstate-replicating" revision="1"> + <title>在两个不同数据库间复制对象</title> + + + <para> + 偶尔会用到不重新生成持久化标识(identifier)，将持久实例以及其关联的实例持久到不同的数据库中的操作。 + </para> + + <programlisting><![CDATA[//retrieve a cat from one database +Session session1 = factory1.openSession(); +Transaction tx1 = session1.beginTransaction(); +Cat cat = session1.get(Cat.class, catId); +tx1.commit(); +session1.close(); + +//reconcile with a second database +Session session2 = factory2.openSession(); +Transaction tx2 = session2.beginTransaction(); +session2.replicate(cat, ReplicationMode.LATEST_VERSION); +tx2.commit(); +session2.close();]]></programlisting> + + + <para> + <literal>ReplicationMode</literal>决定在和数据库中已存在记录由冲突时，<literal>replicate()</literal>如何处理。 + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>ReplicationMode.IGNORE</literal> - 忽略它 + </para> + </listitem> + <listitem> + <para> + <literal>ReplicationMode.OVERWRITE</literal> - 覆盖相同的行 + </para> + </listitem> + <listitem> + <para> + <literal>ReplicationMode.EXCEPTION</literal> - 抛出异常 + </para> + </listitem> + <listitem> + <para> + <literal>ReplicationMode.LATEST_VERSION</literal> - 如果当前的版本较新，则覆盖，否则忽略 + </para> + </listitem> + </itemizedlist> + + + <para> + 这个功能的用途包括使录入的数据在不同数据库中一致，产品升级时升级系统配置信息，回滚non-ACID事务中的修改等等。 + （译注，non-ACID，非ACID;ACID，Atomic，Consistent，Isolated and Durable的缩写） + </para> + + </sect1> + + <sect1 id="objectstate-flushing"> + <title>Session刷出(flush)</title> + + + <para> + 每间隔一段时间，<literal>Session</literal>会执行一些必需的SQL语句来把内存中的对象的状态同步到JDBC连接中。这个过程被称为<emphasis>刷出(flush)</emphasis>，默认会在下面的时间点执行： + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + 在某些查询执行之前 + </para> + </listitem> + <listitem> + <para> + 在调用<literal>org.hibernate.Transaction.commit()</literal>的时候 + </para> + </listitem> + <listitem> + <para> + 在调用<literal>Session.flush()</literal>的时候 + </para> + </listitem> + </itemizedlist> + + <para> + 涉及的SQL语句会按照下面的顺序发出执行： + </para> + + <orderedlist spacing="compact"> + <listitem> + <para> + 所有对实体进行插入的语句，其顺序按照对象执行<literal>Session.save()</literal>的时间顺序 + </para> + </listitem> + <listitem> + <para> + 所有对实体进行更新的语句 + </para> + </listitem> + <listitem> + <para> + 所有进行集合删除的语句 + </para> + </listitem> + <listitem> + <para> + 所有对集合元素进行删除，更新或者插入的语句 + </para> + </listitem> + <listitem> + <para> + 所有进行集合插入的语句 + </para> + </listitem> + <listitem> + <para> + 所有对实体进行删除的语句，其顺序按照对象执行<literal>Session.delete()</literal>的时间顺序 + </para> + </listitem> + </orderedlist> + + <para> + （有一个例外是，如果对象使用<literal>native</literal>方式来生成ID（持久化标识）的话，它们一执行save就会被插入。） + </para> + + <para> + 除非你明确地发出了<literal>flush()</literal>指令，关于Session<emphasis>何时</emphasis>会执行这些JDBC调用是完全无法保证的，只能保证它们执行的前后顺序。 + 当然，Hibernate保证，<literal>Query.list(..)</literal>绝对不会返回已经失效的数据，也不会返回错误数据。 + </para> + + + <para> + 也可以改变默认的设置，来让刷出(flush)操作发生的不那么频繁。 + <literal>FlushMode</literal>类定义了三种不同的方式。 + 仅在提交时刷出(仅当Hibernate的<literal>Transaction</literal> API被使用时有效)， + 按照刚才说的方式刷出， + 以及除非明确使用<literal>flush()</literal>否则从不刷出。 + 最后一种模式对于那些需要长时间保持<literal>Session</literal>为打开或者断线状态的长时间运行的工作单元很有用。 + (参见 <xref linkend="transactions-optimistic-longsession"/>). + </para> + + <programlisting><![CDATA[sess = sf.openSession(); +Transaction tx = sess.beginTransaction(); +sess.setFlushMode(FlushMode.COMMIT); // allow queries to return stale state + +Cat izi = (Cat) sess.load(Cat.class, id); +izi.setName(iznizi); + +// might return stale data +sess.find("from Cat as cat left outer join cat.kittens kitten"); + +// change to izi is not flushed! +... +tx.commit(); // flush occurs +sess.close();]]></programlisting> + + + <para> + 刷出(flush)期间，可能会抛出异常。（例如一个DML操作违反了约束） + 异常处理涉及到对Hibernate事务性行为的理解，因此我们将在<xref linkend="transactions"/>中讨论。 + </para> + + </sect1> + + <sect1 id="objectstate-transitive" revision="1"> + <title>传播性持久化(transitive persistence)</title> + + <para> + 对每一个对象都要执行保存，删除或重关联操作让人感觉有点麻烦，尤其是在处理许多彼此关联的对象的时候。 + 一个常见的例子是父子关系。考虑下面的例子: + </para> + + + <para> + 如果一个父子关系中的子对象是值类型(value typed)（例如，地址或字符串的集合）的，他们的生命周期会依赖于父对象，可以享受方便的级联操作(Cascading)，不需要额外的动作。 + 父对象被保存时，这些值类型(value typed)子对象也将被保存；父对象被删除时，子对象也将被删除。 + 这对将一个子对象从集合中移除是同样有效：Hibernate会检测到，并且因为值类型(value typed)的对象不可能被其他对象引用，所以Hibernate会在数据库中删除这个子对象。 + </para> + + + <para> + 现在考虑同样的场景，不过父子对象都是实体(entities)类型，而非值类型(value typed)（例如，类别与个体，或母猫和小猫）。 + 实体有自己的生命期，允许共享对其的引用（因此从集合中移除一个实体，不意味着它可以被删除）， + 并且实体到其他关联实体之间默认没有级联操作的设置。 + Hibernate默认不实现所谓的<emphasis>可到达即持久化（persistence by reachability）</emphasis>的策略。 + </para> + + <para> + 每个Hibernate session的基本操作 - 包括 <literal>persist(), merge(), + saveOrUpdate(), delete(), lock(), refresh(), evict(), replicate()</literal> - 都有对应的级联风格(cascade style)。 + 这些级联风格(cascade style)风格分别命名为 <literal>create, + merge, save-update, delete, lock, refresh, evict, replicate</literal>。 + 如果你希望一个操作被顺着关联关系级联传播，你必须在映射文件中指出这一点。例如： + </para> + + <programlisting><![CDATA[<one-to-one name="person" cascade="persist"/>]]></programlisting> + + + <para> + 级联风格(cascade style)是可组合的: + </para> + + <programlisting><![CDATA[<one-to-one name="person" cascade="persist,delete,lock"/>]]></programlisting> + + + <para> + 你可以使用<literal>cascade="all"</literal>来指定<emphasis>全部</emphasis>操作都顺着关联关系级联(cascaded)。 + 默认值是<literal>cascade="none"</literal>，即任何操作都不会被级联(cascaded)。 + </para> + + <para> + 注意有一个特殊的级联风格(cascade style) <literal>delete-orphan</literal>，只应用于one-to-many关联，表明<literal>delete()</literal>操作 + 应该被应用于所有从关联中删除的对象。 + </para> + + + + <para> + 建议: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + 通常在<literal>&lt;many-to-one&gt;</literal>或<literal>&lt;many-to-many&gt;</literal>关系中应用级联(cascade)没什么意义。 + 级联(cascade)通常在 <literal>&lt;one-to-one&gt;</literal>和<literal>&lt;one-to-many&gt;</literal>关系中比较有用。 + </para> + </listitem> + <listitem> + <para> + 如果子对象的寿命限定在父亲对象的寿命之内，可通过指定<literal>cascade="all,delete-orphan"</literal>将其变为<emphasis>自动生命周期管理的对象(life cycle object)</emphasis>。 + </para> + </listitem> + <listitem> + <para> + 其他情况，你可根本不需要级联(cascade)。但是如果你认为你会经常在某个事务中同时用到父对象与子对象，并且你希望少打点儿字，可以考虑使用<literal>cascade="persist,merge,save-update"</literal>。 + </para> + </listitem> + </itemizedlist> + + <para> + 可以使用<literal>cascade="all"</literal>将一个关联关系（无论是对值对象的关联，或者对一个集合的关联）标记为<emphasis>父/子</emphasis>关系的关联。 + 这样对父对象进行save/update/delete操作就会导致子对象也进行save/update/delete操作。 + </para> + + <para> + 此外，一个持久的父对象对子对象的浅引用(mere reference)会导致子对象被同步save/update。 + 不过，这个隐喻(metaphor)的说法并不完整。除非关联是<literal>&lt;one-to-many&gt;</literal>关联并且被标记为<literal>cascade="delete-orphan"</literal>， + 否则父对象失去对某个子对象的引用<emphasis>不会</emphasis>导致该子对象被自动删除。 + 父子关系的级联(cascading)操作准确语义如下： + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + 如果父对象被<literal>persist()</literal>，那么所有子对象也会被<literal>persist()</literal> + </para> + </listitem> + <listitem> + <para> + 如果父对象被<literal>merge()</literal>，那么所有子对象也会被<literal>merge()</literal> + </para> + </listitem> + <listitem> + <para> + 如果父对象被<literal>save()</literal>，<literal>update()</literal>或 + <literal>saveOrUpdate()</literal>，那么所有子对象则会被<literal>saveOrUpdate()</literal> + </para> + </listitem> + <listitem> + <para> + 如果某个持久的父对象引用了瞬时(transient)或者脱管(detached)的子对象，那么子对象将会被<literal>saveOrUpdate()</literal> + </para> + </listitem> + <listitem> + <para> + 如果父对象被删除，那么所有子对象也会被<literal>delete()</literal> + </para> + </listitem> + <listitem> + <para> + 除非被标记为<literal>cascade="delete-orphan"</literal>（删除“孤儿”模式，此时不被任何一个父对象引用的子对象会被删除）， + 否则子对象失掉父对象对其的引用时，<emphasis>什么事也不会发生</emphasis>。 + 如果有特殊需要，应用程序可通过显式调用delete()删除子对象。 + </para> + </listitem> + </itemizedlist> + <para> + 最后，注意操作的级联可能是在<emphasis>调用期(call time)</emphasis>或者<emphasis>写入期(flush time)</emphasis>作用到对象图上的。所有的操作，如果允许，都在操作被执行的时候级联到可触及的关联实体上。然而，<literal>save-upate</literal>和<literal>delete-orphan</literal>是在<literal>Session</literal> flush的时候才作用到所有可触及的被关联对象上的。 + </para> + + + </sect1> + + <sect1 id="objectstate-metadata"> + <title>使用元数据</title> + + <para> + Hibernate中有一个非常丰富的元级别(meta-level)的模型，含有所有的实体和值类型数据的元数据。 + 有时这个模型对应用程序本身也会非常有用。 + 比如说，应用程序可能在实现一种“智能”的深度拷贝算法时， + 通过使用Hibernate的元数据来了解哪些对象应该被拷贝（比如，可变的值类型数据）， + 那些不应该（不可变的值类型数据，也许还有某些被关联的实体）。 + </para> + + + <para> + Hibernate提供了<literal>ClassMetadata</literal>接口，<literal>CollectionMetadata</literal>接口和<literal>Type</literal>层次体系来访问元数据。 + 可以通过<literal>SessionFactory</literal>获取元数据接口的实例。 + </para> + + <programlisting><![CDATA[Cat fritz = ......; +ClassMetadata catMeta = sessionfactory.getClassMetadata(Cat.class); + +Object[] propertyValues = catMeta.getPropertyValues(fritz); +String[] propertyNames = catMeta.getPropertyNames(); +Type[] propertyTypes = catMeta.getPropertyTypes(); + +// get a Map of all properties which are not collections or associations +Map namedValues = new HashMap(); +for ( int i=0; i<propertyNames.length; i++ ) { + if ( !propertyTypes[i].isEntityType() && !propertyTypes[i].isCollectionType() ) { + namedValues.put( propertyNames[i], propertyValues[i] ); + } +}]]></programlisting> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/toolset_guide.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/toolset_guide.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/toolset_guide.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/toolset_guide.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,564 @@ +<chapter id="toolsetguide" revision="2"> + <title>工具箱指南</title> + + <para> + 可以通过一系列Eclipse插件、命令行工具和Ant任务来进行与Hibernate关联的转换。 + + </para> + + <para> + 除了Ant任务外，当前的<emphasis>Hibernate Tools</emphasis>也包含了Eclipse IDE的插件，用于与现存数据库的逆向工程。 + </para> + + <itemizedlist> + <listitem><para> + + <emphasis>Mapping Editor:</emphasis> Hibernate XML映射文件的编辑器，支持自动完成和语法高亮。它也支持对类名和属性/字段名的语义自动完成，比通常的XML编辑器方便得多。 + </para></listitem> + <listitem><para> + <emphasis>Console:</emphasis> Console是Eclipse的一个新视图。除了对你的console配置的树状概览，你还可以获得对你持久化类及其关联的交互式视图。Console允许你对数据库执行HQL查询，并直接在Eclipse中浏览结果。 + </para></listitem> + <listitem><para> + <emphasis>Development Wizards:</emphasis> 在Hibernate Eclipse tools中还提供了几个向导；你可以用向导快速生成Hibernate 配置文件（cfg.xml），你甚至还可以同现存的数据库schema中反向工程出POJO源代码与Hibernate 映射文件。反向工程支持可定制的模版。 + </para></listitem> + <listitem><para> + <emphasis>Ant Tasks:</emphasis> + </para></listitem> + + </itemizedlist> + + <para> + 要得到更多信息，请查阅 <emphasis>Hibernate Tools</emphasis> 包及其文档。 + </para> + + <para> + 同时，Hibernate主发行包还附带了一个集成的工具（它甚至可以在Hibernate“内部”快速运行）<emphasis>SchemaExport</emphasis> ，也就是 <literal>hbm2ddl</literal>。 + + </para> + + <sect1 id="toolsetguide-s1" revision="2"> + <title>Schema自动生成（Automatic schema generation）</title> + + <para> + 可以从你的映射文件使用一个Hibernate工具生成DDL。 生成的schema包含有对实体和集合类表的完整性引用约束（主键和外键）。涉及到的标示符生成器所需的表和sequence也会同时生成。 + </para> + + <para> + 在使用这个工具的时候，你<emphasis>必须</emphasis> 通过<literal>hibernate.dialet</literal>属性指定一个SQL<literal>方言(Dialet)</literal>，因为DDL是与供应商高度相关的。 + </para> + + <para> + 首先，要定制你的映射文件，来改善生成的schema。 + </para> + + <sect2 id="toolsetguide-s1-2" revision="3"> + <title>对schema定制化(Customizing the schema)</title> + + <para> + 很多Hibernate映射元素定义了可选的<literal>length</literal>、<literal>precision</literal> 或者 <literal>scale</literal>属性。你可以通过这个属性设置字段的长度、精度、小数点位数。 + </para> + + <programlisting><![CDATA[<property name="zip" length="5"/>]]></programlisting> + <programlisting><![CDATA[<property name="balance" precision="12" scale="2"/>]]></programlisting> + + <para> + 有些tag还接受<literal>not-null</literal>属性（用来在表字段上生成<literal>NOT NULL</literal>约束）和<literal>unique</literal>属性（用来在表字段上生成<literal>UNIQUE</literal>约束）。 + </para> + + <programlisting><![CDATA[<many-to-one name="bar" column="barId" not-null="true"/>]]></programlisting> + <programlisting><![CDATA[<element column="serialNumber" type="long" not-null="true" unique="true"/>]]></programlisting> + + <para> + <literal>unique-key</literal>属性可以对成组的字段指定一个唯一键约束(unique key constraint)。目前，<literal>unique-key</literal>属性指定的值在生成DDL时<emphasis>并不会</emphasis>被当作这个约束的名字，它们只是在用来在映射文件内部用作区分的。 + </para> + + <programlisting><![CDATA[<many-to-one name="org" column="orgId" unique-key="OrgEmployeeId"/> +<property name="employeeId" unique-key="OrgEmployee"/>]]></programlisting> + + <para> + <literal>index</literal>属性会用对应的字段（一个或多个）生成一个index,它指出了这个index的名字。如果多个字段对应的index名字相同，就会生成包含这些字段的index。 + </para> + + <programlisting><![CDATA[<property name="lastName" index="CustName"/> +<property name="firstName" index="CustName"/>]]></programlisting> + + <para> + <literal>foreign-key</literal>属性可以用来覆盖任何生成的外键约束的名字。 + </para> + + <programlisting><![CDATA[<many-to-one name="bar" column="barId" foreign-key="FKFooBar"/>]]></programlisting> + + <para> + 很多映射元素还接受<literal>&lt;column&gt;</literal>子元素。这在定义跨越多字段的类型时特别有用。 + </para> + + <programlisting><![CDATA[<property name="name" type="my.customtypes.Name"/> + <column name="last" not-null="true" index="bar_idx" length="30"/> + <column name="first" not-null="true" index="bar_idx" length="20"/> + <column name="initial"/> +</property>]]></programlisting> + + <para> + <literal>default</literal>属性为字段指定一个默认值 (在保存被映射的类的新实例之前，你应该将同样的值赋于对应的属性)。 + </para> + + <programlisting><![CDATA[<property name="credits" type="integer" insert="false"> + <column name="credits" default="10"/> +</property>]]></programlisting> + + <programlisting><![CDATA[<version name="version" type="integer" insert="false"> + <column name="version" default="0"/> +</property>]]></programlisting> + + <para> + <literal>sql-type</literal>属性允许用户覆盖默认的Hibernate类型到SQL数据类型的映射。 + </para> + + <programlisting><![CDATA[<property name="balance" type="float"> + <column name="balance" sql-type="decimal(13,3)"/> +</property>]]></programlisting> + + <para> + <literal>check</literal>属性允许用户指定一个约束检查。 + </para> + + <programlisting><![CDATA[<property name="foo" type="integer"> + <column name="foo" check="foo > 10"/> +</property>]]></programlisting> + + <programlisting><![CDATA[<class name="Foo" table="foos" check="bar < 100.0"> + ... + <property name="bar" type="float"/> +</class>]]></programlisting> + + + <table frame="topbot" id="schemattributes-summary" revision="1"> + <title>Summary</title> + <tgroup cols="2"> + <colspec colwidth="1*"/> + <colspec colwidth="2.5*"/> + <thead> + <row> + <entry>属性(Attribute)</entry> + <entry>值（Values）</entry> + <entry>解释（Interpretation）</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>length</literal></entry> + <entry>数字</entry> + <entry>字段长度</entry> + + </row> + <row> + <entry><literal>precision</literal></entry> + <entry>数字</entry> + <entry>精度(decimal precision)</entry> + </row> + <row> + <entry><literal>scale</literal></entry> + <entry>数字</entry> + <entry>小数点位数(decimal scale)</entry> + </row> + <row> + <entry><literal>not-null</literal></entry> + <entry><literal>true|false</literal></entry> + <entry>指明字段是否应该是非空的</entry> + </row> + <row> + <entry><literal>unique</literal></entry> + <entry><literal>true|false</literal></entry> + <entry>指明是否该字段具有惟一约束</entry> + </row> + <row> + <entry><literal>index</literal></entry> + <entry><literal>index_name</literal></entry> + <entry>指明一个（多字段）的索引(index)的名字</entry> + </row> + <row> + <entry><literal>unique-key</literal></entry> + <entry><literal>unique_key_name</literal></entry> + <entry>指明多字段惟一约束的名字（参见上面的说明）</entry> + </row> + <row> + <entry><literal>foreign-key</literal></entry> + <entry><literal>foreign_key_name</literal></entry> + <entry> + specifies the name of the foreign key constraint generated + for an association, for a <literal>&lt;one-to-one&gt;</literal>, + <literal>&lt;many-to-one&gt;</literal>, <literal>&lt;key&gt;</literal>, + or <literal>&lt;many-to-many&gt;</literal> mapping element. Note that + <literal>inverse="true"</literal> sides will not be considered + by <literal>SchemaExport</literal>. + 指明一个外键的名字，它是为关联生成的，或者<literal>&lt;one-to-one&gt;</literal>，<literal>&lt;many-to-one&gt;</literal>, <literal>&lt;key&gt;</literal>, 或者<literal>&lt;many-to-many&gt;</literal>映射元素。注意<literal>inverse="true"</literal>在<literal>SchemaExport</literal>时会被忽略。 + + </entry> + </row> + <row> + <entry><literal>sql-type</literal></entry> + <entry><literal>SQL 字段类型</literal></entry> + <entry> + 覆盖默认的字段类型(只能用于<literal>&lt;column&gt;</literal>属性） + </entry> + </row> + <row> + <entry><literal>default</literal></entry> + <entry>SQL表达式</entry> + <entry> + 为字段指定默认值 + </entry> + </row> + <row> + <entry><literal>check</literal></entry> + <entry>SQL 表达式</entry> + <entry> + 对字段或表加入SQL约束检查 + </entry> + </row> + + </tbody> + </tgroup> + </table> + + <para> + <literal>&lt;comment&gt;</literal>元素可以让你在生成的schema中加入注释。 + </para> + + <programlisting><![CDATA[<class name="Customer" table="CurCust"> + <comment>Current customers only</comment> + ... +</class>]]></programlisting> + + <programlisting><![CDATA[<property name="balance"> + <column name="bal"> + <comment>Balance in USD</comment> + </column> +</property>]]></programlisting> + + <para> + 结果是在生成的DDL中包含<literal>comment on table</literal> 或者 + <literal>comment on column</literal>语句(假若支持的话)。 + </para> + + </sect2> + + <sect2 id="toolsetguide-s1-3" revision="2"> + <title>运行该工具</title> + + <para> + <literal>SchemaExport</literal>工具把DDL脚本写到标准输出，同时/或者执行DDL语句。 + </para> + + <para> + <literal>java -cp </literal><emphasis>hibernate_classpaths</emphasis> + <literal>org.hibernate.tool.hbm2ddl.SchemaExport</literal> <emphasis>options mapping_files</emphasis> + </para> + + <table frame="topbot"> + <title><literal>SchemaExport</literal>命令行选项</title> + <tgroup cols="2"> + <colspec colwidth="1.5*"/> + <colspec colwidth="2*"/> + <thead> + <row> + <entry>选项</entry> + <entry>说明</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>--quiet</literal></entry> + <entry>不要把脚本输出到stdout</entry> + </row> + <row> + <entry><literal>--drop</literal></entry> + <entry>只进行drop tables的步骤</entry> + </row> + <row> + <entry><literal>--create</literal></entry> + <entry>只创建表</entry> + </row> + <row> + <entry><literal>--text</literal></entry> + <entry>不执行在数据库中运行的步骤</entry> + </row> + <row> + <entry><literal>--output=my_schema.ddl</literal></entry> + <entry>把输出的ddl脚本输出到一个文件</entry> + </row> + <row> + <entry><literal>--naming=eg.MyNamingStrategy</literal></entry> + <entry>选择一个命名策略(<literal>NamingStrategy</literal>)</entry> + </row> + <row> + <entry><literal>--config=hibernate.cfg.xml</literal></entry> + <entry>从XML文件读入Hibernate配置</entry> + </row> + <row> + <entry><literal>--properties=hibernate.properties</literal></entry> + <entry>从文件读入数据库属性</entry> + </row> + <row> + <entry><literal>--format</literal></entry> + <entry>把脚本中的SQL语句对齐和美化</entry> + </row> + <row> + <entry><literal>--delimiter=;</literal></entry> + <entry>为脚本设置行结束符</entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + 你甚至可以在你的应用程序中嵌入<literal>SchemaExport</literal>工具: + </para> + + <programlisting><![CDATA[Configuration cfg = ....; +new SchemaExport(cfg).create(false, true);]]></programlisting> + + </sect2> + + <sect2 id="toolsetguide-s1-4"> + <title>属性(Properties)</title> + + <para> + 可以通过如下方式指定数据库属性: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para>通过<literal>-D</literal><emphasis>&lt;property&gt;</emphasis>系统参数</para> + </listitem> + <listitem> + <para>在<literal>hibernate.properties</literal>文件中</para> + </listitem> + <listitem> + <para>位于一个其它名字的properties文件中,然后用 <literal>--properties</literal>参数指定</para> + </listitem> + </itemizedlist> + + <para> + 所需的参数包括: + </para> + + <table frame="topbot"> + <title>SchemaExport 连接属性</title> + <tgroup cols="2"> + <colspec colwidth="1.5*"/> + <colspec colwidth="2*"/> + <thead> + <row> + <entry>属性名</entry> + <entry>说明</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>hibernate.connection.driver_class</literal></entry> + <entry>jdbc driver class</entry> + </row> + <row> + <entry><literal>hibernate.connection.url</literal></entry> + <entry>jdbc url</entry> + </row> + <row> + <entry><literal>hibernate.connection.username</literal></entry> + <entry>database user</entry> + </row> + <row> + <entry><literal>hibernate.connection.password</literal></entry> + <entry>user password</entry> + </row> + <row> + <entry><literal>hibernate.dialect</literal></entry> + <entry>方言(dialect)</entry> + </row> + </tbody> + </tgroup> + </table> + + </sect2> + + <sect2 id="toolsetguide-s1-5"> + <title>使用Ant(Using Ant)</title> + + <para> + 你可以在你的Ant build脚本中调用<literal>SchemaExport</literal>: + </para> + + <programlisting><![CDATA[<target name="schemaexport"> + <taskdef name="schemaexport" + classname="org.hibernate.tool.hbm2ddl.SchemaExportTask" + classpathref="class.path"/> + + <schemaexport + properties="hibernate.properties" + quiet="no" + text="no" + drop="no" + delimiter=";" + output="schema-export.sql"> + <fileset dir="src"> + <include name="**/*.hbm.xml"/> + </fileset> + </schemaexport> +</target>]]></programlisting> + + </sect2> + + <sect2 id="toolsetguide-s1-6" revision="2"> + <title>对schema的增量更新(Incremental schema updates)</title> + + <para> + <literal>SchemaUpdate</literal>工具对已存在的schema采用"增量"方式进行更新。注意<literal>SchemaUpdate</literal>严重依赖于JDBC metadata API,所以它并非对所有JDBC驱动都有效。 + </para> + + <para> + <literal>java -cp </literal><emphasis>hibernate_classpaths</emphasis> + <literal>org.hibernate.tool.hbm2ddl.SchemaUpdate</literal> <emphasis>options mapping_files</emphasis> + </para> + + <table frame="topbot"> + <title><literal>SchemaUpdate</literal>命令行选项</title> + <tgroup cols="2"> + <colspec colwidth="1.5*"/> + <colspec colwidth="2*"/> + <thead> + <row> + <entry>选项</entry> + <entry>说明</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>--quiet</literal></entry> + <entry>不要把脚本输出到stdout</entry> + </row> + <row> + <entry><literal>--text</literal></entry> + <entry>不把脚本输出到数据库</entry> + </row> + <row> + <entry><literal>--naming=eg.MyNamingStrategy</literal></entry> + <entry>选择一个命名策略 (<literal>NamingStrategy</literal>)</entry> + </row> + <row> + <entry><literal>--properties=hibernate.properties</literal></entry> + <entry>从指定文件读入数据库属性</entry> + </row> + <row> + <entry><literal>--config=hibernate.cfg.xml</literal></entry> + <entry>指定一个 <literal>.cfg.xml</literal>文件</entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + 你可以在你的应用程序中嵌入<literal>SchemaUpdate</literal>工具: + </para> + + <programlisting><![CDATA[Configuration cfg = ....; +new SchemaUpdate(cfg).execute(false);]]></programlisting> + + </sect2> + + <sect2 id="toolsetguide-s1-7"> + <title>用Ant来增量更新schema(Using Ant for incremental schema updates)</title> + + <para> + 你可以在Ant脚本中调用<literal>SchemaUpdate</literal>： + </para> + + <programlisting><![CDATA[<target name="schemaupdate"> + <taskdef name="schemaupdate" + classname="org.hibernate.tool.hbm2ddl.SchemaUpdateTask" + classpathref="class.path"/> + + <schemaupdate + properties="hibernate.properties" + quiet="no"> + <fileset dir="src"> + <include name="**/*.hbm.xml"/> + </fileset> + </schemaupdate> +</target>]]></programlisting> + + </sect2> + + <sect2 id="toolsetguide-s1-8" revision="1"> + <title>Schema 校验</title> + + <para> + <literal>SchemaValidator</literal>工具会比较数据库现状是否与映射文档“匹配”。注意，<literal>SchemaValidator</literal> 严重依赖于JDBC的metadata API，因此不是对所有的JDBC驱动都适用。这一工具在测试的时候特别有用。 + </para> + + <para> + <literal>java -cp </literal><emphasis>hibernate_classpaths</emphasis> + <literal>org.hibernate.tool.hbm2ddl.SchemaValidator</literal> <emphasis>options mapping_files</emphasis> + </para> + + <table frame="topbot"> + <title><literal>SchemaValidator</literal>命令行参数</title> + <tgroup cols="2"> + <colspec colwidth="1.5*"/> + <colspec colwidth="2*"/> + <thead> + <row> + <entry>选项</entry> + <entry>描述</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>--naming=eg.MyNamingStrategy</literal></entry> + <entry>选择一个命名策略 (<literal>NamingStrategy</literal>)</entry> + </row> + <row> + <entry><literal>--properties=hibernate.properties</literal></entry> + <entry>从文件中读取数据库属性</entry> + </row> + <row> + <entry><literal>--config=hibernate.cfg.xml</literal></entry> + <entry>指定一个<literal>.cfg.xml</literal>文件</entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + 你可以在你的应用程序中嵌入<literal>SchemaValidator</literal>： + </para> + + <programlisting><![CDATA[Configuration cfg = ....; +new SchemaValidator(cfg).validate();]]></programlisting> + + </sect2> + + <sect2 id="toolsetguide-s1-9"> + <title>使用Ant进行schema校验</title> + + <para> + 你可以在Ant脚本中调用<literal>SchemaValidator</literal>: + </para> + + <programlisting><![CDATA[<target name="schemavalidate"> + <taskdef name="schemavalidator" + classname="org.hibernate.tool.hbm2ddl.SchemaValidatorTask" + classpathref="class.path"/> + + <schemavalidator + properties="hibernate.properties"> + <fileset dir="src"> + <include name="**/*.hbm.xml"/> + </fileset> + </schemavalidator> +</target>]]></programlisting> + + </sect2> + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/transactions.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/transactions.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/transactions.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/transactions.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,870 @@ +<chapter id="transactions" revision="2"> + <title>事务和并发</title> + <para> + Hibernate的事务和并发控制很容易掌握。Hibernate直接使用JDBC连接和JTA资源，不添加任何附加锁定 + 行为。我们强烈推荐你花点时间了解JDBC编程，ANSI SQL查询语言和你使用 + 的数据库系统的事务隔离规范。 + </para> + + <para> + Hibernate不锁定内存中的对象。你的应用程序会按照你的数据库事务的隔离级别规定的那样运作。幸亏有了<literal>Session</literal>，使得Hibernate通过标识符查找，和实体查询（不是返回标量值的报表查询）提供了可重复的读取（Repeatable reads）功能，<literal>Session</literal>同时也是事务范围内的缓存（cache）。 + </para> + + <para> + 除了对自动乐观并发控制提供版本管理，针对行级悲观锁定，Hibernate也提供了辅助的（较小的)API，它使用了 + <literal>SELECT FOR UPDATE</literal>的SQL语法。本章后面会讨论乐观并发控制和这个API。 + </para> + <para> + 我们从<literal>Configuration</literal>层、<literal>SessionFactory</literal>层, 和 + <literal>Session</literal>层开始讨论Hibernate的并行控制、数据库事务和应用 + 程序的长事务。 + </para> + <sect1 id="transactions-basics" revision="1"> + <title>Session和事务范围(transaction scope)</title> + <para> + <literal>SessionFactory</literal>对象的创建代价很昂贵，它是线程安全的对象，它为所有的应用程序线程所共享。它只创建一次，通常是在应用程序启动的时候，由一个<literal>Configuraion</literal>的实例来创建。 + </para> + <para> + <literal>Session</literal>对象的创建代价比较小，是非线程安全的，对于单个请求，单个会话、单个的 + 工作单元而言，它只被使用一次，然后就丢弃。只有在需要的时候，一个<literal>Session</literal>对象 + 才会获取一个JDBC的<literal>Connection</literal>（或一个<literal>Datasource</literal>） + 对象，因此假若不使用的时候它不消费任何资源。 + </para> + <para> + 此外我们还要考虑数据库事务。数据库事务应该尽可能的短，降低数据库中的锁争用。 + 数据库长事务会阻止你的应用程序扩展到高的并发负载。因此，假若在用户思考期间让数据库事务开着，直到整个工作单元完成才关闭这个事务，这绝不是一个好的设计。 + </para> + <para> + 一个操作单元(Unit of work)的范围是多大？单个的Hibernate <literal>Session</literal>能跨越多个 + 数据库事务吗？还是一个<literal>Session</literal>的作用范围对应一个数据库事务的范围？应该何时打开 + <literal>Session</literal>，何时关闭<literal>Session</literal>？，你又如何划分数据库事务的边界呢？ + </para> + <sect2 id="transactions-basics-uow" revision="1"> + <title>操作单元(Unit of work)</title> + <para> + 首先，别用<emphasis>session-per-operation</emphasis>这种反模式了，也就是说，在单个线程中， + 不要因为一次简单的数据库调用，就打开和关闭一次<literal>Session</literal>！数据库事务也是如此。 + 应用程序中的数据库调用是按照计划好的次序，分组为原子的操作单元。（注意，这也意味着，应用程 + 序中，在单个的SQL语句发送之后，自动事务提交(auto-commit)模式失效了。这种模式专门为SQL控制台操作设计的。 + Hibernate禁止立即自动事务提交模式，或者期望应用服务器禁止立即自动事务提交模式。）数据库事务绝不是可有可无的，任何与数据库之间的通讯都必须在某个事务中进行，不管你是在读还是在写数据。对读数据而言，应该避免auto-commit行为，因为很多小的事务比一个清晰定义的工作单元性能差。后者也更容易维护和扩展。 + </para> + <para> + 在多用户的client/server应用程序中，最常用的模式是 <emphasis>每个请求一个会话(session-per-request)</emphasis>。 + 在这种模式下，来自客户端的请求被发送到服务器端（即Hibernate持久化层运行的地方），一 + 个新的Hibernate <literal>Session</literal>被打开，并且执行这个操作单元中所有的数据库操作。 + 一旦操作完成（同时对客户端的响应也准备就绪），session被同步，然后关闭。你也可以使用单 + 个数据库事务来处理客户端请求，在你打开<literal>Session</literal>之后启动事务，在你关闭 + <literal>Session</literal>之前提交事务。会话和请求之间的关系是一对一的关系，这种模式对 + 于大多数应用程序来说是很棒的。 + </para> + <para> + 实现才是真正的挑战。Hibernate内置了对"当前session(current session)" 的管理，用于简化此模式。你要做的一切就是在服务器端要处理请求的时候，开启事务，在响应发送给客户之前结束事务。你可以用任何方式来完成这一操作，通常的方案有<literal>ServletFilter</literal>，在service方法中进行pointcut的AOP拦截器，或者proxy/interception容器。EJB容器是实现横切诸如EJB session bean上的事务分界，用CMT对事务进行声明等方面的标准手段。假若你决定使用编程式的事务分界，请参考本章后面讲到的Hibernate <literal>Transaction</literal> API，这对易用性和代码可移植性都有好处。 + </para> + + <para> + 在任何时间，任何地方，你的应用代码可以通过简单的调用<literal>sessionFactory.getCurrentSession()</literal>来访问"当前session"，用于处理请求。你总是会得到当前数据库事务范围内的<literal>Session</literal>。在使用本地资源或JTA环境时，必须配置它，请参见<xref linkend="architecture-current-session"/>。 + </para> + + <para> + 有时，将<literal>Session</literal>和数据库事务的边界延伸到"展示层被渲染后"会带来便利。有些serlvet应用程序在对请求进行处理后，有个单独的渲染期，这种延伸对这种程序特别有用。假若你实现你自己的拦截器，把事务边界延伸到展示层渲染结束后非常容易。然而，假若你依赖有容器管理事务的EJB，这就不太容易了，因为事务会在EJB方法返回后结束，而那是在任何展示层渲染开始之前。请访问Hibernate网站和论坛，你可以找到<emphasis>Open Session in View</emphasis>这一模式的提示和示例。 + </para> + + </sect2> + + <sect2 id="transactions-basics-apptx" revision="1"> + <title>长对话</title> + <para> + session-per-request模式不仅仅是一个可以用来设计操作单元的有用概念。很多业务处理都需 + 要一系列完整的与用户之间的交互，而这些用户是指对数据库有交叉访问的用户。在基于web的应用和企业 + 应用中，跨用户交互的数据库事务是无法接受的。考虑下面的例子： + </para> + <itemizedlist> + <listitem> + <para> + 在界面的第一屏，打开对话框，用户所看到的数据是被一个特定的 <literal>Session</literal> 和数据 + 库事务载入(load)的。用户可以随意修改对话框中的数据对象。 + </para> + </listitem> + <listitem> + <para> + 5分钟后，用户点击“保存”，期望所做出的修改被持久化；同时他也期望自己是唯一修改这个信息的人，不会出现 + 修改冲突。 + </para> + </listitem> + </itemizedlist> + + <para> + 从用户的角度来看，我们把这个操作单元称为长时间运行的<emphasis>对话</emphasis>（conversation）,或者(or <emphasis>应用事务</emphasis>,application transaction)。 + 在你的应用程序中，可以有很多种方法来实现它。 + </para> + <para> + 头一个幼稚的做法是，在用户思考的过程中，保持<literal>Session</literal>和数据库事务是打开的， + 保持数据库锁定，以阻止并发修改，从而保证数据库事务隔离级别和原子操作。这种方式当然是一个反模式， + 因为锁争用会导致应用程序无法扩展并发用户的数目。 + </para> + <para> + 很明显，我们必须使用多个数据库事务来实现这个对话。在这个例子中，维护业务处理的 + 事务隔离变成了应用程序层的部分责任。一个对话通常跨越多个数据库事务。如果仅仅只有一 + 个数据库事务（最后的那个事务）保存更新过的数据，而所有其他事务只是单纯的读取数据（例如在一 + 个跨越多个请求/响应周期的向导风格的对话框中），那么应用程序事务将保证其原子性。这种方式比听 + 起来还要容易实现，特别是当你使用了Hibernate的下述特性的时候： + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>自动版本化</emphasis> - Hibernate能够自动进行乐观并发控制 ，如果在用户思考 + 的过程中发生并发修改，Hibernate能够自动检测到。一般我们只在对话结束时才检查。 + </para> + </listitem> + <listitem> + <para> + <emphasis>脱管对象</emphasis>（Detached Objects）- 如果你决定采用前面已经讨论过的 + <emphasis>session-per-request</emphasis>模式，所有载入的实例在用户思考的过程 + 中都处于与Session脱离的状态。Hibernate允许你把与Session脱离的对象重新关联到Session + 上，并且对修改进行持久化，这种模式被称为 + <emphasis>session-per-request-with-detached-objects</emphasis>。自动版本化被用来隔离并发修改。 + </para> + </listitem> + <listitem> + <para> + <emphasis>Extended (or Long) Session</emphasis> - Hibernate 的<literal>Session</literal> + 可以在数据库事务提交之后和底层的JDBC连接断开，当一个新的客户端请求到来的时候，它又重新连接上底层的 + JDBC连接。这种模式被称之为<emphasis>session-per-conversation</emphasis>，这种情况可 + 能会造成不必要的Session和JDBC连接的重新关联。自动版本化被用来隔离并发修改, <literal>Session</literal>通常不允许自动flush,而是明确flush。 + </para> + </listitem> + </itemizedlist> + + <para> + <emphasis>session-per-request-with-detached-objects</emphasis> 和 + <emphasis>session-per-conversation</emphasis> 各有优缺点，我们在本章后面乐观并发 + 控制那部分再进行讨论。 + </para> + </sect2> + + <sect2 id="transactions-basics-identity"> + <title>关注对象标识(Considering object identity)</title> + <para> + 应用程序可能在两个不同的<literal>Session</literal>中并发访问同一持久化状态，但是， + 一个持久化类的实例无法在两个 <literal>Session</literal>中共享。因此有两种不同的标识语义： + </para> + <para> + <variablelist spacing="compact"> + <varlistentry> + <term>数据库标识</term> + <listitem> + <para> + <literal>foo.getId().equals( bar.getId() )</literal> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>JVM 标识</term> + <listitem> + <para> + <literal>foo==bar</literal> + </para> + </listitem> + </varlistentry> + </variablelist> + + <para> + 对于那些关联到 <emphasis>特定</emphasis><literal>Session</literal> + （也就是在单个<literal>Session</literal>的范围内）上的对象来说，这 + 两种标识的语义是等价的，与数据库标识对应的JVM标识是由Hibernate来保 + 证的。不过，当应用程序在两个不同的session中并发访问具有同一持久化标 + 识的业务对象实例的时候，这个业务对象的两个实例事实上是不相同的（从 + JVM识别来看）。这种冲突可以通过在同步和提交的时候使用自动版本化和乐 + 观锁定方法来解决。 + </para> + <para> + 这种方式把关于并发的头疼问题留给了Hibernate和数据库；由于在单个线程内，操作单元中的对象识别不 + 需要代价昂贵的锁定或其他意义上的同步，因此它同时可以提供最好的可伸缩性。只要在单个线程只持有一个 + <literal>Session</literal>，应用程序就不需要同步任何业务对象。在<literal>Session</literal> + 的范围内，应用程序可以放心的使用<literal>==</literal>进行对象比较。 + </para> + <para> + 不过，应用程序在<literal>Session</literal>的外面使用<literal>==</literal>进行对象比较可能会 + 导致无法预期的结果。在一些无法预料的场合，例如，如果你把两个脱管对象实例放进同一个 + <literal>Set</literal>的时候，就可能发生。这两个对象实例可能有同一个数据库标识（也就是说， + 他们代表了表的同一行数据），从JVM标识的定义上来说，对脱管的对象而言，Hibernate无法保证他们 + 的的JVM标识一致。开发人员必须覆盖持久化类的<literal>equals()</literal>方法和 + <literal>hashCode()</literal> 方法，从而实现自定义的对象相等语义。警告：不要使用数据库标识 + 来实现对象相等，应该使用业务键值，由唯一的，通常不变的属性组成。当一个瞬时对象被持久化的时 + 候，它的数据库标识会发生改变。如果一个瞬时对象（通常也包括脱管对象实例）被放入一 + 个<literal>Set</literal>，改变它的hashcode会导致与这个<literal>Set</literal>的关系中断。虽 + 然业务键值的属性不象数据库主键那样稳定不变，但是你只需要保证在同一个<literal>Set</literal> + 中的对象属性的稳定性就足够了。请到Hibernate网站去寻求这个问题更多的详细的讨论。请注意，这不是一 + 个有关Hibernate的问题，而仅仅是一个关于Java对象标识和判等行为如何实现的问题。 + </para> + </para> + </sect2> + + <sect2 id="transactions-basics-issues"> + <title>常见问题</title> + <para> + 决不要使用反模式<emphasis>session-per-user-session</emphasis>或者<emphasis> + session-per-application</emphasis>（当然，这个规定几乎没有例外）。请注意， + 下述一些问题可能也会出现在我们推荐的模式中，在你作出某个设计决定之前，请务必理解该模式的应用前提。 + </para> + <itemizedlist> + <listitem> + <para> + <literal>Session</literal> 对象是非线程安全的。如果一个<literal>Session</literal> + 实例允许共享的话，那些支持并发运行的东东，例如HTTP request，session beans,或者是 + Swing workers，将会导致出现资源争用（race condition）。如果在<literal>HttpSession</literal>中有 + Hibernate 的<literal>Session</literal>的话（稍后讨论），你应该考虑同步访问你的Http session。 + 否则，只要用户足够快的点击浏览器的“刷新”，就会导致两个并发运行线程使用同一个 + <literal>Session</literal>。 + </para> + </listitem> + <listitem> + <para> + 一个由Hibernate抛出的异常意味着你必须立即回滚数据库事务，并立即关闭<literal>Session</literal> + （稍后会展开讨论）。如果你的<literal>Session</literal>绑定到一个应用程序上，你必 + 须停止该应用程序。回滚数据库事务并不会把你的业务对象退回到事务启动时候的状态。这 + 意味着数据库状态和业务对象状态不同步。通常情况下，这不是什么问题，因为异常是不可 + 恢复的,你必须在回滚之后重新开始执行。 + </para> + </listitem> + <listitem> + <para> + <literal>Session</literal> 缓存了处于持久化状态的每个对象（Hibernate会监视和检查脏数据）。 + 这意味着，如果你让<literal>Session</literal>打开很长一段时间，或是仅仅载入了过多的数据， + <literal>Session</literal>占用的内存会一直增长，直到抛出OutOfMemoryException异常。这个 + 问题的一个解决方法是调用<literal>clear()</literal> 和<literal>evict()</literal>来管理 + <literal>Session</literal>的缓存，但是如果你需要大批量数据操作的话，最好考虑 + 使用存储过程。在<xref linkend="batch"/>中有一些解决方案。在用户会话期间一直保持 + <literal>Session</literal>打开也意味着出现脏数据的可能性很高。 + </para> + </listitem> + </itemizedlist> + + </sect2> + + </sect1> + + <sect1 id="transactions-demarcation"> + <title>数据库事务声明</title> + <para> + 数据库（或者系统）事务的声明总是必须的。在数据库事务之外，就无法和数据库通讯（这可能会让那些习惯于 + 自动提交事务模式的开发人员感到迷惑）。永远使用清晰的事务声明，即使只读操作也是如此。进行 + 显式的事务声明并不总是需要的，这取决于你的事务隔离级别和数据库的能力，但不管怎么说，声明事务总归有益无害。当然，一个单独的数据库事务总是比很多琐碎的事务性能更好，即时对读数据而言也是一样。 + </para> + <para> + 一个Hibernate应用程序可以运行在非托管环境中（也就是独立运行的应用程序，简单Web应用程序， + 或者Swing图形桌面应用程序），也可以运行在托管的J2EE环境中。在一个非托管环境中，Hibernate + 通常自己负责管理数据库连接池。应用程序开发人员必须手工设置事务声明，换句话说，就是手工启 + 动，提交，或者回滚数据库事务。一个托管的环境通常提供了容器管理事务(CMT)，例如事务装配通过可声 + 明的方式定义在EJB session beans的部署描述符中。可编程式事务声明不再需要，即使是 + <literal>Session</literal> 的同步也可以自动完成。 + </para> + <para> + 让持久层具备可移植性是人们的理想,这种移植发生在非托管的本地资源环境，与依赖JTA但是使用BMT而非CMT的系统之间。在两种情况下你都可以使用编程式的事务管理。Hibernate提供了一套称为<literal>Transaction</literal>的封装API， + 用来把你的部署环境中的本地事务管理系统转换到Hibernate事务上。这个API是可选的，但是我们强烈 + 推荐你使用，除非你用CMT session bean。 + </para> + <para> + 通常情况下，结束 <literal>Session</literal> 包含了四个不同的阶段: + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + 同步session(flush,刷出到磁盘） + </para> + </listitem> + <listitem> + <para> + 提交事务 + </para> + </listitem> + <listitem> + <para> + 关闭session + </para> + </listitem> + <listitem> + <para> + 处理异常 + </para> + </listitem> + </itemizedlist> + + + <para> + session的同步(flush,刷出）前面已经讨论过了，我们现在进一步考察在托管和非托管环境下的事务声明和异常处理。 + </para> + + <sect2 id="transactions-demarcation-nonmanaged" revision="2"> + <title>非托管环境</title> + <para> + 如果Hibernat持久层运行在一个非托管环境中，数据库连接通常由Hibernate的简单（即非DataSource)连接池机制 + 来处理。session/transaction处理方式如下所示： + </para> + <programlisting><![CDATA[//Non-managed environment idiom +Session sess = factory.openSession(); +Transaction tx = null; +try { + tx = sess.beginTransaction(); + + // do some work + ... + + tx.commit(); +} +catch (RuntimeException e) { + if (tx != null) tx.rollback(); + throw e; // or display error message +} +finally { + sess.close(); +}]]></programlisting> + <para> + 你不需要显式<literal>flush()</literal> <literal>Session</literal> - + 对<literal>commit()</literal>的调用会自动触发session的同步(取决于session的<xref linkend="objectstate-flushing">FlushMode</xref>)。调用 <literal>close()</literal> 标志session的结束。<literal>close()</literal>方法重要的暗示是，<literal>session</literal>释放了JDBC连接。这段Java代码在非托管环境下和JTA环境下都可以运行。 + </para> + + <para> + 更加灵活的方案是Hibernate内置的"current session"上下文管理，前文已经讲过： + </para> + + <programlisting><![CDATA[// Non-managed environment idiom with getCurrentSession() +try { + factory.getCurrentSession().beginTransaction(); + + // do some work + ... + + factory.getCurrentSession().getTransaction().commit(); +} +catch (RuntimeException e) { + factory.getCurrentSession().getTransaction().rollback(); + throw e; // or display error message +}]]></programlisting> + + <para> + 你很可能从未在一个通常的应用程序的业务代码中见过这样的代码片断：致命的（系统）异常应该总是 + 在应用程序“顶层”被捕获。换句话说，执行Hibernate调用的代码（在持久层）和处理 + <literal>RuntimeException</literal>异常的代码（通常只能清理和退出应用程序）应该在不同 + 的应用程序逻辑层。Hibernate的当前上下文管理可以极大地简化这一设计，你所有的一切就是<literal>SessionFactory</literal>。 异常处理将在本章稍后进行讨论。 + </para> + + <para> + 请注意，你应该选择 <literal>org.hibernate.transaction.JDBCTransactionFactory</literal> + (这是默认选项)，对第二个例子来说，<literal>hibernate.current_session_context_class</literal>应该是<literal>"thread"</literal> + </para> + + </sect2> + + <sect2 id="transactions-demarcation-jta" revision="3"> + <title>使用JTA</title> + <para> + 如果你的持久层运行在一个应用服务器中（例如，在EJB session beans的后面），Hibernate获取 + 的每个数据源连接将自动成为全局JTA事务的一部分。 + 你可以安装一个独立的JTA实现，使用它而不使用EJB。Hibernate提供了两种策略进行JTA集成。 + </para> + + <para> + 如果你使用bean管理事务（BMT），可以通过使用Hibernate的 <literal>Transaction</literal> API来告诉 + 应用服务器启动和结束BMT事务。因此，事务管理代码和在非托管环境下是一样的。 + </para> + + <programlisting><![CDATA[// BMT idiom +Session sess = factory.openSession(); +Transaction tx = null; +try { + tx = sess.beginTransaction(); + + // do some work + ... + + tx.commit(); +} +catch (RuntimeException e) { + if (tx != null) tx.rollback(); + throw e; // or display error message +} +finally { + sess.close(); +}]]></programlisting> + + <para> + 如果你希望使用与事务绑定的<literal>Session</literal>，也就是使用<literal>getCurrentSession()</literal>来简化上下文管理，你将不得不直接使用JTA <literal>UserTransaction</literal>API。 + </para> + + <programlisting><![CDATA[// BMT idiom with getCurrentSession() +try { + UserTransaction tx = (UserTransaction)new InitialContext() + .lookup("java:comp/UserTransaction"); + + tx.begin(); + + // Do some work on Session bound to transaction + factory.getCurrentSession().load(...); + factory.getCurrentSession().persist(...); + + tx.commit(); +} +catch (RuntimeException e) { + tx.rollback(); + throw e; // or display error message +}]]></programlisting> + + + <para> + 在CMT方式下，事务声明是在session bean的部署描述符中，而不需要编程。 + 因此，代码被简化为: + </para> + + <programlisting><![CDATA[// CMT idiom +Session sess = factory.getCurrentSession(); + +// do some work +... + +]]></programlisting> + + <para> + 在CMT/EJB中甚至会自动rollback，因为假若有未捕获的<literal>RuntimeException</literal>从session bean方法中抛出，这就会通知容器把全局事务回滚。<emphasis>这就意味着，在BMT或者CMT中，你根本就不需要使用Hibernate <literal>Transaction</literal> API ，你自动得到了绑定到事务的“当前”Session。 + </emphasis> + </para> + + <para> + 注意，当你配置Hibernate的transaction factory的时候，在直接使用JTA的时候（BMT），你应该选择<literal>org.hibernate.transaction.JTATransactionFactory</literal>,在CMT session bean中选择<literal>org.hibernate.transaction.CMTTransactionFactory</literal>。记得也要设置<literal>hibernate.transaction.manager_lookup_class</literal>。还有，确认你的<literal>hibernate.current_session_context_class</literal>未设置（为了向下兼容），或者设置为<literal>"jta"</literal>。 + </para> + + <para> + <literal>getCurrentSession()</literal>在JTA环境中有一个弊端。对<literal>after_statement</literal>连接释放方式有一个警告，这是被默认使用的。因为JTA规范的一个很愚蠢的限制，Hibernate不可能自动清理任何未关闭的<literal>ScrollableResults</literal> 或者<literal>Iterator</literal>，它们是由<literal>scroll()</literal>或<literal>iterate()</literal>产生的。你<emphasis>must</emphasis>通过在<literal>finally</literal>块中，显式调用<literal>ScrollableResults.close()</literal>或者<literal>Hibernate.close(Iterator)</literal>方法来释放底层数据库游标。(当然，大部分程序完全可以很容易的避免在JTA或CMT代码中出现<literal>scroll()</literal>或<literal>iterate()</literal>。) + </para> + + + </sect2> + + + + <sect2 id="transactions-demarcation-exceptions"> + <title>异常处理</title> + <para> + 如果 <literal>Session</literal> 抛出异常 (包括任何<literal>SQLException</literal>), + 你应该立即回滚数据库事务，调用 <literal>Session.close()</literal> ，丢弃该 + <literal>Session</literal>实例。<literal>Session</literal>的某些方法可能会导致session + 处于不一致的状态。所有由Hibernate抛出的异常都视为不可以恢复的。确保在 + <literal>finally</literal> 代码块中调用<literal>close()</literal>方法，以关闭掉 + <literal>Session</literal>。 + </para> + <para> + <literal>HibernateException</literal>是一个非检查期异常（这不同于Hibernate老的版本）， + 它封装了Hibernate持久层可能出现的大多数错误。我们的观点是，不应该强迫应用程序开发人员 + 在底层捕获无法恢复的异常。在大多数软件系统中，非检查期异常和致命异常都是在相应方法调用 + 的堆栈的顶层被处理的（也就是说，在软件上面的逻辑层），并且提供一个错误信息给应用软件的用户 + （或者采取其他某些相应的操作）。请注意，Hibernate也有可能抛出其他并不属于 + <literal>HibernateException</literal>的非检查期异常。这些异常同样也是无法恢复的，应该 + 采取某些相应的操作去处理。 + </para> + <para> + 在和数据库进行交互时，Hibernate把捕获的<literal>SQLException</literal>封装为Hibernate的 + <literal>JDBCException</literal>。事实上，Hibernate尝试把异常转换为更有实际含义 + 的<literal>JDBCException</literal>异常的子类。底层的<literal>SQLException</literal>可以 + 通过<literal>JDBCException.getCause()</literal>来得到。Hibernate通过使用关联到 + <literal>SessionFactory</literal>上的<literal>SQLExceptionConverter</literal>来 + 把<literal>SQLException</literal>转换为一个对应的<literal>JDBCException</literal> + 异常的子类。默认情况下，<literal>SQLExceptionConverter</literal>可以通过配置dialect + 选项指定；此外，也可以使用用户自定义的实现类（参考javadocs + <literal>SQLExceptionConverterFactory</literal>类来了解详情）。标准的 + <literal>JDBCException</literal>子类型是： + </para> + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>JDBCConnectionException</literal> - 指明底层的JDBC通讯出现错误 + </para> + </listitem> + <listitem> + <para> + <literal>SQLGrammarException</literal> - 指明发送的SQL语句的语法或者格式错误 + </para> + </listitem> + <listitem> + <para> + <literal>ConstraintViolationException</literal> - 指明某种类型的约束违例错误 + </para> + </listitem> + <listitem> + <para> + <literal>LockAcquisitionException</literal> - 指明了在执行请求操作时，获取 + 所需的锁级别时出现的错误。 + + </para> + </listitem> + <listitem> + <para> + <literal>GenericJDBCException</literal> - 不属于任何其他种类的原生异常 + </para> + </listitem> + </itemizedlist> + + + </sect2> + + <sect2 id="transactions-demarcation-timeout"> + <title>事务超时</title> + + <para> + EJB这样的托管环境有一项极为重要的特性，而它从未在非托管环境中提供过，那就是事务超时。在出现错误的事务行为的时候，超时可以确保不会无限挂起资源、对用户没有交代。在托管(JTA)环境之外，Hibernate无法完全提供这一功能。但是，Hiberante至少可以控制数据访问，确保数据库级别的死锁，和返回巨大结果集的查询被限定在一个规定的时间内。在托管环境中，Hibernate会把事务超时转交给JTA。这一功能通过Hibernate <literal>Transaction</literal>对象进行抽象。 + </para> + + <programlisting><![CDATA[ +Session sess = factory.openSession(); +try { + //set transaction timeout to 3 seconds + sess.getTransaction().setTimeout(3); + sess.getTransaction().begin(); + + // do some work + ... + + sess.getTransaction().commit() +} +catch (RuntimeException e) { + sess.getTransaction().rollback(); + throw e; // or display error message +} +finally { + sess.close(); +}]]></programlisting> + + <para> + 注意<literal>setTimeout()</literal>不应该在CMT bean中调用，此时事务超时值应该是被声明式定义的。 + </para> + + </sect2> + </sect1> + + <sect1 id="transactions-optimistic"> + <title>乐观并发控制(Optimistic concurrency control)</title> + <para> + 唯一能够同时保持高并发和高可伸缩性的方法就是使用带版本化的乐观并发控制。版本检查使用版本号、 + 或者时间戳来检测更新冲突（并且防止更新丢失）。Hibernate为使用乐观并发控制的代码提供了三种可 + 能的方法，应用程序在编写这些代码时，可以采用它们。我们已经在前面应用程序对话那部分展示了 + 乐观并发控制的应用场景，此外，在单个数据库事务范围内，版本检查也提供了防止更新丢失的好处。 + </para> + + <sect2 id="transactions-optimistic-manual"> + <title>应用程序级别的版本检查(Application version checking)</title> + <para> + 未能充分利用Hibernate功能的实现代码中，每次和数据库交互都需要一个新的 + <literal>Session</literal>，而且开发人员必须在显示数据之前从数据库中重 + 新载入所有的持久化对象实例。这种方式迫使应用程序自己实现版本检查来确保 + 对话事务的隔离，从数据访问的角度来说是最低效的。这种使用方式和 + entity EJB最相似。 + </para> + + <programlisting><![CDATA[// foo is an instance loaded by a previous Session +session = factory.openSession(); +Transaction t = session.beginTransaction(); + +int oldVersion = foo.getVersion(); +session.load( foo, foo.getKey() ); // load the current state +if ( oldVersion != foo.getVersion() ) throw new StaleObjectStateException(); +foo.setProperty("bar"); + +t.commit(); +session.close();]]></programlisting> + + <para> + <literal>version</literal> 属性使用 <literal>&lt;version&gt;</literal>来映射，如果对象 + 是脏数据，在同步的时候，Hibernate会自动增加版本号。 + </para> + + <para> + 当然，如果你的应用是在一个低数据并发环境下，并不需要版本检查的话，你照样可以使用 + 这种方式，只不过跳过版本检查就是了。在这种情况下，<emphasis>最晚提交生效</emphasis> + （<emphasis>last commit wins</emphasis>）就是你的长对话的默认处理策略。 + 请记住这种策略可能会让应用软件的用户感到困惑，因为他们有可能会碰上更新丢失掉却没 + 有出错信息，或者需要合并更改冲突的情况。 + </para> + + <para> + 很明显，手工进行版本检查只适合于某些软件规模非常小的应用场景，对于大多数软件应用场景 + 来说并不现实。通常情况下，不仅是单个对象实例需要进行版本检查，整个被修改过的关 + 联对象图也都需要进行版本检查。作为标准设计范例，Hibernate使用扩展周期的 + <literal>Session</literal>的方式，或者脱管对象实例的方式来提供自动版本检查。 + </para> + + </sect2> + + <sect2 id="transactions-optimistic-longsession"> + <title>扩展周期的session和自动版本化</title> + <para> + 单个 <literal>Session</literal>实例和它所关联的所有持久化对象实例都被用于整个 + 对话，这被称为<emphasis>session-per-conversation</emphasis>。Hibernate在同步的时候进行对象实例的版本检查，如果检测到并发修 + 改则抛出异常。由开发人员来决定是否需要捕获和处理这个异常（通常的抉择是给用户 + 提供一个合并更改，或者在无脏数据情况下重新进行业务对话的机会）。 + </para> + <para> + 在等待用户交互的时候， <literal>Session</literal> 断开底层的JDBC连接。这种方式 + 以数据库访问的角度来说是最高效的方式。应用程序不需要关心版本检查或脱管对象实例 + 的重新关联，在每个数据库事务中，应用程序也不需要载入读取对象实例。 + </para> + + <programlisting><![CDATA[// foo is an instance loaded earlier by the old session +Transaction t = session.beginTransaction(); // Obtain a new JDBC connection, start transaction + +foo.setProperty("bar"); + +session.flush(); // Only for last transaction in conversation +t.commit(); // Also return JDBC connection +session.close(); // Only for last transaction in conversation]]></programlisting> + + <para> + <literal>foo</literal>对象知道它是在哪个<literal>Session</literal>中被装入的。在一个旧session中开启一个新的数据库事务，会导致session获取一个新的连接，并恢复session的功能。将数据库事务提交，使得session从JDBC连接断开，并将此连接交还给连接池。在重新连接之后，要强制对你没有更新的数据进行一次版本检查，你可以对所有可能被其他事务修改过的对象，使用参数<literal>LockMode.READ</literal>来调用<literal>Session.lock()</literal>。你不用lock任何你<emphasis>正在</emphasis>更新的数据。一般你会在扩展的<literal>Session</literal>上设置<literal>FlushMode.MANUAL</literal>，因此只有最后一个数据库事务循环才会真正的吧整个对话中发生的修改发送到数据库。因此，只有这最后一次数据库事务才会包含<literal>flush()</literal>操作，然后在整个对话结束后，还要<litera! l>close()</literal>这个session。 + </para> + + <para> + 如果在用户思考的过程中，<literal>Session</literal>因为太大了而不能保存，那么这种模式是有 + 问题的。举例来说，一个<literal>HttpSession</literal>应该尽可能的小。由于 + <literal>Session</literal>是一级缓存，并且保持了所有被载入过的对象，因此 + 我们只应该在那些少量的request/response情况下使用这种策略。你应该只把一个<literal>Session</literal>用于单个对话，因为它很快就会出现脏数据。 + </para> + + <para> + （注意，早期的Hibernate版本需要明确的对<literal>Session</literal>进行disconnec和reconnect。这些方法现在已经过时了，打开事务和关闭事务会起到同样的效果。） + </para> + + + <para> + 此外，也请注意，你应该让与数据库连接断开的<literal>Session</literal>对持久层保持 + 关闭状态。换句话说，在三层环境中，使用有状态的EJB session bean来持有<literal>Session</literal>， + 而不要把它传递到web层（甚至把它序列化到一个单独的层），保存在<literal>HttpSession</literal>中。 + </para> + + <para> + 扩展session模式，或者被称为<emphasis>每次对话一个session(session-per-conversation)</emphasis>, 在与自动管理当前session上下文联用的时候会更困难。你需要提供你自己的<literal>CurrentSessionContext</literal>实现。请参阅Hibernate Wiki以获得示例。 + </para> + + + </sect2> + + <sect2 id="transactions-optimistic-detached"> + <title>脱管对象(deatched object)和自动版本化</title> + + <para> + 这种方式下，与持久化存储的每次交互都发生在一个新的<literal>Session</literal>中。 + 然而，同一持久化对象实例可以在多次与数据库的交互中重用。应用程序操纵脱管对象实例 + 的状态，这个脱管对象实例最初是在另一个<literal>Session</literal> 中载入的，然后 + 调用 <literal>Session.update()</literal>，<literal>Session.saveOrUpdate()</literal>, 或者 + <literal>Session.merge()</literal> 来重新关联该对象实例。 + </para> + + <programlisting><![CDATA[// foo is an instance loaded by a previous Session +foo.setProperty("bar"); +session = factory.openSession(); +Transaction t = session.beginTransaction(); +session.saveOrUpdate(foo); // Use merge() if "foo" might have been loaded already +t.commit(); +session.close();]]></programlisting> + + <para> + Hibernate会再一次在同步的时候检查对象实例的版本，如果发生更新冲突，就抛出异常。 + </para> + + <para> + 如果你确信对象没有被修改过，你也可以调用<literal>lock()</literal> 来设置 + <literal>LockMode.READ</literal>（绕过所有的缓存，执行版本检查），从而取 + 代 <literal>update()</literal>操作。 + </para> + + </sect2> + + <sect2 id="transactions-optimistic-customizing"> + <title>定制自动版本化行为</title> + <para> + 对于特定的属性和集合，通过为它们设置映射属性<literal>optimistic-lock</literal>的值 + 为<literal>false</literal>，来禁止Hibernate的版本自动增加。这样的话，如果该属性 + 脏数据，Hibernate将不再增加版本号。 + </para> + + <para> + 遗留系统的数据库Schema通常是静态的，不可修改的。或者，其他应用程序也可能访问同一数据 + 库，根本无法得知如何处理版本号，甚至时间戳。在以上的所有场景中，实现版本化不能依靠 + 数据库表的某个特定列。在<literal>&lt;class&gt;</literal>的映射中设置 + <literal>optimistic-lock="all"</literal>可以在没有版本或者时间戳属性映射的情况下实现 + 版本检查，此时Hibernate将比较一行记录的每个字段的状态。请注意，只有当Hibernate能够比 + 较新旧状态的情况下，这种方式才能生效，也就是说， + 你必须使用单个长生命周期<literal>Session</literal>模式，而不能使用 + session-per-request-with-detached-objects模式。 + </para> + + <para> + 有些情况下，只要更改不发生交错，并发修改也是允许的。当你在<literal>&lt;class&gt;</literal> + 的映射中设置<literal>optimistic-lock="dirty"</literal>，Hibernate在同步的时候将只比较有脏 + 数据的字段。 + </para> + + <para> + 在以上所有场景中，不管是专门设置一个版本/时间戳列，还是进行全部字段/脏数据字段比较， + Hibernate都会针对每个实体对象发送一条<literal>UPDATE</literal>（带有相应的 + <literal>WHERE</literal>语句 ）的SQL语句来执行版本检查和数据更新。如果你对关联实体 + 设置级联关系使用传播性持久化（transitive persistence），那么Hibernate可能会执行不必 + 要的update语句。这通常不是个问题，但是数据库里面对<emphasis>on update</emphasis>点火 + 的触发器可能在脱管对象没有任何更改的情况下被触发。因此，你可以在 + <literal>&lt;class&gt;</literal>的映射中，通过设置<literal>select-before-update="true"</literal> + 来定制这一行为，强制Hibernate <literal>SELECT</literal>这个对象实例，从而保证， + 在更新记录之前，对象的确是被修改过。 + </para> + + </sect2> + + </sect1> + + <sect1 id="transactions-locking"> + <title>悲观锁定(Pessimistic Locking)</title> + <para> + 用户其实并不需要花很多精力去担心锁定策略的问题。通常情况下，只要为JDBC连接指定一下隔 + 离级别，然后让数据库去搞定一切就够了。然而，高级用户有时候希望进行一个排它的悲观锁定， + 或者在一个新的事务启动的时候，重新进行锁定。 + </para> + + <para> + Hibernate总是使用数据库的锁定机制，从不在内存中锁定对象！ + </para> + + <para> + 类<literal>LockMode</literal> 定义了Hibernate所需的不同的锁定级别。一个锁定 + 可以通过以下的机制来设置: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + 当Hibernate更新或者插入一行记录的时候，锁定级别自动设置为<literal>LockMode.WRITE</literal>。 + </para> + </listitem> + <listitem> + <para> + 当用户显式的使用数据库支持的SQL格式<literal>SELECT ... FOR UPDATE</literal> + 发送SQL的时候，锁定级别设置为<literal>LockMode.UPGRADE</literal> + </para> + </listitem> + <listitem> + <para> + 当用户显式的使用Oracle数据库的SQL语句<literal>SELECT ... FOR UPDATE NOWAIT</literal> + 的时候，锁定级别设置<literal>LockMode.UPGRADE_NOWAIT</literal> + </para> + </listitem> + <listitem> + <para> + 当Hibernate在“可重复读”或者是“序列化”数据库隔离级别下读取数据的时候，锁定模式 + 自动设置为<literal>LockMode.READ</literal>。这种模式也可以通过用户显式指定进行设置。 + </para> + </listitem> + <listitem> + <para> + <literal>LockMode.NONE</literal> 代表无需锁定。在<literal>Transaction</literal>结束时， + 所有的对象都切换到该模式上来。与session相关联的对象通过调用<literal>update()</literal> + 或者<literal>saveOrUpdate()</literal>脱离该模式。 + </para> + </listitem> + </itemizedlist> + + <para> + "显式的用户指定"可以通过以下几种方式之一来表示: + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + 调用 <literal>Session.load()</literal>的时候指定<literal>锁定模式(LockMode)</literal>。 + </para> + </listitem> + <listitem> + <para> + 调用<literal>Session.lock()</literal>。 + </para> + </listitem> + <listitem> + <para> + 调用<literal>Query.setLockMode()</literal>。 + </para> + </listitem> + </itemizedlist> + + <para> + 如果在<literal>UPGRADE</literal>或者<literal>UPGRADE_NOWAIT</literal>锁定模式下调 + 用<literal>Session.load()</literal>，并且要读取的对象尚未被session载入过，那么对象 + 通过<literal>SELECT ... FOR UPDATE</literal>这样的SQL语句被载入。如果为一个对象调用 + <literal>load()</literal>方法时，该对象已经在另一个较少限制的锁定模式下被载入了，那 + 么Hibernate就对该对象调用<literal>lock()</literal> 方法。 + </para> + + <para> + 如果指定的锁定模式是<literal>READ</literal>, <literal>UPGRADE</literal> 或 + <literal>UPGRADE_NOWAIT</literal>，那么<literal>Session.lock()</literal>就 + 执行版本号检查。（在<literal>UPGRADE</literal> 或者<literal>UPGRADE_NOWAIT</literal> + 锁定模式下，执行<literal>SELECT ... FOR UPDATE</literal>这样的SQL语句。） + </para> + + <para> + 如果数据库不支持用户设置的锁定模式，Hibernate将使用适当的替代模式（而不是扔出异常）。 + 这一点可以确保应用程序的可移植性。 + </para> + </sect1> + <sect1 id="transactions-connection-release"> + <title>连接释放模式(Connection Release Modes)</title> + + <para> + Hibernate关于JDBC连接管理的旧(2.x)行为是，<literal>Session</literal>在第一次需要的时候获取一个连接，在session关闭之前一直会持有这个连接。Hibernate引入了连接释放的概念，来告诉session如何处理它的JDBC连接。注意，下面的讨论只适用于采用配置<literal>ConnectionProvider</literal>来提供连接的情况，用户自己提供的连接与这里的讨论无关。通过<literal>org.hibernate.ConnectionReleaseMode</literal>的不同枚举值来使用不用的释放模式: + + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>ON_CLOSE</literal> - 基本上就是上面提到的老式行为。Hibernate session在第一次需要进行JDBC操作的时候获取连接，然后持有它，直到session关闭。 + </para> + </listitem> + <listitem> + <para> + <literal>AFTER_TRANSACTION</literal> - 在<literal>org.hibernate.Transaction</literal>结束后释放连接。 + </para> + </listitem> + <listitem> + <para> + <literal>AFTER_STATEMENT</literal> (也被称做积极释放) - 在每一条语句被执行后就释放连接。但假若语句留下了与session相关的资源，那就不会被释放。目前唯一的这种情形就是使用<literal>org.hibernate.ScrollableResults</literal>。 + </para> + </listitem> + </itemizedlist> + + <para> + <literal>hibernate.connection.release_mode</literal>配置参数用来指定使用哪一种释放模式。可能的值有： + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para> + <literal>auto</literal>(默认) - 这一选择把释放模式委派给<literal>org.hibernate.transaction.TransactionFactory.getDefaultReleaseMode()</literal>方法。对JTATransactionFactory来说，它会返回ConnectionReleaseMode.AFTER_STATEMENT;对JDBCTransactionFactory来说，则是ConnectionReleaseMode.AFTER_TRANSACTION。很少需要修改这一默认行为，因为假若设置不当，就会带来bug，或者给用户代码带来误导。 + </para> + </listitem> + <listitem> + <para> + <literal>on_close</literal> - 使用 ConnectionReleaseMode.ON_CLOSE. 这种方式是为了向下兼容的,但是已经完全不被鼓励使用了。 + </para> + </listitem> + <listitem> + <para> + <literal>after_transaction</literal> - 使用ConnectionReleaseMode.AFTER_TRANSACTION。这一设置不应该在JTA环境下使用。也要注意，使用ConnectionReleaseMode.AFTER_TRANSACTION的时候，假若session 处于auto-commit状态，连接会像AFTER_STATEMENT那样被释放。 + </para> + </listitem> + <listitem> + <para> + <literal>after_statement</literal> - 使用ConnectionReleaseMode.AFTER_STATEMENT。除此之外，会查询配置的<literal>ConnectionProvider</literal>，是否它支持这一设置（(<literal>supportsAggressiveRelease()</literal>)）。假若不支持，释放模式会被设置为ConnectionReleaseMode.AFTER_TRANSACTION。只有在你每次调用<literal>ConnectionProvider.getConnection()</literal>获取底层JDBC连接的时候，都可以确信获得同一个连接的时候，这一设置才是安全的；或者在auto-commit环境中，你可以不管是否每次都获得同一个连接的时候，这才是安全的。 + + </para> + </listitem> + </itemizedlist> + + </sect1> + +</chapter> + Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/tutorial.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/tutorial.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/tutorial.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/tutorial.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,1233 @@ +<chapter id="tutorial"> + <title> + Hibernate入门 + </title> + <sect1 id="tutorial-intro" revision="1"> + <title> + 前言 + </title> + + <para> + 本章是面向Hibernate初学者的一个入门教程。我们从一个使用驻留内存式(in-memory)数据库的简单命令行应用程序开始, 用易于理解的方式逐步开发。 + + </para> + + <para> + 本章面向Hibernate初学者，但需要Java和SQL知识。它是在Michael Goegl所写的指南的基础上完成的。在这里，我们称第三方库文件是指JDK 1.4和5.0。若使用JDK1.3，你可能需要其它的库文件。 + </para> + + <para> + 本章的源代码已包含在发布包中，位于<literal>doc/reference/tutorial/</literal>目录下。 + </para> + + </sect1> + + <sect1 id="tutorial-firstapp" revision="2"> + <title> + 第一部分 － 第一个Hibernate应用程序 + </title> + <para> + 首先我们将创建一个简单的基于控制台的(console-based)Hibernate应用程序。由于我们使用Java数据库(HSQL DB)，所以不必安装任何数据库服务器。 + </para> + + <para> + 假设我们希望有一个小应用程序可以保存我们希望参加的活动（events）和这些活动主办方的相关信息。 + （译者注：在本教程的后面部分，我们将直接使用event而不是它的中文翻译“活动”，以免混淆。） + </para> + + <para> + 我们所做的第一件事就是创建我们的开发目录，并且把所有需要用到的Java库文件放进去。解压缩从Hibernate网站下载的Hibernate发布包，并把<literal>/lib</literal>目录下所有需要的库文件拷到我们新建开发目录下的<literal>/lib</literal>目录下。看起来就像这样： + </para> + + <programlisting><![CDATA[. ++lib + antlr.jar + cglib.jar + asm.jar + asm-attrs.jars + commons-collections.jar + commons-logging.jar + ehcache.jar + hibernate3.jar + jta.jar + dom4j.jar + log4j.jar ]]></programlisting> + + <para> + <emphasis>到编写本文时为止</emphasis>，这些是Hibernate运行所需要的最小库文件集合（注意我们也拷贝了 Hibernate3.jar，这个是最主要的文件）。你正使用的Hibernate版本可能需要比这更多或少一些的库文件。请参见发布包中的<literal>lib/</literal>目录下的<literal>README.txt</literal>，以获取更多关于所需和可选的第三方库文件信息（事实上，Log4j并不是必须的库文件，但被许多开发者所喜欢）。 + + </para> + + <para> + 接下来我们创建一个类，用来代表那些我们希望储存在数据库里的event。 + </para> + + <sect2 id="tutorial-firstapp-firstclass" revision="1"> + <title> + 第一个class + </title> + + <para> + 我们的第一个持久化类是一个带有一些属性（property）的简单JavaBean类： + </para> + + <programlisting><![CDATA[package events; + +import java.util.Date; + +public class Event { + private Long id; + + private String title; + private Date date; + + public Event() {} + + public Long getId() { + return id; + } + + private void setId(Long id) { + this.id = id; + } + + public Date getDate() { + return date; + } + + public void setDate(Date date) { + this.date = date; + } + + public String getTitle() { + return title; + } + + public void setTitle(String title) { + this.title = title; + } +}]]></programlisting> + + <para> + 你可以看到这个类对属性的存取方法（getter and setter method）使用了标准JavaBean命名约定，同时把类属性（field）的访问级别设成私有的（private）。这是推荐的设计，但并不是必须的。Hibernate也可以直接访问这些field，而使用访问方法（accessor method）的好处是提供了重构时的健壮性（robustness）。为了通过反射机制（Reflection）来实例化这个类的对象，我们需要提供一个无参的构造器（no-argument constructor)。 + </para> + + <para> + 对一特定的event, <literal>id</literal> 属性持有唯一的标识符（identifier）的值。如果我们希望使用Hibernate提供的所有特性，那么所有的持久化实体（persistent entity）类（这里也包括一些次要依赖类）都需要一个这样的标识符属性。而事实上，大多数应用程序（特别是web应用程序）都需要通过标识符来区别对象，所以你应该考虑使用标识符属性而不是把它当作一种限制。然而，我们通常不会操作对象的标识（identity），因此它的setter方法的访问级别应该声明private。这样当对象被保存的时候，只有Hibernate可以为它分配标识符值。你可看到Hibernate可以直接访问public，private和protected的访问方法和field。所以选择哪种方式完全取决于你，你可以使你的选择与你的应用程序设计相吻合。 + </para> + + <para> + 所有的持久化类（persistent classes）都要求有无参的构造器，因为Hibernate必须使用Java反射机制来为你创建对象。构造器（constructor）的访问级别可以是private，然而当生成运行时代理（runtime proxy）的时候则要求使用至少是package 级别的访问控制，这样在没有字节码指令（bytecode instrumentation）的情况下，从持久化类里获取数据会更有效率。 + </para> + + <para> + 把这个Java源代码文件放到开发目录下的<literal>src</literal>目录里，注意包位置要正确。 现在这个目录看起来应该像这样： + </para> + + <programlisting><![CDATA[. ++lib + <Hibernate and third-party libraries> ++src + +events + Event.java]]></programlisting> + + <para> + 下一步，我们把这个持久化类的信息告诉Hibernate。 + </para> + + </sect2> + + <sect2 id="tutorial-firstapp-mapping" revision="1"> + <title> + 映射文件 + </title> + + <para> + Hibernate需要知道怎样去加载（load）和存储（store）持久化类的对象。这正是Hibernate映射文件发挥作用的地方。映射文件告诉Hibernate它，应该访问数据库(database)里面的哪个表（table）及应该使用表里面的哪些字段（column）。 + + </para> + + <para> + 一个映射文件的基本结构看起来像这样： + </para> + + <programlisting><![CDATA[<?xml version="1.0"?> +<!DOCTYPE hibernate-mapping PUBLIC + "-//Hibernate/Hibernate Mapping DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> + +<hibernate-mapping> +[...] +</hibernate-mapping>]]></programlisting> + + <para> + 注意Hibernate的DTD是非常复杂的。你的编辑器或者IDE里使用它来自动完成那些用来映射的XML元素（element）和属性（attribute）。你也可以在文本编辑器里打开DTD－这是最简单的方式来概览所有的元素和attribute，并查看它们的缺省值以及注释。注意Hibernate不会从web加载DTD文件，但它会首先在应用程序的classpath中查找。DTD文件已包括在<literal>hibernate3.jar</literal>里，同时也在Hibernate发布包的<literal>src/</literal>目录下。 + </para> + + <para> + 为缩短代码长度，在以后的例子里我们会省略DTD的声明。当然，在实际的应用程序中，DTD声明是必须的。 + </para> + + <para> + 在<literal>hibernate-mapping</literal>标签（tag）之间, 含有一个<literal>class</literal>元素。所有的持久化实体类（再次声明，或许接下来会有依赖类，就是那些次要的实体）都需要一个这样的映射，来把类对象映射到SQL数据库里的表。 + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="events.Event" table="EVENTS"> + + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + 到目前为止，我们告诉了Hibernate怎样把<literal>Events</literal>类的对象持久化到数据库的<literal>EVENTS</literal>表里，以及怎样从<literal>EVENTS</literal>表加载到<literal>Events</literal>类的对象。每个实例对应着数据库表中的一行。现在我们将继续讨论有关唯一标识符属性到数据库表的映射。另外，由于我们不关心怎样处理这个标识符，我们就配置由Hibernate的标识符生成策略来产生代理主键字段。 + + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="events.Event" table="EVENTS"> + <id name="id" column="EVENT_ID"> + <generator class="native"/> + </id> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + <literal>id</literal>元素是标识符属性的声明，<literal>name="id"</literal> 声明了Java属性的名字 － Hibernate会使用<literal>getId()</literal>和<literal>setId()</literal>来访问它。 <literal>column</literal>属性则告诉Hibernate, 我们使用<literal>EVENTS</literal>表的哪个字段作为主键。嵌套的<literal>generator</literal>元素指定了标识符生成策略，在这里我们指定<literal>native</literal>，它根据已配置的数据库（方言）自动选择最佳的标识符生成策略。Hibernate支持由数据库生成，全局唯一性（globally unique）和应用程序指定（或者你自己为任何已有策略所写的扩展）这些策略来生成标识符。 + </para> + + <para> + 最后我们在映射文件里面包含需要持久化属性的声明。默认情况下，类里面的属性都被视为非持久化的： + </para> + + <programlisting><![CDATA[ +<hibernate-mapping> + + <class name="events.Event" table="EVENTS"> + <id name="id" column="EVENT_ID"> + <generator class="native"/> + </id> + <property name="date" type="timestamp" column="EVENT_DATE"/> + <property name="title"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + 和<literal>id</literal>元素一样，<literal>property</literal>元素的<literal>name</literal>属性告诉Hibernate使用哪个getter和setter方法。在此例中，Hibernate会寻找<literal>getDate()/setDate()</literal>, 以及<literal>getTitle()/setTitle()</literal>。 + </para> + + <para> + 为什么<literal>date</literal>属性的映射含有<literal>column</literal> attribute，而<literal>title</literal>却没有？当没有设定<literal>column</literal> attribute 的时候，Hibernate缺省地使用JavaBean的属性名作为字段名。对于<literal>title</literal>，这样工作得很好。然而，<literal>date</literal>在多数的数据库里，是一个保留关键字，所以我们最好把它映射成一个不同的名字。 + + </para> + + <para> + 另一有趣的事情是<literal>title</literal>属性缺少一个<literal>type</literal> attribute。我们在映射文件里声明并使用的类型，却不是我们期望的那样，是Java数据类型，同时也不是SQL数据库的数据类型。这些类型就是所谓的Hibernate 映射类型<emphasis>（mapping types）</emphasis>，它们能把Java数据类型转换到SQL数据类型，反之亦然。再次重申，如果在映射文件中没有设置<literal>type</literal>属性的话，Hibernate会自己试着去确定正确的转换类型和它的映射类型。在某些情况下这个自动检测机制（在Java 类上使用反射机制）不会产生你所期待或需要的缺省值。<literal>date</literal>属性就是个很好的例子，Hibernate无法知道这个属性（<literal>java.util.Date</literal>类型的）应该被映射成：SQL <literal>date</literal>，或<literal>timestamp</literal>，还是<literal>time</literal> 字段。在此例中�! �把这个属性映射成<literal>timestamp</literal> 转换器，这样我们预留了日期和时间的全部信息。 + </para> + + <para> + 应该把这个映射文件保存为<literal>Event.hbm.xml</literal>，且就在<literal>Event</literal>Java类的源文件目录下。映射文件可随意地命名，但<literal>hbm.xml</literal>的后缀已成为Hibernate开发者社区的约定。现在目录结构看起来应该像这样： + </para> + + <programlisting><![CDATA[. ++lib + <Hibernate and third-party libraries> ++src + +events + Event.java + Event.hbm.xml]]></programlisting> + + <para> + 我们继续进行Hibernate的主要配置。 + </para> + + </sect2> + + <sect2 id="tutorial-firstapp-configuration" revision="2"> + <title> + Hibernate配置 + </title> + + <para> + 现在我们已经有了一个持久化类和它的映射文件，该是配置Hibernate的时候了。在此之前，我们需要一个数据库。 HSQL DB是种基于Java 的SQL数据库管理系统（DBMS），可以从HSQL DB的网站上下载。实际上，你只需下载的包中的<literal>hsqldb.jar</literal>文件，并把这个文件放在开发文件夹的<literal>lib/</literal>目录下即可。 + + </para> + + <para> + 在开发的根目录下创建一个<literal>data</literal>目录 － 这是HSQL DB存储数据文件的地方。此时在data目录中运行<literal>java -classpath ../lib/hsqldb.jar org.hsqldb.Server</literal>就可启动数据库。你可以在log中看到它的启动，及绑定到TCP/IP套结字，这正是我们的应用程序稍后会连接的地方。如果你希望在本例中运行一个全新的数据库，就在窗口中按下<literal>CTRL + C</literal>来关闭HSQL数据库，并删除<literal>data/</literal>目录下的所有文件，再重新启动HSQL数据库。 + </para> + + <para> + Hibernate是你的应用程序里连接数据库的那层，所以它需要连接用的信息。连接（connection）是通过一个也由我们配置的JDBC连接池（connection pool）来完成的。Hibernate的发布包里包含了许多开源的（open source）连接池，但在我们例子中使用Hibernate内置的连接池。注意，如果你希望使用一个产品级(production-quality)的第三方连接池软件，你必须拷贝所需的库文件到你的classpath下，并使用不同的连接池设置。 + </para> + + <para> + 为了保存Hibernate的配置，我们可以使用一个简单的<literal>hibernate.properties</literal>文件，或者一个稍微复杂的<literal>hibernate.cfg.xml</literal>，甚至可以完全使用程序来配置Hibernate。多数用户更喜欢使用XML配置文件： + </para> + + <programlisting><![CDATA[<?xml version='1.0' encoding='utf-8'?> +<!DOCTYPE hibernate-configuration PUBLIC + "-//Hibernate/Hibernate Configuration DTD 3.0//EN" + "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"> + +<hibernate-configuration> + + <session-factory> + + <!-- Database connection settings --> + <property name="connection.driver_class">org.hsqldb.jdbcDriver</property> + <property name="connection.url">jdbc:hsqldb:hsql://localhost</property> + <property name="connection.username">sa</property> + <property name="connection.password"></property> + + <!-- JDBC connection pool (use the built-in) --> + <property name="connection.pool_size">1</property> + + <!-- SQL dialect --> + <property name="dialect">org.hibernate.dialect.HSQLDialect</property> + + <!-- Enable Hibernate's automatic session context management --> + <property name="current_session_context_class">thread</property> + + <!-- Disable the second-level cache --> + <property name="cache.provider_class">org.hibernate.cache.NoCacheProvider</property> + + <!-- Echo all executed SQL to stdout --> + <property name="show_sql">true</property> + + <!-- Drop and re-create the database schema on startup --> + <property name="hbm2ddl.auto">create</property> + + <mapping resource="events/Event.hbm.xml"/> + + </session-factory> + +</hibernate-configuration>]]></programlisting> + + <para> + 注意这个XML配置使用了一个不同的DTD。在这里，我们配置了Hibernate的<literal>SessionFactory</literal>－一个关联于特定数据库全局的工厂（factory）。如果你要使用多个数据库，就要用多个的<literal>&lt;session-factory&gt;</literal>，通常把它们放在多个配置文件中（为了更容易启动）。 + </para> + + <para> + 最开始的4个<literal>property</literal>元素包含必要的JDBC连接信息。方言（dialect）的<literal>property</literal>元素指明Hibernate 生成的特定SQL变量。你很快会看到，Hibernate对持久化上下文的自动session管理就会派上用场。 打开<literal>hbm2ddl.auto</literal>选项将自动生成数据库模式（schema）－ 直接加入数据库中。当然这个选项也可以被关闭（通过去除这个配置选项）或者通过Ant任务<literal>SchemaExport</literal>的帮助来把数据库schema重定向到文件中。最后，在配置中为持久化类加入映射文件。 + </para> + + <para> + 把这个文件拷贝到源代码目录下面，这样它就位于classpath的根目录的最后。Hibernate在启动时会自动在classpath的根目录查找名为<literal>hibernate.cfg.xml</literal>的配置文件。 + </para> + + </sect2> + + <sect2 id="tutorial-firstapp-ant" revision="1"> + <title> + 用Ant构建 + </title> + + <para> + 现在我们用Ant来构建应用程序。你必须先安装Ant－可以从<ulink url="http://ant.apache.org/bindownload.cgi">Ant 下载页面</ulink>得到它。怎样安装Ant就不在这里介绍了，请参考<ulink url="http://ant.apache.org/manual/index.html">Ant 用户手册</ulink>。当你安装完了Ant，就可以开始创建<literal>build.xml</literal>文件，把它直接放在开发目录下面。 + </para> + <para> + 一个简单的build文件看起来像这样： + </para> + + <programlisting><![CDATA[<project name="hibernate-tutorial" default="compile"> + + <property name="sourcedir" value="${basedir}/src"/> + <property name="targetdir" value="${basedir}/bin"/> + <property name="librarydir" value="${basedir}/lib"/> + + <path id="libraries"> + <fileset dir="${librarydir}"> + <include name="*.jar"/> + </fileset> + </path> + + <target name="clean"> + <delete dir="${targetdir}"/> + <mkdir dir="${targetdir}"/> + </target> + + <target name="compile" depends="clean, copy-resources"> + <javac srcdir="${sourcedir}" + destdir="${targetdir}" + classpathref="libraries"/> + </target> + + <target name="copy-resources"> + <copy todir="${targetdir}"> + <fileset dir="${sourcedir}"> + <exclude name="**/*.java"/> + </fileset> + </copy> + </target> + +</project>]]></programlisting> + + <para> + 这将告诉Ant把所有在lib目录下以<literal>.jar</literal>结尾的文件拷贝到classpath中以供编译之用。它也把所有的非Java源代码文件，例如配置和Hibernate映射文件，拷贝到目标目录。如果你现在运行Ant，会得到以下输出： + </para> + + <programlisting><![CDATA[C:\hibernateTutorial\>ant +Buildfile: build.xml + +copy-resources: + [copy] Copying 2 files to C:\hibernateTutorial\bin + +compile: + [javac] Compiling 1 source file to C:\hibernateTutorial\bin + +BUILD SUCCESSFUL +Total time: 1 second ]]></programlisting> + + </sect2> + + <sect2 id="tutorial-firstapp-helpers" revision="3"> + <title> + 启动和辅助类 + </title> + + + <para> + 是时候来加载和储存一些<literal>Event</literal>对象了，但首先我们得编写一些基础的代码以完成设置。我们必须启动Hibernate，此过程包括创建一个全局的<literal>SessoinFactory</literal>，并把它储存在应用程序代码容易访问的地方。<literal>SessionFactory</literal>可以创建并打开新的<literal>Session</literal>。一个<literal>Session</literal>代表一个单线程的单元操作，<literal>SessionFactory</literal>则是个线程安全的全局对象，只需要被实例化一次。 + </para> + + <para> + 我们将创建一个<literal>HibernateUtil</literal>辅助类（helper class）来负责启动Hibernate和更方便地操作<literal>SessionFactory</literal>。让我们来看一下它的实现： + </para> + + <programlisting><![CDATA[package util; + +import org.hibernate.*; +import org.hibernate.cfg.*; + +public class HibernateUtil { + + private static final SessionFactory sessionFactory; + + static { + try { + // Create the SessionFactory from hibernate.cfg.xml + sessionFactory = new Configuration().configure().buildSessionFactory(); + } catch (Throwable ex) { + // Make sure you log the exception, as it might be swallowed + System.err.println("Initial SessionFactory creation failed." + ex); + throw new ExceptionInInitializerError(ex); + } + } + + public static SessionFactory getSessionFactory() { + return sessionFactory; + } + +}]]></programlisting> + + + <para> + 这个类不但在它的静态初始化过程（仅当加载这个类的时候被JVM执行一次）中产生全局的<literal>SessionFactory</literal>，而且隐藏了它使用了静态singleton的事实。它也可能在应用程序服务器中的JNDI查找<literal>SessionFactory</literal>。 + </para> + + <para> + 如果你在配置文件中给<literal>SessionFactory</literal>一个名字，在<literal>SessionFactory</literal>创建后，Hibernate会试着把它绑定到JNDI。要完全避免这样的代码，你也可以使用JMX部署，让具有JMX能力的容器来实例化<literal>HibernateService</literal>并把它绑定到JNDI。这些高级可选项在后面的章节中会讨论到。 + </para> + + <para> + 把<literal>HibernateUtil.java</literal>放在开发目录的源代码路径下，与放<literal>events</literal>的包并列： + </para> + + <programlisting><![CDATA[. ++lib + <Hibernate and third-party libraries> ++src + +events + Event.java + Event.hbm.xml + +util + HibernateUtil.java + hibernate.cfg.xml ++data +build.xml]]></programlisting> + + + <para> + 再次编译这个应用程序应该不会有问题。最后我们需要配置一个日志（logging)系统 － Hibernate使用通用日志接口，允许你在Log4j和JDK 1.4 日志之间进行选择。多数开发者更喜欢Log4j：从Hibernate的发布包中（它在<literal>etc/</literal>目录下）拷贝<literal>log4j.properties</literal>到你的<literal>src</literal>目录，与<literal>hibernate.cfg.xml</literal>.放在一起。看一下配置示例，如果你希望看到更加详细的输出信息，你可以修改配置。默认情况下，只有Hibernate的启动信息才会显示在标准输出上。 + </para> + + <para> + 示例的基本框架完成了 － 现在我们可以用Hibernate来做些真正的工作。 + </para> + + </sect2> + + <sect2 id="tutorial-firstapp-workingpersistence" revision="5"> + <title> + 加载并存储对象 + </title> + + <para> + 我们终于可以使用Hibernate来加载和存储对象了，编写一个带有<literal>main()</literal>方法的<literal>EventManager</literal>类： + + </para> + + <programlisting><![CDATA[package events; +import org.hibernate.Session; + +import java.util.Date; + +import util.HibernateUtil; + +public class EventManager { + + public static void main(String[] args) { + EventManager mgr = new EventManager(); + + if (args[0].equals("store")) { + mgr.createAndStoreEvent("My Event", new Date()); + } + + HibernateUtil.getSessionFactory().close(); + } + + private void createAndStoreEvent(String title, Date theDate) { + + Session session = HibernateUtil.getSessionFactory().getCurrentSession(); + + session.beginTransaction(); + + Event theEvent = new Event(); + theEvent.setTitle(title); + theEvent.setDate(theDate); + + session.save(theEvent); + + session.getTransaction().commit(); + } + +}]]></programlisting> + + + <para> + 我们创建了个新的<literal>Event</literal>对象并把它传递给Hibernate。现在Hibernate负责与SQL打交道，并把<literal>INSERT</literal>命令传给数据库。在运行之前，让我们看一下处理<literal>Session</literal>和<literal>Transaction</literal>的代码。 + + </para> + <para> + 一个<literal>Session</literal>就是个单一的工作单元。我们暂时让事情简单一些，并假设Hibernate<literal>Session</literal>和数据库事务是一一对应的。为了让我们的代码从底层的事务系统中脱离出来（此例中是JDBC，但也可能是JTA），我们使用Hibernate <literal>Session</literal>中的<literal>Transaction</literal> API。 + </para> + + <para> + <literal>sessionFactory.getCurrentSession()</literal>是干什么的呢？首先，只要你持有<literal>SessionFactory</literal>（幸亏我们有<literal>HibernateUtil</literal>，可以随时获得），大可在任何时候、任何地点调用这个方法。<literal>getCurrentSession()</literal>方法总会返回“当前的”工作单元。记得我们在<literal>hibernate.cfg.xml</literal>中把这一配置选项调整为"thread"了吗？因此，因此，当前工作单元被绑定到当前执行我们应用程序的Java线程。但是，这并非是完全准确的,你还得考虑工作单元的生命周期范围 (scope),它何时开始,又何时结束. + </para> + + <para> + <literal>Session</literal>在第一次被使用的时候,即第一次调用<literal>getCurrentSession()</literal>的时候,其生命周期就开始。然后它被Hibernate绑定到当前线程。当事务结束的时候，不管是提交还是回滚，Hibernate会自动把<literal>Session</literal>从当前线程剥离，并且关闭它。假若你再次调用<literal>getCurrentSession()</literal>，你会得到一个新的<literal>Session</literal>，并且开始一个新的工作单元。这种<emphasis>线程绑定(thread-bound)</emphasis>的编程模型（model）是使用Hibernate的最广泛的方式,因为它支持对你的代码灵活分层(事务划分可以和你的数据访问代码分离开来,在本教程的后面部分就会这么做)。 + + </para> + + <para> + + 和工作单元的生命周期这个话题相关，Hibernate <literal>Session</literal>是否被应该用来执行多次数据库操作？上面的例子对每一次操作使用了一个<literal>Session</literal>，这完全是巧合，这个例子不是很复杂，无法展示其他方式。Hibernate <literal>Session</literal>的生命周期可以很灵活，但是你绝不要把你的应用程序设计成为<emphasis>每一次</emphasis>数据库操作都用一个新的Hibernate <literal>Session</literal>。因此就算下面的例子（它们都很简单）中你可以看到这种用法，记住<emphasis>每次操作一个session</emphasis>是一个反模式。在本教程的后面会展示一个真正的(web)程序。 + </para> + + + + <para> + 关于事务处理及事务边界界定的详细信息，请参看<xref linkend="transactions"/>。在上面的例子中，我们也忽略了所有的错误与回滚的处理。 + </para> + + <para> + 为第一次运行我们的程序，我们得在Ant的build文件中增加一个可以调用得到的target。 + </para> + + <programlisting><![CDATA[<target name="run" depends="compile"> + <java fork="true" classname="events.EventManager" classpathref="libraries"> + <classpath path="${targetdir}"/> + <arg value="${action}"/> + </java> +</target>]]></programlisting> + + <para> + <literal>action</literal>参数（argument）的值是通过命令行调用这个target的时候设置的： + </para> + + <programlisting><![CDATA[C:\hibernateTutorial\>ant run -Daction=store]]></programlisting> + + <para> + 你应该会看到，编译以后，Hibernate根据你的配置启动，并产生一大堆的输出日志。在日志最后你会看到下面这行： + </para> + + <programlisting><![CDATA[[java] Hibernate: insert into EVENTS (EVENT_DATE, title, EVENT_ID) values (?, ?, ?)]]></programlisting> + + <para> + 这是Hibernate执行的<literal>INSERT</literal>命令，问号代表JDBC的绑定参数。如果想要看到绑定参数的值或者减少日志的长度，就要调整你在<literal>log4j.properties</literal>文件里的设置。 + </para> + + <para> + 我们想要列出所有已经被存储的events，就要增加一个条件分支选项到main方法中去。 + </para> + + <programlisting><![CDATA[if (args[0].equals("store")) { + mgr.createAndStoreEvent("My Event", new Date()); +} +else if (args[0].equals("list")) { + List events = mgr.listEvents(); + for (int i = 0; i < events.size(); i++) { + Event theEvent = (Event) events.get(i); + System.out.println("Event: " + theEvent.getTitle() + + " Time: " + theEvent.getDate()); + } +}]]></programlisting> + + <para> + 我们也增加一个新的<literal>listEvents()</literal>方法: + </para> + + <programlisting><![CDATA[private List listEvents() { + + Session session = HibernateUtil.getSessionFactory().getCurrentSession(); + + session.beginTransaction(); + + List result = session.createQuery("from Event").list(); + + session.getTransaction().commit(); + + return result; +}]]></programlisting> + + <para> + 我们在这里是用一个HQL（Hibernate Query Language－Hibernate查询语言）查询语句来从数据库中加载所有存在的<literal>Event</literal>对象。Hibernate会生成适当的SQL，把它发送到数据库，并操作从查询得到数据的<literal>Event</literal>对象。当然，你可以使用HQL来创建更加复杂的查询。 + </para> + + <para> + 现在，根据以下步骤来执行并测试以上各项： + </para> + + <itemizedlist> + <listitem> + <para> + 运行<literal>ant run -Daction=store</literal>来保存一些内容到数据库。当然，先得用hbm2ddl来生成数据库schema。 + </para> + </listitem> + <listitem> + <para> + 现在把<literal>hibernate.cfg.xml</literal>文件中hbm2ddl属性注释掉，这样我们就取消了在启动时用hbm2ddl来生成数据库schema。通常只有在不断重复进行单元测试的时候才需要打开它，但再次运行hbm2ddl会把你保存的一切都删掉（<emphasis>drop</emphasis>）——<literal>create</literal>配置的真实含义是：“在创建SessionFactory的时候，从schema 中drop 掉所有的表，再重新创建它们”。 + </para> + </listitem> + </itemizedlist> + + + <para> + 如果你现在使用命令行参数<literal>-Daction=list</literal>运行Ant，你会看到那些至今为止我们所储存的events。当然，你也可以多调用几次<literal>store</literal>以保存更多的envents。 + </para> + + <para> + 注意，很多Hibernate新手在这一步会失败，我们不时看到关于<emphasis>Table not found</emphasis>错误信息的提问。但是，只要你根据上面描述的步骤来执行，就不会有这个问题，因为hbm2ddl会在第一次运行的时候创建数据库schema，后继的应用程序重起后还能继续使用这个schema。假若你修改了映射，或者修改了数据库schema，你必须把hbm2ddl重新打开一次。 + </para> + + </sect2> + + </sect1> + <sect1 id="tutorial-associations"> + <title> + 第二部分 － 关联映射 + </title> + + <para> + 我们已经映射了一个持久化实体类到表上。让我们在这个基础上增加一些类之间的关联。首先我们往应用程序里增加人（people）的概念，并存储他们所参与的一个Event列表。（译者注：与Event一样，我们在后面将直接使用person来表示“人”而不是它的中文翻译） + </para> + + <sect2 id="tutorial-associations-mappinguser" revision="1"> + <title> + 映射Person类 + </title> + + <para> + 最初简单的<literal>Person</literal>类： + </para> + + <programlisting><![CDATA[package events; + +public class Person { + + private Long id; + private int age; + private String firstname; + private String lastname; + + public Person() {} + + // Accessor methods for all properties, private setter for 'id' + +}]]></programlisting> + + <para> + 创建一个名为<literal>Person.hbm.xml</literal>的新映射文件（别忘了最上面的DTD引用）： + </para> + + <programlisting><![CDATA[<hibernate-mapping> + + <class name="events.Person" table="PERSON"> + <id name="id" column="PERSON_ID"> + <generator class="native"/> + </id> + <property name="age"/> + <property name="firstname"/> + <property name="lastname"/> + </class> + +</hibernate-mapping>]]></programlisting> + + <para> + 最后，把新的映射加入到Hibernate的配置中： + </para> + + <programlisting><![CDATA[<mapping resource="events/Event.hbm.xml"/> +<mapping resource="events/Person.hbm.xml"/>]]></programlisting> + + <para> + 现在我们在这两个实体之间创建一个关联。显然，persons可以参与一系列events，而events也有不同的参加者（persons）。我们需要处理的设计问题是关联方向（directionality），阶数（multiplicity）和集合（collection）的行为。 + </para> + + </sect2> + + <sect2 id="tutorial-associations-unidirset" revision="3"> + <title> + 单向Set-based的关联 + </title> + + <para> + 我们将向<literal>Person</literal>类增加一连串的events。那样，通过调用<literal>aPerson.getEvents()</literal>，就可以轻松地导航到特定person所参与的events，而不用去执行一个显式的查询。我们使用Java的集合类（collection）：<literal>Set</literal>，因为set 不包含重复的元素及与我们无关的排序。 + </para> + + <para> + 我们需要用set 实现一个单向多值关联。让我们在Java类里为这个关联编码，接着映射它： + </para> + + <programlisting><![CDATA[public class Person { + + private Set events = new HashSet(); + + public Set getEvents() { + return events; + } + + public void setEvents(Set events) { + this.events = events; + } +}]]></programlisting> + + <para> + 在映射这个关联之前，先考虑一下此关联的另外一端。很显然，我们可以保持这个关联是单向的。或者，我们可以在<literal>Event</literal>里创建另外一个集合，如果希望能够双向地导航，如：<literal>anEvent.getParticipants()</literal>。从功能的角度来说，这并不是必须的。因为你总可以显式地执行一个查询，以获得某个特定event的所有参与者。这是个在设计时需要做出的选择，完全由你来决定，但此讨论中关于关联的阶数是清楚的：即两端都是“多”值的，我们把它叫做<emphasis>多对多(many-to-many)</emphasis>关联。因而，我们使用Hibernate的多对多映射： + </para> + + <programlisting><![CDATA[<class name="events.Person" table="PERSON"> + <id name="id" column="PERSON_ID"> + <generator class="native"/> + </id> + <property name="age"/> + <property name="firstname"/> + <property name="lastname"/> + + <set name="events" table="PERSON_EVENT"> + <key column="PERSON_ID"/> + <many-to-many column="EVENT_ID" class="events.Event"/> + </set> + +</class>]]></programlisting> + + <para> + Hibernate支持各种各样的集合映射，<literal>&lt;set&gt;</literal>使用的最为普遍。对于多对多关联（或叫<emphasis>n:m</emphasis>实体关系）, 需要一个关联表（association table）。<literal>表</literal>里面的每一行代表从person到event的一个关联。表名是由<literal>set</literal>元素的<literal>table</literal>属性配置的。关联里面的标识符字段名，对于person的一端，是由<literal>&lt;key&gt;</literal>元素定义，而event一端的字段名是由<literal>&lt;many-to-many&gt;</literal>元素的<literal>column</literal>属性定义。你也必须告诉Hibernate集合中对象的类（也就是位于这个集合所代表的关联另外一端的类）。 + </para> + + <para> + 因而这个映射的数据库schema是： + </para> + + <programlisting><![CDATA[ + _____________ __________________ + | | | | _____________ + | EVENTS | | PERSON_EVENT | | | + |_____________| |__________________| | PERSON | + | | | | |_____________| + | *EVENT_ID | <--> | *EVENT_ID | | | + | EVENT_DATE | | *PERSON_ID | <--> | *PERSON_ID | + | TITLE | |__________________| | AGE | + |_____________| | FIRSTNAME | + | LASTNAME | + |_____________| + ]]></programlisting> + + </sect2> + + <sect2 id="tutorial-associations-working" revision="2"> + <title> + 使关联工作 + </title> + + <para> + 我们把一些people和events 一起放到<literal>EventManager</literal>的新方法中： + </para> + + <programlisting><![CDATA[private void addPersonToEvent(Long personId, Long eventId) { + + Session session = HibernateUtil.getSessionFactory().getCurrentSession(); + session.beginTransaction(); + + Person aPerson = (Person) session.load(Person.class, personId); + Event anEvent = (Event) session.load(Event.class, eventId); + + aPerson.getEvents().add(anEvent); + + session.getTransaction().commit(); +}]]></programlisting> + + <para> + 在加载一<literal>Person</literal>和<literal>Event</literal>后，使用普通的集合方法就可容易地修改我们定义的集合。如你所见，没有显式的<literal>update()</literal>或<literal>save()</literal>，Hibernate会自动检测到集合已经被修改并需要更新回数据库。这叫做自动脏检查（<emphasis>automatic dirty checking</emphasis>），你也可以尝试修改任何对象的name或者date属性，只要他们处于<emphasis>持久化</emphasis>状态，也就是被绑定到某个Hibernate 的<literal>Session</literal>上（如：他们刚刚在一个单元操作被加载或者保存），Hibernate监视任何改变并在后台隐式写的方式执行SQL。同步内存状态和数据库的过程，通常只在单元操作结束的时候发生，称此过程为清理缓存<emphasis>（flushing）</emphasis>。在我们的代码中，工作单元由数据库事务的提交（或者回滚）来结束——这是由<literal>Curren! tSessionContext</literal>类的<literal>thread</literal>配置选项定义的。 + </para> + + <para> + 当然，你也可以在不同的单元操作里面加载person和event。或在<literal>Session</literal>以外修改不是处在持久化（persistent）状态下的对象（如果该对象以前曾经被持久化，那么我们称这个状态为<emphasis>脱管（detached）</emphasis>）。你甚至可以在一个集合被脱管时修改它： + </para> + + <programlisting><![CDATA[private void addPersonToEvent(Long personId, Long eventId) { + + Session session = HibernateUtil.getSessionFactory().getCurrentSession(); + session.beginTransaction(); + + Person aPerson = (Person) session + .createQuery("select p from Person p left join fetch p.events where p.id = :pid") + .setParameter("pid", personId) + .uniqueResult(); // Eager fetch the collection so we can use it detached + + Event anEvent = (Event) session.load(Event.class, eventId); + + session.getTransaction().commit(); + + // End of first unit of work + + aPerson.getEvents().add(anEvent); // aPerson (and its collection) is detached + + // Begin second unit of work + + Session session2 = HibernateUtil.getSessionFactory().getCurrentSession(); + session2.beginTransaction(); + + session2.update(aPerson); // Reattachment of aPerson + + session2.getTransaction().commit(); +}]]></programlisting> + + <para> + 对<literal>update</literal>的调用使一个脱管对象重新持久化，你可以说它被绑定到一个新的单元操作上，所以在脱管状态下对它所做的任何修改都会被保存到数据库里。这也包括你对这个实体对象的集合所作的任何改动（增加/删除）。 + </para> + + <para> + 这对我们当前的情形不是很有用，但它是非常重要的概念，你可以把它融入到你自己的应用程序设计中。在<literal>EventManager</literal>的main方法中添加一个新的动作，并从命令行运行它来完成我们所做的练习。如果你需要person及event的标识符 — 那就用<literal>save()</literal>方法返回它（你可能需要修改前面的一些方法来返回那个标识符）： + </para> + + <programlisting><![CDATA[else if (args[0].equals("addpersontoevent")) { + Long eventId = mgr.createAndStoreEvent("My Event", new Date()); + Long personId = mgr.createAndStorePerson("Foo", "Bar"); + mgr.addPersonToEvent(personId, eventId); + System.out.println("Added person " + personId + " to event " + eventId); +}]]></programlisting> + + <para> + 上面是个关于两个同等重要的实体类间关联的例子。像前面所提到的那样，在特定的模型中也存在其它的类和类型，这些类和类型通常是“次要的”。你已看到过其中的一些，像<literal>int</literal>或<literal>String</literal>。我们称这些类为<emphasis>值类型（value type）</emphasis>，它们的实例<emphasis>依赖（depend）</emphasis>在某个特定的实体上。这些类型的实例没有它们自己的标识（identity），也不能在实体间被共享（比如，两个person不能引用同一个<literal>firstname</literal>对象，即使他们有相同的first name）。当然，值类型并不仅仅在JDK中存在（事实上，在一个Hibernate应用程序中，所有的JDK类都被视为值类型），而且你也可以编写你自己的依赖类，例如<literal>Address</literal>，<literal>MonetaryAmount</literal>。 + </para> + + <para> + 你也可以设计一个值类型的集合，这在概念上与引用其它实体的集合有很大的不同，但是在Java里面看起来几乎是一样的。 + </para> + + </sect2> + + <sect2 id="tutorial-associations-valuecollections"> + <title> + 值类型的集合 + </title> + + <para> + 我们把一个值类型对象的集合加入<literal>Person</literal>实体中。我们希望保存email地址，所以使用<literal>String</literal>类型，而且这次的集合类型又是<literal>Set</literal>： + </para> + <programlisting><![CDATA[private Set emailAddresses = new HashSet(); + +public Set getEmailAddresses() { + return emailAddresses; +} + +public void setEmailAddresses(Set emailAddresses) { + this.emailAddresses = emailAddresses; +}]]></programlisting> + + <para> + 这个<literal>Set</literal>的映射 + </para> + + <programlisting><![CDATA[<set name="emailAddresses" table="PERSON_EMAIL_ADDR"> + <key column="PERSON_ID"/> + <element type="string" column="EMAIL_ADDR"/> +</set>]]></programlisting> + + <para> + 比较这次和此前映射的差别，主要在于<literal>element</literal>部分，这次并没有包含对其它实体引用的集合，而是元素类型为<literal>String</literal>的集合（在映射中使用小写的名字”string“是向你表明它是一个Hibernate的映射类型或者类型转换器）。和之前一样，<literal>set</literal>元素的<literal>table</literal>属性决定了用于集合的表名。<literal>key</literal>元素定义了在集合表中外键的字段名。<literal>element</literal>元素的<literal>column</literal>属性定义用于实际保存<literal>String</literal>值的字段名。 + </para> + + <para> + 看一下修改后的数据库schema。 + </para> + + <programlisting><![CDATA[ + _____________ __________________ + | | | | _____________ + | EVENTS | | PERSON_EVENT | | | ___________________ + |_____________| |__________________| | PERSON | | | + | | | | |_____________| | PERSON_EMAIL_ADDR | + | *EVENT_ID | <--> | *EVENT_ID | | | |___________________| + | EVENT_DATE | | *PERSON_ID | <--> | *PERSON_ID | <--> | *PERSON_ID | + | TITLE | |__________________| | AGE | | *EMAIL_ADDR | + |_____________| | FIRSTNAME | |___________________| + | LASTNAME | + |_____________| + ]]></programlisting> + + <para> + 你可以看到集合表的主键实际上是个复合主键，同时使用了2个字段。这也暗示了对于同一个person不能有重复的email地址，这正是Java里面使用Set时候所需要的语义（Set里元素不能重复）。 + </para> + + <para> + 你现在可以试着把元素加入到这个集合，就像我们在之前关联person和event的那样。其实现的Java代码是相同的： + </para> + <programlisting><![CDATA[private void addEmailToPerson(Long personId, String emailAddress) { + + Session session = HibernateUtil.getSessionFactory().getCurrentSession(); + session.beginTransaction(); + + Person aPerson = (Person) session.load(Person.class, personId); + + // The getEmailAddresses() might trigger a lazy load of the collection + aPerson.getEmailAddresses().add(emailAddress); + + session.getTransaction().commit(); +}]]></programlisting> + + <para> + 这次我们没有使用<emphasis>fetch</emphasis>查询来初始化集合。因此，调用其getter方法会触发另一附加的select来初始化集合，这样我们才能把元素添加进去。检查SQL log，试着通过预先抓取来优化它。 + </para> + + + </sect2> + + <sect2 id="tutorial-associations-bidirectional" revision="1"> + <title> + 双向关联 + </title> + + <para> + 接下来我们将映射双向关联（bi-directional association）－ 在Java里让person和event可以从关联的任何一端访问另一端。当然，数据库schema没有改变，我们仍然需要多对多的阶数。一个关系型数据库要比网络编程语言 更加灵活，所以它并不需要任何像导航方向（navigation direction）的东西 － 数据可以用任何可能的方式进行查看和获取。 + </para> + + <para> + 首先，把一个参与者（person）的集合加入<literal>Event</literal>类中： + </para> + + <programlisting><![CDATA[private Set participants = new HashSet(); + +public Set getParticipants() { + return participants; +} + +public void setParticipants(Set participants) { + this.participants = participants; +}]]></programlisting> + + <para> + 在<literal>Event.hbm.xml</literal>里面也映射这个关联。 + </para> + + <programlisting><![CDATA[<set name="participants" table="PERSON_EVENT" inverse="true"> + <key column="EVENT_ID"/> + <many-to-many column="PERSON_ID" class="events.Person"/> +</set>]]></programlisting> + <para> + 如你所见，两个映射文件里都有普通的<literal>set</literal>映射。注意在两个映射文件中，互换了<literal>key</literal>和<literal>many-to-many</literal>的字段名。这里最重要的是<literal>Event</literal>映射文件里增加了<literal>set</literal>元素的<literal>inverse="true"</literal>属性。 + </para> + + <para> + 这意味着在需要的时候，Hibernate能在关联的另一端 － <literal>Person</literal>类得到两个实体间关联的信息。这将会极大地帮助你理解双向关联是如何在两个实体间被创建的。 + </para> + + </sect2> + + <sect2 id="tutorial-associations-usingbidir"> + <title> + 使双向连起来 + </title> + + <para> + 首先请记住，Hibernate并不影响通常的Java语义。 在单向关联的例子中，我们是怎样在<literal>Person</literal>和<literal>Event</literal>之间创建联系的？我们把<literal>Event</literal>实例添加到<literal>Person</literal>实例内的event引用集合里。因此很显然，如果我们要让这个关联可以双向地工作，我们需要在另外一端做同样的事情 － 把<literal>Person</literal>实例加入<literal>Event</literal>类内的Person引用集合。这“在关联的两端设置联系”是完全必要的而且你都得这么做。 + </para> + + <para> + 许多开发人员防御式地编程，创建管理关联的方法来保证正确的设置了关联的两端，比如在<literal>Person</literal>里： + </para> + + <programlisting><![CDATA[protected Set getEvents() { + return events; +} + +protected void setEvents(Set events) { + this.events = events; +} + +public void addToEvent(Event event) { + this.getEvents().add(event); + event.getParticipants().add(this); +} + +public void removeFromEvent(Event event) { + this.getEvents().remove(event); + event.getParticipants().remove(this); +}]]></programlisting> + + <para> + 注意现在对于集合的get和set方法的访问级别是protected - 这允许在位于同一个包（package）中的类以及继承自这个类的子类可以访问这些方法，但禁止其他任何人的直接访问，避免了集合内容的混乱。你应尽可能地在另一端也把集合的访问级别设成protected。 + </para> + + <para> + <literal>inverse</literal>映射属性究竟表示什么呢？对于你和Java来说，一个双向关联仅仅是在两端简单地正确设置引用。然而，Hibernate并没有足够的信息去正确地执行<literal>INSERT</literal>和<literal>UPDATE</literal>语句（以避免违反数据库约束），所以它需要一些帮助来正确的处理双向关联。把关联的一端设置为<literal>inverse</literal>将告诉Hibernate忽略关联的这一端，把这端看成是另外一端的一个<emphasis>镜象（mirror）</emphasis>。这就是所需的全部信息，Hibernate利用这些信息来处理把一个有向导航模型转移到数据库schema时的所有问题。你只需要记住这个直观的规则：所有的双向关联需要有一端被设置为<literal>inverse</literal>。在一对多关联中它必须是代表多（many）的那端。而在多对多（many-to-many）关联中，你可以任意选取一端，因为两端之间并没有差别。 + </para> + </sect2> + <para> + 让我们把进入一个小型的web应用程序。 + </para> + + </sect1> + + <sect1 id="tutorial-webapp"> + <title>第三部分 - EventManager web应用程序</title> + + <para> + Hibernate web应用程序使用<literal>Session</literal> 和<literal>Transaction</literal>的方式几乎和独立应用程序是一样的。但是，有一些常见的模式（pattern）非常有用。现在我们编写一个<literal>EventManagerServlet</literal>。这个servlet可以列出数据库中保存的所有的events，还提供一个HTML表单来增加新的events。 + </para> + + <sect2 id="tutorial-webapp-servlet" revision="2"> + <title>编写基本的servlet</title> + + <para> + 在你的源代码目录的<literal>events</literal>包中创建一个新的类： + </para> + + <programlisting><![CDATA[package events; + +// Imports + +public class EventManagerServlet extends HttpServlet { + + // Servlet code +}]]></programlisting> + + <para> + 我们后面会用到<literal>dateFormatter</literal> 的工具， 它把<literal>Date</literal>对象转换为字符串。只要一个formatter作为servlet的成员就可以了。 + </para> + + <para> + 这个servlet只处理 HTTP <literal>GET</literal> 请求，因此，我们要实现的是<literal>doGet()</literal>方法： + </para> + + <programlisting><![CDATA[protected void doGet(HttpServletRequest request, + HttpServletResponse response) + throws ServletException, IOException { + + SimpleDateFormat dateFormatter = new SimpleDateFormat("dd.MM.yyyy"); + + try { + // Begin unit of work + HibernateUtil.getSessionFactory() + .getCurrentSession().beginTransaction(); + + // Process request and render page... + + // End unit of work + HibernateUtil.getSessionFactory() + .getCurrentSession().getTransaction().commit(); + + } catch (Exception ex) { + HibernateUtil.getSessionFactory() + .getCurrentSession().getTransaction().rollback(); + throw new ServletException(ex); + } + +}]]></programlisting> + <para> +我们称这里应用的模式为每次请求一个session<emphasis>(session-per-request)</emphasis>。当有请求到达这个servlet的时候，通过对<literal>SessionFactory</literal>的第一次调用，打开一个新的Hibernate <literal>Session</literal>。然后启动一个数据库事务&mdash;所有的数据访问都是在事务中进行，不管是读还是写（我们在应用程序中不使用auto-commit模式）。 + </para> + + <para> + + <emphasis>不要</emphasis>为每次数据库操作都使用一个新的Hibernate <literal>Session</literal>。将Hibernate <literal>Session</literal>的范围设置为整个请求。要用<literal>getCurrentSession()</literal>，这样它自动会绑定到当前Java线程。 + </para> + + <para> + 下一步，对请求的可能动作进行处理，渲染出反馈的HTML。我们很快就会涉及到那部分。 + </para> + + <para> + 最后，当处理与渲染都结束的时候，这个工作单元就结束了。假若在处理或渲染的时候有任何错误发生，会抛出一个异常，回滚数据库事务。这样，<literal>session-per-request</literal>模式就完成了。为了避免在每个servlet中都编写事务边界界定的代码，可以考虑写一个servlet 过滤器（filter）来更好地解决。关于这一模式的更多信息，请参阅Hibernate网站和Wiki，这一模式叫做<emphasis>Open Session in View</emphasis>&mdash;只要你考虑用JSP来渲染你的视图（view），而不是在servlet中，你就会很快用到它。 + </para> + + </sect2> + + <sect2 id="tutorial-webapp-processing" revision="1"> + <title>处理与渲染</title> + + <para> + 我们来实现处理请求以及渲染页面的工作。 + </para> + +<programlisting><![CDATA[// Write HTML header +PrintWriter out = response.getWriter(); +out.println("<html><head><title>Event Manager</title></head><body>"); + +// Handle actions +if ( "store".equals(request.getParameter("action")) ) { + + String eventTitle = request.getParameter("eventTitle"); + String eventDate = request.getParameter("eventDate"); + + if ( "".equals(eventTitle) || "".equals(eventDate) ) { + out.println("<b><i>Please enter event title and date.</i></b>"); + } else { + createAndStoreEvent(eventTitle, dateFormatter.parse(eventDate)); + out.println("<b><i>Added event.</i></b>"); + } +} + +// Print page +printEventForm(out); +listEvents(out, dateFormatter); + +// Write HTML footer +out.println("</body></html>"); +out.flush(); +out.close();]]></programlisting> + <para> + <literal>listEvents()</literal>方法使用绑定到当前线程的Hibernate <literal>Session</literal>来执行查询： + </para> + + <programlisting><![CDATA[private void listEvents(PrintWriter out, SimpleDateFormat dateFormatter) { + + List result = HibernateUtil.getSessionFactory() + .getCurrentSession().createCriteria(Event.class).list(); + if (result.size() > 0) { + out.println("<h2>Events in database:</h2>"); + out.println("<table border='1'>"); + out.println("<tr>"); + out.println("<th>Event title</th>"); + out.println("<th>Event date</th>"); + out.println("</tr>"); + for (Iterator it = result.iterator(); it.hasNext();) { + Event event = (Event) it.next(); + out.println("<tr>"); + out.println("<td>" + event.getTitle() + "</td>"); + out.println("<td>" + dateFormatter.format(event.getDate()) + "</td>"); + out.println("</tr>"); + } + out.println("</table>"); + } +}]]></programlisting> + + <para> + 最后，<literal>store</literal>动作会被导向到<literal>createAndStoreEvent()</literal>方法，它也使用当前线程的<literal>Session</literal>: + </para> + + <programlisting><![CDATA[protected void createAndStoreEvent(String title, Date theDate) { + Event theEvent = new Event(); + theEvent.setTitle(title); + theEvent.setDate(theDate); + + HibernateUtil.getSessionFactory() + .getCurrentSession().save(theEvent); +}]]></programlisting> + + <para> + 大功告成，这个servlet写完了。Hibernate会在单一的<literal>Session</literal> 和<literal>Transaction</literal>中处理到达的servlet请求。如同在前面的独立应用程序中那样，Hibernate可以自动的把这些对象绑定到当前运行的线程中。这给了你用任何你喜欢的方式来对代码分层及访问<literal>SessionFactory</literal>的自由。通常，你会用更加完备的设计，把数据访问代码转移到数据访问对象中(DAO模式）。请参见Hibernate Wiki，那里有更多的例子。 + </para> + + </sect2> + + <sect2 id="tutorial-webapp-deploy"> + <title>部署与测试</title> + + <para> + 要发布这个程序，你得把它打成web发布包：WAR文件。把下面的脚本加入到你的<literal>build.xml</literal>中： + </para> + +<programlisting><![CDATA[<target name="war" depends="compile"> + <war destfile="hibernate-tutorial.war" webxml="web.xml"> + <lib dir="${librarydir}"> + <exclude name="jsdk*.jar"/> + </lib> + + <classes dir="${targetdir}"/> + </war> +</target>]]></programlisting> + + <para> + 这段代码在你的开发目录中创建一个<literal>hibernate-tutorial.war</literal>的文件。它把所有的类库和<literal>web.xml</literal>描述文件都打包进去，web.xml 文件应该位于你的开发根目录中： + </para> + +<programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?> +<web-app version="2.4" + xmlns="http://java.sun.com/xml/ns/j2ee" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"> + + <servlet> + <servlet-name>Event Manager</servlet-name> + <servlet-class>events.EventManagerServlet</servlet-class> + </servlet> + + <servlet-mapping> + <servlet-name>Event Manager</servlet-name> + <url-pattern>/eventmanager</url-pattern> + </servlet-mapping> +</web-app>]]></programlisting> + + <para> + 请注意在你编译和部署web应用程之前，需要一个附加的类库：<literal>jsdk.jar</literal>。这是Java Servlet开发包，假若你还没有，可以从Sun网站上下载，把它copy到你的lib目录。但是，它仅仅是在编译时需要，不会被打入WAR包。 + </para> + + <para> + 在你的开发目录中，调用<literal>ant war</literal>来构建、打包，然后把<literal>hibernate-tutorial.war</literal>文件拷贝到你的tomcat的<literal>webapps</literal>目录下。假若你还没安装Tomcat，就去下载一个，按照指南来安装。对此应用的发布，你不需要修改任何Tomcat的配置。 + </para> + + <para> + 在部署完，启动Tomcat之后，通过<literal>http://localhost:8080/hibernate-tutorial/eventmanager</literal>进行访问你的应用，在第一次servlet 请求发生时，请在Tomcat log中确认你看到Hibernate被初始化了（<literal>HibernateUtil</literal>的静态初始化器被调用），假若有任何异常抛出，也可以看到详细的输出。 + </para> + + </sect2> + + </sect1> + <sect1 id="tutorial-summary"> + <title> + 总结 + </title> + + <para> + 本章覆盖了如何编写一个简单独立的Hibernate命令行应用程序及小型的Hibernate web应用程序的基本要素。 + </para> + + <para> + 如果你已经对Hibernate感到自信，通过开发指南目录，继续浏览你感兴趣的内容－那些会被问到的问题大多是事务处理 (<xref linkend="transactions"/>)，抓取（fetch）的效率 (<xref linkend="performance"/>)，或者API的使用 (<xref linkend="objectstate"/>)和查询的特性(<xref linkend="objectstate-querying"/>)。 + </para> + + <para> + 别忘了去Hibernate的网站查看更多（有针对性的）示例。 + </para> + + </sect1> +</chapter> Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/content/xml.xml (from rev 14080, core/trunk/documentation/manual/zh-CN/src/main/docbook/modules/xml.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/content/xml.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/content/xml.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,285 @@ +<!-- + ~ Copyright (c) 2007, Red Hat Middleware, LLC. All rights reserved. + ~ + ~ This copyrighted material is made available to anyone wishing to use, modify, + ~ copy, or redistribute it subject to the terms and conditions of the GNU + ~ Lesser General Public License, v. 2.1. This program is distributed in the + ~ hope that it will be useful, but WITHOUT A WARRANTY; without even the implied + ~ warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + ~ Lesser General Public License for more details. You should have received a + ~ copy of the GNU Lesser General Public License, v.2.1 along with this + ~ distribution; if not, write to the Free Software Foundation, Inc., + ~ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + ~ + ~ Red Hat Author(s): Steve Ebersole + --> +<chapter id="xml"> + <title>XML映射</title> + <para><emphasis> + 注意这是Hibernate 3.0的一个实验性的特性。这一特性仍在积极开发中。 + </emphasis></para> + + <sect1 id="xml-intro" revision="1"> + <title>用XML数据进行工作</title> + + <para> + Hibernate使得你可以用XML数据来进行工作，恰如你用持久化的POJO进行工作那样。解析过的XML树 + 可以被认为是代替POJO的另外一种在对象层面上表示关系型数据的途径. + </para> + + <para> + Hibernate支持采用dom4j作为操作XML树的API。你可以写一些查询从数据库中检索出 + dom4j树，随后你对这颗树做的任何修改都将自动同步回数据库。你甚至可以用dom4j解析 + 一篇XML文档，然后使用Hibernate的任一基本操作将它写入数据库： + <literal>persist(), saveOrUpdate(), merge(), delete(), replicate()</literal> + (合并操作merge()目前还不支持)。 + </para> + + <para> + 这一特性可以应用在很多场合，包括数据导入导出，通过JMS或SOAP具体化实体数据以及 + 基于XSLT的报表。 + </para> + + <para> + 一个单一的映射就可以将类的属性和XML文档的节点同时映射到数据库。如果不需要映射类， + 它也可以用来只映射XML文档。 + </para> + + <sect2 id="xml-intro-mapping"> + <title>指定同时映射XML和类</title> + + <para> + 这是一个同时映射POJO和XML的例子： + </para> + + <programlisting><![CDATA[<class name="Account" + table="ACCOUNTS" + node="account"> + + <id name="accountId" + column="ACCOUNT_ID" + node="@id"/> + + <many-to-one name="customer" + column="CUSTOMER_ID" + node="customer/@id" + embed-xml="false"/> + + <property name="balance" + column="BALANCE" + node="balance"/> + + ... + +</class>]]></programlisting> + </sect2> + + <sect2 id="xml-onlyxml"> + <title>只定义XML映射</title> + + <para> + 这是一个不映射POJO的例子： + </para> + + <programlisting><![CDATA[<class entity-name="Account" + table="ACCOUNTS" + node="account"> + + <id name="id" + column="ACCOUNT_ID" + node="@id" + type="string"/> + + <many-to-one name="customerId" + column="CUSTOMER_ID" + node="customer/@id" + embed-xml="false" + entity-name="Customer"/> + + <property name="balance" + column="BALANCE" + node="balance" + type="big_decimal"/> + + ... + +</class>]]></programlisting> + + <para> + 这个映射使得你既可以把数据作为一棵dom4j树那样访问，又可以作为由属性键值对(java <literal>Map</literal>s) + 组成的图那样访问。属性名字纯粹是逻辑上的结构，你可以在HQL查询中引用它。 + </para> + + </sect2> + + </sect1> + + <sect1 id="xml-mapping" revision="1"> + <title>XML映射元数据</title> + + <para> + 许多Hibernate映射元素具有<literal>node</literal>属性。这使你可以指定用来保存 + 属性或实体数据的XML属性或元素。<literal>node</literal>属性必须是下列格式之一： + </para> + + <itemizedlist spacing="compact"> + <listitem> + <para><literal>"element-name"</literal> - 映射为指定的XML元素</para> + </listitem> + <listitem> + <para><literal>"@attribute-name"</literal> - 映射为指定的XML属性</para> + </listitem> + <listitem> + <para><literal>"."</literal> - 映射为父元素</para> + </listitem> + <listitem> + <para> + <literal>"element-name/@attribute-name"</literal> - + 映射为指定元素的指定属性 + </para> + </listitem> + </itemizedlist> + + <para> + 对于集合和单值的关联，有一个额外的<literal>embed-xml</literal>属性可用。 + 这个属性的缺省值是真(<literal>embed-xml="true"</literal>)。如果<literal>embed-xml="true"</literal>， + 则对应于被关联实体或值类型的集合的XML树将直接嵌入拥有这些关联的实体的XML树中。 + 否则，如果<literal>embed-xml="false"</literal>，那么对于单值的关联，仅被引用的实体的标识符出现在 + XML树中(被引用实体本身不出现)，而集合则根本不出现。 + </para> + + <para> + 你应该小心，不要让太多关联的embed-xml属性为真(<literal>embed-xml="true"</literal>)，因为XML不能很好地处理 + 循环引用! + </para> + + <programlisting><![CDATA[<class name="Customer" + table="CUSTOMER" + node="customer"> + + <id name="id" + column="CUST_ID" + node="@id"/> + + <map name="accounts" + node="." + embed-xml="true"> + <key column="CUSTOMER_ID" + not-null="true"/> + <map-key column="SHORT_DESC" + node="@short-desc" + type="string"/> + <one-to-many entity-name="Account" + embed-xml="false" + node="account"/> + </map> + + <component name="name" + node="name"> + <property name="firstName" + node="first-name"/> + <property name="initial" + node="initial"/> + <property name="lastName" + node="last-name"/> + </component> + + ... + +</class>]]></programlisting> + + <para> + 在这个例子中，我们决定嵌入帐目号码(account id)的集合，但不嵌入实际的帐目数据。下面的HQL查询： + </para> + + <programlisting><![CDATA[from Customer c left join fetch c.accounts where c.lastName like :lastName]]></programlisting> + + <para> + 返回的数据集将是这样： + </para> + + <programlisting><![CDATA[<customer id="123456789"> + <account id="987632567" short-desc="Savings"/> + <account id="985612323" short-desc="Credit Card"/> + <name> + <first-name>Gavin</first-name> + <initial>A</initial> + <last-name>King</last-name> + </name> + ... +</customer>]]></programlisting> + + <para> + 如果你把一对多映射<literal>&lt;one-to-many&gt;</literal>的embed-xml属性置为真(<literal>embed-xml="true"</literal>)， + 则数据看上去就像这样： + </para> + + <programlisting><![CDATA[<customer id="123456789"> + <account id="987632567" short-desc="Savings"> + <customer id="123456789"/> + <balance>100.29</balance> + </account> + <account id="985612323" short-desc="Credit Card"> + <customer id="123456789"/> + <balance>-2370.34</balance> + </account> + <name> + <first-name>Gavin</first-name> + <initial>A</initial> + <last-name>King</last-name> + </name> + ... +</customer>]]></programlisting> + + </sect1> + + + <sect1 id="xml-manipulation" revision="1"> + <title>操作XML数据</title> + + <para> + 让我们来读入和更新应用程序中的XML文档。通过获取一个dom4j会话可以做到这一点： + </para> + + <programlisting><![CDATA[Document doc = ....; + +Session session = factory.openSession(); +Session dom4jSession = session.getSession(EntityMode.DOM4J); +Transaction tx = session.beginTransaction(); + +List results = dom4jSession + .createQuery("from Customer c left join fetch c.accounts where c.lastName like :lastName") + .list(); +for ( int i=0; i<results.size(); i++ ) { + //add the customer data to the XML document + Element customer = (Element) results.get(i); + doc.getRootElement().add(customer); +} + +tx.commit(); +session.close();]]></programlisting> + + <programlisting><![CDATA[Session session = factory.openSession(); +Session dom4jSession = session.getSession(EntityMode.DOM4J); +Transaction tx = session.beginTransaction(); + +Element cust = (Element) dom4jSession.get("Customer", customerId); +for ( int i=0; i<results.size(); i++ ) { + Element customer = (Element) results.get(i); + //change the customer name in the XML and database + Element name = customer.element("name"); + name.element("first-name").setText(firstName); + name.element("initial").setText(initial); + name.element("last-name").setText(lastName); +} + +tx.commit(); +session.close();]]></programlisting> + + <para> + 将这一特色与Hibernate的<literal>replicate()</literal>操作结合起来对于实现的基于XML的数据导入/导出将非常有用. + </para> + + </sect1> + +</chapter> Deleted: core/trunk/documentation/manual/zh-CN/src/main/docbook/glossary.txt =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/glossary.txt 2007-10-09 19:32:35 UTC (rev 14080) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/glossary.txt 2007-10-09 20:10:34 UTC (rev 14081) @@ -1,27 +0,0 @@ -O/R Mapping 对象/关系数据库映射 -identifier property: 标识属性 -discriminator: 辨别标志(不使用"鉴别器") - -join-subclass,union-subclass,join: 不翻译 - -fine-grained 细粒度 -domain model 领域模型 -business object 业务对象(v2的时候翻译为"商业对象",被无数人痛骂....) -annotations 注解(这个词还比较新,也见到有翻译为"特殊注释"/"标注"的) - -Aggregate functions 统计函数 (聚集函数?聚合函数? 还是翻译为统计函数才能让人看懂) -Criteria Queries 条件查询(标准查询?这里Criteria是"判据"的含义,而非"标准",意译为条件查询更加明白) - -session flush session清洗 -lazy fetching 延迟加载(懒加载,翻译很直白,但是却不易理解) - -对象状态： - persistent class 持久化类 - persistent object 持久对象 (体现这是与某个持久化设备联系的,掉电之后不消失) - transient object 瞬时对象 (其含义是仅在内存中存在的,掉电之后消失,翻译为瞬时对象比较好) - detached object 脱管对象(与session脱离的对象) - -outer-join fetching 外连接抓取 (fetch一般翻译为"获取",v2翻译的时候,为了突出其主动获取的特点,翻译为"抓取") - -class hierarchy 类分层结构 http://www.umlchina.com/xprogrammer/glossary1.htm -inheritance hierarchy 继承层次 http://www-128.ibm.com/developerworks/cn/java/j-aopwork4/?ca=dwcn-newslet... Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/images/AuthorWork.png (from rev 14073, core/trunk/documentation/manual/en-US/src/main/docbook/images/AuthorWork.png) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/images/AuthorWork.zargo (from rev 14073, core/trunk/documentation/manual/en-US/src/main/docbook/images/AuthorWork.zargo) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/images/CustomerOrderProduct.png (from rev 14073, core/trunk/documentation/manual/en-US/src/main/docbook/images/CustomerOrderProduct.png) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/images/CustomerOrderProduct.zargo (from rev 14073, core/trunk/documentation/manual/en-US/src/main/docbook/images/CustomerOrderProduct.zargo) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/images/EmployerEmployee.png (from rev 14073, core/trunk/documentation/manual/en-US/src/main/docbook/images/EmployerEmployee.png) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/images/EmployerEmployee.zargo (from rev 14073, core/trunk/documentation/manual/en-US/src/main/docbook/images/EmployerEmployee.zargo) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/images/full_cream.png (from rev 14073, core/trunk/documentation/manual/en-US/src/main/docbook/images/full_cream.png) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/images/full_cream.svg (from rev 14073, core/trunk/documentation/manual/en-US/src/main/docbook/images/full_cream.svg) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/images/full_cream.svg (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/images/full_cream.svg 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,429 @@ +<?xml version="1.0" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN" +"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd" +[ + <!ATTLIST svg + xmlns:xlink CDATA #FIXED "http://www.w3.org/1999/xlink"> +]> +<!-- Created with Sodipodi ("http://www.sodipodi.com/") --> +<svg + xmlns="http://www.w3.org/2000/svg" + xmlns:xlink="http://www.w3.org/1999/xlink" + width="354.331" + height="336.614" + id="svg1"> + <defs + id="defs3"> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad"> + <stop + style="stop-color:#000000;stop-opacity:1;" + offset="0" + id="stop128" /> + <stop + style="stop-color:#ffffff;stop-opacity:1;" + offset="1" + id="stop129" /> + </linearGradient> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient130" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + <radialGradient + cx="0.5" + cy="0.5" + fx="0.5" + fy="0.5" + r="0.5" + id="radialGradient131" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + </defs> + <g + transform="matrix(0.823795,0,0,0.823795,0.120302,5.25349)" + style="font-size:12;" + id="g659"> + <rect + width="212.257" + height="57.2441" + x="17.9576" + y="100.132" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect137" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + transform="matrix(0.743454,0,0,0.482981,6.46949,52.2178)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect132" /> + </g> + <rect + width="325.86" + height="63.6537" + x="17.4083" + y="15.194" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect136" /> + <rect + width="325.86" + height="63.6537" + x="13.6713" + y="12.4966" + style="font-size:12;fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect126" /> + <g + transform="matrix(1.14345,0,0,0.729078,-1.67818,105.325)" + style="font-size:12;" + id="g164"> + <rect + width="285.502" + height="77.2688" + x="16.6979" + y="222.966" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect138" /> + <rect + width="285.502" + height="77.2688" + x="14.7335" + y="221.002" + transform="translate(-1.30962,-1.30992)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect133" /> + </g> + <text + x="170.824753" + y="58.402939" + transform="scale(0.823795,0.823795)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text183"> + <tspan + x="170.824997" + y="58.402901" + id="tspan360"> +Application</tspan> + </text> + <text + x="178.076340" + y="364.281433" + transform="scale(0.823795,0.823795)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text197"> + <tspan + x="178.076004" + y="364.281006" + id="tspan421"> +Database</tspan> + </text> + <text + x="68.605331" + y="138.524582" + transform="scale(0.823795,0.823795)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text216"> + <tspan + x="68.605301" + y="138.524994" + id="tspan384"> +SessionFactory</tspan> + </text> + <rect + width="67.0014" + height="101.35" + x="196.927" + y="89.2389" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect387" /> + <rect + width="67.0014" + height="101.35" + x="194.633" + y="86.4389" + style="font-size:12;fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect388" /> + <text + x="249.108841" + y="173.885559" + transform="scale(0.823795,0.823795)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text389"> + <tspan + x="249.108994" + y="173.886002" + id="tspan392"> +Session</tspan> + </text> + <rect + width="73.0355" + height="101.35" + x="270.995" + y="90.0018" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect395" /> + <rect + width="73.0355" + height="101.35" + x="267.869" + y="87.2018" + style="font-size:12;fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect396" /> + <text + x="328.593658" + y="174.715622" + transform="scale(0.823795,0.823795)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text397"> + <tspan + x="328.593994" + y="174.716003" + id="tspan563"> +Transaction</tspan> + </text> + <g + transform="matrix(0.29544,0,0,0.397877,9.70533,103.96)" + style="font-size:12;" + id="g565"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect566" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect567" /> + </g> + <text + x="25.592752" + y="204.497803" + transform="scale(0.823795,0.823795)" + style="font-size:10;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text568"> + <tspan + x="25.592800" + y="204.498001" + id="tspan662"> +TransactionFactory</tspan> + </text> + <g + transform="matrix(0.298082,0,0,0.397877,99.6898,103.96)" + style="font-size:12;" + id="g573"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect574" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect575" /> + </g> + <text + x="134.030670" + y="205.532791" + transform="scale(0.823795,0.823795)" + style="font-size:10;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text576"> + <tspan + x="134.031006" + y="205.533005" + id="tspan664"> +ConnectionProvider</tspan> + </text> + <g + transform="matrix(1.14345,0,0,0.729078,-1.67818,38.9539)" + style="font-size:12;" + id="g587"> + <rect + width="285.502" + height="77.2688" + x="16.6979" + y="222.966" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect588" /> + <rect + width="285.502" + height="77.2688" + x="14.7335" + y="221.002" + transform="translate(-1.30962,-1.30992)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect589" /> + </g> + <rect + width="90.951" + height="44.4829" + x="25.6196" + y="206.028" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect594" /> + <rect + width="90.951" + height="44.4829" + x="24.4229" + y="204.135" + style="font-size:12;fill:#b3b3b3;fill-rule:evenodd;stroke-width:1pt;" + id="rect595" /> + <text + x="85.575645" + y="282.300354" + transform="scale(0.823795,0.823795)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;text-anchor:middle;" + id="text596"> + <tspan + x="85.575600" + y="282.299988" + id="tspan607"> +JNDI</tspan> + </text> + <rect + width="90.951" + height="44.4829" + x="236.937" + y="206.791" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect610" /> + <rect + width="90.951" + height="44.4829" + x="235.741" + y="204.898" + style="font-size:12;fill:#b3b3b3;fill-rule:evenodd;stroke-width:1pt;" + id="rect611" /> + <text + x="342.093201" + y="283.226410" + transform="scale(0.823795,0.823795)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;text-anchor:middle;" + id="text612"> + <tspan + x="342.092987" + y="283.226013" + id="tspan621"> +JTA</tspan> + </text> + <rect + width="90.951" + height="44.4829" + x="130.134" + y="206.791" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect616" /> + <rect + width="90.951" + height="44.4829" + x="128.937" + y="204.898" + style="font-size:12;fill:#b3b3b3;fill-rule:evenodd;stroke-width:1pt;" + id="rect617" /> + <text + x="212.445343" + y="283.226410" + transform="scale(0.823795,0.823795)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;text-anchor:middle;" + id="text618"> + <tspan + x="212.445007" + y="283.226013" + id="tspan623"> +JDBC</tspan> + </text> + <g + transform="matrix(0.823795,0,0,0.823795,0.120302,6.19341)" + style="font-size:12;" + id="g637"> + <g + transform="matrix(0.499515,0,0,0.415467,-0.237339,5.61339)" + id="g167"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect134" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect135" /> + </g> + <text + x="33.749969" + y="50.589706" + style="font-size:11;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text188"> + <tspan + x="33.750000" + y="50.589699" + id="tspan635"> +Transient Objects</tspan> + </text> + </g> + <g + transform="matrix(0.823795,0,0,0.823795,0.120302,5.25349)" + style="font-size:12;" + id="g644"> + <g + transform="matrix(0.297486,0,0,0.516482,230.251,36.9178)" + id="g364"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect365" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect366" /> + </g> + <text + x="277.123230" + y="85.155571" + style="font-size:11;font-weight:normal;stroke-width:1pt;font-family:Helvetica;text-anchor:middle;" + id="text367"> + <tspan + x="277.122986" + y="85.155602" + id="tspan631"> +Persistent</tspan> + <tspan + x="277.122986" + y="96.155602" + id="tspan633"> +Objects</tspan> + </text> + </g> +</svg> Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/images/hibernate_logo_a.png (from rev 14073, core/trunk/documentation/manual/en-US/src/main/docbook/images/hibernate_logo_a.png) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/images/lite.png (from rev 14073, core/trunk/documentation/manual/en-US/src/main/docbook/images/lite.png) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/images/lite.svg (from rev 14073, core/trunk/documentation/manual/en-US/src/main/docbook/images/lite.svg) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/images/lite.svg (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/images/lite.svg 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,334 @@ +<?xml version="1.0" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN" +"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd" +[ + <!ATTLIST svg + xmlns:xlink CDATA #FIXED "http://www.w3.org/1999/xlink"> +]> +<!-- Created with Sodipodi ("http://www.sodipodi.com/") --> +<svg + xmlns="http://www.w3.org/2000/svg" + xmlns:xlink="http://www.w3.org/1999/xlink" + width="318.898" + height="248.031" + id="svg1"> + <defs + id="defs3"> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad"> + <stop + style="stop-color:#000000;stop-opacity:1;" + offset="0" + id="stop128" /> + <stop + style="stop-color:#ffffff;stop-opacity:1;" + offset="1" + id="stop129" /> + </linearGradient> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient130" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + <radialGradient + cx="0.5" + cy="0.5" + fx="0.5" + fy="0.5" + r="0.5" + id="radialGradient131" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + </defs> + <rect + width="291.837" + height="57.0074" + x="17.3169" + y="18.646" + style="font-size:12;fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect136" /> + <rect + width="291.837" + height="57.0074" + x="13.9703" + y="16.2302" + style="font-size:12;fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect126" /> + <g + transform="matrix(0.326107,0,0,0.765831,9.59261,8.98517)" + style="font-size:12;" + id="g161"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect137" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect132" /> + </g> + <g + transform="matrix(1.02406,0,0,0.652953,0.223384,39.9254)" + style="font-size:12;" + id="g164"> + <rect + width="285.502" + height="77.2688" + x="16.6979" + y="222.966" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect138" /> + <rect + width="285.502" + height="77.2688" + x="14.7335" + y="221.002" + transform="translate(-1.30962,-1.30992)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect133" /> + </g> + <g + transform="matrix(0.449834,0,0,0.338463,-3.15909,9.73319)" + style="font-size:12;" + id="g167"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect134" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect135" /> + </g> + <text + x="302.277679" + y="65.943230" + transform="scale(0.73778,0.73778)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text183"> + <tspan + x="302.277954" + y="65.943184" + id="tspan360"> +Application</tspan> + </text> + <text + x="36.235924" + y="63.796055" + transform="scale(0.73778,0.73778)" + style="font-size:14;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text188"> + <tspan + x="36.235950" + y="63.796051" + id="tspan427"> +Transient Objects</tspan> + </text> + <text + x="180.416245" + y="290.543701" + transform="scale(0.73778,0.73778)" + style="font-size:18;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text197"> + <tspan + x="180.415939" + y="290.543549" + id="tspan421"> +Database</tspan> + </text> + <text + x="25.037701" + y="179.154755" + transform="scale(0.73778,0.73778)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text216"> + <tspan + x="25.037655" + y="179.154648" + id="tspan384"> +SessionFactory</tspan> + </text> + <g + transform="matrix(0.252763,0,0,0.765831,109.104,8.98517)" + style="font-size:12;" + id="g386"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect387" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect388" /> + </g> + <g + transform="matrix(0.297394,0,0,0.572692,101.502,21.6359)" + style="font-size:12;" + id="g364"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect365" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect366" /> + </g> + <text + x="202.746506" + y="102.992203" + transform="scale(0.73778,0.73778)" + style="font-size:14;font-weight:normal;stroke-width:1pt;font-family:Helvetica;text-anchor:middle;" + id="text367"> + <tspan + x="202.746948" + y="102.992249" + id="tspan423"> +Persistent</tspan> + <tspan + x="202.746948" + y="116.992355" + id="tspan425"> +Objects</tspan> + </text> + <text + x="174.458496" + y="180.080795" + transform="scale(0.73778,0.73778)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text389"> + <tspan + x="174.458618" + y="180.080338" + id="tspan392"> +Session</tspan> + </text> + <g + transform="matrix(0.127369,0,0,0.765831,188.675,8.98517)" + style="font-size:12;" + id="g394"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect395" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect396" /> + </g> + <text + x="260.413269" + y="179.154739" + transform="scale(0.73778,0.73778)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text397"> + <tspan + x="260.412964" + y="179.154343" + id="tspan400"> +JDBC</tspan> + </text> + <g + transform="matrix(0.127369,0,0,0.765831,229.156,8.98517)" + style="font-size:12;" + id="g405"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect406" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect407" /> + </g> + <text + x="320.606903" + y="179.154739" + transform="scale(0.73778,0.73778)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text408"> + <tspan + x="320.606964" + y="179.154343" + id="tspan417"> +JNDI</tspan> + </text> + <g + transform="matrix(0.127369,0,0,0.765831,269.281,8.98517)" + style="font-size:12;" + id="g411"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect412" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect413" /> + </g> + <text + x="377.096313" + y="179.154739" + transform="scale(0.73778,0.73778)" + style="font-size:16;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text414"> + <tspan + x="377.096008" + y="179.154999" + id="tspan145"> +JTA</tspan> + </text> +</svg> Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/images/overview.png (from rev 14073, core/trunk/documentation/manual/en-US/src/main/docbook/images/overview.png) =================================================================== (Binary files differ) Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/images/overview.svg (from rev 14073, core/trunk/documentation/manual/en-US/src/main/docbook/images/overview.svg) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/images/overview.svg (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/images/overview.svg 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,250 @@ +<?xml version="1.0" standalone="no"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN" +"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd" +[ + <!ATTLIST svg + xmlns:xlink CDATA #FIXED "http://www.w3.org/1999/xlink"> +]> +<!-- Created with Sodipodi ("http://www.sodipodi.com/") --> +<svg + xmlns="http://www.w3.org/2000/svg" + xmlns:xlink="http://www.w3.org/1999/xlink" + width="248.031" + height="248.031" + id="svg1"> + <defs + id="defs3"> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad"> + <stop + style="stop-color:#000000;stop-opacity:1;" + offset="0" + id="stop128" /> + <stop + style="stop-color:#ffffff;stop-opacity:1;" + offset="1" + id="stop129" /> + </linearGradient> + <linearGradient + x1="0" + y1="0" + x2="1" + y2="0" + id="linearGradient130" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + <radialGradient + cx="0.5" + cy="0.5" + fx="0.5" + fy="0.5" + r="0.5" + id="radialGradient131" + xlink:href="#linearGradient127" + gradientUnits="objectBoundingBox" + spreadMethod="pad" /> + </defs> + <g + transform="matrix(0.771934,0,0,0.771934,4.36019,-3.02123)" + style="font-size:12;" + id="g158"> + <rect + width="285.502" + height="77.2688" + x="16.6979" + y="17.3527" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect136" /> + <rect + width="285.502" + height="77.2688" + x="14.7335" + y="15.3883" + transform="translate(-1.30962,-1.30992)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect126" /> + </g> + <g + transform="matrix(0.771934,0,0,0.771934,4.36019,3.04452)" + style="font-size:12;" + id="g161"> + <rect + width="285.502" + height="118.523" + x="16.6979" + y="99.2053" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect137" /> + <rect + width="285.502" + height="118.523" + x="13.4238" + y="95.9309" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect132" /> + </g> + <g + transform="matrix(0.771934,0,0,0.771934,4.36019,8.0993)" + style="font-size:12;" + id="g164"> + <rect + width="285.502" + height="77.2688" + x="16.6979" + y="222.966" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect138" /> + <rect + width="285.502" + height="77.2688" + x="14.7335" + y="221.002" + transform="translate(-1.30962,-1.30992)" + style="fill:#d2d2d2;fill-rule:evenodd;stroke-width:1pt;" + id="rect133" /> + </g> + <g + transform="matrix(0.771934,0,0,0.543505,2.59104,21.1103)" + style="font-size:12;" + id="g167"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect134" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect135" /> + </g> + <text + x="105.392174" + y="56.568123" + transform="scale(0.771934,0.771934)" + style="font-size:24;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text183"> + <tspan + x="105.392273" + y="56.568146" + id="tspan186"> +Application</tspan> + </text> + <text + x="81.820183" + y="103.149330" + transform="scale(0.771934,0.771934)" + style="font-size:20;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text188"> + <tspan + x="81.820213" + y="103.149727" + id="tspan206"> +Persistent Objects</tspan> + </text> + <text + x="111.548180" + y="278.927887" + transform="scale(0.771934,0.771934)" + style="font-size:24;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text197"> + <tspan + x="111.547874" + y="278.927551" + id="tspan200"> +Database</tspan> + </text> + <text + x="94.436180" + y="153.805740" + transform="scale(0.771934,0.771934)" + style="font-size:24;font-weight:normal;stroke-width:1pt;font-family:Helvetica;" + id="text216"> + <tspan + x="94.436180" + y="153.805740" + id="tspan221"> +HIBERNATE</tspan> + </text> + <g + transform="matrix(0.771934,0,0,0.771934,2.59083,1.02261)" + style="font-size:12;" + id="g254"> + <g + transform="translate(4.58374,2.61928)" + id="g176"> + <g + transform="matrix(0.571429,0,0,0.67347,-10.6174,117.093)" + id="g170"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect171" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect172" /> + </g> + <g + transform="matrix(0.571429,0,0,0.67347,138.682,117.093)" + id="g173"> + <rect + width="199.065" + height="61.5532" + x="61.8805" + y="68.4288" + style="fill:#757575;fill-rule:evenodd;stroke-width:1pt;" + id="rect174" /> + <rect + width="199.065" + height="61.5532" + x="59.2613" + y="65.8095" + style="fill:#e0e0e0;fill-rule:evenodd;stroke-width:1pt;" + id="rect175" /> + </g> + </g> + <text + x="47.259438" + y="182.367538" + style="font-weight:bold;stroke-width:1pt;font-family:Courier;" + id="text191"> + <tspan + x="47.259399" + y="182.367996" + id="tspan212"> +hibernate.</tspan> + <tspan + x="47.259399" + y="194.367996" + id="tspan214"> +properties</tspan> + </text> + <text + x="198.523010" + y="188.260941" + style="font-weight:normal;stroke-width:1pt;font-family:helvetica;" + id="text194"> + <tspan + id="tspan195"> +XML Mapping</tspan> + </text> + </g> +</svg> Copied: core/trunk/documentation/manual/zh-CN/src/main/docbook/legal_notice.xml (from rev 14073, core/trunk/documentation/manual/en-US/src/main/docbook/legal_notice.xml) =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/legal_notice.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/legal_notice.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,52 @@ +<?xml version='1.0' encoding="UTF-8"?> +<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<!-- + ~ Copyright (c) 2007, Red Hat Middleware, LLC. All rights reserved. + ~ + ~ This copyrighted material is made available to anyone wishing to use, modify, + ~ copy, or redistribute it subject to the terms and conditions of the GNU + ~ Lesser General Public License, v. 2.1. This program is distributed in the + ~ hope that it will be useful, but WITHOUT A WARRANTY; without even the implied + ~ warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + ~ Lesser General Public License for more details. You should have received a + ~ copy of the GNU Lesser General Public License, v.2.1 along with this + ~ distribution; if not, write to the Free Software Foundation, Inc., + ~ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + ~ + ~ Red Hat Author(s): Steve Ebersole + --> +<legalnotice id="Legal_Notice"> + <title>Legal Notice</title> + <para> + <address> + <street>1801 Varsity Drive</street> + <city>Raleigh</city>, <state>NC</state><postcode>27606-2072</postcode><country>USA</country> + <phone>Phone: +1 919 754 3700</phone> + <phone>Phone: 888 733 4281</phone> + <fax>Fax: +1 919 754 3701</fax> + <pob>PO Box 13588</pob><city>Research Triangle Park</city>, <state>NC</state><postcode>27709</postcode><country>USA</country> + </address> + </para> + <para> + Copyright <trademark class="copyright"></trademark> 2007 by Red Hat, Inc. This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, V1.0 or later (the latest version is presently available at <ulink url="http://www.opencontent.org/openpub/">http://www.opencon...>). + </para> + <para> + Distribution of substantively modified versions of this document is prohibited without the explicit permission of the copyright holder. + </para> + <para> + Distribution of the work or derivative of the work in any standard (paper) book form for commercial purposes is prohibited unless prior permission is obtained from the copyright holder. + </para> + <para> + Red Hat and the Red Hat "Shadow Man" logo are registered trademarks of Red Hat, Inc. in the United States and other countries. + </para> + <para> + All other trademarks referenced herein are the property of their respective owners. + </para> + <para> + The GPG fingerprint of the security(a)redhat.com key is: + </para> + <para> + CA 20 86 86 2B D6 9D FC 65 F6 EC C4 21 91 80 CD DB 42 A6 0E + </para> +</legalnotice> \ No newline at end of file Deleted: core/trunk/documentation/manual/zh-CN/src/main/docbook/master.xml =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/master.xml 2007-10-09 19:32:35 UTC (rev 14080) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/master.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -1,474 +0,0 @@ -<?xml version='1.0' encoding="UTF-8"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" - "../support/docbook-dtd/docbookx.dtd" -[ -<!ENTITY tutorial SYSTEM "modules/tutorial.xml"> -<!ENTITY architecture SYSTEM "modules/architecture.xml"> -<!ENTITY configuration SYSTEM "modules/configuration.xml"> -<!ENTITY persistent-classes SYSTEM "modules/persistent_classes.xml"> -<!ENTITY basic-mapping SYSTEM "modules/basic_mapping.xml"> -<!ENTITY collection-mapping SYSTEM "modules/collection_mapping.xml"> -<!ENTITY association-mapping SYSTEM "modules/association_mapping.xml"> -<!ENTITY component-mapping SYSTEM "modules/component_mapping.xml"> -<!ENTITY inheritance-mapping SYSTEM "modules/inheritance_mapping.xml"> -<!ENTITY session-api SYSTEM "modules/session_api.xml"> -<!ENTITY transactions SYSTEM "modules/transactions.xml"> -<!ENTITY events SYSTEM "modules/events.xml"> -<!ENTITY batch SYSTEM "modules/batch.xml"> -<!ENTITY query-hql SYSTEM "modules/query_hql.xml"> -<!ENTITY query-criteria SYSTEM "modules/query_criteria.xml"> -<!ENTITY query-sql SYSTEM "modules/query_sql.xml"> -<!ENTITY filters SYSTEM "modules/filters.xml"> -<!ENTITY xml SYSTEM "modules/xml.xml"> -<!ENTITY performance SYSTEM "modules/performance.xml"> -<!ENTITY toolset-guide SYSTEM "modules/toolset_guide.xml"> -<!ENTITY example-parentchild SYSTEM "modules/example_parentchild.xml"> -<!ENTITY example-weblog SYSTEM "modules/example_weblog.xml"> -<!ENTITY example-mappings SYSTEM "modules/example_mappings.xml"> -<!ENTITY best-practices SYSTEM "modules/best_practices.xml"> -]> - - -<book lang="zh-cn"> - - <bookinfo> - <title>HIBERNATE - 符合Java习惯的关系数据库持久化</title> - - <subtitle>Hibernate参考文档</subtitle> - <releaseinfo>3.2</releaseinfo> - </bookinfo> - - <toc/> - - <preface id="preface" revision="2"> - <title>前言</title> - - <para> - WARNING! This is a translated version of the English Hibernate reference - documentation. The translated version might not be up to date! However, the - differences should only be very minor. Consult the English reference - documentation if you are missing information or encounter a translation - error. If you like to contribute to a particular translation, contact us - on the Hibernate developer mailing list. - </para> - - <para> - Translator(s): RedSaga Translate Team 满江红翻译团队 &amp;lt;caoxg(a)yahoo.com&amp;gt; - </para> - - <para> - 在今日的企业环境中，把面向对象的软件和关系数据库一起使用可能是相当麻烦、浪费时间的。Hibernate是一个面向Java环境的对象/关系数据库映射工具。对象/关系数据库映射(object/relational mapping (ORM))这个术语表示一种技术，用来把对象模型表示的对象映射到基于SQL的关系模型数据结构中去。 - </para> - - <para> - Hibernate不仅仅管理Java类到数据库表的映射（包括Java数据类型到SQL数据类型的映射），还提供数据查询和获取数据的方法，可以大幅度减少开发时人工使用SQL和JDBC处理数据的时间。 - </para> - - <para> - Hibernate的目标是对于开发者通常的数据持久化相关的编程任务，解放其中的95%。对于以数据为中心的程序来说,它们往往只在数据库中使用存储过程来实现商业逻辑,Hibernate可能不是最好的解决方案;对于那些在基于Java的中间层应用中，它们实现面向对象的业务模型和商业逻辑的应用，Hibernate是最有用的。不管怎样，Hibernate一定可以帮助你消除或者包装那些针对特定厂商的SQL代码，并且帮你把结果集从表格式的表示形式转换到一系列的对象去。 - </para> - - <para> - 如果你对Hibernate和对象/关系数据库映射还是个新手，或者甚至对Java也不熟悉，请按照下面的步骤来学习。 - </para> - - <orderedlist> - <listitem> - <para> - 阅读<xref linkend="tutorial"/>，这是一篇包含详细的逐步指导的指南。本指南的源代码包含在发行包中，你可以在<literal>doc/reference/tutorial/</literal>目录下找到。 </para> - </listitem> - <listitem> - <para> - 阅读<xref linkend="architecture"/>来理解Hibernate可以使用的环境。 - </para> - </listitem> - <listitem> - <para> - 查看Hibernate发行包中的<literal>eg/</literal>目录，里面有一个简单的独立运行的程序。把你的JDBC驱动拷贝到<literal>lib/</literal>目录下，修改一下<literal>src/hibernate.properties</literal>,指定其中你的数据库的信息。进入命令行，切换到你的发行包的目录，输入<literal>ant eg</literal>(使用了Ant），或者在Windows操作系统中使用<literal>build eg</literal>。 - </para> - </listitem> - <listitem> - <para> - 把这份参考文档作为你学习的主要信息来源。 - </para> - </listitem> - <listitem> - <para> - 在Hibernate 的网站上可以找到经常提问的问题与解答(FAQ)。 - </para> - </listitem> - <listitem> - <para> - 在Hibernate网站上还有第三方的演示、示例和教程的链接。 - </para> - </listitem> - <listitem> - <para> - Hibernate网站的“社区(Community Area)”是讨论关于设计模式以及很多整合方案(Tomcat, JBoss AS, Struts, EJB,等等)的好地方。 - </para> - </listitem> - </orderedlist> - - <para> - 如果你有问题，请使用Hibernate网站上链接的用户论坛。我们也提供一个JIRA问题追踪系统，来搜集bug报告和新功能请求。如果你对开发Hibernate有兴趣，请加入开发者的邮件列表。（Hibernate网站上的用户论坛有一个中文版面，JavaEye也有Hibernate中文版面,您可以在那里交流问题与经验。） - </para> - - <para> - 商业开发、产品支持和Hibernate培训可以通过JBoss Inc.获得。（请查阅：http://www.hibernate.org/SupportTraining/）。 - Hibernate是一个专业的开放源代码项目(Professional Open Source project)，也是JBoss Enterprise Middleware System(JEMS),JBoss企业级中间件系统的一个核心组件。 - </para> - - <sect1 id="preface-translate-comments-zh-cn"> - <title>翻译说明</title> - - <para> - 本文档的翻译是在网络上协作进行的，也会不断根据Hibernate的升级进行更新。提供此文档的目的是为了减缓学习Hibernate的坡度，而非代替原文档。我们建议所有有能力的读者都直接阅读英文原文。若您对翻译有异议，或发现翻译错误，敬请不吝赐教，报告到如下email地址：cao at redsaga.com - </para> - - <para> - Hibernate版本3的翻译由满江红翻译团队(RedSaga Translate Team)集体进行，这也是一次大规模网络翻译的试验。在不到20天的时间内，我们完成了两百多页文档的翻译，这一成果是通过十几位网友集体努力完成的。通过这次翻译，我们也有了一套完整的流程，从初译、技术审核一直到文字审核、发布。我们的翻译团队还会继续完善我们的翻译流程，并翻译其他优秀的Java开源资料，敬请期待。 - </para> - - <table frame="topbot" id="redsaga-translate-team"> - <title> - Hibernate v3翻译团队 - </title> - <tgroup cols="5" rowsep="1" colsep="1"> - <colspec colname="c1" colwidth="1*"/> - <colspec colname="c2" colwidth="2*"/> - <colspec colname="c3" colwidth="2*"/> - <colspec colname="c4" colwidth="2*"/> - <colspec colname="c5" colwidth="2*"/> - <thead> - <row> - <entry align="center"> - 序号 - </entry> - <entry align="center"> - 标题 - </entry> - <entry align="center"> - 中文标题 - </entry> - <entry align="center"> - v3翻译 - </entry> - <entry align="center"> - v3审校 - </entry> - <entry align="center"> - v3.1审校 - </entry> - </row> - </thead> - <tbody> - <row> - <entry>--</entry> - <entry>Quickstart with Tomcat</entry> - <entry>在Tomcat中快速上手(3.1版本中取消）</entry> - <entry>曹晓钢</entry> - <entry>zoujm</entry> - <entry>--</entry> - </row> - <row> - <entry>#1</entry> - <entry>Turtotial</entry> - <entry>Hibernate入门</entry> - <entry>Zheng Shuai</entry> - <entry>-</entry> - <entry>Sean Chan</entry> - </row> - <row> - <entry>#2</entry> - <entry>Architecture</entry> - <entry>体系结构</entry> - <entry>Hilton(BJUG)</entry> - <entry>厌倦发呆</entry> - <entry>Sean Chan</entry> - </row> - <row> - <entry>#3</entry> - <entry>Configuration</entry> - <entry>配置</entry> - <entry>Goncha</entry> - <entry>mochow</entry> - <entry>zcgly</entry> - </row> - <row> - <entry>#4</entry> - <entry>Persistent Classes</entry> - <entry>持久化类</entry> - <entry>曹晓钢</entry> - <entry>mochow</entry> - <entry>DigitalSonic</entry> - </row> - <row> - <entry>#5</entry> - <entry>Basic O/R Mapping</entry> - <entry>对象/关系数据库映射基础(上)</entry> - <entry>moxie</entry> - <entry>Kingfish</entry> - <entry>张成钢</entry> - </row> - <row> - <entry></entry> - <entry></entry> - <entry>对象/关系数据库映射基础(下)</entry> - <entry>inter_dudu</entry> - <entry>刘国雄(vincent)</entry> - <entry>张成钢</entry> - </row> - <row> - <entry>#6</entry> - <entry>Collection Mapping</entry> - <entry>集合类映射</entry> - <entry>曹晓钢</entry> - <entry>robbin</entry> - <entry>--</entry> - </row> - <row> - <entry>#7</entry> - <entry>Association Mappings</entry> - <entry>关联关系映射</entry> - <entry>Robbin</entry> - <entry>devils.advocate</entry> - <entry>--</entry> - </row> - <row> - <entry>#8</entry> - <entry>Component Mapping</entry> - <entry>组件映射</entry> - <entry>曹晓钢</entry> - <entry>Robbin</entry> - <entry>Song guo qiang</entry> - </row> - <row> - <entry>#9</entry> - <entry>Inheritance Mappings</entry> - <entry>继承映射</entry> - <entry>morning(BJUG)</entry> - <entry>mochow</entry> - <entry>Liang cheng</entry> - </row> - <row> - <entry>#10</entry> - <entry>Working with objects</entry> - <entry>与对象共事</entry> - <entry>程广楠</entry> - <entry>厌倦发呆</entry> - <entry>--</entry> - </row> - <row> - <entry>#11</entry> - <entry>Transactions And Concurrency</entry> - <entry>事务和并发</entry> - <entry>Robbin</entry> - <entry>mochow</entry> - <entry>--</entry> - </row> - <row> - <entry>#12</entry> - <entry>Interceptors and events</entry> - <entry>继承映射</entry> - <entry>七彩狼(BJUG)</entry> - <entry>厌倦发呆</entry> - <entry>--</entry> - </row> - <row> - <entry>#13</entry> - <entry>Batch processing</entry> - <entry>批量处理</entry> - <entry>Kingfish(BJUG)</entry> - <entry>厌倦发呆</entry> - <entry>--</entry> - </row> - <row> - <entry>#14</entry> - <entry>HQL: The Hibernate Query Language</entry> - <entry>HQL: Hibernate查询语言</entry> - <entry>郑浩(BJUG)</entry> - <entry>Zheng Shuai</entry> - <entry>--</entry> - </row> - <row> - <entry>#15</entry> - <entry>Criteria Queries</entry> - <entry>条件查询</entry> - <entry>nemo(BJUG)</entry> - <entry>Zheng Shuai</entry> - <entry>--</entry> - </row> - <row> - <entry>#16</entry> - <entry>Native SQL</entry> - <entry>Native SQL查询</entry> - <entry>似水流年</entry> - <entry>zoujm</entry> - <entry>--</entry> - </row> - <row> - <entry>#17</entry> - <entry>Filters</entry> - <entry>过滤数据</entry> - <entry>冰云(BJUG)</entry> - <entry>Goncha</entry> - <entry>--</entry> - </row> - <row> - <entry>#18</entry> - <entry>XML Mapping</entry> - <entry>XML映射</entry> - <entry>edward(BJUG)</entry> - <entry>Goncha</entry> - <entry>huxb</entry> - </row> - <row> - <entry>#19</entry> - <entry>Improving performance</entry> - <entry>性能提升</entry> - <entry>Wangjinfeng</entry> - <entry>Robbin</entry> - <entry>--</entry> - </row> - <row> - <entry>#20</entry> - <entry>Toolset Guide</entry> - <entry>工具箱指南</entry> - <entry>曹晓钢</entry> - <entry>Robbin</entry> - <entry>--</entry> - </row> - <row> - <entry>#21</entry> - <entry>Example: Parent/Child</entry> - <entry>示例：父子关系</entry> - <entry>曹晓钢</entry> - <entry>devils.advocate</entry> - <entry>--</entry> - </row> - <row> - <entry>#22</entry> - <entry>Example: Weblog Application</entry> - <entry>示例：Weblog 应用程序</entry> - <entry>曹晓钢</entry> - <entry>devils.advocate</entry> - <entry>--</entry> - </row> - <row> - <entry>#23</entry> - <entry>Example: Various Mappings</entry> - <entry>示例：多种映射</entry> - <entry>shidu(BJUG)</entry> - <entry>冰云</entry> - <entry>--</entry> - </row> - <row> - <entry>#24</entry> - <entry>Best Practices</entry> - <entry>最佳实践</entry> - <entry>曹晓钢</entry> - <entry>冰云</entry> - <entry>--</entry> - </row> - </tbody> - </tgroup> - </table> - - <para> - v3.2版本在2006年11月份由曹晓钢更新。 - </para> - - <para> - 关于我们 - </para> - - - <variablelist spacing="compact"> - <varlistentry> - <term>满江红.开源, http://www.redsaga.com</term> - <listitem> - <para> - 从成立之初就致力于Java开放源代码在中国的传播与发展,与国内多个Java团体及出版社有深入交流。坚持少说多做的原则，目前有两个团队，“OpenDoc团队”与“翻译团队”，本翻译文档即为翻译团队作品。OpenDoc团队已经推出包括Hibernate、iBatis、Spring、WebWork的多份开放文档，并于2005年5月在Hibernate开放文档基础上扩充成书，出版了原创书籍：《深入浅出Hibernate》，本书400余页，适合各个层次的Hibernate用户。(http://www.redsaga.com/hibernate_book.html)敬请支持。 - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>北京Java用户组, http://www.bjug.org</term> - <listitem> - <para> - Beiing Java User Group，民间技术交流组织，成立于2004年6月。以交流与共享为宗旨，每两周举行一次技术聚会活动。BJUG的目标是，通过小部分人的努力，形成一个技术社群，创建良好的交流氛围，并将新的技术和思想推广到整个IT界，让我们共同进步。 - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>Java视线, http://www.javaeye.com</term> - <listitem> - <para> - Java视线在是Hibernate中文论坛（http://www.hibernate.org.cn，Hibernate中文论坛是中国最早的Hibernate专业用户论坛，为Hibernate在中国的推广做出了巨大的贡献）基础上发展起来的Java深度技术网站，目标是成为一个高品质的，有思想深度的、原创精神的Java技术交流网站，为软件从业人员提供一个自由的交流技术，交流思想和交流信息的平台。 - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>致谢</term> - <listitem> - <para>还有一些朋友给我们发来了勘误，在此致谢：Kurapica，李毅，李海林。 - </para> - </listitem> - </varlistentry> - </variablelist> - - </sect1> - - <sect1 id="preface-translate-licence-zh-cn"> - <title>版权声明</title> - - <para> - Hibernate英文文档属于Hibernate发行包的一部分，遵循LGPL协议。本翻译版本同样遵循LGPL协议。参与翻译的译者一致同意放弃除署名权外对本翻译版本的其它权利要求。 - </para> - - <para> - 您可以自由链接、下载、传播此文档，或者放置在您的网站上，甚至作为产品的一部分发行。但前提是必须保证全文完整转载，包括完整的版权信息和作译者声明，并不能违反LGPL协议。这里“完整”的含义是，不能进行任何删除/增添/注解。若有删除/增添/注解，必须逐段明确声明那些部分并非本文档的一部分。 - </para> - </sect1> - - </preface> - - &tutorial; - - &architecture; - - &configuration; - - &persistent-classes; - - &basic-mapping; - &collection-mapping; - &association-mapping; - &component-mapping; - &inheritance-mapping; - - &session-api; - &transactions; - &events; - &batch; - - &query-hql; - &query-criteria; - &query-sql; - &filters; - &xml; - - &performance; - - &toolset-guide; - - &example-parentchild; - &example-weblog; - &example-mappings; - - &best-practices; - -</book> - Added: core/trunk/documentation/manual/zh-CN/src/main/docbook/translators.xml =================================================================== --- core/trunk/documentation/manual/zh-CN/src/main/docbook/translators.xml (rev 0) +++ core/trunk/documentation/manual/zh-CN/src/main/docbook/translators.xml 2007-10-09 20:10:34 UTC (rev 14081) @@ -0,0 +1,17 @@ +<?xml version='1.0' encoding="UTF-8"?> + +<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<authorgroup id="translators"> + + <othercredit class="translator"> + <firstname>Cao</firstname> + <surname>Xiaogang</surname> + <affiliation> + <orgname>RedSaga</orgname> + </affiliation> + <contrib>Translation Lead</contrib> + <email&gt;caoxg(a)yahoo.com&lt;/email&gt; + </othercredit> + +</authorgroup>