返回給前端樣式數據整合Swagger

對於前端樣式整合swagger，只對接口作加強，不對接口邏輯作修改，當json樣式拼接完成，咱們把json轉爲對應的實體類便可。

前端json樣式對象構造參考：https://workshops.otrs365.cn/web/#/132?page_id=1248

針對前端樣式，這次抽出5個公共模塊類，下面對這些類進行展開敘述

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

ReturnData 返回給前端的數據(最外層)

ReturnData<T,L,O>

/**
 * @param <T> FormStyle裏面Data的泛型
 * @param <L> ListHead裏面的字段的具體屬性
 * @param <O> OverviewList,通常與數據庫表屬性對應
 * @Description:
 * @author: 張重虎
 * @Date: 2021/6/2 9:31
 * @Copyright: Xi'an Dian Tong Software Co., Ltd. All Rights Reserved.
 * @Version 1.0
 */
@Data
@ApiModel
public class ReturnData<T,L,O> {
    @JsonProperty("tableStyle")
    @ApiModelProperty(value = "表格樣式")
    private Tablestyle<L,O> tablestyle;
    @ApiModelProperty(value = "表單樣式")
    @JsonProperty("formStyle")
    private Formstyle<T> formstyle;
}

View Code

 

ReturnData<T,L,O>使咱們能高度自定義返回的樣式

前端界面以簡單的FormStyle和TableStyle展開拼接

 

 

FormStyle （返回給前端的表單樣式）

FormStyle裏面有兩個基本屬性: data和order。data裏面是一個個order對象，對象裏面是具體的屬性

Formstyle<T>

@lombok.Data
@ApiModel
public class Formstyle<T> {
    @ApiModelProperty(value = "頁面表單字段具體樣式")
    private T data;
    @ApiModelProperty(value = "頁面表單展現字段")
    private List<String> order;
}

 

 

Data對應一個泛型，泛型裏面定義Data的基本屬性，通常如下屬性就夠了，多的在繼承這個類，而後進行擴展便可

FormStyleDataGeneric:

@Data
@ApiModel
public class FormStyleDataGeneric {
    @JsonProperty("default")
    @ApiModelProperty(value = "默認值")
    private String defaults;

    @ApiModelProperty(value = "展現")
    private String display;

    @JsonProperty("promptCode")
    @ApiModelProperty(value = "0，不作提示；1，展現在文本框內；2，展現在字段下方；,3，展現圖標在字段尾部進行提示；4，以紅色提示展現在字段下方")
    private int promptcode;

    @ApiModelProperty(value = "表單提交到後臺的 Key")
    private String name;

    @ApiModelProperty(value = "可選項")
    private JSONObject options;

    @JsonProperty("disabledClear")
    @ApiModelProperty(value = "可清除/可擦除")
    private int disabledclear;

    @JsonProperty("promptMessage")
    @ApiModelProperty(value = "提示信息")
    private String promptmessage;

    @ApiModelProperty(value = "翻譯信息展現在左側的 Label 中")
    private String label;

    @ApiModelProperty(value = "字段類型。文本：Text，下拉選：Dropdown，樹：SelectTree，複選框：Checkbox，時間類型：DateTime（年月日-時分秒），Date（年月日）")
    private String type;
}

View Code

 

FormStyleDataGeneric裏面的屬性對應前端界面效果

 

 

Formstyle<T> ，T 若是FormStyleDataGeneric裏面的屬性不知足，則自定義一個便可

使用方法 Formstyle<FormStyleDataGeneric>

TableStyle （返回給前端的表格樣式）

TableStyle<L,O>

@Data
@ApiModel
public class Tablestyle<L,O> {
    @JsonProperty("PreferenceFields")
    @ApiModelProperty(value = "表格中表頭字段")
    private List<String> preferencefields ;

    @ApiModelProperty(value = "可配置數據")
    private List<String> configData ;


    @ApiModelProperty(value = "表格數據總數")
    private int total;

    @JsonProperty("OverviewList")
    @ApiModelProperty(value = "表格中具體某條數據")
    private List<O> overviewlist;

    @JsonProperty("ListHeader")
    @ApiModelProperty(value = "表頭字段的具體屬性")
    private L listheader;
}

