{"id":524,"date":"2024-10-19T10:03:22","date_gmt":"2024-10-19T09:03:22","guid":{"rendered":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/?p=524"},"modified":"2024-12-23T10:07:08","modified_gmt":"2024-12-23T09:07:08","slug":"json-unit-test-assertions-mit-jsonunit-ein-leitfaden","status":"publish","type":"post","link":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/?p=524","title":{"rendered":"JSON-Unit-Test-Assertions mit JsonUnit: Ein Leitfaden"},"content":{"rendered":"\n

In modernen Softwareprojekten ist JSON ein zentraler Bestandteil f\u00fcr die Kommunikation zwischen verschiedenen Systemen. Insbesondere bei der Entwicklung von APIs spielt JSON eine Schl\u00fcsselrolle, da es oft als Datenaustauschformat verwendet wird. Um die Integrit\u00e4t und Qualit\u00e4t der APIs sicherzustellen, ist das Testen von JSON-Inhalten unverzichtbar. Hier kommt JsonUnit ins Spiel, eine Java-Bibliothek, die speziell f\u00fcr die Verifizierung von JSON-Inhalten in Unit-Tests entwickelt wurde.<\/p>\n\n\n\n

JsonUnit bietet eine elegante und effiziente M\u00f6glichkeit, JSON-Datenstrukturen zu vergleichen und sicherzustellen, dass sie den erwarteten Werten entsprechen. In diesem Artikel werden wir die grundlegenden Konzepte, die Einrichtung und die Anwendung von JsonUnit detailliert besprechen.<\/p>\n\n\n\n

\n\n\n\n

Warum JsonUnit verwenden?<\/h3>\n\n\n\n

Beim Testen von JSON-Strukturen gibt es verschiedene Herausforderungen:<\/p>\n\n\n\n

    \n
  1. Flexibilit\u00e4t beim Vergleich<\/strong>: JSON-Daten k\u00f6nnen unterschiedliche Reihenfolgen der Schl\u00fcssel oder dynamische Werte wie IDs und Zeitstempel enthalten. Ein einfacher String-Vergleich reicht hier nicht aus.<\/li>\n\n\n\n
  2. Lesbarkeit der Tests<\/strong>: Komplexe JSON-Strukturen manuell zu vergleichen kann un\u00fcbersichtlich und fehleranf\u00e4llig sein.<\/li>\n\n\n\n
  3. Unterst\u00fctzung von Teilvergleichen<\/strong>: Oft m\u00f6chte man nur bestimmte Teile eines JSON-Dokuments verifizieren, ohne das gesamte Dokument zu testen.<\/li>\n<\/ol>\n\n\n\n

    JsonUnit adressiert all diese Punkte und bietet eine intuitive Syntax sowie leistungsstarke Features.<\/p>\n\n\n\n

    \n\n\n\n

    Installation und Einrichtung<\/h3>\n\n\n\n

    Um JsonUnit in einem Java-Projekt zu verwenden, m\u00fcssen Sie die Bibliothek in Ihrer Build-Konfiguration hinzuf\u00fcgen. F\u00fcr ein Maven-Projekt sieht die Dependency wie folgt aus:<\/p>\n\n\n

    <dependency<\/span>><\/span>\n    <groupId<\/span>><\/span>net.javacrumbs.json-unit<\/groupId<\/span>><\/span>\n    <artifactId<\/span>><\/span>json-unit<\/artifactId<\/span>><\/span>\n    <version<\/span>><\/span>3.5.0<\/version<\/span>><\/span>\n    <scope<\/span>><\/span>test<\/scope<\/span>><\/span>\n<\/dependency<\/span>><\/span>\n<\/code><\/span>Code-Sprache:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
    Falls Sie Gradle verwenden, k\u00f6nnen Sie die Bibliothek wie folgt einbinden:<\/p>\n\n\n
    testImplementation 'net.javacrumbs.json-unit:json-unit:2.37.0'<\/span>\n<\/code><\/span>Code-Sprache:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
    Nach der Einrichtung k\u00f6nnen Sie JsonUnit in Ihren Testklassen importieren:<\/p>\n\n\n
    import<\/span> static<\/span> net<\/span>.javacrumbs<\/span>.jsonunit<\/span>.JsonAssert<\/span>.assertJsonEquals<\/span>;\n<\/code><\/span>Code-Sprache:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
    \n\n\n\n
    Grundlagen: JSON-Vergleich mit JsonUnit<\/h3>\n\n\n\n
    1. Einfacher Vergleich<\/strong><\/h4>\n\n\n\n
    Der grundlegende Anwendungsfall von JsonUnit ist der Vergleich zweier JSON-Dokumente:<\/p>\n\n\n
    @Test\nvoid<\/span> testSimpleJsonComparison() {\n    String<\/span> actualJson = \"{\"<\/span>name\": \"<\/span>John\", \"<\/span>age\": 30}\"<\/span>;\n    String<\/span> expectedJson = \"{\"<\/span>age\": 30, \"<\/span>name\": \"<\/span>John\"}\"<\/span>;\n\n    assertJsonEquals(expectedJson, actualJson);\n}\n<\/code><\/span>Code-Sprache:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
    JsonUnit ignoriert die Reihenfolge der Schl\u00fcssel und pr\u00fcft nur die Werte, was es ideal f\u00fcr JSON-Tests macht.<\/p>\n\n\n\n
    2. Vergleich mit Toleranz<\/strong><\/h4>\n\n\n\n
    JsonUnit erlaubt es, numerische Werte mit einer Toleranz zu vergleichen:<\/p>\n\n\n
    @Test\nvoid<\/span> testComparisonWithTolerance() {\n    String<\/span> actualJson = \"{\"<\/span>value\": 99.9}\"<\/span>;\n    String<\/span> expectedJson = \"{\"<\/span>value\": 100.0}\"<\/span>;\n\n    assertJsonEquals(expectedJson, actualJson, JsonAssert.withTolerance(0.2<\/span>));\n}\n<\/code><\/span>Code-Sprache:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
    \n\n\n\n
    Erweiterte Funktionen von JsonUnit<\/h3>\n\n\n\n
    1. Teilvergleich<\/strong><\/h4>\n\n\n\n
    H\u00e4ufig m\u00f6chte man nur bestimmte Teile eines JSON-Dokuments \u00fcberpr\u00fcfen. JsonUnit bietet hierf\u00fcr die Methode assertJsonPartEquals<\/code>:<\/p>\n\n\n
    @Test\nvoid<\/span> testPartialComparison() {\n    String<\/span> actualJson = \"{\"<\/span>user\": {\"<\/span>name\": \"<\/span>John\", \"<\/span>age\": 30}}\"<\/span>;\n    String<\/span> expectedName = \"John\"<\/span>;\n\n    assertJsonPartEquals(expectedName, actualJson, \"user.name\"<\/span>);\n}\n}\n<\/code><\/span>Code-Sprache:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
    2. Ignorieren dynamischer Werte<\/strong><\/h4>\n\n\n\n
    JsonUnit kann spezifische Felder ignorieren, die sich bei jedem Testlauf \u00e4ndern, z. B. IDs oder Zeitstempel:<\/p>\n\n\n
    @Test\nvoid<\/span> testIgnoringDynamicValues() {\n    String<\/span> actualJson = \"{\"<\/span>id\": 123, \"<\/span>name\": \"<\/span>John\"}\"<\/span>;\n    String<\/span> expectedJson = \"{\"<\/span>id\": \"<\/span>${json-unit.ignore}\", \"<\/span>name\": \"<\/span>John\"}\"<\/span>;\n\n    assertJsonEquals(expectedJson, actualJson);\n}\n<\/code><\/span>Code-Sprache:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
    3. Vergleich mit JSON-Pfad-Ausdr\u00fccken<\/strong><\/h4>\n\n\n\n
    JsonUnit unterst\u00fctzt JSONPath-Ausdr\u00fccke, um gezielt Teile des JSON-Dokuments zu pr\u00fcfen:<\/p>\n\n\n
    @Test\nvoid<\/span> testWithJsonPath() {\n    String<\/span> actualJson = \"{\"<\/span>user\": {\"<\/span>name\": \"<\/span>John\", \"<\/span>roles\": [\"<\/span>admin\", \"<\/span>user\"]}}\"<\/span>;\n\n    assertJsonPartEquals(\"admin\"<\/span>, actualJson, \"user.roles[0]\"<\/span>);\n}\n<\/code><\/span>Code-Sprache:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
    \n\n\n\n
    Integration in Frameworks<\/h3>\n\n\n\n
    1. JUnit 5<\/strong><\/h4>\n\n\n\n
    JsonUnit l\u00e4sst sich nahtlos in JUnit 5-Tests integrieren, indem die Methoden direkt in den Testf\u00e4llen verwendet werden.<\/p>\n\n\n\n
    2. Spring Boot<\/strong><\/h4>\n\n\n\n
    In Spring-Boot-Anwendungen ist JsonUnit besonders hilfreich, um die Antworten von REST-APIs zu verifizieren. Hier ein Beispiel mit MockMvc<\/code>:<\/p>\n\n\n
    @Test\nvoid testRestApiResponse() throws Exception<\/span> {\n    mockMvc.perform(get(\"\/api\/user\/1\"<\/span>))\n           .andExpect(status().isOk())\n           .andExpect(result -> assertJsonEquals(\"{\"<\/span>name\": \"<\/span>John\", \"<\/span>age\": 30}\"<\/span>, result.getResponse().getContentAsString()));\n}\n<\/code><\/span>Code-Sprache:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
    \n\n\n\n
    Best Practices<\/h3>\n\n\n\n
      \n
    1. Verwendung von Platzhaltern<\/strong>: Platzhalter wie ${json-unit.ignore}<\/code> erleichtern den Umgang mit dynamischen Werten.<\/li>\n\n\n\n
    2. Modularisierung von Tests<\/strong>: Lagern Sie erwartete JSON-Daten in separaten Dateien aus, um die Lesbarkeit und Wiederverwendbarkeit zu verbessern.<\/li>\n\n\n\n
    3. Kombination mit Mocking<\/strong>: Nutzen Sie JsonUnit in Kombination mit Mocking-Frameworks wie Mockito, um die R\u00fcckgaben von Services zu testen.<\/li>\n\n\n\n
    4. Toleranzen und Vergleichsmodi<\/strong>: Verwenden Sie Toleranzen und Modifikatoren wie LENIENT<\/code>, um flexiblere Tests zu erstellen.<\/li>\n<\/ol>\n\n\n\n
      \n\n\n\n
      Fazit<\/h3>\n\n\n\n
      JsonUnit ist ein m\u00e4chtiges Werkzeug f\u00fcr die Verifizierung von JSON-Daten in Unit-Tests. Es bietet eine Vielzahl von Funktionen, die \u00fcber einen einfachen Vergleich hinausgehen und Entwicklern die M\u00f6glichkeit geben, Tests flexibel und robust zu gestalten. Durch die Integration in bestehende Testframeworks und die einfache Handhabung wird JsonUnit zu einem unverzichtbaren Bestandteil moderner Java-Teststrategien.<\/p>\n\n\n\n
      Mit JsonUnit k\u00f6nnen Sie sicherstellen, dass Ihre JSON-Strukturen korrekt und konsistent bleiben \u2013 ein entscheidender Schritt, um die Qualit\u00e4t Ihrer Anwendungen zu gew\u00e4hrleisten.<\/p>\n","protected":false},"excerpt":{"rendered":"
      In modernen Softwareprojekten ist JSON ein zentraler Bestandteil f\u00fcr die Kommunikation zwischen verschiedenen Systemen. Insbesondere bei der Entwicklung von APIs spielt JSON eine Schl\u00fcsselrolle, da es oft als Datenaustauschformat verwendet wird. Um die Integrit\u00e4t und Qualit\u00e4t der APIs sicherzustellen, ist das Testen von JSON-Inhalten unverzichtbar. Hier kommt JsonUnit ins Spiel, eine Java-Bibliothek, die speziell f\u00fcr […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-524","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts\/524","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=524"}],"version-history":[{"count":1,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts\/524\/revisions"}],"predecessor-version":[{"id":525,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts\/524\/revisions\/525"}],"wp:attachment":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=524"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=524"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=524"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}