对象结构创建构建表模型的过程中，需要为表中字段适当建立索引。基于表模型来建立索引，应当遵循以下两个原则：常用的查询条件字段创建索引，创建索引时，区分度大的字段放在前面。不要对所有字段建立索引，太多的索引会导致增删改的操作变慢，且维护成本高。关于建立索引的详细原则以及范例，详细说明请参见索引添加规则。索引添加规则当建立表模型时，字段取值是唯一(Unique)的，并且也勾选了“是否唯一”选项，平台自动添加索引。如果新建字段时候，勾选了“是否唯一”，那么平台自动为此字段添加了索引。当字段类型为Lookup及MasterDetail时，平台自动添加索引。当字段的取值区分度不大时，不建议添加索引。如SingleSelect类型、CheckBox类型不应该建立索引。举例：Status字段取值为Active、Inactive、Deleted，添加索引对查询性能影响不大，但是对增删改有影响，致使增删改的操作耗时多。对于TextArea类型的字段，平台暂不支持建立索引。当字段为多语言字段时，字段值存储的是多语言ID，若业务根据多语言ID查询，可添加索引以提高查询性能，若业务根据多语言的值查询，则无需添加索引。当字段的取值既不是唯一，又无法确认重复度时，根据业务实际使用场景添加。若业务使用该字段进行查询的频率较高时，可建立索引以提高查询性能，若使用频率较低时，可不建立索引。

了解AppCube平台的相关参数与限制，在业务开发过程中，在限制规则内进行开发，以免触发未知的异常。平台对接的ES（Elasticsearch），查询条件中能带的value个数≤1024个。平台对接的ES，返回数据量≤5000条。平台1.2.12.2版本后，默认≤5000条。平台1.2.12.2版本前，默认≤3000条。平台对接的ES，查询条件中的From ≤ 10000平台1.2.12.2版本后，默认≤10000平台1.2.12.2版本前，默认≤3000单条SQL查询，关联表的数量最好不超过6个，推荐4个。超过限制会导致执行过慢，甚至报错。单条SQL查询，返回的数据量限制为10000条；不传limit时，会默认限制为5000条。单条SQL执行时间60秒后会报超时的错误。当大批量数据操作时要分批操作。定时任务中，脚本执行10min后超时。restful API中，单个API访问数据库的限制如下，其它详细约束请参见AppCube平台的规格说明。表1 单个API访问数据库的限制license限制免费租户企业版租户脚本最大运行时长60s180s脚本任务最大运行时长180s600s每个节点允许并行运行的脚本的最大数目11000每次请求执行数据库查询最大次数1001000每次请求数据库查询最大记录数50000200000每次请求执行数据库DML操作最大次数1501000每次请求数据库DML操作最大记录数10000100000每次请求执行查询elasticsearch最大次数201000每次请求elasticsearch查询最大记录数50000200000每次请求最大外部请求数101000每次请求最大发送邮件数101000每次请求最大发送事件数501000

查询系统参数（getSysParameters）查询系统参数。该接口主要用于公共查询系统参数，只可查询非加密系统参数值。注意事项无。基本信息接口名称getSysParameters接口路径/service/Common/0.1.0/getSysParameters接口协议HTTPS接口方法POST请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选（M）/可选（O）参数位置参数含义access-tokenStringMCookie | Header授权TOKEN。localeStringOHeader当前界面语言。如zh_CN、en_US。默认为zh_CN。parameterNamesStringMBody系统参数名称。表示要查询的系统参数名称。请求样例 { "parameterNames": "roma_app_prefix" }响应参数响应参数如表2所示。表2 响应参数说明参数名称类型必选（M）/可选（O）位置参数含义resCodeStringMBody接口的返回码。resMsgStringOBody接口的返回消息。resultOutputs[]OBody接口的响应参数。表3 Outputs参数说明参数名称类型必选（M）/可选（O）位置参数含义parametersStringMBody/result/Outputs系统参数结果。{“系统参数名”：“系统参数值”}响应样例{ "resCode": "0", "resMsg": "成功", "result": [ { "parameters": { "roma_app_prefix": "test_default__" } } ] }

