.Net Core集成Office Web Apps（一）

　　最近開始學習.Net Core，並使用Visual Studio Code工具來開發。感覺開發起來特別的方便，但是有個頭疼的地方：許多的類庫被修改了，一時半會兒還熟悉不了，需要查閱官方API。。。

　　Microsoft Office Web Apps（以下簡稱OWA）是由微軟推出的基於Web端的在線辦公工具，它將Microsoft Office產品的體驗延伸到可支持的瀏覽器上。OWA讓你可以在任何地方共享自己的Office文檔。

　　系統集成OWA需要參考官方的系統接口定義（https://wopi.readthedocs.io/en/latest/），這個接口簡稱WOPI（Web Application Open Platform Interface）。

下面介紹一個完整的OWA的例子，最終效果如圖：

wopi協議的工作流程如下圖

 

　　我們所要做的就是開發一個OWA客戶端，提供文件信息及文件流給OWA服務器，當然也接收從OWA服務POST來的文件流來保存文件，出於安全考慮也可以加上access_token進行自定義權限驗證。

　　標准的WOPI服務包括：CheckFileInfo、GetFile、Lock、GetLock、RefreshLock、Unlock、UnlockAndRelock、PutFile、PutRelativeFile、RenameFile、DeleteFile、PutUserInfo等

返回狀態碼定義：

200 OK 成功

400 Bad Request 錯誤請求

401 Unauthorized 非法 與access_token相關

409 Conflict 沖突 目標文件已經存在或LOCK

413 Request Entity Too Large 文件太大

500 Internal Server Error 內部服務器錯誤

501 Not Implemented 不支持，如果CheckFileInfo的SupportsUpdate和UserCanNotWriteRelative都設置為true，則必須返回501

OwaFileInfo類

需要定義一個文件信息類，該類的主要屬性包括：

屬性名	類型	描述
BaseFileName	String	包含擴展的文件名
BreadcrumbFolderName	String	文件夾名稱（界面顯示）
BreadcrumbDocName	String	文檔名稱（界面顯示）
OwnerId	String	唯一標識文件所有者
Size	Long	文件大小
SHA256	String	SHA-2 256位散列編碼值
Version	String	版本編號
SupportsUpdate	Bool	是否支持PUT文件
UserCanWrite	Bool	是否有權限修改
SupportsLocks	Bool	是否支持Lock和Unlock
CloseButtonClosesWindow	Bool	是否顯示關閉按鈕
更多屬性參考API   https://wopirest.readthedocs.io/en/latest/files/CheckFileInfo.html

屬性名必須與API中一致才能被OWA服務器識別。

 

using System;
using System.Runtime.Serialization;

namespace WebApplication.Models.FileInfoModels
{
    [DataContract(Name = "OwaFileInfo")]
    public class OwaFileInfo
    {
        public OwaFileInfo()
        {
            this.SupportsUpdate = false;
            this.UserCanWrite = false;
            this.SupportsLocks = false;
        }

        [DataMember(Name = "BaseFileName")]
        public string BaseFileName { get; set; }
        [DataMember(Name = "OwnerId")]
        public string OwnerId { get; set; }
        [DataMember(Name = "Size")]
        public long Size { get; set; }
        [DataMember(Name = "SHA256")]
        public string SHA256 { get; set; }
        [DataMember(Name = "Version")]
        public string Version { get; set; }
        [DataMember(Name = "SupportsUpdate")]
        public bool SupportsUpdate { get; set; }
        [DataMember(Name = "UserCanWrite")]
        public bool UserCanWrite { get; set; }
        [DataMember(Name = "SupportsLocks")]
        public bool SupportsLocks { get; set; }
        [DataMember(Name = "BreadcrumbDocName")]
        public string BreadcrumbDocName { get; set; }
        [DataMember(Name = "CloseButtonClosesWindow")]
        public bool CloseButtonClosesWindow { get; set; }
        [DataMember(Name = "BreadcrumbFolderName")]
        public string BreadcrumbFolderName { get; set; }
    }
}

CheckFileInfo服務

接口要求實現CheckFileInfo服務，作用是OWA服務器需要獲取文件的詳細信息和操作權限（如：是否可編輯），以確保文件的真實有效。這些信息已經在上面的類中進行了定義。

Method：GET

URI：HTTP://server/<...>/wopi*/files/<id>

Request Headers：

X-WOPI-SessionContext 上下文session參數值

該接口需要返回的json格式如：

{"BaseFileName":"test.docx","OwnerId":"admin","Size":798,"SHA256":"wlbRK+XNdLtHNaOcXnejbIVzHPHAZzI+1MhKNHUCVlw=","Version":"2016-03-17T02:27:33","SupportsUpdate":true,"UserCanWrite":true,"SupportsLocks":true,"WebEditingDisabled":false}

說明：

0.返回的屬性名區分大小寫，很多插件默認將頭字母轉換成小寫，最終導致對接失敗。

1.所有的OWA客戶端接口URl必須以/wopi開頭

如：

http://localhost:5000/api/wopi/files/test.docx

http://localhost:5000/api/wopi_test/files/test.docx

 

2. SHA256的計算

a.獲取該文件的文件流

b SHA256計算文件流Hash值

c.將Hash值轉換為Base64String

string sha256 = "";
using (FileStream stream = File.OpenRead(fileName))
using (var sha = SHA256.Create())
{
      byte[] checksum = sha.ComputeHash(stream);
      sha256 = Convert.ToBase64String(checksum);
}

3.驗證action返回的結果，訪問http://localhost:5000/api/wopi/files/test.docx，返回結果如下圖

GetFile服務

當office web apps檢驗完文件信息后就可以獲取文件了

Method：GET

URI: HTTP://server/<...>/wopi*/files/<id>/contents?access_token=<token>

Request Headers：

X-WOPI-MaxExpectedSize

Response Headers:

X-WOPI-ItemVersion 文件版本號類似於CheckFileInfo里的Version

返回文件的二進制流

[Route("files/{name}/contents")]
[HttpGetAttribute]
public FileStreamResult Get(string name, string access_token)
{
      var file = "Files/" + name;
      var stream = new FileStream(file, FileMode.Open, FileAccess.Read);
      return new FileStreamResult(stream, "application/octet-stream");
}

PutFile服務

Method：POST

URI: HTTP://server/<...>/wopi*/files/<id>/contents?access_token=<token>

 

Request Headers:

X-WOPI-Override 固定值 PUT，必須

X-WOPI-Lock 鎖定請求的字符串標識（具體參考LOCK請求）

Response Headers:

X-WOPI-Lock鎖定請求的字符串標識

X-WOPI-LockFailureReason 鎖定失敗原因

X-WOPI-ItemVersion 版本號

請求內容為文件的二進制格式

[Route("files/{name}/contents")]
[HttpPostAttribute]
public async void Post(string name, string access_token)
{
      using (FileStream fs = System.IO.File.Create("Files/" + name))
     {
          await Request.Body.CopyToAsync(fs);
      }
}

至此基本的Office在線預覽功能就基本完成了

后續工作：

1.規范請求和返回的頭信息，完善功能實現在線編輯

2.引入配置文件和緩存配置數據

3.添加預覽和編輯鏈接生成controller

4.完善access_token驗證邏輯