Websharp使用说明

2022-07-15 80酷酷网 80kuku.com

　　web

前言

N层的应用软件系统，由于其众多的优点，已经成为典型的软件系统架构，也已经为广大开发人员所熟知。在一个典型的三层应用软件系统中，应用系统通常被划分成以下三个层次：数据库层、应用服务层和用户界面层。如下图所示：

其中，应用服务层集中了系统的业务逻辑的处理，因此，可以说是应用软件系统中的核心部分。软件系统的健壮性、灵活性、可重用性、可升级性和可维护性，在很大程度上取决于应用服务层的设计。因此，如何构建一个良好架构的应用服务层，是应用软件开发者需要着重解决的问题。

为了使应用服务层的设计达到最好的效果，我们通常还需要对应用服务层作进一步的职能分析和层次细分。细分的结果，是能够使我们更加容易构建应用服务层的内容。

对于应用服务层来说，我们通常需要处理以下几个方面的内容：

Ø 数据的表示方式

Ø 数据的存取方式

Ø 业务逻辑的组织方式

Ø 业务服务的提供方式

Ø 层的部署和层间交互

关于这些方面的讨论，可以参见拙文《面向对象的应用服务层设计》，或者在这里也能够看到同样的文章。

下面，将就这些部分在Websharp中使用进行一些比较详细的说明。

数据实体的表示

Websharp在数据的表现上，能够采用两种方式。

第一种方式，充分利用了.Net Framework类库中DataSet的功能，设计了一个EntityData类。这个类继承了DataSet，并增加了一些属性和方法。同数据库的映射关系，采用XML配置文件的方式。XML配置文件可以通过我们提供的工具来生成。

在实际的应用中，要获取一个Product实体对象，可以通过如下方式取得：

EntityData Product=EntityProtypeManager. GetEmptyEntity(“Product”);

然后，可以通过如下方式来访问这个对象的属性：

string ProductID=Customer[“ProductID”]

可以看到，这种方式同纯粹的面向对象的方式有点不同。在这种方式下，数据的表现形式只有一个，那就是EntityData。其好处是明显的，不用为每个实体都单独编写一个类，能够大大减少代码的编写量。其缺点也很明显，那就是不能利用编译器类型检测的功能，如果在调用对象的属性的时候，写错了属性的名称，就可能出错，但是，这个问题可以通过工具来解决。这种方式，比较符合原来使用ADO编程人员的习惯。

第二种方式，我们可以编写一个Product类，然后，按照标准的OO的方法来使用这个类。只不过，在编写Product类的时候，必须实现PersistenceCapable接口，并且，同时可以使用到EntityData类的强大功能。

PersistenceCapable类的定义见附1：Websharp主要接口定义——PersistenceCapable

一个按照这个标准实现的Product类的示例如下：

public class Product : PersistenceCapable