调用资产前需要先调用该接口，获取access-token值。注意事项无。基本信息接口名称token接口路径/baas/auth/v1.0/oauth2/token接口协议HTTPS接口方法POST请求参数请求参数如表1所示。表1 请求参数说明参数名称类型必选（M）/可选（O）参数位置参数含义Content-TypeStringMHeadersHTTP协议中设定的一个参数，用于标识返回的内容用什么格式去解析。取值为：“application/x-www-form-urlencoded”，表示urlencode格式。说明：当前使用的是OAuth 2.0的客户端鉴权模式获取用户access_token，由于不需要access-token认证，所以Header中只需要设置“Content-Type”为“application/x-www-form-urlencoded”即可，即需要将Body中的请求消息体参数以www-form-urlencoded格式传入。grant_typeStringMBody类型。取值：client_credentialsclient_idStringMBody客户端id，可在OAuth查看，参考创建OAuth。例如：08b357*****7af28d1client_secretStringMBody客户端密钥，可在OAuth查看，参考创建OAuth。例如：3c4e95*****4a5blocaleStringOBody语言。例如：en_US创建OAuthclient_id和client_secret获取方式如下：创建权限配置信息。管理员账号登录AppCube平台。依次选择“管理 > 用户管理 > 权限配置”，单击“新建”，新建权限配置。填写权限配置名称，如“test”，单击“保存”，创建完毕。自定义编辑步骤1创建的权限配置信息。单击选择步骤1创建的权限配置名称，进入权限配置详情页面。单击右上角编辑按钮，勾选需要调用的API对应的业务权限凭证，如图1所示信息。图1 权限配置详情创建用户。获取AppCube鉴权信息之前，先要创建用户，为用户配置OAuth权限。依次选择“管理 > 用户管理 > 用户”，进入用户列表页面。单击“新建”，输入用户信息，选择用户权限为步骤1创建的权限配置名称，如下图所示。单击“保存”，用户创建完成。获取AppCube的鉴权信息。依次选择“管理 > 系统管理 > OAuth”菜单。单击“新建”，输入名称，选择上个步骤创建的用户，并单击“保存”。系统会自动生成客户端ID和客户端密钥。每个OAuth都有特定的用途，因此需要为AppCube鉴权信息单独新建一个OAuth。单击，下载excel文件，从中获取client_id和client_secret。响应样例{ "access_token": "0000000000***********jbd0qVnm6qhfGBnaEwbMU=", "expires_in": 3600, "token_type": "Bearer" }

应用工程指使用AppCube平台开发的App和BO，应用工程规范包括App、BO的命名规范、目录结构规范，工程配置规范和工程服务规范。App是一个可复用的独立业务应用。例如，智慧园区解决方案中的综合安防应用。App的交付件包括：接口Interface：对外暴露的接口服务，Restful API接口可以直接被前台或第三方系统调用。事件Event：对外暴露、共外部订阅的事件。菜单Menu：面向租户业务使用人员，提供配置操作能力。BO是一个可复用的领域服务，是最小粒度的复用单元。例如，为了使业务应用开发人员高效地实现与物联设备的交互，对物联设备进行业务抽象，封装为设备BO。BO是资产封装的规范，可以基于平台元数据能力实现，也可以用其他方式实现。BO是有边界的。BO与BO之间不能共享数据。BO对外开放数据视图、接口服务、配置机制、事件等来进行交互，内部实现对外闭源不可见。BO的数据视图以聚合根的形式开放供外部查询。BO可以同时开放多个聚合根。BO与BO之间允许有接口调用的引用关系，但设计时应尽量避免BO与BO之间的直接交互，并完全禁止双向依赖。BO中可以包含UI内容如Layout、Widget，但仅作为参考实现。BO应尽量利用配置能力来适配不同的业务场景。配置无法满足时才考虑对BO做Addon扩展。扩展不能影响BO的向前兼容性。BO被打包在App或Addon中，租户通过安装App或Addon来获取BO。本文中字符数均以英文字符作为计数单位，一个汉字算3个字符。开发态的名称定义使用英文，展现给租户使用的配置参数显示则使用中文。BO的交付件包括：接口Interface：BO对外暴露的接口服务，一类是可以直接被前台或第三方系统调用的Restful API接口，一类是只能在开发平台上通过编排来调用的SDK API。事件Event：对外暴露、共外部订阅的事件。配置Configuration：面向开发人员或IT管理人员的，提供的配置能力。其中，配置菜单是BO提供的配置界面，选项列表是BO内部使用的字典项，系统参数是BO内部需要读取的控制参数。

