Original post at: https://siderite.dev/blog/interception-of-object-methods-and-properties-in-net
Previous post at: https://siderite.dev/blog/adding-logging-to-your-objects-without.html/
A few years ago I wrote an article about using RealProxy to intercept methods and properties calls in order to log them. It was only for .NET Framework and suggested you inherit all intercepted classes from MarshalByRefObject. This one is a companion piece that shows how interception can be done in a more general way and without the need for MarshalByRefObject.
To do that I am going to give you two versions of the same class, one for .NET Framework and one for .NET Core which can be used like this:
//Initial code:
IInterface obj = new Implementation();
//Interceptor added:
IInterface obj = new Implementation();
var interceptor = new MyInterceptor<IInterface>();
obj = interceptor.Decorate(obj);
//Interceptor class (every method there is optional):
public class MyInterceptor<T> : ClassInterceptor<T>
{
protected override void OnInvoked(MethodInfo methodInfo, object[] args, object result)
{
// do something when the method or property call ended succesfully
}
protected override void OnInvoking(MethodInfo methodInfo, object[] args)
{
// do something before the method or property call is invoked
}
protected override void OnException(MethodInfo methodInfo, object[] args, Exception exception)
{
// do something when a method or property call throws an exception
}
}
This code would be the same for .NET Framework or Core. The difference is in the ClassInterceptor code and the only restriction is that your class has to implement an interface for the methods and properties intercepted.
Here is the .NET Framework code:
public abstract class ClassInterceptor<TInterface> : RealProxy
{
private object _decorated;
public ClassInterceptor()
: base(typeof(TInterface))
{
}
public TInterface Decorate<TImplementation>(TImplementation decorated)
where TImplementation:TInterface
{
_decorated = decorated;
return (TInterface)GetTransparentProxy();
}
public override IMessage Invoke(IMessage msg)
{
var methodCall = msg as IMethodCallMessage;
var methodInfo = methodCall.MethodBase as MethodInfo;
OnInvoking(methodInfo,methodCall.Args);
object result;
try
{
result = methodInfo.Invoke(_decorated, methodCall.InArgs);
} catch(Exception ex)
{
OnException(methodInfo, methodCall.Args, ex);
throw;
}
OnInvoked(methodInfo, methodCall.Args, result);
return new ReturnMessage(result, null, 0, methodCall.LogicalCallContext, methodCall);
}
protected virtual void OnException(MethodInfo methodInfo, object[] args, Exception exception) { }
protected virtual void OnInvoked(MethodInfo methodInfo, object[] args, object result) { }
protected virtual void OnInvoking(MethodInfo methodInfo, object[] args) { }
}
In it, we use the power of RealProxy to create a transparent proxy. For Core we use DispatchProxy, which is the .NET Core replacement from Microsoft. Here is the code:
public abstract class ClassInterceptor<TInterface> : DispatchProxy
{
private object _decorated;
public ClassInterceptor() : base()
{
}
public TInterface Decorate<TImplementation>(TImplementation decorated)
where TImplementation : TInterface
{
var proxy = typeof(DispatchProxy)
.GetMethod("Create")
.MakeGenericMethod(typeof(TInterface),GetType())
.Invoke(null,Array.Empty<object>())
as ClassInterceptor<TInterface>;
proxy._decorated = decorated;
return (TInterface)(object)proxy;
}
protected override object Invoke(MethodInfo targetMethod, object[] args)
{
OnInvoking(targetMethod,args);
try
{
var result = targetMethod.Invoke(_decorated, args);
OnInvoked(targetMethod, args,result);
return result;
}
catch (TargetInvocationException exc)
{
OnException(targetMethod, args, exc);
throw exc.InnerException;
}
}
protected virtual void OnException(MethodInfo methodInfo, object[] args, Exception exception) { }
protected virtual void OnInvoked(MethodInfo methodInfo, object[] args, object result) { }
protected virtual void OnInvoking(MethodInfo methodInfo, object[] args) { }
}
DispatchProxy is a weird little class. Look how it generates an object which can be cast simultaneously to T or Class!
There are many other things one can do to improve this class:
- the base class could make the distinction between a method call and a property call. In the latter case the MethodInfo object will have IsSpecialName true and start with set_ or get_
- for async/await scenarios and not only, the result of a method would be a Task and if you want to log the result you should check for that, await the task, get the result, then log it. So this class could make this functionality available out of the box
- support for Dependency Injection scenarios could also be added as the perfect place to use interception is when you register an interface-implementation pair. An extension method like container.RegisterSingletonWithLogging could be used instead of container.RegisterSingleton, by registering a factory which replaces the implementation with a logging proxy
I hope this helps!
Top comments (0)