Orchard:如何生成模块和生成一个Content Part - W3CAPI 在线教程

在Orchard架构介绍中对Orchard的一些架构内容进行了介绍，下图是Orchard自带的一些模块，

本篇讲解一下如何扩展Orchard来生成我们的第一个模块。

介绍

Orchard构建在ASP.NET MVC之上，MVC是一个应用模式，我在信息系统开发平台OpenExpressApp － Command扩展机制简单介绍了一下。在本篇示例中不包含任何数据，所以我们暂时不用关心model。我们只需要一个controller 和一个view。

在Orchard中Modules能够打包成一个可重用的资产，Modules被实现成一个MVC Areas。在MVC中Areas是一个包含一套独立于其他站点的功能的子站点（sub-sites）。

生成模块目录结构

在生成我们要做的模块示例的文件结构，我们需要先在Orchard的控制台中下载、安装和打开Code Generation 功能，不知道如何下载安装的看看我之前的几篇文档。对于命令行代码生成器的更多内容可以查看Command-line Code Generation.
一旦我们打开了代码生成功能，我们打开Orchard command-line，打上下面的命令来生成HelloWorld模块：

codegen module HelloWorld

更改清单文件 Manifest

执行命令后，在Orchard网站的Modules目录下可以看到一个新的HelloWorld目录，在这个目录下可以找到文件module.txt ，按以下内容修改：

View Code

这个文件描述当前模块，在功能管理面板可以看到这个信息

注意：使用空格，而不是tab缩进

添加Route

示例将处理网站的相对地址/HelloWorld 。为了定义请求这个URL是要做什么，我们需要在HelloWorld目录下生成文件Routes.cs：

View Code

一个Route是一个在URL和controller之间的映射，上面的代码是映射/HelloWorld URL到area HelloWorld 的Home controller的Index action

生成Controller

新的模块已经有一个Controllers 目录，下面需要生成HomeController.cs:

View Code

这个controller处理URL /HelloWorld的请求。在定义Route时我们设置了默认为index的action，代码中Index方法返回HelloWorld视图。

注意在HomeController上的Themed 属性在视图在当前主题下获取皮肤时需要用到。

生成View

在Views目录下，生成一个Home的目录Views\Home，然后添加一个视图文件HelloWorld.cshtml:


<h2>@T("Hello World!")</h2>

注意使用T helper function是希望视图将来支持本地化，这虽然不是强制的，但是是一个好的实践。

添加新的文件到项目中去

上面工作做完之后，剩下的任务就是把这些文件加入HelloWorld.csproj项目文件中进行动态编译了。打开HelloWorld.csproj文件进行编辑：

View Code

激活模块

最后我们需要激活刚加的模块，在命令行下输入以下命令：

feature enable HelloWorld

我们也可以在后台的【Features】中打开

使用Module

我们可以在网站地址之后添加URL /HelloWorld，显示如下界面：

参考： Building a Hello World module

本篇接着上面示例给大家讲解一下如何生成一个Content Part。如果还没有生成HelloWorld模块，请参考上篇做完练习再回来接着做本次练习。

Content Part

　　在开源社区项目Orchard基本概念在介绍了Orchard中Content Type是由一些小的构件块（parts）组成，我们叫做content parts， Content parts 是跨内容类型的可重用的原子内容。例如一个blog由多部分组成，回复、tags或者打分等content parts，这些part都是可以在其他内容类型中重用的。

　　下面将为大家介绍如何给Orchard增加一个自定义的Content Part。

生成model

在HelloWorld/Models目录下生成一个Product.cs:

using System.ComponentModel.DataAnnotations;

using Orchard.ContentManagement;

using Orchard.ContentManagement.Records;

namespace HelloWorld.Models

