更新时间:2024-12-12 GMT+08:00
分享

创建AstroZero自定义对象

操作场景

低代码平台支持开发者根据自身的业务需求,创建自定义对象(Custom Object)。自定义对象创建完成后,系统默认预置了一些标准字段,为了满足业务需求,往往还需修改标准字段或新建自定义字段,字段就是对象的属性描述。

在AstroZero中,创建一个自定义对象主要包括图1中几个步骤。

图1 创建自定义对象流程图

(可选)创建对象存放目录

对象默认存放在根目录下,在创建对象前,您可以先创建对象存放的目录,也可以在对象创建后将其拖拽到指定目录。

  1. 参考登录AstroZero新版应用设计器中操作,进入应用设计器。
  2. 在应用设计器的左侧导航栏中,选择“数据”
  3. 单击对象后的,为对象添加目录。

    图2 新建目录

  4. 设置对象目录的名称,单击“保存”

    新建对象目录的名称,不能超过60个字符。
    图3 设置目录名称

创建自定义对象

  1. 将鼠标放在(可选)创建对象存放目录中创建的目录上,单击,进入创建新对象页面。

    您也可以直接单击对象后的,进入创建新对象页面。
    图4 新建对象

  1. 设置对象基本信息,单击“确定”。

    图5 设置对象基本信息
    表1 新建对象参数说明

    参数

    说明

    对象名称

    新建对象的名称,用于在页面显示,创建后可修改。

    取值范围:1~80个字符。

    唯一标识

    新建对象的标识,是对象在系统中的唯一标识,创建后不支持修改。命名要求如下:

    • 长度不能超过63个字符,包括前缀命名空间和后缀“__CST”的长度。
      须知:

      名称前的内容为命名空间,在AstroZero中为了避免不同租户间数据的重名,租户在首次创建应用时需要先定义一个命名空间。一个租户只能创建一个命名空间,创建后不支持修改。

    • 必须以英文字母开头,只能由英文字母,数字或下划线组成,且不能以下划线结尾。

为对象添加字段

