wp8使用Beetle.NetPackage实现基于TCP通讯的订单查询

在新版本的Beetle.NetPackage中提供了对Protobuf和Controller的支持,所以在WP8下使用Beetle.NetPackage进行基于TCP的数据交互则一件非常简单事情.下面通过组件在WP8下简单实现基于TCP通讯的订单在线查询功能.

协议定义

为了简化交互数据的处理在这里使用Protobuf来描述数据交互,通过Protobuf制订一系列的请求和应答对象来代替平常在TCP下繁琐的数据流处理过程.下面通过Protobuf来描述订单查询的通讯协议.

 [ProtoContract]
     public class GetCustomer
     {
         [ProtoMember()]
         public string Name { get; set; }
     }

     [ProtoContract]
     public class GetCustomerResponse
     {

         [ProtoMember()]
         public IList<Customer> Items
         {
             get;
             set;
         }

     }

     [ProtoContract]
     public class Customer
     {
         [ProtoMember()]
         public string ID
         {
             get;
             set;
         }
         [ProtoMember()]
         public string Name
         {
             get;
             set;
         }
         public override string ToString()
         {
             return Name;
         }
     }

     [ProtoContract]
     public class GetEmployee
     {
         [ProtoMember()]
         public string Name { get; set; }
     }

     [ProtoContract]
     public class GetEmployeeResponse
     {
         [ProtoMember()]
         public IList<Employee> Items
         {
             get;
             set;
         }
     }

     [ProtoContract]
     public class Employee
     {

         [ProtoMember()]
         public string ID
         {
             get;
             set;
         }
         [ProtoMember()]
         public string Name
         {
             get;
             set;
         }
         public override string ToString()
         {
             return Name;
         }

     }

     [ProtoContract]
     public class OrderSearch
     {
         [ProtoMember()]
         public string Employee { get; set; }
         [ProtoMember()]
         public int PageIndex { get; set; }
         [ProtoMember()]
         public string Customer { get; set; }
         [ProtoMember()]
         public string FromDate { get; set; }
         [ProtoMember()]
         public string ToDate { get; set; }
     }

     [ProtoContract]
     public class OrderSearchResponse
     {
         [ProtoMember()]
         public IList<Order> Items
         {
             get;
             set;
         }
         [ProtoMember()]
         public int PageIndex
         {
             get;
             set;
         }
         [ProtoMember()]
         public int Pages
         {
             get;
             set;
         }
     }

     [ProtoContract]
     public class Order
     {
         [ProtoMember()]
         public string OrderID { get; set; }
         [ProtoMember()]
         public string Employee { get; set; }
         [ProtoMember()]
         public string Customer { get; set; }
         [ProtoMember()]
         public string OrderDate { get; set; }
         [ProtoMember()]
         public string RequiredDate { get; set; }
         [ProtoMember()]
         public string ShippedDate { get; set; }
         [ProtoMember()]
         public string ShipName { get; set; }
         [ProtoMember()]
         public string ShipAddress { get; set; }
         [ProtoMember()]
         public string ShipCity { get; set; }
         [ProtoMember()]
         public string ShipRegion { get; set; }
     }

     [ProtoContract]
     public class GetOrderDetail
     {
         [ProtoMember()]
         public string OrderID { get; set; }
     }

     [ProtoContract]
     public class GetOrderDetailResponse
     {
         [ProtoMember()]
         public IList<OrderDetail> Items
         {
             get;
             set;
         }
     }

     [ProtoContract]
     public class OrderDetail
     {
         [ProtoMember()]
         public string OrderID { get; set; }
         [ProtoMember()]
         public string Product { get; set; }
         [ProtoMember()]
         public double UnitPrice { get; set; }
         [ProtoMember()]
         public int Quantity { get; set; }
         [ProtoMember()]
         public float Discount { get; set; }
     }

由于这里使用了protobuf-net,所以通过类和特性来结合,其实规范方便其他平台处理还是建议使用proto文件描述来生成对应的类,这样可以方便生成C++,JAVA等不同平台的交互对象.

定义TCP通讯对象

通过Beetle.NetPackage对protobuf的支持,在WP8下建立相应的TCP通讯是件非常简单的事情.

 Beetle.NetPackage.ProtoPakcage.Register(typeof(MainPage).Assembly);
             if (mClient == null)
             {
                 mClient = new Beetle.NetPackage.NetClient("192.168.0.104", , new Beetle.NetPackage.ProtoPakcage(), this);
                 mClient.LittleEndian = false;
             }
             mClient.Connect();

在使用protobuf前通过ProtoPakcage.Register把程序集下面对应的protobuf消息注册到组件中,然后创建相应的NetClient就可以进行数据通讯.在这里为了和android交互兼容把client的LittleEndian属性设置成false即在处理数据过程采用高字序作为一些数据类型的处理方式.

消息路由分发

在新版本的Beetle.NetPackage中提供简单的消息路由功能,因此在编写消息接收处理的时候再也不需要通过if来判断不同消息去调用方法.使用消息路由并不需开发人员定义复杂的消息规则,只需要定义相应消息类型的参数即可让组件帮助完成这个事情.

 public void OnSearchOrderResponse(Beetle.NetPackage.NetClient client, OrderSearchResponse e)
         {
             if (e.Items == null)
                 lstOrders.ItemsSource = null;
             else
                 lstOrders.ItemsSource = e.Items.ToList();
             mPageIndex = e.PageIndex;
             mPages = e.Pages;
         }

         public void OnGetEmployee(Beetle.NetPackage.NetClient client, GetEmployeeResponse e)
         {
             mEmployees = e.Items;
             lstEmployee.ItemsSource = e.Items.ToList();
         }
         public void OnGetCustomer(Beetle.NetPackage.NetClient client, GetCustomerResponse e)
         {
             mCustomers = e.Items;
             lstCustomer.ItemsSource = e.Items.ToList();

         }
         public void OnGetOrderDetail(Beetle.NetPackage.NetClient client, GetOrderDetailResponse e)
         {
             DialogOrderDetail detail = new DialogOrderDetail();
             CustomMessageBox mOrderDetailDialog = new CustomMessageBox
             {
                 Content = detail,
                 Title = "OrderDetail",
                 RightButtonContent = "OK"
             };
             detail.ListSelector.ItemsSource = e.Items.ToList();
             mOrderDetailDialog.Show();
         }

以上是制定不同消息的处理过程,在接收消息的时候触发这些过程只需要简单地调用Controller.Invoke方法即可完成.

 public void ClientReceive(Beetle.NetPackage.NetClient client, object message)
         {
             this.Dispatcher.BeginInvoke(() =>
             {
                 Beetle.NetPackage.Controller.Invoke(this, mClient, message);
             });
         }

在消息接收方法中调用Controller.Invoke组件会自动匹配相应消息处理的方法并调用,由于是组件自动匹配所以在制定方法的过程也需要遵循一个规则,就是在一个对象中对应消息处理的方法必须是唯一的.

运行效果

　　

总结

通过Beetle.NetPackage只需要很少量的代码就能完成基于TCP的对象数据交互处理,而开发者是完全不用关心下层的协议处理细节,Beetle.NetPackage不仅仅提供对wp8的支持,还提供对flash和android的支持.

下载sample

组件开源官网:https://beetlenp.codeplex.com/