智慧楼宇智能化管理系统详细设计说明书

智慧楼宇智慧化管理系统

详细设计说明书

目录

1引言...............................................................................1

1.1目的...........................................................................1

L2范围...........................................................................1

1.3参考资料......................................................................1

1.4术语与缩略语..................................................................1

2设计内容及方法....................................................................1

2.1设计要求......................................................................1

2.1.1后台处理开发框架..........................................................1

2.1.2目录结构...................................................................3

2.1.3前端展现设计要求..........................................................7

2.2设计方法和工具................................................................8

3应用功能设计......................................................................9

3.1系统公共......................................................................9

3.1.1登录页面..................................................................9

3.1.2系统首页...................................................................9

3.2智慧化展示...................................................................14

3.2.1用能分布.................................................................14

3.3智慧化管理...................................................................14

3.3.1能耗监测..................................................................14

3.3.2配电监测.................................................................34

3.4智慧化评价...................................................................35

3.4.1评价管理.................................................................35

342评价报告..................................................................36

3.4.3系统维护..................................................................37

3.4.4功能项维护...............................................................39

3.5信息管理.....................................................................41

251能耗字曲配置..............................................................41

352用户管理..................................................................42

3.5.3角色管理.................................................................44

3.5.4菜单维护.................................................................45

3.5.5建筑类型维护.............................................................47

3.5.6建筑维护.................................................................48

3.5.7分类分项信息维护.........................................................50

3.5.8楼宇环境参数配置.........................................................51

359楼宇定额配置..............................................................53

3.5.10设备类型维护............................................................54

3.5.11设备台帐管理............................................................56

3512采集器管理...............................................................57

3.5.13变量维护................................................................59

3.5.14集成系统维护............................................................60

3515设备分组维护.............................................................61

3516楼宇用能数据录入.........................................................63

3.5.17表计用能数据录入........................................................65

3518设备参数数据录入.........................................................67

1引言

1.1目的

本文件的目的是向读者说明楼宇智慧化管理系统的设计实现，详细描述各功能模块的实

现方式、设计类、程序流程等。

本文件是用于指导后续的代码编写、平台配置。

本文件面向的读者是：楼宇智慧化管理系统的设计人员、开发人员、测试人员以及参与

和本系统进行集成的相关人员。相关设计人员、开发人员应该阅读全文，其他人员可以按自

己兴趣选择章节阅读。

1.2范围

楼宇智慧化管理系统（以下简称“楼宇智慧化管理系统”）在功能上划分为智慧化展示、

智慧化管理、智慧化评价、信息管理等4大模块。

楼宇智慧化管理系统需要实现与三维地图、BIM运维、配电系统、空调机组、风机盘管、

空调循环泵、电梯、给排水、环境、污水等11大系统的集成，以实现信息共享和数据互通。

楼宇智慧化管理系统需要实现自身的数据共享，提供API数据接口供其他系统调用。

1.3参考资料

1.4术语与缩略语

术语、缩略语解释

类国是在面向对象的系统模型中使用得最普遍的图。类图包含了一组

类图类、接口和协作以及他们之间的关系，使用类图来为系统的静态视图建

模

SOAServiceOrientedArchitecture,面向服务的架构

服务采用标准方式（例如WSDL）描述的功能，例如Web服务，为目前江

苏电力应用集成所使用的主要技术。

服务提供者计算机服务功能技术实现实体（业务应用系统或企业其他信息系统，例

如身份认证系统）。

服务消费者服务的调用者，即服务客户端。

2设计内容及方法

2.1设计要求

2.L1后台处理开发框架

楼宇智慧化管理系统后台处理基于Framework4.0+MVC4.0开发框架进行设计及

开发，系统分层如下图:

I

View

SQL1

Other...

ServerJ「

各层含义说明如下：

View：视图层，主要是aspx页面或者是Razor视图，负责收集用户数据，向用户展示数

据，引入ajax技术,采用异步处理,改进用户体验;由RoutingSystem负责拦截http请求,根据

情况调用不同的控制类，根据请处理结果返回不同的视图，大部分的情况都是返回json数据。

RoutingSystem：前端控制器，由RoutingSystem负责拦截http请求，根据情况调用不同