对象创建完成后,支持为对象添加字段、编辑字段和删除字段等。您也可以参照批量添加对象字段中操作,为对象批量添加字段。

  1. 在应用设计器的左侧导航栏中,选择“数据”。
  2. 将鼠标放在已创建的对象上,单击,选择“编辑”,进入对象设计器。
  3. 在对象设计器中,单击对象中的

    您也可以单击,直接进入图6页面,为对象添加字段。
    图6 为对象添加字段

  4. 在对象详情页面,单击“添加”,进入添加字段页面。
  5. 设置字段的基本信息,单击“确认”。

    图7 添加字段
    表2 添加字段参数说明

    参数

    说明

    显示名称

    请输入字段的名称,用于在页面显示,创建后可修改。

    取值范围:1~63个字符。

    唯一标识

    字段在系统中的唯一标识,创建后不支持修改。命名要求如下:

    • 长度不能超过63个字符,包括前缀命名空间和后缀“__CST”的长度。
      须知:

      名称前的内容为命名空间,在AstroZero中为了避免不同租户间数据的重名,租户在首次创建应用时需要先定义一个命名空间。一个租户只能创建一个命名空间,创建后不支持修改。

    • 必须以英文字母开头,只能由英文字母、数字或单下划线组成,且不能以下划线结尾。

    字段类型

    单击,在弹出的页面中,选择新建字段的类型。

    • 文本:允许用户输入任何字母和数字的组合,最多可输入255个字符。
    • 密文:允许用户输入任何字母和数字的组合,并且以加密格式存储,最多可输入111个字符。
    • 文本区:允许用户输入多行文本,最多可输入1,048,576字符。
    • 数字:允许用户输入任何数字,会删除前置零。
    • 百分比:允许用户输入百分比数字(例如"10"),并自动向数字添加百分号。
    • 电话:允许用户输入任何电话号码,系统会自动将其转换为电话号码格式。
    • 币种金额:允许用户输入其他币种金额,并将字段自动转换为币种金额格式。此功能在将数据导出到Excel或其它电子表格时非常有用。
    • 日期:允许用户输入日期或从弹出式日历中选择日期。
    • 日期/时间:允许用户输入日期和时间,或从弹出式日历中选择日期。当用户单击弹出式日历中的某个日期后,该日期和当前时间将输入到“日期/时间”字段。
    • 电子邮件:允许用户输入电子邮件地址,对其进行验证以确保格式正确。如果对于一个联系人和潜在客户指定了此字段,则用户单击“发送电子邮件”时可以选择地址。自定义电子邮件地址无法用于批量电子邮件。
    • 复选框:允许用户选择“真”(选取)或“假”(不选取)值。
    • 选项列表:允许用户从定义的列表中选择值。
    • 选项列表(多项选择):允许用户从定义的列表中选择多个值。
    • URL:允许用户输入任何有效的网址。当用户单击该字段时,该 URL 将在单独的浏览器窗口中打开。
    • 查找关系:创建一个将此对象链接到另一对象的关系。
    • 自动编号:使用用户定义的格式生成序列编号。该编号对于每条新记录会自动递增。
    • 公式:使用用户定义的公式表达式生成只读字段。任何表达式中使用的源字段有所更改,本字段值将更新。
    • 主从关系类型:在一个对象和另一个对象之间创建一种特殊类型的父子关系。详细记录的所有权是由主记录决定的。当用户删除主记录时,所有详细记录都将被删除。
    • 多语言:允许用户从自定义资源表中选择多种语言内容。
    • 附件:允许用户保存多个上传文件的地址,支持图片、文档等类型。

    数据长度

    根据实际需要,输入字段的长度。“字段类型”设置为“数字”时,才会显示该参数。

    小数位数

    根据实际需要,输入整数后的小数点位数。“字段类型”设置为“数字”时,才会显示该参数。

    描述

    请根据实际需要,输入字段的描述信息。

    取值范围:1~255个字符。

  6. (可选)管理对象中的字段。

    • 编辑已添加的字段
      1. 在对象的“字段”页签中,单击已添加的字段。
      2. 在右侧字段属性中,修改字段属性。

        不同类型的字段,此处展示的内容所有不同。此处以数字类型的字段为例,进行介绍。

        表3 编辑字段参数说明

        参数

        说明

        显示名称

        继承5中新建字段时输入的名称,支持再次编辑。

        唯一标识

        继承5中新建字段时输入的标识,不支持编辑。

        字段类型

        继承5中新建字段时指定的字段类型,不支持编辑。

        字段帮助

        请根据需要,在输入框中输入该字段提示的描述信息。

        描述

        请根据需要,在输入框中输入对该字段的描述信息。

        字段设置

        • 是否唯一:勾选,表示该字段唯一。
        • 是否必填:勾选,表示该字段为必填字段。
        • 是否可搜:是否能在前端开发者控制台或脚本中,使用search语句搜索该字段。search语句可以理解为sql语句的子集,系统支持大部分常用的sql查询语句。只需把sql查询语句开头的select关键词,修改为search即可。search语句特点和限制如下:
          • search语句当前对分组、通配符、去重distinct等功能暂不支持。
          • search语句不支持通配符,in查询可进行模糊查询。
          • search语句除了聚合函数(AVG、COUNT、MAX、MIN和SUM),其他必须带有where从句,否则报错。
          • 字符串类型默认都转为es中text类型,因此可以实现分词的倒排索引。由于默认未设置Fielddata=on(会很耗性能),所以字符串类型无法排序。
          • 不支持search语句where从句中,有非可搜索字段,如不支持search from myobject where t1 = 'abc' (此处t1为非可搜字段)。
          • search语句目前只可进行单表搜索。
          • search语句不支持HAVING子句、OFFSET。
          • search语句不支持同时普通查询和聚合,例如不支持“search count(列名),列名 from 列表名;”。
          • search语句不支持列表别名后“.*”全部查询,例如不支持“search T.* from table as T where ...;”。
          • text类型采用了英语分词器,因此大小写单复数不敏感,“movie”可匹配“Movies”。
          • 同sql语句一样,search语句也大小写不敏感。
        • 大小写敏感:大小写是否敏感,例如,“ABC”“abc”为相同值,表示大小写不敏感,“ABC”“abc”为不同值,则表示大小写敏感。

        数据长度

        继承5中新建字段时指定的字符长度,支持修改。字段长度不支持缩短,例如新建字段时设置的数据长度设置为18,此处输入的值需大于18。

        小数点后位数

        继承5中新建字段时指定的小数点后位数,支持修改。小数位数不支持缩短,例如新建字段时设置的小数位数为2,此处输入的值需大于2。

        默认值

        请根据需要,在输入框中输入该字段的默认值。默认值长度需小于等于“数据长度”

      3. 设置完成后,单击“保存”
    • 隐藏系统预置的标准字段。

      “字段”页签中,单击右上角的,可选择隐藏系统预置的标准字段,默认不隐藏。

    • 删除已添加的字段。

      只支持删除自定义字段,系统预置字段不支持删除。字段删除后不可恢复,请谨慎操作。

      1. “字段”页签中,选中待删除的字段。
      2. 在右侧字段属性设置中,单击“删除字段”
      3. 在弹出的确认框中,单击“删除”,即可删除该字段。

