dahuahe/framework_stb

面向机顶盒开发的框架库

framework_stb

• 版本号：v2.0.5
• 最后编辑时间：2018年6月8日 13点58分
• 作者联系方式：QQ 442331311
• 面向机顶盒开发的框架库 相对完善的底层库封装(Json序列化、Guid、Random、KeyCode、funckLock、SetTimeout、SetInterval、Cookie、PageSource、FormatTime)常用业务模块(焦点、翻页、缓存、播放器、事件分发、自定义组建扩展) 并持续更新中...

特性

使用 Framework_stb 框架可以使项目支持加载海量NPM包(待实现...)

支持 ES6/ES7标准代码，且可生成任意版本，使用async/await/promise能够有效避免回掉地狱

组建重用，对基础javascript代码进行封装，实现组件重用和嵌套一切皆为组件化

自动化命令，通过命令快速创建完整页面结构以及各类文件

支持 Bootstb 界面框架快速搭建界面结构已各类组件

配置完善的 snippet 代码片段(vs code)包括 html typescript less 语言的组件一键生成

初始化项目

npm run start // 开发流程

npm run minify // 发布流程

npm run server // 本地服务

npm run doc // 框架文档

gulp page --页面名称 // 创建页面

gulp model --文件名称 // 创建文件

gulp logic --文件名称 // 创建文件

项目目录结构

├─dist // 输出目录 │ ├─css │ ├─images │ └─js │ ├─framework
│ │ ├─data_tool │ │ └─ui_tool │ ├─logic
│ └─model
├─doc // 文档资料 └─src // 源文件 ├─framework // 框架文件 │ ├─data_tool │ └─ui_tool ├─less ├─logic // 数据逻辑 ├─model // 数据实体 ├─pages // 页面文件 │ └─index └─template // 模板文件

配置开发工具

项目初始化后使用 Visual Studio Code 或其他习惯IDE打开项目根目录。

开发流程

在 Visual Studio Code 或其他习惯IDE中编辑 src 目录下源码，然后在项目根目录运行 npm start 命令构建项目，然后再运行 npm server 命令启动静态资源服务自动弹出窗口预览

项目研发中，html 视图构建首选方案为 bootstrap 布局;Less 编写 css 样式;TypeScript 进行业务逻辑处理

Tips：编程思路核心突出体现强类型与模块化方案

设计思路

单一职责
    单一职责的描述如下：
    A class should have only one reason to change
    类发生更改的原因应该只有一个

    dataTool.ts 基础库
    整个体系中最小单位对象。仅有一个或一组紧密相关的行为为一个主题服务。通过解耦使每个职责更加有弹性的变化

    focus.ts 焦点对象
    职责是初始化一组矩阵焦点与页面焦点映射关联。且具备一组对该矩阵图相关的职责属性方法

    model 系列对象
    实体类主要是作为数据管理和业务逻辑处理层面上存在的类别;
    某个实体对象可与另一个实体对象关联，但他们都遵循单一职责，每个实体对象的定义都应该围绕一个主题且属性不可再分

    ...

开闭原则
    开闭原则的描述如下：
    Software entities (classes, modules, functions, etc.) should be open for extension but closed for modification.
    软件实体（类，模块，方法等等）应当对扩展开放，对修改关闭，即软件实体应当在不修改的前提下扩展。

    pageEvent.ts 事件管理对象
    采用事件订阅模式，也称观察者模式。同时也是 MVC 框架中各模块间通信的中间对象，订阅者仅关心在处理地方订阅并处理即可。增加其他事件类型也不用修改源码而只是订阅新的事件（Key、PageEventType、FocusType等等）。

    ...

里氏替换原则
    里氏替换原则的描述如下：
    Subtypes must be substitutable for their base types.
    派生类型必须可以替换它的基类型。 

    module.ts 系列模块
    将页面所有焦点元素作为一个或多个模块进行管理 Module 对象作为基类为模块提供基本约束 initialize 和 subscribeToEvents 子类实现这两个方法实现对 pageEvent 订阅和处理相关业务逻辑。在此基础上可实现更为复杂的 Module 模块作为基类被子类继承，但未子类提供处理更复杂业务的能力

    ...

接口隔离原则
    关注接口而不是关注数据

