Bir dosya biçimi oluşturmanın uygun bir yolu var mı?

Ben bilgi kaydetmek ve belki de satır proje varlıkları saklamak için C # .NET yazdım bir uygulama için özel bir dosya biçimi inşa ediyorum. Bunun nasıl yapılacağına dair bir standart var mı? Ben sadece Serializeikili dosyalara gidiyordu ve bana dosyayı nasıl ayrıştırılacağını söyleyecek bir başlık oluşturmak. Bu kötü bir yaklaşım mı?

En basit yöntem muhtemelen XMLSerializersınıfınızı kullanarak yapınızı XML olarak serileştirmektir . Muhtemelen ayrı bir başlık ve gövde yapısı oluşturmanız gerekmez, ancak tüm varlıkları XML olarak serileştirin. Bu, dosya yapınızı kendi programınızın dışında kolayca incelemenize / düzenlemenize olanak tanır ve kolayca yönetilebilir.

Ancak, dosya yapınız gerçekten karmaşıksa, tüm yapıyı XML'ye serileştirmek çok külfetli olacak şekilde farklı türlerde birçok farklı varlık içerirse, her bir varlığı ayrı ayrı serileştirmeye ve bunları PackagingC # 'daki kütüphaneyi kullanarak tek bir pakette derlemeye bakabilirsiniz. . Aslında .docx, .xslx, .pptx ve diğer ofis dosya biçimleri bu şekilde oluşturulur.

Birçok dosya biçimini ayrıştırmak zorunda olan birinden, bu konuda farklı bir bakış açısıyla en çok görüşe sahibim.

• İnsanların diğer formatlar için dosya formatı dedektörlerini sizinki gibi tanımlamaması için sihirli numarayı çok benzersiz hale getirin. İkili kullanıyorsanız, sihirli sayı için ikili biçimin başlangıcında rastgele oluşturulmuş 8 veya 16 bayt ayırın. XML kullanıyorsanız, alan adınızda başkalarıyla çakışmaması için uygun bir ad alanı ayırın. JSON kullanıyorsanız, tanrı size yardımcı olur. Belki birileri şu ana kadar bir formatın iğrençliği için bir çözüm bulmuştur.

• Geriye dönük uyumluluk planlayın. Biçimin sürüm numarasını bir şekilde saklayın, böylece yazılımınızın sonraki sürümleri farklılıklar ile başa çıkabilir.

• Dosya büyük olabilir veya bir nedenden dolayı insanların atlamak isteyebilecekleri bölümler varsa, bunu yapmanın güzel bir yolu olduğundan emin olun. XML, JSON ve diğer birçok metin formatı bunun için özellikle korkunçtur, çünkü okuyucuyu umursamasalar bile başlangıç ​​ve bitiş öğesi arasındaki tüm verileri ayrıştırmaya zorlarlar. EBML biraz daha iyidir çünkü öğelerin uzunluğunu saklar, sonuna kadar atlamanızı sağlar. Özel bir ikili biçim oluşturursanız, başlıktaki ilk şey olarak bir yığın tanımlayıcı ve bir uzunluk depoladığınız ve okuyucunun tüm parçayı atlayabileceği oldukça yaygın bir tasarım vardır.

• Tüm dizeleri UTF-8'de saklayın.

• Uzun süreli genişletilebilirlikle ilgileniyorsanız, tüm tam sayıları değişken uzunlukta bir formda saklayın.

• Sağlama toplamları iyidir, çünkü okuyucunun dosyanın kafa karıştırıcı sonuçlar doğurabilecek bölümlerine adım atmak yerine geçersiz verileri hemen iptal etmesine izin verir.

Açıkladığınız şeylerin çok kötü bir yaklaşım olabileceği zamanlar var. Bu, bir dilin / çerçevenin bir nesneyi alıp doğrudan bir tür ikili akışa çıktı verme yeteneğini kullanarak bahsettiğinizi 'serileştir' dediğinizi varsayar. Sorun sınıf yapılarının yıllar içinde değişmesidir. Tüm sınıflarınız daha yeni bir sınıfta değişirse, uygulamanızın önceki bir sürümünde yapılmış bir dosyayı yeniden yükleyebilecek misiniz?

Bir dosya biçiminin uzun vadeli istikrarı için, şimdi kollarınızı biraz yuvarlamayı ve özellikle sınıflarınıza kendi 'serileştirme' / 'akış' yöntemlerinizi yazmayı daha iyi buldum. yani, değerlerin bir akışa elle yazılmasını yönetin. Biçim sürümünü açıklayan bir başlık yazın ve ardından istediğiniz sırada olmasını istediğiniz verileri kaydedin. Okuma tarafında, dosya biçiminin farklı sürümlerini işlemek çok daha kolay hale gelir.

Diğer seçenek elbette XML veya JSON. İkili ağır içerik için mutlaka en büyük değil, basit ve insan tarafından okunabilir ... uzun süreli uygulanabilirlik için büyük bir artı.

Ben de istiyorum seviyorum kendimden daha yıldan fazla deneyime sahip kişilerden bu soruya cevap duymak.

Çalışmam için kişisel olarak birkaç dosya formatı uyguladım ve bir XML dosya formatı kullanmaya geçtim. Etkileşimlerim ve etkileşimde bulunduğum donanım sürekli değişiyor ve gelecekte formata ne eklemem gerektiğini söyleyemiyorum. XML'in birincil avantajlarından biri, yarı yapılandırılmış olmasıdır . Bu nedenle, genellikle .NET'in sağladığı otomatik XML Serileştirmesinden kaçınırım çünkü tam bir biçim beklemeye zorladığına inanıyorum.

Amacım, gelecekte yeni öğeler ve niteliklerin eklenmesine ve etiketlerin sırasının mümkün olduğunca önemli olmamasına izin veren bir XML biçimi oluşturmaktı. Dosyanızın tamamını belleğe yükleyebileceğinizden eminseniz, XPATH muhtemelen iyi bir seçimdir.

Özellikle büyük dosyalarla uğraşıyorsanız veya başka nedenlerle dosyayı bir kerede yükleyemiyorsanız, muhtemelen bir XmlStreamReader kullanmanız ve bilinen öğeleri taramanız ve ReadSubtree ile tekrar tekrar taramanız ve tekrar taramanız ...