Problems
- Eliminate — in favor of —
— was causing 'no such entity' errors during docbook
processing; — produces the equivalent output.
- Fix column issues in appendices
column counts were set to 3, when they are in fact 4. This passed
under DocBook 4 and Spring Build for unknown reasons, but caused a
hard stop under DocBook 5 and the docbook-reference-plugin.
- Add jdbc callout section in docbook 5-friendly style
use <co/> tags as advertised in DocBook documentation.
- Set correct widths for PDF ref doc images
images were rendering larger than the PDF page; just set all to
width=400 and everything looks good.
Polish
- Update reference doc copyright to 2012
- Remove "work-in-progress" language from ref docs
- Update maven URLs to repo.springsource.org
- Update javadoc urls from 3.0.x/javadoc-api => current/api
- Replace hardcoded "3.1" with ${version} in ref doc
202 lines
7.0 KiB
XML
202 lines
7.0 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<section xmlns="http://docbook.org/ns/docbook" version="5.0"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xml:id="beans-standard-annotations">
|
|
<title>Using JSR 330 Standard Annotations</title>
|
|
|
|
<para>Starting with Spring 3.0, Spring offers support for JSR-330 standard annotations (Dependency Injection).
|
|
Those annotations are scanned in the same way as the Spring annotations. You just need to have the relevant jars in your classpath.
|
|
</para>
|
|
|
|
<note>
|
|
<para>
|
|
If you are using Maven, the <interfacename>javax.inject</interfacename> artifact is available
|
|
in the standard Maven repository
|
|
(<ulink url="http://repo1.maven.org/maven2/javax/inject/javax.inject/1/">http://repo1.maven.org/maven2/javax/inject/javax.inject/1/</ulink>).
|
|
You can add the following dependency to your file pom.xml:
|
|
</para>
|
|
<programlisting language="xml">
|
|
<dependency>
|
|
<groupId>javax.inject</groupId>
|
|
<artifactId>javax.inject</artifactId>
|
|
<version>1</version>
|
|
</dependency></programlisting>
|
|
</note>
|
|
|
|
<section id="beans-inject-named">
|
|
<title>Dependency Injection with <interfacename>@Inject</interfacename> and <interfacename>@Named</interfacename></title>
|
|
|
|
<para>Instead of <interfacename>@Autowired</interfacename>,
|
|
<interfacename>@javax.inject.Inject</interfacename> may be used as follows:
|
|
|
|
<programlisting language="java">import javax.inject.Inject;
|
|
|
|
public class SimpleMovieLister {
|
|
|
|
private MovieFinder movieFinder;
|
|
|
|
@Inject
|
|
public void setMovieFinder(MovieFinder movieFinder) {
|
|
this.movieFinder = movieFinder;
|
|
}
|
|
<lineannotation>// ...</lineannotation>
|
|
}</programlisting>
|
|
</para>
|
|
|
|
<para>As with <interfacename>@Autowired</interfacename>, it is possible to use <interfacename>@Inject</interfacename>
|
|
at the class-level, field-level, method-level and constructor-argument level.
|
|
|
|
If you would like to use a qualified name for the dependency that should be injected,
|
|
you should use the <interfacename>@Named</interfacename> annotation as follows:
|
|
|
|
<programlisting language="java">import javax.inject.Inject;
|
|
import javax.inject.Named;
|
|
|
|
public class SimpleMovieLister {
|
|
|
|
private MovieFinder movieFinder;
|
|
|
|
@Inject
|
|
public void setMovieFinder(@Named("main") MovieFinder movieFinder) {
|
|
this.movieFinder = movieFinder;
|
|
}
|
|
<lineannotation>// ...</lineannotation>
|
|
}</programlisting>
|
|
|
|
</para>
|
|
</section>
|
|
|
|
<section id="beans-named">
|
|
<title><interfacename>@Named</interfacename>: a standard equivalent to the <interfacename>@Component</interfacename> annotation</title>
|
|
<para>
|
|
Instead of <interfacename>@Component</interfacename>, <interfacename>@javax.inject.Named</interfacename> may be used as follows:
|
|
<programlisting language="java">import javax.inject.Inject;
|
|
import javax.inject.Named;
|
|
|
|
@Named("movieListener")
|
|
public class SimpleMovieLister {
|
|
|
|
private MovieFinder movieFinder;
|
|
|
|
@Inject
|
|
public void setMovieFinder(MovieFinder movieFinder) {
|
|
this.movieFinder = movieFinder;
|
|
}
|
|
<lineannotation>// ...</lineannotation>
|
|
}</programlisting>
|
|
</para>
|
|
|
|
<para>
|
|
It is very common to use <interfacename>@Component</interfacename> without
|
|
specifying a name for the component. <interfacename>@Named</interfacename>
|
|
can be used in a similar fashion:
|
|
|
|
<programlisting language="java">import javax.inject.Inject;
|
|
import javax.inject.Named;
|
|
|
|
@Named
|
|
public class SimpleMovieLister {
|
|
|
|
private MovieFinder movieFinder;
|
|
|
|
@Inject
|
|
public void setMovieFinder(MovieFinder movieFinder) {
|
|
this.movieFinder = movieFinder;
|
|
}
|
|
<lineannotation>// ...</lineannotation>
|
|
}</programlisting>
|
|
</para>
|
|
|
|
<para>
|
|
When using <interfacename>@Named</interfacename>, it is possible to use
|
|
component-scanning in the exact same way as when using Spring annotations:
|
|
|
|
<programlisting language="xml"><beans>
|
|
<context:component-scan base-package="org.example"/>
|
|
</beans></programlisting>
|
|
</para>
|
|
</section>
|
|
|
|
<section id="beans-standard-annotations-limitations">
|
|
<title>Limitations of the standard approach</title>
|
|
|
|
<para>When working with standard annotations, it is important to know that
|
|
some significant features are not available as shown in the table below:</para>
|
|
|
|
<para><table id="annotations-comparison">
|
|
<title>Spring annotations vs. standard annotations</title>
|
|
|
|
<tgroup cols="3">
|
|
|
|
<colspec colnum="1" colwidth="0.7*" />
|
|
<colspec colnum="2" colwidth="0.6*" />
|
|
<colspec colnum="3" colwidth="1.5*" />
|
|
|
|
<thead>
|
|
<row>
|
|
<entry>Spring</entry>
|
|
<entry>javax.inject.*</entry>
|
|
<entry>javax.inject restrictions / comments</entry>
|
|
</row>
|
|
</thead>
|
|
|
|
<tbody>
|
|
<row>
|
|
<entry>@Autowired</entry>
|
|
<entry>@Inject</entry>
|
|
<entry>@Inject has no 'required' attribute</entry>
|
|
</row>
|
|
<row>
|
|
<entry>@Component</entry>
|
|
<entry>@Named</entry>
|
|
<entry>—</entry>
|
|
</row>
|
|
<row>
|
|
<entry>@Scope("singleton")</entry>
|
|
<entry>@Singleton</entry>
|
|
<entry>
|
|
<para>
|
|
The JSR-330 default scope is like Spring's <interfacename>prototype</interfacename>.
|
|
However, in order to keep it consistent with Spring's general defaults,
|
|
a JSR-330 bean declared in the Spring container is a
|
|
<interfacename>singleton</interfacename> by default. In order to use a
|
|
scope other than <interfacename>singleton</interfacename>, you should use Spring's
|
|
<interfacename>@Scope</interfacename> annotation.
|
|
</para>
|
|
<para>
|
|
<interfacename>javax.inject</interfacename> also provides a
|
|
<ulink url="http://download.oracle.com/javaee/6/api/javax/inject/Scope.html">@Scope</ulink> annotation.
|
|
Nevertheless, this one is only intended to be used for creating your own annotations.
|
|
</para>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>@Qualifier</entry>
|
|
<entry>@Named</entry>
|
|
<entry>—</entry>
|
|
</row>
|
|
<row>
|
|
<entry>@Value</entry>
|
|
<entry>—</entry>
|
|
<entry>no equivalent</entry>
|
|
</row>
|
|
<row>
|
|
<entry>@Required</entry>
|
|
<entry>—</entry>
|
|
<entry>no equivalent</entry>
|
|
</row>
|
|
<row>
|
|
<entry>@Lazy</entry>
|
|
<entry>—</entry>
|
|
<entry>no equivalent</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
|
|
</section>
|
|
|
|
</section>
|