依赖反转原则

工厂模式
    描述如下：
    与创建型模式类似，工厂模式创建对象（视为工厂里的产品）时无需指定创建对象的具体类。

    工厂模式定义一个用于创建对象的接口，这个接口由子类决定实例化哪一个类。该模式使一个类的实例化延迟到了子类。而子类可以重写接口方法以便创建的时候指定自己的对象类型。

    这个模式十分有用，尤其是创建对象的流程赋值的时候，比如依赖于很多设置文件等。并且，你会经常在程序里看到工厂方法，用于让子类类定义需要创建的对象类型。

Less 框架结构（Bootstrap v3.3.7）

通用 CSS
    Print media styles
    Typography
    Code
    Grid system
    Forms
    Buttons
    Responsive utilities
组件
    Navs
    Thumbnails
    Alerts
    List groups
    Panels
JS组建
    Tabs
    Progressbar

盒子与浏览器差异

• 盒子关机后 cookie 清空（通常）
• launcher 相关方法不要通过闭包或 require 加载，出现接口无法访问问题
• 安徽-海信-ZP906H 盒子 全局 top 属性作为 js 关键字。再次声明或赋值操作为无效。尽可能不要使用该关键字 top
• 数码视讯 Q5 小窗视频会覆盖所有元素背景图片样式；添加 背景图片可能导致屏幕部分黑屏（图片相关使用 img 标签）
• 创维 E900 返回简码与其它盒子不一致 Key.Backspace2且隐藏视频接口this.mediaPlay.setVideoDisplayMode(255)无效
• APK 暴露的方法不要使用 let var 去定义 否则导致为空
• line-height 居中文字盒子展示有差异,使用 padding + font-size 代替 line-height 高度 this.mediaPlay.setVideoDisplayMode(255)无效
• APK 暴露的方法不要使用 let var 去定义 否则导致为空

部分盒子加载超长图片会失真模糊，浏览器自动降低分辨率，解决方案拆分成多个

需要改进的功能

• PageEvent 自定义模块 Focus 事件注册后提示注册的信息失效（偶发情况）
• Focus 对象 autoFile autoTarget 属性兼容性，后者会影响前者状态（目前最好不要同时配置两个属性）
• 将 HTMLElement 相关常用特效及其功能按照 Bootstrap 插件形势开发，且不依赖于Jquery
• 执行性能检测
• 更改 Focus 对象算法以 Dome 坐标为基础（待定...）
• model logic 生成时改变文件里面对象名称
• 工厂模式创建形状
• ModulePage 分页左右无法缓存问题（偶发）
• 提取 ModulePage 到独立文件进行管理，便于进行多个数据源缓存管理（考虑中）目前本就可以把它当作多个模块来实例化，而不是通过继承来处理。将此种方法和其他组建的应用示例写到 demo 里面，已备以后随时查看参考
• 编写DB组件 ModulePage 以及其他特殊场景应用组件，说明其应用范围以及条件
• Focus 模块 Demo 说明手动触发模拟按钮事件方式以及应用场景setSite(keyCode,"common") demo 介绍
• Demo 说明 Focus 主动触发一个模块的按钮事件，通过 pageveType.keydown 触发为例。不要直接使用 siteSite 方法。
• 需要改进 Focus 组建，模拟事件触发功能。Change事件触发可带参数 配置说明
• AutoFile 配置失效
• disableSite cancelClass demo 应用场景说明
• Focus initData 传入类型怎么样最方便（思考），HElement 对象可传入多个且返回一个 HElement 实例
• 项目接口地址以及参数保存文档，截图到手机，随时对接参数
• 事件批量注册功能 DEMO 说明
• Model on 事件 DEMO 说明
• HElement 传入多个ID或类进行实例化
• HElement 传入多个HElement进行实例化
• Focus 快速焦点增加 除了 Enter 之外的案件
• 快速创建文件命令 page 命令 页面 default 变量自动替换与页面相关变量
• 设计模式完善
• 需要改进：优化 HELEment .className 多个类名时无法获取情况
• Demo 提示 设计原则 Focus 尽可能最少
• 再次简化 ModulePage 的封装（思考）
• Demo 说明 卸载Focus 对象必须调用 relase();
• DEMO 说明 同一个模块的 Focus 实例有且仅能存在一个；否则导致冲突
• 完善 keydown 来自系统与来自自定义方式标识
• Focus 调模模式加入警告 ，不要为通过 Mtype 类型创建多个实例 Focus 导致异常
• Focus 调试模式加入警告 重新实例化必须进行释放，否则会进行多次订阅
• DEMO 说明 ModulePage 获取当前焦点数据 getData()
• 思考 Focus autoFile 失效，是否需要自动填充，如果不需要那么取消
• PageEvent 转移焦点单独开提示调试模式
• 重要功能模块独立为单独项目，使用安装的方式引用
• • PageSource 对象如果来源页面为空，无法记录值，导致返回当前的去向页面。需要处理。且加入返回 launche 业务，如果没有来源也 launcher 自动返回。并且兼容 多地区盒子
• 焦点恢复 传入模块 页面下标 坐标 恢复已传入的值 以 undefined 为标准 。封装为组件
• 添加组件化测试，类似 React 组建测试，针对数据流，不依赖环境
• 添加状态机，降低html 与 js 的处理难度。
• 添加数据绑定机制，不再需要根据下标去找到对应数据而是在之前就绑定。也就是在定义时就已经确定参数