{

private EntityData product;

public Product() : this(true)

{}

public Product(bool AutoInit)

{

product=EntityPrototypeManager.GetEmptyEntity("Product");

if(AutoInit)

product.NewRecord();

}

public string ProductID

{

get{return product.GetString("ProductID");}

set{product["ProductID"]=value;}

}

public string Name

{

get{return product.GetString("Name");}

set{product["Name"]=value;}

}

public string UnitName

{

get{return product.GetString("UnitName");}

set{product["UnitName"]=value;}

}

public string Description

{

get{return product.GetString("Description");}

set{product["Description"]=value;}

}

public decimal Price

{

get{return product.GetDecimal("Price");}

set{product["Price"]=value;}

}

public decimal CurrentCount

{

get{return product.GetDecimal("CurrentCount");}

set{product["CurrentCount"]=value;}

}

public int ObjectCount

{

get

{

return product.EntityCount;

}

public EntityData EntityData

{

get

{

return product;

}

set

{

product=value;

}

public bool Next()

{

return product.Next();

}

public void First()

{

product.First();

}

public void AddNew()

{

product.NewRecord();

}

可以看出，采用这种方式，Product类既可以代表一个单个的Product对象，也可以包含一个Product对象集合，并且可以通过Next和First方法来遍历。

如果要表示一对多的对象结构，我们可以采用如下的方式（表明了一个入库单的结构，这个入库单包含了入库单头和相关明细）：

public class Form : PersistenceCapable

{

private EntityData form;

private FormDetail formDetail;

#region 构造函数

public Form() : this(true)

{}

public Form(bool AutoInit)

{

form=EntityPrototypeManager.GetEmptyEntity("Form");

if(AutoInit)

form.NewRecord("Form");

}

public Form(EntityData entity)

{

form=entity;

}

#endregion

#region 属性

public string FormID

{

get{return form["FormID","Form"].ToString();}

set{form["FormID","Form"]=value;}

}

public DateTime FormTime

{

get{return form.GetDateTime("FormTime","Form");}

set{form["FormTime","Form"]=value;}

}

public FormDetail FormDetail

{

get

{

if(formDetail==null)

{

formDetail=new FormDetail(form);

}

return formDetail;

}

#endregion

#region PersistenceCapable 成员

public int ObjectCount

{

get

{

return form.EntityCount;

}

public EntityData EntityData

{

get

{

return form;

}

set

{

form=value;

}

public bool Next()

{

return form.Next("Form");

}

public void First()

{

form.First("Form");

}

public void AddNew()

{

form.NewRecord("Form");

}

#endregion

}

public class FormDetail : PersistenceCapable

{

private EntityData form;

#region 构造函数

public FormDetail() : this(true)

{}

public FormDetail(bool AutoInit)

{

form=EntityPrototypeManager.GetEmptyEntity("Form");

if(AutoInit)

form.NewRecord("FormDetail");

}

public FormDetail(EntityData entity)

{

form=entity;

}

#endregion

#region 属性

public string FormDetailID

{

get{return form["FormDetailID","FormDetail"].ToString();}

set{form["FormDetailID","FormDetail"]=value;}

}

public string FormID

{

get{return form["FormID","FormDetail"].ToString();}

set{form["FormID","FormDetail"]=value;}

}

public string ProductID

{

get{return form["ProductID","FormDetail"].ToString();}

set{form["ProductID","FormDetail"]=value;}

}

public decimal InCount

{

get{return form.GetDecimal("InCount","FormDetail");}

set{form["InCount","FormDetail"]=value;}

}

#endregion

#region PersistenceCapable 成员

public int ObjectCount

{

get

{

return form.Tables["FormDetail"].Rows.Count;

}

public EntityData EntityData

{

get

{

return form;

}

set

{

form=value;

}

public bool Next()

{

return form.Next("FormDetail");

}

public void First()

{

form.First("FormDetail");

}

public void AddNew()

{

form.NewRecord("FormDetail");

}

#endregion

}

数据的存取方式

数据存取的目的，是持久化保存对象。在Websharp中，定义了PersistenceManager接口来实现这个功能。PersistenceManager的定义可以见：附1：Websharp主要接口定义——PersistenceManager

我们可以使用如下的方式来持久化保存一个对象：

Product product=new Product (true);

……//处理product

PersistenceManager pm = PersistenceManagerFactory.Instance().

CreatePersistenceManager();

pm.PersistNewObject(p);

pm.Close();

代码非常简明和直观，没有一大堆数据库操纵的代码，也不容易发生差错。

也可以通过向PersistenceManagerFactory 传递一个PersistenceProperty参数来初始化一个PersistenceManager，如：

PersistenceProperty pp=new PersistenceProperty();

pp……//设置pp的属性

PersistenceManager pm = PersistenceManagerFactory.Instance().CreatePersistenceManager(pp);

关于PersistenceProperty的说明，可以见后面的系统持久化配置信息一节。

事务处理

在很多时候，在处理对象保存的时候，我们需要使用事务处理，特别是在处理上上面示例中的类似于入库单的一对多结构的对象的时候。在Websharp中，我们可以通过Transaction 接口来完成这个功能。Transaction接口的定义可以见：附1：Websharp主要接口定义——Transaction

下面是使用事务处理的一个例子：

Product product=new Product (true);

……//处理product

PersistenceManager pm = PersistenceManagerFactory.Instance().

CreatePersistenceManager();

Transaction trans=pm.CurrentTransaction;

trans.Begin();

try

{

pm.PersistNewObject(p);

trans.Commit();

}

catch(Excption e)

{

trans.Rollback();

}

finally

{

pm.Close();

}

对象的查询

Websharp提供了对对象查询的功能，这个功能通过Query接口提供。Query接口的定义可以见：附1：Websharp主要接口定义——Query

可以通过下面的办法来使用Query接口：

PersistenceManager pm=PersistenceManagerFactory.Instance().CreatePersistenceManager(pp);

Query q=pm.NewQuery("Product");

q.Filter="ProductID='P001'";

q.Open();

EntityData entity=q.QueryData();

dataGrid1.DataSource=entity;

q.Close();

pm.Close();

Websharp也提供了直接操纵数据库的数据访问接口——DataAccess，这个接口对ADO.Net进行了一些封装，可以使程序员更加容易的使用ADO.Net的功能，并且能够屏蔽不同数据库之间的差别。这个接口的定义可以见：附1：Websharp主要接口定义——DataAccess

能够通过PersistenceManager的NewDataAccess方法来初始化一个DataAccess对象，然后调用相应的办法来执行需要的功能。

业务逻辑的处理

有了上面的工作，我们就可以把这些对象组合起来，编写我们的业务逻辑。在面向对象的系统中，业务逻辑表现为对象之间的交互。在一些简单的系统中，没有复杂的业务逻辑，只是一些数据的维护工作，那么，有了上面两个部分的工作，我们实际上可能已经忘成了大部分的工作。

下面是一个简单的例子，表示了一张入库单入库的过程，在这个过程中，需要修改入库单上每种产品的现有库存量：

public void StoreIntoWarehouse(Form insertForm)

{

FormDetail detail=insertForm.FormDetail;

detail.First();

PersistenceManager pm = PersistenceManagerFactory.Instance().CreatePersistenceManager();

Transaction tm=pm.CurrentTransaction;

tm.Begin();

try

{

if(detail.ObjectCount>0)

{

Product product=(Product)pm.FindObjectByPrimaryKey

(detail.ProductID,Type.GetType

("LogisticsDemo.EntityDefinitions.Product"));

product.CurrentCount+=detail.InCount;

pm.UpdateObject(product);

}while(detail.Next());

}

pm.PersistNewObject(insertForm);

tm.Commit();

}

catch(Exception e)

{

tm.Rollback();

throw e;

}

finally

{

pm.Close();

}

可以看到，在使用Websharp后，对于业务逻辑的编写，可以变成一个非常自然的过程，也能够节省很多代码量。

业务服务的提供

业务外观层（Business Facade）的目的，是隔离系统功能的提供者和使用者，更明确地说，是隔离业务逻辑的软件的用户界面（可以参见Facade设计模式）。可以使用现有的任何方法来构建构建这个层次，在我们提供的例子中，我们使用了Web Service。

Websharp应用系统的配置

1、缓存的配置

Websharp使用了微软的Cached Application Block来缓存数据，因此，下面的缓存信息必须在应用程序中添加。关于Cached Application Block，可以参见微软的相关文档。

</configSections>

<!-- DATA PROTECTION SETTINGS

Use DataProtectionInfo to set the assembly and class which implement

the dataprotection interfaces for the cache.

-->

<DataProtectionInfo AssemblyName="Microsoft.ApplicationBlocks.Cache"

ClassName="Microsoft.ApplicationBlocks.Cache.DataProtection.DefaultDataProtection"

ValidationKey="Oci44OQ9C3xAdQ3/BMHpksPfzeTezLkXen/ahQ8T7nVk/KMgAFnssQJr00KUNhRso+MpLVwAinGep6i14X9M+A=="

Validation="SHA1"/>

<!-- STORAGE SETTINGS

Use StorageInfo to set the assembly and class which implement

the storage interfaces for the cache.

Modes: InProc, OutProc

-->

<!--

MmfDictionarySize - It is the size (in bytes) of the dictionary object (in MmfCacheStorage) used to store the references of cache items.

-->

<!-- SCAVENGING SETTINGS

Use the ScavengingAlgorithm to set a class that will be executed when

scavenging is performed.

-->

<!-- EXPIRATION SETTINGS

Use the ExpirationCheckInterval to change the interval to check for

cache items expiration. The value attribute is represented in seconds.

-->

</CacheManagerSettings>

</WebsharpExpirationPolicy>

</configuration>

2、系统持久化配置信息

配置PersistenceProperty，对于Web应用系统，可以在Global.asax中配置，对于Windows应用程序，可以在程序初始化时设置。

下面是设置的一个例子：

PersistenceProperty pp=new PersistenceProperty();

pp.ConnectionString="server=127.0.0.1;uid=sa;pwd=;database=logisticsDemo;";//数据库连接字符串

pp.DatabaseType=DatabaseType.MSSQLServer; //数据库类型

pp.MapFileLocation="WebsharpTestLib,WebsharpTestLib.xml"; //XML定义文件的路径

pp.MapFileLocationTye=MapFileLocationType.Assembly; //XML文件路径的类型

pp.UserID="sa"; //数据库用户名，必须与数据库连接字符串中的用户名一致

pp.Password=""; //数据库用户密码，必须与数据库连接字符串中的用户密码一致

ApplicationConfiguration.DefaultPersistenceProperty=pp; //设置应用程序的默认配置属性

配置信息的说明如下：

1）数据库连接字符串、用户名和密码的设置按照常规设置

2） MapFileLocationTye指明XML映射文件的路径类型，可以有三种类型:

a) AbsolutePath：采用绝对路径的形式，在这种情况下，MapFileLocation设置成绝对路径的形式，如：“d:\apppath\xml”。

b) VirtualPath：对于Web应用程序，可以设置为虚拟路径的形式，如“/MyWebApp/EntityDefinitions/”。

c) Assembly：XML文件作为资源文件被编译。采用这种形式，需要将XML文件的生成操作属性设置成“嵌入的资源”，这种情况下，MapFileLocation的格式为：“AssemblyName,NameSpace”。例如，XML文件位于WebsharpTestLib项目的xml文件夹下面，MapFileLocation可以设置为：“WebsharpTestLib,WebsharpTestLib.xml”

附1：Websharp主要接口定义：

PersistenceCapable：

public interface PersistenceCapable

{

EntityData EntityData{get;set;}

int ObjectCount{get;}

void AddNew();

bool Next();

void First();

}

PersistenceManager：

public interface PersistenceManager : IDisposable

{

void Close();

bool IsClosed{get;}

Transaction CurrentTransaction{ get;}

bool IgnoreCache{get;set;}

void PersistNewObject(EntityData entity);

void PersistNewObject(PersistenceCapable pc);

void UpdateObject(EntityData entity);

void UpdateObject(PersistenceCapable pc);

void DeleteObject(EntityData entity);

void DeleteObject(PersistenceCapable pc);

void Reload(EntityData entity);

void Reload(PersistenceCapable pc);

void Evict (object pc);

void EvictAll (object[] pcs);

void EvictAll (ICollection pcs);

void EvictAll ();

EntityData FindEntityDataByPrimaryKey(object id,string entityTypeName);

EntityData FindEntityDataByPrimaryKey(object id,EntityData entity);

PersistenceCapable FindObjectByPrimaryKey(object id,PersistenceCapable pc);

PersistenceCapable FindObjectByPrimaryKey(object id,Type entityType);

Query NewQuery();

Query NewQuery(string entityTypeName);

Query NewQuery(string entityTypeName,string filter);

Query NewQuery(string entityTypeName,string filter,QueryParameterCollection paramColletion);

DataAccess NewDataAccess();

}

Transaction：

public interface Transaction

{

void Begin();

void Commit();

void Rollback();

PersistenceManager PersistenceManager{get;}

}

Query：

public interface Query

{

string EntityTypeName{get;set;}

string Filter{get;set;}

QueryParameterCollection Parameters

{

get;

set;

}

string Ordering{get;set;}

bool IgnoreCache{get;set;}

EntityData QueryData();

PersistenceCapable QueryObject(PersistenceCapable ps);

EntityData LoadSubObject(EntityData entity,string subTypeName);

PersistenceCapable QueryObject(PersistenceCapable ps,string subTypeName);

EntityData LoadSubObjects(EntityData entity);

PersistenceManager PersistenceManager{get;}

bool QuerySubObjects{get;set;}

bool IsClosed{get;}

void Close ();

void Open();

}

DataAccess：

public interface DataAccess

{

#region Support Property & Method

DatabaseType DatabaseType{get;}

IDbConnection DbConnection{get;}

PersistenceManager PersistenceManager{get;}

IDbTransaction BeginTransaction();

void Open();

void Close();

bool IsClosed{get;}

#endregion

#region ExecuteNonQuery

int ExecuteNonQuery(CommandType commandType, string commandText);

int ExecuteNonQuery(string commandText);

int ExecuteNonQuery(string commandText, QueryParameterCollection commandParameters);

int ExecuteNonQuery(CommandType commandType, string commandText, QueryParameterCollection commandParameters);

#endregion ExecuteNonQuery

#region ExecuteDataSet

DataSet ExecuteDataset(CommandType commandType, string commandText);

DataSet ExecuteDataset(string commandText);

DataSet ExecuteDataset(CommandType commandType, string commandText, QueryParameterCollection commandParameters);

DataSet ExecuteDataset(string commandText, QueryParameterCollection commandParameters);

DataSet ExecuteDataset(CommandType commandType, string commandText,string tableName);

DataSet ExecuteDataset(string commandText,string tableName);

DataSet ExecuteDataset(CommandType commandType, string commandText, QueryParameterCollection commandParameters,string tableName);

DataSet ExecuteDataset(string commandText, QueryParameterCollection commandParameters,string tableName);

DataSet ExecuteDataset(CommandType commandType, string commandText,DataSet ds);

DataSet ExecuteDataset(string commandText,DataSet ds);

DataSet ExecuteDataset(CommandType commandType, string commandText, QueryParameterCollection commandParameters,DataSet ds);

DataSet ExecuteDataset(string commandText, QueryParameterCollection commandParameters,DataSet ds);

DataSet ExecuteDataset(CommandType commandType, string commandText,DataSet ds,string tableName);

DataSet ExecuteDataset(string commandText,DataSet ds,string tableName);

DataSet ExecuteDataset(CommandType commandType, string commandText, QueryParameterCollection commandParameters,DataSet ds,string tableName);

DataSet ExecuteDataset(string commandText, QueryParameterCollection commandParameters,DataSet ds,string tableName);

#endregion ExecuteDataSet

#region ExecuteReader

IDataReader ExecuteReader(CommandType commandType, string commandText);

IDataReader ExecuteReader(string commandText);

IDataReader ExecuteReader(CommandType commandType, string commandText, QueryParameterCollection commandParameters);

IDataReader ExecuteReader(string commandText, QueryParameterCollection commandParameters);

#endregion ExecuteReader

#region ExecuteScalar

object ExecuteScalar(CommandType commandType, string commandText);

object ExecuteScalar(string commandText);

object ExecuteScalar(CommandType commandType, string commandText, QueryParameterCollection commandParameters);

object ExecuteScalar(string commandText, QueryParameterCollection commandParameters);

#endregion ExecuteScalar

#region ExecuteXmlReader

XmlReader ExecuteXmlReader(CommandType commandType, string commandText);

XmlReader ExecuteXmlReader(string commandText);

XmlReader ExecuteXmlReader(CommandType commandType, string commandText, QueryParameterCollection commandParameters);

XmlReader ExecuteXmlReader(string commandText, QueryParameterCollection commandParameters);

#endregion ExecuteXmlReader

}

附2：使用Websharp中间件开发的Demo程序一份。