的控制类，根据请处理结果返回不同的视图，大部分的情况都是返回json数据。

MVCHandle：前端过滤器，Mvc提供Authorization、ExceptionAction>ResultFilters等

几个过滤器，对一个请求的授权、异常处理、Action调用前后的处埋、返回结果前后的处理都

提供了扩展点，方便系统的统一处理功能的实现。

Controller：接收客户端的数据•，交由业务规则层处理，并将结过返回给View。

BLL：业务规则层，负责业务逻辑的处理及计算，并将结果反馈给Controller。

DIL：数据接口访问层，负责将DAL层的数据库实体数据，转换成业务类数据，并交由

BLL层。

DAL：负贡数据库的访问、写入等操作，且仅在此层与数据库有直接交互，返回数据库

2

实体数据给DIL层。

Modal：数据库实体类层，封装与数据库结构一致的数据实体类，该类在出View之外的

各层中流转。

数据库层：支持Sqlscrver、Oracle等主流关系型数据库。

2.1.2目录结构

根据系统分层设计，项目中设计10个工程，每个工程对应一个目录：

NLA：通用类库，存放不含业务逻辑的公共类库(可直接移植到其它解决方案使用)，如：

日志记录帮助类(Log4Nel)、数值类型转换扩展类(Extensions)、各种工具类等(MD5Helper)。

NLA.Data：数据摩连接对象管理类库，数据库连接对象组装。

NLA.DataHelper：数据库连接对象方法使用封装类库。包括配置库(ConfigSqlHelper)、基

础库(MeterBaseSqlhelper)、关系库(RelationSqlHelper)。

NLA.EnergyManagc.BLL：业务逻辑处理，存放各页面业务逻辑处理类。每个模块对应一

个文件夹(文件夹名称与前端模块名称相同)，每个前端页面对应一个类文件(类文件名称为前

端页面名称+BLL)。公共的业务逻辑处理类库放在Common文件夹中，如ECharts数据组装类

库(ECharlsBLL)。各页面BLL之间禁止相互调用(Common文件夹下的BLL除外)。

NLA.EnergyManage.Common：通用帮助类库，存放与业务逻辑相关的通用帮助类库。如：

BaiduEChartSxBootStranTable、Cache>Cookies>EasyUI-TreesSession等。

NLA.EnergyManage.Controller：控制器层，MVC中的控制器层。每个前端模块对应一个

文件夹(文件夹名称与模块名称相同)，每个前端页面对应一个控制器类文件(文件名称为页面

名称+Conlroller)。每个模块文件夹下有一个与模块名称对应的Controller类：存放该模块下所

有前端页面的导航跳转功能。该层主要实现的功能：解析前端页面传递的参数、调用业务逻

辑处理层(BLL)、向前端页面返I川结果。

NLA.EnergyManage.DIL：数据接口访问层，负责将DAL层的数据库实体数据，转换成业

务类数据。

NLA.EnergyManage.DAL：数据库访问层。该层中每个数据库对应一个文件夹，配置库：

Energy_Configs基础库：Encrgy_MctcrBase关系库：Encrgy_Rclationo每个文件夹下都有一

个该库的通用操作类：EnergyConfigDAL>EnergyMetsrBaseD/\L>EnergyRelationDALo这3

个DAL中都是针对3个数据库的通用操作方法，如有需特殊化处理的，根据数据库表名命名，

如：BuildBaselnfoDALoBaseDAL:存放DAL模块的通用方法。PaginationDAL：分页查询操

作类。该层只负责读取、返回数据，不负责对数据进行业务相关的处理。

3

NLA.EncrgyManagc.Model；实体类层，该层L要存放数据库表实体类对象、自定义实体

对象、前端各页面数据对象等。

NLA.EnergyManage.Web：前端模块层，该层主要存放前端html页面、脚本文件、css样

式文件、第三方脚本库等。

设计命名要求

开发中遵循以下2种命名规范：

Pascal命名规则

所有单词第一个字母大写，其他字母小写

例如：BackColor

Camel命名规则

大小写形式一除了第一个单词，所有单词第一个字母大写，其他字母小写。

例如：backColor

各类标志符规范示例如下:

标识符大小写示例

类PascalAppDomain

枚举类型PascalErrorLevel

