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.


hamalcahan said…
Harrah's New Orleans Casino & Hotel - JTA Hub
Harrah's 영주 출장샵 New 성남 출장마사지 Orleans Casino & Hotel - 777 Harrah's Boulevard 경기도 출장샵 New 남원 출장안마 Orleans, LA 70130-9646 (716) 755-7777 군포 출장마사지

Popular posts from this blog

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

Experience Profile Anonymous, Unknown and Known contacts

When you first get started with Sitecore's experience profile the reporting for contacts can cause a little confusion. There are 3 terms that are thrown around, 1) Anonymous 2) Unknown 3) Known. When you read the docs they can bleed into each other a little. First, have a read through the Sitecore tracking documentation to get a feel for what Sitecore is trying to do. There are a couple key things here to first understand: Unless you call " IdentifyAs() " for request the contact is always anonymous.  Tracking of anonymous contacts is off by default.  Even if you call "IdentifyAs()" if you don't set facet values for the contact (like first name and email) the contact will still show up in your experience profile as "unknown" (because it has no facet data to display).  Enabled Anonymous contacts Notice in the picture I have two contacts marked in a red box. Those are my "known" contacts that I called "IdentifyAs"

Password Management

The need to create, store and manage passwords is a huge responsibility in modern day life. So why is it that so many people do it so poorly? This is a loaded questions with answers ranging from people being uneducated, to lazy, to educated but not affective in their methods and many more. This blog is to help those (in some way even myself) around me strengthen their online security. Why does it matter? To answer this let's look at a few numbers. According to the US Department of Justice (DOJ)’s most recent study , 17.6 million people in the US experience some form of identity theft each year. Ok fine but that is identity theft that has nothing to do with password management. What is one way someone can start getting information about who you are? How do they get access to steal your money? From Cyber Security Ventures 2019 report : "Cybersecurity Ventures predicts that healthcare will suffer 2-3X more cyberattacks in 2019 than the average amount for other industries. W

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

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