eeplat:Open Source Metadata PaaS
开始学习的时候只是下了整个项目并且跑通,顺手在这个平台自动化的建立 了个管理系统,接下来开始深入研究这个开源平台
所谓元数据(metadata)即描述数据的数据(data about data),在EEPlat中,对于描述业务系统(包括业务数据、逻辑和UI)的元数据我们称之为模型(model)或声明式业务对象(Declarative Domain Object),下面图文中元数据、模型、声明式业务对象的概念可以互相替换,如下图:
元模型体系
在模型的基础上,EEPlat又进行了进一步的抽象,称之为元模型(metamodel),这样又进一步提高了系统的灵活性和可扩展性。 EEPlat拥有世界领先的元模型体系。元模型是声明式业务对象的模型,声明式业务对象由元模型描述。EEPlat元模型体系是对企业信息化、电子政务等信息化领域业务的高度抽象,拥有自描述和动态扩展特性,能准确得完成业务领域模型的描述。 元模型从承担职责的角度分为功能元模型、业务对象元模型、服务元模型、规则元模型、工作流元模型、组织元模型、UI元模型等。
业务对象元模型主要描述业务功能的静态结构,服务元模型主要完成业务逻辑,同时负责业务对象元模型之间的交互;工作流元模型主要完成业务流程及业务对象元模型的协作;组织元模型通过组织元模型之间的职责关系可以实现灵活的组织结构,UI元模型是菜单、面板、表格、表格元素、功能树等的UI模型的元模型,可以实现复杂的界面表现,如下图:
- EEPlat元模型是声明式业务对象的模型,是对信息管理系统的合理抽象。在元模型体系下,声明式业务对象是通过元数据(配置数据)进行描述。
- 声明式业务对象在EEPlat执行引擎的引导下形成用户可用的界面、逻辑等构成的业务系统,本质上执行引擎对EEPlat元数据的解析。
- 对应于OMG提出的MOF,EEPlat只有三层:
- 信息层(information layer):利用EEPlat开发的信息管理系统
- 模型层(model layer):声明式业务对象
- 元模型层(metamodel layer):EEplat元模型
总线的基本概念
- 数据总线是业务对象之间共享数据、交换数据的唯一媒介。
- 数据总线存在存、取两种操作。
- 数据总线的生命周期是是Session,也就是说从用户会话开始到用户会话结束数据总线是一贯和连续的。
- 数据总线是线程独享的、线程安全的,一个线程对数据总线的改变不会影响到其他线程对数据总线的使用,每个线程都是使用的总线的副本。
数据总线的构成方式
数据总线有下面几部分构成,每个组成部分我们称之为节点:
FORM节点
FORM的构建
FORM的类型是BOInstance。 FORM指对HTTP GET的QueryString的封装或对HTTP POST 数据的封装,它可以是界面上FORM的值,也可以是通过AJAX方式传递的参数。如/mvccontroller/a=1&b=2&c=3,那么FORM的构建过程是这样的: BOInstance form = new BOInstance(); form.putValue(“a”,”1”); form.putValue(“b”,”2”); form.putValue(“c”,”3”);
FORM的获取
DOService的参数是怎样获取FORM的值的?
首先,参数的类型是FORM,确定是从总线的FORM中取值。 其次,查看参数是否配置了属性?
- 如果配置了属性
如果parameterValue得到的是null,参数还会按照“没有配置属性”取值。
- 如果没有配置属性
如果parameterValue得到的是null,参数会查看是否配置了默认值,如果配置了默认值则取默认值,否则直接返回null。
当使用API时,可以通过SessionContext.getInstance().getFormInstance()获取Form 节点
USER节点
USER的构建
USER的类型是BOInstance。 FORM指对登陆用户封装,USER是在登陆自定义动作里面创建的。
//service 是指根据用户名、密码查询登陆用户的服务 users = service.invokeSelect(); if (users != null && users.size() > 0) { BOInstance user = (BOInstance) users.get(0); SessionContext us = (SessionContext) request.getSession().getAttribute( "userInfo"); if(us == null){ us = new SessionContext(); request.getSession().setAttribute("userInfo", us); } /为用户添加他的岗位: user.putValue("stationuid", user.getValue("fdgangweiid")); ///为用户添加他所在的部门: user.putValue("deptuid", "tt"); us.setUser(user); }
USER的更改
例: 把当前用户名改为admin,界面皮肤改为red
- WEBService 方式
/eeplat/servicecontroller?dataBus=setUserContext&contextKey=username&contextValue=admin& contextKey=skin&contextValue=red
- 代码方式
SessionContext.getInstance().getUser().putValue("username", "admin"); SessionContext.getInstance().getUser().putValue("skin", "red");
USER的获取
参数关于对USER获取有5中类型分别是:
- TYPE_LOGIN_ID:
获取登陆用户的UID,如果为空则返回’666666’。
- TYPE_LOGIN_NAME:
获取登陆用户的名称,如果为空则返回null。
- TYPE_LOGIN_MAIN_DEPT:
获取用户所在的部门uid。USER在构建过程中必须添加deptuid的值才可以获取到,否则返回null。
- TYPE_LOGIN_MAIN_STATION:
获取用户的岗位uid。USER在构建过程中必须添加stationuid的值才可以获取到,否则返回null。
- TYPE_LOGIN_KEY:
根据缺省值里面的配置返回USER在构建过程中对应的值,可以得到USER里面的所有的值。可以用这种类型得到前四种类型的值,前四种类型其实是这种类型的特例,如TYPE_LOGIN_MAIN_STATION 这个类型可以用TYPE_LOGIN_KEY 代替,只要在缺省值里面配置字符串’stationuid’;并且还要更灵活,如果表达岗位不用stationuid, 我们只要在缺省值里面配置相应的字符串。
当使用API时,可以通过SessionContext.getInstance().getUser()获取User节点
GLOBAL节点
注意,下面描述的GLOBAL节点内容,只有EEPlat 2014或后续版本才支持。
创建:
- WEBService 方式
- 代码方式
获取:
- WEBService 方式
- 代码方式
ECHO_STR节点
创建: SessionContext.getInstance().getThreadContext().setEchoValue(echoValue)
获取:
- WEBService 方式
/eeplat/servicecontroller?dataBus=getContext
- 代码方式
SEARCH_LIST节点
创建:
- WEBService方式
/eeplat/servicecontroller?dataBus=setContextColl&contextKey=?contextValue=?&contexValue=?
- 代码方式
SessionContext.getInstance().getThreadContext().setInstances(paras)
获取:
- WEBService方式
/eeplat/servicecontroller?dataBus= getContextColl
- 代码方式
SessionContext.getInstance().getThreadContext().getInstances()
CURRENT节点
- 代码方式
获取当前业务对象被选择的数据:
SessionContext.getInstance().get("业务对象ID或业务对象")
把数据设置为当前选择:SessionContext.getInstance().put("业务对象ID或业务对象",BOInstance)
- WEBService方式
见下述“总线操作”。
总线操作
假设webmodule名称为:eeplat,总线的操作一般不单独进行,为了减少网络调用,一般和面板操作和服务操作放在一起进行。总线操作中 URL:/eeplat/mvccontroller 和 /eeplat/servicecontroller操作是等效的,下面以/eeplat/servicecontroller为例,假设操作的业务对象UID分别为class0001,class0002,class0003…名称分别为classanole1, classanole2, classanole...业务对象的数据的UID为instance1, instance2, instance3…。
总线操作一般是指对总线的CURRENT节点进行的操作。
第一类Restful WebService总线写操作
/eeplat/servicecontroller? callType=initOnly&contextClassUid=class0001contextInstanceUid=instance1
这个URL表示更新总线上的业务对象class0001的值为instance1。 initOnly表示只操作总线不做其它动作。
第一类Restful WebService总线写操作方式只有对总线的写操作,没有读操作。
第二类Restful WebService总线写操作
新的参数
- dataBus
对总线的操作类型
- contextKey
总线上键的名称,一般指的是业务对象的名称,注意contextClassUid是业务对象的uid.
- contextValue
总线上对应于键的值,和contextInstanceUid概念基本一致。
总线操作的分类
- 总线操作按读写分为:总线读操作,总线写操作
- 按操作内容的不同分为:
- 平台级操作:操作的内容是业务对象、业务对象实例。
- 用户级操作:操作的内容是自定义的JSON格式对象。
总线写操作
- 平台级操作:支持批量写操作,可以同时更新多个业务对象的总线上的值。如:
/eeplat/servicecontroller? callType=initOnly &dataBus=setContext&contextKey=classanole1&contextValue=instance1&contextKey= classanole2&contextValue= instance2 在这里,contextKey是业务对象的主键, contextValue是业务对象实例的主键;如果contextKey和contextValue只写一对,就是对单个对象的的总线操作。
- 用户级操作:可以在总线上写入自定义的数据结构,并且键也可以不是业务对象的主键。如:
/eeplat/servicecontroller?callType=initOnly&dataBus=setContext&contextCustKey=menumodel&contextCustValue={'value':'500000'} 在这里,contextCustKey可以不是业务对象的主键, contextCustValue必须是json格式的字符串。
总线读操作
- 平台级操作:
获取总线上业务对象对应的实例的UID
/eeplat/servicecontroller?dataBus=getContext&contextKey=classanole1
获取总线上业务对象对应的实例的完整信息(JSON格式)/eeplat/servicecontroller?dataBus=getFullContext&contextKey=classanole1
- 用户级操作:
/eeplat/servicecontroller?dataBus=getFullContext&contextCustKey=classanole1 /eeplat/servicecontroller?dataBus=getCustContext&contextCustKey=classanole1 这两种写法等效,都是获取用户自定义数据的完整信息(JSON格式)
JAVA代码操作
读操作
DOBO theBO = DOBO.getByName("业务对象名称");//或者去业务对象 BOInstance bi = theBO.getCorrInstance(); 或 BOInstance bi = DOGlobals.getInstance().getSessoinContext().get(theBO); 或 BOInstance bi = DOGlobals.getInstance().getSessoinContext().get(theBO.getObjUid());
写操作
DOBO theBO = DOBO.getByName("业务对象名称");//或者去业务对象 theBO.refreshContext(boinstance); 或 DOGlobals.getInstance().getSessoinContext().put(业务对象, boinstance) 或 DOGlobals.getInstance().getSessoinContext().put(业务对象ID, boinstance)
面板操作
假设webmodule名称为:wd,面板的ID为:0000001;面板Name为:pane_anole
根据面板ID获取面板的内容
/eeplat/mvccontroller?paneModelUid=0000001
根据面板Name获取面板的内容
/eeplat/pane_anole.pml
服务操作
服务操作的数据类型全部是json格式的字符串。假设webmodule名称为:wd:
基本URL及传递参数
- 基本URL为:/eeplat/servicecontroller
- 传递参数采用标准URL的方式,如
/eeplat/servicecontroller? contextServiceName=test&userName=anole&password=anolesoft
如何调用服务
- 以ID的方式调用(ID为0000001)
/eeplat/servicecontroller? contextServiceUid=0000001
- 以Name 的方式调用(服务名称为test):
查询操作类型
- 查询返回的结果是以数组组织的数据
[{‘id’:’china’,’location’:’beijing’},{},{}] /eeplat/servicecontroller? contextServiceName=test &callType=sa
- 查询返回的结果是like map方式的结构的数据
- 查询返回的结果是全部以数组方式组织的数据,不过是返回业务对象的id和name两个值
- 只返回一个值
- 查询分页
上述url表示获取第10页的数据,每页含有50条数据。
修改操作类型
- 只执行当前的服务(不执行对应的规则),返回的结果是一条json记录数据
/eeplat/servicecontroller? contextServiceName=test&callType=us
- 执行当前的服务包括规则:
返回的结果是一个json 字符串:格式为 {‘returnPath’:’’, //执行服务后界面上需要连接的路径(可以是多个) ’ targetPane’:’’, //路径所显示的目标面板 (可以是多个)
‘returnValue’:’’}//返回数据总线上ECHO_STR节点的值
调用JAVA Class
假设需要调用的类全名为:com.exedosoft.Hello,Hello必须实现com.exedosoft.plat.action.Action接口。 下面介绍有返回值的情况,如果不需要返回记录,下面的三种调用类型任选其一就可以。
返回的结果是一条记录
/eeplat/servicecontroller? userDefineClass=com.exedosoft.Hello&callType=as
返回的结果被存放在总线的 GLOBAL_UID节点中。 所以com.exedosoft.Hello 需要调用
SessionContext.getInstance().getThreadContext().setInstance(bi);对总线赋值。
返回的结果是以数组组织的多条记录
/eeplat/servicecontroller? userDefineClass=com.exedosoft.Hello&callType=aa
返回的结果被存放在总线的 SEARCH_LIST节点中。 所以com.exedosoft.Hello 需要调用
SessionContext.getInstance().getThreadContext().setInstances(list);对总线赋值。
只返回一个值
/eeplat/servicecontroller? userDefineClass=com.exedosoft.Hello&callType=ao
SessionContext.getInstance().getThreadContext().setEchoStr(list)
返回的结果是Echo_str