View Code

 

TableStyle<L,O>對應頁面屬性說明

 

 

看得出來，TableStyle<L,O>裏面有兩個泛型，若是基本的屬性知足不了咱們，咱們自定義一個類，而後傳進去便可。另外，泛型O通常是對應咱們數據表的那個dao實體類，直接傳進去便可

泛型L,L表明ListHeader裏面的屬性，就是表頭字段的屬性，在小島這裏看不出來，咱們用另外一個界面對這些屬性進行解讀。

定義ListHeader<T>的時候，咱們根據數據表dao去定義屬性，而後加上泛型T便可

ListHeader<T> , 這個T咱們通常傳ListHeaderGeneric就夠了，若是須要添加其餘字段，就自定義一個泛型，往裏面傳便可

@Data
@ApiModel
public class Listheader<T> {
    @ApiModelProperty(value = "模板")
    private T template;

    @ApiModelProperty(value = "流程")
    private T process;

    @JsonProperty("featureCode")
    @ApiModelProperty(value = "特徵碼")
    private T featurecode;

    @JsonProperty("communicationConfigName")
    @ApiModelProperty(value = "通信地址名稱")
    private T communicationconfigname;

    @JsonProperty("dataPackageName")
    @ApiModelProperty(value = "數據包名稱")
    private T datapackagename;

    @JsonProperty("changeBy")
    @ApiModelProperty(value = "修改者")
    private T changeby;

    @JsonProperty("changeTime")
    @ApiModelProperty(value = "修改時間")
    private T changetime;

    @JsonProperty("createBy")
    @ApiModelProperty(value = "建立者")
    private T createby;

    @JsonProperty("createTime")
    @ApiModelProperty(value = "建立時間")
    private T createtime;

    @ApiModelProperty(value = "名稱")
    private T name;

    @JsonProperty("operationType")
    @ApiModelProperty(value = "操做類型")
    private T operationtype;

    @ApiModelProperty(value = "備註")
    private T comment;

    @ApiModelProperty(value = "說明")
    private T direction;
}

View Code

 

ListHeaderGeneric

@Data
@ApiModel
public class ListHeaderGeneric {
    @JsonProperty("SortBy")
    @ApiModelProperty(value = "排序:0可排序，1不可排序")
    private int sortby;

    @JsonProperty("Label")
    @ApiModelProperty(value = "標籤")
    private String label;

    @JsonProperty("FilterKey")
    @ApiModelProperty(value = "過濾key，表明該字段可進行過濾")
    private String filterkey;
}

View Code

 

 

 

TableStyle<L,O>使用方法TableStyle<ListHeader<ListHeaderGeneric>,Overviewlist>

特殊狀況

返回的數據比ReturnData更多

以Communication通信地址爲例

ps:之後統一返回首字母大寫的駝峯命名，好比FormStyle而不是formStyle

 

 

數據除了formStyle和tableStyle，還額外多了個myParameter

 

 

對應這種狀況，咱們繼承ReturnData<T, L, O>進行擴展便可,若是還需對增長的屬性進行說明，就在定義一個泛型便可

CommunicationTableData

@Data
@EqualsAndHashCode(callSuper = true)
@ApiModel
public class CommunicationTableData<T, L, O> extends ReturnData<T, L, O> {
    @ApiModelProperty(value = "本島相關信息(小島id,小島地址)")
    private JSONObject myParameter;
}

 

返回的數據爲裏面那層(Tablestyle)

好比數據包裏面

 

 

看着像Tablestyle，可是又比Tablestyle多了幾個屬性，那咱們就能夠自定義一個ReturnData,讓它直接繼承Tablestyle，再作擴展

或者不繼承TableData，直接寫一個ReturnData類，裏面包含這些屬性

@Data
@ApiModel
public class TableData<L,S,O> {
    @JsonProperty("PreferenceFields")
    @ApiModelProperty(value = "默認展現的表頭信息")
    private List<String> preferencefields ;

    @ApiModelProperty(value = "搜索表單字段集合")
    private S searchFormDataOrder ;

    @ApiModelProperty(value = "可配置數據")
    @JsonProperty("PreferenceDisable")
    private String preferenceDisable ;


