Testowanie dwóch obiektów JSON pod kątem równości, ignorując kolejność dzieci w Javie

Szukam biblioteki analizującej JSON, która obsługuje porównywanie dwóch obiektów JSON ignorujących kolejność elementów podrzędnych, szczególnie do testowania jednostkowego JSON powracającego z usługi WWW.

Czy którakolwiek z głównych bibliotek JSON obsługuje to? Biblioteka org.json po prostu porównuje odniesienia.

Jako ogólny punkt architektoniczny zwykle odradzam uwalnianie zależności od określonego formatu serializacji poza warstwę pamięci / sieci; dlatego najpierw zaleciłbym rozważenie przetestowania równości między własnymi obiektami aplikacji, a nie ich manifestacjami JSON.

Powiedziawszy to, jestem obecnie wielkim fanem Jacksona, który mój szybki odczyt ich implementacji ObjectNode.equals () sugeruje, czy zestaw porównawczy członkostwa, który chcesz:

public boolean equals(Object o)
{
    if (o == this) return true;
    if (o == null) return false;
    if (o.getClass() != getClass()) {
        return false;
    }
    ObjectNode other = (ObjectNode) o;
    if (other.size() != size()) {
        return false;
    }
    if (_children != null) {
        for (Map.Entry<String, JsonNode> en : _children.entrySet()) {
            String key = en.getKey();
            JsonNode value = en.getValue();

            JsonNode otherValue = other.get(key);

            if (otherValue == null || !otherValue.equals(value)) {
                return false;
            }
        }
    }
    return true;
}

Wypróbuj JSONAssert w Skyscreamer .

Jego zakaz ścisłe tryb ma dwie główne zalety, które czynią go mniej kruche:

• Rozszerzalność obiektu (np. Przy oczekiwanej wartości {id: 1} , to i tak dałoby wynik: {id: 1, moredata: 'x'} .)
• Luźna kolejność tablic (np. [„Pies”, „kot”] == [„kot”, „pies”])

W trybie ścisłym zachowuje się bardziej jak klasa testowa json-lib.

Test wygląda mniej więcej tak:

@Test
public void testGetFriends() {
    JSONObject data = getRESTData("/friends/367.json");
    String expected = "{friends:[{id:123,name:\"Corby Page\"}"
        + ",{id:456,name:\"Solomon Duskis\"}]}";
    JSONAssert.assertEquals(expected, data, false);
}

Parametry w wywołaniu JSONAssert.assertEquals () są oczekiwane : JSONString , actualDataString i isStrict .

Komunikaty wyników są dość wyraźne, co jest ważne przy porównywaniu naprawdę dużych obiektów JSON.

Korzystanie z GSON

JsonParser parser = new JsonParser();
JsonElement o1 = parser.parse("{a : {a : 2}, b : 2}");
JsonElement o2 = parser.parse("{b : 2, a : {a : 2}}");
assertEquals(o1, o2);

Edycja: Od wersji GSON v2.8.6 metoda instancji JsonParser.parsejest przestarzała. Musisz użyć metody statycznej JsonParser.parseString:

JsonElement o1 = JsonParser.parseString("{a : {a : 2}, b : 2}");
JsonElement o2 = JsonParser.parseString("{b : 2, a : {a : 2}}");
assertEquals(o1, o2);

Zrobiłbym następujące,

JSONObject obj1 = /*json*/;
JSONObject obj2 = /*json*/;

ObjectMapper mapper = new ObjectMapper();

JsonNode tree1 = mapper.readTree(obj1.toString());
JsonNode tree2 = mapper.readTree(obj2.toString());

return tree1.equals(tree2);

Możesz spróbować użyć klasy JSONAssert json-lib :

JSONAssert.assertEquals(
  "{foo: 'bar', baz: 'qux'}",
  JSONObject.fromObject("{foo: 'bar', baz: 'xyzzy'}")
);

Daje:

junit.framework.ComparisonFailure: objects differed at key [baz]; expected:<[qux]> but was:<[xyzzy]>

