博客分类: 官方教程

返回目录索引
原文链接：How Orchard Works
译文链接：Orchard扩展——Orchard的工作原理
本文为纯文字内容，稍显枯燥，不过若能全篇理一遍，对Orchard的整体架构技术可以有个比较好的了解。
另，本文有些内容个人看的时候还是一头雾水，有些地方翻译会比较晦涩。

构建一个web cms与常规的web应用有所不同，它更像是构建一个应用容器。当设计一个这类系统，我们需要把可扩展性作为首要功能特性。这是一个的挑战，因为开放式的架构会需要有很好的扩展性，但这可能需要降低应用的可用性来满足：系统中所有内容都需要能够和未来未知的模块进行组合，包括在UI层。将所有不互通的小部件组织为一个连贯的整体就是所谓的Orchard。

本文讲述了组成Orchard所做的架构选择，以及它是如何解决在提供灵活性的同时，又保证了良好的用户体验这一问题。

网站架构

Orchard基础

Orchard CMS是建立在现有框架和库之上的。以下是其中最基本的几个：

• ASP.NET MVC: ASP.NET MVC是一个现代的Web开发框架 —— 它提倡业务分离。
• NHibernate: NHibernate是一个对象关系映射工具。它用于处理Orchard内容项的持久化数据库存储，并在进行模块开发时，极大简化数据模型，以便于我们无需关注数据的持久化。你可以通过查看任何一个核心内容类型的源代码来查看示例，例如Pages。
• Autofac: Autofac是一个IoC容器。Orchard大量使用了依赖注入。通过实现IDependency接口（或继承自IDependency的特定接口——如标记接口）来创建一个可注入的Orchard依赖就项写一个类一样简单；而使用依赖就像使用正确类型的构造参数一样简单。注入的依赖项的使用范围和生命周期则由Orchard框架进行管理。你可以通过查看IAuthorizationService, RolesBasedAuthorizationService 和 XmlRpcHandler的代码来查看示例。
• Castle Dynamic Proxy: 我们使用Castle来进行动态代理生成。

Orchard应用及框架是在这些基础框架之上建立额外的抽象层。Orchard中有许多方法来实现具体功能内容，且不一定需要知道NHibernate, Castle, 或 Autofac。

Orchard框架

Orchard框架是Orchard中最低层的东西。它包含了应用程序的引擎以及不能继续拆分为模块的部分。那些东西通常是最基本的模块都要依赖的。你可以把它当作Orchard的基础类库。

Orchard启动

关于本节中“租户（tenant）”一词，网络未找到比较好的解释，仅在维基百科中的多租户技术中提到此词的解释：
租户（tenant）是指使用系统或电脑运算资源的客户。
多租户概念维基百科链接 —— 墙外链接

当Orchard web应用启动时，一个Orchard主机服务将会被创建。其主机服务为一个应用程序域级别的单例。

然后，主机服务会使用ShellContextFactory来为当前租户获取一个Shell。租户是应用程序的实例，它被拆分到了用户操作级别，但是它们还运行在同一个应用程序域 —— 提高网站的密度。Shell在租户级别是一个单例，或者可以说它实际上代表租户。它在租户级别有效的隔离了对象，并且保证了模块的编程模型与多租户无关。

shell一旦创建，将会从ExtensionManager中获取可用扩展列表（即模块和主题）。其默认实现是通过扫描模块和主题目录来获取扩展内容。

与此同时，shell还会从ShellSettingManager中获取有关租户的设置列表。其默认实现是在App_Data中对应的子文件夹中获取设置，但是我们可以另外实现来从其它不同的位置获取。例如，我们有一个Azure实现，它用来存储blob数据，因为在那种情况下，App_Data可写是不安全的。

之后，shell会获取组策略对象，并使用它依据当前主机服务的可用扩展列表和当前租户的设置来准备IoC容器。在此获得的结果并不是一个shell的IoC容器，它是一个ShellBlueprint —— 依赖、控制器和记录蓝图的一个列表。

