最近開始學(xué)習(xí).Net Core，并使用Visual Studio Code工具來開發(fā)。感覺開發(fā)起來特別的方便，但是有個(gè)頭疼的地方：許多的類庫被修改了，一時(shí)半會(huì)兒還熟悉不了，需要查閱官方API。。。

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

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

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

wopi協(xié)議的工作流程如下圖

?

　　我們所要做的就是開發(fā)一個(gè)OWA客戶端，提供文件信息及文件流給OWA服務(wù)器，當(dāng)然也接收從OWA服務(wù)POST來的文件流來保存文件，出于安全考慮也可以加上access_token進(jìn)行自定義權(quán)限驗(yàn)證。

　　標(biāo)準(zhǔn)的WOPI服務(wù)包括：CheckFileInfo、GetFile、Lock、GetLock、RefreshLock、Unlock、UnlockAndRelock、PutFile、PutRelativeFile、RenameFile、DeleteFile、PutUserInfo等

返回狀態(tài)碼定義：

200 OK 成功

400 Bad Request 錯(cuò)誤請求

401 Unauthorized 非法 與access_token相關(guān)

409 Conflict 沖突 目標(biāo)文件已經(jīng)存在或LOCK

413 Request Entity Too Large 文件太大

500 Internal Server Error 內(nèi)部服務(wù)器錯(cuò)誤

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

OwaFileInfo類

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

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

屬性名必須與API中一致才能被OWA服務(wù)器識(shí)別。

?

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; }} } OwaFileInfo

CheckFileInfo服務(wù)

接口要求實(shí)現(xiàn)CheckFileInfo服務(wù)，作用是OWA服務(wù)器需要獲取文件的詳細(xì)信息和操作權(quán)限（如：是否可編輯），以確保文件的真實(shí)有效。這些信息已經(jīng)在上面的類中進(jìn)行了定義。

Method：GET

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

Request Headers：

X-WOPI-SessionContext 上下文session參數(shù)值

該接口需要返回的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.返回的屬性名區(qū)分大小寫，很多插件默認(rèn)將頭字母轉(zhuǎn)換成小寫，最終導(dǎo)致對接失敗。

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

如：

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

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

?

2. SHA256的計(jì)算

a.獲取該文件的文件流

b SHA256計(jì)算文件流Hash值

c.將Hash值轉(zhuǎn)換為Base64String

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

3.驗(yàn)證action返回的結(jié)果，訪問http://localhost:5000/api/wopi/files/test.docx，返回結(jié)果如下圖

GetFile服務(wù)

當(dāng)office web apps檢驗(yàn)完文件信息后就可以獲取文件了

Method：GET

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

Request Headers：

X-WOPI-MaxExpectedSize

Response Headers:

X-WOPI-ItemVersion 文件版本號(hào)類似于CheckFileInfo里的Version

返回文件的二進(jìn)制流

[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服務(wù)

Method：POST

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

?

Request Headers:

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

X-WOPI-Lock 鎖定請求的字符串標(biāo)識(shí)（具體參考LOCK請求）

Response Headers:

X-WOPI-Lock鎖定請求的字符串標(biāo)識(shí)

X-WOPI-LockFailureReason 鎖定失敗原因

X-WOPI-ItemVersion 版本號(hào)

請求內(nèi)容為文件的二進(jìn)制格式

[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在線預(yù)覽功能就基本完成了

后續(xù)工作：

1.規(guī)范請求和返回的頭信息，完善功能實(shí)現(xiàn)在線編輯

2.引入配置文件和緩存配置數(shù)據(jù)

3.添加預(yù)覽和編輯鏈接生成controller

4.完善access_token驗(yàn)證邏輯

轉(zhuǎn)載于:https://www.cnblogs.com/liuxiaobo93/p/5819595.html

總結(jié)

以上是生活随笔為你收集整理的.Net Core集成Office Web Apps（一）的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。