Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HHH-8904 documentation for build time bytecode enhancements

This commit is contained in:
Jeremy Whiting 2014-01-28 19:11:07 +00:00 committed by Brett Meyer
parent a39eeed257
commit 9fe3862e55
1 changed files with 69 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
documentation/src/main/docbook/manual/en-US/content/performance.xml
View File

@ -1365,13 +1365,77 @@ hibernate.cache.use_structured_entries true</programlisting>
<section xml:id="entityentry-lookup-buildtime-instrument">
<title>Buildtime instrument</title>
<para>Besides above two approaches, Hibernate also provides you the third choice, which is an ANT task (
<classname>org.hibernate.tool.enhance.EnhancementTask</classname>) that can be used at build time to
instrument your entity classes with the required interfaces and methods.
<para>Besides above two approaches, Hibernate also provides you a
third choice which is build time bytecode enhancement. Applications
should use enhanced entity classes annotated with either <classname>javax.persistence.Entity</classname>
or composite <classname>javax.persistence.Embeddable</classname>.
Meanwhile, the maven and gradle plugin are still under development and will be available soon.
<section xml:id="entityentry-lookup-buildtime-instrument-ant">
<title>Ant Task</title>
<para>To use the task <classname>org.hibernate.tool.enhance.EnhancementTask</classname>
define a taskdef and call the task as the example shows. This code uses a
pre defined classpathref and a property referencing the compiled classes
directory.
<programlisting role="XML">&lt;taskdef name="enhance" classname="org.hibernate.tool.enhance.EnhancementTask" classpathref="enhancement.classpath" /&gt;
&lt;enhance&gt;
&lt;fileset dir="${ejb-classes}/org/hibernate/auction/model" includes="**/*.class"/&gt;
&lt;/enhance&gt;</programlisting>
</para>
<note>
<para>The EnhancementTask is intended as a replacement for <link linkend="performance-fetching-lazyproperties">InstrumentTask</link>. It is also incompatible so instrumented classels
will need building from source again.</para>
</note>
</section>
<section xml:id="entityentry-lookup-buildtime-instrument-maven">
<title>Maven Plugin</title>
<para>The Maven Plugin uses a Mojo descriptor to attach the Mojo to the compile
phase for your project.
<programlisting role="XML">&lt;dependencies&gt;
&lt;dependency&gt;
&lt;groupId&gt;org.hibernate.javax.persistence&lt;/groupId&gt;
&lt;artifactId&gt;hibernate-jpa-[SPEC-VERSION]-api&lt;/artifactId&gt;
&lt;version&gt;[IMPL-VERSION]&lt;/version&gt;
&lt;scope&gt;compile&lt;/scope&gt;
&lt;/dependency&gt;
&lt;/dependencies&gt;
&lt;plugins&gt;
&lt;plugin&gt;
&lt;groupId&gt;org.hibernate.orm.tooling&lt;/groupId&gt;
&lt;artifactId&gt;hibernate-enhance-maven-plugin&lt;/artifactId&gt;
&lt;version&gt;VERSION&lt;/version&gt;
&lt;executions&gt;
&lt;execution&gt;
&lt;goals&gt;
&lt;goal&gt;enhance&lt;/goal&gt;
&lt;/goals&gt;
&lt;/execution&gt;
&lt;/executions&gt;
&lt;/plugin&gt;</programlisting>
</para>
</section>
<section xml:id="entityentry-lookup-buildtime-instrument-gradle">
<title>Gradle Plugin</title>
<para>The Gradle plugin adds an enhance task using the output directory of
the compile task as the source location of entity class files to enhance.
<programlisting>apply plugin: 'java'
apply plugin: 'maven'
apply plugin: 'enhance'
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'org.hibernate:hibernate-gradle-plugin:VERSION'
}
}
dependencies {
compile group: 'org.hibernate.javax.persistence', name: 'hibernate-jpa-[SPEC-VERSION]-api', version: '[IMPL-VERSION]'
compile group: 'org.hibernate', name: 'hibernate-gradle-plugin', version: 'VERSION'
}
</programlisting>
</para>
</section>
</para>
</section>
</section>