Skip to main content

AOP using RealProxy (custom implementation) - Part I (RealProxy)

This days I read a post from MSDN Magazine about RealProxy. Using RealProxy you can control the call itself of a method, alter the result or the input. We could say that this is the door for AOP (Aspect Oriented Programming) without using a specific stack.
The most important method of RealProxy is “Invoke”. This method is called each time when a method from you specific class is called. From it you can access the method name, parameters and call your real method or a fake one.
Before saying “Wooww, it’s so cool!” you should know that this will works only when you use also the interfaces.
Reading the above article I had the idea to see if and how we can implement a duration profiling mechanism that is based on attributes. If a method from your specific implementation had the custom profiling attribute, than automatically, the system will measure how long it takes to make a specific call.
First step is to create a custom attribute, which accept a custom message that will be written when we will write the duration time to the trace.
public class DurationProfillingAttribute : Attribute
{
    public DurationProfillingAttribute(string message)
    {
        Message = message;
    }

    public DurationProfillingAttribute()
    {
        Message = string.Empty;
    }

    public string Message { get; set; }
}
Next we need is a generic class that extends RealProxy and calculate the duration of the call. In the Invoke method we will need to use a Stopwatch that will calculate how long a call takes. At this level we can check if a specific method is decorated with our attribute.
public class DurationProfilingDynamicProxy<T> : RealProxy
{
    private readonly T _decorated;

    public DurationProfilingDynamicProxy(T decorated)
        : base(typeof(T))
    {
        _decorated = decorated;
    }

    public override IMessage Invoke(IMessage msg)
    {
        IMethodCallMessage methodCall = (IMethodCallMessage)msg;
        MethodInfo methodInfo = methodCall.MethodBase as MethodInfo;
        DurationProfillingAttribute profillingAttribute = (DurationProfillingAttribute)methodInfo.GetCustomAttributes(typeof(DurationProfillingAttribute)).FirstOrDefault();

        // Method don't needs to be measured. 
        if (profillingAttribute == null)
        {
            return NormalInvoke(methodInfo, methodCall);
        }

        return ProfiledInvoke(methodInfo, methodCall, profillingAttribute.Message);
    }

    private IMessage ProfiledInvoke(MethodInfo methodInfo, IMethodCallMessage methodCall, string profiledMessage)
    {
        Stopwatch stopWatch = null;
        try
        {
            stopWatch = Stopwatch.StartNew();
            var result = InvokeMethod(methodInfo, methodCall);
            stopWatch.Stop();

            WriteMessage(profiledMessage, methodInfo.DeclaringType.FullName, methodInfo.Name, stopWatch.Elapsed);

            return new ReturnMessage(result, null, 0,
                methodCall.LogicalCallContext, methodCall);
        }
        catch (Exception e)
        {
            if (stopWatch != null
                && stopWatch.IsRunning)
            {
                stopWatch.Stop();
            }
            return new ReturnMessage(e, methodCall);
        }
    }

    private IMessage NormalInvoke(MethodInfo methodInfo, IMethodCallMessage methodCall)
    {
        try
        {
            var result = InvokeMethod(methodInfo, methodCall);

            return new ReturnMessage(result, null, 0,
                methodCall.LogicalCallContext, methodCall);
        }
        catch (Exception e)
        {
            return new ReturnMessage(e, methodCall);
        }
    }

    private object InvokeMethod(MethodInfo methodInfo, IMethodCallMessage methodCall)
    {
        object result = methodInfo.Invoke(_decorated, methodCall.InArgs);
        return result;
    }


