1       引言

1.1     目的

用于社会化开发平台的架构设计指导，阐述基础设施及关键技术构件、业务构件的设计思想及具体实现。

读者包括但不限于社会化开发平台的研发人员，使用社会化开发平台的产品定制人员以及公司外部的二次开发者。

1.2     参考资料

《架构使用说明书》

《业务使用说明书》

《皮肤设计机制》

1.3     引用术语与缩写解释

2       “平台+应用”设计思想

2.1     设计思想

2.1.1 目的

1. 开发架构清晰，易于维护；

2. 提升开发效率；

3. 提升产品的可扩展性；

4. 什么是应用？

2.1.2 概念

应用指产品中的功能模块，具有以下特征：

1)         具有一定独立性的完整的功能模块；

2)         可以在产品中安装、卸载、禁用/启用；

3)         可以在呈现区域安装、卸载（如果允许在呈现区域安装）；

4)         应用可以设置为锁定状态，锁定的应用不允许卸载（可以禁用）；

1. 什么是呈现区域?

呈现区域之间彼此隔离，具有独立性，可以有独立的皮肤设计规约及导航，皮肤都是针对呈现区域进行设计的，呈现区域可以看作多个应用数据的容器。频道、用户空间、群组空间、后台，都是呈现区域，都可以定义自己的皮肤及导航。

1. 什么是呈现区域实例？

是指呈现区域在运行期间生成的一个具体可以使用的实例，呈现区域分为单例和多例，每个呈现区域实例都有自己的Owner。例如：

1)         频道、后台属于单例：Owner=0；

2)         用户空间、群组空间属于多例：Owner为UserId或GroupId；

1. 应用与呈现区域的关系

1)         1个应用可以在多个呈现区域中使用，可以为不同的呈现区域提供数据；

2)         1个呈现区域下，可以有多个应用，为应用数据提供统一的导航及皮肤设计；

2.1.3 设计要点

图表1应用设计整体设想

1. 应用应该保持独立性：

1)         应用设计在物理上、逻辑上尽量独立；

2)         尽量避免应用之间的依赖；

1. 应用的设计主要包括两部分的内容，一部分是数据另一部分是如何呈现；

2. 应用的数据部分支持多租户，租户可以是呈现区域（PersentArea）也可以是另一个应用。

2.1.3.1    数据部分

在数据库设计方面采用最简单的方式，在应用数据表中增加TenantTypeId（存储对应的PersentAreaKey或ApplicationId）。

2.1.3.2    呈现部分

按照当前的皮肤设计机制，应用的View仅有一份（在所有皮肤中共用），而导航等UI元素的风格又经常会在不同皮肤中进行调整，因此必须把这一部分UI元素交由平台部分进行设计，各应用仅对外公布呈现这部分UI元素的数据。基于这个原因，需要抽象出来的UI元素包括：导航、管理菜单、快捷操作，这几个UI元素在不同的呈现区域各不相同因此应该重新设计。

2.2     设计实施

2.2.1 设计规则

1. 应用可以由开发者设置为锁定状态，锁定状态的应用不允许删除（可以禁用）；

2. 应用在呈现区域可以设置为内置应用：

1)         内置应用不允许卸载；

2)         内置应用属于自动安装应用（无论自动安装属性设置何值）；

1. 应用在呈现区域可以设置为自动安装：创建呈现区域实例时，自动安装到该呈现区域中；

2. 在站点安装/卸载（目前仅考虑手动进行安装/卸载）时需要添加/移除以下数据：

2.2.2 安装/卸载

1)         tn_Applications：应用表；

2)         tn_ApplicationInPresentAreaSettings：应用在呈现区域的设置；

3)         tn_InitialNavigations：应用在呈现区域的初始化导航；

4)         tn_ApplicationManagementOperations：应用在呈现区域的管理操作；

1. 在呈现区域安装/卸载（由呈现区域实例Owner在管理界面执行）时需要添加/移除以下数据：

1)         tn_ApplicationInPresentAreaInstallations：应用在呈现区域的安装记录；

2)         tn_PresentAreaNavigations：呈现区域实例的导航数据；

3)         应用数据中与该呈现区域实例相关的数据（卸载时需要考虑）；

1. 在其他应用安装/卸载：

1)         当前底层设计支持一个应用安装在另一个应用中；

2)         由开发者自行完成；

2.2.3 平台支撑

为了最大限度提升应用的开发效率，把应用开发常用的代码封装成可重用的技术构件（Infrastructure）和业务构件（BusinessComponents）。

