rest api方式实现对文档库的管理

分类: IT文章 • 2022-07-29 14:09:32

写在前面

刚入职一家新公司，在对接app的时候需要获取到某公司的sharepoint上面的文档库，获取文档库列表，团队文档库中的文件和文件夹列表，个人文档库中的文件文件夹列表，及在app端进入文件夹的时候需要获取该文件夹下的文件及文件夹列表，对文件的上传下载等操作。

对rest api的使用，完全是小白，具体也不知道怎么实现，在编写过程中查找了很多资料，发现这方面的资料极其少，也有可能是对自己对这个技术完全的不了解，所以在查找方向上面有问题。最后算是实现了上面的功能，这里做一下记录，以及提供一些参考资料。

实现过程

在如果注册app以及注册发布者的操作步骤，可以参考我之前的一篇文章：Rest API的简单应用，这里介绍了如何注册app和发布者的操作步骤，也包括了如何使用高安全的访问方式。希望对你有所帮助。项目的简单描述，本项目实现方式是一个server to server的方式，在app请求iis上面部署的接口，然后该iis服务器再去请求sharepoint服务器的api，获取文档库的相关信息。流程是大概这样的一个流程。

注册的发布者：所有的操作可以使用同一个发布者。

团队文档库：可以使用同一个ClientID

个人文档库：每一个人对应一个ClientID。

查询方式使用了OData的方式，关于OData的查询方式，可以参考这篇文章

https://msdn.microsoft.com/zh-SG/library/fp142385

查询

查询单个文件的信息

 1         /// <summary>
 2         /// 根据文件在服务端的相对url获取文件信息
 3         /// </summary>
 4         /// <param name="serverRelativeUrl">文件在服务端的相对url</param>
 5         /// <returns>文件信息的json</returns>
 6         public string GetFileInfoByRelativeUrl(string serverRelativeUrl)
 7         {
 8             ///Personal/chenwd/Documents/Shared with Everyone
 9             string queryFileApi = "GetFileByServerRelativeUrl('" + serverRelativeUrl + "')";
10             string filter = "?$select=" + new Document.Core.Model.Document().ToString();
11             if (_documentType == Model.DocumentType.Personal)
12             {
13                 RequestHelper.ClientID = _dicMapping[_userName];
14             }
15             string strFileJson = RequestHelper.RequestGet(_userName, _appUrl, queryFileApi + filter, _documentType);
16             return strFileJson.ToJson("200");
17         }

这里将文件信息封装成为一个类，并重写了tostring方法，方便操作。

 1    /// <summary>
 2     /// 文档信息实体类
 3     /// </summary>
 4     public class Document
 5     {
 6         /// <summary>
 7         /// 签入描述
 8         /// </summary>
 9         public string CheckInComment { get; set; }
10         /// <summary>
11         /// 签出类型
12         /// </summary>
13         public string CheckOutType { get; set; }
14         /// <summary>
15         /// 内容Tag
16         /// </summary>
17         public string ContentTag { get; set; }
18         /// <summary>
19         /// CustomizedPageStatus
20         /// </summary>
21         public string CustomizedPageStatus { get; set; }
22         /// <summary>
23         /// 独占签出标识
24         /// </summary>
25         public string ETag { get; set; }
26         /// <summary>
27         /// 是否存在
28         /// </summary>
29         public string Exists { get; set; }
30         /// <summary>
31         /// 大小
32         /// </summary>
33         public string Length { get; set; }
34         /// <summary>
35         /// 等级
36         /// </summary>
37         public string Level { get; set; }
38         /// <summary>
39         /// 主要版本
40         /// </summary>
41         public string MajorVersion { get; set; }
42         /// <summary>
43         /// 次版本
44         /// </summary>
45         public string MinorVersion { get; set; }
46         /// <summary>
47         /// 文档名称
48         /// </summary>
49         public string Name { get; set; }
50         /// <summary>
51         /// 文档服务端相对地址
52         /// </summary>
53         public string ServerRelativeUrl { get; set; }
54         /// <summary>
55         /// 创建时间
56         /// </summary>
57         public string TimeCreated { get; set; }
58         /// <summary>
59         /// 最后一次修改时间
60         /// </summary>
61         public string TimeLastModified { get; set; }
62         /// <summary>
63         /// 描述
64         /// </summary>
65         public string Title { get; set; }
66         /// <summary>
67         /// 版本
68         /// </summary>
69         public string UIVersion { get; set; }
70         /// <summary>
71         /// 版本标识
72         /// </summary>
73         public string UIVersionLabel { get; set; }
74         public override string ToString()
75         {
76             Type type = this.GetType();
77             PropertyInfo[] pros = type.GetProperties();
78             string str = string.Empty;
79             foreach (var item in pros)
80             {
81                 str += item.Name + ",";
82             }
83             return str.TrimEnd(',');
84         }
85     }

