基于Web Service的客户端框架搭建四：终结篇

前言

　　这是这个系列的终结篇，前面3个博客介绍了一下内容：

　　1、使用Http Post方式调用Web Service

　　2、客户端框架之数据转换层

　　3、客户端框架之代理层

 

框架结构

　　框架是基于C#的，在VS2010中搭建出来的，解决方案搭建完毕之后的框架结构如下图：

　　

　　如上图，框架主要分数据层Data，数据转换成FCL，代理层Proxy，功能分发层Dispatcher以及界面层UI。

　　1、数据转换层FCL

　　　　数据格式转换层，位于在Proxy服务代理层和UI界面层之间。在UI层使用的都是明确的实例对象（比如User对象、Project对象），通过FCL层的　　转换变成Json数据格式的字符串，然后代理层得到字符串，作为服务接口的参数。代理层通过服务接口方法得到Json数据之后，同样通过DFC层转换　　成相应的实力对象，然后绑定到UI上。

　　　　IDFC是数据转换接口，DFC_Project和DFC_User类是接口IDFC的实现类。

　　　　

namespace ProjectmsMGT_FCL
{
    public interface IDFC
    {
        string Object2Json(List<Object> models);

        List<Object> Json2Object(string json);
    }
}

　　　　

namespace ProjectmsMGT_FCL
{
    public class DFC_User : IDFC
    {
        public static JavaScriptSerializer js = new JavaScriptSerializer();

        #region IDFC 成员

        public string Object2Json(List<object> models)
        {
            return js.Serialize(models);
        }

        public List<object> Json2Object(string json)
        {
            List<User> objs = js.Deserialize<List<User>>(json);

            List<Object> list = new List<object>();
            foreach (var item in objs)
            {
                list.Add(item);
            }
            return list;    
        }

        #endregion
    }
}

　　　　

namespace ProjectmsMGT_FCL
{
    public class DFC_Project : IDFC
    {
        public static JavaScriptSerializer js = new JavaScriptSerializer();

        #region IDFC 成员

        public string Object2Json(List<Object> models)
        {
            return js.Serialize(models);
        }

        public List<Object> Json2Object(string json)
        {
            List<Project> objs = js.Deserialize<List<Project>>(json);

            List<Object> list = new List<object>();
            foreach (var item in objs)
            {
                list.Add(item);
            }
            return list;
        }

        #endregion
    }
}

 

　　2、代理层Proxy

　　　　代理层，主要工作是调用服务接口，为UI层服务，同时还要处理Web Service的权限认证以及数据传输安全（SSL）。

　　　　主要包括Http工具类HttpHelper，类的实现可以参考【客户端框架之代理层】。ProjectProxy中就是代理函数的实现。

　　　　

namespace ProjectmsMGT_Proxy
{
    public class ProjectmsProxy
    {
        private readonly string Url = "http://59.68.29.106:8087/IFT_Project.asmx";//通过配置文件获取Web Service地址
        private readonly string requestParaKey = "paramaters";//服务端所有接口函数统一的参数名
        private HttpHelper httpHelper;

        public ProjectmsProxy()
        {
            //初始化
            Initialize();
        }

        private void Initialize()
        {
            httpHelper = new HttpHelper(this.Url, this.requestParaKey);
        }

        /// <summary>
        /// 使用Get方式调用WebService，不带参数
        /// </summary>
        /// <param name="methodName"></param>
        /// <param name="parasJsonStr"></param>
        /// <param name="requestType"></param>
        /// <returns></returns>
        public string Excute(string methodName, string parasJsonStr, string requestType)
        {
            return httpHelper.CreateHttpGet(methodName, false);
        }

        /// <summary>
        /// 默认使用Post方式调用WebService，带参数
        /// </summary>
        /// <param name="methodName"></param>
        /// <param name="parasJsonStr"></param>
        /// <returns></returns>
        public string Excute(string methodName, string parasJsonStr)
        {
            return httpHelper.CreateHttpPost(methodName, parasJsonStr, false);
        }

        /// <summary>
        /// 默认使用Post方式调用WebService，不带参数
        /// </summary>
        /// <param name="methodName"></param>
        /// <returns></returns>
        public string Excute(string methodName)
        {
            return httpHelper.CreateHttpPost(methodName, null, false);
        }
    }
}

 

　　3、功能转发层Dispatcher

　　　　主要任务是调用Proxy为UI层服务。函数分发层只有一个方法Excute，参数字符串methodName、IDFC数据格式转换接口实例对象以及List<Object>对象。主要工作是使用IDFC将参数List<Object>序列化成Json字符串，然后将methodName和Json传给Proxy中的Post方法。

　　　　其中有个RemoteMethodName类，这个类中记录着所有需要远程调用的接口函数的名字。FunctionDispatcher就是功能转发类的Excute方法的实现，这个类在整个项目中只需要一个。

　　　　

namespace ProjectmsMGT_Dispatcher
{
    public class RemoteMethodName
    {
        public readonly static string GetProjectInfoById = "GetProjectInfoById";
        public readonly static string Project = "Project";
        public readonly static string Project_no = "Project_no";
    }
}

　　　　

namespace ProjectmsMGT_Dispatcher
{
    public class FunctionDispatcher
    {
        private ProjectmsMGT_Proxy.ProjectmsProxy proxy = new ProjectmsMGT_Proxy.ProjectmsProxy();

        public List<Object> Excute(string methodName, IDFC idfc, List<Object> paras)
        {
            string jsonParas = idfc.Object2Json(paras);
            string jsonResult = proxy.Excute(methodName, jsonParas);//默认使用Post方式

            return idfc.Json2Object(jsonResult);
        }

        public List<Object> Excute(string methodName, IDFC idfc)
        {
            string jsonResult = proxy.Excute(methodName);

            return idfc.Json2Object(jsonResult);
        }
    }
}

　　4、界面层

　　　　界面层主要就是在界面调用的实例了，

FunctionDispatcher dispatcher = new FunctionDispatcher();
IDFC dfc = new DFC_User();

List<Object> filterList = new List<Object>();
filterList.Add(new UserFilter
{
     UserID = "0206001",
     UserName = "ceshi"
});

filterList.Add(new UserFilter
{
     UserID = "0206002",
     UserName = "ceshi2"
});

List<Object> resultProjects = dispatcher.Excute(RemoteMethodName.Project, dfc, filterList);

foreach (var item in resultProjects)
{
    User user = item as User;
    this.richTextBox1.Text += user.UserID + ":" + user.UserName + "\n";
}

 

总结

　　设计完了代理层，数据转换层，Dispatcher层之后，如果有了新的模块，我们需要做的就是设计UI层，数据层Data，对数据对象实现一个IDFC实现类，在RemoteMethodName类中添加接口函数名常量，这样代码人员的工作就很轻松，需要添加的代码很少。这个框架的主要好处就是模块扩展性好，开发效率高。