通过

事件接收器的最佳做法

  • 项目

上次修改时间： 2010年1月13日

适用范围： SharePoint Foundation 2010

本主题解决与有效使用事件接收器相关的常见问题。

在事件接收器中使用对象

不要在事件接收器内实例化 SPWeb、SPSite、SPList 或 SPListItem 对象。实例化这些对象而非使用通过事件属性传递的实例的事件接收器可能会导致以下问题：

  • 大量额外的数据库往返（一次写入操作会导致在每个事件接收器中出现多达 5 次的额外往返）。

  • 对这些实例调用 Update 方法会导致在其他注册的事件接收器中的后续 Update 调用失败。

不良的编码实践

在事件接收器内安装一个 SPSite 对象

public override void ItemDeleting(SPItemEventProperties properties)
{
    using (SPSite site = new SPSite(properties.WebUrl))
    {
    using (SPWeb web = site.OpenWeb())
        {
        SPList list = web.Lists[properties.ListId];
        SPListItem item = list.GetItemByUniqueId(properties.ListItemId);
        // Operate on an item.
        }
    }
}

 Public Overrides Sub ItemDeleting(ByVal properties As SPItemEventProperties)
    Using site As New SPSite(properties.WebUrl)

        Using web As SPWeb = site.OpenWeb()
            Dim list As SPList = web.Lists(properties.ListId)
            Dim item As SPListItem = list.GetItemByUniqueId(properties.ListItemId)
            ' Operate on an item.
        End Using
    End Using
End Sub

良好的编码实践

使用 SPItemEventProperties

// Retrieve SPWeb and SPListItem from SPItemEventProperties instead of
// from a new instance of SPSite.
SPWeb web = properties.OpenWeb();
// Operate on the SPWeb object.
SPListItem item = properties.ListItem;
// Operate on an item.

' Retrieve SPWeb and SPListItem from SPItemEventProperties instead of
' from a new instance of SPSite.
Dim web As SPWeb = properties.OpenWeb()
' Operate on the SPWeb object.
Dim item As SPListItem = properties.ListItem
' Operate on an item.

如果不从 SPItemEventProperties 中检索 SPWeb、SPSite、SPList 或 SPListItem 对象，而是在一个事件接收器中实例化这些对象，当对这些新实例调用 Update 时，则必须使用 SPEventPropertiesBase 的适当子类（例如 SPItemEventProperties.InvalidateListItem 或 SPItemEventProperties.InvalidateWeb）中的 Invalidate 方法清除它。