然后使用Odata查询，获取需要的字段的值。
请求辅助类

    /// <summary>
    /// 请求辅助类
    /// </summary>
    public class RequestHelper
    {
        public static string ClientID;
        /// <summary>
        /// get请求
        /// </summary>
        /// <returns></returns>
        public static string RequestGet(string userName, string appUrl, string apiUrl, DocumentType docType)
        {
            string strJson = string.Empty;
            Uri hostWebUri = new Uri(appUrl);
            try
            {
                CheckDcomentType(docType);
                var accessToken = TokenHelper.GetS2SAccessTokenWithWindowsIdentity(hostWebUri, null);
                HttpWebRequest endpointRequest = (HttpWebRequest)HttpWebRequest.Create(appUrl + "/_api/web/" + apiUrl);
                endpointRequest.Method = RequestMethodType.GET.ToString();
                endpointRequest.Accept = "application/json;odata=verbose";
                endpointRequest.Headers.Add("Authorization", "Bearer " + accessToken);
                HttpWebResponse endpointResponse = (HttpWebResponse)endpointRequest.GetResponse();
                StreamReader sr = new StreamReader(endpointResponse.GetResponseStream(), Encoding.UTF8);
                strJson = sr.ReadToEnd();
                sr.Dispose();
            }
            catch (Exception ex)
            {
                strJson = string.Empty.ToErrorJson("500", ex.Message);
            }
            return strJson;
        }
        /// <summary>
        /// 下载文件get请求
        /// </summary>
        /// <param name="appUrl"></param>
        /// <param name="apiUrl"></param>
        /// <param name="filePath"></param>
        /// <param name="fileLength"></param>
        public static void RequestGet(string appUrl, string apiUrl, string filePath, int fileLength, DocumentType docType)
        {
            byte[] buffer = null;
            Uri hostWebUri = new Uri(appUrl);
            CheckDcomentType(docType);
            var accessToken = TokenHelper.GetS2SAccessTokenWithWindowsIdentity(hostWebUri, null);
            HttpWebRequest endpointRequest = (HttpWebRequest)HttpWebRequest.Create(appUrl + "/_api/web/" + apiUrl);
            endpointRequest.Method = "Get";
            endpointRequest.Accept = "application/json;odata=verbose";
            endpointRequest.Headers.Add("Authorization", "Bearer " + accessToken);
            HttpWebResponse endpointResponse = (HttpWebResponse)endpointRequest.GetResponse();
            using (FileStream fs = new FileStream(filePath, FileMode.Create, FileAccess.ReadWrite, FileShare.ReadWrite))
            {
                using (Stream st = endpointResponse.GetResponseStream())
                {
                    BinaryReader br = new BinaryReader(st);
                    buffer = new byte[fileLength];
                    br.Read(buffer, 0, buffer.Length);
                    fs.Write(buffer, 0, buffer.Length);
                }
            }
        }
        /// <summary>
        /// 检测是否是个人文档库的请求
        /// </summary>
        /// <param name="docType">文档类型</param>
        private static void CheckDcomentType(DocumentType docType)
        {
            if (docType == DocumentType.Personal)
            {
                if (string.IsNullOrEmpty(ClientID))
                {
                    throw new ArgumentNullException("ClientID不能为空");
                }
                else
                {
                    TokenHelper.ClientId = ClientID.ToLower();
                }
            }
        }
        /// <summary>
        /// post请求
        /// </summary>
        /// <returns></returns>
        public static string RequestPost(string userName, string appUrl, string apiUrl, DocumentType docType)
        {
            string strJson = string.Empty;
            Uri hostWebUri = new Uri(appUrl);
            try
            {
                CheckDcomentType(docType);
                var accessToken = TokenHelper.GetS2SAccessTokenWithWindowsIdentity(hostWebUri, null);
                HttpWebRequest endpointRequest = (HttpWebRequest)HttpWebRequest.Create(appUrl + "/_api/web/" + apiUrl);
                endpointRequest.Method = RequestMethodType.POST.ToString();
                endpointRequest.Accept = "application/json;odata=verbose";
                endpointRequest.Headers.Add("Authorization", "Bearer " + accessToken);
                //post请求处理 
                endpointRequest.ContentLength = 0;
                endpointRequest.ContentType = "application/json;odata=verbose";
                HttpWebResponse endpointResponse = (HttpWebResponse)endpointRequest.GetResponse();
                StreamReader sr = new StreamReader(endpointResponse.GetResponseStream(), Encoding.UTF8);
                strJson = sr.ReadToEnd().ToSuccessJson("200","操作成功");
                sr.Dispose();
            }
            catch (WebException ex)
            {
                strJson = string.Empty.ToErrorJson("500", ex.Message);
            }
            return strJson;
        }
      
        /// <summary>
        /// put请求
        /// </summary>
        /// <returns></returns>
        public static string RequestPut(string userName, string appUrl, string apiUrl, DocumentType docType)
        {
            string strJson = string.Empty;
            Uri hostWebUri = new Uri(appUrl);
            try
            {
                CheckDcomentType(docType);
                var accessToken = TokenHelper.GetS2SAccessTokenWithWindowsIdentity(hostWebUri, null);
                HttpWebRequest endpointRequest = (HttpWebRequest)HttpWebRequest.Create(appUrl + "/_api/web/" + apiUrl);
                endpointRequest.Method = RequestMethodType.PUT.ToString();
                endpointRequest.Accept = "application/json;odata=verbose";
                endpointRequest.Headers.Add("Authorization", "Bearer " + accessToken);
                HttpWebResponse endpointResponse = (HttpWebResponse)endpointRequest.GetResponse();
                StreamReader sr = new StreamReader(endpointResponse.GetResponseStream(), Encoding.UTF8);
                strJson = sr.ReadToEnd();
                sr.Dispose();
            }
            catch (Exception ex)
            {
                strJson = string.Empty.ToErrorJson("500", ex.Message);
            }
            return strJson;
        }
        /// <summary>
        /// delete请求
        /// </summary>
        /// <returns></returns>
        public static string RequestDelete(string userName, string appUrl, string apiUrl, DocumentType docType)
        {
            string strJson = string.Empty;
            Uri hostWebUri = new Uri(appUrl);
            try
            {
                CheckDcomentType(docType);
                var accessToken = TokenHelper.GetS2SAccessTokenWithWindowsIdentity(hostWebUri, null);
                HttpWebRequest endpointRequest = (HttpWebRequest)HttpWebRequest.Create(appUrl + "/_api/web/" + apiUrl);
                endpointRequest.Method = RequestMethodType.DELETE.ToString();
                endpointRequest.Accept = "application/json;odata=verbose";
                endpointRequest.Headers.Add("Authorization", "Bearer " + accessToken);
                HttpWebResponse endpointResponse = (HttpWebResponse)endpointRequest.GetResponse();
                StreamReader sr = new StreamReader(endpointResponse.GetResponseStream(), Encoding.UTF8);
                strJson = sr.ReadToEnd();
                sr.Dispose();
            }
            catch (Exception ex)
            {
                strJson = string.Empty.ToErrorJson("500", ex.Message);
            }
            return strJson;
        }
        /// <summary>
        /// Merge请求
        /// </summary>
        /// <returns></returns>
        public static string RequestMerge(string userName, string appUrl, string apiUrl, DocumentType docType)
        {
            string strJson = string.Empty;
            Uri hostWebUri = new Uri(appUrl);
            try
            {
                CheckDcomentType(docType);
                var accessToken = TokenHelper.GetS2SAccessTokenWithWindowsIdentity(hostWebUri, null);
                HttpWebRequest endpointRequest = (HttpWebRequest)HttpWebRequest.Create(appUrl + "/_api/web/" + apiUrl);
                endpointRequest.Method = RequestMethodType.MERGE.ToString();
                endpointRequest.Accept = "application/json;odata=verbose";
                endpointRequest.Headers.Add("Authorization", "Bearer " + accessToken);
                HttpWebResponse endpointResponse = (HttpWebResponse)endpointRequest.GetResponse();
                StreamReader sr = new StreamReader(endpointResponse.GetResponseStream(), Encoding.UTF8);
                strJson = sr.ReadToEnd();
                sr.Dispose();
            }
            catch (Exception ex)
            {
                strJson = string.Empty.ToErrorJson("500", ex.Message);
            }
            return strJson;
        }
    }

