You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tapestry.apache.org by hl...@apache.org on 2009/02/04 19:01:53 UTC
svn commit: r740814 - in /tapestry/tapestry5/trunk/tapestry-ioc/src:
main/java/org/apache/tapestry5/ioc/internal/services/
main/java/org/apache/tapestry5/ioc/services/ site/apt/
test/java/org/apache/tapestry5/ioc/
Author: hlship
Date: Wed Feb 4 18:01:53 2009
New Revision: 740814
URL: http://svn.apache.org/viewvc?rev=740814&view=rev
Log:
Improve some of the method advice documentation.
Modified:
tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/services/LoggingAdvisorImpl.java
tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/services/LoggingDecoratorImpl.java
tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/LoggingAdvisor.java
tapestry/tapestry5/trunk/tapestry-ioc/src/site/apt/advice.apt
tapestry/tapestry5/trunk/tapestry-ioc/src/test/java/org/apache/tapestry5/ioc/AdviceDemoModule.java
Modified: tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/services/LoggingAdvisorImpl.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/services/LoggingAdvisorImpl.java?rev=740814&r1=740813&r2=740814&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/services/LoggingAdvisorImpl.java (original)
+++ tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/services/LoggingAdvisorImpl.java Wed Feb 4 18:01:53 2009
@@ -29,7 +29,7 @@
this.exceptionTracker = exceptionTracker;
}
- public <T> void advise(Logger logger, MethodAdviceReceiver receiver)
+ public <T> void addLoggingAdvice(Logger logger, MethodAdviceReceiver receiver)
{
MethodAdvice advice = new LoggingAdvice(logger, exceptionTracker);
Modified: tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/services/LoggingDecoratorImpl.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/services/LoggingDecoratorImpl.java?rev=740814&r1=740813&r2=740814&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/services/LoggingDecoratorImpl.java (original)
+++ tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/internal/services/LoggingDecoratorImpl.java Wed Feb 4 18:01:53 2009
@@ -39,7 +39,7 @@
"<Logging interceptor for %s(%s)>",
serviceId,
serviceInterface.getName()));
- advisor.advise(logger, builder);
+ advisor.addLoggingAdvice(logger, builder);
return builder.build();
}
Modified: tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/LoggingAdvisor.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/LoggingAdvisor.java?rev=740814&r1=740813&r2=740814&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/LoggingAdvisor.java (original)
+++ tapestry/tapestry5/trunk/tapestry-ioc/src/main/java/org/apache/tapestry5/ioc/services/LoggingAdvisor.java Wed Feb 4 18:01:53 2009
@@ -32,5 +32,5 @@
* @return a new object implementing the interface that can be used in place of the delegate, providing logging
* behavior around each method call on the service interface
*/
- <T> void advise(Logger logger, MethodAdviceReceiver methodAdviceReceiver);
+ <T> void addLoggingAdvice(Logger logger, MethodAdviceReceiver methodAdviceReceiver);
}
Modified: tapestry/tapestry5/trunk/tapestry-ioc/src/site/apt/advice.apt
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-ioc/src/site/apt/advice.apt?rev=740814&r1=740813&r2=740814&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-ioc/src/site/apt/advice.apt (original)
+++ tapestry/tapestry5/trunk/tapestry-ioc/src/site/apt/advice.apt Wed Feb 4 18:01:53 2009
@@ -18,7 +18,8 @@
Let's start with a (contrived) example. Let's say you have an existing set of services that have methods
that sometimes return null, and you want them to return an empty string instead because you are getting some NullPointerExceptions.
- You could track down the implementation of each service and fix the logic that provides a return value ... or you could advise the methods:
+ You could track down the implementation of each service and fix the logic that provides a return value ...
+ or you could advise the methods:
----
@Match("*")
@@ -40,20 +41,39 @@
----
This is a method that is placed in a module class. Note the terminology: <advise> is the verb ("to advise a method")
- and <advice> is the noun ("with this advice").
+ and <advice> is the noun ("with this advice"). The
+ {{{../../apidocs/org/apache/tapestry5/ioc/MethodAdviceReceiver.html}MethodAdviceReceiver}}
+ is a wrapper around the service being advised: you can add advice to some or all methods of the service, and also
+ obtain the interface of the service. It is automatically passed into service advisor methods.
+
+ The {{{injection.html}guide to injection}} describes what can be injected into a service advisor method.
+
+ Service advisor methods {must} have a parameter of type MethodAdviceReciever.
+
+ A service will often be advised multiple times; any method may have any number of advice objects applied to it.
+ Some methods may not get any advice. All of this is acceptible.
+
+ Service advisor methods are always void methods (this is different than {{{decorator.html}service decorator methods}}).
The {{{../../apidocs/org/apache/tapestry5/ioc/annotations/Match.html}@Match}}
annotation indicates that this advice applies to all services (both your own, and those defined by Tapestry).
You will want to narrow down which services are actually targetted in most cases.
- The {{{../../apidocs/org/apache/tapestry5/ioc/MethodAdvice.html}MethodAdvice}} object is very simple; it recieves an
+ Note that some services, especially those built-in to Tapestry IoC, are marked as
+ {{{../../apidocs/org/apache/tapestry5/ioc/annotations/PreventServiceDecoration.html}not subject to decoration}},
+ this applies to service advice as well as service decoration.
+
+ The {{{../../apidocs/org/apache/tapestry5/ioc/MethodAdvice.html}MethodAdvice}} interface is very simple; it receives an
{{{../../apidocs/org/apache/tapestry5/ioc/Invocation.html}Invocation}} representing a method call. Invocation
has methods for inspecting the type and value of the parameters, and for overriding the values of the parameters.
- The call to proceed() allows the invocation to continue; the original method is invoked. You can then inspect
+ The call to proceed() allows the invocation to continue; that is, the original method is invoked. If the method has been advised
+ multiple times, the call to proceed() may chain into the next MethodAdvice object. In any case,
+ after invoking proceed(), you may inspect
and override the result (the return value).
- We can improve our method to only advise methods that return String:
+ Advice is pretty efficient, but it would still be better to apply it only to methods that make sense.
+ We can improve our service advisor method to only advise methods that return String:
----
@Match("*")
@@ -78,13 +98,6 @@
};
----
- The {{{injection.html}guide to injection}} describes what can be injected into a service advisor method.
-
- Service advisor methods must return void and have a parameter of type MethodAdviceReciever.
-
- A service will often be advised multiple times; any method may have any number of advice objects added to it.
- Some methods may not get any advice. All of this is acceptible.
-
Logging Advice
Logging advice is built into Tapestry. You can apply logging advice to your services very easily:
@@ -93,7 +106,7 @@
@Match("*")
public static void adviseLogging(LoggingAdvisor loggingAdvisor, Logger logger, MethodAdviceReciever reciever)
{
- loggingAdvisor.advise(logger, reciever);
+ loggingAdvisor.addLoggingAdvice(logger, reciever);
}
---
@@ -115,8 +128,8 @@
Decorators and Advice
- {{{decorator.html}Service decorators}} are another way to achieve the same thing; service advisors were
- added in Tapestry 5.1.
+ {{{decorator.html}Service decorators}} are another way to achieve the same thing; service advisors are a more
+ recent addition, added in Tapestry 5.1.
It is not recommended that you mix advice and decoration. If you do, decoration take precendence; all decorators
will be in effect before any advice (internally, they are two seperate steps, with advice being processed and the
Modified: tapestry/tapestry5/trunk/tapestry-ioc/src/test/java/org/apache/tapestry5/ioc/AdviceDemoModule.java
URL: http://svn.apache.org/viewvc/tapestry/tapestry5/trunk/tapestry-ioc/src/test/java/org/apache/tapestry5/ioc/AdviceDemoModule.java?rev=740814&r1=740813&r2=740814&view=diff
==============================================================================
--- tapestry/tapestry5/trunk/tapestry-ioc/src/test/java/org/apache/tapestry5/ioc/AdviceDemoModule.java (original)
+++ tapestry/tapestry5/trunk/tapestry-ioc/src/test/java/org/apache/tapestry5/ioc/AdviceDemoModule.java Wed Feb 4 18:01:53 2009
@@ -37,7 +37,7 @@
@Match("*")
public static void adviseLogging(MethodAdviceReceiver receiver, LoggingAdvisor loggingAdvisor, Logger logger)
{
- loggingAdvisor.advise(logger, receiver);
+ loggingAdvisor.addLoggingAdvice(logger, receiver);
}
@Order("after:Logging")