枚举值PascalFatalError

事件PascalValueChange

异常类PascalWebExceplion

只读的静态字段PascalRcdValuc

接口PascalIDisposable总是以I前缀开始

方法PascalToString

命名空间PascalSystem.Drawing

属性PascalBackColor

很少使用。属性优于

公共实例字段PascalRedValue

使用公共实例字段。

很少使用。属性优于

受保护的实例字

CamelredValue使用受保护的实例

段

字段,

私有的实例字段CamelredValue

控制层设计

登录控制器LoginComroller需继承原生的控制器System.Web.Controller,其它控制器均需

继续控制器基类BaseCcntroller,BaseConlrollei■类图设计如下：

4

：7..............、

BaseController灸]

：类

jfController

[,方法

**BaseController

p*DownLoadResponse

汽GetErrorJsonResult

工GetlsonResult<T>(+2簸)

成员详细信息设计如下图:

名称

」方法

t>/BaseControllerprotected构造函数

t>%DownLoadResponsevoidprotected客户i*文件下栽

t.GetErrorJsonResultJsonResultprotected向喜户端反馈e照果（异常）

t>/GetJsonResult<T>JsonResultprotected向富户端反馈a隅果（成功）

t%GeUsonResultJsonResultprotected向客户湍反堵的结果

t%GeUsonResultJsonResultprotected向客户就反宿的结果（成功）

■＜添加方法〉

/星性

夕

/宇瑙

夕

BaseController中特性:

增加UserLoginAuthorize特性，确保每次被请求时都经过是都登录的校验

增加SessionState特性，确保该控制器支持Ajax多线程请求

各控制器返回数据格式约束如下:

publicJsonResullGetDataO

^region获取参数及组装对象

#endregion

try

*re”on调用BLL获取数据

itendregion

^region调用BLL组装业务返回数据

#endregion

〃返回结果

returnbase.GetJsonResult(data);

L

catch(Exceptionex)

5

〃异常处理

returnbase.GetErrorJsonResu]t(z，thisController","GetData”,ex);

}一

finally

(

〃释放资源

)

业务逻辑层设计

业务逻辑处理.，存放各页面业务逻辑处理类。每个模块对应一个文件夹（文件夹名称与前

端模块名称相同），每个前端页面对应一个类文件（类文件名称为前端页面名称+BLL）。公共的

业务逻辑处理类库放在Common文件夹中，如ECharts数据组装类库（EChartsBLL）。各页面

BLL之间禁止相互调用，接口格式规约如卜.：

///<summary>

/〃获取指标数据

〃/〈/summary〉

<paramnamewcustomQuotaParamz，>#^[<,patani>

///<returns></returns)

publicEnergyEffect.CustomQuota.DataGetData(intaccountSetID,CustomQuota.Param

customQuotaParam)

