GithubHelp home page GithubHelp logo

elytrium / java-serializer Goto Github PK

View Code? Open in Web Editor NEW
22.0 22.0 4.0 279 KB

Java Library to (de-)serialize data in various formats (e.g. JSON, YAML)

License: GNU Lesser General Public License v3.0

Java 100.00%

java-serializer's People

Contributors

galster-dev avatar hevav avatar mdxd44 avatar skywatcher2019 avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar

Forkers

galster-dev rusal84 shieldcommunity

java-serializer's Issues

Cannot serialize/deserialize custom types into a collection

I use the following configuration:

public class TestSettings extends YamlSerializable {

    @Transient
    private static final SerializerConfig CONFIG = new SerializerConfig.Builder()
            .setCommentValueIndent(1)
            .registerSerializer(new TestSerializer())
            .build();
    @Transient
    public static final TestSettings IMP = new TestSettings();

    public TestSettings() {
        super(CONFIG);
    }

    public TEST_SECTION TEST_SECTION = new TEST_SECTION();

    public static class TEST_SECTION {

        public TestData DATA = new TestData(Collections.singletonList("test"));

    }

}

Custom type for serialization:

@NoArgsConstructor
@AllArgsConstructor
@Data
public class TestData {

    private List<String> originalList = new ArrayList<>();

}

Custom serialization class. From TestData to List with String type.

public class TestSerializer extends ClassSerializer<TestData, List<String>> {

    @Override
    public List<String> serialize(TestData from) {
        return from.getOriginalList();
    }

    @Override
    public TestData deserialize(List<String> from) {
        return new TestData(from);
    }

}

Exception when attempting to load a configuration:

[16:28:11] [Thread-1/ERROR]: Exception in thread "Thread-1" java.lang.IllegalArgumentException: Invalid type was provided: E
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readByType(AbstractReader.java:250)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readByType(AbstractReader.java:195)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.YamlReader.readByType0(YamlReader.java:581)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.YamlReader.readCollectionFromMarker(YamlReader.java:557)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.YamlReader.readCollection(YamlReader.java:261)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readList(AbstractReader.java:379)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readCollectionByType(AbstractReader.java:315)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readByType(AbstractReader.java:215)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readAndDeserializeByType(AbstractReader.java:174)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readNode(AbstractReader.java:135)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.YamlReader.readSerializableObject(YamlReader.java:136)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readByType(AbstractReader.java:237)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readAndDeserializeByType(AbstractReader.java:174)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readNode(AbstractReader.java:135)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.YamlReader.readSerializableObject(YamlReader.java:136)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readSerializableObject(AbstractReader.java:76)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.object.AbstractSerializable.load(AbstractSerializable.java:93)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.object.AbstractSerializable.load(AbstractSerializable.java:82)
[16:28:11] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.object.AbstractSerializable.reload(AbstractSerializable.java:64)

Is this a serializer bug or is this behavior simply not supported at this time?

"commentValueIndent" should be 1 instead of 0 by default

java-serializer/src/main/java/net/elytrium/serializer/annotations/Comment.java

Lines 47 to 55 in 61d9ece

/**
* The comment will be placed before the field.
*
* <pre> {@code
* # Line1
* # Line2
* regular-field: "regular value"
* } </pre>
*/

The documentation shows an example of what a comment looks like when using the comment format.
However, this example only contains indentation, which is disabled by default, which is confusing.
Besides this default behavior is different from the old configuration framework, where the default was always only 1 indentation.

Using square brackets for a list of strings causes an infinite loop

It looks like the yml reader goes into a deep loop if square brackets are found for a list of strings.
This configuration cause error:

stringList: ["test1", "test2", "test3"]

This configuration does NOT cause problems:

stringList: 
- "test1"
- "test2"
- "test3"

The example does not use a custom serializer, only a simple List<String> type.

Cannot read nested Map in node sequence: "Got a new line in node name: "