为对象添加索引

对象创建完成后,支持为对象添加索引。一个实体上最多允许定义10个自定义索引。创建索引的好处在于,通过索引可确保数据的唯一性、加快数据的检索速度、加快表之间的连接、减少分组和排序时间等。

  1. 在应用设计器的左侧导航栏中,选择“数据”。
  2. 将鼠标放在已创建的对象上,单击,选择“编辑”,进入对象设计器。
  3. 在对象设计器中,单击对象中的,进入对象详情页。
  4. 在“索引”页签,单击“添加”。
  5. 设置索引信息,单击“保存”。

    图8 设置索引信息
    表4 添加索引参数说明

    参数

    说明

    显示名称

    新建索引的名称,用于在页面显示,创建后可修改。

    取值范围:1~63个字符。

    唯一标识

    新建索引的标识,是索引在系统中的唯一标识,创建后不支持修改。命名要求如下:

    • 取值范围:1~63个字符。
    • 必须以英文字母开头,只能由英文字母,数字或下划线组成,且不能以下划线结尾。

    索引类型

    选择新建索引的类型,支持普通索引和唯一索引。

    • 普通:允许被索引的数据列包含重复的值,可按需选择绑定的字段数。
    • 唯一:被索引的数据列不包含重复值,保证数据记录的唯一性,必须绑定两个字段。

    默认值:普通。

    字段

    索引关联的数据字段,要求如下:

    • 文本、密文、文本区、复选框、选项列表(多项选择)、公式、多语言和附件字段类型不支持创建索引。
    • 使用关联字段(查找关系与主从关系)创建索引时,必须绑定两个及以上字段。

  6. (可选)管理对象中的索引。

    • 编辑已添加的索引
      1. “索引”页签,选中已添加的索引。
      2. 在右侧的索引属性面板中,根据表4中的参数说明修改索引。
    • 删除已添加的索引
      1. 在“索引”页签,单击索引列表中的索引。
      2. 在右侧的索引属性面板中,单击“删除索引”。
      3. 在弹出的删除确认框中,单击“删除”,即可删除该索引。

        索引删除后不可恢复,请谨慎操作。

为对象添加验证规则

