介绍

什么是 amis

amis 是一个低代码前端框架,它使用 JSON 配置来生成页面,可以减少页面开发工作量,极大提升效率。

为什么要做 amis?

在经历了十几年的发展后,前端开发变得越来越复杂,门槛也越来越高,要使用当下流行的 UI 组件库,你必须懂 npmwebpackreact/vue,必须熟悉 ES6 语法,最好还了解状态管理,比如 Redux,如果没接触过函数式编程,光入门都很费劲,而入门之后会发现它还有巨大的 生态,相关的库有 2347 个,很多功能相似,挑选成本高。

然而前端技术的发展不会停滞,等学完这些后可能会发现大家都用 Hooks 了、某个打包工具取代 Webpack 了……

而有时候其实只想做个普通的增删改查界面,用于信息管理,类似下面这种:

  1. {
  2. "title": "浏览器内核对 CSS 的支持情况",
  3. "remark": "嘿,不保证数据准确性",
  4. "type": "page",
  5. "body": {
  6. "type": "crud",
  7. "draggable": true,
  8. "syncLocation": false,
  9. "api": "/api/mock2/sample",
  10. "keepItemSelectionOnPageChange": true,
  11. "autoGenerateFilter": true,
  12. "bulkActions": [
  13. {
  14. "type": "button",
  15. "label": "批量删除",
  16. "actionType": "ajax",
  17. "api": "delete:/api/mock2/sample/${ids|raw}",
  18. "confirmText": "确定要批量删除?"
  19. },
  20. {
  21. "type": "button",
  22. "label": "批量修改",
  23. "actionType": "dialog",
  24. "dialog": {
  25. "title": "批量编辑",
  26. "name": "sample-bulk-edit",
  27. "body": {
  28. "type": "form",
  29. "api": "/api/mock2/sample/bulkUpdate2",
  30. "body": [
  31. {
  32. "type": "hidden",
  33. "name": "ids"
  34. },
  35. {
  36. "type": "input-text",
  37. "name": "engine",
  38. "label": "Engine"
  39. }
  40. ]
  41. }
  42. }
  43. }
  44. ],
  45. "quickSaveApi": "/api/mock2/sample/bulkUpdate",
  46. "quickSaveItemApi": "/api/mock2/sample/$id",
  47. "headerToolbar": [
  48. "bulkActions",
  49. {
  50. "type": "button",
  51. "label": "重置测试数据",
  52. "actionType": "ajax",
  53. "size": "sm",
  54. "api": "/api/mock2/sample/reset"
  55. },
  56. "export-excel",
  57. {
  58. "type": "tpl",
  59. "tpl": "一共有 ${count} 行数据。",
  60. "className": "v-middle"
  61. },
  62. {
  63. "type": "columns-toggler",
  64. "align": "right",
  65. "draggable": true
  66. },
  67. {
  68. "type": "drag-toggler",
  69. "align": "right"
  70. }
  71. ],
  72. "footerToolbar": ["statistics", "switch-per-page", "pagination"],
  73. "columns": [
  74. {
  75. "name": "id",
  76. "label": "ID",
  77. "width": 20,
  78. "sortable": true,
  79. "type": "text",
  80. "searchable": {
  81. "type": "input-text",
  82. "name": "id",
  83. "label": "主键",
  84. "placeholder": "输入id"
  85. }
  86. },
  87. {
  88. "name": "browser",
  89. "label": "Browser",
  90. "searchable": {
  91. "type": "select",
  92. "name": "browser",
  93. "label": "浏览器",
  94. "placeholder": "选择浏览器",
  95. "options": [
  96. {
  97. "label": "Internet Explorer ",
  98. "value": "ie"
  99. },
  100. {
  101. "label": "AOL browser",
  102. "value": "aol"
  103. },
  104. {
  105. "label": "Firefox",
  106. "value": "firefox"
  107. }
  108. ]
  109. }
  110. },
  111. {
  112. "name": "platform",
  113. "label": "平台",
  114. "popOver": {
  115. "trigger": "hover",
  116. "body": {
  117. "type": "tpl",
  118. "tpl": "就是为了演示有个叫 popOver 的功能"
  119. }
  120. },
  121. "sortable": true,
  122. "type": "text"
  123. },
  124. {
  125. "name": "grade",
  126. "label": "CSS 等级",
  127. "type": "select",
  128. "options": ["A", "B", "C", "D", "X"]
  129. },
  130. {
  131. "type": "operation",
  132. "label": "操作",
  133. "width": 100,
  134. "buttons": [
  135. {
  136. "type": "button",
  137. "actionType": "ajax",
  138. "label": "删除",
  139. "confirmText": "您确认要删除?",
  140. "api": "delete:/api/mock2/sample/$id"
  141. }
  142. ]
  143. }
  144. ]
  145. }
  146. }

这个界面虽然用 Bootstrap 及各种前端 UI 库也能做出个大概,但仔细观察会发现它有大量细节功能,比如:

  • 可以对数据做筛选
  • 有按钮可以刷新数据
  • 编辑单行数据
  • 批量修改和删除
  • 按某列排序
  • 可以隐藏某些列
  • 可以调整列顺序
  • 自动生成顶部查询区域
  • 可调整列宽度
  • 开启整页内容拖拽排序
  • 表格有分页(页数还能同步到地址栏,不过这个例子中关了)
  • 有数据汇总
  • 支持导出 Excel
  • 「渲染引擎」那列的表头有提示文字
  • 鼠标移动到「平台」那列的内容时还有放大镜符号,可以展开查看更多
  • 如果往下拖动还有首行冻结来方便查看表头(因为文档页面的限制,这个功能在这里看不出来)

全部实现这些需要大量的代码。

但可以看到,用 amis 只需要 157 行 JSON 配置(其中 47 行只有一个括号),你不需要了解 React/VueWebpack,甚至不需要很了解 JavaScript,即便没学过 amis 也能猜到大部分配置的作用,只需要简单配置就能完成所有页面开发。

这正是建立 amis 的初衷,我们认为:对于大部分常用页面,应该使用最简单的方法来实现,甚至不需要学习前端框架和工具。

用 JSON 写页面有什么好处

为了实现用最简单方式来生成大部分页面,amis 的解决方案是基于 JSON 来配置,它的独特好处是:

  • 不需要懂前端:在百度内部,大部分 amis 用户之前从来没写过前端页面,也不会 JavaScript,却能做出专业且复杂的后台界面,这是所有其他前端 UI 库都无法做到的;
  • 不受前端技术更新的影响:百度内部最老的 amis 页面是 6 年多前创建的,至今还在使用,而当年的 Angular/Vue/React 版本现在都废弃了,当年流行的 Gulp 也被 Webpack 取代了,如果这些页面不是用 amis,现在的维护成本会很高;
  • 享受 amis 的不断升级:amis 一直在提升细节交互体验,比如表格首行冻结、下拉框大数据下不卡顿等,之前的 JSON 配置完全不需要修改;
  • 可以 完全 使用 可视化页面编辑器 来制作页面:一般前端可视化编辑器只能用来做静态原型,而 amis 可视化编辑器做出的页面是可以直接上线的。

amis 的其它亮点

  • 提供完整的界面解决方案:其它 UI 框架必须使用 JavaScript 来组装业务逻辑,而 amis 只需 JSON 配置就能完成完整功能开发,包括数据获取、表单提交及验证等功能,做出来的页面不需要经过二次开发就能直接上线;
  • 大量内置组件(120+),一站式解决:其它 UI 框架大部分都只有最通用的组件,如果遇到一些稍微不常用的组件就得自己找第三方,而这些第三方组件往往在展现和交互上不一致,整合起来效果不好,而 amis 则内置大量组件,包括了富文本编辑器、代码编辑器、diff、条件组合、实时日志等业务组件,绝大部分中后台页面开发只需要了解 amis 就足够了;
  • 支持扩展:除了低代码模式,还可以通过 自定义组件 来扩充组件,实际上 amis 可以当成普通 UI 库来使用,实现 90% 低代码,10% 代码开发的混合模式,既提升了效率,又不失灵活性;
  • 容器支持无限级嵌套:可以通过嵌套来满足各种布局及展现需求;
  • 经历了长时间的实战考验:amis 在百度内部得到了广泛使用,在 6 年多的时间里创建了 5 万页面,从内容审核到机器管理,从数据分析到模型训练,amis 满足了各种各样的页面需求,最复杂的页面有超过 1 万行 JSON 配置。

amis 不适合做什么?

使用 JSON 有优点但也有明显缺点,在以下场合并不适合 amis:

  • 大量定制 UI:JSON 配置使得 amis 更适合做有大量常见 UI 组件的页面,但对于面向普通客户(toC)的页面,往往追求个性化的视觉效果,这种情况下用 amis 就不合适,实际上绝大部分前端 UI 组件库也都不适合,只能定制开发。
  • 极为复杂或特殊的交互
    • 有些复杂的前端功能,比如 可视化编辑器,其中有大量定制的拖拽操作,这种需要依赖原生 DOM 实现的功能无法使用 amis。
    • 但对于某些交互固定的领域,比如图连线,amis 后续会有专门的组件来实现。

阅读建议

  • 如果你是第一次接触 amis,那么请 务必认真阅读完概念部分,它会让你对 amis 有个整体的认识
  • 如果你已经掌握 amis 基本概念,且有一定的开发经验,需要参考 amis 组件相关文档的同学,那么请移步 组件文档

让我们马上开始吧

点击页面底部的下一篇,继续阅读文档。