多身份详细设计.doc

基线多身份详细设计方案修订记录版本编号*变化变更内容日期变更人批准日期批准人1.0A初始版本2017/8/17杨峻峰1.0M多身份切换流程2017/8/21张汪德1.0M基础数据设置多身份的流程、数据结构设计2017/08/21周东*变化状态：A增加，M修改，D删除科大讯飞 教育产品事业部目录基线多身份详细设计方案11.引言31.1编写目的31.2项目背景31.3预期读者31.4阅读建议31.5缩写与术语31.6参考资料42.程序模块描述52.1模块上下文52.1.1多身份设置52.1.2多身份切换52.2模块描述62.2.1基础数据管理平台62.2.2多身份切换62.3关键技术【算法、优化等】62.4流程/逻辑62.4.1基础数据管理平台62.4.2多身份切换72.5数据结构设计72.6接口设计82.6.1基础数据管理平台82.6.2openapi-login82.6.3basis-data-api82.6.4store-api92.6.5desktop-api92.7测试特别关注事项92.8其他91. 引言 1.1 编写目的平台需要支持对身份，部分应用系统如桌面对同一用户不同的身份所显示的页面内容会有所不同，则需要进行身份切换。同时区域基线不同的子系统需要形成统一的身份切换解决方案。1.2 项目背景区域解决方案基线：1、 基础数据管理平台管理用户基础数据（多身份设置）a) 多身份设置功能，及多身份设置接口开发b) 基础数据同步，包括中心及乐知行基础数据同步2、 EDCL平台a) 提供多身份切换功能b) 改造基础服务接口c) 平台应用商店改造3、 区域应用a) 多身份切换b) 部分区域应用系统业务改造1.3 预期读者区域基线开发人员1.4 阅读建议1、 注意基础数据同步方案2、 注意多身份切换方案1.5 缩写与术语1、 基线区域解决方案基线2、 EDCL区域应用集成平台3、 数据交换平台（basedata-exchange）cycore用户服务同步基础数据至乐知行的数据交换平台4、 otter同步区域用户服务同步至中心用户服务5、 portal桌面管理平台或乐知行门户平台6、 store 区域应用商店7、 乐知行dubbo服务 basis-data-api、store-api、desktop-api8、 桌面个人桌面应用（desktop-web）9、 导航 个人桌面提供的平台统一导航10、 区域应用基线自研M应用（如微课学习中心、安全监管、资源中心等应用的统称）11、 sso 平台单点登录服务12、 openapi 平台开放接口13、 乐知行区库 edc35_cloud14、 乐知行校库 智校应用校级数据库（每开通一个云校会创建一个校库）1.6 参考资料无2. 程序模块描述2.1 模块上下文2.1.1 多身份设置基线平台由基础数据管理平台统计进行多身份基础数据的设置，其他如有设置多身份的需求（如桌面）则统一调用基础数据管理的http接口。2.1.2 多身份切换多身份切换操作统一由桌面导航进行，区域应用直接嵌入桌面导航js即可。2.2 模块描述2.2.1 基础数据管理平台能够完成用户多身份设置，及对平台桌面提供多身份设置接口。需要完成多身份基础数据对中心及乐知行的同步，完成数据同步。2.2.2 多身份切换能够完成平台身份的统一切换，并提供集成方案给区域应用进行集成。2.3 关键技术【算法、优化等】2.4 流程/逻辑2.4.1 基础数据管理平台1、多角色数据流程图的设计2、桌面设置老师和家长身份流程2.4.2 多身份切换1、 首页登录流程a)、用户登录首页，请求sso登录，获取全局会话标识。b)、选取用户默认角色。c)、以全局会话标识为key值，将角色及单位id信息存入到redis中。d)、导航栏中写入用户角色信息，并将用户角色信息写到cookie中。2、 首次进入应用a)、进入应用，进行sso登录验证，获取全局会话标识。b)、通过login-api获取redis默认角色信息。c)、生成应用session。d)、将角色信息写到导航栏。3、 应用内进行用户角色切换 a)、设置用户角色单位ID到redis。b)、修改cookie角色信息。c)、修改导航中角色信息。4、 打开的多个应用页面 a)、导航栏中设置定时器，对比导航中角色信息与cookie中的角色信息是否一致，如果不一致，跳到应用首页。b)、定时器时间为2秒。2.5 数据结构设计2.5.1 学生转校的数据库设计2.5.2 桌面设置多身份（老师+家长）数据库设计2.6 接口设计2.6.1 基础数据管理平台 getApplications接口定义：String getApplications功能说明：根据分类获取相应的应用和排行榜应用参数说明：名称类型长度是否必填备注pageint是起始页数pageSizeint是每页显示的条数sortString否排序方式返回值说明：errorCode: 返回编码 ；errorMessage:返回的提示信息；resultEntity:返回的数据数据格式：Json返回值说明：数据项属性数据类型必备描述errorCode无String是返回的编码errorMessage无String是返回的提示信息resultEntityallApplicationsList是根据分类获取相应相应数量的应用topApplicationList是获取排行应用2.6.2 openapi-login set.roleinfo.to.redis 接口定义：Boolean set.roleinfo.to.redis功能说明：设置用户角色到redis参数说明：名称类型长度是否必填备注keyString是SSO全局会话标识roleString是角色orgIdString是学校或机构ID返回值说明：Boolean: 是否设置成功数据格式：Boolean返回值说明：数据项属性数据类型必备描述result 无Boolean是是否设置成功 get.roleinfo.to.redis 接口定义：String get.roleinfo.to.redis功能说明：根据key值获取用户角色信息参数说明：名称类型长度是否必填备注KeyString是SSO全局会话标识返回值说明：result:返回的数据数据格式：Json返回值说明：数据项属性数据类型必备描述result无String是返回角色以及单位ID信息2.6.3 basis-data-api getPersonalInfoByCondition 接口定义：Map getPersonalInfoByCondition(String userId, String userType);功能说明：获取个人信息主身份（为兼容老版本）参数说明：名称类型长度是否必填备注userIdString是Cycore用户iduserTypeString是Cycore身份编码返回值说明：Map: 用户信息Map数据格式：Map返回值说明：数据项属性数据类型必备描述MapMap是用户信息 getPersonalInfoByCondition 接口定义：Map getPersonalInfoByCondition(String userId, String userType);功能说明：获取个人信息参数说明：名称类型长度是否必填备注userIdString是Cycore用户iduserTypeString是Cycore身份编码schoolIdString否Cycore学校或机构id返回值说明：Map: 用户信息Map数据格式：Map返回值说明：数据项属性数据类型必备描述MapMap是用户信息 findUserInfoById 接口定义：UserDTO findUserInfoById(String userId, String usertypeId, String slaveSchoolId)功能说明：获取个人信息参数说明：名称类型长度是否必填备注userIdString是Cycore用户idusertypeIdString是Cycore身份编码slaveSchoolIdString否Cycore学校或机构id返回值说明：UserDTO: 用户信息数据格式：UserDTO返回值说明：数据项属性数据类型必备描述UserDTOidString是用户id（cycore）nameString是用户姓名blockedInteger是是否被锁定 0锁定,1未锁定usernameString是用户名（登录名）schoolIdString是机构id（Cycore的id）usertypeString是用户类型1为老师，2为教职工,4为学生usernumberString否用户编号，当usertype为1时，usernumber为教职工的职工号versionString否版本userFaceString否