使用Jackson序列化的JSON的Java類實現-魔扣目錄

本文介紹了使用Jackson序列化的JSON的Java類實現的處理方法，對大家解決問題具有一定的參考價值，需要的朋友們下面隨著小編來一起學習吧！

問題描述

我正在嘗試在Java應用程序中實現Microsoft Teams API的一部分，在使用Jackson庫將Java對象序列化為JSON時，我希望得到一些關于正確的Java類結構和體系結構的建議。目標是在特定階段完成時向團隊頻道發送消息。

我有一個測試類，它可以序列化到我想要的JSON，但根據我看到的其他實現，下面的代碼感覺它的結構不正確，也不靈活。

我希望得到的JSON結構如下：

{
  "@context": "http://schema.org/extensions",
  "@type": "MessageCard",
  "correlationId": "104443c6-7acc-11ea-bc55-0242ac130003",
  "summary": "test.complete",
  "themeColor": "0076D7",
  "sections": [
    {
      "activityTitle": "Test Notification"
    },
    {
      "title": "Execution Status",
      "facts": [
        {
          "name": "Build Number",
          "value": "1"
        },
        {
          "name": "Description",
          "value": "Test Pipeline Description"
        },
        {
          "name": "Execution Name",
          "value": "Test Pipeline Name"
        },
        {
          "name": "Stage Name",
          "Value": "Deploy"
        },
        {
          "name": "Status",
          "value": "complete"
        },
        {
          "name": "Summary",
          "value": "pipeline has completed successfully"
        }
      ]
    }
  ],
  "potentialAction": [
    {
      "@context": "http://schema.org",
      "@type": "ViewAction",
      "name": "View Execution",
      "target": [
        "https://testdomain.com"
      ]
    }
  ]
}

我的測試Java類如下：

import java.util.*;
import com.fasterxml.jackson.annotation.*;

public class JacksonSerializerTest {
  private static String ACTIVITY_TITLE = "Test Notifications";
  private static String FACTS_TITLE = "Execution Status";

  @JsonProperty("@context")
  public String context = "http://schema.org/extensions";

  @JsonProperty("@type")
  public String type = "MessageCard";

  public String correlationId;
  public String summary;
  public String themeColor;

  private transient HashMap<String, Object> metadata;

  public JacksonSerializerTest(HashMap<String, Object> metadata) {
    this.correlationId = this.createRandomUUID();
    this.summary = "test.complete";
    this.themeColor = "0076D7";

    this.metadata = metadata;
  }

  public List<HashMap> getSections() {
    List<HashMap> sections = new ArrayList<>();
    HashMap<String, Object> activityTitle = this.getSection("activityTitle", ACTIVITY_TITLE);

    sections.add(activityTitle);
    sections.add((HashMap)this.getFacts());

    return sections;
  }

  public HashMap<String, Object> getSection(String name, Object obj) {
    HashMap<String, Object> section = new HashMap<>();

    section.put(name, obj);

    return section;
  }

  private HashMap<String, Object> getFacts() {
    HashMap<String, Object> facts = new HashMap<>();
    List<HashMap> factsList = new ArrayList<>();

    factsList.add((HashMap)this.getFact("Build Number", (String)metadata.get("buildNumber")));
    factsList.add((HashMap)this.getFact("Description", (String)metadata.get("description")));
    factsList.add((HashMap)this.getFact("Execution Name", (String)metadata.get("executionName")));
    factsList.add((HashMap)this.getFact("Stage Name", (String)metadata.get("eventName")));
    factsList.add((HashMap)this.getFact("Status", (String)metadata.get("executionStatus")));
    factsList.add((HashMap)this.getFact("Summary", (String)metadata.get("executionSummary")));

    facts.put("title", FACTS_TITLE);
    facts.put("facts", factsList);

    return facts;
  }

  public HashMap<String, String> getFact(String name, String value) {
    HashMap<String, String> fact = new HashMap<>();

    fact.put("name", name);
    fact.put("value", value);

    return fact;
  }

  public List<HashMap> getPotentialAction() {
    List<HashMap> potentialAction = new ArrayList<>();
    HashMap<String, Object> action = new HashMap<>();
    ArrayList<String> targets = new ArrayList<>();

    targets.add((String)metadata.get("executionUrl"));

    action.put("@context", "http://schema.org");
    action.put("@type", "ViewAction");
    action.put("name", "View Execution");
    action.put("target", targets);

    potentialAction.add(action);

    return potentialAction;
  }

  private static String createRandomUUID() {
    return UUID.randomUUID().toString();
  }
}

根據我所閱讀的內容，看起來我應該為sections和PotalAction元素使用嵌套類，但我一直在努力解決如何實現嵌套類以輸出在這些數組中包含不同散列的數組。

到目前為止，我并不打算實現整個API，而是希望獲得一個特定的消息卡結構，如上面的JSON所示。不過，我們可能希望以后添加其他功能或使用不同的消息類型。

如果我們確實需要基于團隊API添加其他元素，如何改進此類以及如何構造此Java對象以使其更靈活？

推薦答案

您可以從為PotentialAction和Sections創建單獨的類開始。這是為了確保分離關注點。類似于：

class PotentialAction { 
  private List<HashMap> potentialAction;
  //all business logic to generate Potential Action goes in this class
}

class Sections {
 private List<HashMap> sections;
 //all business logic to generate Sections goes in this class
}

然后創建一個具有每個API所具有的最低要求(如元數據)的抽象類

abstract class APICommon {
 //compulsory attributes required by all api's
 private String accessToken;
}

現在定義特定于API的類以擴展抽象類

class API1 extends APICommon {
 // all the api specific attributes
  public String correlationId;
  public String summary;
  public String themeColor;
  private PotentialAction potentialAction;
  private Sections sections;
}

優勢：

通過將潛在的操作和節分離到不同的類中，現在分離了JSON的不同部分的業務邏輯，這不僅使代碼變得干凈，而且還可以在不同的API上重復使用。

/li>

如果您有其他需求，并且需要支持新的API，則只需從抽象類APICommon擴展另一個類即可。這可確保早期實現不受影響，并使您的設計具有可擴展性。

希望這會有幫助：)

這篇關于使用Jackson序列化的JSON的Java類實現的文章就介紹到這了，希望我們推薦的答案對大家有所幫助，