How can I delete the nameValuePairs key from the JSONObject?

18,621

Solution 1

Issue:

Retrofit by default uses GSON to convert HTTP bodies to and from JSON. The object which is specified with @Body annotation will be passed to GSON for serialization, which basically converts the JAVA object to JSON representation. This JSON representation will be the HTTP request body.

JSONObject stores all the key-value mapping in a member variable by name nameValuePairs. Here is an excerpt of JSONObject implementation:

public class JSONObject {
    ...
    private final Map<String, Object> nameValuePairs;
    ...
}

When you pass JSONObject to @Body annotation, this JSONObject is seraliazed, hence the HTTP request body contains : {"nameValuePairs": "actual JSON Object"}.

Solution:

Pass the actual JAVA object to @Body annotation, not it's corresponding JSONObject. GSON will take care of converting it to JSON representation.

For e.g.

class HTTPRequestBody {
   String key1 = "value1";
   String key2 = "value2";
   ...
}

// GSON will serialize it as {"key1": "value1", "key2": "value2"}, 
// which will be become HTTP request body.

public interface MyService {
    @Headers({"Content-type: application/json",
              "Accept: */*"})
    @POST("/test")
    void postJson(@Body HTTPRequestBody body, Callback<Response> callback);
}

// Usage
MyService myService = restAdapter.create(MyService.class);
myService.postJson(new HTTPRequestBody(), callback);

Alternative solution:

If you still want to send raw JSON as HTTP request body, then follow the solution mentioned by Retrofit author here.

One of the suggested solution is to use TypedInput:

public interface MyService {
  @POST("/test")
  void postRawJson(@Body TypedInput body, Callback<Response> callback);
}

String json = jsonRequest.toString();
TypedInput in = new TypedByteArray("application/json", json.getBytes("UTF-8"));
myService.postRawJson(in, callback);

Solution 2

Use com.google.gson.JsonObject instead of org.json.JSONObject.

JSONObject jsonRequest = new JSONObject();
jsonRequest.put("xxxx", "zzzzzzz");
jsonRequest.put("yyyy", "uuuuuuu");

Change to

JsonObject jsonRequest = new JsonObject();
jsonRequest.addProperty("xxxx", "zzzzzzz");
jsonRequest.addProperty("yyyy", "uuuuuuu");

Then in interface

public interface MyService {
    @Headers({"Content-type: application/json",
              "Accept: */*"})
    @POST("/test")
    void testFunction(@Body JsonObject jsonObject, Callback<Response> callback);
}

JSONObject class keeping the values in LinkedHashMap with the variable name of nameValuePairs, When Gson trying to convert the JSONObject's instance into JSON, GSON keeps the structure(which has the variable nameValuePairs). That causing this problem.

Solution 3

you have to covert JSONObject to JsonObject of GSON

follow this way

 JsonParser jsonParser = new JsonParser();
  JsonObject jsonObject = (JsonObject)jsonParser.parse(actualjsonobject.toString());

then pass in body

HashMap<String,Object> body=new HashMap();

 body.put("content",jsonObject);

Solution 4

Thanks to 13KZ, pointed me in the right direction, and to flesh it out here is what I now have to solve this issue.

Definitions

private JsonObject gsonResultTwoWeek;
private JsonObject gsonResultDay;
private JsonObject gsonResult;

Initialise

gsonResult = new JsonObject();
gsonResultDay = new JsonObject();
gsonResultTwoWeek = new JsonObject();

Use

gsonResultDay.addProperty(epoch, value);

where data is a string and value is an int in my case and is in a for loop to add multiple values

And then to pull it all together

gsonResult.addProperty("accounts", 2);
gsonResult.add("todaydata", gsonResultDay);
gsonResult.add("2weekdata", gsonResultTwoWeek);

Finally my interface

public interface ApiInterface {

    @POST("/groupdata")
    void postGroupData(@Body JsonObject body,Callback<StatusResponse> cb);

}

What hits my server is this

{"accounts":2,"todaydata":{"1423814400":89,"1423816200":150,"1423818000":441},"2weekdata":{"1423699200":4869,"1423785600":1011}}
Share:
18,621
13KZ
Author by

13KZ

ANDROID LIBRARY : I develop a library which allow user to rate his application. See the following link for more information. App Rating lib

Updated on June 15, 2022

Comments

  • 13KZ
    13KZ almost 2 years

    I'm working on an Android project which needs a JSONObject for the body of my POST request. After putting the keys and values of the JSON I got the following line:

    {
        "xxxx":"zzzzzzz",
        "yyyy":"uuuuuuu"
    }
    

    But the server got the following:

    {
        "name_value_pairs": {
                            "xxxx":"zzzzzzz",
                            "yyyy":"uuuuuuu"
        }
    }
    

    I've already tried a JSONStringer but it wasn't really helpful because the Content-Type of the request is application/json.

    UPDATE

    I'm not trying to construct a JSONObject because it's already done by using the following line of code (the same given by @osayilgan):

    JSONObject jsonRequest = new JSONObject();
    jsonRequest.put("xxxx", "zzzzzzz");
    jsonRequest.put("yyyy", "uuuuuuu");
    

    Here is not the problem. The interface described below is used to communicate with the server.

    public interface MyService {
        @Headers({"Content-type: application/json",
                  "Accept: */*"})
        @POST("/test")
        void testFunction(@Body JSONObject jsonObject, Callback<Response> callback);
    }
    

    The server got the request with the second JSON as Body which is disappointing. I note that the key name_value_pairs is automatically added to the object.

    Does anybody know how can I fix this?