Fizz企業級微服務API閘道器進階系列教程-服務編排處理列表資料(上)-展開與合併

語言: CN / TW / HK

概述

服務編排是Fizz閘道器提供的一個強大的功能,能夠基於現有的業務微服務通過線上配置的方式快速的生成一個聚合介面,減少中間層膠水程式碼以及降低編碼投入。在服務編排中支援使用函式,本進階教程中我們分三篇文章(上篇:列表展開&合併、中篇:列表提取&關聯、下篇:列表欄位重新命名&欄位移除)來介紹資料列表類函式的使用。

本文為服務編排處理列表資料系列的上篇。

函式

函式是服務編排提供的一個強大又便捷的功能,通過將一些常用的邏輯封裝成函式,在服務編排中使用函式對服務編排過程的資料進行處理,從而簡化我們的配置又能實現複雜的功能。

函式分類

版本要求:v2.3或以上版本

函式以fn.開頭,如fn.date.timestamp(), date為類別, 閘道器內建了以下幾大類函式

  • 公共類 fn.common
  • 日期類 fn.date
  • 字串類 fn.string
  • 編解碼類 fn.codec
  • 數學類 fn.math
  • 資料列表類 fn.list

引用值

在函式裡支援使用引用值,如:

fn.string.concat({step1.result.channelCode},{step1.result.nonce})

{step1.result.channelCode} 表示引用值, 引用step1的結果

fn.string.concat({step1.result.channelCode},{g.account.name})

{g.account.name} 表示引用值, 引用公共資源“account.name”, 以g開頭表示引用公共資源

巢狀呼叫

支援多重巢狀呼叫,如:

fn.codec.md5(fn.date.add(fn.date.add("2021-07-09 22:44:55", "yyyy-MM-dd HH:mm:ss", 1, fn.math.addExact(999,1)), "yyyy-MM-dd HH:mm:ss", fn.math.addExact(0,1), 1000))
fn.string.toUpperCase(fn.codec.sha256(fn.string.concat({step1.result.channelCode},{step1.result.nonce},{step1.result.timestamp},{step1.result.appSecret})))

資料列表類函式

函式 返回值型別 用途 引數說明
fn.list.expand(
List<List<Object>> data)
List<Object> 將二維陣列(列表)展開為一維陣列(列表),
如:
data=[[{a:1}],[{a:2}],[{a:3}]]
fn.list.expand(data)
返回:[{a:1},{a:2},{a:3}]
data: 二維陣列(列表)
fn.list.merge(
List<Object>... data)
List<Object> 將多個列表合併成一個,如:
data1=[{a:1}]
data2=[{a:2}]
data3=[{a:3}]
fn.list.merge(data1,data2,data3)
返回:[{a:1},{a:2},{a:3}]
data: 列表,可多個
fn.list.extract(
List<Map<String, Object>> data,
String... fields)
List<Map<String, Object>> 只提取列表裡的部分欄位,如:
data=[
{a:1,b:4,c:7},
{a:2,b:5,c:8},
{a:3,b:6,c:9}
]
fn.list.extract(data, "a", "c")
返回:[
{a:1,c:7},
{a:2,c:8},
{a:3,c:9}
]
data: 列表
fields: 【可選】欄位,可多個
fn.list.join(
List<Map<String, Object>> dest,
List<Map<String, Object>> src,
String joinField,
String... fields)
List<Map<String, Object>> 合併2個列表欄位,可只合並指定欄位,如:
dest=[
{a:1,b:4,c:7},
{a:2,b:5,c:8},
{a:3,b:6,c:9}
]
src=[
{a:1,d:444,e:777},
{a:2,d:555,e:888}
]
fn.list.join(dest,src, "a", "d")
返回:[
{a:1,b:4,c:7,d:444},
{a:2,b:5,c:8,d:555},
{a:3,b:6,c:9}
]
dest: 目標列表
src: 被合併的列表
joinField: 兩個列表關聯的欄位
格式:
dest列表的關聯欄位:src列表的
關聯欄位,如:userName:uname,
如果兩個列表的關聯欄位一樣可
只填一個,如:userName
fields: 【可選】被合併列表裡需合併的欄位,可多個,不填則合併所有欄位
fn.list.rename(
List<Map<String, Object>> data,
String... fieldPairs)
List<Map<String, Object>> 重新命名列表裡的部分欄位,如:
data=[
{a:1,b:4,c:7},
{a:2,b:5,c:8},
{a:3,b:6,c:9}
]
fn.list.rename(data, "a:apple", "c:cat")
返回:[
{apple:1,b:4,cat:7},
{apple:2,b:5,cat:8},
{apple:3,b:6,cat:9}
]
data: 列表
fieldPairs: 【可選】需重新命名
的欄位對,可多個。格式:
原欄位名:新欄位名,如:c:cat
fn.list.removeFields(
List<Map<String, Object>> data,
String... fields)
List<Map<String, Object>> 刪除列表裡的部分欄位,如:
data=[
{a:1,b:4,c:7},
{a:2,b:5,c:8},
{a:3,b:6,c:9}
]
fn.list.removeFields(data, "b")
返回:[
{a:1,c:7},
{a:2,c:8},
{a:3,c:9}
]
data: 列表
fields: 【可選】需刪除的
欄位,可多個

資料準備

Fizz閘道器安裝

