DNN模块开发之利器篇:七种武器

dnnsun@gmail.com — Fri, 23 May 2008 10:23:53 GMT

读过武侠小说的你一定都知道古龙曾有一部著名的小说<<七种武器>>,其中列举了当今武林最牛的,杀伤力最大的武器,其中包括长生剑、孔雀翎、碧玉刀、多情环、霸王枪、离别钩、拳头.后来还有百晓生的兵器排行榜,其中就包括小李飞刀等等.在此我就班门弄斧了,借着古代利器之说,姑且列举一些对DNN模块开发起决定作用的一些方法或类,并辅助说明使用方式(排名没有先后之分,纯粹用于标识):

1) PortalModuleBase

所属命名空间:DotNetNuke.Entities.Modules

这是一个开发DNN模块所必须继承的基类,标志性的基类,在此基类中,你可以得到DNN所为你封装的一些模块基本信息,毋需你多费周折,其中包括当前用户UseID,UserInfo,TabID,ModulePath,ModuleConfiguration,LocalResourceFile等等,下边就简单解析几个比较有用的属性:

<1> ModulePath: 模块根目录,可以获取到模块根目录所需要的文件,比如脚本文件,图像文件,比如你想在后台注册一个js脚本,代码可以类似:

ScriptManager scriptManager = ScriptManager.GetCurrent(Page);
scriptManager.Services.Add(new ServiceReference(this.ModulePath + "WebService.asmx"));
scriptManager.Scripts.Add(new ScriptReference(this.ModulePath + "js/Utility.js"));

<2> LocalResourceFile: 本地化资源文件,默认是关联到模块根目录下的App_LocalResources下对应文件,比如你开发的模块用户控件为xx_view.ascx,那LocalResourceFile就是App_LocalResources/xx_view.ascx.resx(或xx_view.ascx.zh-CN.resx),如果你想手动的注册本地化支持,代码可以类似:

lblMessage.Text = Localization.GetString("Message", LocalResourceFile)

更高级的应用可能就是设置共享本地化资源,也就是说你可以好些UserControl共享一个资源文件,比如你可以设置一个共享资源文件SharedResources.resx(或SharedResources.zh-CN.resx),专门放置一些公共的本地化键值对设置,然后添加如下方法到你的基类或后台代码,这是一个值得推荐的方法,节省了资源文件的大小(如果说你开发的模块比较复杂的话,文件的统筹规划是必不可少的):

Public Function LocalizationByKey(ByVal key As String, Optional ByVal IsSharedResource As Boolean = False)
If IsSharedResource Then
Return Localization.GetString(key, SharedResourceFile)
End If
Return Localization.GetString(key, LocalResourceFile)
End Function

<3> ModuleConfiguration: 当前用户控件所在的模块配置信息,比如动态设置模块标题,是否显示模块容器,是否支持打印或聚合等等.比如通过以下代码你就可以动态的修改模块标题:

If Not Null.IsNull(UserId) Then
ModuleConfiguration.ModuleTitle = Localization.GetString("UpdateUserInfo", LocalResourceFile)
Else
ModuleConfiguration.ModuleTitle = Localization.GetString("ModuleTitle", LocalResourceFile)
End If

2) AJAX

所属命名空间:DotNetNuke.Framework

DNN核心封装支持Ajax功能的辅助类,其中包含了一些及其有用的方法,比如:
IsInstalled(): MS Ajax是否安装
IsEnabled(): MS Ajax是否激活
RegisterPostBackControl: 注册传统PostBack控件
RegisterScriptManager: 注册ScriptManager
等等.
现举一个应用例子:

/// <summary>
/// Register the background Webservice and js-script
/// </summary>
private void RegisterAjaxWebservice()
{
if (DotNetNuke.Framework.AJAX.IsInstalled())
{
DotNetNuke.Framework.AJAX.RegisterScriptManager();
ScriptManager scriptManager = ScriptManager.GetCurrent(Page);
scriptManager.Services.Add(new ServiceReference(this.ModulePath + "ManageService.asmx"));
scriptManager.Scripts.Add(new ScriptReference(this.ModulePath + "Utility.js"));
}
}

3) ModuleSettingsBase

所属命名空间:DotNetNuke.Entities.Modules

这是DNN模块设置的基类,其中主要包含两个方法,LoadSettings和UpdateSettings,当你继承于它时,你所需要就是重写这两个基类方法,方法体实现业务逻辑,关联的数据库表为TabModuleSettings或ModuleSettings,这两个都具有同样的数据结构,存储就是类似哈希表的键值对,所不同只是他们更新数据的方法不一样而已:

Dim objModules As New DotNetNuke.Entities.Modules.ModuleController
objModules.UpdateModuleSetting(ModuleId, "timeinterval", txtTimeInterval.Text.Trim.ToString())
Dim objModules As New DotNetNuke.Entities.Modules.ModuleController
objModules.UpdateTabModuleSetting(ModuleId, "timeinterval", txtTimeInterval.Text.Trim.ToString())