【操作步骤&问题现象】1、问题现象：因项目使用海康摄像头，需使用海康提供的播放插件，目前是将海康插件上传到OBS后，在视频预览界面进行下载插件。由于ABC脚本上传限制为5M，请教运维人员后将上传限制由5M提升至80M，但出现了下载过慢的问题，下载也存在会中断的情况。2、问题咨询：是否有相关配置会影响下载速度？【截图信息】

【功能模块】Roma连接数据源【操作步骤&问题现象】1、roma连接本地mysql，失败原因只显示20秒，请先复制到文本文件中，本机的Na 可以连本机的仓库，但是ROMA是外网的，是不是连接不了？【截图信息】【日志信息】（可选，上传日志内容或者附件）

园区基线预集成的设备IO包含：基线设备IO、连接实验室认证扩展IO。当对应设备接入园区时无需开发任何代码，可直接接入使用。基线设备IO：随基线版本一起安装，订购园区基线后默认安装好，如表1所示。连接实验室认证扩展IO：IO扩展包随基线版本发布，但默认不安装，项目可根据需要选装，如表2所示。扩展IO详情见连接实验室认证扩展IO。基线设备IO这部分设备IO随基线版本一起安装，订购园区基线后默认安装好。表1 基线设备IO条数分类设备IO“统一设备服务”端对应的设备规格1保安系统设备门禁设备IOAccessControl2泄露电缆设备IOLeakyCable3人行闸机设备IOTurnstile4消防系统设备消防烟感设备IOSmokeDetector5消防温感设备IOTemperatureSensor6消防手报设备IOManualFireAlarmActivation7声光报警设备IOAcoustoOpticAlarm8消防栓按钮设备IOFireHydrantButton9可燃气体探测器设备IOCombustibleGasDetector10能耗系统设备水表设备IOWaterMeter11电表设备IOElectricMeter12燃气表设备IOGasMeter13资产管理设备新基点IoT射频识别标签设备IORFID14新基点IoT射频识别读卡器设备IORFIDReader15环境监测设备户外环境监测设备IOOutdoorEnvSensor16室内环境监测设备IOIndoorEnvSensor17建筑BA设备空调机组设备IOAirHandleUnit18新风机组设备IOPreCoolingAirHandlingUnit19送风机设备IOSupplyAirFan20排风机设备IOExhaustAirFan21冷机设备IOChiller22冷冻水泵设备IOChillerWaterPump23冷却水泵设备IOCoolDownWaterPump24冷却塔设备IOCoolingTower25冷源补水箱设备IOColdSourceSupplyTank26冷源补水泵设备IOColdSourceSupplyPump27冷冻水总管设备IOChilledWaterMainPipe28冷却水总管设备IOCoolDownWaterMainPipe29管道设备IOMainPipe30膨胀水箱设备IOExpansionTank31蓄冷罐设备IOColdStorageTank32电热锅炉设备IOElectricBoiler33锅炉热水泵设备IOBoilerHotWaterPump34供热水泵设备IOHeatingWaterPump35排水泵设备IODrainagePump36生活水泵设备IODomesticWaterPump37集水井设备IOSumpPit38生活水箱设备IODomesticWaterTank39减压阀设备IOPressureReliefValve40室内照明控制器设备室内照明控制器设备IOIndoorLightingController41厕位检测设备厕位检测设备IOToiletPositionDetector42工位检测设备工位检测设备IOWorkStationDetector43升降电梯设备升降电梯设备IOElevator44电梯群控器设备电梯群控器设备IOElevatorClusterController连接实验室认证扩展IO这部分设备IO扩展包随基线版本发布，但默认不安装，项目可根据需要选装。表2 连接实验室认证扩展IO条数分类设备IO“统一设备服务”端对应的设备规格1电气火灾监测系统设备故障电弧探测器设备ArcFaultDetectionDevice2电气火灾检测系统探测器设备ElectrFireMonitorSysDetector3消防电源监控系统设备FirePowerMonitorSys4照明系统路灯设备StreetLight5室外景观照明设备OutdoorLandscapeLighting6室内多回路照明控制器设备IndoorMultLoopLightingController7环境空间监测系统震动传感器设备Vibrating8GPS定位器设备GPSLocator9智能手环设备SmartBand10垃圾桶设备Trashcans11擦手纸余量检测设备TissuePaper12厕纸余量检测设备ToiletPaper13客流统计设备PassengerFlow14多媒体点评器设备Evaluator15洗手液余量检测设备SoapDispenser16井盖检测器设备ManholeCoverDetector17路灯显示屏设备StreetLightDisplayScreen18激光探测器设备LaserDetector19应急指示灯设备EmergencyLamp20水文监测系统水位水质监测设备WaterQualityMonitoring21水文监测设备HydrologicalTelemetery22能耗管理系统能耗管理系统设备EnergyConsumption23智能水表设备SmartWaterMeter24热量表设备HeatMeter25冷量表设备CoolCapacityMeter26火灾自动报警系统报警主机设备AlarmHost27入侵报警系统电子围栏设备ElectronicFence28门磁探测器设备ElecLockDetector29报警主机防区设备AlarmHostDefenceArea30环境空间告警系统管线甲烷气体探测器设备PipelineCH4Detector31管线硫化氢气体探测器设备PipelineH2SDetector32管线温湿度探测器设备PipelineTempAndHumidityDetector33管线压力探测器设备PipelinePressureDetector34管线氧气气体探测器设备PipelineO2Detector35紧急按钮设备EmergencyButton36温湿度监测设备TemperatureHumidity37管道流量监测设备PipelineTrafficMonitoring38液压检测设备HydraulicPressureDetector39水浸检测设备WaterImmersion40液位检测设备LiquidLevelDetector41CH探测器设备CH4Detector42红外探测器设备InfraredDetector43一氧化碳探测器设备CODetector44氨气探测器设备AmmoniaDetector45空气质量探测器设备AirAualityDetector46地埋侧循环泵设备BuriedSideCirculatingPump47定压水泵设备ConstantPressurePump48水处理仪设备WaterTreatmentInstrument49地源热泵机组设备GroundSourceHeatPumpUnit50锅炉补水箱设备BoilerSupplyTank51二次水循环泵设备SecondaryCirculationPump52消防监测系统消防栓监测设备HydrantDetector53消防管道监测设备FireControlPipeDetector54BA400V进线设备InLine400V5510kV进线设备InLine10kV56400V出线设备OutLine400V57电力变压器温控器设备TransformerTempController58交流电通断检测器设备ACDetector59空气断路器设备AirCircuitBreaker60电箱温度传感器设备TempDetector61母联设备BusTieSwitch62电容器设备Capacitance6335kV出线设备Capacitance64主变压器设备MainTransformer6510kV出线设备OutLine10kV66站变设备StationTransformer67110kV分段设备Subsection110kV68直流屏设备DirectCurrentPanel69110kV进线间隔设备IncomingLineInterval110kV70双电源转换开关DualPowerSwitch71TV监控设备TVMonitoringDevice72母线保护设备BusbarProtection73光伏发电设备PhotovoltaicGenerator74柴油发电设备DieselGenerator75电动天窗电动天窗设备PowerSunroof76电梯及扶梯扶梯设备Escalator

