root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

[SPR-8240] Restructuring the "Context management and caching" section.

This commit is contained in:
Sam Brannen 2011-09-29 13:51:34 +00:00
parent bc6927e601
commit a4953e7c22
1 changed files with 97 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

169
spring-framework-reference/src/testing.xml
View File

@ -1026,8 +1026,10 @@ public void testProcessRepeatedly() {
<para><classname>DelegatingSmartContextLoader</classname>: the <para><classname>DelegatingSmartContextLoader</classname>: the
default loader which delegates internally to an default loader which delegates internally to an
<classname>AnnotationConfigContextLoader</classname> or a <classname>AnnotationConfigContextLoader</classname> or a
<classname>GenericXmlContextLoader</classname> depending on <classname>GenericXmlContextLoader</classname> depending
the configuration declared for the test class.</para> either on the configuration declared for the test class or on
the presence of default locations or configuration
classes.</para>
</listitem> </listitem>
<listitem> <listitem>
@ -1101,18 +1103,23 @@ public class MyTest {
merely by declaring the merely by declaring the
<interfacename>@ContextConfiguration</interfacename> annotation at the <interfacename>@ContextConfiguration</interfacename> annotation at the
class level. If your test class does not explicitly declare class level. If your test class does not explicitly declare
application context resource <literal>locations</literal>, the application context resource <literal>locations</literal> or
configured <interfacename>ContextLoader</interfacename> determines how configuration <varname>classes</varname>, the configured
and whether to load a context from a default location. For example, <interfacename>ContextLoader</interfacename> determines how to load a
<classname>GenericXmlContextLoader</classname>, which is the default context from a default location or default configuration
<interfacename>ContextLoader</interfacename>, generates a default classes.</para>
location based on the name of the test class. If your class is named
<literal>com.example.MyTest</literal>,
<classname>GenericXmlContextLoader</classname> loads your application
context from
<literal>"classpath:/com/example/MyTest-context.xml"</literal>.</para>
<programlisting language="java">package com.example; <section id="testcontext-ctx-management-xml">
<title>XML-based configuration</title>
<para>For example, <classname>GenericXmlContextLoader</classname>
generates a default location based on the name of the test class. If
your class is named <literal>com.example.MyTest</literal>,
<classname>GenericXmlContextLoader</classname> loads your
application context from
<literal>"classpath:/com/example/MyTest-context.xml"</literal>.</para>
<programlisting language="java">package com.example;
@RunWith(SpringJUnit4ClassRunner.class) @RunWith(SpringJUnit4ClassRunner.class)
<lineannotation>// ApplicationContext will be loaded from <literal>"classpath:/com/example/MyTest-context.xml"</literal></lineannotation> <lineannotation>// ApplicationContext will be loaded from <literal>"classpath:/com/example/MyTest-context.xml"</literal></lineannotation>
@ -1121,56 +1128,69 @@ public class MyTest {
<lineannotation>// class body...</lineannotation> <lineannotation>// class body...</lineannotation>
}</programlisting> }</programlisting>
<para>If the default location does not suit your needs, you can <para>If the default location does not suit your needs, you can
explicitly configure the <literal>locations</literal> attribute of explicitly configure the <literal>locations</literal> attribute of
<interfacename>@ContextConfiguration</interfacename> with an array <interfacename>@ContextConfiguration</interfacename> with an array
that contains the resource locations of XML configuration metadata that contains the resource locations of XML configuration metadata
(assuming an XML-capable <interfacename>ContextLoader</interfacename> (assuming an XML-capable
has been configured, which is the default). A plain path, for example <interfacename>ContextLoader</interfacename> has been configured,
<literal>"context.xml"</literal>, will be treated as a classpath which is the default). A plain path, for example
resource from the same package in which the test class is defined. A <literal>"context.xml"</literal>, will be treated as a classpath
path starting with a slash is treated as a fully qualified classpath resource from the same package in which the test class is defined. A
location, for example <literal>"/org/example/config.xml"</literal>. A path starting with a slash is treated as a fully qualified classpath
path which represents a URL (i.e., a path prefixed with location, for example <literal>"/org/example/config.xml"</literal>.
<literal>classpath:</literal>, <literal>file:</literal>, A path which represents a URL (i.e., a path prefixed with
<literal>http:</literal>, etc.) will be used <emphasis>as <literal>classpath:</literal>, <literal>file:</literal>,
is</emphasis>. Alternatively, you can implement and configure your own <literal>http:</literal>, etc.) will be used <emphasis>as
custom <interfacename>ContextLoader</interfacename>.</para> is</emphasis>. Alternatively, you can implement and configure your
own custom <interfacename>ContextLoader</interfacename>.</para>
<programlisting language="java">@RunWith(SpringJUnit4ClassRunner.class) <programlisting language="java">@RunWith(SpringJUnit4ClassRunner.class)
<lineannotation>// ApplicationContext will be loaded from <literal>"/applicationContext.xml"</literal> and <literal>"/applicationContext-test.xml"</literal></lineannotation> <lineannotation>// ApplicationContext will be loaded from "/applicationContext.xml" and
<lineannotation>// in the root of the classpath</lineannotation> // "/applicationContext-test.xml" in the root of the classpath</lineannotation>
<emphasis role="bold">@ContextConfiguration({"/applicationContext.xml", "/applicationContext-test.xml"})</emphasis> <emphasis role="bold">@ContextConfiguration(locations={"/applicationContext.xml", "/applicationContext-test.xml"})</emphasis>
public class MyTest { public class MyTest {
<lineannotation>// class body...</lineannotation> <lineannotation>// class body...</lineannotation>
}</programlisting> }</programlisting>
<para><interfacename>@ContextConfiguration</interfacename> supports an <para><interfacename>@ContextConfiguration</interfacename> supports
alias for the <literal>locations</literal> attribute through the an alias for the <literal>locations</literal> attribute through the
standard <literal>value</literal> attribute. Thus, if you do not need standard <literal>value</literal> attribute. Thus, if you do not
to configure a custom <interfacename>ContextLoader</interfacename>, need to configure a custom
you can omit the declaration of the <literal>locations</literal> <interfacename>ContextLoader</interfacename>, you can omit the
attribute name and declare the resource locations by using the declaration of the <literal>locations</literal> attribute name and
shorthand format demonstrated in the following example.</para> declare the resource locations by using the shorthand format
demonstrated in the following example.</para>
<para><interfacename>@ContextConfiguration</interfacename> also <programlisting language="java">@RunWith(SpringJUnit4ClassRunner.class)
supports a boolean <literal>inheritLocations</literal> attribute that <emphasis role="bold">@ContextConfiguration({"/applicationContext.xml", "/applicationContext-test.xml"})</emphasis>
denotes whether resource locations from superclasses should be public class MyTest {
<emphasis>inherited</emphasis>. The default value is <lineannotation>// class body...</lineannotation>
<literal>true</literal>, which means that an annotated class inherits }</programlisting>
the resource locations defined by an annotated superclass. </section>
Specifically, the resource locations for an annotated class are
appended to the list of resource locations defined by an annotated
superclass. Thus, subclasses have the option of
<emphasis>extending</emphasis> the list of resource locations. In the
following example, the
<interfacename>ApplicationContext</interfacename> for
<classname>ExtendedTest</classname> is loaded from "/base-context.xml"
<emphasis role="bold">and</emphasis> "/extended-context.xml", in that
order. Beans defined in "/extended-context.xml" may therefore override
those defined in "/base-context.xml".</para>
<programlisting language="java">@RunWith(SpringJUnit4ClassRunner.class) <section id="testcontext-ctx-management-inheritance">
<title>Configuration inheritance</title>
<para><interfacename>@ContextConfiguration</interfacename> also
supports a boolean <literal>inheritLocations</literal> attribute
that denotes whether resource locations from superclasses should be
<emphasis>inherited</emphasis>. The default value is
<literal>true</literal>, which means that an annotated class
inherits the resource locations defined by an annotated superclass.
Specifically, the resource locations for an annotated class are
appended to the list of resource locations defined by an annotated
superclass. Thus, subclasses have the option of
<emphasis>extending</emphasis> the list of resource locations. In
the following example, the
<interfacename>ApplicationContext</interfacename> for
<classname>ExtendedTest</classname> is loaded from
"/base-context.xml" <emphasis role="bold">and</emphasis>
"/extended-context.xml", in that order. Beans defined in
"/extended-context.xml" may therefore override those defined in
"/base-context.xml".</para>
<programlisting language="java">@RunWith(SpringJUnit4ClassRunner.class)
<lineannotation>// ApplicationContext will be loaded from <literal>"/base-context.xml"</literal> in the root of the classpath</lineannotation> <lineannotation>// ApplicationContext will be loaded from <literal>"/base-context.xml"</literal> in the root of the classpath</lineannotation>
<emphasis role="bold">@ContextConfiguration("/base-context.xml")</emphasis> <emphasis role="bold">@ContextConfiguration("/base-context.xml")</emphasis>
public class BaseTest { public class BaseTest {
@ -1184,23 +1204,28 @@ public class ExtendedTest extends BaseTest {
<lineannotation>// class body...</lineannotation> <lineannotation>// class body...</lineannotation>
}</programlisting> }</programlisting>
<para>If <literal>inheritLocations</literal> is set to <para>If <literal>inheritLocations</literal> is set to
<literal>false</literal>, the resource locations for the annotated <literal>false</literal>, the resource locations for the annotated
class shadow and effectively replace any resource locations defined by class shadow and effectively replace any resource locations defined
a superclass.</para> by a superclass.</para>
</section>
<para>By default, once loaded, the configured <section id="testcontext-ctx-management-caching">
<interfacename>ApplicationContext</interfacename> is reused for each <title>Context caching</title>
test. Thus the setup cost is incurred only once (per test suite), and
subsequent test execution is much faster. In the unlikely case that a <para>By default, once loaded, the configured
test corrupts the application context and requires reloading — for <interfacename>ApplicationContext</interfacename> is reused for each
example, by modifying a bean definition or the state of an application test. Thus the setup cost is incurred only once (per test suite),
object — you can annotate your test class or test method with and subsequent test execution is much faster. In the unlikely case
<interfacename>@DirtiesContext</interfacename> (assuming that a test corrupts the application context and requires reloading
<classname>DirtiesContextTestExecutionListener</classname> has been — for example, by modifying a bean definition or the state of an
configured, which is the default). This instructs Spring to reload the application object — you can annotate your test class or test method
configuration and rebuild the application context before executing the with <interfacename>@DirtiesContext</interfacename> (assuming
next test.</para> <classname>DirtiesContextTestExecutionListener</classname> has been
configured, which is the default). This instructs Spring to reload
the configuration and rebuild the application context before
executing the next test.</para>
</section>
</section> </section>
<section id="testcontext-fixture-di"> <section id="testcontext-fixture-di">