Ray.Aop package provides method interception. This feature enables you to write code that is executed each time a matching method is invoked. It's suited for cross cutting concerns ("aspects"), such as transactions, security and logging. Because interceptors divide a problem into aspects rather than objects, their use is called Aspect Oriented Programming (AOP).
A Matcher is a simple interface that either accepts or rejects a value. For Ray.AOP, you need two matchers: one that defines which classes participate, and another for the methods of those classes. To make this easy, there's factory class to satisfy the common scenarios.
MethodInterceptors are executed whenever a matching method is invoked. They have the opportunity to inspect the call: the method, its arguments, and the receiving instance. They can perform their cross-cutting logic and then delegate to the underlying method. Finally, they may inspect the return value or exception and return. Since interceptors may be applied to many methods and will receive many calls, their implementation should be efficient and unintrusive.
To illustrate how method interceptors work with Ray.Aop, we'll forbid calls to our pizza billing system on weekends. The delivery guys only work Monday thru Friday so we'll prevent pizza from being ordered when it can't be delivered! This example is structurally similar to use of AOP for authorization.
To mark select methods as weekdays-only, we define an attribute.
<?php
#[Attribute(Attribute::TARGET_METHOD)]
final class NotOnWeekends
{
}...and apply it to the methods that need to be intercepted:
<?php
class RealBillingService
{
#[NotOnWeekends]
public function chargeOrder(PizzaOrder $order, CreditCard $creditCard)
{Next, we define the interceptor by implementing the org.aopalliance.intercept.MethodInterceptor interface. When we need to call through to the underlying method, we do so by calling $invocation->proceed():
<?php
class WeekendBlocker implements MethodInterceptor
{
public function invoke(MethodInvocation $invocation)
{
$today = getdate();
if ($today['weekday'][0] === 'S') {
throw new \RuntimeException(
$invocation->getMethod()->getName() . " not allowed on weekends!"
);
}
return $invocation->proceed();
}
}Finally, we configure everything using the Aspect class:
use Ray\Aop\Aspect;
use Ray\Aop\Matcher;
$aspect = new Aspect();
$aspect->bind(
(new Matcher())->any(),
(new Matcher())->annotatedWith(NotOnWeekends::class),
[new WeekendBlocker()]
);
$billing = $aspect->newInstance(RealBillingService::class);
try {
echo $billing->chargeOrder();
} catch (\RuntimeException $e) {
echo $e->getMessage() . "\n";
exit(1);
}Putting it all together, (and waiting until Saturday), we see the method is intercepted and our order is rejected:
chargeOrder not allowed on weekends!
Ray.Aop also supports a PECL extension. When the extension is installed, you can use the weave method to apply aspects to all classes in a directory:
$aspect = new Aspect();
$aspect->bind(
(new Matcher())->any(),
(new Matcher())->annotatedWith(NotOnWeekends::class),
[new WeekendBlocker()]
);
$aspect->weave(__DIR__ . '/src'); // Weave the aspects to all classes in the directory that match the matcher.
$billing = new RealBillingService();
echo $billing->chargeOrder(); // Interceptors appliedWith the PECL extension:
- You can create new instances anywhere in your code using the normal
newkeyword. - Interception works even with
finalclasses and methods.
To use these features, simply install the PECL extension and Ray.Aop will automatically utilize it when available. PHP 8.1+ is required for the PECL extension.
PHP 8.1 or higher is required to use the PECL extension. For more information, see ext-rayaop.
When creating an Aspect instance, you can optionally specify a temporary directory:
$aspect = new Aspect('/path/to/tmp/dir');If not specified, the system's default temporary directory will be used.
This concludes the basic usage of Ray.Aop. For more detailed information and advanced usage, please refer to the full documentation.
You can have your own matcher.
To create contains matcher, You need to provide a class which have two method. One is matchesClass for class match.
The other one is matchesMethod method match. Both return the boolean result of matched.
use Ray\Aop\AbstractMatcher;
use Ray\Aop\Matcher;
class IsContainsMatcher extends AbstractMatcher
{
/**
* {@inheritdoc}
*/
public function matchesClass(\ReflectionClass $class, array $arguments) : bool
{
[$contains] = $arguments;
return (strpos($class->name, $contains) !== false);
}
/**
* {@inheritdoc}
*/
public function matchesMethod(\ReflectionMethod $method, array $arguments) : bool
{
[$contains] = $arguments;
return (strpos($method->name, $contains) !== false);
}
}In an interceptor, a MethodInvocation object is passed to the invoke method:
class MyInterceptor implements MethodInterceptor
{
public function invoke(MethodInvocation $invocation)
{
// Before method invocation
$result = $invocation->proceed();
// After method invocation
return $result;
}
}$invocation->proceed() invokes the next interceptor in the chain. If no more interceptors are present, it calls the target method. This chaining allows multiple interceptors for a single method, executing in the order bound.
Example execution flow for interceptors A, B, and C:
- Interceptor A (before)
- Interceptor B (before)
- Interceptor C (before)
- Target method
- Interceptor C (after)
- Interceptor B (after)
- Interceptor A (after)
This chaining mechanism allows you to combine multiple cross-cutting concerns (like logging, security, and performance monitoring) for a single method.
With the MethodInvocation object, you can:
$invocation->proceed()- Invoke method$invocation->getMethod()- Get method reflection$invocation->getThis()- Get object$invocation->getArguments()- Get parameters$invocation->getNamedArguments()- Get named parameters An extendedClassRefletionandMethodReflectionholds methos to get PHP 8 attribute and doctrine annotation(s) .
/** @var $method \Ray\Aop\ReflectionMethod */
$method = $invocation->getMethod();
/** @var $class \Ray\Aop\ReflectionClass */
$class = $invocation->getMethod()->getDeclaringClass();$method->getAnnotations()- Get method attributes/annotations$method->getAnnotation($name)- Get method attribute/annotation$class->->getAnnotations()- Get class attributes/annotations$class->->getAnnotation($name)- Get class attributes/annotation
Ray.Aop can be used either with doctrine/annotation in PHP 7/8 or with an Attributes in PHP8.
The method interceptor API implemented by Ray.Aop is a part of a public specification called AOP Alliance.
The recommended way to install Ray.Aop is through Composer.
# Add Ray.Aop as a dependency
$ composer require ray/aop ^2.0SevericeLocator::setReader(new AttributeReader);`- See also the DI framework Ray.Di which integrates DI and AOP.
For more detailed technical information, please refer to the following resources:
- Note: This documentation of the part is taken from Guice/AOP. z1
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent