本帖最后由 Lay.Li 于 2024-11-5 18:09 编辑
前端
规则
- 命名规则：基于业务，创建统一的命名规则。例如，使用"模块_功能"的命名规则创建"purchase_list"的页面名称。
- 分类规则：根据模块功能划分相应的文件目录，以便更好的管理和维护。
- 引用规则：建议给要引用的单元格和表格列命名，这样引用时使用单元格或者列名称，更容易理解和维护。
- 注释规则：建议在一些重要或者复杂的命令或者单元格中添加注释，以便后续的维护。
页面布局设计
- 在开始开发页面之前，应该要先设计页面的总体布局。布局定义了页面的大致结构(如左右，上中下，左中右等)。
- 如果团队中有设计师，请遵循设计师设计的布局结构。
- 如果团队中没有设计师的话，可以选择活字格中提供的页面模板作为基本布局。
- 根据业务需求，应该事先设计好多种页面类型，比如导航菜单页面，主页，列表页面，详情页面，卡片页面等
页面样式设计
- 建议页面给页面设置流式布局，以便最终网页可以在不同屏幕的设备中自适应，可以参考流式布局。
- 为每种页面类型定义统一的单元格样式。例如对于表单页面，对按钮，输入框，表格等都定义为"提交"的单元格样式。
- 建议使用主题颜色和字体定义单元格样式。这样切换主题时，相应的颜色和字体会自动变化。
- 当许多页面需要使用相同的背景图片时，建议使用主题图片。这样在修改背景图片时，只需要修改主题的背景图片，不需要单独修改每个页面的背景图片。
- 页面拉伸模式避免选择为等比拉伸(填满宽度)，因为这可能会导致性能问题。
交互逻辑
网站的交互逻辑是指用户与网站之间交互所涉及的规则和过程。良好的交互逻辑可以提高网站的可用性、功能性、可靠性和用户满意度，网站的交互逻辑是网站设计和开发过程中至关重要的一步。
- 命令-在活字格汇总，使用三种命令让用户处理交互逻辑。
| 命令类型 | 触发时机 | 备注 | | 普通命令 | 根据单元格类型触发，比如按钮的点击，文本框的值变更 | 通常用于页面的交互逻辑，比如导航到另一个页面，弹出消息框等 | | 模板命令 | 在单元格命令中调用 | 用于普通命令的复用 | | 服务端命令 | 可以在页面单元格命令，服务端命令，计划任务或者第三方程序中调用 | 重要或复杂的业务逻辑（如操作数据表）应在服务器命令中处理，要做好前端和后端之间的分离。 |
- 公式-活字格中的公式类似于excel中的公式，用于执行计算或者操作数据的数据表达式。可以参考Excel公式
- 校验-在用户使用应用的时候，适当的错误处理和提示是至关重要的。
- 对输入做校验很重要，通过校验，可以防止给应用中存入不正确，不恰当或者有害的数据。根据业务需求，使用数据验证功能定义对应的校验规则
- 对于特殊或者重要的操作，应该给予用户警告。比如删除数据时，应该提示用户是否确认操作。
- 当用户的操作有业务逻辑的错误是，应该给予清晰和合理的错误信息。
- 消息通知是必不可少的，尤其是对于流程审批业务。推荐使用服务端通知功能实现实时通知的需求。
服务端
服务端命令建议
- 根据业务需求为命令，参数，返回值等创建统一的命名规则。
- 根据业务需求，将实现同一模块业务逻辑的命令放在同一个文件夹中，以便进行高效的管理和维护。
- 为命令，参数，返回值和其他重要的关键内容创建注释。
- 如果服务端命令只能由其他的服务端命令/计划任务调用，那么应该设置为私有的服务端命令。
- 构建服务端命令时应该独立于前端的数据，只处理基本的业务逻辑。
- 在构建服务端命令/WebAPI时，应考虑到之后与第三方系统集成的可能性。
- 设置参数的数据验证和服务端命令的调用权限
- 在第三方系统需要调用服务端命令时，根据需要做第三方授权验证
- 封装服务端命令的返回结果，提供标准化的返回值。
- 使用异常捕获命令处理服务端命令内部的逻辑错误，确保可以正确的执行回滚操作，并为最终用户提供明确的错误信息。
- 在服务端命令操作数据表数据时，使用事务命令确保数据的一致性
- 根据业务需求选择合适的隔离级别，较低的隔离级别通常提供更好的并发性能，但可能会导致数据一致性问题，而较高的隔离级别可以提供更强的数据一致性保证，但可能会降低并发性能。
- 合理的使用数据表操作命令，调用存储过程命令和sql命令。活字格内置的数据表操作命令使用起来比较简单方便。但是如果内置命令不能满足复杂的业务场景或性能要求，可以使用调用存储过程命令或执行SQL命令。建议由经验丰富的数据库管理人员执行此类操作。
运行维护建议
- 使用管理控制台的监控和日志功能，监控应用的运行状态和查看应用的日志记录。
- 对于每个发布的应用，默认情况下需启用除http请求之外所有的日志模块，http请求将记录每个http请求的日志，这些请求将包含大量日志内容。
- 开启服务管理器中的定时备份功能，定时备份服务器中所有已发布的应用。
- 开启设计器中的保存时备份功能，以防工程文件丢失。
- 如果应用使用的内置数据库，活字格的备份功能也会备份内置数据库，如果使用外连数据库，请在外连数据库中开启自动备份功能。
- 如果应用程序的附件文件路径是默认路径，活字格的备份功能可以备份附件文件。但如果将附件文件路径更改为其他文件路径，请自行备份附件文件。
|
|
陕公网安备：61019002000258 |
隐私政策 |
网站地图