指定Web服务引用自动生成的实体基类

时间:2009-09-30 13:27:47

标签: c# visual-studio-2008 web-services auto-generate

问题:
是否可以(自动)更改通过Visual Studio“添加Web引用”功能创建的自动生成的域对象的基类,而无需手动修改References.cs?

背景
当我们添加对Web服务的引用时(通过Visual Studio的“添加Web引用”功能),会自动生成许多类。这些代表一个代理对象(例如MyServiceSoapClient)和一些自动生成的域对象(例如,一个CustomerInfo)。

所以,如果我按照以下方式做某事:

MyServiceSoapClient client = new MyServiceSoapClient();
CustomerInfo cust = client.GetCustomer("John Smith");

我将获得一个具有各种属性等的CustomerInfo对象,所有这些都可以从服务器返回的任何XML中反序列化。

问题是......
假设我将cust对象中Name属性的值更改为“Bob Dylan” 理想情况下,我想有一个名为ServiceEntity的基类,它将跟踪是否已经进行了更改(通过捕获基类中有限提供的INotifyPropertyChanged.PropertyChanged事件),以提供一个'Dirty'属性,指示该对象具有因为它是从服务中取出而改变的。

解决方案
虽然下面的答案很好,但我们采取了稍微不同的方法...... 由于只需要在几种情况下记录同步状态,因此通过Generic类添加同步跟踪更有意义,因此我们可以在需要时使用它。
这是一个示例泛型类和接口:

界面:

public interface ISyncEntity
{
    /// <summary>
    /// Gets or Sets the Entity Sync State
    /// </summary>
    [XmlIgnore]
    [SoapIgnore]
    EntitySyncState SyncState { get; set; }

    /// <summary>
    /// Flag for deletion
    /// </summary>
    void DeleteOnSync();

    /// <summary>
    /// Flag for Creation
    /// </summary>
    void CreateOnSync();
}

班级:

public class SyncEntity<TEntity> : ISyncEntity
{
    /// <summary>
    /// Backing Field for Entity Property
    /// </summary>
    private TEntity _entity;

    /// <summary>
    /// Gets or Sets the Entity in question
    /// </summary>
    public TEntity Entity
    {
        get { return _entity; }
        set { OnEntityChange(value); }
    }

    /// <summary>
    /// Invoked when a Property on the Entity is changing
    /// </summary>
    /// <param name="entity"></param>
    protected void OnEntityChange(TEntity entity)
    {
        // Detach the property change event handler from the previous entity?
        if (_entity is INotifyPropertyChanged)
            (entity as INotifyPropertyChanged).PropertyChanged -= OnPropertyChange;

        // Set backing field
        _entity = entity;

        // Implements INotifyPropertyChanged?
        if (entity is INotifyPropertyChanged)
            (entity as INotifyPropertyChanged).PropertyChanged += OnPropertyChange;

        // Set the Sync State
        SyncState = EntitySyncState.Unchanged;
    }



    /// <summary>
    /// Fired when a property in the entity changes
    /// </summary>
    /// <param name="sender"></param>
    /// <param name="e"></param>
    protected void OnPropertyChange(object sender, PropertyChangedEventArgs e)
    {
        // If a delete or create is already pending, don't worry about the update!
        if (SyncState == EntitySyncState.Unchanged)
            SyncState = EntitySyncState.UpdatePending;
    }

    #region Sync Framework Members

    [XmlIgnore]
    [SoapIgnore]
    public EntitySyncState SyncState
    {
        get;
        set;
    }

    public void DeleteOnSync()
    {
        SyncState = EntitySyncState.DeletePending;
    }

    public void CreateOnSync()
    {
        SyncState = EntitySyncState.CreatePending;
    }

    #endregion
}

扩展方法:

public static SyncEntity<TEntity> ToSyncEntity<TEntity>(this TEntity source)
{
    if (source == null)
        throw new ArgumentException("Source cannot be null");

    return new SyncEntity<TEntity>()
    {
        Entity = source
    };
}

1 个答案:

答案 0 :(得分:1)

通过Visual Studio的Web引用功能生成的客户端代理类是使用.Net Framework的wsdl.exe utility构建的。生成时,输出会生成公共部分类。您可以在另一个添加了您尝试实现的事件代码的文件中提供其他类代码,而不是尝试修改自动生成的输出。

当然,这留下了为每个对象实现类似的代码。根据您的源服务,您可以考虑扩展SoapHttpClientProtocol(或代表您的对象的任何协议基类),以便为所有继承对象提供单个实现。如果不使用AOP,这可能是不可能的。因此,您的里程可能会有所不同。