Light

srushti / xstream.net Goto Github PK

View Code? Open in Web Editor NEW

12.0 4.0 9.0 354 KB

A .net port of the Java original

Home Page: xstream.net

License: Other

C# 97.06% Ruby 2.94%

xstream.net's Introduction

XStream.Net 0.9.0¶ ↑

XStream.Net is largely a port of Joe Walnes original XStream project written for Java. The current version is a result of multiple iterations on a real world project and is currently in production use.

Example¶ ↑

new XStream().ToXml(obj);

new XStream().FromXml(xml);

There is also support for custom converters.

Licence¶ ↑

XStream.Net is released under the Apache 2.0 licence

xstream.net's People

Contributors

Stargazers

Watchers

Forkers

irfn c42 kaiwren strager joewalnes chrdela rollandx agintegrated

xstream.net's Issues

Objects having Dictionary as Field (or Property) can not be deserialized

When an object with a Dictionary Field (or Property) are serialized, the Type information is not written in the stream. As a consequence, the deserialization fails with a Null pointer exception:

System.NullReferenceException: La référence d'objet n'est pas définie à une instance d'un objet.
à xstream.DynamicInstanceBuilder.CreateInstance(Type type)
à xstream.Converters.Collections.DictionaryConverter.EmptyDictionary(XStreamReader reader)
à xstream.Converters.Collections.BaseDictionaryConverter`1.FromXml(XStreamReader reader, UnmarshallingContext context)
à xstream.Unmarshaller.ConvertField(Type fieldType)
à xstream.Unmarshaller.UnmarshalAs(Object result, Type type)
à xstream.Unmarshaller.Unmarshal(Type type)
à xstream.UnmarshallingContext.ConvertOriginal()
à xstream.XStream.FromXml(String s)

The XML looks like (here the property name is Hashtable):

  ....
  <Hashtable>
    <entry>
      <key class="System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">3</key>
      <value class="System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">three</value>
    </entry>
    <entry>
      <key class="System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">2</key>
      <value class="System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">two</value>
    </entry>
    <entry>
      <key class="System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">1</key>
      <value class="System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">one</value>
    </entry>
  </Hashtable>
 ...

Class:
public class ExampleWithCollections
{
public List<String> List;
public Dictionary<int, string> Dictionary;
public Hashtable Hashtable;
public ExampleWithCollections()
{
List = new List<string>();
Dictionary = new Dictionary<int, string>();
Hashtable = new Hashtable();
}
}

Please note that the problem does not occur if an instance of Dictionary is serialized directly as the "root" object, as the type (class) information is written to the stream:

<DictionaryOfInt32AndString class="System.Collections.Generic.Dictionary`2[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
  <entry>
    <key class="System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">1</key>
    <value class="System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">one</value>
  </entry>
  <entry>
    <key class="System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">2</key>
    <value class="System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">two</value>
  </entry>
  <entry>
    <key class="System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">3</key>
    <value class="System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">three</value>
  </entry>
</DictionaryOfInt32AndString>

Testclass to reproduce the problem:
ProblemWithDictionaryTest.cs

Output of the test class before and after fix
test_result_after.txt
test_result_before.txt

Fix proposal:

add attribute dict-type with type information when serialized
read attribute dict-type when deserializing in order to instantiate the appropriate type
the serialized Dictionary now looks like:

<ExampleWithCollections class=
 ....
  <Dictionary dict-type="System.Collections.Generic.Dictionary`2[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]">
    <entry>
....

Fixed files are attached:
BaseDictionaryConverter.cs
DictionaryConverter.cs
HashtableConverter.cs
Please not that the type information is redundantly serialized in case an instance of a Dictionary is serialized as the "root" object:

<DictionaryOfInt32AndString class="System.Collections.Generic.Dictionary`2[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" dict-type="System.Collections.Generic.Dictionary`2[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]">
  <entry>

Unittests are green after the fix.

Application crashing when serializing a List of Class-Objects

I have created a List with some Class-Objects for Data-Storage (e.g. KeyBinds). When I try to serialize this List to xml, the application crashes without any error message.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.