${title}

导读

除了手动编写模拟数据脚本，用户也可以通过 AngusTester 应用中"数据"->"生成数据"编辑生成脚本，其生成的数据脚本与以下规范是一致的。

支持数据格式包括：CSV、CUSTOM、EXCEL、JSON、SQL、TAB、XML。

字段名称	类型	是否必须	数量/长度限制	描述
name	string	否	200	模拟数据名称，未设置脚本名称时，该名称会被设置到脚本名称。
description	string	否	800	模拟数据描述，未设置脚本描述时，该名称会被设置到脚本描述。
fields	object	否	1 ～ 200	定义组成数据字段，具体请查看下面模拟数据“字段”说明。
settings	object	否	/	模拟数据插件配置参数，用于指定生成数据格式和存储位置，具体查看下面模拟数据“设置”说明。

当前信息可以通过脚本规范"扩展字段"进行扩展。

一个模拟 CSV 格式数据示例：

mockData:
  name: User
  description: This is an example of generating CSV format data
  fields:
    - name: username
      type: string
      value: "@String(3,20)"
    - name: password
      type: string
      value: "@String(6,32)"
  settings:
    format: CSV
    rows: 100000
    batchRows: 200
    location: LOCAL
    lineEnding: UNIT_LF
    includeHeader: true

主要字段(fields)

字段名称	类型	是否必须	长度限制	描述
name	string	是	200	字段名称。
type	enum	是	/	字段类型，支持值 string、integer、boolean、number、object、array，默认：string。注意：`object、array 类型只在 JSON 格式中支持`。
value	string	否	8192	字段值，可以是常量值和 Mock 函数。

当前信息可以通过脚本规范"扩展字段"进行扩展。

一个字段的示例：

fields:
  - name: username
    type: string
    value: "@String(3,20)"
  - name: password
    type: string
    value: "@String(6,32)"

设置(setting)

字段名称	类型	是否必须	数量/长度限制	描述
format	string	是	40	生成数据格式，需要插件数据格式相对应，具体请查看“支持插件”中格式。
rows	integer	是	1 ～ 100,000,000,000	生成数据总行数。
batchRows	integer	否	1 ～ 10000	每次批量生成、存储或发送行数，默认 1。
location	enum	是	/	生成数据的存储位置。支持位置：DATASPACE、DATASOURCE、LOCAL、PUSH_THIRD，具体请查看"存储位置"。
storeRequest	object	否	/	Http 请求配置，当存储数据到`空间`或`推送到三方接口`时是必须的。注意：`只支持 POST 请求方法`。具体参数请查看“脚本规范”中 Http 请求配置。
*Plugin Parameters*	object	否	/	模拟数据插件独有配置参数，具体请查看下面“插件参数”。

当前信息可以通过脚本规范"扩展字段"进行扩展。

一个设置的示例：

settings:
  format: CSV
  rows: 100000
  batchRows: 200
  location: LOCAL
  lineEnding: UNIT_LF # CSV插件参数
  includeHeader: true # CSV插件参数

存储位置(location)

DATASPACE：数据空间存储，将数据存储到 AngusTester 应用"数据"->“文件数据”->“空间”。
DATASOURCE：数据源存储，将生成数据写入到客户数据库或 AngusTester 应用"数据"->“数据源数据”->“数据源”。
LOCAL：本地存储，生成数据会以文件形式存储在执行节点，您可以进入执行详情页面点击下载数据文件。默认存储路径：${AGENT_HOME}/data/exec/[执行ID]/data.[数据格式]。
PUSH_THIRD：推送三方接口，支持将生成数据以文本或文件形式发送到一个 Http 接口。

注意：当存储位置为三方接口（PUSH_THIRD）时，如果配置的是一个 HTTP 上传请求（ContentType 是 binary 或者 FormData 中有文件类型），会先生成完整数据文件，再上传文件到三方接口；如果配置的不是 Http 上传请求，会将生成数据以文本形式发送到三方接口，为了加快发送效率，建议将参数 batchRows 设置成 1000。

插件参数 [Plugin Parameters]

MockCsv

字段名称	类型	是否必须	长度限制	说明
lineEnding	enum	是	/	换行符，支持 `UNIT_LF` 和 `WINDOWS_CRLF`。
includeHeader	boolean	是	/	生成数据中是否包含字段名称的表头。

