[обсуждение] стили написания кода

Всем здрасьте.

Хочу обсудить кто как пишет чтение-сохранения файлов, дабы в процессе дискуссии выявить самые красивые и быстрые варианты.
Начну с того, как пишу я.
Для примера возмем файл Dynamicobjects.data (Чуть ли не самый простой файл).

Структура
Естественно-понятно, что прежде чем писать какой-то редактор или парсер файла - мы разбираем его структуру.
У динамика структура (для 010) такова:

PHP:

struct object
{
    int ID;
    int Length;
    char Path[Length];
};

int sign;
int Count;
object Object[Count]<optimize=false>;

Код
Далее я пишу класс, который будет содержать заголовочные переменные, и массивы каких-то блоков (их я объявляю структурой). А что бы код можно было легко и непринужденно переносить в другие проекты (и что бы в этом другом проекте не образовывалась свалка) - сразу переименовываю его в соответсвии с типом файла, с которым работаю
Пример класса:

PHP:

using System;
using System.Text;
using System.IO;

namespace DynObj
{
    class DynObj
    {
        protected static int Sign = 1347242308;
        protected static DynObj_CS.Templates.Object[] Objects;
    }
}

Тут же в проекте создал папку (Folder), и обозвал её DynObj_CS. Тут будут располагаться все классы для работы с этим файлом.
В ней создал папку Templates. Тут будут располагаться все структуры для этого файла.
В папке Templates создал класс, и назвал его Object - в него я запишу под структуру Object.
Содержимое этого класса:

PHP:

namespace DynObj.DynObj_CS.Templates
{
    struct Object
    {
        public int ID;
        public string Path;
    }
}

Чтение в память
Далее мы будем читать файл в память. Я делаю это так:
В класс для чтения передаю массив байтов, которые закидываю в MemoryStream, к которому подключаю BinaryReader. Получается очень даже симпатичный код.

PHP:

using System;
using System.Text;
using System.IO;

namespace DynObj.DynObj_CS
{
    class Load : DynObj
    {
        public static void Start(byte[] fileArr)
        {
            MemStream = new MemoryStream(fileArr);
            file = new BinaryReader(MemStream);

            int inSign = file.ReadInt32();
            if (inSign != Sign)
                throw new Exception("Неверный тип файла.");
      
            readObjects();

            file.Close();
            MemStream.Close();
        }

        static void readObjects()
        {
            int count = file.ReadInt32();
            Objects = new Templates.Object[count];

            for (int i = 0; i < count; i++)
            {
                Objects[i].ID = file.ReadInt32();
                Objects[i].Path = readString();
            }
        }


        static string readString()
        {
            int Length = file.ReadInt32();
            byte[] strArr = file.ReadBytes(Length);
            string result = Encoding.GetEncoding(936).GetString(strArr, 0, Length);
            //Кодировка (Encoding.GetEncoding(936)) захардкоженна а не передана в параметре, тк
            //в PW почти везде используется именно она
            //Но для гибкости можно передавать кодировку и в параметре

            return result;
        }

        static MemoryStream MemStream;
        static BinaryReader file;
    }
}

В основном классе подключаем чтение по имени файла и по массиву байт:

PHP:

using System;
using System.Text;
using System.IO;

namespace DynObj
{
    class DynObj
    {
        public static void Load(string fileName)
        {
            byte[] fileArr = File.ReadAllBytes(fileName);
            DynObj_CS.Load.Start(fileArr);
        }
        public static void Load(byte[] fileArr)
        {
            DynObj_CS.Load.Start(fileArr);
        }

        protected static int Sign = 1347242308;
        protected static DynObj_CS.Templates.Object[] Objects;
    }
}

Выгрузка из памяти
Теперь напишем класс для сохранения всей той информации, что у нас есть.

PHP:

using System;
using System.Text;
using System.IO;

namespace DynObj.DynObj_CS
{
    class Save : DynObj
    {
        public static byte[] Start()
        {
            MemStream = new MemoryStream(GetFileSize());
            file = new BinaryWriter(MemStream);


            file.Write(Sign);
            writeObjects();


            byte[] result = MemStream.ToArray();
            file.Close();
            MemStream.Close();

            return result;
        }

        static void writeObjects()
        {
            file.Write(Objects.Length);

            for (int i = 0; i < Objects.Length; i++)
            {
                file.Write(Objects[i].ID);
                writeString(Objects[i].Path);
            }
        }



        static int GetFileSize()
        {
            //Что бы у нас не было много циклов копирования памяти что бы
            //просто расширить её - мы сразу подсчитаем размер, который нам понадобится
            //Можно, конечно, задать какой-то фиксированный большой размер
            //НО для красивого и правильного примера мы так делать не будем
            int Size = 8;//Header

            for (int i = 0; i < Objects.Length; i++)
            {
                Size += 8;//ID и длинна строки

                byte[] tmpArr = Encoding.GetEncoding(936).GetBytes(Objects[i].Path);
                Size += tmpArr.Length;
            }

            return Size;
        }

        static void writeString(string Value)
        {
            byte[] strArr = Encoding.GetEncoding(936).GetBytes(Value);
            file.Write(strArr.Length);
            file.Write(strArr);
        }


        static MemoryStream MemStream;
        static BinaryWriter file;
    }
}

И подключим в основном классе сохранение:

PHP:

using System;
using System.Text;
using System.IO;

namespace DynObj
{
    class DynObj
    {
        public static void Load(string fileName)
        {
            byte[] fileArr = File.ReadAllBytes(fileName);
            DynObj_CS.Load.Start(fileArr);
        }
        public static void Load(byte[] fileArr)
        {
            DynObj_CS.Load.Start(fileArr);
        }