图1 设备通过IoT接入南向设备接入的整个业务流程可以分为2部分：数据上报和指令下发，各模块的处理流程如下。数据上报IoT平台能力：南向设备通过IoT网关和IoT平台，将原始数据上报到ROMA MQS的原始topic中。基线预置能力：IoT Adapter IO依据消息类型将消息拆分，并根据设备类型和消息类型转发给对应设备IO的中间层topic。例如人行闸机上报的消息，会转发给“人行闸机设备IO”；门禁上报的消息会转发给“门禁设备IO”。设备IO能力：设备IO将消息转换成标准格式，并发送到“设备标准消息MQS Topic”。基线预置能力：统一设备服务消费标准topic中的消息，转换成事件供业务应用做逻辑判断。指令下发基线预置能力：统一设备服务提供标准化的设备模型和控制命令，无论是对哪种设备下发指令，业务应用都只需调用标准化的指令接口即可。基线预置能力：统一设备服务根据业务侧下发的指令，在设备的标准模型中查询到该设备的指令服务后回调ROMA侧的“设备标准IoT接口”。基线预置能力：ROMA侧的“设备标准IoT接口”依据指令中的“channel”和“deviceType”参数，将指令路由到设备IO。“channel”参数用于多IoT平台的场景，确定指令要下发给哪个IoT平台，例如新基点IoT平台的channel值为“basepoint.connectionmax.iot”。“deviceType”参数确定指令路由到哪个设备IO，deviceType的值来自统一设备服务中定义的标准模型。例如人行闸机的指令会路由到“人行闸机设备IO”，门禁的指令会路由到“门禁设备IO”。设备IO能力：设备IO将业务侧下发的指令转换为实际物理设备可以执行的指令，并回调南向IoT平台的指令下发接口。IoT平台能力：南向IoT平台向实际物理设备下发指令，控制设备的运行。在整个业务流程中，每种类型的设备，都需要有一个对应的设备IO，用于标准化实际设备上报的消息，以及转换业务下发给设备的指令，消息上报和指令下发通过IoT平台来实现。针对园区常见的一部分设备，基线已经预集成了对应的设备IO，无需开发任何代码，可直接接入使用，详细清单参见基线已集成设备。对于不在基线预置内的设备，只需开发对应的设备IO即可，其它部分不需要开发，整个上行/下行流程和业务侧都无需变动，开发流程详见基线未集成设备接入指导。

