How to write Aviator function logic and syntax - DataWorks - Centro de documentación de Alibaba Cloud

DataService Studio permite escribir funciones y asociarlas con una API para utilizarlas como filtros. Este tema proporciona ejemplos sobre cómo escribir la lógica de las funciones mediante funciones Aviator y su sintaxis.

Escenarios

Si configura una función como prefiltro de una API, esta puede preprocesar los parámetros de solicitud de la API cuando se invoca.
Si configura una función como posfiltro de una API, esta puede reprocesar y transformar los valores de retorno de la API cuando se invoca.

Guía de uso

Para obtener más información sobre cómo crear, probar, confirmar, publicar, eliminar, mover y clonar funciones, consulte Manage functions, Test, publish, and use functions y Publish functions.
Para obtener más información sobre cómo usar funciones como prefiltros y posfiltros de API, consulte Create an Aviator function.
Para obtener más información sobre la sintaxis de las funciones Aviator, consulte Sintaxis de funciones.

Ejemplos de parámetros de entrada

Nota

En el código Aviator, el nombre de variable predeterminado $0 hace referencia a toda la entrada de la función.

Escenario 1: Uso de una función Aviator como prefiltro de API
En este escenario, los parámetros de solicitud de la API se utilizan como entrada completa de la función en una estructura JSON de un solo nivel. El siguiente ejemplo muestra los parámetros de solicitud como entrada de la función:
```
## The request parameter is user_id
## Multiple parameter values are passed when the API is called: user_id = (0,1,2)
{
  "user_id": [0,1,2]
}
```

Escenario 2: Uso de una función Aviator como posfiltro de API

En este escenario, el valor de retorno de la API se utiliza como entrada completa de la función en una estructura JSON de varios niveles. El siguiente ejemplo muestra un valor de retorno como entrada de la función:

## The return result contains three columns: user_id, city, and tags
## After the API is called, three matching data records are returned (see rows)
{
  "data": {
    "totalNum": 3,
    "pageSize": 10,
    "rows": [
      {
        "user_id": 2,
        "city": "BJ",
        "tags": "B,D,dongcs,ccccc"
      },
      {
        "user_id": 3,
        "city": "SH",
        "tags": "A,C,D,F"
      },
      {
        "user_id": 1,
        "city": "HZ",
        "tags": "A,B,C"
      }
    ],
    "pageNum": 1
  },
  "errCode": 0,
  "requestId": "0bb211c516357674333185698eb07b",
  "errMsg": "success",
  "apiLog": null
}

Ejemplos de uso de funciones

Escenario 1: Uso de una función Aviator como prefiltro de API. Los siguientes ejemplos muestran cómo utilizar la función:

Ejemplo 1: Al invocar la función, esta modifica el valor de un parámetro de solicitud enviado desde el cliente.

Función Aviator:

## For the request parameter user_id, the original value passed from the client is user_id=1
## After being processed by the filter, the actual value for the query is user_id=2
if $0.user_id == 1
{
    $0.user_id = $0.user_id + 1;
}
return $0;