Có một cách thích hợp để tạo một định dạng tập tin?

Tôi đang xây dựng một định dạng tệp độc quyền cho một ứng dụng mà tôi đã viết bằng C # .NET để lưu trữ thông tin và có lẽ xuống tài sản dự án. Có một tiêu chuẩn về cách làm điều này theo bất kỳ cách nào? Tôi chỉ đơn giản là đi đến Serializecác đối tượng của mình thành nhị phân và tạo một tiêu đề sẽ cho tôi biết cách phân tích tệp. Đây có phải là một cách tiếp cận xấu?

Phương thức đơn giản nhất có lẽ là tuần tự hóa cấu trúc của bạn thành XML bằng cách sử dụng XMLSerializerlớp. Bạn có thể không cần phải tạo một cấu trúc cơ thể và tiêu đề riêng biệt - nhưng tuần tự hóa tất cả các tài sản thành XML. Điều này cho phép bạn dễ dàng kiểm tra / chỉnh sửa cấu trúc tệp của mình bên ngoài chương trình của riêng bạn và có thể dễ dàng quản lý.

Tuy nhiên, nếu cấu trúc tệp của bạn thực sự phức tạp, chứa nhiều tài sản thuộc các loại khác nhau, như vậy việc tuần tự hóa toàn bộ cấu trúc thành XML là quá nặng nề, bạn có thể xem xét tuần tự hóa từng tài sản riêng lẻ và biên dịch chúng thành một gói bằng Packagingthư viện trong C # . Đây thực chất là cách .docx, .xslx, .pptx và các định dạng tệp văn phòng khác được xây dựng.

Từ một người đã phải phân tích nhiều định dạng tệp, tôi có ý kiến ​​về điều này từ một quan điểm khác với hầu hết.

• Làm cho số ma thuật trở nên rất độc đáo để các trình phát hiện định dạng tệp của mọi người cho các định dạng khác không xác định nhầm nó là của bạn. Nếu bạn sử dụng nhị phân, hãy phân bổ 8 hoặc 16 byte được tạo ngẫu nhiên khi bắt đầu định dạng nhị phân cho số ma thuật. Nếu bạn sử dụng XML, hãy phân bổ một không gian tên thích hợp trong miền của bạn để nó không thể xung đột với người khác. Nếu bạn sử dụng JSON, chúa sẽ giúp bạn. Có lẽ bây giờ ai đó đã sắp xếp một giải pháp cho sự ghê tởm của một định dạng.

• Lập kế hoạch cho khả năng tương thích ngược. Lưu trữ số phiên bản của định dạng bằng cách nào đó để các phiên bản phần mềm sau này của bạn có thể xử lý các khác biệt.

• Nếu tệp có thể lớn hoặc có những phần mà mọi người có thể muốn bỏ qua vì một số lý do, hãy đảm bảo có một cách hay để làm điều này. XML, JSON và hầu hết các định dạng văn bản khác đặc biệt khủng khiếp vì điều này, vì chúng buộc người đọc phải phân tích tất cả dữ liệu giữa phần tử bắt đầu và kết thúc ngay cả khi họ không quan tâm đến nó. EBML có phần tốt hơn vì nó lưu trữ độ dài của các phần tử, cho phép bạn bỏ qua tất cả từ đầu đến cuối. Nếu bạn tạo một định dạng nhị phân tùy chỉnh, có một thiết kế khá phổ biến nơi bạn lưu trữ một định danh chunk và độ dài là điều đầu tiên trong tiêu đề, và sau đó người đọc có thể bỏ qua toàn bộ khối.

• Lưu trữ tất cả các chuỗi trong UTF-8.

• Nếu bạn quan tâm đến khả năng mở rộng dài hạn, hãy lưu trữ tất cả các số nguyên ở dạng có độ dài thay đổi.

• Tổng kiểm tra là tốt vì nó cho phép người đọc hủy bỏ ngay lập tức dữ liệu không hợp lệ, thay vì có khả năng bước vào các phần của tệp có thể tạo ra kết quả khó hiểu.

Vâng, có những lúc những gì bạn mô tả có thể là một cách tiếp cận rất xấu. Điều này là giả sử khi bạn nói 'tuần tự hóa' bạn đang nói về việc sử dụng khả năng của ngôn ngữ / khung để chỉ cần lấy một đối tượng và xuất trực tiếp đến một loại luồng nhị phân nào đó. Vấn đề là cấu trúc lớp thay đổi qua nhiều năm. Bạn có thể tải lại một tệp được tạo trong phiên bản trước của ứng dụng nếu tất cả các lớp của bạn thay đổi trong một phiên bản mới hơn không?

Để ổn định lâu dài định dạng tệp, tôi đã thấy tốt hơn nên xắn tay áo lên một chút bây giờ và đặc biệt viết các phương thức 'tuần tự hóa' / 'truyền phát' của riêng bạn trong các lớp học. tức là, tự xử lý việc ghi các giá trị vào luồng. Viết tiêu đề khi bạn nêu mô tả phiên bản định dạng và sau đó dữ liệu bạn muốn lưu theo thứ tự bạn muốn. Về mặt đọc, việc xử lý các phiên bản khác nhau của định dạng tệp trở nên dễ dàng hơn rất nhiều.

Tất nhiên, tùy chọn khác là XML hoặc JSON. Không nhất thiết là lớn nhất cho nội dung nặng nhị phân, nhưng đơn giản và dễ đọc của con người ... một điểm cộng lớn cho khả năng tồn tại lâu dài.

Tôi cũng rất thích nghe câu trả lời cho câu hỏi này từ những người có nhiều năm kinh nghiệm hơn bản thân tôi.

Cá nhân tôi đã triển khai một số định dạng tệp cho công việc của mình và tôi đã chuyển sang sử dụng định dạng tệp XML. Yêu cầu và phần cứng của tôi mà tôi tương tác luôn thay đổi và không có gì để nói tôi sẽ cần thêm gì vào định dạng trong tương lai. Một trong những ưu điểm chính của XML là nó có cấu trúc bán cấu trúc . Vì lý do này, tôi thường tránh Tuần tự hóa XML tự động mà .NET cung cấp vì tôi tin rằng nó buộc nó phải mong đợi một định dạng chính xác.

Mục tiêu của tôi là tạo ra một định dạng XML cho phép các yếu tố và thuộc tính mới được thêm vào trong tương lai và để thứ tự các thẻ không quan trọng bất cứ khi nào có thể. Nếu bạn chắc chắn rằng bạn có thể tải toàn bộ tệp của mình vào bộ nhớ thì XPATH có lẽ là một lựa chọn tốt.

Nếu bạn đang xử lý các tệp đặc biệt lớn hoặc vì các lý do khác không thể tải toàn bộ tệp cùng một lúc, thì có lẽ bạn còn sử dụng XmlStreamReader và quét các phần tử đã biết và đệ quy vào các phần tử đó bằng ReadSubtree và quét lại ...