至此，ShellSetting（每个租户）的列表和ShellBluePrint将会放入ShellContainerFactory。利用CreateContainer来获取一个ILifetimeScope —— 基本上可以在租户级别范围使用IoC容器，这样模块可以在不需要处理具体事宜的情况下，获取当前租户的作用域中注入的依赖。

依赖注入

在Orchard中，标准的创建注入依赖的方式是：先创建一个派生自IDependency（或者是它的派生接口）的接口，然后再实现这个接口。而在使用时，可以在你的构造函数中使用接口类型的参数。Orchard应用框架会发现所有依赖项，然后依据需要进行实例化和注入实例。

Orchard中为注入提供了三个可行的范围，从中选择正确的接口派生即可：

• 请求——Request: 为每个新的http请求创建的依赖实例，且一旦请求完成，实例就会销毁。通过继承接口IDependency来使用。此对象应当相对低代价的创建。
• 对象——Object: 每次对象通过接口获取依赖时，都会创建一个新的实例。且实例从不共享。通过继承接口ITransientDependency来使用。此对象必须很低代价的创建。
• Shell: 每个shell/租户只创建一个实例。它利用ISingletonDependency接口派生。只有需要在shell生存期中必须保持一个共同状态的对象使用此创建。

替换现有依赖

可以通过使用OrchardSuppressDependency特性装饰类来实现替换现有依赖。它会将完全限定类型名称替换为一个参数。

依赖关系排序

一些依赖项并不唯一，而是列表的一部分。例如，handlers是同时处于活动状态。在某些情况下，你将会需要修改这些依赖的使用顺序。这可以通过修改模块清单来实现 —— 使用功能中优先级（Priority）属性。下面为示例代码：

Features:
    Orchard.Widgets.PageLayerHinting:
        Name: Page Layer Hinting
        Description: ...
        Dependencies: Orchard.Widgets
        Category: Widget
        Priority: -1

ASP.NET MVC

Orchard是基于ASP.NET MVC建立的，但是为了添加事物，如主题与租户分离，它需要引入一个额外的层，这样，在设想中ASP.NET MVC端将按预期进行控制显示呈现，而在Orchard概念层中的Orchard端拆分事物。

例如，当请求一个特定视图时，我们的LayoutAwareViewEngine将会启动。严格来讲，它并不是一个新的视图引擎，因为它不关心实际的渲染，但是，它包含依据当前主题查找到正确视图的逻辑处理，然后他会将渲染的工作交给实际的视图引擎。

同样，我们还有路由提供程序、模型绑定器和控制器工厂，它们的工作是作为ASP.NET MVC的单一入口点，并将调用分配到下面合理范围的对象。

就以路由为例，我们会有n个路由提供程序（通常来自模块）和一个与ASP.NET MVC交互的路由发布程序。模型绑定器和控制器工厂也是一样的。

内容类型系统

在Orchard中，内容由一个真实的类型系统管理，此类型系统相对与.net类型系统在某些方面要更加丰富且更加动态。为了在Web CMS中提供更灵活的处理，类型必须在运行的时候组合，并反应出内容管理的关注点。

类型、部件和字段

Orchard可以处理任意的内容类型，包括那些由网站管理员以无代码方式动态创建的类型。这些内容类型是内容部件的整合，其中每个部件都要处理特定的问题。其原因是许多问题会跨越多个内容类型。

例如，一篇博文，一个产品展示，和一个视频剪辑可能都含有一个路由地址，以及评论和标签内容。因此，在Orchard中路由地址、评论和标签是作为单独的内容部件来处理。这样，评论管理模块就可以只开发以此，并可以应用到任意的内容类型上，包括评论模块开发者不了解的那些类型。

部件本身可以含有属性和内容字段。内容字段可以和部件一样重复使用：一个特定的字段类型可以用于多个部件和内容类型。部件和字段的不同之处在于他们操作的范围和语意区别。

