Office文档在线编辑的实现之二

在线编辑Office文档

最新推荐文章于 2025-05-07 16:32:00 发布

最新推荐文章于 2025-05-07 16:32:00 发布 · 199 阅读

文章标签：

#数据库 #设计模式

本文介绍如何利用WebDAV协议实现在客户端直接编辑服务器或数据库中的Office文档，包括关键步骤及代码示例。

< httpHandlers >
< remove verb ="*" path ="*" />
< add verb ="GET,PUT,UNLOCK,LOCK,OPTIONS" path ="*.doc,*.xml" type ="Webdav.WebdavProtocolHandler, Webdav " />
</ httpHandlers >

通过这个配置，使我们的 WebdavProtocolHandler可以来处理webdav请求．

WebdavProtocolHandler类是一个标准的httphandler,实现了IHttpHandler接口，它按照客户端的请求类型，返回符合wevdav协议的数据．

WebdavProtocolHandler类需要按照不同的webdav请求动作,做不同的处理，那么怎么来实现这个类呢？
这里就要用到一个设计模式：命令模式．

首先定义一个接口：

public interface IVerbHandler
{
void Process(HttpContextcontext);
}

实现对Options请求的处理：

class OptionsHandler:IVerbHandler
{
#region IVerbHandler成员

public void Process(System.Web.HttpContextcontext)
{
context.Response.AppendHeader( " DASL " , " <DAV:sql> " );
context.Response.AppendHeader( " DAV " , " 1,2 " );

context.Response.AppendHeader( " Public " , " OPTIONS,TRACE,GET,HEAD,DELETE,PUT,POST,COPY,MOVE,MKCOL,PROPFIND,PROPPATCH,LOCK,UNLOCK,SEARCH " );

context.Response.AppendHeader( " Allow " , " OPTIONS,TRACE,GET,HEAD,DELETE,PUT,COPY,MOVE,PROPFIND,PROPPATCH,SEARCH,LOCK,UNLOCK " );
}

#endregion
}

webdav的请求verb多达15个以上，大多数情况下，我们并不需要一个完整的webdav支持，故我们只要对其中的几个进行实现即可。

实现对LOCK的支持：

class LockHandler:IVerbHandler
{
#region IVerbHandler成员

public void Process(System.Web.HttpContextcontext)
{
context.Response.ContentType = " text/xml " ;

string token = Guid.NewGuid().ToString() + " : " + DateTime.Now.Ticks.ToString();

context.Response.AppendHeader( " Lock-Token " , " <opaquelocktoken: " + token + " > " );

string xml = @" <?xmlversion=""1.0""?>
<a:propxmlns:a=""DAV:""><a:lockdiscovery>
<a:activelock><a:locktype><a:write/></a:locktype>
<a:lockscope><a:exclusive/></a:lockscope><ownerxmlns=""DAV:"">Administrator</owner><a:locktoken>
<a:href>opaquelocktoken:{0}</a:href></a:locktoken>
<a:depth>0</a:depth><a:timeout>Second-180</a:timeout></a:activelock></a:lockdiscovery>
</a:prop> " ;

context.Response.Write(String.Format(xml,token));
context.Response.End();
}

#endregion
}

注意这篇文章的主题：实现在线编辑。并没有版本控制等其他内容，大家仔细看以上的代码，服务器并没有真正实现"锁定"，只是假装告诉客户端，你要的资源已经给你锁定了，你可以放心的编辑了。当然，有兴趣的朋友可以实现真正的锁定，无非可以通过给数据做一个状态字段来实现。但注意，要考虑一些复杂的情况，如自动解锁（用户打开一个文档，然后关机了，文档岂不永远锁定了？）等等。

接着，我们实现UNLOCK,同样是假的:

class UnLockHandler:IVerbHandler
{
#region IVerbHandler成员

public void Process(System.Web.HttpContextcontext)
{
}

#endregion
}

