Disposing SPWeb and SPSite objects

The New Definitive SPSite/SPWeb Disposal Article « Solutionizing .NET

The New Definitive SPSite/SPWeb Disposal Article « Solutionizing .NET — Sun, 07 Dec 2008 07:47:07 GMT

PingBack from http://solutionizing.net/2008/12/06/the-new-definitive-spsitespweb-disposal-article/

re: Disposing SPWeb and SPSite objects

Jeremy Thake — Sun, 07 Dec 2008 09:52:52 GMT

Thanks for this, be great to get this up on the new http://www.sharepointdevwiki.com/ Let me know if you’re happy to submit it. That way people can evolve it in a wiki rather than an updated blog post etc. Be interested to hear your thoughts on it Stefan.

re: Disposing SPWeb and SPSite objects

Spence — Sun, 07 Dec 2008 11:10:51 GMT

excellent write up mate, thanks!

re: Disposing SPWeb and SPSite objects

Rick — Mon, 08 Dec 2008 18:55:34 GMT

Great Post!

I have one question

I guess it's ok to dispose in the following situation?

public override void ItemCheckingOut(SPItemEventProperties properties)

{

SPWeb web = properties.OpenWeb()

//Do stuff...

web.dispose();

}

Cheers,

Rick

re: Disposing SPWeb and SPSite objects

Stefan_Gossner — Mon, 08 Dec 2008 19:47:05 GMT

Hi Rick,

yes this call will construct a new SPWeb object which you actually have to dispose.

Cheers,

Stefan

re: Disposing SPWeb and SPSite objects

Keith Dahlby — Thu, 11 Dec 2008 06:52:31 GMT

Stefan ~

Looking at the internals behind the various EventProperties, I'm not finding anywhere that the framework actually cleans up disposable objects allocated to create the child items. SPItemEventProperties is even IDisposable, but Dispose() is never called that I can find.

Since the SP* objects returned aren't even created until the property is referenced, it seems to me the best practice here would be to create your own SPSite/SPWeb and clean it up yourself. What do you think?

If this is the case, it's also worth mentioning that SPItemEventProperties.OpenWeb() will internally allocate an SPSite that needs to be cleaned up by the caller.

Cheers ~

Keith

re: Disposing SPWeb and SPSite objects

Stefan_Gossner — Thu, 11 Dec 2008 10:33:16 GMT

Hi Keith,

actually there are two different constructors for SPItemEventProperties.

One of them passes a SPSite object into the constructor which is then set as the relevant SPSite member variable.

As the event receiver cannot control how the SPItemEventProperties object has been created it is not allowed to dispose this object as this object might be the SPSite object coming from SPContext (e.g.).

Regarding IDisposable of SPItemEventProperties: you are right. I just double checked. This looks like a problem in our code. I will forward this info to the right people here.

Cheers,

Stefan

re: Disposing SPWeb and SPSite objects

Keith Dahlby — Thu, 11 Dec 2008 23:42:02 GMT

I agree that it isn't the SPItemEventProperties object's responsibility to dispose of an SPSite that was passed in, which is handled nicely by the logic within Dispose(). Whether or not Dispose() is called is its creator's problem. However, that contract does not exist for SPListEventProperties and SPWebEventProperties, which leads me to believe the auxiliary sites and webs are allowed to leak.

I'm inclined to mimic the built-in receivers, almost all of which create their own SPSite/SPWeb as necessary and Dispose() when they're done.

Regards ~

Keith

re: Disposing SPWeb and SPSite objects

Stefan_Gossner — Thu, 11 Dec 2008 23:48:21 GMT

Hi Keith,

intersting. I will check into this in more detail tomorrow and post my results.

Cheers,

Stefan

Linki do prezentacji o zarządzaniu obiektami

.neting in the free world — Tue, 16 Dec 2008 01:40:01 GMT

Linki, które posłużyły mi przy tworzeniu prezentacji, z których czerpałem wiedzę, nakładałem ją na to

WSS 3.0 & MOSS: Recopilatorio de enlaces interesantes (XXIV)!

Blog del CIIN — Thu, 01 Jan 2009 18:28:16 GMT