Użyj tej biblioteki: https://github.com/lukas-krecan/JsonUnit

Pom:

<dependency>
    <groupId>net.javacrumbs.json-unit</groupId>
    <artifactId>json-unit</artifactId>
    <version>1.5.0</version>
    <scope>test</scope>
</dependency>

IGNORING_ARRAY_ORDER - ignoruje kolejność w tablicach

assertJsonEquals("{\"test\":[1,2,3]}",
  "{\"test\":  [3,2,1]}",
  when(IGNORING_ARRAY_ORDER)
);

Jeśli już używasz JUnit, najnowsza wersja zawiera teraz Hamcrest. Jest to ogólna struktura dopasowywania (szczególnie przydatna do testowania jednostkowego), którą można rozszerzyć w celu zbudowania nowych dopasowań.

Istnieje mała biblioteka open source o nazwie hamcrest-jsonz dopasowaniami JSON. Jest dobrze udokumentowany, przetestowany i obsługiwany. Poniżej znajdują się przydatne linki:

• Kod źródłowy
• Strona główna
• Javadocs dla głównego dopasowywania :

Przykładowy kod wykorzystujący obiekty z biblioteki JSON org.json.simple:

Assert.assertThat(
    jsonObject1.toJSONString(),
    SameJSONAs.sameJSONAs(jsonObject2.toJSONString()));

Opcjonalnie możesz (1) zezwolić na tablice „dowolnego rzędu” i (2) zignorować dodatkowe pola.

Ponieważ istnieje wiele bibliotek JSON for Java ( Jackson, GSON, json-lib, itd), jest przydatna, że hamcrest-jsontekst podpory JSON (jak java.lang.String), a także obiekty wspierające natywnie z JSON biblioteki Douglasa Crockforda użytkownika org.json.

Wreszcie, jeśli nie używasz JUnit, możesz użyć Hamcrest bezpośrednio do asercji. ( Pisałem o tym tutaj. )

Możesz wypróbować JsonUnit . Może porównywać dwa obiekty JSON i zgłaszać różnice. Jest zbudowany na Jacksonie.

Na przykład

assertJsonEquals("{\"test\":1}", "{\n\"test\": 2\n}");

Prowadzi do

java.lang.AssertionError: JSON documents are different:
Different value found in node "test". Expected 1, got 2.

Jedną rzeczą, którą zrobiłem i działa cuda, jest odczytanie obu obiektów do HashMap, a następnie porównanie ze zwykłą funkcją assertEquals (). Wywoła metodę haszaps równą (), która rekurencyjnie porównuje wszystkie obiekty w środku (będą to albo inne haszapy, albo jakiś obiekt o pojedynczej wartości, taki jak łańcuch lub liczba całkowita). Dokonano tego przy użyciu analizatora składni JSON firmy Codehaus.

assertEquals(mapper.readValue(expectedJson, new TypeReference<HashMap<String, Object>>(){}), mapper.readValue(actualJson, new TypeReference<HashMap<String, Object>>(){}));

Podobne podejście można zastosować, jeśli obiekt JSON jest tablicą.

Używam tego i działa dobrze dla mnie (z org.json. *):

package com.project1.helpers;

import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;

import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;

public class JSONUtils {

    public static boolean areEqual(Object ob1, Object ob2) throws JSONException {
        Object obj1Converted = convertJsonElement(ob1);
        Object obj2Converted = convertJsonElement(ob2);
        return obj1Converted.equals(obj2Converted);
    }

    private static Object convertJsonElement(Object elem) throws JSONException {
        if (elem instanceof JSONObject) {
            JSONObject obj = (JSONObject) elem;
            Iterator<String> keys = obj.keys();
            Map<String, Object> jsonMap = new HashMap<>();
            while (keys.hasNext()) {
                String key = keys.next();
                jsonMap.put(key, convertJsonElement(obj.get(key)));
            }
            return jsonMap;
        } else if (elem instanceof JSONArray) {
            JSONArray arr = (JSONArray) elem;
            Set<Object> jsonSet = new HashSet<>();
            for (int i = 0; i < arr.length(); i++) {
                jsonSet.add(convertJsonElement(arr.get(i)));
            }
            return jsonSet;
        } else {
            return elem;
        }
    }
}

