Binaryformatter migration guide #41564
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- remove the migration samples as we won't provide them (at least now) - remove WPF and WinForms part as it will be provided in Preview 7 - clarify the public type requirement for Messagepack - describe ArrayRecord and SZArrayRecord<T> - describe the OOB package
…but build produces warnings)
adamsitnik
requested review from
blowdart,
GrabYourPitchforks,
JeremyKuhne and
bartonjs
bartonjs
reviewed
Jun 27, 2024
docs/standard/serialization/binaryformatter-migration-guide/overview.md
Outdated
Show resolved
Hide resolved
|
|
||
| Moreover, WinForms and WPF may require some additional changes starting from .NET 9 Preview 7. | ||
|
|
||
| ## Summary |
There was a problem hiding this comment.
None of the bullets here seem strongly related to the rest of the content on this page, so they're not really a Summary.
Are they left over from there being different content here that moved elsewhere?
(Maybe the idea is that they are summarizing the rest of the content across all other pages, but it doesn't quite feel like that)
There was a problem hiding this comment.
Maybe the idea is that they are summarizing the rest of the content across all other pages, but it doesn't quite feel like that
That was my intention.
docs/standard/serialization/binaryformatter-migration-guide/overview.md
Outdated
Show resolved
Hide resolved
docs/standard/serialization/binaryformatter-migration-guide/overview.md
Outdated
Show resolved
Hide resolved
| * [DataContractSerializer](../../../fundamentals/runtime-libraries/system-runtime-serialization-datacontractserializer.md) is an XML serializer that **fully supports the serialization programming model that was used by the `BinaryFormatter`**. It requires the known types to be specified up-front (but most .NET collections and primitive types are on a default allow-list and don't need to be specified). **It's the serializer that requires the least amount of effort to migrate to**. | ||
| * [System.Text.Json](./../system-text-json/overview.md) is strict by default and avoids any guessing or interpretation on the caller's behalf, emphasizing deterministic behavior. The library is intentionally designed this way for performance and security. In contrary to `BinaryFormatter`, by default it serializes **only public properties**. To deserialize a `readonly` field or property, `[JsonConstructor]` attribute needs be used to indicate that given constructor should be used to set these. It supports serialization and deserialization of most built-in collections, but it does not support dictionaries where keys are not primitive types. It supports polymorphic type hierarchy serialization and deserialization, but it needs to be explicitly enabled. The same goes for preserving the references and handling circular references. The default behavior can be changed by writing custom converters. | ||
| * [MessagePack](https://github.com/MessagePack-CSharp/MessagePack-CSharp) provides a **highly efficient binary serialization format**, resulting in smaller message sizes compared to JSON and XML. It's **very performant** and ships with built-in support for LZ4 compression. It works best when all serializable public types and members are annotated with dedicated attributes. It does not serialize non-public types and members by default, but it can be customized. It supports readonly types and members, by trying to select the best matching constructor. The constructor can be selected in an explicit way by using the `[SerializationConstructor]` attribute. | ||
| * `NrbfDecoder` should be used for reading any `BinaryFormatter` payload that was either persisted before the migration or comes from an actor that can not be migrated (example: client app owned by a 3rd party). This new type can read any NRBF (.NET Remoting Binary Format) payload, but it's mandatory to know the list of types that could have been serialized. Otherwise, it's impossible to create and hydrate the serialized objects. |
There was a problem hiding this comment.
I don't understand the mandatory type list and hydration comments... I didn't think NrbfDecoder had hydration of anything other than NRBF primitive values and arrays thereof?
docs/standard/serialization/binaryformatter-migration-guide/reading-nrbf-payloads.md
Outdated
Show resolved
Hide resolved
docs/standard/serialization/binaryformatter-migration-guide/reading-nrbf-payloads.md
Outdated
Show resolved
Hide resolved
docs/standard/serialization/binaryformatter-migration-guide/reading-nrbf-payloads.md
Outdated
Show resolved
Hide resolved
docs/standard/serialization/binaryformatter-migration-guide/reading-nrbf-payloads.md
Outdated
Show resolved
Hide resolved
docs/standard/serialization/binaryformatter-migration-guide/reading-nrbf-payloads.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Jeremy Barton <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
BinaryFormatter is getting removed in Preview 6, we need to provide the docs along with its public release.
I am able to address any feedback this week, after that I won't be available for some time (vacations).
Internal previews