Tips：编程思路核心突出体现强类型与模块化方案

播放器改动，如果三秒没有更新则不尽兴 stop (针对直播流) 播放器卡顿时间超过 3 S 是否会误判

更新判断是否存在统一播放器

更新 MediaPlayer 对象接口

创维E8205 在 A 页面创建播放器没有释放情况到 B 页面进行播放 这时 Backspace 被系统阻止.释放播放器后可恢复该异常

创维中兴 调用频道播放直播流 A B 页面频繁切换时需注意 创建与播放 MediaPlayer 实例的间隔。可导致 无法播放问题。解决方案。在 A B 页面不要释放播放器。可重复创建 MediaPlayer 实例

直播流不要加载总时长限制，可能无法获取到总时长所导致异常

• 生成框架 .d.ts 不要直接定向到源码

• 以安装包形式引入项目，使用 commonjs

• 架构选择 MVC 或者三层架构重构框架

• Visual Studio Code 代码调试

• 模块测试工具

• 前端模块构建概念 React

• 数据流程管理 Redux

• v1.0 版本库发布

• v2.0 版本构建新特性（重构模块、重构模块扩展交互、重构业务流程、重构数据流程、重构焦点引擎）

• 引擎 框架 库 概念分析

更新日志

2017年9月5日11:33:59

