SharePoint 2010 提供了完整的用戶端物件模型,開發體驗相當不錯。但若是維護 SharePoint 2007 環境,那套方案就用不上了。本文要處理的問題是:如何在純JavaScript中透過WebService取得SharePoint的資料。
先從此處下載 JavaScript API 套件:
https://darrenjohnstone.net/download/12
引用時包含兩個檔案,分工明確:SPAPI_Core.js 是處理核心,SPAPI_Lists.js 則提供了大多數對外可呼叫的清單相關介面。
<script src="SPAPI_Core.js"></script> <script src="SPAPI_Lists.js"></script>
最常用的方法是:
getListItems(listName, viewName, query, viewFields, rowLimit, queryOptions, webID)
這是在 SharePoint Designer 中定制開發時經常遇到的需求。以下程式碼示範如何查詢 UserInfo 清單,取得目前登入者所屬的部門:
function getCurrentUserStat() {
var lists = new SPAPI_Lists('');
var items = lists.getListItems(
'UserInfo',
'',
'<Query><Where><Eq><FieldRef Name="ID"/><Value Type="Counter">' + _spUserId + '</Value></Eq></Where></Query>',
'<ViewFields><FieldRef Name="Department"/></ViewFields>',
1, // rowLimit
'' // queryOptions
);
接著處理回傳的XML即可取出需要的欄位值:
if (items.status == 200) {
var rows = items.responseXML.getElementsByTagName('z:row');
if (rows.length == 1) {
var dep = rows[0].getAttribute('ows_Department');
return rows[0].getAttribute('ows_Department');
}
}
關於同步請求:這個方法是同步發送請求的,也就是程式會停下來等回應。這在資料量小、邏輯簡單時沒問題,但若呼叫頻繁或伺服器回應慢,就會造成介面凍結的惡劣體驗。實務上建議改用 SPAPI 提供的非同步回呼版本。
關於CAML語法:傳入的 query 與 viewFields 採用的是SharePoint的CAML查詢語言,屬性名稱區分大小寫,這點在撰寫時要特別注意。
關於回傳屬性的命名:從XML中取值時,欄位名稱前面會加上 ows_ 前綴(例如 ows_Department),而且需注意清單欄位的內部名稱可能與顯示名稱不同。
關於除錯:想知道 items 物件上到底有哪些屬性和值,直接 alert(items.responseText) 看原始回應是最快的方式。
參考資料:
https://darrenjohnstone.net/2008/07/22/a-cross-browser-javascript-api-for-the-sharepoint-and-office-live-web-services/