W przypadku org.json wdrożyłem własne rozwiązanie, metodę porównywalną z instancjami JSONObject. W tym projekcie nie pracowałem ze złożonymi obiektami JSON, więc nie wiem, czy to działa we wszystkich scenariuszach. Biorąc pod uwagę, że używam tego w testach jednostkowych, nie wkładałem wysiłku w optymalizacje. Oto on:

public static boolean jsonObjsAreEqual (JSONObject js1, JSONObject js2) throws JSONException {
    if (js1 == null || js2 == null) {
        return (js1 == js2);
    }

    List<String> l1 =  Arrays.asList(JSONObject.getNames(js1));
    Collections.sort(l1);
    List<String> l2 =  Arrays.asList(JSONObject.getNames(js2));
    Collections.sort(l2);
    if (!l1.equals(l2)) {
        return false;
    }
    for (String key : l1) {
        Object val1 = js1.get(key);
        Object val2 = js2.get(key);
        if (val1 instanceof JSONObject) {
            if (!(val2 instanceof JSONObject)) {
                return false;
            }
            if (!jsonObjsAreEqual((JSONObject)val1, (JSONObject)val2)) {
                return false;
            }
        }

        if (val1 == null) {
            if (val2 != null) {
                return false;
            }
        }  else if (!val1.equals(val2)) {
            return false;
        }
    }
    return true;
}

Możesz użyć biblioteki zjsonpatch , która przedstawia informacje o różnicach zgodnie z RFC 6902 (łatka JSON). Jest bardzo łatwy w użyciu. Proszę odwiedzić jego stronę z opisem użycia

Wziąłbym bibliotekę pod adresem http://json.org/java/ i zmodyfikowałem equalsmetodę JSONObject i JSONArray, aby przeprowadzić głęboki test równości. Aby upewnić się, że działa bez względu na kolejność dzieci, wystarczy wymienić wewnętrzną mapę na TreeMaplub użyć czegoś podobnego Collections.sort().

Spróbuj tego:

public static boolean jsonsEqual(Object obj1, Object obj2) throws JSONException

    {
        if (!obj1.getClass().equals(obj2.getClass()))
        {
            return false;
        }

        if (obj1 instanceof JSONObject)
        {
            JSONObject jsonObj1 = (JSONObject) obj1;

            JSONObject jsonObj2 = (JSONObject) obj2;

            String[] names = JSONObject.getNames(jsonObj1);
            String[] names2 = JSONObject.getNames(jsonObj1);
            if (names.length != names2.length)
            {
                return false;
            }

            for (String fieldName:names)
            {
                Object obj1FieldValue = jsonObj1.get(fieldName);

                Object obj2FieldValue = jsonObj2.get(fieldName);

                if (!jsonsEqual(obj1FieldValue, obj2FieldValue))
                {
                    return false;
                }
            }
        }
        else if (obj1 instanceof JSONArray)
        {
            JSONArray obj1Array = (JSONArray) obj1;
            JSONArray obj2Array = (JSONArray) obj2;

            if (obj1Array.length() != obj2Array.length())
            {
                return false;
            }

            for (int i = 0; i < obj1Array.length(); i++)
            {
                boolean matchFound = false;

                for (int j = 0; j < obj2Array.length(); j++)
                {
                    if (jsonsEqual(obj1Array.get(i), obj2Array.get(j)))
                    {
                        matchFound = true;
                        break;
                    }
                }

                if (!matchFound)
                {
                    return false;
                }
            }
        }
        else
        {
            if (!obj1.equals(obj2))
            {
                return false;
            }
        }

        return true;
    }

Wiem, że to jest zwykle uważane tylko do testów, ale można użyć Hamcrest JSON comparitorSameJSONAs w Hamcrest JSON.

Hamcrest JSON SameJSONAs

