Skip to content

Latest commit

 

History

History
264 lines (212 loc) · 17.7 KB

README.ru.md

File metadata and controls

264 lines (212 loc) · 17.7 KB
Raw

Реализация кэша для временного хранения операционных данных в ASP.NET WebForms реализована настолько удачно, что не требует никаких улучшений и подходит для любого класса приложений. В ранние годы платформы .NET, за неимением ничего лучшего, разработчики зачастую импортировали пространство имён System.Web даже в WinForms приложения, чтобы иметь возможность работать с кэшем объектов в памяти.

Предлагаемый повсеместно шаблон кода очень прост и практичен:

// try to get an instance of object from cache
DataSet ds = HttpRuntime.Cache["KeyName"] as DataSet;
// check the result and recreate it, if it is null
if (ds == null)
{
    ds = QueryDataFromDatabase();
    HttpRuntime.Cache.Insert("KeyName", ds);
}
// using the instance of object that has been populated from cache or from storage
DataRow dr = ds.Tables[0].Rows[0];

Тем не менее, предлагаемая в ASP.NET реализация кэша не включает нескольких простых, но порой востребованных, функциональностей.

Параметры кэша по умолчанию

Несмотря на то, что метод добавления значения в кэш Cache.Insert(String, Object) пригоден для большинства случаев, зачастую желательно указание параметров хранения в кеше по умолчанию или на основе свойств web-приложения, хранящихся в файле Web.config, а иногда даже и полного отключения кеша для всего приложения. При этом основной код приложения не должен изменяться, запросы на извлечение данных из кэша должны возвращать null, а добавадение данных в кэш не должно ничего менять.

Универсальные методы и значения по умолчанию

ASP.NET кэш оперирует только экземплярами класса object. В большинстве случаев это не представляет проблемы, даже со значениями Value types, которые можно привести к Nullable types. Хотя дело конечно же в личном восприятии исходного кода, но хотелось бы иметь возможность использовать универсальные методы для извлечения данных:

// this is a dafault extraction data from cache
myClassName item = HttpRuntime.Cache["Key1"] as myClassName; 

// this is a desired extraction data with generic methods
myClassName item = DataCache.Get<myClassName>("Key1");

Если не устраивает типизированный вариант, то вполне можно использовать стандартный вариант кода. По сути, эти два варианта идентичны. Разница только в дополнительной проверке типа и дополнительном функционале, который могут предложить типизированные методы. Например, можно задать значение по умолчанию, если извлекаемых данных нет в кеше:

myClassName defaultValue = new myClassName(/* init properties */);
myClassName item = DataCache.Get<myClassName>("Key1", defaultValue); 
/* if there is nothing in the cache, then the item will be defaultValue */

Deep copied data

ASP.NET кэш всегда возвращает объект, хранящийся в кэше. Это означает, что изменения какого-либо свойства извлечённого объекта, повлечёт также и изменение объекта хранящего в кеше, так как это один и тот же объект. Также, стоит учесть thread safe, так как объекты в кэше не безопасны для изменения в разных потоках. В реальном приложении потребность изменения объектов хранящихся в кэше возникает не часто, но возникает. Одна из удобных функциональностей заключается в извлечении копии объекта из кэша с которой можно выполнять произвольные действия, не беспокоясь о храняшихся данных в кеше.

Хранение и очистка данных по регионам

Для приложения ASP.NET кэш представляет собой коллекцию пар ключ-значение. Это просто и элегантно, но с ростом приложения становится затруднительно подбирать правильные ключи. Например рассмотрим вариант кэширования двух связанных таблиц базы данных, например Vendors и Models. Скорее всего приложению потребуются все данные из таблицы Vendors и только связанные с определённой записью таблицы Vendors, записи таблицы Models. Организовать хранение таких срезов данных можно например по ключу Vendors для всех записей таблицы Vendors и ключам вида Models.[VendorID] для связанных записей таблицы Models. При изменении записи таблицы Vendors может потребоваться очистить не только кэш таблицы Vendors, но и кэши связанных записей таблицы Models. Использование регионов хранения данных в кеше позволило бы в данном случае очищать кэш всего региона сразу, а не обрабатывать каждый ключ по отдельности.

