仪表盘组件接口文档 V1.0.0
仪表盘组件接口文档 V1.0.0
接口类型说明
注册接口是在仪表盘初始化的时候调用的,这时候仪表盘还没有任何组件实例,所以注册接口所配置的是组件的静态信息
组件接口和系统接口,是在组件实例中使用的,属于组件运行时的接口,跟随着组件的生命周期,组件实例未创建之前、或者组件销毁以后无法调用。
组件接口、系统接口关系图
为什么需要区分组件接口与系统接口
理论上,只提供系统接口,组件也能完成业务。相比较而言,组件接口比系统接口的使用更为简单,一些我们认为相对固化功能由系统接管,组件就只提供一些必要的参数或处理一些回调,不用操作整个流程。类似于AOP(面向切面编程)思想,每一个组件接口就可以认为是一个切入点。所以组件接口主要是降低接口使用的难度,开发更简单。但并非所有接口都能做成组件接口,一些业务不固定,触发时机不确定的情况下,系统没法接管流程,这时组件只能自己使用系统接口完成整个流程的处理。
组件目录
组件目录目前仅要求有入口和组件实现类。
目录下也建议可按照功能进行拆分多几个文件,降低组件实体类的复杂度。
一般建议一个组件在一个目录下,这样组件独立性更强。实际上从机制来看,可以支持一个目录放置多个组件,多配置几个组件描述即可。