SharePoint - Mô hình đối tượng máy khách

Trong chương này, chúng ta sẽ xem xét Mô hình Đối tượng Khách hàng hoặc CSOM. Đây là một trong hai API, để xây dựng các ứng dụng từ xa đã được thêm vào SharePoint 2010.

Một trong những mục tiêu thiết kế của Mô hình Đối tượng Máy khách là bắt chước Mô hình Đối tượng Máy chủ càng nhiều càng tốt, do đó, sẽ có một đường cong học tập ngắn hơn cho các nhà phát triển đã quen với việc phát triển phía Máy chủ.

Trung tâm của Mô hình Đối tượng Khách hàng là một dịch vụ web có tên là Client.svc, nằm trong thư mục ảo _vti_bin . Chúng tôi không được giao tiếp trực tiếp với Client.svc, nhưng chúng tôi được cấp ba proxy hoặc điểm vào mà chúng tôi có thể sử dụng. Họ là –

.NET Mã được quản lý.
JavaScript.
JavaScript.

Mã giao tiếp với các proxy này và sau đó các proxy này cuối cùng giao tiếp với dịch vụ web.

Vì đây là một API từ xa và giao tiếp được thực hiện với SharePoint thông qua các lệnh gọi dịch vụ web, nên Mô hình Đối tượng Khách hàng được thiết kế để cho phép chúng tôi tổng hợp các lệnh và yêu cầu thông tin.

Mã được quản lý .NET

Hai tập hợp cốt lõi cho việc triển khai quản lý .NET là:

Microsoft.SharePoint.Client.dll và Microsoft.SharePoint.Client.Runtime.dll.

Mã Silverlight

Các tập hợp để triển khai Silverlight có trong TEMPLATE \ LAYOUTS \ ClientBin . Tên lắp ráp cũng bắt đầu bằng Microsoft.SharePoint.Client . Đối với tất cả các cụm, trừ một cụm, tên cụm kết thúc bằng Silverlight.

Hai tổ hợp cốt lõi để triển khai Silverlight là:

Microsoft.SharePoint.Client.Silverlight.dll
Microsoft.SharePoint.Client.Silverlight.Runtime.dll

JavaScript

Việc triển khai JavaScript trên Mô hình Đối tượng Khách hàng nằm trong thư mục TEMPLATE \ LAYOUTS bên dưới Gốc Hệ thống SharePoint. Tất cả các tên thư viện JavaScript đều bắt đầu bằng SP. Ba thư viện cốt lõi là SP.js, Sp.Runtime.js và SP.Core.js.

Mô hình Đối tượng Khách hàng được mở rộng trong SharePoint 2013.

Truy xuất tài nguyên khi tải bằng .NET

Chúng ta hãy xem xét một ví dụ đơn giản trong đó chúng ta sẽ sử dụng triển khai được quản lý của Mô hình Đối tượng Máy khách bằng ứng dụng Windows biểu mẫu. Do đó, đầu tiên chúng ta cần tạo một dự án mới.

Bước 1 – Chọn Ứng dụng Windows Forms trong ngăn giữa và nhập tên vào trường Tên. Bấm OK.

SharePoint - Mô hình đối tượng máy khách

Bước 2 – Sau khi dự án được tạo, chúng ta hãy thêm một hộp danh sách và một nút như hình dưới đây. Để sử dụng Mô hình Đối tượng Khách hàng, chúng ta cần thêm một vài tham chiếu hợp ngữ. Nhấp chuột phải vào Tài liệu tham khảo và chọn Thêm tài liệu tham khảo.

Bước 3 – Chọn Tiện ích mở rộng trong ngăn bên trái bên dưới Bộ lắp ráp .

Hai tập hợp cốt lõi để triển khai được quản lý của Mô hình Đối tượng Khách hàng là Microsoft.SharePoint.Client và Microsoft.SharePoint.Client.Runtime . Đánh dấu vào hai tùy chọn này và bấm OK.

Bây giờ hãy nhấp đúp vào nút Load để thêm trình xử lý sự kiện như được đưa ra bên dưới.

using Microsoft.SharePoint.Client;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace ClientObjectModel {
   public partial class Form1 : Microsoft.SharePoint.Client.Form {
      public Form1() {
         InitializeComponent();
      }
      private void loadBtn_Click(object sender, EventArgs e) {
         using (var context = new ClientContext("http://waqasserver/sites/demo")) {
            var web = context.Web;
            context.Load(web);
            context.Load(web.Lists);
            context.ExecuteQuery();
            ResultListBox.Items.Add(web.Title);
            ResultListBox.Items.Add(web.Lists.Count);
         }
      }
   }
}

Điểm vào trong Mô hình Đối tượng Khách hàng là bối cảnh khách hàng. Nó là điều khiển từ xa của phiên bản máy khách của đối tượng SPContext . Đây là loại dùng một lần, vì vậy nó được bao bọc trong một câu lệnh using . Chúng tôi chuyển URL đến site SharePoint trong ClientContext .

Vì vậy, bây giờ, chúng tôi có bối cảnh của chúng tôi. Chúng tôi cần một đối tượng để đại diện cho trang web hiện tại, đó là var web = context.web .

Lưu ý – Hãy nhớ rằng, đối tượng này chỉ là một shell rỗng, vì vậy chúng ta cần tải các đối tượng web bằng cách sử dụng context.load và chuyển đối tượng web. Điều này chỉ ra rằng chúng tôi muốn các thuộc tính của đối tượng web được phổ biến trong lần truy xuất hàng loạt tiếp theo.

Tiếp theo, chúng ta cần gọi context.ExecuteQuery và điều đó thực sự khởi động quá trình truy xuất hàng loạt. Chúng tôi lấy các giá trị thuộc tính từ máy chủ và thêm vào hộp danh sách.

Khi đoạn mã trên được biên dịch và thực thi, bạn sẽ thấy kết quả sau: