整合Office Web Apps至本身的開發系統

時間  2020-11-25
標籤 html web 算法 json api 瀏覽器 mvc app asp.net post 欄目 HTML 简体版
原文   原文鏈接

原文出處：http://www.cnblogs.com/poissonnotes/p/3267190.htmlhtml

還可參考：https://www.cnblogs.com/majiang/p/3672976.html?utm_source=tuicoolweb

介紹Office Web Apps與其餘系統的關係圖，算法

clip_image001

 

從上述圖中，可知實際上Office Web Apps也是能夠接入本身開發的系統的。下面介紹一下整合Office Web Apps的一些理論知識。json

 

這裏在簡單描述一下原理吧：office web apps（owas）扮演者一個客服端，它會訪問咱們asp.net 站點的文件而後呈現出來。而咱們經常使用的API主要有以下3個：api

GET api/wopi/files/{name}?access_token={access_token}     
GET api/wopi/files/{name}/contents?access_token={access_token}     
POST api/wopi/files/{name}/contents?access_token={access_token}瀏覽器

至於每一個API作什麼 ，第一個是owas 檢查文件，傳遞的信息是json數據格式，第二個是owas獲取文件流，第三個是owas post的文件流（保存修改文件）mvc

 

要想讓本身的系統與Office Web Apps整合就必定要清楚一些概念，首先要理解什麼是」WOPI」。app

WOPI的英文全稱是「Web Application Open Platform Interface」，中文名爲「Web應用程序開放平臺接口協議」。asp.net

 

WOPI協議提供一系列基於web方式的，使文檔能在Office Web Apps中查看與編輯的接口服務（Web Service）。post

只要web application按照標準，實現了WOPI的接口，那麼就能夠調用Office Web Apps。例子不少，好比SharePoint，Exchange，SkyDriver，Dropbox集成Office Web Apps。

若是本身作的web應用也實現了相應接口，也是能夠調用Office Web Apps的。實現文檔的在線編輯查看。

 

這樣比市面上的一些基於ActiveX的在線Office產品有很大的優點。

首先Office Web Apps是基於網頁技術，因此是跨平臺的，能夠在iOS，安卓，WP及PC使用，實現多屏一體。

其次Office Web Apps實現了桌面Office的大部分功能，能在客戶機沒有安裝Office的狀況下，實現雲端上的文檔編輯查看。

 

下面介紹的內容都是基於http協議下的，https也是相似的。

 

在WOPI結構中，

咱們把存放Office文檔的web應用叫WOPI Host或者WOPI Server。

把查看編輯操做Office文檔的web應用叫WOPI Client或者叫WOPI applications。

因此，Office Web Apps充當的就是WOPI Client的角色。

SharePoint，Exchange，本身開發的文檔管理系統充當的就是WOPI Host的角色。

 

下圖爲瀏覽器，server，client三者的請求順序及關係：

clip_image002

從上圖可知，WOPI Client 向WOPI Server發送了兩次請求

1. Tell me about the file

2. Give me the file

 

因此WOPI client至少要提供兩個Web服務。

1. 一個是CheckFileInfo服務

此服務返回的是請求文件的基本信息，WOPI Host以json方式返回給WOPI Client.

服務URI格式通常爲

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

此服務返回的json格式相似爲：

複製代碼 
{

"BaseFileName": "Sample Document.docx", 

"OwnerId": "tylerbutler", 

"Size": 300519,

"SHA256": "+17lwXXN0TMwtVJVs4Ll+gDHEIO06l+hXK6zWTUiYms=", 

"Version": "GIYDCMRNGEYC2MJREAZDCORQGA5DKNZOGIZTQMBQGAVTAMB2GAYA===="

}
複製代碼

Json中至少要包括五個屬性：BaseFileName, OwnerId, Size, SHA256, 和 Version

BaseFileName: 文件名。

OwnerId: 文件全部者的惟一編號。

Size: 文件大小，以bytes爲單位。

SHA256: 文件的256位bit的SHA-2編碼散列內容。

Version: 文件版本號，文件若是被編輯，版本號也要跟着改變。

更多參數介紹請參考：http://msdn.microsoft.com/en-us/library/hh622920(v=office.12).aspx

 

2. 一個是GetFile服務

此服務返回的是請求文件的內容，WOPI host以數據流的方式返回給WOPI Client.

服務URI格式通常爲

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

注意：CheckFileInfo與GetFile服務的URI格式只差了一個/contents，其餘地方的格式是沒有不一樣的。這麼作是爲了讓WOPI client能夠經過CheckFileInfo服務URI推導出GetFile服務的URI，千萬不要別出心裁，寫出的服務URI格式破壞了這層關係。