对象创建后,支持为对象添加校验规则。通过添加校验规则,可确保数据的正确性和有效性。例如,某个销售信息的对象,其中字段A为销售收入,字段B为销售利润,可以增加“字段B的值不能大于字段A”的规则进行校验。

  1. 在应用设计器的左侧导航栏中,选择“数据”。
  2. 将鼠标放在已创建的对象上,单击,选择“编辑”,进入对象设计器。
  3. 单击对象中的,进入对象详情页。
  4. 在“验证”页签,单击“添加”,进入添加验证页面。
  5. 设置验证的基本信息,单击“保存”。

    图9 添加验证
    表5 添加校验规则参数说明

    参数

    说明

    显示名称

    新建校验规则的名称,用于在页面显示,创建后可修改。

    取值范围:1~63个字符。

    唯一标识

    新建校验规则的标识,是验证规则在系统中的唯一标识,创建后不支持修改。命名要求如下:

    • 取值范围:1~63个字符。
    • 必须以英文字母开头,只能由英文字母,数字或下划线组成,且不能以下划线结尾。

  6. (可选)管理对象中的验证规则。

    • 编辑验证规则
      1. 在“验证”页签,单击验证列表中的验证。
      2. 在右侧的验证属性面板中,修改验证规则。
        • 显示名称:修改验证在界面的展示名称。
        • 唯一标识:验证规则的唯一标识,不支持修改。
        • 描述:验证规则的描述信息。
        • 是否启用:是否使用该验证规则。
        • 验证公式:设置验证规则的公式。在输入框中,可下拉选择元素,选择后自动插入到当前光标位置。
          图10 验证公式

          设置对象验证规则的公式时,在输入框中,可下拉选择元素,鼠标放在对应元素上有相应验证公式的描述说明。

        • 错误信息:设置错误信息,提示验证失败的原因。
      3. 修改完成后,单击“保存”
    • 删除验证规则
      1. 在“验证”页签,单击验证列表中的验证。
      2. 在右侧的验证属性面板中,单击“删除验证”。
      3. 在弹出的删除确认框中,单击“删除”,即可删除该验证。

        验证删除后不可恢复,请谨慎操作。

为对象添加清理任务

为对象预置初始的清理规则,来自动删除已过期的数据记录。例如,当对象的创建时间字段,距离当前时间超过12个月,且状态字段等于失效,则将对应的数据删除。此处配置的清理规则,会包含在应用包中,被安装到目标运行环境。

  1. 在应用设计器的左侧导航栏中,选择“数据”。
  2. 将鼠标放在已创建的对象上,单击,选择“编辑”,进入对象设计器。
  3. 单击对象中的,进入对象详情页。
  4. 在“清理”页签中,单击“启动清理任务”
  5. 在任务清单中,指定根据哪个日期字段来进行清理。

    仅支持选择当前对象的,所有日期类型的字段。

    图11 指定字段

  6. 指定待存留时间。

    当该记录的指定字段值超过了该期限后,清理任务自动处理该记录。

  7. 单击“新增”,指定记录匹配条件,仅清除符合条件的记录。

    图12 指定匹配条件

  8. 设置清理动作,单击“保存”。

    选择动作为删除任务,即清理任务直接删除符合条件的记录。

    图13 清理动作

  9. (可选)管理对象的清理任务。

    • 重置清理规则

      “清理”页签,单击已创建清理任务中的“重置”,即可重置清理规则。

    • 关闭清理任务

      “清理”页签,单击已创建清理任务中的“关闭清理任务”,即可关闭清理任务。

为对象添加数据

添加数据前,请确保已参考为对象添加字段中操作,添加自定义字段。此处以创建年龄(age)、性别(gender)字段为例(系统已预置name字段),添加一条简单的数据记录。您也可以参考批量导入对象数据中操作,为对象批量添加数据。

  1. 在应用设计器的左侧导航栏中,选择“数据”。
  2. 将鼠标放在已创建的对象上,单击,选择“编辑”,进入对象设计器。
  3. 单击对象中的,进入对象详情页。
  4. “数据”页签,单击“添加”。
  5. 在下方表格中,按要求录入所需数据,录入完成后数据自动保存。

    图14 录入数据后效果

设置对象出厂数据