Implementation

Описанные функциональности не критичны и могут без особых усилий быть реализованы прямо в приложении. За время разработки веб-приложений на платформе ASP.NET я собрал всё нужное в одной библиотеке взяв за основу реализации шаблон Заместитель. Данная библиотека работает на версии .NET Framework 2.0 и выше. С выходом .NET Framework 4.0, в котором представлено пространство имён System.Runtime.Caching и несколько классов с новой моделью кэширования, потребность в стандартном кэше ASP.NET и его улучшениях конечно же отпадает.

Sad but true.

Properties and settings

/// <summary>
/// Признак использования кэша для хранения данных
/// </summary>
public static bool IsCacheEnable;

/// <summary>
/// Тип хранения объектов в кэше
/// </summary>
public static CacheExpirationType ExpirationType;

/// <summary>
/// Время хранения объектов в кэше
/// </summary>
public static TimeSpan ExpirationTime;

Перечисление CacheExpirationType определяет на какой срок данные будут храниться в кэше

/// <summary>
/// Тип хранения объектов в кэше
/// </summary>
public enum CacheExpirationType
{
    /// <summary>
    /// Без ограничения по времени, значение свойства <seealso cref="DataCache.ExpirationTime"/> будет проигнорировано
    /// </summary>
    NoExpiration,

    /// <summary>
    /// Абсолютное кэширование на заданное время в свойстве <seealso cref="DataCache.ExpirationTime"/>
    /// </summary>
    AbsoluteExpiration,

    /// <summary>
    /// Скользящее кэширование на заданное время в свойстве <seealso cref="DataCache.ExpirationTime"/>
    /// </summary>
    SlidingExpiration
}

Methods to extract data from the cache

/// <summary>
/// Возвращает типизированный объект из глобального кэша приложений по уникальному имени
/// </summary>
/// <typeparam name="T">Тип возвращаемого объекта</typeparam>
/// <param name="key">Имя объекта в кэше</param>
/// <param name="defaultValue">Значение, возвращаемое по умолчанию, если запрашиваемого объекта нет в кэше</param>
/// <returns>Извлеченный объект, или <paramref name="defaultValue"/> - если в кэше указанного объекта не обнаружено</returns>
public static T GetData<T>(string key, T defaultValue = default(T))

/// <summary>
/// Создаёт новый типизированный объект и заполняет его свойствами объекта из кэша. 
/// Идентичен методу <seealso cref="GetData{T}(string, T)"/>, но вместо возвращения объекта из кэша 
/// дублирует его значения в новом объекте.
/// </summary>
/// <typeparam name="T">Тип возвращаемого объекта</typeparam>
/// <param name="key">Имя объекта в кэше</param>
/// <param name="defaultValue">Значение, возвращаемое по умолчанию, если запрашиваемого объекта нет в кэше</param>
/// <returns>Извлеченный объект, или <paramref name="defaultValue"/> - если в кэше указанного объекта не обнаружено</returns>
public static T GetDeepCopiedData<T>(string key, T defaultValue = default(T))

Methods to store data in the cache

/// <summary>
/// Добавляет объект в глобальный кэш приложений используя параметры кэширования заданные по умолчанию.
/// Если объект по такому имени уже существует, то он будет переписан новым значением.
/// </summary>
/// <param name="key">Имя добавляемого объекта в кэше</param>
/// <param name="value">Значение добавляемого объекта в кэше</param>
public static void InsertData(string key, object value)

/// <summary>
/// Добавляет объект в глобальный кэш приложений с абсолютным кэшированием на заданное время.
/// Если объект по такому имени уже существует, то он будет переписан новым значением.
/// </summary>
/// <param name="key">Имя добавляемого объекта в кэше</param>
/// <param name="value">Значение добавляемого объекта в кэше</param>
/// <param name="expirationTime">Время хранения объекта в кэше</param>
public static void InsertAbsoluteExpirationData(string key, object value, TimeSpan expirationTime)

