/*
* Copyright 2002-2017 the original author or authors.
*
* 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.
*/
package org.springframework.aop.aspectj;
import org.aspectj.weaver.tools.PointcutParser;
import org.aspectj.weaver.tools.TypePatternMatcher;
import org.springframework.aop.ClassFilter;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
Spring AOP ClassFilter
implementation using AspectJ type matching. Author: Rod Johnson, Juergen Hoeller Since: 2.0
/**
* Spring AOP {@link ClassFilter} implementation using AspectJ type matching.
*
* @author Rod Johnson
* @author Juergen Hoeller
* @since 2.0
*/
public class TypePatternClassFilter implements ClassFilter {
private String typePattern = "";
@Nullable
private TypePatternMatcher aspectJTypePatternMatcher;
Creates a new instance of the TypePatternClassFilter
class. This is the JavaBean constructor; be sure to set the typePattern
property, else a no doubt fatal IllegalStateException
will be thrown when the matches(Class<?>)
method is first invoked.
/**
* Creates a new instance of the {@link TypePatternClassFilter} class.
* <p>This is the JavaBean constructor; be sure to set the
* {@link #setTypePattern(String) typePattern} property, else a
* no doubt fatal {@link IllegalStateException} will be thrown
* when the {@link #matches(Class)} method is first invoked.
*/
public TypePatternClassFilter() {
}
Create a fully configured TypePatternClassFilter
using the given type pattern. Params: - typePattern – the type pattern that AspectJ weaver should parse
/**
* Create a fully configured {@link TypePatternClassFilter} using the
* given type pattern.
* @param typePattern the type pattern that AspectJ weaver should parse
*/
public TypePatternClassFilter(String typePattern) {
setTypePattern(typePattern);
}
Set the AspectJ type pattern to match.
Examples include:
org.springframework.beans.*
This will match any class or interface in the given package.
org.springframework.beans.ITestBean+
This will match the ITestBean
interface and any class that implements it.
These conventions are established by AspectJ, not Spring AOP.
Params: - typePattern – the type pattern that AspectJ weaver should parse
/**
* Set the AspectJ type pattern to match.
* <p>Examples include:
* <code class="code">
* org.springframework.beans.*
* </code>
* This will match any class or interface in the given package.
* <code class="code">
* org.springframework.beans.ITestBean+
* </code>
* This will match the {@code ITestBean} interface and any class
* that implements it.
* <p>These conventions are established by AspectJ, not Spring AOP.
* @param typePattern the type pattern that AspectJ weaver should parse
*/
public void setTypePattern(String typePattern) {
Assert.notNull(typePattern, "Type pattern must not be null");
this.typePattern = typePattern;
this.aspectJTypePatternMatcher =
PointcutParser.getPointcutParserSupportingAllPrimitivesAndUsingContextClassloaderForResolution().
parseTypePattern(replaceBooleanOperators(typePattern));
}
Return the AspectJ type pattern to match.
/**
* Return the AspectJ type pattern to match.
*/
public String getTypePattern() {
return this.typePattern;
}
Should the pointcut apply to the given interface or target class?
Params: - clazz – candidate target class
Throws: - IllegalStateException – if no
setTypePattern(String)
has been set
Returns: whether the advice should apply to this candidate target class
/**
* Should the pointcut apply to the given interface or target class?
* @param clazz candidate target class
* @return whether the advice should apply to this candidate target class
* @throws IllegalStateException if no {@link #setTypePattern(String)} has been set
*/
@Override
public boolean matches(Class<?> clazz) {
Assert.state(this.aspectJTypePatternMatcher != null, "No type pattern has been set");
return this.aspectJTypePatternMatcher.matches(clazz);
}
If a type pattern has been specified in XML, the user cannot write and
as "&&" (though && will work). We also allow and
between two sub-expressions. This method converts back to &&
for the AspectJ pointcut parser.
/**
* If a type pattern has been specified in XML, the user cannot
* write {@code and} as "&&" (though && will work).
* We also allow {@code and} between two sub-expressions.
* <p>This method converts back to {@code &&} for the AspectJ pointcut parser.
*/
private String replaceBooleanOperators(String pcExpr) {
String result = StringUtils.replace(pcExpr," and "," && ");
result = StringUtils.replace(result, " or ", " || ");
return StringUtils.replace(result, " not ", " ! ");
}
}