RequestHelper

为string做扩展方法，将结果使用自定义的格式包裹成json格式。

    /// <summary>
    /// string类型扩展
    /// </summary>
    public static class StringExtention
    {
        /// <summary>
        /// 将json数据包裹在code/time/data中
        /// </summary>
        /// <param name="source">json源</param>
        /// <param name="strCode">状态码</param>
        /// <returns>json数据</returns>
        public static string ToJson(this string source, string strCode)
        {
            StringBuilder sb = new StringBuilder();
            sb.Append("{");
            sb.Append(""_code":");
            sb.Append(""" + strCode + "",");
            sb.Append(""_time":");
            sb.Append(""" + DateTime.Now.ToString("yyyyMMddHHmmss") + "",");
            sb.Append(""_data":");
            sb.Append("{");
            sb.Append(""files":");
            sb.Append(source);
            sb.Append("}}");
            return sb.ToString();
        }
        /// <summary>
        ///拼接json字符串
        /// </summary>
        /// <param name="source">FolderJson字符串</param>
        ///  <param name="strCode">是否成功编码</param>
        /// <param name="strFileInput">要拼接的Filejson字符串</param>
        /// <returns>拼接后的json字符串</returns>
        public static string ToMergeJson(this string source, string strCode, string strFileInput)
        {
            StringBuilder sb = new StringBuilder();
            sb.Append("{");
            sb.Append(""_code":");
            sb.Append(""" + strCode + "",");
            sb.Append(""_time":");
            sb.Append(""" + DateTime.Now.ToString("yyyyMMddHHmmss") + "",");
            sb.Append(""_data":");
            sb.Append("{");
            sb.Append(""folders":");
            if (!string.IsNullOrEmpty(source))
            {
                sb.Append(source);
            }
            else
            {
                sb.Append("{");
                sb.Append(""d":");
                sb.Append("{");
                sb.Append(""results":");
                sb.Append("[");
                sb.Append("{}]");
                sb.Append("}}");
            }
            sb.Append(",");
            sb.Append(""files":");
            sb.Append(strFileInput);
            sb.Append("}}");
            return sb.ToString();
        }
        /// <summary>
        /// 获得下载的文件路径
        /// </summary>
        /// <param name="source">源json</param>
        /// <param name="strCode">响应码</param>
        /// <param name="strUrl">下载的url</param>
        /// <returns>下载的url</returns>
        public static string ToDownLoadJson(this string source, string strCode, string strUrl)
        {
            StringBuilder sb = new StringBuilder();
            sb.Append("{");
            sb.Append(""_code":");
            sb.Append(""" + strCode + "",");
            sb.Append(""_time":");
            sb.Append(""" + DateTime.Now.ToString("yyyyMMddHHmmss") + "",");
            sb.Append(""_data":");
            sb.Append("{");
            sb.Append(""Url":");
            sb.Append(""" + strUrl + """);
            sb.Append("}}");
            return sb.ToString();
        }
        /// <summary>
        /// 返回操作成功的json
        /// </summary>
        /// <param name="source">源字符串</param>
        /// <param name="strCode">操作码</param>
        /// <param name="message">操作提示信息</param>
        /// <returns>json</returns>
        public static string ToSuccessJson(this string source, string strCode, string message)
        {
            StringBuilder sb = new StringBuilder();
            sb.Append("{");
            sb.Append(""_code":");
            sb.Append(""" + strCode + "",");
            sb.Append(""_time":");
            sb.Append(""" + DateTime.Now.ToString("yyyyMMddHHmmss") + "",");
            sb.Append(""_data":");
            sb.Append("{");
            sb.Append(""Message":");
            sb.Append(""" + message + """);
            sb.Append("}}");
            return sb.ToString();
        }
        /// <summary>
        /// 错误信息提示
        /// </summary>
        /// <param name="source">源json</param>
        /// <param name="strCode">错误码</param>
        /// <param name="message">错误信息</param>
        /// <returns>错误信息</returns>
        public static string ToErrorJson(this string source, string strCode, string message)
        {
            StringBuilder sb = new StringBuilder();
            sb.Append("{");
            sb.Append(""_code":");
            sb.Append(""" + strCode + "",");
            sb.Append(""_time":");
            sb.Append(""" + DateTime.Now.ToString("yyyyMMddHHmmss") + "",");
            sb.Append(""_data":");
            sb.Append("{");
            sb.Append(""Message":");
            sb.Append(""" + message + """);
            sb.Append("}}");
            return sb.ToString();
        }

    }

StringExtention

查询某个相对服务端的Url下的所有文件及文件夹

 1         /// <summary>
 2         /// 根据文档在服务端的相对Url获取文档信息
 3         /// </summary>
 4         /// <param name="serverRelativeUrl"></param>
 5         /// <returns></returns>
 6         public string GetDocmumentsByRelativeUrl(string serverRelativeUrl)
 7         {
 8             ///Personal/chenwd/Documents/Shared with Everyone
 9             string queryFileApi = "GetFolderByServerRelativeUrl('" + serverRelativeUrl + "')/Files";
10             string queryFolderApi = "GetFolderByServerRelativeUrl('" + serverRelativeUrl + "')/Folders";
11 
12             string filter = "?$select=" + new Document.Core.Model.Document().ToString();
13             if (_documentType == Model.DocumentType.Personal)
14             {
15                 RequestHelper.ClientID = _dicMapping[_userName];
16             }
17             string strFileJson = RequestHelper.RequestGet(_userName, _appUrl, queryFileApi + filter, _documentType);
18             string strFolderJson = RequestHelper.RequestGet(_userName, _appUrl, queryFolderApi + filter, _documentType);
19             return strFolderJson.ToMergeJson("200", strFileJson);
20         }

根据文档库的URL查询所有的文件及文件夹

 1         /// <summary>
 2         /// 根据url获取该url下的所有的文档信息
 3         /// </summary>
 4         /// <param name="docSiteUrl"></param>
 5         /// <returns></returns>
 6         public string GetDocumentsByUrl(string docSiteUrl)
 7         {
 8             //docsiteUrl格式：http://my.xxx.com/Personal/cxxx/Documents/Forms/All.aspx
 9             //解析出文档库服务端的相对路径
10             int startIndex = docSiteUrl.IndexOf("//") + 2;
11             string strRelativeUrl = docSiteUrl.Substring(startIndex);
12             string[] strUrls = strRelativeUrl.Split(new char[] { '/' });
13             strRelativeUrl = "/" + strUrls[1] + "/" + strUrls[2] + "/" + strUrls[3] + "/";
14             string queryFileApi = "GetFolderByServerRelativeUrl('" + strRelativeUrl + "')/Files";
15             string queryFolderApi = "GetFolderByServerRelativeUrl('" + strRelativeUrl + "')/Folders";
16             string filter = "?$select=" + new Document.Core.Model.Document().ToString();
17             if (_documentType == Model.DocumentType.Personal)
18             {
19                 RequestHelper.ClientID = _dicMapping[_userName];
20             }
21             string strFileJson = RequestHelper.RequestGet(_userName, _appUrl, queryFileApi + filter, _documentType);
22             string strFolderJson = RequestHelper.RequestGet(_userName, _appUrl, queryFolderApi + filter, _documentType);
23             return strFolderJson.ToMergeJson("200", strFileJson);
24         }

移动文件

 1         /// <summary>
 2         /// 移动
 3         /// </summary>
 4         /// <param name="serverFileUrl"></param>
 5         /// <param name="newFileUrl"></param>
 6         /// <returns></returns>
 7         public string MoveTo(string serverFileUrl, string newFileUrl)
 8         {
 9             string strMoveToApi = "GetFileByServerRelativeUrl('" + serverFileUrl + "')/moveto(newurl='" + newFileUrl + "',flags=1)";
10 
11             if (_documentType == Model.DocumentType.Personal)
12             {
13                 RequestHelper.ClientID = _dicMapping[_userName];
14             }
15             return RequestHelper.RequestPost(_userName, _appUrl, strMoveToApi, _documentType);
16         }

 1        /// <summary>
 2         /// 创建文件夹
 3         /// </summary>
 4         /// <param name="serverRelativeUrl"></param>
 5         /// <param name="folderName"></param>
 6         /// <returns></returns>
 7         public string CreateFolder(string serverRelativeUrl, string folderName)
 8         {       
 9             serverRelativeUrl = serverRelativeUrl.StartsWith("/", StringComparison.CurrentCulture) ? serverRelativeUrl : "/" + serverRelativeUrl;
10             string createFolderApi = "folders/add('" + serverRelativeUrl + "/" + folderName + "')";
11 
12             if (_documentType == Model.DocumentType.Personal)
13             {
14                 RequestHelper.ClientID = _dicMapping[_userName];
15             }
16             return RequestHelper.RequestPost(_userName, _appUrl, createFolderApi, _documentType);
17         }

将所需的字段封装为文档库实体，方便以后的操作

 1   /// <summary>
 2     /// 文档库实体类
 3     /// </summary>
 4     public class DocumentSite
 5     {
 6         /// <summary>
 7         /// 文档库id
 8         /// </summary>
 9         public string Id { set; get; }
10         /// <summary>
11         /// 文档库父Url
12         /// </summary>
13         public string ParentWebUrl { set; get; }
14         /// <summary>
15         /// 文档库的英文标识名字
16         /// </summary>
17         public string EntityTypeName { set; get; }
18         /// <summary>
19         /// 当前文档库文档数
20         /// </summary>
21         public string ItemCount { set; get; }
22         /// <summary>
23         /// 最后一次删除时间
24         /// </summary>
25         public string LastItemDeletedDate { set; get; }
26         /// <summary>
27         /// 最后一次修改时间
28         /// </summary>
29         public string LastItemModifiedDate { set; get; }
30         /// <summary>
31         /// 文档库名称
32         /// </summary>
33         public string Title { set; get; }
34         /// <summary>
35         /// 创建时间
36         /// </summary>
37         public string Created { set; get; }
38         /// <summary>
39         /// 返回所有的属性，以逗号分隔
40         /// </summary>
41         /// <returns></returns>
42         public override string ToString()
43         {
44             Type type = this.GetType();
45             PropertyInfo[] pros = type.GetProperties();
46             string str = string.Empty;
47             foreach (var item in pros)
48             {
49                 str += item.Name + ",";
50             }
51             return str.TrimEnd(',');
52         }
53     }

DocumentSite

rest api方式实现对文档库的管理

写在前面

实现过程

总结

相关推荐