It seems that reader cannot read a map of type Map<String, String> if it is inside a node sequence:

[15:32:50] [Thread-1/ERROR]: Exception in thread "Thread-1" java.lang.IllegalStateException: Got a new line in node name: 
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.YamlReader.readNodeNameFromMarker(YamlReader.java:323)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.YamlReader.readMapFromMarker(YamlReader.java:440)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.YamlReader.readMap(YamlReader.java:254)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readMap(AbstractReader.java:333)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readMapByType(AbstractReader.java:283)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readByType(AbstractReader.java:208)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readAndDeserializeByType(AbstractReader.java:174)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readNode(AbstractReader.java:135)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.YamlReader.readSerializableObject(YamlReader.java:136)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readByType(AbstractReader.java:237)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readByType(AbstractReader.java:195)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.YamlReader.readByType0(YamlReader.java:581)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.YamlReader.readCollectionFromMarker(YamlReader.java:557)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.YamlReader.readCollection(YamlReader.java:261)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readList(AbstractReader.java:379)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readCollectionByType(AbstractReader.java:315)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readByType(AbstractReader.java:209)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readAndDeserializeByType(AbstractReader.java:174)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readNode(AbstractReader.java:135)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.YamlReader.readSerializableObject(YamlReader.java:136)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.reader.AbstractReader.readSerializableObject(AbstractReader.java:76)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.object.AbstractSerializable.load(AbstractSerializable.java:93)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.object.AbstractSerializable.load(AbstractSerializable.java:82)
[15:32:50] [Thread-1/ERROR]: 	at net.elytrium.serializer.language.object.AbstractSerializable.reload(AbstractSerializable.java:64)

I am using the following configuration:

public class TestConfig extends YamlSerializable {

    @Transient
    private static final SerializerConfig CONFIG = new SerializerConfig.Builder()
            .setCommentValueIndent(1)
            .build();

    @Transient
    public static final TestConfig IMP = new TestConfig();

    public TestConfig() {
        super(CONFIG);
    }

    public List<CUSTOM_SECTION> SECTIONS = Collections.singletonList(new CUSTOM_SECTION());

    @NoArgsConstructor
    @AllArgsConstructor
    public static class CUSTOM_SECTION {

        public Map<String, String> STRING_AND_STRING = new LinkedHashMap<>();
        {
            STRING_AND_STRING.put("key1", "value1");
        }
    }
}

The serialized string looks like the following and seems to be written perfectly by writer:

sections:
  - string-and-string:
      key1: "value1"

But the same construction works fine in the deprecated version of the framework.

Invalid serialization if single double quotation mark is present

If you insert only one double quotation mark in the field like this:

test-section:
  # Some description for this test value1
  value-test: "
  # Some description for this test value2
  value-test-2: "test2"

The result of the serialization will be as follows:

test-section:
  # Some description for this test value1
  value-test: " # Some description for this test value2 value-test-2: "
  # Some description for this test value2
  value-test-2: "test2"

It looks like reader keeps looking for the next double quote even when the next field starts.

Configuration used:

public class TestSettings extends YamlSerializable {

    @Transient
    private static final SerializerConfig CONFIG = new SerializerConfig.Builder()
            .setCommentValueIndent(1)
            .build();
    @Transient
    public static final TestSettings IMP = new TestSettings();

    public TestSettings() {
        super(CONFIG);
    }

    public TEST_SECTION TEST_SECTION = new TEST_SECTION();

    public static class TEST_SECTION {

        @Comment(value = {
                @CommentValue("Some description for this test value1"),
        }, at = Comment.At.PREPEND)
        public String VALUE_TEST = "test1";

        @Comment(value = {
                @CommentValue("Some description for this test value2"),
        }, at = Comment.At.PREPEND)
        public String VALUE_TEST2 = "test2";

    }
}

Recommend Projects

  • React photo React

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

  • Vue.js photo Vue.js

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

  • Typescript photo Typescript

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

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

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

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.