报表开发规范

172 阅读2分钟

开启掘金成长之旅!这是我参与「掘金日新计划 · 12 月更文挑战」的第9天,点击查看活动详情

数据层面—SQL性能优化规范

  • 明确字段,不取多余
  • 大表关联,先做过滤
  • 提取共性,减少重复
  • 减少不必要的扫描计算
  • 创建索引,有明确边界
  • 避免显式转换
  • 排序需放在最后一步
  • 决策报表中,尽量将多个数据集合并为同一个数据集,减少并发数量

工程层面—报表开发环境规范

开发环境规范

  • jar包与本地环境一致(jar包和插件一致)
  • J远程设计环境

开发环境规范

  • 权限控制
  • 一致性
  • 备份策略

报表层面—报表命名规范

目录命名规则

  • 见名知意,与业务模块相关,报表目录层级尽量不超过四层
  • 模板命名规则
  • 模板目录名+下划线+编号
  • 例如:MARKET_SALE_001
  • 编号可以按照制作顺序递增,不可重复 数据集命名规则
  • 参数面板数据集:以para_开头,例如地区选择下拉框的数据集para_area
  • 数据字典数据集:以dic_开头,例如产品映射字典数据集dic_product
  • 报表主题数据集:以report_开头,例如客户销售数据report_customerSaleData
  • 图表数据集:以chart_开头,例如产品占比图表chart_productRatiio 参数命名规则
  • 全局参数:以g开头,例如gSaleGroup,gProduct,gPerson
  • 模板参数:以p开头,例如pDate,pCurrency,pUnit
  • 数据集参数:以s开头,例如sCmompany,sProject

功能层面—功能实现方法规范

展示报表制作

  • 图块多的报表(如驾驶舱、大屏)使用frm开发,减少前端过滤的使用,尽量在数据集中过滤
  • 公式中也要注意格式
  • 大屏模板制作、用外置图片、否则非常影响 填报报表制作
  • 大数据填报报表尽量读写分离
  • 业务主键字段通常设置不可修改,如必须修改则应用数据库表中代理主键UUID字段做填报主键,新增数据时公式赋值新的额UUID 参数开发
  • 统一采用英文命名方式
  • 参数大小写一致,建议都用大写
  • 避免参数名称和fr系统参数重名,避免混淆 条件属性
  • 一个条件属性能解决的问题不要用多个条件属性
  • 尽量合并多个条件属性为一个
  • 隐藏行列一定不要直接隐藏行列!

UI层面—报表UI设计规范 风格一致,整体清爽 避免使用商用字体