字段相对于部件要更加细粒度。例如，字段类型可以描述一个电话号码或一个坐标，然而，一个部件通常用于描述一个完整的问题，如评论或标记。

但是它们最重要的不同是他们的含义：如果要实现是一个的关系，你需要写一个部件；如果要实现有一个的关系，你就需要写一个字段。

例如，一件衬衫是一个产品，它有库存和价格。你不可能说一件衬衫有一个产品或者它是一个价格或库存。

从上面可以知道，衬衫它是一个内容类型，它将是由产品部件组成，然后产品部件由一个名为价格的money字段和一个名为SKU的字符串字段组成。

另一个不同点是，在每一个内容类型中，你只能有一个给定类型的部件 —— 这样是一个关系才有意义，而一个部件可以含有给定类型的任意数量的字段。还有另一种说法是，部件上的字段是字段类型从字符串到值的字典，而内容类型是部件类型（不含名称）的列表。

这提供了另一种选择部件和字段的方式：如果你认为在每个内容类型中，你的对象需要多个实例，它就需要是一个字段。

内容类型解析

正如我们看到的，一个内容类型是从内容部件构建出来的。在代码方面，内容部件通常与以下内容有关：

• 一条记录 —— 部件数据的POCO对象表示。
• 一个模型类 —— 实际的部件，由ContentPart<T>派生出来，其中T是记录类型。
• 存储库 —— 存储库不需要模块作者实现，因为 Orchard会提供通用的使用方式。
• 事件处理程序 —— 处理程序实现IContentHandler接口，它是一系列的事件处理程序，如OnCreated或OnSaved。基本上，它们与内容项的生命周期挂钩，它们用于处理多个任务。他们还可以通过内容项的构造函数参与到它们的实际构成。在ContentHandler基类中有一个筛选器集合，可以允许处理程序添加通用处理到内容类型中。
  例如，Orchard提供了一个StorageFilter —— 用它可以方便的声明一个内容类型的持久化怎么处理：只需要使用Filters.Add(StorageFilter.For(myPartRepository));，这样Orchard就会将来自myPartRepository的数据持久化存储到数据库。
  另一个示例是ActivatingFilter —— 负责将一个类型关联到实际的部件上：调用Filters.Add(new ActivatingFilter<BodyAspect>(BlogPostDriver.ContentType.Name));，这样就是向博文添加正文内容部分。
• 驱动 —— 驱动程序是一种更友好、更特殊的处理程序（因此相对不灵活），并且它与特定的内容部件相关联（他们派生自ContentPartDriver<T>，T为内容部件类型）。另外，处理程序不一定要指定一个内容部件类型。驱动程序可以看作一个特殊部件的控制器。他们通常需要通过主题引擎来构建显示的形态。

内容管理器

在Orchard中，所有的内容都通过内容管理器对象访问 —— 这使得在你不知道内容类型的情况下，仍然可以使用内容。

内容管理器含有查询内容存储、版本内容和管理发布状态的方法。

事务

Orchard自动为每个HTTP请求创建一个事务。这意味着在请求期间发生的所有操作都是“ambient”事务的一部分。如果代码在请求期间中止事务，则那个事务里面所有的数据操作都将回滚。如果事务从未显示地取消，所有的操作会在请求结束时提交，而不需要显示提交。

请求的生命周期

在本节中，我们将以特定的博文请求作为示例。

当针对特定博文发出请求时，应用首先会查看由各个模块贡献的可用路由，然后找到与博客模块匹配的路由。之后，路由会解析请求到博文控制器项的action —— action会从内容管理器中查找博文。然后action会基于请求主对象来从内容管理器（调用BuildDisplay）中获取页面对象Model（POM） —— 即在内容管理器中检索博文。

