Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wojtpl2/ExtendedXmlSerializer

A configurable and eXtensible Xml serializer for .NET.
https://github.com/wojtpl2/ExtendedXmlSerializer

custom-serializer customization dotnet extensibility extensions hacktoberfest poco serialization serializer xml

Last synced: about 2 months ago
JSON representation

A configurable and eXtensible Xml serializer for .NET.

Host: GitHub
URL: https://github.com/wojtpl2/ExtendedXmlSerializer
Owner: ExtendedXmlSerializer
License: mit
Created: 2016-08-04T11:18:59.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2024-03-23T11:39:33.000Z (6 months ago)
Last Synced: 2024-05-22T08:12:08.937Z (4 months ago)
Topics: custom-serializer, customization, dotnet, extensibility, extensions, hacktoberfest, poco, serialization, serializer, xml
Language: C#
Homepage: https://extendedxmlserializer.github.io/
Size: 8.76 MB
Stars: 328
Watchers: 14
Forks: 46
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        ExtendedXmlSerializer

=====================

[![Build status](https://ci.appveyor.com/api/projects/status/ub776yxp0nj535qp?svg=true)](https://ci.appveyor.com/project/ExtendedXmlSerializer/extendedxmlserializer) [![Nuget](https://img.shields.io/nuget/v/ExtendedXmlSerializer.svg)](https://www.nuget.org/packages/ExtendedXmlSerializer/)



Welcome!

========

Welcome to ExtendedXMLSerializer's GitHub repository.  Here you will find a .NET serializer that:

- Specializes in [POCO](https://en.wikipedia.org/wiki/Plain_old_CLR_object)-based object graph serialization

- Features a powerful extension model

- Operates in the tried-and-trusted dependable XML format. 💖

"But why?"

==========

The classic `System.Xml.XmlSerializer` poses some challenges:

- Does not support properties that are defined with interface types

- Does not support read-only collection properties (like Xaml does)

- Does not support parameterized constructors (immutable objects)

- Does not support private constructors

- Does not support serialization of class with circular reference or class with interface property

- If you want create custom serializer, your class must inherit from `IXmlSerializable` or `ISerializable`.  This takes the "plain" out of [POCO](https://en.wikipedia.org/wiki/Plain_old_CLR_object). 😁

- No migration mechanism for XML based on older code model

ExtendedXmlSerializer addresses a lot of these problems and much much more!

- Serializes and deserializes pretty much any POCO you throw at it*: `class`, `struct`, generics, primitives, generic `List` and `Dictionary`, `Array`, `Enum` and much much more! If you find a class that doesn't get serialized, [let us know](https://github.com/ExtendedXmlSerializer/home/issues/new) and we'll take a look at it.

- Custom serializer registration by type or member

- Serialization of references, handling circular references without endlessly looping

- All configurations (migrations, custom serializer...) are outside the class and not coupled to attributes or messy, arcane conventions

- Migrate old XML based on an older schema to a current schema

- Property encryption

- Support `XmlElementAttribute`, `XmlRootAttribute`, and `XmlTypeAttribute` for identity resolution

- Additional attribute support: `XmlIgnoreAttribute`, `XmlAttributeAttribute`, and `XmlEnumAttribute`

- Deserialization xml from classic `XmlSerializer` (mostly, [details in FAQ](https://github.com/ExtendedXmlSerializer/home/wiki/FAQs#systemxmlserializer-vs-extendedxmlserializer))

(\*Yes, this even -- and *especially* -- means classes with properties that have an interface property type!)

Supported platforms:

- .NET Standard 2.0

- .NET 4.5.2 ([as of #273](https://github.com/ExtendedXmlSerializer/home/issues/273))

Usage

=====

ExtendedXmlSerializer uses a `ConfigurationContainer` to store configurations and extensions.  Once this container is configured as desired, call its `Create` method to create a serializer and serialize!

Example class:

``` csharp

class Subject {

    public int Number { get; set; }

    public string Message { get; set; }

}

```

Configure, create, and serialize:

``` csharp

IExtendedXmlSerializer serializer = new ConfigurationContainer().UseAutoFormatting()

                                                                .UseOptimizedNamespaces()

                                                                .EnableImplicitTyping(typeof(Subject))

                                                                // Additional configurations...

                                                                .Create();

var instance = new Subject {Message = "Hello World!", Number = 42};

var document = serializer.Serialize(new XmlWriterSettings {Indent = true},

                                    instance);

```

MAKE THE PRETTY XML!!! 😁😁😁

(contents of the `document` variable above:)

``` xml

```

The above demonstrated code can be found in the form of [a passing test within our test suite here](https://github.com/ExtendedXmlSerializer/home/blob/a7667b3f56ce15e3146f0ca061e7dae162b1a448/test/ExtendedXmlSerializer.Tests.ReportedIssues/Issue282Tests_README.cs#L11-L33).

Installation

============

From your favorite [Package Manager Console](https://docs.microsoft.com/en-us/nuget/consume-packages/install-use-packages-powershell):

```

Install-Package ExtendedXmlSerializer

```

Or if you are brave and want to try out our preview feed:

```

Install-Package ExtendedXmlSerializer -Source https://ci.appveyor.com/nuget/extendedxmlserializer-preview

```

Known Issues

============

While ExtendedXmlSerializer is [very nice](https://tenor.com/view/nice-very-nice-gif-4295060), it does have some known issues that have been identified by its owners.  These issues are considered too significant to address and have been consolidated under a dedicated label for your review here:

https://github.com/ExtendedXmlSerializer/home/labels/known%20issue

Please review these issues before submitting a new issue and/or trialing ExtendedXmlSerializer.

Additionally, please note that [ExtendedXmlSerializer is now essentially in maintenance mode as of March 2020](https://github.com/ExtendedXmlSerializer/home/issues/383).  We will continue to monitor for any major bugs, so [feel free to post an issue](https://github.com/ExtendedXmlSerializer/home/issues/new) if you find one.  However, major tasks and/or feature requests and the like will be deferred to the community.

Featured Documentation

======================

- [FAQs](https://github.com/ExtendedXmlSerializer/home/wiki/FAQs) - Probably the first place to go if you have a question.

- [Conceptual Topics](https://github.com/ExtendedXmlSerializer/home/wiki) - From our wiki.

  - [The Basics](https://github.com/ExtendedXmlSerializer/home/wiki/The-Basics)

  - [Features](https://github.com/ExtendedXmlSerializer/home/wiki/Features#experimental)

  - [API Overview](https://github.com/ExtendedXmlSerializer/home/wiki/API-Overview)

  - [Example Scenarios](https://github.com/ExtendedXmlSerializer/home/wiki/Example-Scenarios)

- [Documentation Site](https://extendedxmlserializer.github.io/documentation/) - A resource deployed on every release.

  - [API Reference](https://extendedxmlserializer.github.io/documentation/reference/)

  - [Concepts and Topics](https://extendedxmlserializer.github.io/documentation/conceptual/) (Mirror of our wiki above)

(Looking to upgrade from 1.x?  We got you [covered here](https://github.com/ExtendedXmlSerializer/home/wiki/How-to-Upgrade-from-v1.x-to-v2).)

Want to Contribute?

===================

We are a smaller project and are open to any contributions or questions.  We do not have a formal code of conduct and would like to keep it that way.

![Keep Calm and Code](https://i.imgur.com/6wP6Zqy.png)

If you view our [FAQs](https://github.com/ExtendedXmlSerializer/home/wiki/FAQs) and still have a question, [open up a new issue](https://github.com/ExtendedXmlSerializer/home/issues/new)!  We'll do our best to [meet you there with sample code](https://github.com/ExtendedXmlSerializer/home/issues?q=is%3Aissue+label%3ADocumentation+sort%3Aupdated-desc) to help get you on your way.

Notable Contributors

========================

- [Wojciech Nagórski](https://github.com/WojciechNagorski) - v1.x Author.

- [Mike-E-angelo](https://github.com/Mike-E-angelo) - v2.x+ Author.

Mentions

========

[](https://www.jetbrains.com/resharper/download/)

ExtendedXmlSerializer is proudly developed and maintained with ReSharper Ultimate.