批量导出接口业务对象的数据很多场景下需要导出到外部，例如在界面导出成文件，导出到数据平台做分析，或导出到第三方系统使用。因此需要提供REST形式的数据导出接口。导出接口的命名举例：deviceDataExportForBatchURL格式举例：/service/Device/0.1.0/deviceDataExportForBatch导出接口的入参字段：导出接口的本质是按条件查询接口，但和数据视图的查询接口不同，导出接口通常入参与时间段相关，其查询结果应为平铺的字段列表而非嵌套的对象结构。导出接口的入参字段建议包含以下：表1 导出接口的入参字段序号名称类型必选（M）/可选（O）描述1countFlagIntegerM1：返回总数totalNumber。其它：返回title，data。2startIntegerO导出开始数，0开始。countFlag为1时，可不传。countFlag不为1时，必传。3limitIntegerO导出数。countFlag为1时，可不传。countFlag不为1时，必传。4xxxAnyO回调服务自定义参数。入参样例：{ "channel": "string", "countFlag": "string", "defId": "string", "deviceIds": [ "string" ], "deviceName": "string", "exportAllFlag": "string", "externalCode": "string", "gatewayId": "string", "limit": 0, "spaceInPath": "string", "start": 0, "status": "string" }导出接口的出参字段建议为：表2 导出接口的出参字段序号名称类型必选（M）/可选（O）描述1totalNumberIntegerO导出的总数，countFlag为1时返回。2titleString[]O导出文件标题列表，例如：["title1", "title2", "title3"]countFlag不为1时返回。3resultRecord[]O导出的数据列表。一条数据对应一行导出数据，字段名为对应标题，字段值为导出值，例如：[{"title1": "val1"}, {"title2": "val2"}, {"title3": "val3"}]countFlag不为1时返回。出参示例：{ "result": [ {} ], "title": [ "string" ], "totalNumber": 0 }一个应用通常会包含多个业务对象，例如人员BO包含了人员实例、人员群组、通行授权等业务对象。不同的业务对象应提供不同的批量导出接口，不同的业务对象关系也应提供不同的批量导出接口，因为批量导出的结果集为平铺的多字段数据记录集，不适合同时承载有关联关系的多个业务对象。