(

//定义返回数据对象

varreturnData-newEnergyEffect.CustomQuota.Data();

〃调用DAL层数据库取数

〃业务逻辑处理

returnreturnData;

(

数据访问层设计

数据访问层，负责数据库的访问、写入等操作，且仅在此层与数据库有直接交互，所有

SQL语句均在数据访问层中编写，不允许在其它类中写SQL,格式如下，使用=@来表示与

参数的匹配。数据访问层代码格式规约如下：

///<summary>

/〃读取关系口汇总数据列表

///〈/summary〉

6

‘〈paramname="relationlD”>关系lD</param>

///〈paramname"startTime”»F始时间〈/param〉

///<paramname="stopTime”>结束时间</param>

///<returns></returns'*

publicList<SumData>GetDataList(intrelationlD,DateTimestartTime,DeteTime

stopTime)

{___________________________________________________________________________

定义返回数据对象

List<SumData>resultList=newList<SumData>();

〃定义SQL丽-

//参数化查询对象定义

〃数据库取数

returnresultList;

r

2.1.3前端展现设计要求

前端View层，是Razor视图，负责收集用户数据，向用户展示数据，采用Jqueiyajax和

Controller进行数据交互。

使用技术及第三方组件包含Jquery、baiduEcharts、Bootstrap、EasyUI等。

目录结构

前端展现层目录结构设计如下：

7

展现层设计

展示层每个业务点包含一个后缀为chtml的html文件和一个js格式的脚本文件。

其中chlml引入展示层模版文件（模版文件中包含常用的CSS、JS文件），并引入业务js

文件，js类设计格式如下：

“usestrict*;

(function(win)(

〃登录页面：类

varLogin={

〃整体初始化

init:function(){

//页面脚本初始化

login:function(){

〃登录事件

},

win.Login=Login;

}(window));

Login,init();

2.2设计方法和工具

详细设计文档：详细设计文档采用MicrosoftWcrd2003进行编写，主要描述整个系统的

设计说明和相关的其它文件，作为程序开发人员理解系统设计的入口文件，使读者容易理解

8

设计思路。

3应用功能设计

3.1系统公共

3.1.1登录页面

用户登录

1）功能描述

用户登录输入用户名和密码，点击登录按钮进行系统登录。

2）接口设计

接口名称Login

接口地址Login/Login

输入参数UserName：用户名

PassWord：密码

返回参数LoginSuccess：true|false.是否登录成功

LoginMsg：登录失败是的错误提示

3.1.2系统首页

加载菜单

1）功能描述

用户登录后加载侧边栏菜单。

2）接口设计

接口名称GetData

接口地址Menu/GetData

输入参数无

9

返回参数Success：truelfalse

Msg：返回消息信息

MainData：菜单数据项集合

修改密码

1）功能描述

用户登录后修改密码

2）接口设计

接口名称EditPassWord

接口地址EditUserPassword/EditPassWord

输入参数PassWord：原密码

NewPassWord：新密码

返回参数Success：truefalse

Msg：接口消息

环境参数

1）功能描述

展示首页环境参数面板

2）接口设计

接口名称Environment

接口地址Cesktop/Environment

输入参数无

返回参数Success：true|false

VSR：接口消息

10

WainData：环境参数数据集合

基本能耗信息

1）功能描述

展示首页技能能耗信息面板

2）接口设计

接口名称GetBaseEnergyData

接口地址Desktop/GetBaseEnergyData

输入参数无

返回参数Success：true|false

Msg：接口消息

MainData：Bootstrap表格数据

Top排名

1）功能描述

展示首页能耗排名面板

2）接口设计

接口名称EnergySort

接口地址Desktop/EnergySort

输入参数£

返回参数Success：truefalse

Msg：接口消息

MainData：BaiduEchart数据

11

本年能耗

1）功能描述

展示首页本年能耗面板

2）接口设计

接口名称GetMonthData

接口地址Cesktop/GetMonthData

输入参数无

返回参数Success：true|false

Msg：接口消息

MainDatA：RaiduErhart数据

实时负荷

1）功能描述

展示首页实时负荷面板数据

2）接口设计

接口名称GetPower

接口地址Desktop/GetPower

输入参数无

返回参数Success：true|false

Msg：接口消息

MainData：BaiduEchart数据

分项能耗

1）功能描述

展示首页分项能耗面板。

12

2）界面设计

3）接口设计

接口名称GctSubEncrgyData

接口地址Desktop/GetSubEnergyData

输入参数无

返回参数Success：true|false

Msg：接口消息

MainData：BaiduEchart数据

智慧化水平排名

1）功能描述

展示首页智慧化水平排名面板

2）接口设计

接口名称GetLevelSort

接口地址Cesktop/GetLevelSort

输入参数无

返回参数Success：true|false

Msg：接口消息

MainData：BaiduEchart数据

13

3.2智慧化展示

321用能分布

3.3智慧化管理

3.3.1能耗监测

加载监测点

1）功能描述

加载左侧用能对象树，其它业务点接口相同时省略

2）接口设计

接口名称GetTrecDataList

接口地址Iree/GetTreeDataList

输入参数TreeType：树类型，默认：build

Farams：参数

ShowRootAccount：是否显示根节点

返回参数Success；true|false

Msg：接口消息

MainData：EasyUItree数据集合

加载能耗字典列表

1）功能描述

加载左侧能耗字典对象树，其它业务点接口相同时省略

2）接口设计

接口名称GetTreeDataList

接口地址Iree/GetTreeDataList

输入参数TreeType：树类型，默认：energy

Farams：参数

ShowRootAccount：是否显示根节点

返回参数Success：true|false

Msg：接口消息

MainData：EasyUItree数据集合

获取负荷数据

1）功能描述

获取用能对象负荷图表数据和表格数据

2）接口设计

接口名称GetData

接口地址FowerMonitor/GetData

输入参数NodeType：树类型

NodelD：树节点ID

EnergyItemCode：能耗字典Code

SlartTimc：开始时间

StopTimc：结束时间

ShowWorkTime：是否包含工作时间

ShowRestTime：是否包含休息时间

返回参数Success：true|false

Msg：接口消息

MainData：BaiduEchart图表数据.Bootstrap表格数据

15

能耗数据查询

1）功能描述

获取用能对象能耗数据图表和表格数据

2）接口设计

接口名称GetData

接口地址CumulantMonitor/GetData

输入参数NodeType：树类型

NodelD：树节点ID

EnergyItemCode：能耗字典Code,默认A1000

StartTime：开始时间

StopTime：结束时间

ShowWorkTime：是否包含工作时间

ShowRestTime：是否包含休息时间

DataSizc：数据粒度

返回参数Success：truefalse

Msg：接口消息

NbinData：BaiduEchart图表数据，Bootstrap表格数据

用电查询

1）功能描述

获取用能对象用电数据图表和表格数据

2）接口设计

接口名称GetData

16

接口地址CumulantMonitor/GetData

输入参数NodeType：树类型

NodelD：树节点ID

EnergyItemCode：能耗字典Code,默认00000

StartTime：开始时间

StopTime：结束时间

ShowWorkTime：是否包含工作时间

ShowRestTimc：是否包含休息时间

DataSize：数据粒度

返回参数Success：true|false

Msg：接口消息

MainData：BaiduEchart图表数据,Bootstrap表格数据

用水查询

1）功能描述

获取用能对象用水数据图表和表格数据

2）接口设计

接口名称GetData

接口地址CumulantMonitor/GetData

输入参数NodeType：树类型

NodelD：树节点ID

EnergyltemCode：能耗字典Code,默认02000

StartTime：开始时间

17

StopTimc：结束时间

ShowWorkTimc：是否包含工作时间

ShowRestTime：是否包含休息时间

DataSize：数据粒度

返回参数Success：true|false

Msg：接口消息

MainData：BaiduEchart图表数据,Bootstrap表格数据

负荷类比分析

1）功能描述

获取多用能对象负荷数据图表和表格数据

2）接口设计

接口名称GetDala

接口地址PowerAna1ogy/Getl)ata

输入参数NodcTypc：树类型

NodelD：树节点ID

EnergyItcmCode：能耗字典Code,默认A1000

StartTime：开始时间

StopTime：结束时间

ShowWorkTime：是否包含工作时间

ShowRestTime：是否包含休息时间

返回参数Success：truefalse

Msg：接口消息

MainData：BaiduEchart图表数据:Bootstrap表格数据

18

用能类比分析

1）功能描述

获取多用能对象用能数据图表和表格数据

2）接口设计

接口名称GetData

接口地址EnergyAnalogy/GetData

输入参数NodeType：树类型

Node"）：树节点ID

EnergyItemCode,能耗字典Cede,默认0000（）

StartTime：开始时间

StopTime：结束时间

ShowWorkTime：是否包含工作时间

ShowRestTime：是否包含休息时间

DataSize：数据粒度

返回参数Success：ti'uelfalse

Msg：接口消息

MainData：BaiduEchart图表数据；Bootstrap表格数据

负荷时段类比

1）功能描述

获取多用能对象负荷数据图表和表格数据

2）接口设计

接口名称GetData

19

接口地址IimeAnalogy/GetData

输入参数NodeType：树类型

NodelD：树节点ID

EnergyItemCode：能耗字典Code

StartTime：开始时间

StopTime：结束时间

返回参数Success：truelfalse

Msg：接口消息

MainData：BaiduEchart图表数据,Bootstrap表格数据

用能时段类比

1）功能描述

获取多用能对象用能数据图表和表格数据

2）接口设计

接口名称GctData

接口地址HnergyTimeAna1ogy/GetData

输入参数NodeType：树类型

NodelD：树节点ID

EnergyItemCode：能耗字典Code

Star（Time：开始时间

StopTime：结束时间

返回参数Success：truelfalse

Msg：接口消息

MainData：BaiduEchart图表数据,Bootstrap表格数据

20

占比分析

1）功能描述

获取多用能对象用能占比数据图表和表格数据

2）接口设计

接口名称GetData

接口地址RatioOnTotal/GetData

输入参数NodeType：树类型

NodeID：树节点ID

HnergyItemCodej能耗字典Cede

StartTime：开始时间

StopTime：结束时间

RatioType：查询分类

RatioNormal：查询类型

返回参数Success：truelfalse

Msg：接口消息

MainData：BaiduEchart图表数据:Bootstrap表格数据

同比分析

1）功能描述

获取多用能对象用能同比数据图表和表格数据

2）接口设计

接口名称GetData

接口地址YearOnYear/GetData

21

输入参数NodeType：树类型

NodeID：树节点ID

EnergyItemCode：能耗字典Code

StartTime：开始时间

StopTime：结束时间

SelFunc：数值类型

返回参数Success：truefalse

Msg：接口消息

MainData：BaiduEcharl图表数据，Bootstrap表格数据

环比分析

1）功能描述

获取多用能对象用能环比数据图表和表格数据

2）接口设计

接口名称GetDala

接口地址MonthOnMonth/GetData

输入参数\odcTypc：树类型

NodelD：树节点ID

EnuigyItciiiCvdc:能耗字典Cu加

StartTime：开始时间

StopTime：结束时间

SelFunc：数值类型

返回参数Success：true|false

22

Msg：接口消息

MainData：BaiduEchari图表数据.Bootstrap表格数据

排名分析

1）功能描述

获取多用能对象用能排名数据图表和表格数据

2）接口设计

接口名称GetData

接口地址EnergyPublic/GetData

输入参数NodeType：树类型

NodelD：树节点ID

EnergyItcmCodc：能耗字典Code

StartTime：开始时间

StopTime：结束时间

CataSize：数据粒度

返回参数Success：true|false

Msg：接口消息

MainData：BaiduEchart图表数据:Bootstrap表格数据

自定义指标分析

1）功能描述

获取多用能对象指标数据数据图表和表格数据

2）接口设计

接口名称GetData

23

接口地址CustomQuota/GetData

输入参数NodeType：树类型

NodelD：树节点ID

EnergyItemCode：能耗字典Code

StartTime：开始时间

StopTime：结束时间

QuotaCode：指标参数Code

CataSizc：数据粒度

返回参数Success：true|false

Msg：接口消息

V.ainData：BaiduEchart图表数据.Bootstrap表格数据

指标参数字典维护

列表数据查询

1）功能描述

获取指标参数字典列表数据

2）接口设计

接口名称GetData

接口地址QuotaDictMaintain/GetData

输入参数无

返回参数Success：true|false

Msg：接口消息

MainData：Bootstrap表格数据

24

单个数据提取

1）功能描述

提取单个数据进行查看或修改

2）接口设计

接口名称GetDataByCode

接口地址QuotaDictMaintain/GetDataByCode

输入参数QuotaCode：指标参数字典Code

返回参数Success：truefalse

Msg：接口消息

MainData：T_DT_QuotaDict对象

保存

1）功能描述

保存指标参数字典单个数据

2）接口设计

接口名称EditData

接口地址QuotaDictMaintain/EditData

输入参数TDTQuotaDict：QuotaDict对象

返回参数Success：true1false

Msg：接口消息

删除

1）功能描述

删除单个指标参数字典

25

2）接口设计

接口名称DeletcData

接口地址QjotaDictMaintain/DeleteData

输入参数QjotaCodc：指标参数字典Code

返回参数Success；true)false

.\hg：接口消息

指标参数数据维护

列表数据查询

1）功能描述

获取指标参数列表数据

2）接口设计

接口名称GetData

接口地址QuotaDataNfaintain/GetData

输入参数无

返回参数Success：true|false

Msg：接口消息

MainData：Bootstrap表格数据

单个数据提取

1）功能描述

提取单个数据进行查看或修改

2）接口设计

26

接口名称GetDataByCode

接口地址QuotaDataMaintain/GetDataBylD

输入参数