一个 CSV 配置示例：

lineEnding: UNIT_LF
includeHeader: true

MockCustom

字段名称	类型	是否必须	长度限制	说明
lineEnding	enum	是	/	换行符，支持 `UNIT_LF` 和 `WINDOWS_CRLF`。
includeHeader	boolean	是	/	生成数据中是否包含字段名称的表头。
escapeChar	char	否	1	转义符，用于转义引号字符或转义字符的字符，默认值 `\u0000`。
quoteChar	char	否	1	引用符，用于引用字段值的字符，默认值 `\u0000`。
separatorChar	char	否	1	分隔符，用于分隔条目值，默认值 `,`。

一个 CUSTOM 配置示例：

lineEnding: UNIT_LF
includeHeader: true
escapeChar: "'"
quoteChar: '"'
separatorChar: "|"

MockExcel

字段名称	类型	是否必须	长度限制	说明
includeHeader	boolean	是	/	生成数据中是否包含字段名称的表头。

一个 EXCEL 配置示例：

includeHeader: true

MockJson

字段名称	类型	是否必须	长度限制	说明
lineEnding	enum	是	/	换行符，支持 `UNIT_LF` 和 `WINDOWS_CRLF`。
includeNull	boolean	否	/	在 JSON 序列化过程中是否包含空值字段。
rowsToArray	boolean	否	/	是否将多个 JSON 对象（行）转换为数组。

一个 JSON 配置示例：

lineEnding: UNIT_LF
includeNull: true
rowsToArray: false

MockSql

字段名称	类型	是否必须	长度限制	说明
lineEnding	enum	是	/	换行符，支持 `UNIT_LF` 和 `WINDOWS_CRLF`。
tableName	string	是	200	存储数据表名称，生成 INSERT 语句的组成部分。
batchInsert	boolean	否	/	是否批量插入，设置成 true 时会将 `batchRows` 条数据合并成一条 INSERT 语句，默认 false。
storeDatasource	object	是	/	存储数据源配置，完整参数请查看“数据源配置参数”。

一个 SQL 配置示例：

lineEnding: UNIT_LF
tableName: '`user`'
batchInsert: true
storeDatasource:
  name: Store user datasource
  type: MYSQL
  driverClassName: com.mysql.cj.jdbc.Driver
  username: sample
  password: 123456
  jdbcUrl: jdbc:mysql://mysql01-sample.angusmock.cloud:3306/xcan_mockdata_sample

数据源配置参数(storeDatasource)：

字段名称	类型	是否必须	长度限制	说明
name	string	否	100	数据源名称。
type	enum	是	/	数据库类型，支持数据库类型：H2、HSQLDB、SQLITE、POSTGRES、MARIADB、MYSQL、ORACLE、SQLSERVER、DB2。
driverClassName	string	否	1s ～ 86400s	数据库驱动类名，如：com.mysql.cj.jdbc.Driver。
jdbcUrl	string	否	1 ～ 6	数据库连接 URL，如：jdbc:mysql://localhost:3306/mydatabase。
username	string	否	1 ～ 10	用户名。
password	string	否	1 ～ 10	密码。

一个数据源配置示例：

name: Store user datasource
type: MYSQL
driverClassName: com.mysql.cj.jdbc.Driver
username: sample
password: 123456
jdbcUrl: jdbc:mysql://mysql01-sample.angusmock.cloud:3306/xcan_mockdata_sample

MockTab

字段名称	类型	是否必须	长度限制	说明
lineEnding	enum	是	/	换行符，支持 `UNIT_LF` 和 `WINDOWS_CRLF`。
includeHeader	boolean	是	/	生成数据中是否包含字段名称的表头。

一个模拟 TAB 配置示例：

lineEnding: UNIT_LF
includeHeader: true

MockXml

字段名称	类型	是否必须	长度限制	说明
lineEnding	enum	是	/	换行符，支持 `UNIT_LF` 和 `WINDOWS_CRLF`。
rootElement	string	是	200	XML 数据的根元素名称。
recordElement	string	是	200	XML 数据的记录元素名称。

一个模拟 XML 配置示例：

lineEnding: UNIT_LF
rootElement: root
recordElement: row