    private void WriteMessage(string message, string className, string methodName, TimeSpan elapsedTime)
    {
        Trace.WriteLine(string.Format("Duration Profiling: '{0}' for '{1}.{2}' Duration:'{3}'", message, className,methodName, elapsedTime));
    }
We could have another approach here, calculating the duration for all the methods from the class. You can find below the classes used to test the implementation. Using "GetTransparentProxy" method we can obtain a reference to our interface.
class Program
{
    static void Main(string[] args)
    {
        DurationProfilingDynamicProxy<IFoo> fooDurationProfiling = new DurationProfilingDynamicProxy<IFoo>(new Foo());
        IFoo foo = (IFoo)fooDurationProfiling.GetTransparentProxy();

        foo.GetCurrentTime();
        foo.Concat("A", "B");
        foo.LongRunning();
        foo.NoProfiling();
    }
}

public interface IFoo
{
[DurationProfilling("Some text")]
DateTime GetCurrentTime();

[DurationProfilling]
string Concat(string a, string b);

[DurationProfilling("After 2 seconds")]
void LongRunning();

string NoProfiling();
}

public class Foo : IFoo
{
public DateTime GetCurrentTime()
{
    return DateTime.UtcNow;
}

public string Concat(string a, string b)
{
    return a + b;
}

public void LongRunning()
{
    Thread.Sleep(TimeSpan.FromSeconds(2));
}

public string NoProfiling()
{
    return "NoProfiling";
}

}
In the next post related to RealProxy we will see how we can integrate this with a IoC container to be able to control what part of the system have the duration profiling active.

Comments

  1. Interesting - isn't RealProxy a bit too tied to .Net Remoting?

    ReplyDelete

Post a Comment

Popular posts from this blog

Windows Docker Containers can make WIN32 API calls, use COM and ASP.NET WebForms

After the last post , I received two interesting questions related to Docker and Windows. People were interested if we do Win32 API calls from a Docker container and if there is support for COM. WIN32 Support To test calls to WIN32 API, let’s try to populate SYSTEM_INFO class. [StructLayout(LayoutKind.Sequential)] public struct SYSTEM_INFO { public uint dwOemId; public uint dwPageSize; public uint lpMinimumApplicationAddress; public uint lpMaximumApplicationAddress; public uint dwActiveProcessorMask; public uint dwNumberOfProcessors; public uint dwProcessorType; public uint dwAllocationGranularity; public uint dwProcessorLevel; public uint dwProcessorRevision; } ... [DllImport("kernel32")] static extern void GetSystemInfo(ref SYSTEM_INFO pSI); ... SYSTEM_INFO pSI = new SYSTEM_INFO(...

How to audit an Azure Cosmos DB

In this post, we will talk about how we can audit an Azure Cosmos DB database. Before jumping into the problem let us define the business requirement: As an Administrator I want to be able to audit all changes that were done to specific collection inside my Azure Cosmos DB. The requirement is simple, but can be a little tricky to implement fully. First of all when you are using Azure Cosmos DB or any other storage solution there are 99% odds that you’ll have more than one system that writes data to it. This means that you have or not have control on the systems that are doing any create/update/delete operations. Solution 1: Diagnostic Logs Cosmos DB allows us activate diagnostics logs and stream the output a storage account for achieving to other systems like Event Hub or Log Analytics. This would allow us to have information related to who, when, what, response code and how the access operation to our Cosmos DB was done. Beside this there is a field that specifies what was th...

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills)

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills) The idea that moving to the cloud reduces the costs is a common misconception. The cloud infrastructure provides flexibility, scalability, and better CAPEX, but it does not guarantee lower costs without proper optimisation and management of the cloud services and infrastructure. Idle and unused resources, overprovisioning, oversize databases, and unnecessary data transfer can increase running costs. The regional pricing mode, multi-cloud complexity, and cost variety add extra complexity to the cost function. Cloud adoption without a cost governance strategy can result in unexpected expenses. Improper usage, combined with a pay-as-you-go model, can result in a nightmare for business stakeholders who cannot track and manage the monthly costs. Cloud-native services such as AI services, managed databases, and analytics platforms are powerful, provide out-of-the-shelve capabilities, and increase business agility and innovation. H...