雪豹商情数据分析报告(xuebao dashboard)

组织商情数据成完整的报表形式展现给用户。

项目结构

main.go                 程序入口
config.go               程序配置结构
app/                    echo应用
    app.go              app入口
    config.go           app配置结构 
    model/              db表模型定义
    service/            功能服务
    handler/            echo handlers
utils/                  程序用到的工具包
cmds/                   辅助命令工具
    cmd_load_data/      加载测试数据
    cmd_start_swagger/  启动swagger服务
docs/                   swag生成的api描述文件
examples/               测试文件
files/                  测试和文档用到的文件
Makefile                一些常用功能命令

数据库设计

数据源(datasource)

数据域	类型	说明	参数
file	json	json文件	{"path": "path/to/ds.json"}
file	yaml	yaml文件	{"path": "path/to/ds.yaml"}
db	sqlite3	sqlite3数据库	{"dsn": "path/to/test.db"}
db	mysql	mysql数据库	{"dsn": "user:password@/dbname?charset=utf8&parseTime=True&loc=Local"}
db	postgres	postgres数据库	{"dsn": "host=myhost port=myport user=gorm dbname=gorm password=mypassword"}

图表(chart)

每个图表数据来自一个特定数据源，由数据参数指定获取数据的方式，图表参数描述具体的绘图方式。

数据参数(目前)

对于文件数据源， 使用key_path指定数据层次，如果为空，相当于取整个文件数据；当文件内容是一个map形式时，key_path以点分隔每一层的字段。

// file.{json,yaml}
{"key_path": "a.b"}

对于数据库数据源，使用sql来进行查询。

// db.{sqlite3,mysql,postgres}
{"sql": "select key, val from xx_key_val"}

图表参数(目前)

在没有和前端协商更细致的图表样式抽象格式之前，图表参数目前只有一个plot_js，代表一段js代码，eval执行之后返回一个function，带两个参数mountNode和data，如下为基础柱状图:

{"plot_js":"(function(node, data) { var chart = new G2.Chart({ container: node, forceFit: true }); chart.source(data); chart.scale('sales', { tickInterval: 20 }); chart.interval().position('year*sales'); chart.render(); }) "}

报表(dashboard)

每一个报表可以有0个或多个子报表(父ID关联，order排序)，以此组织报表，可以对报表划分章节。key可以对报表分组，比如：同一类报表的不同期应该是相同的key。如何以后有对周期报表的更多需求，再重构。

布局json(layout_json)字段组织报表内容的排版，形式为一个组件树。

报表布局

组件属性: id, type, meta, children

组件	name	说明
标题	Header
分隔线	Divider
行容器	Row
列容器	Col
图表	Chart	各种图表
文本	Text	支持各种格式:markdown等
标签页	Tabs,Tab	使用标签切换内容
TODO: 各个组件meta属性和组合规则

API

进入项目目录, 执行如下命令:

# make
# ./cmd_load_data -d files/test_data.json //加载测试数据
# ./xbdar //启动server
# ./cmd_start_swagger //启动swagger

访问http://localhost:7070/

展示接口

Dashboard

• 分页查询报表信息
• 查询单个报表信息（递归包括子报表）

Chart

• 分页查询图表信息
• 查询单个图表信息
• 获取图表数据

管理接口

管理后台和其它应用对接使用的接口。 TODO