告警组件详细设计说明.docVIP

PAGE 告警组件 概要设计 V2.0 产品名称：车店通系统 文件编号：2014-06-25 北京车网互联科技股份有限公司 2014年06月 SUBJECT \* MERGEFORMAT Project Name Version: 1.0 TITLE \* MERGEFORMAT Software Architecture Document Date: yyyy-mm-dd document identifier Page PAGE 4 of NUMPAGES \* MERGEFORMAT 7 文档简介 文档目的 文档范围 [文档的Scope，非项目的Scope。否则造成同一项目多个文档之间的内容重复，不利于文档维护。] 定义、缩写词和缩略语 [集中列举文档中的定义、缩写词和缩略语。] 参考资料 架构描述方式 [为了让读者更好地理解《架构文档》，在本节应当说明文档涉及的架构视图，并指明为了描述设计决策用到了哪些图表和模型。] 架构视图阅读指南 业务模型分析 系统功能（待补充） 告警组件定位： 将应用系统接收的告警信息，通过告警组件通过短信或推送等方式通知业务展示层。 组件可根据配置对上报的告警消息做归并处理。 系统所处的环境（待补充） 架构设计目标 业务需求和约束因素 功能 质量 约束 业务级需求 业务目标及愿景： 1.重复告警归并 2.告警设置 3.告警通知设置 4.告警发送指定用户 5.发送指定组 用户级需求 通过pom集成 通过配置文件配置不同类型事件的相应 轻量级框架，快速集成到应用系统中 开发级需求 组件工作流程分析 告警组件集成在应用系统中，通过应用系统收集告警信息，并将告警信息通过配置策略分发至指定客户端。 逻辑架构视图 组件依赖关系 接口设计与协作机制 重要设计包 包接口图 开发架构视图 alarm-core 目录结构指导 包名目录 职责 cess 事件处理： EventConsumer 事件MQ的 接收类 EventProcess 事件处理接口 AlarmProcess 告警事件处理类 ， EventProcess接口的实现 .carsmart.event.controller 逻辑控制 EventController .carsmart.event.entity 业务实体类 ConllisionAlarm 碰撞告警实体类 VehicleRollAlarm 车辆翻滚告警 .carsmart.event.config 组件配置包 Config 配置文件类 .carsmart.event.notify 告警通知类： SmsUtils 短信通知工具 PushUtils 推送工具 .carsmart.event.generate 告警生成包 generateEvent ：告警生成类 .carsmart.event.repository 数据库操作层 Message消息表数据库操作类 .carsmart.event.module AlarmManagerModule告警管理guice module 注： AlarmManagerModule 将告警数据库实体注入。 应用系统使用组件时只需在guiceConfig中引入 AlarmManagerModule 即可。 GenerateEvent 是接口类 ，需要应用系统对其实现。想·想· 配置文件 config eventType eventCodecollisionEvent/eventCode eventName碰撞事件/eventName evnetProcess.carsmart.alarm.AlarmProcess/evnetProcess entity.carmsart.alarm.entity.ConllisionAlarm/entity alarmLevel4/alarmLevel generateEventClass.carsmart.cdt.generateEvent/generateEventClass timeOut/timeOut notifyWaysms/notifyWay /eventType /config 配置说明： eventType 事件码 eventName 事件名 evnetProcess 事件处理类 默认为AlarmProcess 若，各子系统对相应的事件有不同处理，可自己实现EventProcess接口。 若无此配置项则系统自动丢弃改类事件。 entity 告警事件 实体类 alarmLevel 告警级别 generateEventClass 生成事件的实现类。 timeOut