Skip to main content

Changing Glass Caching key

There are a few ORM's for Siteocre and Glass is a great one. Like any framework though it has somethings that don't work they way you may need it to. For glass one of these may be how it generates a cache key. This article is focused on version 5 of glass.

Here is the code Glass uses for generating a cache key for all items it caches.You can see it uses a lot of the fields on a Sitecore item to generate the cache key. It does this to make sure it is caching a unique model. However, this is the cache key you are stuck with as there are no settings that will change this. Don't worry though, there is way to plug into Glass and tell it to use a different one.

public class CacheKeyGenerator : ICacheKeyGenerator
    public string Generate(ObjectConstructionArgs args)
      SitecoreTypeCreationContext typeCreationContext = args.AbstractTypeCreationContext as SitecoreTypeCreationContext;
      return string.Format("{0}{1}{2}{3}{4}{5}{6}{7}", 
(object) typeCreationContext.SitecoreService.GlassContext.Name, 
Sitecore.Context.Site == null ? (object) string.Empty : (object) Sitecore.Context.Site.Name, 
(object) typeCreationContext.Item.ID, 
(object) typeCreationContext.Item["__Revision"],
 (object) typeCreationContext.Item.Language.Name,
 (object) typeCreationContext.Item.Database.Name, 
(object) typeCreationContext.Options.Type.FullName,
 (object) typeCreationContext.Options.Lazy);

The default cache key generator takes a lot of things into account, but if it does not take into account something you need can you still turn caching on for Glass models? The answer is yes! You just need to override this CacheKeyGenerator withour own implementation of ICacheKeyGenerator. This is a quick run down on how to do this.

First let's look at one more class and method. The ObjectConstructionTaskConfigFactory is where Glass sets up the cache key generator. First we need to notice the if statement. If caching always on is configured it sets up SitecoreCacheAlwaysOnCheckTask and if not it sets up SitecoreCacheCheckTask passing into each the CacheKeyGenerator. So if we want our on cache key generator we need to override these.

protected void Init()
      Glass.Mapper.Config config = this.DependencyResolver.GetConfig();
      this.Add<NullItemTask>((Func<NullItemTask>) (() => new NullItemTask()));
      this.Add<ModelDepthCheck>((Func<ModelDepthCheck>) (() => new ModelDepthCheck()));      this.Add<ItemVersionCountByRevisionTask>((Func<ItemVersionCountByRevisionTask>) (() => new ItemVersionCountByRevisionTask()));
      this.Add<SitecoreItemTask>((Func<SitecoreItemTask>) (() => new SitecoreItemTask()));
      if (config.Cache.AlwaysOn)   
           this.Add<SitecoreCacheAlwaysOnCheckTask>((Func<SitecoreCacheAlwaysOnCheckTask>) (() => new SitecoreCacheAlwaysOnCheckTask(this.DependencyResolver.CacheFactory, (ICacheKeyGenerator) new CacheKeyGenerator())));
        this.Add<SitecoreCacheCheckTask>((Func<SitecoreCacheCheckTask>) (() => new SitecoreCacheCheckTask(this.DependencyResolver.CacheFactory, (ICacheKeyGenerator) new CacheKeyGenerator())));
      if (config.Debug.Enabled)
        this.Add<ConstructionTimerStart>((Func<ConstructionTimerStart>) (() => new ConstructionTimerStart((ICacheKeyGenerator) new CacheKeyGenerator(), this.DependencyResolver.GetLog(), this.DependencyResolver.GetConfig().Debug)));
      this.Add<EnforcedTemplateCheck>((Func<EnforcedTemplateCheck>) (() => new EnforcedTemplateCheck()));
      this.Add<CreateConcreteTask>((Func<CreateConcreteTask>) (() => new CreateConcreteTask(this.DependencyResolver.LazyLoadingHelper)));
      this.Add<CreateInterfaceTask>((Func<CreateInterfaceTask>) (() => new CreateInterfaceTask(this.DependencyResolver.LazyLoadingHelper)));

We are going to override the this in the GlassMapperScCustom.cs class.In the "CreateResolver" method we want to add the following code. We check to see if we are doing AlwaysOn caching or not and then remove the default object construction factory created in the code above with our own code. With this code we can now configured whatever cache key generator we want!