可參考: https://www.fizzgate.com/fizz/guide/installation

底層服務介面

本文服務編排呼叫的底層服務介面原始碼可從github(https://github.com/wehotel/fizz-examples)獲取。從github克隆最新的fizz-examples原始碼,並啟動fizz-examples-rest-api服務。

aggr_fn_list_demo_backend_1

aggr_fn_list_demo_backend_2

管理後臺(選單位置:RPC管理->服務宣告)配置服務宣告,如圖所示。

aggr_fn_list_demo_backend_3

新增編排介面

管理後臺,選單位置:服務編輯->介面列表,點選新增。

列表展開 fn.list.expand

本例子在編排介面中呼叫底層fizz-examples-rest-api服務的/fn-list/user-basic-info-list-by-roles/{roleList}介面(介面原始碼:FnListController )來獲取使用者基本資訊列表,並對該介面的響應資料進行列表展開以滿足我們想要的資料格式。

基礎資訊

aggr_fn_list_expand_1

配置輸入

在配置輸入中可以定義介面的入參和請求頭等資訊,如果不配置入參或請求頭,閘道器會原樣接收呼叫方傳過來的所有入參或請求頭,但不會對接收到的引數做任何校驗。在本例子中我們不需要入參,全留空。

配置步驟

新增1個步驟step1,然後在步驟step1裡新增1個請求request1,服務選擇我們預先準備好的fizz-examples-rest-api服務,請求/fn-list/user-basic-info-list-by-roles/developer,manager介面。配置響應部分留空,閘道器會原樣接收介面的返回結果。

aggr_fn_list_expand_2

配置輸出

在配置輸出中我們使用step1.request1.response.body.*來引用配置步驟中請求的響應結果(相關引用值的使用方式可參考文件:資料轉換使用文件 )。

配置要返回給前端的響應報文,這裡配置了響應體有以下欄位:

code:引用型別,值為步驟step1中請求request1的響應的code欄位;

message:引用型別,值為步驟step1中請求request1的響應的message欄位;

data:引用型別,值為步驟step1中請求request1的響應的data欄位並用fn.list.expand函式對其進行展開。

aggr_fn_list_expand_3

測試

直接呼叫/fn-list/user-basic-info-list-by-roles/developer,manager介面得到的響應如圖所示。

aggr_fn_list_expand_4

測試介面得到響應如圖所示。

aggr_fn_list_expand_5

從測試介面的響應可以看出服務編排介面已完成了對/fn-list/user-basic-info-list-by-roles/developer,manager介面的請求並正確對響應的data欄位的列表進行了展開。

列表合併 fn.list.merge

本例子在編排介面中兩次呼叫底層fizz-examples-rest-api服務的/fn-list/user-basic-info-list-by-roles/{roleList}介面(介面原始碼:FnListController )來獲取使用者基本資訊列表,並對該介面的兩次呼叫響應資料進行列表合併以滿足我們想要的資料格式。

基礎資訊

aggr_fn_list_merge_1

配置輸入

在本例子中我們不需要入參,全留空。

配置步驟

新增1個步驟step1,在步驟step1裡新增1個請求request1,服務選擇fizz-examples-rest-api,請求/fn-list/user-basic-info-list-by-role/admin介面。在步驟step1裡新增1個請求request2,服務選擇fizz-examples-rest-api,請求/fn-list/user-basic-info-list-by-role/manager介面。

aggr_fn_list_merge_2

aggr_fn_list_merge_3

配置輸出

配置要返回給前端的響應報文,這裡配置了響應體有以下欄位:

code:引用型別,值為步驟step1中請求request1的響應的code欄位;

message:引用型別,值為步驟step1中請求request1的響應的message欄位;

data:引用型別,值為步驟step1中請求request1的響應的data欄位與step1中請求request2的響應的data欄位並用fn.list.merge函式對其進行合併。

aggr_fn_list_merge_4

測試

直接呼叫/fn-list/user-basic-info-list-by-role/admin介面得到的響應如圖所示。

aggr_fn_list_merge_5

直接呼叫/fn-list/user-basic-info-list-by-role/manager介面得到的響應如圖所示。

aggr_fn_list_merge_6

測試介面得到響應如圖所示。

aggr_fn_list_merge_7

從測試介面的響應可以看出服務編排介面已完成了對/fn-list/user-basic-info-list-by-role/admin介面的請求和對/fn-list/user-basic-info-list-by-role/manager介面的請求並正確對兩次呼叫的響應的data欄位的列表進行了合併。

Fizz閘道器介紹

Fizz Gateway 是一個基於 Java開發的微服務聚合閘道器,能夠實現熱服務編排聚合、自動授權選擇、線上服務指令碼編碼、線上測試、高效能路由、API稽核管理、回撥管理等目的,擁有強大的自定義外掛系統可以自行擴充套件,並且提供友好的圖形化配置介面,能夠快速幫助企業進行API服務治理、減少中間層膠水程式碼以及降低編碼投入、提高 API 服務的穩定性和安全性。

官網:https://www.fizzgate.com

GitHub: https://github.com/wehotel/fizz-gateway-community

碼雲:https://gitee.com/fizzgate/fizz-gateway

入門教程:https://www.fizzgate.com/fizz/guide/GettingStarted/

進階教程:https://www.fizzgate.com/fizz/guide/advanced/


作者:ZHONG.J