博文有自己的控制器，但是并支持所有内容类型。例如，动态内容类型将通过Core Routable部分中更通用的ItemController来处理。ItemController的Display操作与博文控制器中的操作几乎一样：它通过slug从内容管理器中获取内容项，然后使用结果生成POM。

然后，布局视图引擎将依据当前的主题和使用的模型类型以及Orchard中约定的视图名称来解析出正确的视图。

在视图中，可以进行更多的动态形状创建，如区域定义。

实际渲染将有主题引擎完成，主题引擎会寻找正确的模板或形状方法，并按照出现的顺序递归地来渲染它在POM中遇到的每个形状。

部件

部件是含有部件内容元件和部件模型的内容类型。和其他内容类型一样，它们由元件和字段组成。这意味着他们可以使用与其他内容类型相同的版本和渲染逻辑来进行编辑。它们也 可以共享相同的构件块，这意味着任何已存在的内容元件都有可能自由的组合到部件中。

部件通过部件层添加到页面。层是部件集合。它具有一个名称和一个规则（用于控制哪些网站页面需要显示），以及一个部件列表和相关的区域布局、排序和设置。

附加到每个层的规则是用IronRuby表达式表示。这些表达式可以使用应用中的任何IruleProvider实现。Orchard中提供了两个内置实现：url和authenticated。

网站设置

在Orchard中，站点是一个内容项，这样使得它可以为模块链接其他附加元件。这也是模块如何可以进行网站设置。

网站设置针对每个租户。

事件总线

Orchard以及其模块是通过创建依赖关系的接口来公开扩展端口，这样之后，就可以通过注入方式实现他们。

向扩展端口插入功能，是通过实现接口，或实现具有相同名称及方法的接口来完成的。也就是说，Orchard在向扩展端口添加插件时，不需要严格的强类型接口对应，其不依赖于其定义的组件。

这仅仅是Orchard事件总线的一个实现。当扩展端口 调用注入的实现时，一个消息就会发布到事件总线上。监听事件总线的对象之一会将消息分配给对应的类的方法（从相应命名接口派生的类）。

命令

在Orchard网站中，许多操作都可以使用命令以及控制面板UI来处理。这些命令通过在ICommandHandler的派生类中的方法上添加CommandName特性装饰来将其公开。

Orchard命令行工具通过在运行期间，模拟网站环境并通过反射检查程序集来发现可用 的命令。这样命令运行的环境会尽可能的接近实际运行的站点。

搜索与索引

搜索和索引在默认情况下是使用Lucene实现，但其可以使用另一个索引引擎来替代默认实现。

缓存

Orchard中的缓存依赖于ASP.NET的缓存，但是我们通过调用Get方法公布了一个辅助API —— 通过ICache类型的依赖关系来使用。如果缓存还没有包含请求的记录，则可以通过Get获取一个键和一个函数来生成缓存记录值。

使用Orchard API处理缓存的主要优点是，它对于每个租户的工作是透明的。

文件系统

Orchard中的文件系统是抽象化的，因此存储处理可以指向一个物理文件系统，或者一个备用的存储（如Azure blob存储）—— 取决于具体环境。媒体模块是使用该抽象文件系统的模块实现示例。

用户及角色

在Orchard中，用户是作为内容项处理（虽然不是可路由的），这让配置模块变得容易（如为其扩展附加字段）。角色则是用户的一个内容部件。

权限

每个模块都可以公布一组权限，以及如何将这些权限默认分配给Orchard的默认角色。

任务

模块可以通过在IScheduledTaskManager类型的依赖中调用CreateTask来计划安排任务。然后通过实现IScheduledTaskHandler来执行任务。Process方法可以检查任务类型名称，以及决定是否执行处理它。

任务是运行一个单独的线程上，此线程来自ASP.NET线程池。

通知

模块可以通过获取INotifier的一个依赖并调用里面的一个方法来向控制面板界面显示消息。可以通过创建多个通知来作为请求的一部分。

本地化

应用及其模块的本地化是通过在调用T方法时传入字符串资源来实现的：@T("This string can be localized")。关于更多详细信息和准则，参阅原文：Using the Localization Providers。Orchard资源管理器会从应用中的特定位置的PO文件来加载本地化 资源字符串。

内容项的本地化是通过不同的机制来完成的：内容项的本地化版本是通过一个特定的部分链接到内容项 —— 它是物理上分离的内容项。

当前的语言文化环境是由文化管理器来决定的。默认实现是返回在网站设置中配置的语言，但是还有代替实现是可以从用户配置文件或浏览器设置中获取。

日志记录

日志记录是 通过ILogger类型的依赖来完成的。不同的实现可以将日志记录发送到各种不同的存储介质类型中。Orchard利用实现Castle.Core.Logging来实现日志记录。关于更多Castle.Core.Logging内容，详见：Castle.Core.Logging。

Orchard核心

Orchard.Core程序集包含一组Orchard运行所必需的模块。其他模块将依赖于这些模块，且这些模块将始终可用以此保证稳妥地运行。

核心模块的示例是：订阅，导航或可路由。

模块

Orchard的默认分发包含一些内置模块，如博客或页面，当然，第三方的模块也在构建中。

模块只是一个带有用于扩展Orchard的manifest.txt文件的ASP.NET MVC区域。

一个模块通常要包含事件处理程序，内容类型和他们的默认呈现模板以及相应的管理界面。

模块可以在每次对csproj文件或csproj文件引用的文件进行改变时，从源代码进行动态编译。这可以让我们使用“记事本”风格进行开发，即不需要开发人员显示编译，甚至 是，不需要使用IDE，如Visual Studio。

模块必须放置在Modules文件夹中（Orchard.Web/Modules/MyModule），并且文件夹的名称必须与项目编译生成的dll名称匹配。因此，如果你有一个名为My.Custom.Models.csproj的自定义模块的项目，并且它编译后名为My.Custom.Module.dll，那么模块的顶级文件夹 必须命名为My.Custom.Module，即~/Modules/My.Custom.Module/。

主题

主题是Orchard中的一个基本的设计原则，Orchard中生成的所有html都可以从主题中替换，包括模块生成的标记。其中规则定义了在主题文件的层次结构中，文件必须放在哪里。

Orchard中整个渲染机制是基于形状。主题引擎的工作是找到当前主题，然后确定主题渲染每个形状的最好方式是什么。每个形状可能有一个由模块定义的默认渲染。它可能是在视图文件夹中以模板方式定义，也可能是代码中以形状方法定义。默认渲染可能会被当前主题覆盖。主题会通过形状来创建自己的模板或者形状方法。

主题可以有一个父级，它可以让子主题以父主题为基础进行自己的特殊化处理或者修改处理。Orchard默认带有一个名为Theme Machine的基本主题，其可以用于作为父主题来使用。

主题可以包含于模块完全相同的代码：他们可以有自己的csproj文件，并可以利用动态编译。这让主题可以定义形状方法，还可以向管理界面公开任何可能有的设置。

当前主题的选择是由实现IThemeSelector的类来处理的，这些类可以返回主题的名称以及任何请求的优先级。这允许多个选择器来出来里主题的选择。Orchard默认带有四个IThemeSelector实现：

• SiteThemeSelector —— 选择当前为最低优先级的租户或站点配置的主题。
• AdminThemeSelector —— 当前URL是一个管理URL时，此实现接管并返回具有高优先级的管理主题。
• PreviewThemeSelector —— 当前用户启动主题预览，则此主题覆盖网站当前主题和正在预览的主题。
• SafeModeThemeSelector —— 当应用处于安全模式时，此主题是唯一可用的选择器，这通常 在安装过程中发生。它的优先级非常低。

主题选择器的示例可以是在当前useragent被识别为移动设备时，就选用一个移动主题。

译：奇葩史

没有评论