Karate jest dokładnie tym, czego szukasz. Oto przykład:

* def myJson = { foo: 'world', hey: 'ho', zee: [5], cat: { name: 'Billie' } }
* match myJson = { cat: { name: 'Billie' }, hey: 'ho', foo: 'world', zee: [5] }

(wyłączenie odpowiedzialności: tutaj programista)

Do porównania jsonów polecam użycie JSONCompare: https://github.com/fslev/json-compare

// Compare by regex
String expected = "{\"a\":\".*me.*\"}";
String actual = "{\"a\":\"some text\"}";
JSONCompare.assertEquals(expected, actual);  // True

// Check expected array has no extra elements
String expected = "[1,\"test\",4,\"!.*\"]";
String actual = "[4,1,\"test\"]";
JSONCompare.assertEquals(expected, actual);  // True

// Check expected array has no numbers
String expected = "[\"\\\\\\d+\"]";
String actual = "[\"text\",\"test\"]";
JSONCompare.assertEquals(expected, actual);  // True

// Check expected array has no numbers
String expected = "[\"\\\\\\d+\"]";
String actual = "[2018]";
JSONCompare.assertNotEquals(expected, actual);  // True

Dla takich jak ja, którzy chcą to zrobić z Jacksonem, możesz użyć json-unit .

JsonAssert.assertJsonEquals(jsonNode1, jsonNode2);

Błędy dają użyteczne informacje zwrotne na temat rodzaju niedopasowania:

java.lang.AssertionError: JSON documents have different values:
Different value found in node "heading.content[0].tag[0]". Expected 10209, got 10206.

Nic innego nie działało całkiem dobrze, więc napisałem to:

private boolean jsonEquals(JsonNode actualJson, JsonNode expectJson) {
    if(actualJson.getNodeType() != expectJson.getNodeType()) return false;

    switch(expectJson.getNodeType()) {
    case NUMBER:
        return actualJson.asDouble() == expectJson.asDouble();
    case STRING:
    case BOOLEAN:
        return actualJson.asText().equals(expectJson.asText());
    case OBJECT:
        if(actualJson.size() != expectJson.size()) return false;

        Iterator<String> fieldIterator = actualJson.fieldNames();
        while(fieldIterator.hasNext()) {
            String fieldName = fieldIterator.next();
            if(!jsonEquals(actualJson.get(fieldName), expectJson.get(fieldName))) {
                return false;
            }
        }
        break;
    case ARRAY:
        if(actualJson.size() != expectJson.size()) return false;
        List<JsonNode> remaining = new ArrayList<>();
        expectJson.forEach(remaining::add);
        // O(N^2)   
        for(int i=0; i < actualJson.size(); ++i) {
            boolean oneEquals = false;
            for(int j=0; j < remaining.size(); ++j) {
                if(jsonEquals(actualJson.get(i), remaining.get(j))) {
                    oneEquals = true;
                    remaining.remove(j);
                    break;
                }
            }
            if(!oneEquals) return false;
        }
        break;
    default:
        throw new IllegalStateException();
    }
    return true;
}

Poniższy kod będzie bardziej pomocny w porównaniu dwóch JsonObject, JsonArray, JsonPrimitive i JasonElements.