/// <summary>
/// Добавляет объект в глобальный кэш приложений со скользящим кэшированием на заданное время.
/// Если объект по такому имени уже существует, то он будет переписан новым значением.
/// </summary>
/// <param name="key">Имя добавляемого объекта в кэше</param>
/// <param name="value">Значение добавляемого объекта в кэше</param>
/// <param name="expirationTime">Время хранения объекта в кэше</param>
public static void InsertSlidingExpirationData(string key, object value, TimeSpan expirationTime)

/// <summary>
/// Добавляет объект в глобальный кэш приложений с заданными параметрами кэширования.
/// Если объект по такому имени уже существует, то он будет переписан новым значением.
/// </summary>
/// <param name="key">Имя добавляемого объекта в кэше</param>
/// <param name="value">Значение добавляемого объекта в кэше</param>
/// <param name="expirationType">Тип хранения объекта в кэше</param>
public static void InsertExpirationData(string key, object value, CacheExpirationType expirationType)

/// <summary>
/// Добавляет объект в глобальный кэш приложений с заданными параметрами кэширования.
/// Если объект по такому имени уже существует, то он будет переписан новым значением.
/// </summary>
/// <param name="key">Имя добавляемого объекта в кэше</param>
/// <param name="value">Значение добавляемого объекта в кэше</param>
/// <param name="expirationType">Тип хранения объекта в кэше</param>
/// <param name="expirationTime">Время хранения объекта в кэше</param>
public static void InsertExpirationData(string key, object value, CacheExpirationType expirationType, TimeSpan expirationTime)

Methods to remove data from the cache

/// <summary>
/// Удаляет объект из глобального кэша приложений по уникальному имени
/// </summary>
/// <param name="key">Имя объекта в кэше</param>
public static void RemoveDataByKey(string key)

/// <summary>
/// Удаляет объекты из глобального кэша приложений по частичному совпадению имени.
/// Удаляются все объекты, имена которых начинаются с указанного значения.
/// </summary>
/// <param name="keyStartsWith">Частичное имя объекта в кэше</param>
public static void RemoveAllDataByKey(string keyStartsWith)

/// <summary>
/// Удаляет все объекты из глобального кэша приложений
/// </summary>
public static void RemoveAllData()

Usage example

1. Settings the default parameters when application starts

public class Global : System.Web.HttpApplication
{
    protected void Application_Start(object sender, EventArgs e)
    {
        Settings settings = Settings.Default;
        DataCache.IsCacheEnable = settings.IsCacheEnable;
        DataCache.ExpirationType = settings.ExpirationType;
        DataCache.ExpirationTime = settings.ExpirationTime;
    }
}

2. Implement the standard template working with cache on the Page or in DAL

public partial class DefaultPage : System.Web.UI.Page
{
    public const string STR_CACHENAME = "something";

    protected void Page_Load(object sender, EventArgs e)
    {
        if (!this.IsPostBack)
        {
            SomethingDataModel val = DataCache.GetData<SomethingDataModel>(STR_CACHENAME);
            if (val == null) 
            {
                SomethingDataModel val = new SomethingDataModel(); // get data from ...
                DataCache.InsertData(STR_CACHENAME, val);
            }
            DataBind(val); // use data on the page
        }
    }
}

Если требуется задать параметры хранения в кэше отличные от заданных при старте приложения, воспользуйтесь одним из переопределённых методов Insert{Which}Data.

3. In the admin panel or when the database was updated remove also cached values by key or by key that starts with

public partial class DefaultPage : System.Web.UI.Page
{
    public const string STR_CACHENAME = "something";

    protected void Page_Load(object sender, EventArgs e)
    {
        if (this.IsPostBack)
        {
            DAL.Update(); // update the database ...
            DataCache.RemoveAllDataByKey(STR_CACHENAME); // clear cache
            Response.Redirect("Default.aspx"); // proccessing the request
        }
    }
}

Support or Contact

Having questions? Contact me and I will help you sort it out.

<style> .inner { min-width: 800px !important; max-width: 60% !important; }</style>