Un año más ( ¡FELIZ AÑO NUEVO A TODOS! ), aquí estoy dando guerra (y ya van más de dos desde que Rodrigo

re: Disposing SPWeb and SPSite objects

Keith Dahlby — Tue, 06 Jan 2009 22:39:20 GMT

Hey Stefan ~

I've posted a revision of my disposal article on the SharePoint Dev Wiki here:

http://sharepointdevwiki.com/display/public/When+to+Dispose+SharePoint+objects

I'd appreciate if you could look it over for anything incorrect or omitted.

Thanks ~

Keith

try / finally using() SharePoint Dispose()

Roger Lamb's SharePoint Developer Blog — Wed, 14 Jan 2009 17:13:14 GMT

Chances are that by now if you have been developing on the Microsoft SharePoint Office Server (MOSS)

re: Disposing SPWeb and SPSite objects

Chirag Patel — Wed, 14 Jan 2009 20:58:47 GMT

This is a very nice blog on WSS object disposal and preventing bad memory usage. But What about those web parts that are created using Sharepoint Designer that uses XSLT to render the web part? Do they handle the disposal of SPSite and SPWeb objects internally?

When to Dispose SharePoint objects

Confluence: SharePoint Development Wiki — Thu, 15 Jan 2009 11:08:24 GMT

SPSite and SPWeb implement the IDisposable interface

re: Disposing SPWeb and SPSite objects

Stefan_Gossner — Thu, 15 Jan 2009 12:44:11 GMT

Hi Chirag,

not sure which web part you mean in detail but most web parts only use the SPWeb and SPSite objects from SPContext which are not allowed to be disposed.

Cheers,

Stefan

re: Disposing SPWeb and SPSite objects

Chirag Patel — Thu, 15 Jan 2009 17:43:47 GMT

Hi Stefan,

I am working in a sharepoint project in which there is a root site collection which contains other site collections e.g Info, so there is a data view web part created in SPD which targets the event calendar list which resides in Info site, so it is clear that in any way the SPD data view web part must create an object of Info site collection and get the root web object [this is not SPWeb object created from SPContext site object]. So in such scenario do the SPD data view web part disponses that SPSite and SPWeb objects automatically?

re: Disposing SPWeb and SPSite objects

Stefan_Gossner — Thu, 15 Jan 2009 19:51:24 GMT

Hi Chirag,

all site collections are independent. A site collection can contain sites - but not site collections.

Cheers,

Stefan

re: Disposing SPWeb and SPSite objects

Keith Dahlby — Fri, 16 Jan 2009 04:30:44 GMT

Chirag ~

Since you're not using code to create the DVWP, you wouldn't have any way to Dispose() the objects even if you wanted to. I would hope the built-in controls would clean up after themselves, but in the worst case scenario since you're only dealing with SPWeb objects from the context SPSite, they will be cleaned up when the context site collection is disposed.

Keith

To Dispose Or Not To Dispose....That Is The Question

Tony Testa's World — Fri, 23 Jan 2009 07:54:17 GMT

To Dispose Or Not To Dispose....That Is The Question

re: Disposing SPWeb and SPSite objects

Zsolt Borcsok — Fri, 10 Jul 2009 14:24:23 GMT

I found this nice problem! An SPRequest, allocated by SPContext.Current, wasn't disposed! How is it possible?

An SPRequest object was not disposed before the end of this thread. To avoid wasting system resources, dispose of this object or its parent (such as an SPSite or SPWeb) as soon as you are done using it. This object will now be disposed. Allocation Id: {42853923-E532-4C15-B002-6BE9D4C6D727} This SPRequest was allocated at at Microsoft.SharePoint.Library.SPRequest..ctor() at Microsoft.SharePoint.SPGlobal.CreateSPRequestAndSetIdentity(Boolean bNotGlobalAdminCode, String strUrl, Boolean bNotAddToContext, Byte[] UserToken, String userName, Boolean bIgnoreTokenTimeout, Boolean bAsAnonymous) at Microsoft.SharePoint.SPWeb.InitializeSPRequest() at Microsoft.SharePoint.SPWeb.EnsureSPRequest() at Microsoft.SharePoint.SPWeb.get_Request() at Microsoft.SharePoint.SPWeb.InitWebPublic() at Microsoft.SharePoint.SPWeb.get_ID() at Microsoft.SharePoint.SPContext.DefaultKey(HttpContext context, SPWeb web) at Microsoft.SharePoint.SPContext.GetContext(HttpContext context) at Microsoft.SharePoint.SPContext.get_Current() ...

re: Disposing SPWeb and SPSite objects

Stefan_Gossner — Fri, 10 Jul 2009 15:02:07 GMT

Hi Borcsok,

looks as if the Microsoft.SharePoint.ApplicationRuntime.SPRequestModule is not registered in the http modules section of the web.config.

Please double check.

Cheers,

Stefan

re: Disposing SPWeb and SPSite objects

Kit Menke — Wed, 09 Sep 2009 16:45:46 GMT

Stefan,

If I open an SPWeb and use it to get a SPListItemCollection, does the SPListItemCollection count as a "child object"? If I use that collection after disposing of the SPWeb object that was used to retrieve it, would the SPWeb be reopened?

Thanks,

Kit

(see my question here for more info http://stackoverflow.com/questions/1394952/will-using-a-splistitemcollection-returned-from-a-function-reopen-the-spweb)

re: Disposing SPWeb and SPSite objects

Stefan_Gossner — Wed, 09 Sep 2009 17:11:39 GMT

Hi Kit,

yes it can reopen the SPWeb object.

Cheers,

Stefan