Приступая к работе с надежными службами
Приложение Azure Service Fabric содержит одну или несколько служб, которые выполняют код. В этом руководстве показано, как создавать приложения Service Fabric с отслеживанием состояния и без его учета с помощью служб Reliable Services.
Основные понятия
Чтобы приступить к работе с Reliable Services, необходимо ознакомиться только с несколькими основными понятиями.
- Тип службы. Это ваша реализация службы. Ее определяет создаваемый вами класс, который расширяет
StatelessService, и любой другой код или зависимости, используемые в нем, а также имя и номер версии. - Именованный экземпляр службы. Для запуска службы создаются именованные экземпляры вашего типа службы, что во многом похоже на создание экземпляров объектов типа класса. Экземпляр службы имеет имя в формате универсального кода ресурса (URI), использующее шаблон fabric:/. Пример: fabric:/MyApp/MyService.
- Узел службы. Создаваемые экземпляры службы должны выполняться в хост-процессе. Узел службы — это просто процесс, в котором можно запускать экземпляры вашей службы.
- Регистрации службы. Регистрация объединяет все элементы. Тип службы должен быть зарегистрирован в среде выполнения Service Fabric на узле службы, что позволит Service Fabric создавать экземпляры службы для запуска.
Создание службы без отслеживания состояния
Сейчас в облачных приложениях обычно используются службы без отслеживания состояния. Термин "без отслеживания состояния" означает, что сама служба не содержит данные, которым требуется надежное хранение или обеспечение высокого уровня доступности. Когда экземпляр службы без отслеживания состояния завершает работу, все данные о его внутреннем состоянии будут утрачены. Чтобы обеспечить высокую доступность и надежность в службах этого типа, состояния должны сохраняться во внешнее хранилище, например в таблицы Azure или Базу данных SQL.
Запустите Visual Studio 2017 или Visual Studio 2019 от имени администратора и создайте проект приложения Service Fabric с именем HelloWorld.
Затем на основе .Net Core 2.0 создайте проект службы без отслеживания состояния с именем HelloWorldStateless:
Теперь решение содержит два проекта:
- HelloWorld. Это проект приложения, который содержит ваши службы. В нем также содержится манифест приложения, описывающий приложение, и ряд скриптов PowerShell для развертывания приложения.
- HelloWorldStateless. Это проект службы. Он содержит реализацию службы без отслеживания состояния.
Реализация службы
Откройте файл HelloWorldStateless.cs в проекте службы. В Service Fabric служба может выполнять любую бизнес-логику. API службы предоставляет две точки входа для кода.
- Вызывается метод RunAsyncс открытой точкой входа, в котором можно начать выполнение любой рабочей нагрузки, например длительных вычислений.
protected override async Task RunAsync(CancellationToken cancellationToken)
{
...
}
- Точка входа для обмена данными, к которой можно подключить любой стек связи, например ASP.NET Core. С ее помощью вы можете получать запросы от пользователей и других служб.
protected override IEnumerable<ServiceInstanceListener> CreateServiceInstanceListeners()
{
...
}
В этом учебнике рассматривается метод точки входа RunAsync() . Используя его, вы можете сразу же начать выполнение кода.
Шаблон проекта включает пример реализации RunAsync() , который увеличивает показания счетчика.
Примечание
Сведения о работе со стеком взаимодействия см. в статье о взаимодействии со службами в ASP.NET Core.
RunAsync
protected override async Task RunAsync(CancellationToken cancellationToken)
{
// TODO: Replace the following sample code with your own logic
// or remove this RunAsync override if it's not needed in your service.
long iterations = 0;
while (true)
{
cancellationToken.ThrowIfCancellationRequested();
ServiceEventSource.Current.ServiceMessage(this.Context, "Working-{0}", ++iterations);
await Task.Delay(TimeSpan.FromSeconds(1), cancellationToken);
}
}
Платформа вызывает этот метод, когда экземпляр службы размещен и готов к выполнению. Для службы без отслеживания состояния это означает, что экземпляр службы открыт. Токен отмены предоставляется для координации закрытия экземпляра вашей службы. В Service Fabric этот цикл открытия и закрытия экземпляра службы может выполняться много раз за все время существования службы. Это может происходить по ряду причин.
- Система перемещает экземпляры служб для распределения ресурсов.
- В коде возникают ошибки.
- Выполняется обновление приложения или системы.
- Возникает аппаратный сбой.
Этой оркестрацией управляет система для сохранения высокой доступности и правильного баланса службы.
Реализация RunAsync() не должна использовать синхронную блокировку. Ваша реализация RunAsync должна вернуть задачу или дождаться завершения любых длительных или блокирующих операций, чтобы продолжить выполнение. Обратите внимание, что в цикле while(true) в предыдущем примере для возвращения задачи используется await Task.Delay(). Если для рабочей нагрузки требуется синхронная блокировка, то в своей реализации RunAsync следует запланировать новую задачу с Task.Run().
Отмена рабочей нагрузки является совместным действием, координированным предоставленным токеном отмены. Чтобы продолжать работу, система должна дождаться завершения задачи (успешного завершения, отмены или завершения вследствие ошибки). Когда система запрашивает отмену задачи, важно как можно быстрее подтвердить токен отмены, завершить все выполняющиеся операции и выйти из RunAsync() .
В этом примере службы без отслеживания состояния счетчик хранится в локальной переменной. Но так как это служба без отслеживания состояния, хранимое значение существует только для текущего жизненного цикла экземпляра службы. Если службу переместить или перезапустить, значение будет утеряно.
Создание службы с отслеживанием состояния
Service Fabric представляет новый вид службы с отслеживанием состояния. Служба с отслеживанием состояния может надежно поддерживать состояние в самой службе (совмещая с кодом, который его использует). Service Fabric делает состояние высокодоступным без необходимости сохранения состояния во внешнее хранилище.
Чтобы преобразовать значение счетчика без учета состояния в высокодоступное и постоянное (даже при перемещении или перезапуске службы), нужно использовать службу с отслеживанием состояния.
В том же приложении HelloWorld можно добавить новую службу, щелкнув правой кнопкой мыши ссылки на службы в проекте приложения и выбрав Добавить -> Новая служба Service Fabric.
Выберите .NET Core 2.0 -> Служба с отслеживанием состояния и присвойте ей имя HelloWorldStateful. Нажмите кнопку ОК.
Теперь в вашем приложении должно быть две службы: служба без отслеживания состояния HelloWorldStateless и служба с отслеживанием состояния HelloWorldStateful.
Служба с отслеживанием состояния имеет такие же точки входа, как и служба без отслеживания состояния. Основное различие заключается в доступности поставщика состояний, который надежно хранит состояние. Платформа Service Fabric поставляется с реализацией поставщика состояний Надежные коллекции Reliable Collections, которая позволяет создавать реплицированные структуры данных с помощью диспетчера надежных состояний. Служба Reliable Service с отслеживанием состояния использует этот поставщик состояний по умолчанию.
Откройте HelloWorldStateful.cs в службе HelloWorldStateful, содержащей следующий метод RunAsync.
protected override async Task RunAsync(CancellationToken cancellationToken)
{
// TODO: Replace the following sample code with your own logic
// or remove this RunAsync override if it's not needed in your service.
var myDictionary = await this.StateManager.GetOrAddAsync<IReliableDictionary<string, long>>("myDictionary");
while (true)
{
cancellationToken.ThrowIfCancellationRequested();
using (var tx = this.StateManager.CreateTransaction())
{
var result = await myDictionary.TryGetValueAsync(tx, "Counter");
ServiceEventSource.Current.ServiceMessage(this.Context, "Current Counter Value: {0}",
result.HasValue ? result.Value.ToString() : "Value does not exist.");
await myDictionary.AddOrUpdateAsync(tx, "Counter", 0, (key, value) => ++value);
// If an exception is thrown before calling CommitAsync, the transaction aborts, all changes are
// discarded, and nothing is saved to the secondary replicas.
await tx.CommitAsync();
}
await Task.Delay(TimeSpan.FromSeconds(1), cancellationToken);
}
RunAsync
RunAsync() работает одинаково в службах с отслеживанием и без отслеживания состояния. Однако в службе с отслеживанием состояния платформа выполняет дополнительные действия от вашего имени перед выполнением RunAsync(). Эти действия могут включать подготовку диспетчера надежных состояний и коллекций Reliable Collections к использованию.
Reliable Collections и диспетчер надежных состояний
var myDictionary = await this.StateManager.GetOrAddAsync<IReliableDictionary<string, long>>("myDictionary");
IReliableDictionary — это реализация словаря, которая позволяет надежно хранить состояние службы. В Service Fabric с помощью Reliable Collections можно хранить данные непосредственно в службе без использования внешнего постоянного хранилища. Надежные коллекции Reliable Collections делают данные высокодоступными. Service Fabric выполняет эту задачу, автоматически создавая несколько реплик службы и управляя ими. Кроме того, платформа предоставляет API-интерфейс, который упрощает управление этими репликами и переходы между их состояниями.
В Reliable Collections можно хранить любые типы объектов .NET, включая пользовательские типы. Необходимо только учитывать следующее.
Service Fabric делает состояние высокодоступным, реплицируя его между узлами и сохраняя на локальном диске, а служба Reliable Collections сохраняет ваши данные на локальном диске каждой реплики. Это означает, что все объекты, хранящиеся в Reliable Collections, должны поддерживать сериализацию. По умолчанию в Reliable Collections для сериализации используется DataContract. Поэтому при использовании сериализатора по умолчанию убедитесь, что ваши типы поддерживаются сериализатором контрактов данных.
Когда вы зафиксируете транзакции в Reliable Collections, объекты реплицируются и становятся высокодоступными. Объекты, сохраненные в Reliable Collections, хранятся в локальной памяти вашей службы. Это означает, что у вас есть локальная ссылка на объект.
Очень важно не изменять локальные экземпляры этих объектов без обновления коллекции в транзакции, так как эти изменения не реплицируются автоматически. Необходимо повторно вставить объект в словарь или использовать один из методов update в словаре.
Диспетчер надежных состояний автоматически управляет коллекциями Reliable Collections. Просто запросите у диспетчера надежных состояний имя коллекции в любое время и в любом расположении службы, и вы гарантированно получите ссылку. Мы не рекомендуем сохранять ссылки на экземпляры коллекции в переменные или свойства членов класса. Необходимо внимательно следить, чтобы ссылка указывала на экземпляр на протяжении всего жизненного цикла службы. Диспетчер надежных состояний выполняет за вас эту работу. Кроме того, он оптимизирован для повторных визитов.
Транзакционные и асинхронные операции
using (ITransaction tx = this.StateManager.CreateTransaction())
{
var result = await myDictionary.TryGetValueAsync(tx, "Counter-1");
await myDictionary.AddOrUpdateAsync(tx, "Counter-1", 0, (k, v) => ++v);
await tx.CommitAsync();
}
В надежных коллекциях имеется множество операций, аналогичных операциям System.Collections.Generic и System.Collections.Concurrent, за исключением LINQ. Операции в надежных коллекциях являются асинхронными. Это вызвано тем, что операции записи с Reliable Collections выполняют операции ввода-вывода для репликации и сохранения данных на диске.
Операции Reliable Collections являются транзакционными, так что вы можете сохранять согласованное состояние между несколькими Reliable Collections и операциями. Например, вы можете исключить рабочий элемент из надежной очереди, выполнить над ним какую-либо операцию и сохранить результат в надежном словаре, и это все в пределах одной транзакции. Такая операция называется атомарной. Предусматривается, что либо вся операция завершится успешно, либо она будет полностью отменена. Если ошибка возникнет после выведения элемента из очереди, но до сохранения результата, будет выполнен откат всей транзакции, а элемент останется в очереди для обработки.
Выполнение приложения
Теперь вернемся к приложению HelloWorld . Теперь вы можете построить и развернуть свои службы. Когда вы нажмете клавишу F5, приложение будет построено и развернуто в вашем локальном кластере.
Запустив службы, вы сможете просмотреть созданные события трассировки событий Windows в окне События диагностики . Обратите внимание, что в приложении отображаются события как из службы без отслеживания состояния, так и из службы с отслеживанием состояния. Поток можно приостановить, нажав кнопку Приостановить . Затем можно просмотреть подробные сведения о сообщении, развернув его.
Примечание
Перед запуском приложения убедитесь, что кластер локальной разработки запущен. Сведения о настройке локальной среды см. в руководстве по началу работы.
Дальнейшие действия
Отладка приложения Service Fabric с помощью Visual Studio
Приступая к работе со службами веб-API Service Fabric с саморазмещением OWIN