SpRestLib 开源项目教程

1. 项目介绍

SpRestLib 是一个轻量级的 JavaScript 库，专门用于简化与 SharePoint REST API 的交互。该库可以在客户端浏览器或服务器端使用，适用于构建嵌入到内容编辑器或脚本中的 Web 部件的开发者。SpRestLib 提供了对 SharePoint 2013 API 和 SharePoint Online 的列表、用户、站点和 REST 方法的全面支持。

主要特点

• 轻量级: 纯 JavaScript 库，无其他框架依赖。
• 现代: 利用 ES6 Promise 架构进行异步操作链和分组。
• 易用: 大多数 REST/Web 服务交互只需几行代码即可完成。

2. 项目快速启动

安装

你可以通过 npm 或 yarn 安装 SpRestLib：

npm install sprestlib

或

yarn install sprestlib

使用示例

以下是一个简单的示例，展示如何使用 SpRestLib 获取当前 SharePoint 用户的信息：

// 引入 SpRestLib
var sprLib = require("sprestlib");

// 获取当前用户信息
sprLib.user().info().then(function(objUser) {
    console.log(objUser);
});

浏览器中使用

如果你在浏览器中使用 SpRestLib，可以通过以下方式加载库：

<script src="/subsite/SiteAssets/js/sprestlib.min.js"></script>
<!-- 或使用 bundle 版本以支持 IE11 -->
<script src="/subsite/SiteAssets/js/sprestlib.bundle.js"></script>

3. 应用案例和最佳实践

案例1：获取 SharePoint 列表数据

假设你有一个名为 "Tasks" 的 SharePoint 列表，你可以使用 SpRestLib 轻松获取该列表的数据：

sprLib.list("Tasks").items().query({
    Select: ["Title", "AssignedTo/Name", "DueDate"],
    Expand: ["AssignedTo"]
}).then(function(items) {
    console.log(items);
});

案例2：上传文件到 SharePoint 文档库

你可以使用 SpRestLib 将文件上传到 SharePoint 文档库：

var file = new Blob(["Hello, World!"], { type: "text/plain" });

sprLib.file("Documents").upload({
    Folder: "Shared Documents",
    FileName: "hello.txt",
    File: file
}).then(function(fileInfo) {
    console.log("File uploaded:", fileInfo);
});

4. 典型生态项目

React 集成

SpRestLib 可以与 React 项目集成，以下是一个简单的示例：

import React, { useEffect, useState } from 'react';
import sprLib from 'sprestlib';

function App() {
    const [userInfo, setUserInfo] = useState(null);

    useEffect(() => {
        sprLib.user().info().then(objUser => setUserInfo(objUser));
    }, []);

    return (
        <div>
            <h1>Current User Info</h1>
            <pre>{JSON.stringify(userInfo, null, 2)}</pre>
        </div>
    );
}

export default App;

Angular 集成

SpRestLib 也可以与 Angular 项目集成，以下是一个简单的示例：

import { Component, OnInit } from '@angular/core';
import sprLib from 'sprestlib';

@Component({
    selector: 'app-root',
    template: `<pre>{{ userInfo | json }}</pre>`
})
export class AppComponent implements OnInit {
    userInfo: any;

    ngOnInit() {
        sprLib.user().info().then(objUser => this.userInfo = objUser);
    }
}

通过这些示例，你可以看到 SpRestLib 如何轻松地与现代前端框架集成，简化与 SharePoint 的交互。