{

public class ProductPartRecord : ContentPartRecord

{

public virtual string Sku { get; set; }

public virtual float Price { get; set; }

}

public class ProductPart : ContentPart<ProductPartRecord>

{

[Required]

public string Sku

{

get { return Record.Sku; }

set { Record.Sku = value; }

}

[Required]

public float Price

{

get { return Record.Price; }

set { Record.Price = value; }

}

在这里我们生成了一个代表产品记录的类ProductPartRecord，它将存储在数据库中。它有两个属性：Sku和Price。这里还生成了一个展现数据的content part ProductPart，它暴露出了两个公开属性SKU和price，这些属性将在UI中展现。
为了让项目编译，打开HelloWorld.csproj 增加

生成初始化数据迁移data migration

第一次听到Data migration这个概念是在Ruby领域中，不知道这里的data migration是不是参考Ruby社区的呢。Data migration是一个能够平滑的对应用或组件进行版本升级的一种模式。这个模式的主要思路是让系统能够跟踪当前安装版本以及每次数据升级带来与上一版本之间改变的描述。如果系统检测到存在一个新的版本，那么网站管理员会收到提示来进行升级，升级后数据版本和代码版本将保持同步。
下面我们先来生成初始化数据迁移代码，进入Orchard命令行，输入

codegen datamigration HelloWorld

将会在HelloWorld项目下增加一个Migration.cs文件：

using System;

using System.Collections.Generic;

using System.Data;

using Orchard.ContentManagement.Drivers;

using Orchard.ContentManagement.MetaData;

using Orchard.ContentManagement.MetaData.Builders;

using Orchard.Core.Contents.Extensions;

using Orchard.Data.Migration;

namespace HelloWorld {

public class Migrations : DataMigrationImpl {

public int Create() {

// Creating table ProductPartRecord

SchemaBuilder.CreateTable("ProductPartRecord", table => table

.ContentPartRecord()

.Column("Sku", DbType.String)

.Column("Price", DbType.Single)

);

return 1;

}

方法名【Create】是命名约定的，它用来生成数据的初始版本，通过SchemaBuilder.CreateTable 方法来生成一个"ProductPartRecord" 表，表比ContentPartRecord多两个字段：Sku 和Price。Create方法现在返回1，表示当前的版本号是1。

模块会有多次版本升级，接下来我们把ProductPart附加到任何content type之上：

public int UpdateFrom1()

{

ContentDefinitionManager.AlterPartDefinition("ProductPart",

builder => builder.Attachable());

return 2;

}

这个新的migration方法为"UpdateFrom1", 这也是一个命名约定，后面的数字1表示从版本1进行升级。如果下面还有更改，那么名称应该就是"UpdateFrom2" 并且返回3了。

打开HelloWorld.csproj 增加：

进入后台的Features 菜单，将会看到一个升级提示，点击"Update"升级模块，执行migrations。

升级后我们查看数据库文件，可以看到多了一张表HelloWorld_ProductPartRecord:

增加handler

在Orchard中handler类似与ASP.NET MVC中的filter。Handler是一个代码块，当特定事件发生时触发执行。下面handler的代码并不复杂，希望以后类似代码可以通过在ProductPartRecord 通过属性声明来实现。增加handlers目录并添加文件ProductHandler.cs:

using Orchard.ContentManagement.Handlers;

using HelloWorld.Models;

using Orchard.Data;

namespace HelloWorld.Handlers

{

public class ProductHandler : ContentHandler

{

public ProductHandler(IRepository<ProductPartRecord> repository)

{

Filters.Add(StorageFilter.For(repository));

}

添加 driver

在Orchard中driver类似于ASP.NET MVC的controller，一个driver通常会重载显示和编辑行为，对于示例的product part而言，我们可以生成一个新的Drivers目录，并添加文件ProductDriver.cs:

using HelloWorld.Models;

using Orchard.ContentManagement.Drivers;

using Orchard.ContentManagement;

namespace HelloWorld.Drivers

{

public class ProductDriver : ContentPartDriver<ProductPart> {

protected override DriverResult Display(

ProductPart part, string displayType, dynamic shapeHelper)

{

return ContentShape("Parts_Product",

() => shapeHelper.Parts_Product(

Sku: part.Sku,

Price: part.Price));

}

//GET

protected override DriverResult Editor(ProductPart part, dynamic shapeHelper)

{

return ContentShape("Parts_Product_Edit",

() => shapeHelper.EditorTemplate(

TemplateName: "Parts/Product",

Model: part,

Prefix: Prefix));

}

//POST

protected override DriverResult Editor(

ProductPart part, IUpdateModel updater, dynamic shapeHelper)

{

updater.TryUpdateModel(part, Prefix, null, null);

return Editor(part, shapeHelper);

}

Editor方法生成一个叫做EditorTemplate的shape，这个shape有一个TemplateName来表示Orchard去哪里找显示模板（这里指定名称为Parts/Product，表示后面会建立Parts目录和Product.cshtml文件）。我们还指定这个模板的model。
Display方法生成前端展现的shape，这个shape有两个part：Sku 和Price。

在模块根目录下新建一个placement.info文件，指定plcaement