而当你仔细参看代码,在方法中LoadSettings所使用的Settings实质就是TabModuleSettings和ModuleSettings的合并,当然你也可以自行获取TabModuleSettings或ModuleSettings,dnn给与你更多的控制权:

Public Shadows ReadOnly Property Settings() As Hashtable
Get
If _settings Is Nothing Then
'Merge the TabModuleSettings and ModuleSettings
_settings = Portals.PortalSettings.GetTabModuleSettings(New Hashtable(ModuleSettings), New Hashtable(TabModuleSettings))
End If
Return _settings
End Get
End Property

更多信息你可以参看dnn核心模块,比如Survey,Link等等.

4) CDefault( or PageBase)

所属命名空间:DotNetNuke.Framework

PageBase是DNN核心页面基类,而CDefault是对此有所封装的类,两者何时需要主要看你的开发需要,在此我就分别举两个例子:

<1>一般模块中的aspx需要继承PageBase,PageBase主要有LocalResourceFile,PortalSettings等属性,比如你模块中存在一个Print.aspx,后台代码可以如此声明:

Partial Public Class Print
Inherits PageBase
End Class

<2>模块里的用户控件如果需要控制页面信息时,可以新增一个属性BasePage,代码如下:

Public ReadOnly Property BasePage() As DotNetNuke.Framework.CDefault
Get
Return CType(Me.Page, DotNetNuke.Framework.CDefault)
End Get
End Property

这时你就可以在用户控件加载时动态修改页面相关属性,比如Title:

Me.BasePage.Title = Me.BasePage.Title & " - " & m_oEntry.Title

本站点博客模块就是如此动态设置页面标题的.

或你可以直接如此设置:

'Override the page title
Dim myPage As DotNetNuke.Framework.CDefault
myPage = CType(Me.Page, CDefault)
myPage.Title = Localization.GetString("ControlTitle_YourPage", Me.LocalResourceFile)

5) Globals

所属命名空间:DotNetNuke.Common

这是DNN模块开发用得最多的一个静态类,汇聚了DNN核心最基本的静态方法,如果你有心想开发好模块,好好看看这里边的方法,你会有意想不到的收获.比如:
<1>ConvertDataReaderToDataTable:把DataReader转化为DataTable
<2>ConvertDataReaderToDataSet:把DataReader转化为DataSet
<3>NavigateURL:最经典的DNN导航(跳转)函数
<4> SendMail:DNN核心发送邮件方法
<5>FriendlyUrl:友好URL重写方法
<6>GetFileList:获取DNN站点根目录下文件列表,如果你在用UrlControl你会觉得这个方法是你所必须知道的.
等等.

6) CBO ( and Null )

所属命名空间:DotNetNuke.Common.Utilities

这是DNN模块数据层所必备的一个工具类,对此我也曾专题般的讨论过,合理的使用CBO决定你即将开发的模块的命运,比如扩展性,兼容性,维护代价等等.

相关链接:

解析DNN新生宠儿DAL+

DNN Object Hydrator -- CBO解析

王者归来—再谈CBO

7) DNNClientAPI

所属命名空间:DotNetNuke.UI.Utilities

这是DNN赫赫有名的一个辅助类,为DNN模块开发客户端脚本和服务器交互起到不可或缺的作用,同时支持本地化使得脚本也真正实现了本地化.最经常使用例如我们需要在点击某一个删除按钮弹出提示信息,如今在DNN模块及其简单,就是一句代码即可:
ClientAPI.AddButtonConfirm(cmdAddComment, LocalizationByKey("cmdDeleteCommentMessage"))
在此再举一个比较经典的应用范例,有时我们需要在客户获取目标控件并对此操作,可由于ASP.Net(DNN)在生成页面时已自动生成客户端代码,比如某一TextBox控件screenName最终可能会生成类似dnn_ctr431_QuickLogin_screenName,如果你在客户端脚本中直用document.getElementById('cmdHome')获取该控件的话,只会返回一个undefined或null,这时就需要我们在客户端注册一个页面ID前缀,而DNN早为我们想到了,那就是dnn.js脚本为我们提供两个方法dnn.gerVar和dnn.setVar,具体流程就是首先在页面注册页面前缀:

ClientAPI.RegisterClientReference(this.Page, ClientAPI.ClientNamespaceReferences.dnn);
ClientAPI.RegisterClientVariable(this.Page, "Container_ID", this.ClientID + "_", true);

然后在脚本中你可以直接得到你想要的控件对象:

var _ModuleContainer;
if( typeof(_ModuleContainer) == 'undefined' ) _ModuleContainer = dnn.getVar('Container_ID');
var screenName = $get( _ModuleContainer + 'screenName').value;

Baldwin's DNN

DNN模块开发之利器篇:七种武器