README.md

Seeking New Ownership!

This project is no longer actively being maintained. If you are interested in taking over as an owner, please inquire within

CacheStack

Cache extensions for Service Stack ICacheClient. Includes mvc donut caching and the notion of a cache context. This is a .net 4.5 library designed to work with ASP.NET MVC 4+. This library can be installed via nuget.

Additional Information

Donut caching is a customized version of MvcDonutCaching persisting content via ICacheClient and leveraging cache context for cache invalidation.

The cache context allows you to setup cache profiles and triggers. Cache profiles are not constrained to the web.config and can be defined in a variety of ways. Cache triggers allow objects to be invalidated from the cache without worrying about specific cache keys.

Conventions/Best Practices

• Relation triggers will need a ReferencesAttribute to work properly. Spruce and OrmLite both have implementations that will suffice. You will also see the best results if your object relations have an Id field specified.
• If you use attribute routing, you'll be further ahead to set CacheStackSettings.UseRouteNameForCacheKey = true;

Example Usage

• Real world, example usage can be found in the MvcKickstart project.

Configuring cache durations using cache profiles

// Somewhere in your application configuration

// Get the cache client from your DI framework of choice or some other way
CacheStackSettings.CacheClient = ObjectFactory.GetInstance<ICacheClient>();
// All of our routes are unique and not shared, so we can use the route name instead of reflection to get a unique cache key
CacheStackSettings.UseRouteNameForCacheKey = true;
CacheStackSettings.CacheProfileDurations = profile => {
	// Can get these values from a db, web.config, or anywhere else
	switch ((CacheProfile)profile) {
		case CacheProfile.Profile1:
			return TimeSpan.FromSeconds(1);
		case CacheProfile.Profile2:
			return TimeSpan.FromMinutes(60);
		default:
			return TimeSpan.FromMinutes(15);
	}
};

// Somewhere else in your solution
public enum CacheProfile {
	Profile1,
	Profile2,
}

Using cache context with donut caching and mvc controller actions

	public class MyController : Controller, IWithCacheContext {
		public ICacheContext CacheContext { get; private set; }
		
		public MyController(ICacheClient cache) {
			CacheContext = new CacheContext(cache);
		}
		
		[DonutOutputCache]
		public ActionResult Index() {
			// Set the cache profile to use when caching this action
			CacheContext.UseCacheProfile(CacheProfile.Profile2);
			// Setup a trigger to invalidate the cache for this action when any MyObject item is updated
			CacheContext.InvalidateOn(TriggerFrom.Any<MyObject>());
		
			return View();
		}
	}

Invalidating cache objects

// Somewhere in your code - for this example, we'll invalidate from a controller action
public ActionResult MyAction(id) {
	var myObject = Db.GetByIdOrDefault<MyObject>(id);
	myObject.UpdatedProperty = DateTime.UtcNow;
	Db.Save(myObject);
	
	// This will invalidate all objects watching for changes to MyObject types with this object's id
	Cache.Trigger(TriggerFor.Id<MyObject>(myObject.Id));
}

Populating multiple cache keys for a single object

Sometimes there are multiple ways of getting the same object. In this example, we have two cache keys for user objects. We can get a user by their id or by their username. Why hit the db when getting a user by username if we already have that user cached by id. Note: Multiple cache keys will only be populated if the original key is present in that list

// Somewhere in your application configuration
CacheStackSettings.CacheKeysForObject.Add(typeof(User), item => {
	var userItem = item as User;
	var keys = new List<string>();	
	keys.Add(CacheKeys.User.ById(userItem.Id));
	keys.Add(CacheKeys.User.ByUsername(userItem.Username));	
	return keys;
});

Capturing stats for cache hit/miss events

Please note that these events only fire if you use Cache.GetOrCache() and will not fire for other cache methods.

// Somewhere in your application configuration
CacheStackSettings.CacheHit += (cache, e) => {
	Metrics.Increment("Cache.Hit.All");
	Metrics.Increment("Cache.Hit.ByType." + e.Type.Name);
	Metrics.Increment("Cache.Hit.ByKey." + e.CacheKey.TrimStart('_'));
};
CacheStackSettings.CacheMiss += (cache, e) => {
	Metrics.Increment("Cache.Miss.All");
	Metrics.Increment("Cache.Miss.ByType." + e.Type.Name);
	Metrics.Increment("Cache.Miss.ByKey." + e.CacheKey.TrimStart('_'));
};