XmlSerializer дає FileNotFoundException у конструкторі

Програма, з якою я працював, не працює, коли я намагаюся серіалізувати типи.

Заява на кшталт

XmlSerializer lizer = new XmlSerializer(typeof(MyType));

виробляє:

System.IO.FileNotFoundException occurred
  Message="Could not load file or assembly '[Containing Assembly of MyType].XmlSerializers, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null' or one of its dependencies. The system cannot find the file specified."
  Source="mscorlib"
  FileName="[Containing Assembly of MyType].XmlSerializers, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
  FusionLog=""
  StackTrace:
       at System.Reflection.Assembly._nLoad(AssemblyName fileName, String codeBase, Evidence assemblySecurity, Assembly locationHint, StackCrawlMark& stackMark, Boolean throwOnFileNotFound, Boolean forIntrospection)
       at System.Reflection.Assembly.nLoad(AssemblyName fileName, String codeBase, Evidence assemblySecurity, Assembly locationHint, StackCrawlMark& stackMark, Boolean throwOnFileNotFound, Boolean forIntrospection)

Я не визначаю жодних спеціальних серіалізаторів для свого класу.

Як я можу виправити цю проблему?

Вірите чи ні, це нормальна поведінка. Виняток кидається, але XmlSerializer обробляє, але якщо ви просто ігноруєте його, все має продовжуватися.

Я вважаю це дуже дратівливим, і було багато скарг на це, якщо трохи пошукати, але з того, що я прочитав, Microsoft не планує нічого з цим робити.

Ви можете уникнути отримання спливаючих вікон Exception весь час під час налагодження, якщо вимкнути винятки з першого шансу для цього конкретного винятку. У візуальній студії перейдіть до програми налагодження -> Винятки (або натисніть Ctrl+ Alt+ E), Винятки з загальної мови для виконання -> System.IO -> System.IO.FileNotFoundException .

Ви можете знайти інформацію про інший спосіб її вирішення у випуску блогу C # XmlSerializer FileNotFound (де обговорюється інструмент Chris Sells XmlSerializerPreCompiler ).