下面，我们将实现两个最重要的请求动作的处理：Get和Put, office请求打开一个服务器上的文件时，采用get请求，office保存一个文件到服务器上时，发送put请求。

首先，我们要考虑一种数据项标识的传递策略，即：客户端发起访问数据库的office文件行，那么如何确认数据行的主键？
有两种策略：
1）通过不同的文件名，如，请求http://localhost/weboffice/1.doc 这个请求主键为1的文件。
2）通过文件路径，如，请求http://localhost/weboffice/1/文件名.doc 这个请求主键为1的文件。
我们将采用策略2。

再返回到我们对web.config做的配置：

< add verb ="GET,PUT,UNLOCK,LOCK,OPTIONS" path ="*.doc,*.xml" type ="Webdav.WebdavProtocolHandler, Webdav " />

这个配置允许 WebdavProtocolHandler处理所有对doc和xml的请求处理，为什么要允许xml呢，因为office2003之后，支持xml格式，可以直接在
数据库重以xml的格式存放office文件。

接着，我们要确认我们的数据存储结构，即，office文件在数据库中时如何存放的。

我们有一个附件表：Document

CREATE TABLE [ dbo ] . [ Document ] (
[ DocumentId ] [ int ] IDENTITY ( 1 , 1 ) NOT NULL ,
[ Name ] [ varchar ] ( 50 )COLLATEChinese_PRC_CI_AS NULL ,
[ Description ] [ text ] COLLATEChinese_PRC_CI_AS NULL ,
[ CreateTime ] [ datetime ] NULL ,
[ Size ] [ int ] NULL ,
[ CreatorId ] [ varchar ] ( 50 )COLLATEChinese_PRC_CI_AS NULL ,
[ CreatorName ] [ char ] ( 10 )COLLATEChinese_PRC_CI_AS NULL ,
[ CreateYear ] [ int ] NULL ,
[ ContentType ] [ varchar ] ( 50 )COLLATEChinese_PRC_CI_AS NULL ,
[ DeptId ] [ varchar ] ( 50 )COLLATEChinese_PRC_CI_AS NULL ,
[ DeptName ] [ varchar ] ( 50 )COLLATEChinese_PRC_CI_AS NULL ,
[ Content ] [ image ] NULL ,
[ ModifyTime ] [ datetime ] NULL ,
[ OwnerType ] [ varchar ] ( 50 )COLLATEChinese_PRC_CI_AS NULL ,
[ TemplateAble ] [ bit ] NULL
) ON [ PRIMARY ] TEXTIMAGE_ON [ PRIMARY ]
GO

设计一个文裆实体：

