arrow-left

All pages
gitbookPowered by GitBook
1 of 3

Loading...

Loading...

Loading...

Auto Aspect Binding

WireBox AOP supports the concept of self aspect bindings. This means that we can make things even simpler by letting the Aspect you build control what class and methods it will match against. This is great, one less thing to remember when developing the code. So let's start with the code first:

/**
* @classMatcher any
* @methodMatcher annotatedWith:transactional
*/
component name="TransactionAspect" implements="coldbox.system.aop.MethodInterceptor"{

    function init(){ return this; }

    function invokeMethod(required invocation) output=false{

        // Let's do the around advice now:
        transaction {
            // execute the method or other aspects in a transaction
            return arguments.invocation.proceed();
        }

    }
}

That's it! Our transaction aspect is done and it will also bind itself to ANY class and ANY method that has the transactional annotation. Then you just map it:

mapAspect("TransactionAspect").to("model.aspects.MyTransactionAspect");

We are done now, by mapping the aspect WireBox detects the two annotations classMatcher and methodMatcher and binds it for you. WOW, but where did you get that from? Well, the component has two annotations:

How cool is that! My aspect can determine the matching for me already.

hashtag
Overiding Bindings

One thing to note about self binding aspects is that you can also override their matching by using the autoBind argument in the mapAspect() method call. So if you wanted to override the class and method matching on this aspect you would do this:

/**
* @classMatcher any
* @methodMatcher annotatedWith:transactional
*/
OR
component classMatcher="any" methodMatcher="annotatedWith:transactional"{}
mapAspect(aspect="TransactionAspect",autoBind=false).to("model.aspects.MyTransactionAspect");

// match only methods that start with the regex ^save
bindAspect(classes=match().any(),methods=match().regex("^save"),aspects="TransactionAspect");

ClassMatcher Annotation DSL

Create a classMatcher annotation on the component with the following DSL values:

DSL

Description

any

Matches against any class path or method name

annotatedWith:{annotation}

Matches against the finding of an annotation in a cfcomponent

annotatedWith:{annotation}:{value}

Matches against the finding of an annotation value in a cfcomponent

mappings:{mappings}

Matches to ONLY the named mapping(s) you pass to this method as a list or array.

instanceOf:{classPath}

Matches if the target object is an instance of the classPath. This internally uses the ColdFusion isInstanceOf() method.

regex:{regex}

Matches against a CFC instantiation path or function name using regular expressions

MethodMatcher Annotation DSL

Create a methodMatcher annotation on the component with the following DSL values:

DSL

Description

any

Matches against any class path or method name

annotatedWith:{annotation}

Matches against the finding of an annotation in a cfcomponent

annotatedWith:{annotation}:{value}

Matches against the finding of an annotation value in a cfcomponent

returns:{type}

Matches to ONLY the methods that return the {type}

methods:{methods}

Matches to ONLY the named methods(s) you pass to this method as a list or array.

regex:{regex}

Matches against a CFC instantiation path or function name using regular expressions