ASP.NET MVC 提交复杂对象至 WCF Service 技术详解

目录#

准备工作
- 定义复杂对象
- 创建 WCF Service
- 配置 WCF Service
在 ASP.NET MVC 中调用 WCF Service
- 添加服务引用
- 实例化服务客户端
- 提交复杂对象
常见问题及解决方案
- 序列化问题
- 数据验证
- 网络异常处理
最佳实践
- 数据契约设计
- 错误处理策略
- 性能优化
示例代码
总结
参考资料

1. 准备工作#

1.1 定义复杂对象#

在 ASP.NET MVC 项目中，首先定义需要提交的复杂对象。例如，假设我们有一个 Customer 类，包含多个属性：

public class Customer
{
    public int CustomerId { get; set; }
    public string Name { get; set; }
    public Address ShippingAddress { get; set; }
    public List<Order> Orders { get; set; }
}
 
public class Address
{
    public string Street { get; set; }
    public string City { get; set; }
    public string State { get; set; }
    public string ZipCode { get; set; }
}
 
public class Order
{
    public int OrderId { get; set; }
    public string ProductName { get; set; }
    public decimal Price { get; set; }
}

1.2 创建 WCF Service#

创建一个 WCF Service 项目，并定义服务契约和服务实现。例如：

服务契约（IService.cs）

[ServiceContract]
public interface IService
{
    [OperationContract]
    void SubmitCustomer(Customer customer);
}

服务实现（Service.svc.cs）

public class Service : IService
{
    public void SubmitCustomer(Customer customer)
    {
        // 在此处添加处理逻辑，例如将客户信息保存到数据库
    }
}

1.3 配置 WCF Service#

在 Web.config 文件中配置 WCF Service 的端点和绑定。例如：

<system.serviceModel>
    <services>
        <service name="YourNamespace.Service">
            <endpoint address="" binding="basicHttpBinding" contract="YourNamespace.IService" />
            <endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" />
        </service>
    </services>
</system.serviceModel>

2. 在 ASP.NET MVC 中调用 WCF Service#

2.1 添加服务引用#

在 ASP.NET MVC 项目中，右键点击项目，选择“添加服务引用”。输入 WCF Service 的地址（例如 http://localhost/Service.svc），然后点击“确定”。Visual Studio 会自动生成服务客户端代码。

2.2 实例化服务客户端#

在控制器中实例化服务客户端：

using (var client = new ServiceReference1.ServiceClient())
{
    // 调用服务方法
}

2.3 提交复杂对象#

创建一个 Customer 对象，并填充其属性，然后调用服务方法提交：

public ActionResult SubmitCustomer()
{
    var customer = new Customer
    {
        CustomerId = 1,
        Name = "John Doe",
        ShippingAddress = new Address
        {
            Street = "123 Main St",
            City = "Anytown",
            State = "CA",
            ZipCode = "12345"
        },
        Orders = new List<Order>
        {
            new Order { OrderId = 101, ProductName = "Product A", Price = 99.99m },
            new Order { OrderId = 102, ProductName = "Product B", Price = 49.99m }
        }
    };
 
    using (var client = new ServiceReference1.ServiceClient())
    {
        client.SubmitCustomer(customer);
    }
 
    return RedirectToAction("Index");
}

3. 常见问题及解决方案#

3.1 序列化问题#

问题：复杂对象可能无法正确序列化。
解决方案：确保所有属性都标记为可序列化（[DataContract] 和 [DataMember]）。例如：

[DataContract]
public class Customer
{
    [DataMember]
    public int CustomerId { get; set; }
    [DataMember]
    public string Name { get; set; }
    [DataMember]
    public Address ShippingAddress { get; set; }
    [DataMember]
    public List<Order> Orders { get; set; }
}
 
[DataContract]
public class Address
{
    [DataMember]
    public string Street { get; set; }
    [DataMember]
    public string City { get; set; }
    [DataMember]
    public string State { get; set; }
    [DataMember]
    public string ZipCode { get; set; }
}
 
[DataContract]
public class Order
{
    [DataMember]
    public int OrderId { get; set; }
    [DataMember]
    public string ProductName { get; set; }
    [DataMember]
    public decimal Price { get; set; }
}

3.2 数据验证#

问题：提交的数据可能不符合服务端的要求。
解决方案：在服务端和客户端都进行数据验证。在服务端，可以使用 DataAnnotations 进行验证：

public class Service : IService
{
    public void SubmitCustomer(Customer customer)
    {
        var validationContext = new ValidationContext(customer, null, null);
        var validationResults = new List<ValidationResult>();
 
        if (!Validator.TryValidateObject(customer, validationContext, validationResults, true))
        {
            throw new FaultException<string>(string.Join(", ", validationResults.Select(r => r.ErrorMessage)));
        }
 
        // 处理逻辑
    }
}

在客户端，可以使用 jQuery Validation 插件进行前端验证。

3.3 网络异常处理#

问题：网络故障可能导致服务调用失败。
解决方案：在调用服务时，使用 try-catch 块捕获异常，并进行适当的处理：

using (var client = new ServiceReference1.ServiceClient())
{
    try
    {
        client.SubmitCustomer(customer);
    }
    catch (CommunicationException ex)
    {
        // 记录日志或显示错误消息
        ModelState.AddModelError("", "网络连接失败，请重试。");
    }
    catch (FaultException<string> ex)
    {
        // 处理服务端返回的错误
        ModelState.AddModelError("", ex.Message);
    }
}

4. 最佳实践#

4.1 数据契约设计#

保持数据契约简洁，只包含必要的属性。
使用 [DataContract] 和 [DataMember] 明确控制序列化。
避免循环引用，必要时使用 [IgnoreDataMember] 忽略某些属性。

4.2 错误处理策略#

统一的错误处理机制，在服务端和客户端都有清晰的错误反馈。
记录详细的错误日志，便于排查问题。
对于可恢复的错误，提供重试机制。

4.3 性能优化#

减少不必要的数据传输，只传输需要的属性。
使用压缩（如 gzip）减少网络带宽占用。
合理配置 WCF Service 的绑定和行为，例如调整 maxReceivedMessageSize 和 maxBufferSize。

5. 示例代码#

完整的示例代码可以在 GitHub 上获取。

6. 总结#

通过本文的介绍，我们了解了在 ASP.NET MVC 中提交复杂对象至 WCF Service 的详细步骤，包括准备工作、调用服务、处理常见问题和遵循最佳实践。合理设计数据契约、正确处理错误和优化性能是确保系统稳定和高效运行的关键。

目录#