Can I GSON deserialize a variable name which includes a hyphen in Java?

Question

I am using GSON in my app. I have the following JSON response:

{
  "success":true,
  "person-name": "John"
}

So, I am creating a class like this:

class Person {
    boolean success;
    String person-name;
}

However, I am unable to create a variable person-name. How can I solve this?

Answer 1

Choose a valid Java identifier and use the @SerializedName annotation to tell GSON the name of the corresponding JSON property:

import com.google.gson.annotations.SerializedName;

class Person {
    boolean success;
    @SerializedName("person-name")
    String personName;
}

Answer 2

Just thought of sharing, if you are using Jackson, which I believe many people are, you can use:

import com.fasterxml.jackson.annotation.JsonProperty;

class Person {
    boolean success;
    @JsonProperty("person-name")
    String personName;
}