Як сказав Мартін Шерберн, це нормальна поведінка. Конструктор XmlSerializer спочатку намагається знайти збірку під назвою [YourAssembly] .XmlSerializers.dll, яка повинна містити створений клас для серіалізації вашого типу. Оскільки така DLL ще не створена (вони за замовчуванням не є), передається FileNotFoundException. Коли це трапляється, конструктор XmlSerializer ловить це виняток, і DLL створюється автоматично під час виконання конструктором XmlSerializer (це робиться шляхом генерування вихідних файлів C # у каталозі% temp% вашого комп'ютера, а потім їх компіляції за допомогою компілятора C #). Додаткові конструкції XmlSerializer для одного типу просто використовуватимуть вже створену DLL.

ОНОВЛЕННЯ: Починаючи з .NET 4.5, він XmlSerializerбільше не виконує генерацію коду, а також не здійснює компіляцію з компілятором C # для того, щоб створити збірку серіалізатора під час виконання, якщо явно не змушений це встановити налаштування файлу конфігурації ( useLegacySerializerGeneration ). Ця зміна усуває залежність від csc.exeта покращує продуктивність запуску. ^{Джерело: .NET Framework 4.5 Readme , розділ 1.3.8.1.}

Виняток обробляє конструктор XmlSerializer. Не потрібно нічого робити самостійно, ви можете просто натиснути «Продовжити» (F5), щоб продовжити виконання вашої програми, і все буде добре. Якщо вас турбують винятки, що зупиняють виконання вашої програми та вискакують помічник виключення, у вас або вимкнено "Просто мій код", або у вас встановлено FileNotFoundException, щоб порушити виконання при видаленні, а не коли "Користувач- необроблений '.

Щоб увімкнути "Просто мій код", перейдіть до Інструменти >> Опції >> Налагодження >> Загальне >> Увімкнути Просто мій код. Щоб вимкнути порушення виконання при передачі FileNotFound, перейдіть до Налагодження >> Винятки >> Знайти >>, введіть “FileNotFoundException” >>, зніміть прапорець “Thrown” від System.IO.FileNotFoundException.

У властивостях проекту Visual Studio (сторінка "Build", якщо я пам'ятаю це правильно) є опція, що говорить "генерувати серіалізаційну збірку". Спробуйте ввімкнути його для проекту, який генерує [Contain Assembly of MyType] .

Для цього існує рішення. Якщо ви використовуєте

XmlSerializer lizer = XmlSerializer.FromTypes(new[] { typeof(MyType) })[0];

слід уникати цього винятку. Це працювало для мене.

ПОПЕРЕДЖЕННЯ: Не використовуйте кілька разів, інакше у вас буде витік пам'яті

Ви просочите пам’ять, як божевільна, якщо ви використовуєте цей метод для створення екземплярів XmlSerializerодного типу не один раз!

Це пояснюється тим, що цей метод обходить вбудований кешування, передбачений XmlSerializer(type)і XmlSerializer(type, defaultNameSpace)конструкторами (всі інші конструктори також обходять кеш).

Якщо ви використовуєте будь-який метод для створення XmlSerializer, який не відбувається за допомогою цих двох конструкторів, ви повинні реалізувати власне кешування або ви пам’ятаєте крововиливи.

Я зіткнувся з цією проблемою і не зміг її обійти жодним із згаданих рішень.

Тоді я нарешті знайшов рішення. Виявляється, серіалізатору потрібен не лише тип, а й вкладені типи. Зміна цього:

XmlSerializer xmlSerializer = new XmlSerializer(typeof(T));

До цього:

XmlSerializer xmlSerializer = new XmlSerializer(typeof(T).GetNestedTypes());

Виправлена ​​проблема для мене. Більше немає винятків чи нічого.

Моє рішення - перейти до роздумів, щоб створити серіалізатор. Це обходить дивне завантаження файлів, що викликає виняток. Я упакував це в допоміжну функцію, яка також піклується про кешування серіалізатора.

private static readonly Dictionary<Type,XmlSerializer> _xmlSerializerCache = new Dictionary<Type, XmlSerializer>();

public static XmlSerializer CreateDefaultXmlSerializer(Type type) 
{
    XmlSerializer serializer;
    if (_xmlSerializerCache.TryGetValue(type, out serializer))
    {
        return serializer;
    }
    else
    {
        var importer = new XmlReflectionImporter();
        var mapping = importer.ImportTypeMapping(type, null, null);
        serializer = new XmlSerializer(mapping);
        return _xmlSerializerCache[type] = serializer;
    }
}

Щоб уникнути винятку, вам потрібно зробити дві речі:

1. Додайте атрибут до серіалізованого класу (сподіваюся, у вас є доступ)
2. Створіть файл серіалізації за допомогою sgen.exe

Додайте до свого класу атрибут System.Xml.Serialization.XmlSerializerAssembly. Замініть "MyAssembly" на назву збірки, де знаходиться MyClass.

[Serializable]
[XmlSerializerAssembly("MyAssembly.XmlSerializers")]
public class MyClass
{
…
}

Створіть файл серіалізації за допомогою утиліти sgen.exe і розгорніть його за допомогою складання класу.

'sgen.exe MyAssembly.dll' створить файл MyAssembly.XmlSerializers.dll

Ці дві зміни змусять .net безпосередньо знайти збірку. Я перевірив це, і він працює на .NET Framework 3.5 з Visual Studio 2008

Цей виняток може бути захоплений керованим помічником налагодження (MDA) під назвою BindingFailure.

Цей MDA корисний, якщо ваша програма призначена для постачання з попередньою збіркою серіалізаційних збірок. Ми робимо це для підвищення продуктивності нашого додатку. Це дозволяє нам переконатися, що заздалегідь складені збірки серіалізації будуються належним чином нашим процесом збирання та завантажуються додатком, не будуючи його знову на ходу.

Це справді не корисно, окрім цього сценарію, оскільки, як говорили інші афіші, коли конструктор серіалізатора вловлює помилку прив'язки, збірка серіалізації відновлюється під час виконання. Тож зазвичай можна вимкнути це.

Функція XmlSerializer.FromTypes не кидає винятку, але вона просочує пам'ять. Ось чому вам потрібно кешувати такий серіалізатор для кожного типу, щоб уникнути протікання пам'яті для кожного створеного екземпляра.

Створіть власну фабрику XmlSerializer і використовуйте її просто:

XmlSerializer serializer = XmlSerializerFactoryNoThrow.Create(typeof(MyType));

Фабрика виглядає так:

public static class XmlSerializerFactoryNoThrow
{
    public static Dictionary<Type, XmlSerializer> _cache = new Dictionary<Type, XmlSerializer>();

    private static object SyncRootCache = new object();        

    /// <summary>
    /// //the constructor XmlSerializer.FromTypes does not throw exception, but it is said that it causes memory leaks
    /// http://stackoverflow.com/questions/1127431/xmlserializer-giving-filenotfoundexception-at-constructor
    /// That is why I use dictionary to cache the serializers my self.
    /// </summary>
    public static XmlSerializer Create(Type type)
    {
        XmlSerializer serializer;

        lock (SyncRootCache)
        {
            if (_cache.TryGetValue(type, out serializer))
                return serializer;
        }

        lock (type) //multiple variable of type of one type is same instance
        {
            //constructor XmlSerializer.FromTypes does not throw the first chance exception           
            serializer = XmlSerializer.FromTypes(new[] { type })[0];
            //serializer = XmlSerializerFactoryNoThrow.Create(type);
        }

        lock (SyncRootCache)
        {
            _cache[type] = serializer;
        }
        return serializer;
    }       
}

Більш складна версія без можливості витоку пам'яті (будь-хто перегляне код):

    public static XmlSerializer Create(Type type)
    {
        XmlSerializer serializer;

        lock (SyncRootCache)
        {
            if (_cache.TryGetValue(type, out serializer))
                return serializer;
        }

        lock (type) //multiple variable of type of one type is same instance
        {
            lock (SyncRootCache)
            {
                if (_cache.TryGetValue(type, out serializer))
                    return serializer;
            }
            serializer = XmlSerializer.FromTypes(new[] { type })[0];
            lock (SyncRootCache)
            {
                _cache[type] = serializer;
            }
        }          
        return serializer;
    }       
}

Виправлення помилок компіляції, з іншого боку, дуже складне. Ці проблеми виявляються у FileNotFoundException з повідомленням:

File or assembly name abcdef.dll, or one of its dependencies, was not found. File name: "abcdef.dll"
   at System.Reflection.Assembly.nLoad( ... )
   at System.Reflection.Assembly.InternalLoad( ... )
   at System.Reflection.Assembly.Load(...)
   at System.CodeDom.Compiler.CompilerResults.get_CompiledAssembly() 

Вам може бути цікаво, що стосується файлу, не знайденого винятку, пов’язаного із створенням об'єкта серіалізатора, але пам’ятайте: конструктор записує файли C # та намагається їх компілювати. Стік викликів цього винятку надає хорошу інформацію на підтвердження цієї підозри. Виняток стався, коли XmlSerializer намагався завантажити збірку, згенеровану CodeDOM, викликаючи метод System.Reflection.Assembly.Load. Виняток не дає пояснення, чому збірки, яку повинен був створити XmlSerializer, не було. Загалом, збірки немає, тому що компіляція не вдалася, що може статися, оскільки за рідкісних обставин атрибути серіалізації виробляють код, який компілятор C # не може скомпілювати.

Примітка. Ця помилка також виникає, коли XmlSerializer працює під обліковим записом або середовищем безпеки, яке не в змозі отримати доступ до тимчасового каталогу.

Джерело : http://msdn.microsoft.com/en-us/library/aa302290.aspx

У властивостях проекту Visual Studio є опція, що говорить "створити збірку серіалізації". Спробуйте ввімкнути його для проекту, який генерує [Contain Assembly of MyType].

Спеціальний клас для серіалізації:

[Serializable]
public class TestClass
{
    int x = 2;
    int y = 4;
    public TestClass(){}
    public TestClass(int x, int y)
    {
        this.x = x;
        this.y = y;
    }

    public int TestFunction()
    {
        return x + y;
    }
}

Я додав фрагмент коду. Можливо, це може вам допомогти.

static void Main(string[] args)
{
    XmlSerializer xmlSerializer = new XmlSerializer(typeof(TestClass));

    MemoryStream memoryStream = new MemoryStream();
    XmlTextWriter xmlWriter = new XmlTextWriter(memoryStream, Encoding.UTF8);

    TestClass domain = new TestClass(10, 3);
    xmlSerializer.Serialize(xmlWriter, domain);
    memoryStream = (MemoryStream)xmlWriter.BaseStream;
    string xmlSerializedString = ConvertByteArray2Str(memoryStream.ToArray());

    TestClass xmlDomain = (TestClass)DeserializeObject(xmlSerializedString);

    Console.WriteLine(xmlDomain.TestFunction().ToString());
    Console.ReadLine();
}

У мене були подібні проблеми, і ігнорування винятку не працювало для мене. Мій код викликав конфігурацію NServiceBusConfigure.With(...).XmlSerializer()...

Для мене це вирішило - змінити платформу для мого проекту.

1. Перейдіть до програми Build \ Configuration Manager ...
2. Знайдіть свій проект та змініть платформу (в моєму випадку з x86 на будь-який процесор)

Так само як довідник. Беручи відповіді та коментарі БД, я прийшов із цим рішенням, близьким до рішення БД. Він працює чудово у всіх моїх випадках і безпечний для потоків. Я не думаю, що використання ConcurrentDictionary було б добре.

using System;
using System.Collections.Generic;
using System.Xml.Serialization;

namespace HQ.Util.General
{
    public class XmlSerializerHelper
    {
        private static readonly Dictionary<Type, XmlSerializer> _dictTypeToSerializer = new Dictionary<Type, XmlSerializer>();

        public static XmlSerializer GetSerializer(Type type)
        {
            lock (_dictTypeToSerializer)
            {
                XmlSerializer serializer;
                if (! _dictTypeToSerializer.TryGetValue(type, out serializer))
                {
                    var importer = new XmlReflectionImporter();
                    var mapping = importer.ImportTypeMapping(type, null, null);
                    serializer = new XmlSerializer(mapping);
                    return _dictTypeToSerializer[type] = serializer;
                }

                return serializer;
            }
        }
    }
}

Використання:

        if (File.Exists(Path))
        {
            using (XmlTextReader reader = new XmlTextReader(Path))
            {
                // XmlSerializer x  = new XmlSerializer(typeof(T));
                var x = XmlSerializerHelper.GetSerializer(typeof(T));

                try
                {
                    options = (OptionsBase<T>)x.Deserialize(reader);
                }
                catch (Exception ex)
                {
                    Log.Instance.AddEntry(LogType.LogException, "Unable to open Options file: " + Path, ex);
                }
            }
        }

Ваш тип може посилатися на інші збірки, які не можна знайти ні в GAC, ні у вашій локальній папці bin ==> ...

"або одна із її залежностей. Система не може знайти вказаний файл"

Чи можете ви навести приклад типу, який ви хочете серіалізувати?

Примітка. Переконайтеся, що ваш тип реалізує Serializable.

Я отримував таку ж помилку, і це було пов’язано з типом, який я намагався десеріалізувати, не маючи конструктора без параметрів за замовчуванням . Я додав конструктор, і він почав працювати.

У мене була така ж проблема, поки я не використовував інструмент сторонньої сторони для створення класу з XSD, і він працював! Я виявив, що інструмент додає додатковий код у верхній частині мого класу. Коли я додав цей самий код до початку мого оригінального класу, він працював. Ось що я додав ...

#pragma warning disable
namespace MyNamespace
{
  using System;
  using System.Diagnostics;
  using System.Xml.Serialization;
  using System.Collections;
  using System.Xml.Schema;
  using System.ComponentModel;
  using System.Xml;
  using System.Collections.Generic;

  [System.CodeDom.Compiler.GeneratedCodeAttribute("System.Xml", "4.6.1064.2")]
  [System.SerializableAttribute()]
  [System.Diagnostics.DebuggerStepThroughAttribute()]
  [System.ComponentModel.DesignerCategoryAttribute("code")]
  [System.Xml.Serialization.XmlTypeAttribute(AnonymousType = true)]
  [System.Xml.Serialization.XmlRootAttribute(Namespace = "", IsNullable = false)]
  public partial class MyClassName
  {
  ...

Було багато рекомендацій по використанню ConcurrentDictionary, але немає твердих прикладів цього, тому я збираюся закинути шапку в цю гонку рішення. Я не є безпечним для розробників потоків, тому якщо цей код не є надійним, просимо говорити заради тих, хто слідує за ним.

public static class XmlSerializerHelper
{
    private static readonly ConcurrentDictionary<Type, XmlSerializer> TypeSerializers = new ConcurrentDictionary<Type, XmlSerializer>();

    public static XmlSerializer GetSerializer(Type type)
    {
        return TypeSerializers.GetOrAdd(type,
        t =>
        {
            var importer = new XmlReflectionImporter();
            var mapping = importer.ImportTypeMapping(t, null, null);
            return new XmlSerializer(mapping);
        });
    }
}

Я бачив інші публікації, що стосуються ConcurrentDictionaryта Lazyзавантажують значення. Я не впевнений, це актуально тут чи ні, але ось код для цього:

private static readonly ConcurrentDictionary<Type, Lazy<XmlSerializer>> TypeSerializers = new ConcurrentDictionary<Type, Lazy<XmlSerializer>>();

public static XmlSerializer GetSerializer(Type type)
{
    return TypeSerializers.GetOrAdd(type,
    t =>
    {
        var importer = new XmlReflectionImporter();
        var mapping = importer.ImportTypeMapping(t, null, null);
        var lazyResult = new Lazy<XmlSerializer>(() => new XmlSerializer(mapping), LazyThreadSafetyMode.ExecutionAndPublication);
        return lazyResult;
    }).Value;
}