Кэшируем данные в приложениях OneScript

Введение

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

Описание

Основой библиотеки является статическое свойство Default , класса MemoryCache , которое доступно в любом приложении .NET. 

Доступные типы

КэшПамятиПоУмолчанию
Основной тип, реализующий работу с кэшем.

Конструкторы:
По умолчанию.

Методы:
Добавить(Ключ, Объект, ПолитикаКэширования)
Описание:
Добавляет объект в кэш с определенной политикой кэширования.
Параметры:
Ключ - идентификатор объекта, имеет тип Строка.
Объект - объект, который помещается в кэш, может иметь любой тип.
ПолитикаКэширования - объект типа ПолитикаКэшированияЭлемента, который определяет условия нахождения объекта в кэше.
Возвращаемое значение:
Тип boolean. Истина - если вставка прошла успешно, Ложь - если объект с таким ключем уже находится в кэше.
 

Удалить(Ключ)
Описание:
Удаляет объект, соответствующий идентификатору Ключ из кэша.
Параметры:
Ключ - идентификатор удаляемого объекта, имеет тип Строка.
Возвращаемое значение:
Возвращает удаляемый объект или Неопределено, если объект отсутствует в кэше.
 

Получить(Ключ)
Описание:
Получает объект из кэша по идентификатору.
Параметры:
Ключ - идентификатор объекта в кэше, имеет тип Строка.
Возвращаемое значение:
Возвращает сохраненный объект или Неопределено, если объект отсутствует в кэше.

ПолитикаКэшированияЭлемента
Используется для задания условий нахождения объекта в кэше, а также его удаления.

Конструкторы:
По умолчанию.

Методы:
Нет.

Свойства:
ДатаИстечения
Описание:
Определяет дату и время, по достижению которой, объект будет удален из кэша. Имеет тип Дата. Невозможно совместное использования этого свойства и свойства ПериодНеИспользования.

ПериодНеИспользования
Если не происходит обращения к объекту в кэше, в течение периода в секундах, определяемого этим свойством, объект будет автоматически удален из кэша. Имеет тип - Число. Невозможно совместное использования этого свойства и свойства ДатаИстечения.  

МониторыИзменения
Массив элементов, типа МониторИзмененияФайловНаКомпьютере. При изменении файлов, отслеживаемых мониторами, объект будет автоматически удален из кэша. 

МониторИзмененияФайловНаКомпьютере
Используется для мониторинга изменения/удаления файлов на компьютере.

Конструкторы:
МониторИзмененияФайловНаКомпьютере(СписокФайлов)
Описание:
Создает монитор изменений файлов на компьютере.
Параметры:
СписокФайлов - Массив элементов типа Строка, содержащих физический путь к файлам, изменение которых требуется отслеживать.

Методы:
Нет.

Свойства:
Файлы
Содержит массив элементов типа Строка, которые содержат физический путь к файлам, изменения которых отслеживаются данным монитором.

БылиИзменения
Имеет значение Истина - если были изменения и Ложь, в противном случае.

Установка

OneScript
Установка осуществляется простым копированием файлов dll в какую-нибудь папку.

HTTP-сервисы OneScript
Установка осуществляется копированием файлов dll в папку Bin веб-приложения.
Затем, необходимо подключить библиотеку, добавив нижеследующую строку в секцию appSettings, файла web.config:

<add key="DefaultMemoryCache" value="attachAssembly" />

Использование

Подключение библиотеки

OneScript

ПодключитьВнешнююКомпоненту("ПутьКПапкеГдеРасположеныDll\DefaultMemoryCache.dll");

HTTP-сервисы OneScript
Поскольку dll библиотеки подключается автоматически при старте web-приложения - никаких дополнительных действий не требуется.

Пример использования

OneScript

Результат = Неопределено;

// Создаем объект кэша
Кэш =  Новый КэшПамятиПоУмолчанию;

// Пытаемся получить объект по идентификатору
Результат = Кэш.Получить("c:\1\1\source.txt");

Если Результат = Неопределено Тогда

	// Объекта нет в кэше
	// Создаем объект
	Результат = Новый ТекстовыйДокумент;
	Результат.Прочитать("c:\1\1\source.txt");

	// Создаем политику кэширования, которая будет удалять объект из кэша при изменениии файла
	Политика = Новый ПолитикаКэшированияЭлемента;
	
	МассивФайлов = Новый Массив;
	МассивФайлов.Добавить("c:\1\1\source.txt");
	МассивМониторов = Новый Массив;
	МассивМониторов.Добавить(Новый МониторИзмененияФайловНаКомпьютере(МассивФайлов));
	Политика.МониторыИзменения = МассивМониторов;
	
	// Также, можем ограничить нахождение объекта в кэше определенной датой
	Политика.ДатаИстечения = ТекущаяДата() + 60;
	// Или удаляем объект, если он не использовался определенное количество секунд
	// Совместное использование ПериодНеИспользования и ДатаИстечения невозможно
	//Политика.ПериодНеИспользования = 10;
	
	// Помещаем его в кэш. Первый параметр - идентификатор объекта
	Кэш.Добавить("c:\1\1\source.txt", Результат, Политика);

КонецЕсли;

1С:Предприятие (Каркасная конфигурация)
Ниже приведен пример кода, иллюстрирующий использования библиотеки в Ваших web-приложениях, создаваемых на основе каркасной конфигурации .  

// Это пример использования библиотеки в каркасной конфигурации
// для создания web-приложений

Результат = Неопределено;

// Выполняется только в OneScript. 
// В 1С:Предприятие, код между //<OneScript> и //<!OneScript>, должен быть закомментирован

//<OneScript>
//// Создаем объект кэша
//Кэш =  Новый КэшПамятиПоУмолчанию;
//
//// Пытаемся получить объект по идентификатору
//Результат = Кэш.Получить("c:\1\1\source.txt");
//<!OneScript>

Если Результат = Неопределено Тогда

	// Объекта нет в кэше
	// Создаем объект
	Результат = Новый ТекстовыйДокумент;
	Результат.Прочитать("c:\1\1\source.txt");

	// Выполняется только в OneScript. 
	// В 1С:Предприятие код, между //<OneScript> и //<!OneScript> должен быть закомментирован
	//<OneScript>
	//// Создаем политику кэширования, которая будет удалять объект из кэша при изменениии файла
	//Политика = Новый ПолитикаКэшированияЭлемента;
	
	//МассивФайлов = Новый Массив;
	//МассивФайлов.Добавить("c:\1\1\source.txt");
	//МассивМониторов = Новый Массив;
	//МассивМониторов.Добавить(Новый МониторИзмененияФайловНаКомпьютере(МассивФайлов));
	//Политика.МониторыИзменения = МассивМониторов;
	
	//// Также, можем ограничить нахождение объекта в кэше определенной датой
	//Политика.ДатаИстечения = ТекущаяДата() + 60;
	//// Или удаляем объект, если он не использовался определенное количество секунд
	//// Совместное использование ПериодНеИспользования и ДатаИстечения невозможно
	////Политика.ПериодНеИспользования = 10;
	//
	//// Помещаем его в кэш. Первый параметр - идентификатор объекта
	//Кэш.Добавить("c:\1\1\source.txt", Результат, Политика);
	//<!OneScript>

КонецЕсли;

Заключение

Надеюсь, что настоящая библиотека поможет Вам улучшить производительность Ваших приложений на OneScript.

P.S.

Саму библиотеку можно загрузить, скачав архив из файлов для скачивания.

Исходный код библиотеки можно посмотреть по ссылке: https://github.com/jdeshin/OneScript-MemoryCache