2. MySelf
5 year of SharePoint
Blogger, Speaker, Hobbyist
photographer
Technical Lead @ Kalsoft

3. Karachi, Pakistan

4. #Best Practice Quotes
“We cannot control the winds, but we can adjust the
sails.”
 Anonymous
“It's not necessarily the amount of time you spend at
practice that counts; it's what you put into the practice.”
 Eric Lindros
“My secret is practice”
 David Beckham

5. Best Practice for Developing
SharePoint Solutions

6. Content to Cover

7. SharePoint Solutions
 General Consideration
 Avoid unnecessary construction
of Objects
 Disposing objects
 Object Caching
 Optimizing code performance

8. Avoid unnecessary
construction
ofSPWeb/SPSite Objects
SPWeb
 SPSite
 SPWebApplication webApplication =
SPWebApplication.Lookup(new
Uri(System.String);
 SPFarm farm = webApplication.Farm;
 SPContentDatabase content =
webApplication.ContentDatabases[S
System.Int32];

9. Disposing objects

10. Disposing objects (Cont..)
 Symptoms
 Application pool recycle frequently,
especially under heavy loads
 System perform poorly, especially under
heavy loads
 System crash or do users experience
unexpected errors such as timeouts or
page-not-available errors, especially under
heavy loads

11. Disposing objects (Cont..)
 Why Dispose?
 SPSite class and SPWeb class objects, are
created as managed objects
 Each instance of SPSite and SPWeb
contains a reference to an SPRequest
object that, in turn, contains a reference to
an unmanaged COM object

12. Disposing objects (Cont..)
 Rule of thumb
Never dispose
SPContext,
SPContext.Site, SPContext.Current.
Site, SPContext.Web, and
SPContext.Current.Web.

13. Disposing objects (Cont..)
 using (SPWeb web = new
SPSite(SPContext.Current.Web.
Url).OpenWeb()) { //
}
 using (SPSite siteCollection = new
SPSite(SPContext.Current.Web.Url)) {
using (SPWeb web =
siteCollection.OpenWeb()) {
//
}}

14. Disposing objects (Cont..)
 SPSite siteCollection =
siteCollections.Add(URL,
"DOMAINUser", EMAIL);
 using (SPSite siteCollection =
siteCollections.Add(URL, "DOMAINUser",
EMAIL)
{
}

15. Disposing objects (Cont..)
 SPWeb web =
siteCollection.AllWebs.Add(URL);
 using (SPWeb web =
siteCollection.AllWebs.Add(URL)
{
}

16. Disposing objects (Cont..)
Download the SPDispose Check tool
http://code.msdn.microsoft.com/SPDispos
eCheck

17. Object Caching
 public void CacheData() { SPListItemCollection
oListItems; oListItems =
(SPListItemCollection)Cache["ListItemCacheName"];
if(oListItems == null) { oListItems =
DoQueryToReturnItems();
Cache.Add("ListItemCacheName", oListItems, ..); } }

18. Object Caching
public void CacheData() {
DataTable oDataTable; SPListItemCollection oListItems;
lock(_lock) {
oDataTable = (DataTable)Cache["ListItemCacheName"];
if(oDataTable == null) {
oListItems = DoQueryToReturnItems();
oDataTable = oListItems.GetDataTable();
Cache.Add("ListItemCacheName", oDataTable, ..); } } }

19. Optimizing code
performance
 SPWeb myWeb =
SPContext.Current.Web;
myWeb.Lists["Tasks"].Title = "List_Title";
myWeb.Lists["Tasks"].Description =
"List_Description";
myWeb.Lists["Tasks"].Update();
 SPWeb myWeb =
SPContext.Current.Web; SPList myList =
myWeb.Lists["Tasks"];
myList.Title="List_Title";
myList.Description="List_Description";
myList.Update();

20. Farm Solutions
 Target farm level solutions to the specific
web application instead of deploying to
all web applications.
 Try to deploy all the resource files
(CSS, JPG) from within the Solution
(Applicable to Sandboxed solution as
well)

21. Sandboxed Solutions
 Plan which servers will run the
sandboxed solutions service.
 Plan which site collections will be able
to run sandboxed solutions.
 Design your Sand Boxed solution as per
the Site collection quota

22. Working With Large Lists

23. Working With Large Lists
 SPWeb.Lists[strDisplayName]
 SPWeb.Lists[GUID]
 SPWeb.GetList(strURL)

24. Working With Large Lists
(Cont..)
 SPList.Items
 SPList.Items.Add
 SPList.Items.GetItemById
 SPList.GetItems(SPQuery query)
 SPList.AddItem
 SPList.GetItemById(int id, string
field1, params string[] fields)

25. Working With Large Lists
(Cont..)
 SPList.Items.Count
 SPList.Items[System.Guid]
 SPList.Items[System.Int32]
 SPList.Items.GetItemById(Syste
m.Int32)
 SPList.ItemCount
 SPList.GetItemByUniqueId(Syste
m.Guid)
 SPList.GetItemById(System.Int32)

26. Working With Large Lists
(Cont..)
 SPFolder.Files.Count
 SPFolder.Files[System.String]
 SPFolder.ItemCount
 SPFolder.ParentWeb.GetFile(SPU
rlUtility.CombineUrl(SPFolder.Url,
System.String)

27. Working With Large Lists
(Cont..)
 Deleting Versions
 SPListItemVersion.GetVersionFr
omID(System.Int32). Delete();
 SPFileVersionCollection.
DeleteByID(System.Int32);

28. Event Receivers

29. Event Receivers
 Always use Event Receivers to execute
the code immediately. Workflows can
perform similar function but it will run as
a timer job which may delay the code
execution.

30. Event Receivers (Cont..)
 Instantiate an SPWeb, SPSite,
SPList, or SPListItem
 Update method
 properties.OpenWeb()
 properties.ListItem

31. Timer Jobs
 Always run the timer job in off hours
 Always perform take out the timer job
when deactivating the respective
feature
 Don’t use
SPContext,SPContext.Current,SPCo
ntext.Current.Web

32. General Considerations
 Use proper feature name and
description.
 Use the feature as it require by design.
 Make sure solutions have proper
consistent naming convention.
 Use the correct older version of WSPs
to retract the solution before deploying
or upgrading the custom code

33. Thank You