[Serializable]
public class Document
{
public Document()
{}

static public DocumentFromPostFile(System.Web.HttpPostedFilefile,Useruser)
{
Documentdoc = new Document(file);
doc.CreateTime = DateTime.Now;
doc.CreatorId = user.Id;
doc.CreatorName = user.Name;
doc.DeptId = user.OrgId;
doc.DeptName = user.OrgName;
return doc;
}

public Document(System.Web.HttpPostedFilefile)
{
string []strs = file.FileName.Split( ' // ' );
this .Name = strs[strs.Length - 1 ];
Size = file.ContentLength;
// 读取文件的数据
this .Content = new byte [Size];
StreamfileDataStream = file.InputStream;
fileDataStream.Read( this .Content, 0 ,Size);
ContentType = file.ContentType;
}

private int _DocumentId;
/// <summary>
/// 任务名
/// </summary>
private string _Name;
/// <summary>
/// 任务描述
/// </summary>
private string _Description;
/// <summary>
/// 报表创建时间
/// </summary>
private DateTime_CreateTime = DateTime.Now;
private int _Size = 0 ;
private byte []_Data;
/// <summary>
/// 创建人Id
/// </summary>
private string _CreatorId;
/// <summary>
/// 创建人名
/// </summary>
private string _CreatorName;

private int _CreateYear;
private string _ContentType;
/// <summary>
/// 部门ID(便于统计)
/// </summary>
private string _DeptId;
/// <summary>
/// 部门名
/// </summary>
private string _DeptName;
// PropertyDocumentId
public int DocumentId
{
get
{
return _DocumentId;
}
set
{
this ._DocumentId = value;
}
}
// PropertyName
public string Name
{
get
{
return _Name;
}
set
{
this ._Name = value;
}
}
// PropertyDescription
public string Description
{
get
{
return _Description;
}
set
{
this ._Description = value;
}
}
// PropertyCreateTime
public DateTimeCreateTime
{
get
{
return _CreateTime;
}
set
{
this ._CreateTime = value;
}
}
private DateTime_ModifyTime = DateTime.Now;
public DateTimeModifyTime
{
get
{
return _ModifyTime;
}
set
{
this ._ModifyTime = value;
}
}
// PropertySize
public int Size
{
get
{
return _Size;
}
set
{
this ._Size = value;
}
}
// PropertyData
public byte []Content
{
get
{
return _Data;
}
set
{
this ._Data = value;
}
}
// PropertyCreatorId
public string CreatorId
{
get
{
return _CreatorId;
}
set
{
this ._CreatorId = value;
}
}

// PropertyCreatorName
public string CreatorName
{
get
{
return _CreatorName;
}
set
{
this ._CreatorName = value;
}
}
// PropertyCreateYear
public int CreateYear
{
get
{
return _CreateYear;
}
set
{
this ._CreateYear = value;
}
}
// PropertyContentType
// application/msword
// text/plain
public string ContentType
{
get
{
return _ContentType;
}
set
{
this ._ContentType = value;
}
}

// PropertyDeptId
public string DeptId
{
get
{
return _DeptId;
}
set
{
if ( this ._DeptId != value)
this ._DeptId = value;
}
}
// PropertyDeptName
public string DeptName
{
get
{
return _DeptName;
}
set
{
this ._DeptName = value;
}
}

private string _Type;
public string OwnerType
{
get
{
return _Type;
}
set
{
this ._Type = value;
}
}
private bool _TemplateAble;
/// <summary>
/// 是否可以作为模版
/// </summary>
public bool Templateable
{
get
{
return _TemplateAble;
}
set
{
this ._TemplateAble = value;
}
}
public override string ToString()
{
return Encoding.UTF8.GetString( this .Content);
}

public static DocumentFromString( string s,Useruser)
{
Documentdoc = new Document();
doc.CreateTime = DateTime.Now;
doc.CreatorId = user.Id;
doc.CreatorName = user.Name;
doc.DeptId = user.OrgId;
doc.DeptName = user.OrgName;
doc.Content = Encoding.UTF8.GetBytes(s);
doc.Size = doc.Content.Length;
doc.ContentType = " text/plain " ;
return doc;
}
public static string ByteToString( byte []bytes)
{
return Encoding.UTF8.GetString(bytes);
}
public static byte []StringToByte( string s)
{
return Encoding.UTF8.GetBytes(s);
}
public string GetExtendName()
{
string []arr = this .Name.Split( ' . ' );

if (arr.Length < 1 ) return "" ;
else return arr[arr.Length - 1 ];
}
}

考虑到数据操作逻辑的可变性，不同的项目里面附件表设计的不同，这里引入一个数据操作接口：

public interface IWebdavDocumentHandler
{
DocumentGetDocument( int id);//获取文档数据
void ModifyDocContent( int docId, byte []data);//修改文档内容
}

具体的实现这里就不写了。

好了，我们的数据访问逻辑已经有了，那么首先看get动作处理的实现：