• √ PageEvent 对象 trigger 方法进行焦点移交时若目标模块没有订阅加入异常提示
• √ PageEvent 对象 on 方法订阅 focus blur keydown 等事件选项封装为枚举类型且可扩展
• √ EventMeitter 对 Mediator 中介器封装，新增 EventMeitter 发射器代替(可支持同一事件被多个地方订阅)
• √ PageEvent 移除 system.${ele.topic}.${targetName} 订阅方式 改用发射器订阅。执行顺序为模块封装的自动行为执行（比如Focus对象）
• √ PageEvent 增加初始化时 targetName 属性可以为 null 意思是当前页面无焦点。然后通过 target 方法在需要地方手动设置
• √ EventMeitter 加入队列管理事件执行队列与顺序（发射器）
• √ PageEvent 定义日志打印接口并且实现相应逻辑，订阅 * - PageEventType.Error 通过浏览器函数 console.log() 输出日志 2018年1月4日18:07:46
• √ PageEvent 发布当前触发事件简码事件。订阅 PageEventType.keydown 事件可以替换为 Key 枚举的值
• √ PageEvent 管理模块可以有开关功能，如果关闭则自动焦点和焦点移交则不会执行
• √ pageEvent 焦点模块列表禁用功能，如果开启则自动排除该模块，不会执行焦点转移
• √ pageEvent 焦点模块列表锁定功能，如果开启该模块仅启用离开事件与焦点事件，不通知具体事件
• √ pageEvent 完整性检查，如果该对象不能接受到事件那么则取消该行为，以免让页面陷入失焦状态。从而让页面死掉
• √ Focus 对象卸载时可保存订阅的事件。重新创建时可以不用重复在订阅，事件可重用
• × Focus 相关事件触发源是自动触发还是主动调用方法触发的标注，特别是处理订阅事件和回掉的时候
• 2018年1月11日15:32:56
• Helement 对象 removeClas,clas 方法导致前后空格，删除异常（类名中某个字符被删除）等问题
• PageEvent 新增 getPreviousIdentCode 方法获取来源模块标识 2018年1月24日15点03分
• 新增 template 文件夹 模板文件单独放置且跳过编译配置
• gulpfile.js 增加css多浏览器兼容
• gulpfile.js 增加html压缩
• gulpfile.js 增加图片压缩
• npm 编译命令增加 npm minify(发布压缩版本、带前缀css版本) 2018年1月26日 14点07分
• pageEvent 新增键码锁定功能在原有功能增加可选参数 lockTopic(identCode: number, keyCodes?: number[])
• pageEvent 锁定 lockTopic：identCode 所有键码。keyCodes 锁定给定键码
• pageEvent 解锁 unlockTopic：identCode 所有键码。keyCodes 解锁给定键码 2018年2月1日 14点37分
• ParseUrl 新增 decodeURI 与 decodeURIComponent 解码类型接口
• FormatUrl 新增 encodeURI 与 encodeURIComponent 加密类型接口 2018年2月5日 10点24分
• Player FinishPlay 事件完善（存在播放开时多次触发该事件）
• Player 完善播放进度兼容问题（部分盒子当前进度播放完成于总进度差距3秒左右误差）
• ParseUrl 与 FormatUrl 增加两种编码加密与解密接口 2018年2月8日 10点57分
• 更新 const.ts 更新部分盒子的配置情况
• 更新 player.ts 取消了音量设置延迟的功能
• Focus 完善 autoTarget: [{ keyCode: Key.Left, target: ModuleType.Anwser }] 支持 enter backspack 按键
• template.ts 更新更完善的初始页面 2018年2月24日 11点03分
• 更新 dataTool Key 对象新增 Home = 181 Pause = 263 2018年2月26日 17点22分
• 修复 Focus 第二次调用 initData 方法后 autoFile 的 Key.Right 和 Key.Left 异常问题 2018年3月8日 09点35分
• 更新 uiTool 工具库新增 VerietyRoll 模块
• 更新 config 配置文件结构与属性命名
• 更新 managementPageDB.ts 文件 修复分页容易产生歧义参数 删除 ManagementPageDBToLocal 模块 新增 ManagementPageDBToNative 模块作为替代
• 更新 dataTool 工具库 ParseUrl 对象 支持传入完整格式的 url 与 location.search
• 更新 dataTool 工具库 JSON 对象为静态对象使用不需要实例化
• 更新 focus 对象 优化部分功能
• 更新 pageEvent 对象 优化部分功能
• 更新 const 支持 云南盒子首页地址获取
• 更新 PageSource 修复cookie 对象返回 null undefined 异常
• 更新 Player 对象 支持自定义总时长 自定义总时长播放完毕后结束视频流
• 更新 Player 自动初始化当前系统音量
• 更新 Player 公开化 mediaPlayer 属性
• 更新 dataTool 模块 新增 Key.Mute2 云南静音键
• 更新 完整的各个模板文件
• 更新 uiTool 工具库 常用插件提取 比如（纵向自动滚动、自定义走马灯、可控制上下滚动查看）
• 更新 uiTool 走马灯逻辑调整给予 js 计时器实现 2018年3月9日 11点23分
• 更新 Player 快件到终点然后续播导致当前进度异常问题 2018年3月12日 10点54分
• 删除 carousel.ts 文件
• 删除 arithmetic.ts 文件 2018年3月22日 14点19分
• 更新 module 模块 增加基于 Module 模块扩展 ModulePage 对象支持播放底部选集翻页组件列表翻页组件
• 更新 interfaces.ts 增加 IManagementDB 接口定义
• 更新 paging.ts 增加 getSerial 方法
• 更新 focus 模块 增加 getSetting 方法
• 更新 player 模块 增加 getTotal 方法 2018年3月30日 17点56分
• 更新 teleplay.ts 新增 recoverPage 恢复页面方法
• 增加 ModulePage 基类支持以 ModuleType 值为参数的多组数据提供前后翻页、上下翻页、自动缓存、智能焦点、全局焦点、全局序号设置焦点、分页下标设置焦点等方法 2018年4月13日 10点36分 v2.0.0
• 更新 ModulePage 修复已知 bug
• 更新 uiTool.ts 新增 VerticalRoll、VerticalFlowRoll、VerticalVisualRangeRoll 、HorizontalRoll 模块
• 更新 framework.ts
• 更新 Helement 模块 支持直接关系选择器（类选择器、ID选择器、节点类型选择器）筛选子节点
• 更新 PagingHelper 模块
• 更新 PageEvent 模块 扩展 on off 方法支持批量处理;
• 更新 Focus 模块 删除 FocusType.Focused FocusType.Blured 事件
• 更新 Module 模块 新增基于 PageEvent 模块的事件订阅方式 且提供回掉参数强类型支持
• 更新 interface.ts 删除 IPageEvent 接口 调整各事件类型属性成员
• 更新 Player PlayerSpecial 播放器进度改变事件回调中增加总时长属性;总时长初始化事件回调加当前进度参数
• 更新 简化编码复杂程度（ModulePage、）
• 增加 Gulp 命令创建完整页面结构（.html、.less、.ts、logic.ts、entity.ts） 2018年4月16日 10点44分 v2.0.1
• 更新 Focus 模块 setSite 方法（设置坐标）如果当前焦点非当前模块时不做添加样式操作;调整 initData 参数为 HElement 对象
• 更新 Helement 模块 API接口参数调整;支持链式调用;支持子节点筛选（类选择器、ID选择器、节点类型选择器） 2018年4月18日 11点39分 v2.0.2
• 更新 Focus 模块兼容非矩形焦点组
• 新增 layout 布局框架引入定制版 Bootstrap 通用样式 组件样式（导航、缩略图以及自定义缩略图样式、警告框、进度条（自己去实现，作为JS组建）、列表组（以及加徽章或者图标）、tabs（自己实现，作为js组件）、徽章、媒体对象 2018年5月9日 16点37分 v2.0.3
• 新增 /src/package 目录 作为发布文件补充目录 启动编译时自动将图片或其他资源输出到 dist 2018年5月14日 10点02分 v2.0.4
• 预定义 CSS .init() .default() .focus() 样式函数 分别应用 重置 焦点默认 焦点样式 2018年6月7日 09点43分 v2.0.5
• 新增 es6-promise.auto.min.js 引入 Promise 开发模式
• 更新 template 系列模板文件 template.ts 定义多组 Module (普通组件、翻页组件)
• 更新 ModulePage 完善强类型支持
• 更新 tsconfig.json 支持 Promise 模式
• 更新 HElement 对象扩展 getAll() 方法 eqAll() 方法
• 更新 interface.ts 各类型属性成员
• 更新 ManagementPageDB 模块无法缓存多页数据BUG;getItem 方法支持返回 Promise 对象
• 更新 HorizontalRoll 首次 enable 无法正常滚动到指定位置
• 更新 Focus 模块 新增 guid 属性 在跨行跨列作为通用属性，参考 Focus 对象 debuggerOut 方法
• 更新 Focus 对象 release 方法卸载队列完整性
• 更新 framework.ts
• 更新 ModulePage 模块 onDBLoadList 回掉中使用异步读取数据导致数据异常与 loadView 数据不一致等问题
• 更新 ModulePage 模块 支持返回 Promise 实例
• 更新 Module 模块 新增 RecoverStatus 方法，恢复组建状态
• 更新 template.ts 定义 reutrn 请求参数作为返回来源页地址
• 新增 自定义代码片段(Vs Code)
• 更新 HorizontalVisualRangeRoll VerticalFlowRoll 模块支持初始设置偏移以及改变时可自定义过渡效果
• 更新 Player 订阅 onfocus 事件避免事件异常
• 更新 package 文件夹引入 velocity.min 插件

应用项目

• 安徽文艺（2017）
• 内蒙环球（2017）
• 云南4k（2017）
• 安徽猜灯谜（2018）
• 安徽送祝福（2018）
• 内蒙天翼（2018.3）
• 安徽聚合（2018.5）
• 云南618（2018.6）
• 安徽世界杯（2018.6）