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(...

ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded

Today blog post will be started with the following error when running DB tests on the CI machine: threw exception: System.InvalidOperationException: The Entity Framework provider type 'System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer' registered in the application config file for the ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded. Make sure that the assembly-qualified name is used and that the assembly is available to the running application. See http://go.microsoft.com/fwlink/?LinkId=260882 for more information. at System.Data.Entity.Infrastructure.DependencyResolution.ProviderServicesFactory.GetInstance(String providerTypeName, String providerInvariantName) This error happened only on the Continuous Integration machine. On the devs machines, everything has fine. The classic problem – on my machine it’s working. The CI has the following configuration: TeamCity .NET 4.51 EF 6.0.2 VS2013 It see...

Navigating Cloud Strategy after Azure Central US Region Outage

 Looking back, July 19, 2024, was challenging for customers using Microsoft Azure or Windows machines. Two major outages affected customers using CrowdStrike Falcon or Microsoft Azure computation resources in the Central US. These two outages affected many people and put many businesses on pause for a few hours or even days. The overlap of these two issues was a nightmare for travellers. In addition to blue screens in the airport terminals, they could not get additional information from the airport website, airline personnel, or the support line because they were affected by the outage in the Central US region or the CrowdStrike outage.   But what happened in reality? A faulty CrowdStrike update affected Windows computers globally, from airports and healthcare to small businesses, affecting over 8.5m computers. Even if the Falson Sensor software defect was identified and a fix deployed shortly after, the recovery took longer. In parallel with CrowdStrike, Microsoft provi...