private boolean compareJson(JsonElement json1, JsonElement json2) {
        boolean isEqual = true;
        // Check whether both jsonElement are not null
        if (json1 != null && json2 != null) {

            // Check whether both jsonElement are objects
            if (json1.isJsonObject() && json2.isJsonObject()) {
                Set<Entry<String, JsonElement>> ens1 = ((JsonObject) json1).entrySet();
                Set<Entry<String, JsonElement>> ens2 = ((JsonObject) json2).entrySet();
                JsonObject json2obj = (JsonObject) json2;
                if (ens1 != null && ens2 != null) {
                    // (ens2.size() == ens1.size())
                    // Iterate JSON Elements with Key values
                    for (Entry<String, JsonElement> en : ens1) {
                        isEqual = isEqual && compareJson(en.getValue(), json2obj.get(en.getKey()));
                    }
                } else {
                    return false;
                }
            }

            // Check whether both jsonElement are arrays
            else if (json1.isJsonArray() && json2.isJsonArray()) {
                JsonArray jarr1 = json1.getAsJsonArray();
                JsonArray jarr2 = json2.getAsJsonArray();
                if (jarr1.size() != jarr2.size()) {
                    return false;
                } else {
                    int i = 0;
                    // Iterate JSON Array to JSON Elements
                    for (JsonElement je : jarr1) {
                        isEqual = isEqual && compareJson(je, jarr2.get(i));
                        i++;
                    }
                }
            }

            // Check whether both jsonElement are null
            else if (json1.isJsonNull() && json2.isJsonNull()) {
                return true;
            }

            // Check whether both jsonElement are primitives
            else if (json1.isJsonPrimitive() && json2.isJsonPrimitive()) {
                if (json1.equals(json2)) {
                    return true;
                } else {
                    return false;
                }
            } else {
                return false;
            }
        } else if (json1 == null && json2 == null) {
            return true;
        } else {
            return false;
        }
        return isEqual;
    }

JSON.areEqual(json1, json2); //using BlobCity Java Commons

https://tech.blobcity.com/2018/09/02/json-equals-in-java-to-compare-two-jsons

Patrząc na odpowiedzi, spróbowałem JSONAssert, ale nie udało się. Więc użyłem Jacksona z zjsonpatch. Podałem szczegóły w odpowiedzi SO tutaj .

To rozwiązanie jest dla mnie bardzo dobre:

try {           
                // Getting The Array "Courses" from json1 & json2   
                Courses1 =json1.getJSONArray(TAG_COURSES1);
                Courses2 = json2.getJSONArray(TAG_COURSES);

                //LOOP FOR JSON1
                for(int i = 0; i < Courses1.length(); i++){
                    //LOOP FOR JSON2
                    for(int ii = 0; ii < Courses2.length(); ii++){
                        JSONObject courses1 = Courses1.getJSONObject(i);
                        JSONObject courses2 = Courses2.getJSONObject(ii);

                        // Storing each json1 item in variable
                        int courseID1 = courses1.getInt(TAG_COURSEID1);
                        Log.e("COURSEID2:", Integer.toString(courseID1));
                        String Rating1 = courses1.getString(TAG_RATING1);
                        int Status1 = courses1.getInt(TAG_STATUS1);
                        Log.e("Status1:", Integer.toString(Status1));      //Put the actual value for Status1 in log.             

                        // Storing each json2 item in variable
                        int courseID2 = courses2.getInt(TAG_COURSEID);
                        Log.e("COURSEID2:", Integer.toString(courseID));   //Put the actual value for CourseID in log
                        String Title2 = courses2.getString(TAG_TITLE);                      
                        String instructor2 = courses2.getString(TAG_INSTRUCTOR);
                        String length2 = courses2.getString(TAG_LENGTH);
                        String rating2 = courses2.getString(TAG_RATING);
                        String subject2 = courses2.getString(TAG_SUBJECT);
                        String description2 = courses2.getString(TAG_DESCRIPTION);

                        //Status1 = 5 from json1; Incomplete, Status1 =-1 Complete 
                        if(Status1 == 5 && courseID2 == courseID1){                                  

                        // creating new HashMap
                        HashMap<String, String> map = new HashMap<String, String>();         
                        //Storing the elements if condition is true.
                        map.put(TAG_COURSEID, Integer.toString(courseID2)); //pend for compare
                        map.put(TAG_TITLE, Title2);
                        map.put(TAG_INSTRUCTOR, instructor2);
                        map.put(TAG_LENGTH, length2);
                        map.put(TAG_RATING, rating2);
                        map.put(TAG_SUBJECT, subject2); //show it
                        map.put(TAG_DESCRIPTION, description2);

                        //adding HashList to ArrayList
                        contactList.add(map);
                        }//if
                    }//for2 (json2)
                } //for1 (json1)                
            }//Try

Mam nadzieję, że pomoże to innym.