Локальное хранилище

В этом руководстве мы объясняем, как работать с локальным хранилищем при разработке алгоритмов cTrader. Ниже мы приводим краткое описание того, как работает доступ к локальному хранилищу.

Использование локального хранилища

Думайте о локальном хранилище как о способе сохранения информации между одной или несколькими остановками и запусками ваших сиБотов и индикаторов. Эта функция позволяет сохранять данные сиБотов и индикаторов, а затем получать доступ к этой информации несколькими способами в зависимости от ваших потребностей. Локальное хранилище работает независимо от прав доступа, предоставленных алгоритму.

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

• SetString(string key, string value) — сохраняет строковое значение, сопоставляя его с указанным ключом.
• SetObject(string key, object obj) — сохраняет объект, сопоставляя его с указанным ключом.
• GetString(string key) — извлекает сохраненное строковое значение, находя его по указанному ключу.
• T GetObject<T>(string key) — извлекает сохраненный объект типа T из локального хранилища, находя его по указанному ключу.

Рассмотрим следующий пример, в котором мы просим экземпляр сиБота сохранить пример сообщения при запуске. При последующих запусках тот же экземпляр отобразит окно сообщения, содержащее наше сообщение.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using cAlgo.API;
using cAlgo.API.Collections;
using cAlgo.API.Indicators;
using cAlgo.API.Internals;

namespace cAlgo.Robots
{
    [Robot(AccessRights = AccessRights.None)]
    public class SampleLocalStorageTest : Robot

    {

        protected override void OnStart()
        {

            string messageLocalStorage = LocalStorage.GetString("Example Message");

            if (messageLocalStorage is not null)

            {

                MessageBox.Show(messageLocalStorage);

            }

            LocalStorage.SetString("Example Message", "This is just an example message");
        }
    }
}

После первого запуска экземпляра сиБота он сохраняет наше примерное сообщение в локальном хранилище. После остановки экземпляра и его повторного запуска отображается следующее окно сообщения.

Обратите внимание, что локальное хранилище работает даже при указании AccessRights.None.

Определение области локального хранилища

Область локального хранилища (определяемая через тип LocalStorageScope) определяет, где именно хранится информация и как к ней можно получить доступ. Это перечисление enum содержит следующие константы:

• LocalStorageScope.Instance — сохраненные данные хранятся и доступны только конкретному запущенному экземпляру сиБота или индикатора. Информация сохраняется в каталоге Documents/cAlgo/LocalStorage/{AlgoType}/{AlgoName}/{InstanceUniqueIdentifier}/. В этом пути "AlgoType" обозначает тип расширения cTrader, работающего с локальным хранилищем (cBots или Indicators), а AlgoName — это имя конкретного сиБота/индикатора. InstanceUniqueIdentifier — это уникальный идентификатор конкретного экземпляра определенного сиБота или индикатора.
• LocalStorageScope.Type — сохраненные данные хранятся и доступны всем запущенным экземплярам конкретного сиБота или индикатора. Информация сохраняется в каталоге Documents/cAlgo/LocalStorage/{AlgoType}/{AlgoName}/.
• LocalStorageScope.Device — сохраненные данные хранятся и доступны всем запущенным экземплярам сиБотов и индикаторов на текущем устройстве. Информация сохраняется в каталоге "Documents/cAlgo/LocalStorage/".

В свою очередь, методы, такие как SetString() и SetObject(), имеют дополнительные перегрузки, позволяющие указать пользовательскую область локального хранилища. Например, следующий код сохранит строку в LocalStorageScope.Type; эта строка, следовательно, будет доступна всем расширениям определенного типа.

1

SetString(“Example String”, “Just an example string”, LocalStorageScope.Type);

Если LocalStorageScope не указан в качестве параметра, по умолчанию используется LocalStorageScope.Instance.

Обратите внимание, что это поведение отличается для методов GetString(string key) и T GetObject<T>(string key). Когда эти методы вызываются без указания области локального хранилища, они будут искать указанный ключ во всех областях, следуя приведенной ниже иерархии:

• Экземпляр
• Тип
• Устройство

Кроме того, каждая отдельная область локального хранилища имеет свою собственную квоту дискового пространства:

• LocalStorageScope.Instance ограничена 10 МБ.
• LocalStorageScope.Type ограничена 100 МБ.
• LocalStorageScope.Device ограничена 500 МБ.

Указанные выше ограничения не являются кумулятивными. Например, если вы уже использовали все 500 МБ хранилища на уровне устройства, вы все равно сможете сохранять информацию, используя хранилище на уровне экземпляра, пока не достигнете его лимита в 10 МБ.

Как работает сохранение и загрузка информации

При сохранении информации в локальное хранилище (например, путем вызова метода SetString()) cTrader автоматически сохраняет данные каждую минуту. Данные также сохраняются при остановке экземпляра.

Однако вы можете настроить это поведение, используя следующие методы:

• Flush(LocalStorageScope localStorageScope) — сохраняет все данные в указанной области.
• Reload(LocalStorageScope localStorageScope) — перезагружает все значения из указанной области.

Имейте в виду, что при вызове метода Reload(LocalStorageScope localStorageScope любые ожидающие изменения могут быть потеряны. Чтобы избежать этого, обязательно вызовите Flush(LocalStorageScope localStorageScope) заранее.

В приведенном ниже примере мы просим сиБота выполнить рыночный ордер. После завершения этого действия мы немедленно сохраняем валовую прибыль позиции, которую мы только что открыли, в LocalStorageScope.Type.

1
2
3
4
5

ExecuteMarketOrder(TradeType.Buy, SymbolName, 10000, “Custom label”);
var positionOne = Positions.Find("Custom label");        
string positionOneGrossProfit = positionOne.GrossProfit.ToString();
LocalStorage.SetString("Position 1", positionOneGrossProfit, LocalStorageScope.Device); 
LocalStorage.Flush(LocalStorageScope.Device);

Локальное хранилище в бэктестинге и оптимизации

Локальное хранилище работает иначе в бэктестинге по сравнению с торговлей в реальном времени.

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

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

Подводя итог, локальное хранилище — это очень полезная функция Algo API, которая позволяет сохранять данные между несколькими остановками и запусками различных сиБотов и индикаторов. Эффективно используя локальное хранилище, вы можете создавать сложные автоматизированные торговые стратегии на основе пользовательских данных, сохраненных в вашей файловой системе.