出厂数据是指在开发期间就已经确定好的配置数据,会在应用包中携带,在部署应用时会安装到环境中。通过设置出厂数据,可帮助开发团队简单易用的准备实例化数据,缩短应用交付的端到端时间。

  1. 在应用设计器的左侧导航栏中,选择“数据”。
  2. 将鼠标放在已创建的对象上,单击,选择“编辑”,进入对象设计器。
  3. 单击对象中的,进入对象详情页。
  4. “数据”页签,单击“设置出厂数据”。
  5. 设置出厂数据,单击“保存”。

    • 请选择要包含的出厂数据:应用包中,最多允许总共包含1万条出厂数据。
      • 全部选择:当前对象里的所有数据,都包含在应用包中。选择全部后,打包时会包含对象当前所有的记录。
      • 手工选择:逐条勾选对象里的数据,打包时会包含这些已选择的记录。
    • 请选择出厂数据的安装策略。
      • 增量数据:对象里包含的出厂数据,会增量添加到环境中,仅添加新记录,环境上已有重复记录则跳过。例如,设备管理应用中,增加了几种设备规格,需要添加到环境中。
        • 如果环境中已存在相同ID的数据,则看是否是出厂数据。如果是,则看是否被更新过。只有未更新过的出厂数据会被覆盖。
        • 如果环境中不存在此数据,则作为增量的新数据写入到环境中。
      • 固定数据:对象里包含的出厂数据是应用本身的一部分,载入环境后这些数据不可被更改、删除。每次应用升级时,会用应用包里新的出厂数据直接覆盖环境上的数据。例如,客户管理应用中预置了个人客户、组织客户两种客户类型数据。
        • 环境中该对象仍然可以插入其他业务数据。
        • 应用升级时,固定数据会全部替换成新的出厂数据。例如,环境上已有A、B、C三条固定数据,新版本应用包中包含A、B、D三条固定数据。升级后,C会被删除,D会被新增。
      • 样例数据:对象里包含的出厂数据,仅在应用首次安装到环境时载入,后续应用升级时不再更新。该策略用来支撑应用在各种演示环境上的安装,如调查问卷应用首次安装时,携带了样例问卷。

    字段设置为出厂数据后,在编辑修改出厂数据时,界面会提示:“此数据为出厂数据,请谨慎修改”。

    图15 修改出厂数据提示

    开发应用时,如果修改了某个对象的出厂数据安装策略。在应用升级时,会以新的安装策略为准,即对包含在出厂数据里的记录ID做变更,变更规则如表6所示。

    表6 变更规则

    安装策略

    样例数据(新)

    固定数据(新)

    增量数据(新)

    样例数据(旧)

    -

    如果环境上之前是样例数据,不管是否修改过,升级时根据ID完全覆盖为固定数据。如果出厂数据中,不包含该ID,则不处理。

    如果环境上之前是样例数据,不管是否修改过,升级时根据ID完全覆盖为增量数据。如果出厂数据中,不包含该ID,则不处理。

    固定数据(旧)

    因为是升级,所以不会写入新样例数据。而出厂数据已经不是固定数据了,因此直接删除之前的全部固定数据。

    -

    环境上数据如果在出厂数据中,则覆盖为增量数据且状态为未修改。如果不在出厂数据中,则直接删除。

    增量数据(旧)

    因为是升级,所以不会写入新样例数据,仅清除该环境数据的策略。

    环境上数据如果出现在出厂数据中,则覆盖为固定数据。如果不在出厂数据中,则仅清除该环境数据的策略。

    -

  6. (可选)如果需要修改出厂数据,再次单击“设置出厂数据”,在右侧属性面板中进行修改即可。

    • 通过“手动选择”,取消部分数据的勾选。
    • 修改“安装策略”,重新选定策略即可。
    • 单击属性面板中的“清除”,表示取消全部数据的出厂设置。

  7. 应用打包。

    • 导出的安装包,默认包含出厂数据。
      图16 导出安装包
    • 导出的补丁包,出厂数据在打包过程中选择。
      图17 导出补丁包
      图18 添加出厂数据

相关文档