        public static void Save(string fileName)
        {
            byte[] fileArr = DynObj_CS.Save.Start();

            //Создаем папку для файла - что бы при сохранении не ругался
            Directory.CreateDirectory(Path.GetDirectoryName(fileName));
            File.WriteAllBytes(fileName, fileArr);
        }
        public static byte[] Save()
        {
            byte[] fileArr = DynObj_CS.Save.Start();
            return fileArr;
        }

        protected static int Sign = 1347242308;
        protected static DynObj_CS.Templates.Object[] Objects;
    }
}

Итог
Вот и всё Теперь мы можем загружать и сохранять этот файл. А в промежутке между этими действиями делать с ним всё что угодно

P.S. Архив с этим проектом.
http://files.mail.ru/E0C7DA0DA3AC4C689DB7025389CFB35E

Теперь ждем топика с примером

Ужасный, неживучий, стиль программирования.
Объяснил в личку почему.

Попросили разжевать. Ок, погнали.
0. аааа, название структуры Object! убейте меня!
1. Использование структур. Структуры изначально появились в c# для того, чтобы взаимодействовать с winapi и всяким com-подобным хламом. Тому есть миллион причин, цитировать книжки я не буду. Используйте классы.
2. Повсюду static (иногда еще и protected static, sic! ). Безумие. Как потом поддерживать этот код? Static-классы в c# для меня это в первую очередь лучшая альтернатива Singleton'у — главному антипаттерну тысячелетия.
3. pdev верно заметил про using. Еще отмечу, что использовать любые потоки как поле в классе должно автоматически вынуждать реализовывать интерфейс IDisposable. Именно поэтому я, например, использую using, чтобы не громоздить говно в куче — его и без нас там хватает. Идеально (для загрузки/сохранения) передавать инстанс Stream/BinaryReader и потом читать. А после прочтения этот инстанс с помощью using уйдет в небытие — лепота.
Заметьте, что никто не мешает сохранить путь к файлу, заблокировать его для чтения-записи для других или отслеживать внешние изменения в нем.
4. Конечно же, двойное чтение. При том, ладно бы чтение одной конкретной записи (еще не страшно, удалится на очередной итерации GC), так нет, чтение ЦЕЛИКОВОГО файла в byte[], а потом разбор этого byte[]. Адский ужс. Я поясню: такой подход даже теоретически увеличивает объем потребляемой памяти в два размера загружаемого файла. Загрузили файл размером N*M в byte[], а потом создали массив struct Object размера N. А что если файл будет хотя бы 100мб? Будет потребление > 200 мб. А если бы была поддержка множественного открытия файлов (ее нет из-за static)?
Я всегда говорю, что память не ресурс, т.к. сейчас у всех уже минимум 8 гб, но зачем городить адский ад, когда можно сделать лучше.
5. Массивы. Это отлично для каких-то вещей, но для нашего конкретного случая — не годится никуда. Хотя бы List. Это достаточно быстрая коллекция.

Прикрепляю код, который на мой взгляд более удобен в плане поддержки и разработки. Так же он позволит быстро писать ViewModels для байндинга в WPF.
Ключевые моменты:
1) Простая загрузка и сохранение:

代码:

            DynResourceCollection model = null;
            using (var stream = File.Open("dynamicobjects.data", FileMode.Open))
            using (var reader = new BinaryReader(stream))
            {
                model = reader.ReadModel<DynResourceCollection>();
            }
            using (var stream = File.Open("dynamicobjects-written.data", FileMode.Create))
            using (var writer = new BinaryWriter(stream))
            {
                writer.WriteModel(model);
            }

2. Легкореализуемое подключение IoC — кому надо поймет.
3. Легкореализуемое проксирование к модели из ViewModel.
4. Полностью отдельный механизм чтения/записи данных, в котором можно реализовать поддержку версий файла или свои форматы данных:

代码:

    internal class DynResourceCollection : List<DynResource>, IBinaryModel
    {
        private const uint Magic = 'D' | 'I' << 8 | 'M' << 16 | 'P' << 24; // DIMP

        #region IBinaryModel Implementation

        void IBinaryModel.ReadInternal(BinaryReader reader, int version)
        {
            var inSign = reader.ReadUInt32();
            if (inSign != Magic)
                throw new Exception("Unhandled type.");

            int count = reader.ReadInt32();
            for (int i = 0; i < count; i++)
            {
                var model = reader.ReadModel<DynResource>();
                Add(model);
            }
        }

        void IBinaryModel.WriteInternal(BinaryWriter writer, int version)
        {
            writer.Write(Magic);
            writer.Write(Count);
            for (int i = 0; i < Count; i++)
            {
                writer.WriteModel(this[i]);
            }
        }

        #endregion // IBinaryModel Implementation
    }

代码:

    internal class DynResource : IBinaryModel
    {
        private string _path;
        public uint Id { get; set; }
        public string Path
        {
            get { return _path; }
            set { _path = string.IsNullOrWhiteSpace(value) ? string.Empty : value; }
        }

...
        #region IBinaryModel Implementation

        void IBinaryModel.ReadInternal(BinaryReader reader, int version)
        {
            Id = reader.ReadUInt32();
            var length = reader.ReadInt32();
            Path = reader.ReadString(Encoding.GetEncoding("GBK"), length);
        }

        void IBinaryModel.WriteInternal(BinaryWriter writer, int version)
        {
            writer.Write(Id);
            var length = Encoding.GetEncoding("GBK").GetByteCount(Path);
            writer.Write(length);
            writer.Write(Path, Encoding.GetEncoding("GBK"), length);
        }

        #endregion // IBinaryModel Implementation
    }

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

Ну, наследник-то может быть один, либо List либо Reader-Writer, а городить своих клонов с мультифункционалом — нелогично же.