在创建FUNCTION类型的权限资源时，只能选择已有的业务权限凭证。AppCube平台的业务权限凭证，由开发者在应用开发的“配置> 业务权限凭证”页面创建，删除同样如此，权限BO仅关联已有业务权限凭证。在应用开发的“配置> 业务权限凭证”页面创建凭证，APP/BO编译打包时，可以将凭证以及API关联的凭证数据一起打包出来。配置规范业务权限凭证配置的粒度应符合实际业务使用场景，使实际业务中既能灵活配置权限，又不产生越权的问题。如果一个权限中需要调用多个接口，其权限资源应配置上多个接口对应的业务权限凭证（即创建多个FUNCTION类型的权限资源），然后分别给这些接口配置业务权限凭证。通常一个接口对应一个业务权限凭证。命名规范凭证名称的命名规范如下：模块名称(APP/BO名称)[必选]_特性[必选]_操作[非必选]，大驼峰格式。例如：SystemManagement_CommonSystemManagement_Operator_Create凭证分类（目录）原则：以APP/BO为模块进行分类，命名与APP/BO一致。目录必选。定义业务权限凭证时目录名称可直接输入。区分使用者权限如：SystemManagement_Common配给匿名用户；SystemManagement_Operator_Update配给系统管理员区分读写权限如：SystemManagement_Operator_QueryAll只读；SystemManagement_Operator_Create可写区分单个/批量权限如：SystemManagement_Operator_Delete单个删除；SystemManagement_Operator_BatchDelete批量删除区分同一操作结果不同权限如：SystemManagement_Operator_QueryAll查询全部信息；SystemManagement_Operator_QueryBasic查询基本信息区分可操作对象不同权限如：SystemManagement_Operator_QueryBasic查询返回多个结果；SystemManagement_Operator_QueryCurrent查询仅返回当前对象结果

BO系统参数BO中的系统参数，统一命名规则为 ：BO名称 + 下划线 + 系统参数名称<BOName>_<SystemParameterName>系统参数名采用首字母大写的驼峰样式。例如：SampleBO_DefaultValue 、AlarmBO_SecurityLevel 、GISBO_MapServerHost创建系统参数的时候，勾选“使用命名空间”这个选项，确保跨租户全局唯一。另外，系统参数名需要能尽可能地表明参数的业务含义，避免与其它参数混淆或者完全看不出业务含义。图1 创建BO系统参数APP系统参数APP中的系统参数，统一命名规则为 ：APP名称 + 下划线 + 系统参数名称<APPName>_<SystemParameterName>系统参数名采用首字母大写的驼峰样式。例如：SampleMgmt_MaxValue 、SecurityMgmt_DefaultSecurityLevel 、IOCMgmt_DataSourceType创建系统参数的时候，勾选“使用命名空间”这个选项，确保跨租户全局唯一。另外，系统参数名需要能尽可能地表明参数的业务含义，避免与其它参数混淆或者完全看不出业务含义。管理界面中的系统参数原则上，所有的系统参数都应该放到各BO及APP中。但是如果确实有些系统参数是共性的，也可以在管理界面中创建。管理界面中创建的系统参数，统一命名规则为 ：Common + 下划线 + 系统参数名称Common_<SystemParameterName>系统参数名采用首字母大写的驼峰样式。例如：Common_CurrentEnvDomain 、Common_ClientTimezone创建系统参数的时候，勾选“使用命名空间”这个选项，确保跨租户全局唯一。另外，系统参数名需要能尽可能地表明参数的业务含义，避免与其它参数混淆或者完全看不出业务含义。

错误码使用原则原则上，系统里面所有的报错或者提示信息，都禁止直接在代码里面硬编码，必须使用错误码的形式。错误码的命名，必须遵循错误码命名规范。错误码要配置在APP或者BO内。错误码命名规范BO名称/APP名称+“.”+错误码名称。错误码名称采用大驼峰的方式，通常采用简练的英文单词，不要使用汉语拼音。状态码不能返回4xx，否则页面会跳转到登录页。错误码的中英文错误信息都要写。错误参数信息不能使用 \ ，应该使用{0}。错误码定义范例全部错误码需要在业务平台上查看。APP错误码名称英文错误信息状态码中文错误信息AlarmBOAlarm.ServiceUnAvailableThe request has failed due to a temporary failure of the server.500服务不可用。Alarm.InvalidOperatorThe input operator is invalid.500非法操作符类型。Alarm.illegalParameterThe input parameter is illegal.500非法参数类型。

当前园区的版本可以支持私有云部署吗？客户这边已经搭建了第三方的私有云平台，并且不想使用公有云。平台可以部署到客户的私有云上面吗？

