-
Notifications
You must be signed in to change notification settings - Fork 566
/
annotationprocessor.xml
515 lines (426 loc) · 18.7 KB
/
annotationprocessor.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ JBoss, Home of Professional Open Source
~ Copyright 2009, Red Hat, Inc. and/or its affiliates, and individual contributors
~ by the @authors tag. See the copyright.txt in the distribution for a
~ full listing of individual contributors.
~
~ Licensed under the Apache License, Version 2.0 (the "License");
~ you may not use this file except in compliance with the License.
~ You may obtain a copy of the License at
~ http://www.apache.org/licenses/LICENSE-2.0
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "../hv.ent">
%BOOK_ENTITIES;
]>
<chapter id="validator-annotation-processor">
<title>Annotation Processor</title>
<para>Have you ever caught yourself by unintentionally doing things
like</para>
<itemizedlist>
<listitem>
<para>specifying constraint annotations at unsupported data types (e.g.
by annotating a String with @Past)</para>
</listitem>
<listitem>
<para>annotating the setter of a JavaBean property (instead of the
getter method)</para>
</listitem>
<listitem>
<para>annotating static fields/methods with constraint annotations
(which is not supported)?</para>
</listitem>
</itemizedlist>
<para>Then the Hibernate Validator Annotation Processor is the right thing
for you. It helps preventing such mistakes by plugging into the build
process and raising compilation errors whenever constraint annotations are
incorrectly used.</para>
<note>
<para>You can find the Hibernate Validator Annotation Processor as part of
the distribution bundle on <ulink
url="http://sourceforge.net/projects/hibernate/files/hibernate-validator">Sourceforge</ulink>
or in the JBoss Maven Repository (see <xref
linkend="example-jboss-maven-url" />) under the GAV
org.hibernate:hibernate-validator-annotation-processor.</para>
</note>
<section id="validator-annotationprocessor-prerequisites">
<title>Prerequisites</title>
<para>The Hibernate Validator Annotation Processor is based on the
"Pluggable Annotation Processing API" as defined by <ulink
url="http://jcp.org/en/jsr/detail?id=269">JSR 269</ulink>. This API is
part of the Java Platform since Java 6. So be sure to use this or a later
version.</para>
</section>
<section id="validator-annotationprocessor-features">
<title>Features</title>
<para>As of Hibernate Validator &version; the Hibernate Validator
Annotation Processor checks that:</para>
<itemizedlist>
<listitem>
<para>constraint annotations are allowed for the type of the annotated
element</para>
</listitem>
<listitem>
<para>only non-static fields or methods are annotated with constraint
annotations</para>
</listitem>
<listitem>
<para>only non-primitive fields or methods are annotated with
@Valid</para>
</listitem>
<listitem>
<para>only such methods are annotated with constraint annotations
which are valid JavaBeans getter methods (optionally, see
below)</para>
</listitem>
<listitem>
<para>only such annotation types are annotated with constraint
annotations which are constraint annotations themselves</para>
</listitem>
<listitem>
<para>definition of dynamic default group sequence with
@GroupSequenceProvider is valid</para>
</listitem>
</itemizedlist>
</section>
<section id="validator-annotationprocessor-options">
<title>Options</title>
<para>The behavior of the Hibernate Validator Annotation Processor can be
controlled using the <ulink
url="http://java.sun.com/javase/6/docs/technotes/tools/windows/javac.html#options">processor
options</ulink> listed in table<xref
linkend="table_processor_options" />:</para>
<table id="table_processor_options">
<title>Hibernate Validator Annotation Processor options</title>
<tgroup cols="2">
<thead>
<row>
<entry align="center">Option</entry>
<entry align="center">Explanation</entry>
</row>
</thead>
<tbody>
<row>
<entry><varname>diagnosticKind</varname></entry>
<entry>Controls how constraint problems are reported. Must be the
string representation of one of the values from the enum
<classname>javax.tools.Diagnostic.Kind</classname>, e.g.
<classname>WARNING</classname>. A value of
<classname>ERROR</classname> will cause compilation to halt
whenever the AP detects a constraint problem. Defaults to
<classname>ERROR</classname>.</entry>
</row>
<row>
<entry><varname>methodConstraintsSupported</varname></entry>
<entry>Controls whether constraints are allowed at methods of any
kind. Must be set to <varname>true</varname> when working with
method level constraints as supported by Hibernate Validator. Can
be set to <varname>false</varname> to allow constraints only at
JavaBeans getter methods as defined by the Bean Validation API.
Defaults to <varname>true</varname>.</entry>
</row>
<row>
<entry><varname>verbose</varname></entry>
<entry>Controls whether detailed processing information shall be
displayed or not, useful for debugging purposes. Must be either
<varname>true</varname> or <varname>false</varname>. Defaults to
<varname>false</varname>.</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section id="validator-annotationprocessor-usage">
<title>Using the Annotation Processor</title>
<para>This section shows in detail how to integrate the Hibernate
Validator Annotation Processor into command line builds (javac, Ant,
Maven) as well as IDE-based builds (Eclipse, IntelliJ IDEA,
NetBeans).</para>
<section id="validator-annotationprocessor-commandline">
<title>Command line builds</title>
<section id="validator-annotationprocessor-javac">
<title>javac</title>
<para>When compiling on the command line using <ulink
url="http://java.sun.com/javase/6/docs/technotes/guides/javac/index.html">javac</ulink>,
specify the following JARs using the "processorpath" option:</para>
<itemizedlist>
<listitem>
<para>validation-api-&bvVersion;.jar</para>
</listitem>
<listitem>
<para>hibernate-validator-&version;.jar</para>
</listitem>
<listitem>
<para>hibernate-validator-annotation-processor-&version;.jar</para>
</listitem>
</itemizedlist>
<para>The following listing shows an example. The processor will be
detected automatically by the compiler and invoked during
compilation.</para>
<example>
<title>Using the annotation processor with javac</title>
<programlisting>javac src/main/java/org/hibernate/validator/ap/demo/Car.java \
-cp /path/to/validation-api-&bvVersion;.jar \
-processorpath /path/to/validation-api-&bvVersion;.jar:/path/to/hibernate-validator-&version;:/path/to/hibernate-validator-annotation-processor-&version;.jar</programlisting>
</example>
</section>
<section id="validator-annotationprocessor-ant">
<title>Apache Ant</title>
<para>Similar to directly working with javac, the annotation processor
can be added as as compiler argument when invoking the <ulink
url="http://ant.apache.org/manual/CoreTasks/javac.html">javac
task</ulink> for <ulink url="http://ant.apache.org/">Apache
Ant</ulink>:</para>
<example>
<title>Using the annotation processor with Ant</title>
<programlisting><javac srcdir="src/main"
destdir="build/classes"
classpath="/path/to/validation-api-&bvVersion;.jar">
<compilerarg value="-processorpath" />
<compilerarg value="/path/to/validation-api-&bvVersion;.jar:/path/to/hibernate-validator-&version;:/path/to/hibernate-validator-annotation-processor-&version;.jar"/>
</javac></programlisting>
</example>
</section>
<section>
<title>Maven</title>
<para>There are several options for integrating the annotation
processor with <ulink url="http://maven.apache.org/">Apache
Maven</ulink>. Generally it is sufficient to add the Hibernate
Validator Annotation Processor as dependency to your project:</para>
<example>
<title>Adding the HV Annotation Processor as dependency</title>
<programlisting>...
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator-annotation-processor</artifactId>
<version>&version;</version>
<scope>compile</scope>
</dependency>
... </programlisting>
</example>
<para>The processor will then be executed automatically by the
compiler. This basically works, but comes with the disadavantage that
in some cases messages from the annotation processor are not displayed
(see <ulink
url="http://jira.codehaus.org/browse/MCOMPILER-66">MCOMPILER-66</ulink>).</para>
<para>Another option is using the <ulink
url="http://code.google.com/p/maven-annotation-plugin/">Maven
Annotation Plugin</ulink>. At the time of this writing the plugin is
not yet available in any of the well-known repositories. Therefore you
have to add the project's own repository to your settings.xml or
pom.xml:</para>
<para><example>
<title>Adding the Maven Annotation Plugin repository</title>
<programlisting>...
<pluginRepositories>
<pluginRepository>
<id>maven-annotation-plugin-repo</id>
<url>http://maven-annotation-plugin.googlecode.com/svn/trunk/mavenrepo</url>
</pluginRepository>
</pluginRepositories>
... </programlisting>
</example> Now disable the standard annotation processing performed
by the compiler plugin and configure the annotation plugin by
specifying an execution and adding the Hibernate Validator Annotation
Processor as plugin dependency (that way the AP is not visible on the
project's actual classpath):</para>
<example>
<title>Configuring the Maven Annotation Plugin</title>
<programlisting>...
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>1.6</source>
<target>1.6</target>
<compilerArgument>-proc:none</compilerArgument>
</configuration>
</plugin>
<plugin>
<groupId>org.bsc.maven</groupId>
<artifactId>maven-processor-plugin</artifactId>
<version>1.3.4</version>
<executions>
<execution>
<id>process</id>
<goals>
<goal>process</goal>
</goals>
<phase>process-sources</phase>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator-annotation-processor</artifactId>
<version>&version;</version>
<scope>compile</scope>
</dependency>
</dependencies>
</plugin>
...
</programlisting>
</example>
</section>
</section>
<section id="validator-annotationprocessor-ide">
<title>IDE builds</title>
<section>
<title>Eclipse</title>
<para>Do the following to use the annotation processor within the
<ulink url="http://www.eclipse.org/">Eclipse</ulink> IDE:</para>
<itemizedlist>
<listitem>
<para>Right-click your project, choose "Properties"</para>
</listitem>
<listitem>
<para>Go to "Java Compiler" and make sure, that "Compiler
compliance level" is set to "1.6". Otherwise the processor won't
be activated</para>
</listitem>
<listitem>
<para>Go to "Java Compiler - Annotation Processing" and choose
"Enable annotation processing"</para>
</listitem>
<listitem>
<para>Go to "Java Compiler - Annotation Processing - Factory Path"
and add the following JARs:</para>
<itemizedlist>
<listitem>
<para>validation-api-&bvVersion;.jar</para>
</listitem>
<listitem>
<para>hibernate-validator-&version;.jar</para>
</listitem>
<listitem>
<para>hibernate-validator-annotation-processor-&version;.jar</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Confirm the workspace rebuild</para>
</listitem>
</itemizedlist>
<para>You now should see any annotation problems as regular error
markers within the editor and in the "Problem" view:</para>
<mediaobject>
<imageobject>
<imagedata align="center" arch="" contentwidth="150mm"
fileref="annotation_processor_eclipse.png" />
</imageobject>
</mediaobject>
</section>
<section id="validator-annotationprocessor-idea">
<title>IntelliJ IDEA</title>
<para>The following steps must be followed to use the annotation
processor within <ulink url="http://www.jetbrains.com/idea/">IntelliJ
IDEA</ulink> (version 9 and above):</para>
<itemizedlist>
<listitem>
<para>Go to "File", then "Settings",</para>
</listitem>
<listitem>
<para>Expand the node "Compiler", then "Annotation
Processors"</para>
</listitem>
<listitem>
<para>Choose "Enable annotation processing" and enter the
following as "Processor path":
/path/to/validation-api-&bvVersion;.jar:/path/to/hibernate-validator-&version;.jar:/path/to/hibernate-validator-annotation-processor-&version;.jar</para>
</listitem>
<listitem>
<para>Add the processor's fully qualified name
<classname>org.hibernate.validator.ap.ConstraintValidationProcessor</classname>
to the "Annotation Processors" list</para>
</listitem>
<listitem>
<para>If applicable add you module to the "Processed Modules"
list</para>
</listitem>
</itemizedlist>
<para>Rebuilding your project then should show any erronous constraint
annotations:</para>
<mediaobject>
<imageobject>
<imagedata align="center" arch="" contentwidth="150mm"
fileref="annotation_processor_intellij.png" />
</imageobject>
</mediaobject>
</section>
<section id="validator-annotationprocessor-netbeans">
<title>NetBeans</title>
<para>Starting with version 6.9, also the <ulink
url="http://www.netbeans.org/">NetBeans</ulink> IDE supports using
annotation processors within the IDE build. To do so, do the
following:</para>
<itemizedlist>
<listitem>
<para>Right-click your project, choose "Properties"</para>
</listitem>
<listitem>
<para>Go to "Libraries", tab "Processor", and add the following
JARs:</para>
<itemizedlist>
<listitem>
<para>validation-api-&bvVersion;.jar</para>
</listitem>
<listitem>
<para>hibernate-validator-&version;.jar</para>
</listitem>
<listitem>
<para>hibernate-validator-annotation-processor-&version;.jar</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Go to "Build - Compiling", select "Enable Annotation
Processing" and "Enable Annotation Processing in Editor". Add the
annotation processor by specifying its fully qualified name
<classname>org.hibernate.validator.ap.ConstraintValidationProcessor</classname></para>
</listitem>
</itemizedlist>
<para>Any constraint annotation problems will then be marked directly
within the editor:</para>
<mediaobject>
<imageobject>
<imagedata align="center" arch="" contentwidth="150mm"
fileref="annotation_processor_netbeans.png" />
</imageobject>
</mediaobject>
</section>
</section>
</section>
<section id="validator-annotationprocessor-known-issues">
<title>Known issues</title>
<para>The following known issues exist as of May 2010:</para>
<itemizedlist>
<listitem>
<para><ulink
url="http://opensource.atlassian.com/projects/hibernate/browse/HV-308">HV-308</ulink>:
Additional validators registered for a constraint <ulink
url="http://docs.jboss.org/hibernate/stable/validator/reference/en/html_single/#d0e1957">using
XML</ulink> are not evaluated by the annotation processor.</para>
</listitem>
<listitem>
<para>Sometimes custom constraints can't be <ulink
url="http://opensource.atlassian.com/projects/hibernate/browse/HV-293">properly
evaluated</ulink> when using the processor within Eclipse. Cleaning
the project can help in these situations. This seems to be an issue
with the Eclipse JSR 269 API implementation, but further investigation
is required here.</para>
</listitem>
<listitem>
<para>When using the processor within Eclipse, the check of dynamic
default group sequence definitions doesn't work. After further
investigation, it seems to be an issue with the Eclipse JSR 269 API
implementation.</para>
</listitem>
</itemizedlist>
</section>
</chapter>