public static IDependencyResolver CreateResolver()
    var config = new Glass.Mapper.Sc.Config();

    var dependencyResolver = new DependencyResolver(config);

     // Replace the standard GlassHtmlFactory with a custom factory, in order to override the default GlassHtml class.
     dependencyResolver.GlassHtmlFactory = new GlassHtmlFactory(dependencyResolver);
     if (config.Cache.AlwaysOn)
        dependencyResolver.ObjectConstructionFactory.InsertBefore<EnforcedTemplateCheck, SitecoreCacheAlwaysOnCheckTask>(
                    (Func<SitecoreCacheAlwaysOnCheckTask>)(() => new SitecoreCacheAlwaysOnCheckTask(dependencyResolver.CacheFactory, 
                       (ICacheKeyGenerator)new MyCacheKeyGenerator())));
       dependencyResolver.ObjectConstructionFactory.InsertBefore<EnforcedTemplateCheck, SitecoreCacheCheckTask>(  
                  (Func<SitecoreCacheCheckTask>)(() => new SitecoreCacheCheckTask(dependencyResolver.CacheFactory,
                        (ICacheKeyGenerator)new MyCacheKeyGenerator())));
   return dependencyResolver;

Now you are ready to move forward with your own cache key generation stratey inside Glass.


Popular posts from this blog

Uniting Testing Expression Predicate with Moq

I recently was setting up a repository in a project with an interface on all repositories that took a predicate. As part of this I needed to mock out this call so I could unit test my code. The vast majority of samples out there for mocking an expression predicate just is It.IsAny<> which is not very helpful as it does not test anything other then verify it got a predicate. What if you actually want to test that you got a certain predicate though? It is actually pretty easy to do but not very straight forward. Here is what you do for the It.IsAny<> approach in case someone is looking for that. this .bindingRepository.Setup(c => c.Get(It.IsAny<Expression<Func<UserBinding, bool >>>())) .Returns( new List<UserBinding>() { defaultBinding }.AsQueryable()); This example just says to always return a collection of UserBindings that contain “defaultBinding” (which is an object I setup previously). Here is what it looks like when you want to pass in an exp

Excel XIRR and C#

I have spend that last couple days trying to figure out how to run and Excel XIRR function in a C# application. This process has been more painful that I thought it would have been when started. To save others (or myself the pain in the future if I have to do it again) I thought I would right a post about this (as post about XIRR in C# have been hard to come by). Lets start with the easy part first. In order to make this call you need to use the Microsoft.Office.Interop.Excel dll. When you use this dll take note of what version of the dll you are using. If you are using a version less then 12 (at the time of this writing 12 was the highest version) you will not have an XIRR function call. This does not mean you cannot still do XIRR though. As of version 12 (a.k.a Office 2007) the XIRR function is a built in function to Excel. Prior version need an add-in to use this function. Even if you have version 12 of the interop though it does not mean you will be able to use the function. The

MVVM light and Model Validation

I have been using the MVVM light toolkit for a project recently. It is a great toolkit but is missing a couple things and Laurent Bugnion does a good job trying to cover those holes. One of the things the toolkit does not support is Validation. The good news is there is a great CodePlex project out there call Fluent Validation that makes this pretty easy to add and really powerful. My objective was to add validation to my model so I could call “IsValid” on the model itself (similar to the MVC attribute approach). Fluent Validation has you create a new class file that holds you validation rules for a given model. This is the approach I took to enable each model to have an “IsValid” property and a “Errors” property that returns the validation errors. First I setup my ValidationFactory: public class ValidatorFactory : FluentValidation.ValidatorFactoryBase { public override FluentValidation.IValidator CreateInstance(Type validatorType) { return SimpleIoc.Default.G

WPF Localization - RESX Option

About a year ago I was building a WPF project in .Net 3.0 and Visual Studio 2005. I wanted to revisit this subject and see what has changed in .Net 3.5 and Visual Studio 2008. I will make a few of these posts to try and cover all the different options (RESX option, LocBaml option, Resource Dictionary Option). In this blog I will focus on using a resx file to localize an application. To show how the resx option is done I created a WPF form with three labels on it. The first label has is text set inline in XAML, the second has it text set via code behind from the resx file and the third has its text set via XAML accessing the resx file. The first thing that needs to happen to setup a project for localization is a small change to the project file. To make this change you will need to open the project file in notepad (or some other generic editor). In the first PropertyGroup section you need to add the follow XML node <UICulture>en-US</UICulture>. So the project file node w

Create Web Forms for Marketers Custom Save Action and Edit Screen

I was recently working on a project where I needed to create a custom save action to add to my Web Forms for Marketers module.  I needed a custom save action to push the data to salesforce and I also needed a custom edit screen so the author could setup some configuration values the action needed. Here are the details of what I did starting with the save action. Save Action The first thing you need to do is create a new class that inherits the “ISaveAction” interface (Sitecore.Form.Submit.ISaveAction) and implement the Execute method.   public class SalesforceSaveAction : ISaveAction { public string FormKey { get; set; } public string FieldsToSend { get; set; }   void ISaveAction.Execute(ID formid, AdaptedResultList fields, params object [] data) { // Code to execute here } } That is really all you need. Now it all becomes about custom code and configuration.  To configure the save action to show up you need to go to Modules –> WFM –> Sett