class GetHandler:IVerbHandler
{
#region IVerbHandler成员
public void Process(System.Web.HttpContextcontext)
{
int id = WebdavProtocolHandler.GetDocumentId(context); //获取到主键

IWebdavDocumentHandler docSvr = new DefaultWebdavDocumentHandler() ; //修改此处代码，实现不同的数据操作逻辑，可引入工厂模式
Documentdoc = docSvr.GetDocument(id);

if (doc == null )
{
context.Response.Write( " 文档不存在！ " );
return ;
}

context.Response.Clear();
context.Response.ContentType = doc.ContentType;
// 下载文件名限制32字符16汉字
int maxlength = 15 ;
string fileName = doc.Name; // att.FileName;
if (fileName.Length > maxlength)
{
fileName = " - " + fileName.Substring(fileName.Length - maxlength,maxlength);
}

fileName = HttpUtility.UrlEncode(fileName,System.Text.Encoding.UTF8); // 必须编码，不然文件名会出现乱码
context.Response.AppendHeader( " Content-Disposition " , " attachment;filename= " + fileName + "" );

if (doc.Content != null && doc.Content.Length > 0 )
context.Response.BinaryWrite(doc.Content);

context.Response.End();
}
#endregion
}

很简单吧，跟我们普通实现文档下载的代码一样。

put动作的实现：

class PutHandler:IVerbHandler
{
#region IVerbHandler成员

public void Process(System.Web.HttpContextcontext)
{
int docId = WebdavProtocolHandler.GetDocumentId(context);

Documentdoc = GetDocFromInput(context.Request);

doc.DocumentId = docId;

IWebdavDocumentHandler docSvr = new DefaultWebdavDocumentHandler() ; //修改此处代码，实现不同的数据操作逻辑，可引入工厂模式

docSvr.ModifyDocContent(doc.DocumentId,doc.Content);
}

private DocumentGetDocFromInput(System.Web.HttpRequestrequest)
{
Documentdoc = new Document();
// 读取文件的数据
doc.Content = new byte [request.ContentLength];
doc.Size = request.ContentLength;
StreamfileDataStream = request.InputStream;
fileDataStream.Read(doc.Content, 0 ,doc.Size);
doc.ContentType = request.ContentType;
return doc;
}
#endregion
}

OK，主要的动作都实现了，下面，我们需要WebdavProtocolHandler将各命令处理对象整合到一起：

public class WebdavProtocolHandler:IHttpHandler
{
public static int GetDocumentId(HttpContextcontext)//按照前面确定的主键策略返回主键
{
string url = context.Request.Url.ToString();
string []arr = url.Split( ' / ' );
string id = arr[arr.Length - 2 ];
return Convert.ToInt32(id);
}
public void ProcessRequest(HttpContextcontext)
{
HttpRequestRequest = context.Request;
context.Response.AppendHeader( " OpenWebDavServer " , " 1.0 " );
string verb = Request.HttpMethod;
// Log.Write(verb);
IVerbHandlervh = GetVerbHandler(verb);

if (vh == null )
return ;

vh.Process(context);
}

private IVerbHandlerGetVerbHandler( string verb)
{
switch (verb)
{
case " LOCK " :
return new LockHandler();
case " UNLOCK " :
return new UnLockHandler();
case " GET " :
return new GetHandler();
case " PUT " :
return new PutHandler();
case " OPTIONS " :
return new OptionsHandler();
default :
return null ;
}
}
public bool IsReusable
{
get { return false ;}
}
}

到这里呢，已经基本上算game over了，基于以上代码设计，可以完全实现office文档的在线编辑。若要通过链接直接打开编辑，可以
采用 Office文档在线编辑的实现之一的 Document_Edit2函数触发office编辑。

哦，IIS还需要做一点小配置：
1）将.doc , .xml 加入到站点虚拟目录的isapi映射, 不要选中 "确认文件是否存在"，动作要选全部动作，
2）禁用IIS本身的Webdav扩展,
3）删除虚拟目录HTTP头中的自定义HTTP头: MicrosoftOfficeWebServer，如果有的话。