правильный способ Dispose: объект не расположен вдоль всех путей исключения

Question

я получаю это сообщение для линии 84 и линий 85 (два, сложенные с использованием линий):

CA2000: Microsoft.Reliability: В методе 'RavenDataAccess.GetRavenDatabase()', object '<> g_ initLocal9' не размещается вдоль всех путей исключения. Вызовите System.IDisposable.Dispose на объекте '<> g _initLocal9', прежде чем все ссылки на него выйдут из области видимости.

DocumentStore реализует IDisposable.

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

private static IDocumentStore GetRavenDatabase() 
{ 
    Shards shards = new Shards(); 

    try 
    { 
     using (DocumentStore docStore1 = new DocumentStore { Url = ConfigurationManager.AppSettings["RavenShard1"] }) // Line 84 
     using (DocumentStore docStore2 = new DocumentStore { Url = ConfigurationManager.AppSettings["RavenShard2"] }) // Line 85 
     { 
      shards.Add(docStore1); 
      shards.Add(docStore2); 
     } 

     using (ShardedDocumentStore documentStore = new ShardedDocumentStore(new ShardStrategy(), shards)) 
     { 
      documentStore.Initialize(); 

      IndexCreation.CreateIndexes(typeof(RavenDataAccess).Assembly, documentStore); 

      return documentStore; 
     } 
    } 
    catch 
    { 
     shards.ForEach(docStore => docStore.Dispose()); 

     throw; 
    } 
} 

Answer 1

Вы должны обеспечить, чтобы все ваши вновь создаваемые одноразовые объекты располагались вдоль любого возможного пути исключения.См. Ниже:

private static IDocumentStore GetRavenDatabase() 
{ 
    Shards shards = new Shards(); 
    DocumentStore docStore1 = null; 
    DocumentStore docStore2 = null; 

    ShardedDocumentStore shardedDocumentStore = null; 
    ShardedDocumentStore tempShardedDocumentStore = null; 

    try 
    { 
     docStore1 = new DocumentStore(); 
     docStore1.Url = ConfigurationManager.AppSettings["RavenShard1"]; 
     docStore2 = new DocumentStore(); 
     docStore2.Url = ConfigurationManager.AppSettings["RavenShard2"]; 

     shards.Add(docStore1); 
     shards.Add(docStore2); 

     tempShardedDocumentStore = new ShardedDocumentStore(new ShardStrategy(), shards); 
     tempShardedDocumentStore.Initialize(); 

     IndexCreation.CreateIndexes(typeof(RavenDataAccess).Assembly, tempShardedDocumentStore); 

     docStore1 = null; 
     docStore2 = null; 

     shardedDocumentStore = tempShardedDocumentStore; 
     tempShardedDocumentStore = null; 

     return shardedDocumentStore; 
    } 
    finally 
    { 
     if (tempShardedDocumentStore != null) { tempShardedDocumentStore.Dispose(); } 
     if (docStore1 != null) { docStore1.Dispose(); } 
     if (docStore2 != null) { docStore2.Dispose(); } 
    } 
} 

У CA, похоже, есть проблема с инициализаторами свойств inline, но если вы их разблокируете, это должно сработать. Главное - убедиться, что независимо от того, где исключение выбрано в блоке try, все ваши новые объекты, которые могут быть удалены, очищаются. не

Устанавливая ссылки временные вам больше не нужно null (docStore1, docStore2 и tempShardedDocumentStore) как раз перед возвращением, вы можете проверить в конце концов заблокировать, чтобы увидеть, если они на самом деле были установлены null, если нет, то исключение произошло где-то, и вы можете избавиться от них до того, как выполнение оставит этот метод.

ПримечаниеdocStore1 и docStore2 временные ссылки, поскольку они добавляются к Shards коллекции.

Answer 2

Учитывая, что CA2000: Dispose objects before losing scope документации государства (часть из него):

вложенности конструкторы, защищенные только один обработчик исключений. Например:

используя (StreamReader КН = новый StreamReader (новый FileStream ("C: \ myfile.txt", FileMode.Create))) {...}

вызывает CA2000 произойти из-за сбой в построении объекта StreamReader может привести к тому, что объект FileStream никогда не будет закрыт. .

и учитывая, что я не вижу в коде предоставил одноразовое выделение объекта другой, то DocumentStore себя, я бы предположил, что это ошибка компилятора.

Answer 3

Прежде всего, shards вы передаете new ShardedDocumentStore() содержит docStore1 и docStore2. Это, скорее всего, вызовет проблемы.

Кроме того, в выписке вы устанавливаете docStores, который уже может быть удален.

И наконец, возвращаемый вами ShardedDocumentStore был удален (при использовании), когда вы его возвращаете, что делает его непригодным для вызывающего абонента.

Кроме того, я быстро просмотрел ShardedDocumentStore (в GitHub), и я бы сказал, что он заботится об утилизации своего docStores. То есть вы не должны справляться с этим.

Измените код следующим образом:

private static IDocumentStore GetRavenDatabase() 
{ 
    ShardedDocumentStore documentStore = null; 
    var docStore1 = null; 
    var docStore2 = null; 

    try 
    { 
     Shards shards = new Shards(); 
     docStore1 = new DocumentStore { Url = ConfigurationManager.AppSettings["RavenShard1"] }; 
     shards.Add(docStore1); 
     docStore2 = new DocumentStore { Url = ConfigurationManager.AppSettings["RavenShard2"] }; 
     shards.Add(docStore2); 

     documentStore = new ShardedDocumentStore(new ShardStrategy(), shards); 
     documentStore.Initialize(); 

     IndexCreation.CreateIndexes(typeof(RavenDataAccess).Assembly, documentStore); 

     return documentStore; 
    } 
    catch 
    { 
     if (documentStore != null) 
     { 
      documentStore.Dispose(); 
     } 
     else 
     { 
      if (docStore2 != null) docStore2.Dispose(); 
      if (docStore1 != null) docStore1.Dispose(); 
     } 
     throw; 
    } 
} 

... и пусть вызывающий в GetRavenDatabase() распоряжения ручки возвращенного IDocumentStore.

Answer 4

Вот почему объект инициализаторы в результате, используя заявление в предупреждение CA:

Ваш код, который выглядит следующим образом:

using (DocumentStore docStore2 = new DocumentStore { Url = ConfigurationManager.AppSettings["RavenShard2"] }) // Line 85 
{ 
    ... 
} 

... essentialy становится этим, в связи с тем, как объект инициализаторов работы :

DocumentStore foo = new DocumentStore; 
foo.Url = ConfigurationManager.AppSettings["RavenShard2"]; 
using(DocumentStore docStore2 = foo) 
{ 
    ... 
} 

так как вы можете видеть, инициализация DocumentStore происходит сейчас вне с помощью {} блока, так что если линия, которая устанавливает temp.Url бросает excep , ваш DocumentStore не будет удален.

Существует несколько способов обхода пути, например, передача параметров в конструктор объекта, установка свойств внутри оператора using вместо использования инициализаторов объектов или использование блоков try/finally.