AOP – string interning with PostSharp attribute

Whilst searching for an elegant solution to apply string interning across a large number of classes (we’re talking about hundreds of classes here..) it dawned on me that I can achieve this with ease using PostSharp’s LocationInterceptionAspect. All I needed was something along the lines of:

You can apply this attribute to a class or even a whole assembly and it’ll ensure every piece of string constructed is interned, including string properties and fields defined by its subclass, which is exactly what I was after.

For example, take this trivial piece of code:

image

If you inspect the compiled code for the Base class in ILSpy you will see something along the lines of:

image

notice how the setter for BaseStringProperty has been modified to invoke the OnSetValue method defined in our aspect above as opposed to the setter method. In this case, it’ll call the String.Intern method to retrieve a reference to an interned instance of the string and set the property to that reference.

For more details on PostSharp’s interception aspects, I recommend reading Dustin Davis’s excellent posts on the topic:

PostSharp Principles: Day 7 Interception Aspects – Part 1

PostSharp Principles: Day 8 Interception Aspects – Part 2

 

As we’ve specified the multicast inheritance behaviour to multicast the attribute to members of the children of the original element, the string properties defined in both A and B classes are also subject to the same string interning treatment without us having to explicitly apply the InternAttribute on them:

image

 

F# Compatible

What’s more, this attribute also works with F# types too, including record and discriminated unions types. Take for instance:

image

If you look at the generated C# code for the discriminated union type, the internal MyDuType.CaseB type would look something like the following:

image

notice how the two internal item1 and item2 properties’s setter methods have been modified in much the same way as the C# examples above? The public Item1 and Item2 properties are read-only and get their values from the internal properties instead.

Indeed, when a new instance of the CaseB type is constructed, it is the internal properties whose values are initialized:

image

 

Finally, let’s look at the record type, which interestingly also defines a non-string field:

image

because we have specified that the InternAttribute should only be applied to properties or fields of type string (via the CompileTimeValidate method which is executed as part of the post-compilation weaving process as opposed to runtime), so the internal representation of the Age field is left unaltered.

The Name field, however, being of string type, was subject to the same transformation as all our other examples.

 

I hope this little attribute can prove to be useful to you too, it has certainly saved me from an unbearable amount of grunt work!


Yan Cui

I’m an AWS Serverless Hero and the author of Production-Ready Serverless. I have run production workload at scale in AWS for nearly 10 years and I have been an architect or principal engineer with a variety of industries ranging from banking, e-commerce, sports streaming to mobile gaming. I currently work as an independent consultant focused on AWS and serverless.

You can contact me via Email, Twitter and LinkedIn.

Hire me.