图表2平台+应用详细视图

3       应用开发指导

3.1     开发流程概览

3.2     建立应用的目录结构

3.2.1 手动建立

您可以手动的建立您的应用目录结构：

1. 在Web/Applications/建立以应用的ApplicationKey命名的Web Application；

2. 在Web/Applications/{ApplicationKey}/建议包含以下目录结构：

图表1应用模块目录结构

3.2.2 自动建立

您还可以使用我们提供的AppHelper程序来自动生成目录结构。点击附件进行下载：[attach:2818]

图表2 AppHelper

3.3     开发必需的程序代码

1. 从ApplicationBase派生自己的Application类，必须实现以下方法：

1. 从ApplicationConfig派生自己的应用配置类，必须重写以下属性：

1. 定义UrlRoutingRegistration.cs

1)         从System.Web.Mvc.AreaRegistration派生；

2)         使用ApplicationKey作为AreaName；

1. 如果需要则创建Application.config；

图表3开发应用需要实现的抽象类

3.4     配置应用

1. 创建应用（涉及到tn_Applications表）

1. 分析应用和呈现区域（涉及到tn_ApplicationInPresentAreaSettings表）

分析该应用可能会在那些呈现区域中使用，是否允许用户安装或卸载，是否为用户自动安装应用，是否会产生数据。具体配置说明如下：

日志配置示例如下：

1. 导航

分析应用在各个呈现区域会有哪些导航，导航的链接地址、图标会是什么，是否在新窗打开，具体配置说明如下：

日志配置示例如下：

1. 管理操作

日志配置示例如下：

3.5     开发必须的SQL脚本

• 安装脚本：需要考虑以下表的初始化数据：

1)         tn_Applications：应用表；

2)         tn_ApplicationInPresentAreaSettings：应用在呈现区域的设置；

3)         tn_InitialNavigations：应用在呈现区域的初始化导航；

4)         tn_ApplicationManagementOperations：应用在呈现区域的管理操作；

• 卸载脚本：

1)         清除安装时添加的数据；

2)         tn_ApplicationStatisticalData：应用统计数据；

3)         tn_PresentAreaNavigations：应用在呈现区域的导航数据；

4)         以及应用自身的数据；

• 升级脚本：由开发者根据应用情况自行设计；

4       高级应用

4.1     界面融合

要达到和现有皮肤整体风格保持一致，应用页面就需要使用预置的布局，具体说明如下：

a)         频道布局包括：app-1col.cshtml（通栏布局）、app-home-2cols.cshtml（应用首页两栏布局）、app-home-3cols.cshtml（应用首页三栏布局）、app-list-2cols.cshtml（应用列表两栏布局）、app-detail-2cols.cshtml（应用详情两栏布局）、app-form-2cols.cshtml（应用表单两栏布局）；

b)         群组布局包括：app-1col.cshtml（通栏布局）、app-list-2cols.cshtml（应用列表两栏布局）、app-detail-2cols.cshtml（应用详情两栏布局）、app-form-2cols.cshtml（应用表单两栏布局）、app-outer-home-2cols.cshtml（对外显示时，应用首页两栏布局）；

c)         用户空间布局包括：app-1col.cshtml（通栏布局）、app-list-2cols.cshtml（应用列表两栏布局）、app-detail-2cols.cshtml（应用详情两栏布局）、app-form-2cols.cshtml（应用表单两栏布局）、app-outer-home-2cols.cshtml（对外显示时，应用首页两栏布局）；

4.2     使用业务构件与平台深度开发

常用到的业务构件有：审核、动态、通知、积分、权限，具体请参见《业务构件使用说明书》

4.3     扩展新视频、音乐网站解析插件

1. 视频网站解析插件：

a)         在~/Plugins/MediaParsers/Video/目录下，创建View文件，并以视频网站的域名关键词（保证域名中包含该关键词，并与其它视频网站解析插件名不同即可）命名；

b)         编辑View文件，实现以下逻辑：

                         i.              匹配该视频网站的视频详细页面地址，匹配成功则继续以下操作；

                       ii.              抓取页面内容，分析出视频名称、视频播放地址、视频缩略图、视频描述，并构建ParsedMedia实体，保存至数据库；

                      iii.              输出ParsedMedia实体的Json格式。

1. 音乐网站解析，与视频网站解析类似。

4.4     使用ORM、缓存快速开发数据访问

参见《架构使用说明书》4.1之前版本[attach:2818]4.2版本[attach:5180]