SuperAPI AI 工具集

ui5-best-practices

通用与其它

查看项目

更新于 10-15 22:10

技能介绍

用途:该技能用于在编写 UI5 应用时强制执行源自 SAP 官方指南的开发标准,覆盖编码规范、工具集成、CAP 集成与表单创建四大领域。

主要能力与规则:

  1. 模块加载:禁止全局访问框架对象(如 sap.m.Button),必须用 sap.ui.define 显式声明依赖,或用 sap.ui.require 动态加载;TypeScript 用 import;XML 视图控件按标签自动加载,格式化器/类型用 core:require。
  2. 组件初始化:用 sap/ui/core/ComponentSupport 声明式初始化根组件,嵌套组件通过 manifest.json 的 component usages 管理。
  3. 数据绑定:优先使用 OData 类型(sap/ui/model/odata/type/*),其次简单类型,再次自定义类型,最后自定义格式化器(仅单向绑定)。自定义类型用于需要双向绑定校验的场景。
  4. 国际化:开发时只改 i18n.properties 基础文件;S/4HANA 及使用 Translation Hub/TEW 的应用不得手动编辑本地化文件。
  5. 安全:禁止内联脚本、内联样式与 style 属性,逻辑放 JS/TS 文件,样式放 CSS 文件。
  6. TypeScript 事件:UI5 >= 1.115.0 使用控件专属事件类型(如 Button$PressEvent);旧版本用通用 Event。
  7. MCP 工具:用 get_api_reference 查 API,用 run_ui5_linter 校验与修复(修复前需用户确认);UI5 CLI 开发服务器不提供默认 index 文件,需用完整路径 http://localhost:8080/index.html。
  8. CAP 集成:UI5 项目建在 CAP 根目录 app/ 下,安装 npm i -D cds-plugin-ui5,从 CAP 根目录运行 cds watch 或 cds run,不要单独启动 UI5 服务器,也不要配置 ui5-middleware-simpleproxy。
  9. 表单:除非明确要求,避免 SimpleForm,改用 Form 加 ColumnLayout,默认 M 2 列、L 3 列、XL 4 列。

限制:具体安装步骤、版本兼容细节与完整 API 列表以官方文档为准,资料未提供更多收费或平台信息。