设计原则开发者平台高级页面开发模式下页面是由N个widget构成（N>=1）。widget可以理解为页面中的小组件，组件的拆分根据具体的业务和组件的服用情况进行拆分。如果某个页面不可拆分或者无服用场景，则可以只有一个widget构成。组件存在的最主要的意义是可在不同页面中被复用。理论上拆分越细，可被复用的概率会越大。但是这带来的副作用是页面开发的复杂度上升。所以拆分的力度需要进行综合的考虑。Widget命名Widget命名采用三段式命名：命名空间_业务名称_widget(固定字段)，业务名称采用大驼峰命名。函数/方法注释函数/方法注释采用典型的JSDoc的注释方式。函数注释入参说明：@param + 1个空格+ {参数类型} + 1个空格 + 参数名+ 1个空格 + 参数说明。函数注释出参说明：@return + 1个空格 + {参数类型} + 1个空格 + 出参说明（若没有出参，则出参说明可不写）。有关键逻辑或者重大变更时，增加改动者及改动描述。【示例】： /** * 在地图上创建标志 * * @param {String} latLng 经纬度信息 * @param {Object} mapInfo 地图描点信息 * @return {Boolean} 在地图上创建点选标志的结果 * @version 20180310 modify by xxx shangsan 修改地图上描点的样式 * @version 20180314 modify by xxx wangwu 在地图上描点增加事件发送，供外部订阅 */ var placeMarkerAndPanTo=function(latLng, mapInfo) { //返回创建点选标志的结果 return true; }方法内注释方法内使用单行注释，以“//”开头。对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置。【示例】：var placeMarkerAndPanTo=function(latLng, mapInfo) { //返回创建点选标志的结果 return true; }FTL注释在一些主要节点标签结束的后边加上注释。【示例】：<div class="success-operate"> <a href="javascript:;" class="btn-md-red" @click="trackOrder">Track Order</a> <!-- btn-md-red end 跳转到订单详情页查看订单--> <a href="javascript:;" class="btn-md-primary" @click="continueShopping">Continue Shopping</a> <!-- btn-md- primary end 跳转到商城首页继续购物--> </div>在一些循环结束的后边加上注释。【示例】：<li class="li-tab" v-for="(item,index) in g_viewOrderData.tabsParam"> <div class="item-wrap"> <div class="img-wrap"> <img :src="item.url"></img> </div> <div class="wid-tab-text">{{item.value}}</div> </div> </li><!--loop end 遍历订单上的状态页签，获取名称和链接-->样式文件样式文件中图片及字体文件的引用，需使用相对路径。字体文件需要放置在与样式文件同级的目录中，目录名称为font、fonts（两个任选其一即可），可设置子层目录，子层目录命名无要求。目录及图片、文件的命名仅支持如下字符：数字、字母（大小写均可）、下划线、中划线。支持的图片格式包含如下：png、jpg、jpeg、gif、bmp、webp。支持的字体文件格式包含如下：tiff、woff、ttf、otf、eot、svg。多个Widget样式可以抽取为单独库文件，独立库文件可以方便进行整体样式主题的切换。缺点是widget的运行需要对这个库文件产生依赖。如果widget比较独立，也可以将样式文件定义到widget作用域的css中。响应式设计Widget需要支持响应式设计，页面需要在多屏下进行充分测试验证。浏览器兼容性组件开发需要考虑浏览器兼容性，对多浏览进行适配验证。需要支持IE10+，Chrome，Safari，Firefox，移动端需要考虑支持UC、QQ浏览器，Android Chrome，iOS Safari等。桥接器BridgeWidget数据访问需要封装到Bridge中，不允许在widget中直接通过ajax访问业务数据服务。通过Bridge的封装，可以保持widget的稳定性。未来数据源的切换不需要升级widget，只需要切换Bridge即可。对于数据消费类的Bridge，mock目录不允许为空。Mock数据会在编辑状态加载，如果直接调用API可能会因为API的不稳定而引起UI渲染异常。一个查询API一个Bridge，更新API当前可以共用同一个Bridge。前端对象需要在Bridge中进行明确定义，字段清晰。开放性Widget自身是开放的，直接引用业界的优秀的开源组件可以提高开发效率。在开发过程中可以按需引入。例如使用MVVM框架Vue（Vue相比AngularJS更轻量，性能更优）以及使用基于Vue的前端控件库Quasar，Element-UI。不允许引入JQuery。框架已经默认提供，引入后会引起运行冲突异常。非特殊场景组件的尺寸大小不建议固定值，可以指定最大/最小值。非特殊场景不允许直接对DOM元素添加CSS，DOM元素的样式通过显式的class引用，保证样式只作用在当前组件。