在上述URI格式中，都有一個access_taken身份驗證令牌。這個身份驗證令牌是必需要有的，WOPI client會把此令牌回發給WOPI Host，由WOPI Host驗證當前用戶對當前文件的權限。因此實際上Office Web Apps根本不涉及文檔的權限管理。

 

咱們在WOPI client上打開一個Office文檔的url地址相似以下：

複製代碼 
http://wopi-app-server.contoso.com/wv/wordviewerframe.aspx?WOPISrc=

http%3A%2F%2Fmy-wopi-host%2Flocal%2Fwopi

%2Ffiles%2F1-Sample%2520Document.docx&access_token=

dc172034-c6f9-4a43-bc3f-d80dd93c1de1
複製代碼

這個裏面有兩個傳遞參數：WOPISrc和access_token

WOPISrc參數的內容爲：http://my-wopi-host/local/wopi/files/1-Sample%20Document.docx

實際上這個是WOPI Host上的CheckFileInfo服務地址。

WOPI client會經過這個地址加上access_token從WOPI host上獲取到1-Sample%20Document.docx文件的信息；

而且經過這個地址推導出WOPI Host上的GetFile服務地址，經過GetFile服務獲取到1-Sample%20Document.docx文件的內容。

 

WOPI host上判斷什麼類型的文件應該怎麼用WOPI client打開，WOPI client會提供一個xml文件給WOPI host，這份xml文件叫WOPI Discovery。格式相似以下：

複製代碼 
<?xml version="1.0" encoding="utf-8"?>

<wopi-discovery>

<net-zone name="external-https">

<app name="Word" favIconUrl="https://wopi-app-server.contoso.com/wv/

resources/1033/FavIcon_Word.ico"

checkLicense="true">

<action name="view" ext="doc" default="true"

urlsrc="https://wopi-app-server.contoso.com/

wv/wordviewerframe.aspx?

<ui=UI_LLCC&><rs=DC_LLCC&><showpagestats=PERFSTATS&>"/>

<action name="view" ext="docm" default="true"

urlsrc="https://wopi-app-server.contoso.com/

wv/wordviewerframe.aspx?

<ui=UI_LLCC&><rs=DC_LLCC&><showpagestats=PERFSTATS&>"/>

……

</app>

……

</net-zone>

</wopi-discovery>
複製代碼

如上所述，打開doc文件，應該使用https://wopi-app-server.contoso.com/ wv/wordviewerframe.aspx的url打開。

WOPI host應該獲取這份文件一次，之後打開什麼類型的文件，調用什麼url本身判斷。

WOPI項目的建立

首先用vs2012建立一個mvc4的程序。如圖：

clip_image002

從上一篇咱們能夠知道，WOPI通信主要經過兩個服務：

一個是CheckFileInfo服務，

一個是GetFile服務。

因此下面咱們主要介紹這兩個服務的建立。

 

1. 首先建立CheckFileInfo服務:

咱們先肯定這個服務的路由地址

設置爲：http://<ServerName>/files/<filename>?access_token=<token>

 

修改App_Start文件夾下面的WebApiConfig.cs文件。

插入下列代碼：

config.Routes.MapHttpRoute(

name: "FileInfo",

routeTemplate: "wopi/files/{name}",

defaults: new { controller = "files", action = "GetFileInfo" }

);

如圖所示

clip_image004

建立一個名稱爲files的Controller，

clip_image006

設置爲空API控制器：

clip_image008

之因此咱們不用日常的MVC控制器，而選API控制器，是由於咱們作的是服務，來返回信息，因此要換成ApiController。

 

這個服務要返回的是json，屬性包括爲

BaseFileName

OwerId

Size

SHA256

Version

因此咱們要建立一個model，包含上述屬性

以下圖：

clip_image010

 

在上述的路由器規則中，action用的是GetFileInfo方法，因此要在FileController規則中寫一個GetFileInfo方法，這個方法返回CheckFileInfo類型。

按 Ctrl+C 複製代碼

public CheckFileInfo GetFileInfo(string name, string access_token)

{

string _access_token = access_token;

var file = HostingEnvironment.MapPath("~/App_Data/" + name);//從硬盤中獲取name文件

FileInfo info = new FileInfo(file);

var json = new CheckFileInfo

{

BaseFileName = info.Name ,//"test.docx",

OwnerId = "admin",

Size = info.Length,

SHA256 = "+17lwXXN0TMwtVJVs4Ll+gDHEIO06l+hXK6zWTUiYms=",

Version = "GIYDCMRNGEYC2MJREAZDCORQGA5DKNZOGIZTQMBQGAVTAMB2GAYA===="

};

return json;

}