    @ApiModelProperty(value = "表格數據總數")
    private int total;

    @ApiModelProperty(value = "表格中具體某條數據")
    @JsonProperty("OverviewList")
    private List<O> Overviewlist;

    @JsonProperty("ListHeader")
    @ApiModelProperty(value = "表頭數據集合")
    private L listheader;
}

View Code

 

返回的數據爲裏面那層(Formstyle)

好比通信地址編輯界面

 

 

看着結構就是Formstyle，可是ReturnData中的兩個屬性都是Formstyle(通常是一個Formstyle和一個Tablestyle)，針對這種狀況，咱們直接寫一個新的ReturnData

/**
 * @param <T> BaseGenericEditData
 * @param <L> CommunicationGenericEditData
 * @Description:
 * @author: 張重虎
 * @Date: 2021/6/2 15:43
 * @Copyright: Xi'an Dian Tong Software Co., Ltd. All Rights Reserved.
 * @Version 1.0
 */
@Data
@ApiModel
public class CommunicationEditData<T,L> {

    @ApiModelProperty(value = "基礎樣式")
    @JsonProperty("base")
    private Formstyle<T> base;

    @ApiModelProperty(value = "通信地址樣式")
    @JsonProperty("communicationConfig")
    private Formstyle<L> communicationConfig;
}

View Code

 

可是這兩個Formstyle裏面的屬性不一致，因此咱們須要分開來定義兩個泛型

 

 

上面兩個泛型，其實都是能夠經過數據表的dao實體類控制，直接傳實體類進去便可。可是爲了方便區分，我定義了兩個泛型 <T> BaseGenericEditData，<L> CommunicationGenericEditData

BaseGenericEditData:

@Data
@ApiModel
public class BaseGenericEditData<T> {

    @ApiModelProperty(value = "名稱")
    private T name;

    @ApiModelProperty(value = "是否用與中聯BH")
    @JsonProperty("isOnlyForZlbh")
    private T isonlyforzlbh;

    @ApiModelProperty(value = "遠程系統id")
    @JsonProperty("remoteSystemId")
    private T remotesystemid;

    @ApiModelProperty(value = "通信地址")
    @JsonProperty("communicationAddress")
    private T communicationaddress;

    @ApiModelProperty(value = "通信key")
    @JsonProperty("communicationKey")
    private T communicationkey;

    @ApiModelProperty(value = "有效id")
    @JsonProperty("validId")
    private T validid;
}

View Code

 

CommunicationGenericEditData:

@Data
@ApiModel
public class CommunicationGenericEditData<T> {
    @JsonProperty("requestTimes")
    @ApiModelProperty(value = "每分鐘最大請求次數")
    private T requesttimes;

    @ApiModelProperty(value = "發送超時時限")
    private T overtime;

    @ApiModelProperty(value = "是否重連")
    @JsonProperty("isReconnection")
    private T isreconnection;

    @ApiModelProperty(value = "是否自動重連")
    @JsonProperty("reconnectionTimes")
    private T reconnectiontimes;

    @ApiModelProperty(value = "自動重連次數")
    @JsonProperty("reconnectionInterval")
    private T reconnectioninterval;

    @ApiModelProperty(value = "日誌等級")
    @JsonProperty("logLevel")
    private T loglevel;
}

 

如小島的轉入轉出規則中，preferenceFields在前端展現成了小寫。

 

 

而模板中PreferenceFields是大寫，對於這種狀況，是之前遺留的問題，沒有較好的規範，致使大小寫很隨意。

 

 

對於這種狀況，咱們確定不能由於一個字段就重寫整個類。這時候，咱們只須要繼承Tablestyle，而後把改字段重寫便可。

 

 

 

返回的數據爲其餘數據

其餘複雜的界面，若是包含了基礎的ReturnData屬性，先繼承，在寫一個ReturnData類作其餘擴展屬性，不然根據具體狀況，自定義ReturnData

舉例1

小島通信地址：getFromDataForAddOrUpdata

 

 

沒整合Swagger以前，返回值泛型是JSONObjec，直接返回jsonRes

 

 

整合以後，泛型JSONObject就變爲具體的對象Communication< >對象