按 Ctrl+C 複製代碼

以下圖

clip_image012

咱們訪問一下這個地址：

http://192.9.206.52:1407/wopi/files/test.docx?access_token=06l+hXK6zWTUi

這個192.9.206.52是個人本機地址。

獲得下列結果：

clip_image014

證實這個服務製做成功。

 

2.而後再來製做GetFile服務。

由於GetFileInfo的URI地址

http://<ServerName>/files/<filename>?access_token=<token>

因此GetFile地址應該比其多一個/Contents，因此爲

http://<ServerName>/files/<filename>/Contents?access_token=<token>

 

設置它的路由地址

config.Routes.MapHttpRoute(

name: "Contents",

routeTemplate: "wopi/files/{name}/contents",

defaults: new { controller = "files", action = "GetFile" }

);

以下圖：

image

GetFile這個服務返回的應該是數據流，因此返回的類型應該是HttpResponseMessage類型。

從硬盤中獲取一個doc文件，轉換爲Stream類型，代碼以下：

按 Ctrl+C 複製代碼

public HttpResponseMessage GetFile(string name, string access_token)

{

try

{

string _access_token = access_token;

var file = HostingEnvironment.MapPath("~/App_Data/" + name);//name是文件名

var rv = new HttpResponseMessage(HttpStatusCode.OK);

var stream = new FileStream(file, FileMode.Open, FileAccess.Read);

rv.Content = new StreamContent(stream);

rv.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");

return rv;

}

catch (Exception ex)

{

var rv = new HttpResponseMessage(HttpStatusCode.InternalServerError);

var stream = new MemoryStream(UTF8Encoding.Default.GetBytes(ex.Message ?? ""));

rv.Content = new StreamContent(stream);

return rv;

}

}


按 Ctrl+C 複製代碼

以下圖：

clip_image018

至此，兩個服務製做完畢。

 

能夠訪問下列地址查看效果，

http://192.9.206.50/wv/wordviewerframe.aspx?WOPISrc=http%3a%2f%2f192.9.206.52%3a1407%2fwopi%2ffiles%2ftest.docx&access_token=06l+hXK6zWTUi

 

其中

192.9.206.50爲OWA的機器地址，

192.9.206.52爲本機的地址。

 

這個URL地址帶了兩個參數

分別爲WOPISrc，值爲http://192.9.206.52:1407/wopi/files/test.docx

Access_token，值爲06l+hXK6zWTUi

 

這兩個參數的意思，我已經在之前的博文中《如何整合Office Web Apps至本身開發的系統（一）》說過了。

在這個例子中，access_token我是隨便取的，而且在代碼中也沒有對這個令牌進行驗證。

 

確保兩臺機器的相應端口能互相訪問。

訪問獲得的結果以下：

clip_image020

怎麼會訪問出錯呢？

 

翻了好久資料，發現有老外也遇到過相似這種問題：

I write this message because on actually working on this WOPI protocol. I try to build a WOPI host. I think i'm almost finish the "view" action. But i got some problems with the CheckFileInfo (JSON) or GetFile (/content). For me everything is well fonctionning, but the WAC doesn't work just after it call my JSON. I really dont know why.. I observed all the interactions between SharePoint and WAC, to show what is different with mine host. But i think i need some help now. Does anyone can try to give me some hint ? I checked everythings (Correlation-ID, JSON, access-token) ...

 

別人的回答是讓他考慮一下是否是SHA散列算法的問題：

You might also double-check that your SHA hashes are being calculated correctly - this can cause some problems.

並給了一個網站地址：www.tylerbutler.com/.../base64-encoded-sha256-hashes

 

那就按照提示把散列算法加上去，

代碼以下：

var file = HostingEnvironment.MapPath("~/App_Data/" + name);//從硬盤中獲取name文件
FileInfo info = new FileInfo(file);

var hasher = SHA256.Create();
byte[] hashValue;
using (Stream s = File.OpenRead(file))
{
hashValue = hasher.ComputeHash(s);
}
string sha256 = Convert.ToBase64String(hashValue);


 

以下圖：

clip_image022

 

再次運行，OK，大功告成

clip_image024

 

 

其實按照上述步驟，就能夠在本身的系統中調用Office Web Apps的查看功能了

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程