WebService 设计总结

最新推荐文章于 2018-12-11 12:00:35 发布
最新推荐文章于 2018-12-11 12:00:35 发布
阅读量8.7k 收藏 13
点赞数 7
分类专栏： [08] Web Services
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/fangxing80/article/details/26940845
版权

接触过很多电商的WebService，有种一看就蛋疼的设计，今天要从这个反例说一说 WebService 的设计。

[WebMethod]
public string QueryOrderDetail(string xml)
{
   ...
}

如上代码输入是一个XML，输出也是一个XML，方法内部自己在做序列化和反序列化。放着成熟的SOAP标准不用，自己再实现一套数据标准。
反而XML成为一个黑盒，调用双方不得不依赖于接口文档，真是吃力不讨好。

因此好的WebService接口，应该从下面几个方面仔细考虑：

一. 参数
(1) 参数应该直接使用简单的数据类型（POCO、POJO），甚至时间类型都可以考虑用string，只要双方约束好时间字符串的格式。
(2) 如果参数个数超过3个，那就需要考虑设计一个Class了，避免参数列表过长，当然这没有硬性规定。
(3) 设计统一的参数规则。比如对外提供的查询接口就要考虑分页相关的数据。保证类似的接口都有统一的参数定义，形成习惯是提升效率最好方式。
      业务参数和非业务参数应该分开，比如分页的数据就可以抽象出基类。


二. 异常
(1) 使用框架中定义的Exception类型，比如：SoapException, FaultException(WCF)。
(2) 尽量避免将异常定义在返回值中，通过返回值定义错误那么无论服务端还是客户端都要写很多if ... else 分支。
(3) 系统异常和业务异常要区分好，比如使用 SoapException 可以用 Code 来区分，比如：System.Error 表示系统错误，Bussiness.Error 表示业务错误。
(4) 补充：.net framework  如果没有包装那么默认有两种 fautCode:  soap:Client 和 soap:Server。假设客户端传入BadRequest 基本就是 soap:Client 错误，其他 没有自定义code的则就是 soap:Server 的错误。

三. 安全
无论何时都要保证系统的安全性，我觉得安全也分系统安全和业务安全两种：
(1) 系统安全主要是指客户端的认证授权，调用次数(需要考虑会不会拖垮业务系统) 等
(2) 业务安全主要是指数据查询/操作权限，当然这个主要是从业务角度考虑的。


四. 日志
日志可以方便排查错误，还可以通过日志来分析服务基本信息（比如：调用次数，失败次数等），必要时还可以通过日志来进行重试。
另外要考虑开发的便捷，设计统一的日志拦截处理。

以 WebService Application (.NET 3.5) 为例，记录几种常用的编程技巧。
原始的 WebService 如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Services;
using WebService1.Entity;
using WebService1.Service;
using System.Web.Services.Protocols;

namespace WebService1
{
    [WebService(Namespace = "http://tempuri.org/")]
    [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
    [System.ComponentModel.ToolboxItem(false)]
    public class Service1 : System.Web.Services.WebService
    {
        [WebMethod]       
        public PageResult<Order> QueryOrder(Query<OrderCondition> queryInfo)
        {
            OrderService service = new OrderService();
            return service.Query(queryInfo);
        }
    }
}

PageResult<T>, Query<T>  将统一的业务部分抽取出来，这样定义其他的业务对象就能简化了。

using System;
using System.Collections.Generic;

namespace WebService1.Entity
{
    [Serializable]
    public class PageResult<T>
    {
        public int PageNo { get; set; }
        public int PageSize { get; set; }
        public int TotalCount { get; set; }
        public int PageCount { get; set; }
        public bool HasNextPage { get; set; }
        public List<T> Data { get; set; }
    }
}

using System;
using System.Collections.Generic;

namespace WebService1.Entity
{
    [Serializable]
    public class Query<T>
    {
        public int PageNo { get; set; }
        public int PageSize { get; set; }
        public T Condition { get; set; }
    }
}

跳过业务处理部分，来关注一下应用框架考虑的日志和安全拦截。可以利用 .NET framework 的 Soap Extensions ( msdn)  很容易地实现对 WebMethod 的 AOP。
Soap Extensions 可以通过两种方式“注入”： 自定义Atrribute 或者通过 Web.config 里的 soapExtensionTypes 进行声明。

TraceExtension 的实现： 
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.IO;
using System.Web.Services.Protocols;
using log4net;
using System.Xml;

namespace WebService1.Common
{
    public class TraceExtension : SoapExtension
    {
        private ILog logger = LogManager.GetLogger(typeof(TraceExtension));

        Stream oldStream;
        Stream newStream;
        
        public override System.IO.Stream ChainStream(System.IO.Stream stream)
        {
            oldStream = stream;
            newStream = new MemoryStream();
            return newStream;
        }

        public override void ProcessMessage(SoapMessage message)
        {
            switch (message.Stage)
            {
                case SoapMessageStage.BeforeDeserialize:
                    
                    log4net.ThreadContext.Properties["ip"] = HttpContext.Current.Request.UserHostAddress;
                    log4net.ThreadContext.Properties["action"] = message.Action;

                    WriteInput(message);
                    break;
                case SoapMessageStage.AfterDeserialize:
                    break;
                case SoapMessageStage.BeforeSerialize:
                    break;
                case SoapMessageStage.AfterSerialize:
                    WriteOutput(message);
                    break;
                default:
                    throw new Exception("Invalid Stage");
            }
        }

        public override object GetInitializer(Type serviceType)
        {
            return null;
        }

        public override object GetInitializer(LogicalMethodInfo methodInfo, SoapExtensionAttribute attr)
        {
            return null;
        }

        public override void Initialize(object initializer)
        {
            //filename = (string)initializer;
        }

        public void WriteOutput(SoapMessage message)
        {
            string soapString = (message is SoapServerMessage) ? "SoapResponse" : "SoapRequest";
            string content = GetContent(newStream);
            // 为了Format XML，如果从性能考虑应该去掉此处的处理
            if (!string.IsNullOrEmpty(content))
            {
                XmlDocument xmlDoc = new XmlDocument();
                xmlDoc.LoadXml(content);
                using (StringWriter sw = new StringWriter())
                {
                    using (XmlTextWriter xtw = new XmlTextWriter(sw))
                    {
                        xtw.Formatting = Formatting.Indented;
                        xmlDoc.WriteTo(xtw);
                        content = sw.ToString();
                    }
                }
            }

            logger.Info(soapString + ":\n" + content);

            Copy(newStream, oldStream);
        }

        public void WriteInput(SoapMessage message)
        {
            Copy(oldStream, newStream);

            string soapString = (message is SoapServerMessage) ? "SoapRequest" : "SoapResponse";
            string content = GetContent(newStream);
            logger.Info(soapString + ":\n" + content);
        }

        void Copy(Stream from, Stream to)
        {
            TextReader reader = new StreamReader(from);
            TextWriter writer = new StreamWriter(to);
            writer.WriteLine(reader.ReadToEnd());
            writer.Flush();
        }

        string GetContent(Stream stream)
        {
            stream.Position = 0;
            TextReader reader = new StreamReader(stream);
            string content = reader.ReadToEnd();
            stream.Position = 0;
            return content;
        }

    }

}
TraceAttribute 实现如下： 
using System;
using System.Web.Services.Protocols;

namespace WebService1.Common
{
    [AttributeUsage(AttributeTargets.Method)]
    public class TraceAttribute : SoapExtensionAttribute
    {
        private int priority = 0;
        public override Type ExtensionType
        {
            get { return typeof(TraceExtension); }
        }

        public override int Priority
        {
            get { return priority; }
            set { priority = value; }
        }
    }
}

其中 TraceExtension 利用 log4net 来记录调用 WebMethod 的Request 和 Response，还包括 ip 和 Action（Action其实对应的 WebMethod）
对应的 log4net 配置如下： 
	<log4net>
		<appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
			<param name="File" value="F:\Programming\VSProject2008\WebServiceSample\WebService1\WebService1\Logs\service.log"/>
                        <param name="DatePattern" value=".yyyy-MM-dd'.log'" />
			<param name="AppendToFile" value="true"/>
			<param name="MaxSizeRollBackups" value="10"/>
			<param name="MaximumFileSize" value="5MB"/>
			<param name="RollingStyle" value="Date"/>
			<param name="StaticLogFileName" value="false"/>
			<layout type="log4net.Layout.PatternLayout">
				<param name="ConversionPattern" value="%d [%t] %-5p [%property{ip}] [%property{action}] - %m%n"/>
			</layout>
		</appender>
		<root>
			<level value="DEBUG"/>
			<appender-ref ref="RollingFileAppender"/>
		</root>
	</log4net>

那么 WebMethod 只要加上 [Trace] 特性，就可以开启日志记录功能。 
        [WebMethod]
        [Trace]
        public PageResult<Order> QueryOrder(Query<OrderCondition> queryInfo)
        {
            OrderService service = new OrderService();
            return service.Query(queryInfo);
        }


输出日志如下：

2014-05-25 22:05:02,292 [8] INFO  [127.0.0.1] [http://tempuri.org/QueryOrder] - SoapRequest:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
   <soapenv:Body>
      <tem:QueryOrder>
         <!--Optional:-->
         <tem:queryInfo>
            <tem:PageNo>1</tem:PageNo>
            <tem:PageSize>1</tem:PageSize>
            <!--Optional:-->
            <tem:Condition>
               <!--Optional:-->
               <tem:StartTime>?</tem:StartTime>
               <!--Optional:-->
               <tem:EndTime>?</tem:EndTime>
               <!--Optional:-->
               <tem:ShopId>?</tem:ShopId>
               <!--Optional:-->
               <tem:ProductId>?</tem:ProductId>
            </tem:Condition>
         </tem:queryInfo>
      </tem:QueryOrder>
   </soapenv:Body>
</soapenv:Envelope>

2014-05-25 22:05:02,357 [8] INFO  [127.0.0.1] [http://tempuri.org/QueryOrder] - SoapResponse:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <QueryOrderResponse xmlns="http://tempuri.org/">
      <QueryOrderResult>
        <PageNo>1</PageNo>
        <PageSize>1</PageSize>
        <TotalCount>3</TotalCount>
        <PageCount>1</PageCount>
        <HasNextPage>false</HasNextPage>
        <Data>
          <Order>
            <Id>1</Id>
            <OrderDate>2014-05-25 22:05:02</OrderDate>
            <ShopId>SHOP001</ShopId>
            <ProductId>PRD001</ProductId>
            <Quantity>1</Quantity>
            <Price>59</Price>
          </Order>
          ...
        </Data>
      </QueryOrderResult>
    </QueryOrderResponse>
  </soap:Body>
</soap:Envelope>

接下来利用 SoapHeader 实现最基本的 Basic Authentication 校验，当然你不想每一个 WebMethod 去做相同的Check，同样我们实现一个 Soap Extension。

Authentication (SoapHeader) 的定义： 
using System;
using System.Web.Services.Protocols;

namespace WebService1.Common
{
    public class Authentication : SoapHeader
    {
        public string UserName { get; set; }
        public string Password { get; set; }
    }
}
AuthCheckExtension 的实现：在 SoapMessage AfterDeserialize 这个阶段，取出客户端传的 SoapHeader 验证 UserName 和 Password 在服务端是否存在。
如果不存在或者错误则抛出 no auth ! 的错误。 
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.IO;
using System.Web.Services.Protocols;
using WebService1.Config;

namespace WebService1.Common
{
    public class AuthCheckExtension : SoapExtension
    {
        public override void ProcessMessage(SoapMessage message)
        {
            if (message.Stage == SoapMessageStage.AfterDeserialize)
            {
                foreach (SoapHeader header in message.Headers)
                {
                    if (header is Authentication)
                    {
                        var authHeader = header as Authentication;
                        var isValidUser = true;
                        var users = AuthConfiguration.AuthSettings.Users;
                        if (users != null && users.Count > 0)
                        { 
                            isValidUser = users.Any(u => u.UserName == authHeader.UserName && u.Password == authHeader.Password);
                        }

                        if (!isValidUser)
                            throw new BizException("no auth !");
                    }
                }
            }
        }


        public override object GetInitializer(Type serviceType)
        {
            return null;
        }

        public override object GetInitializer(LogicalMethodInfo methodInfo, SoapExtensionAttribute attribute)
        {
            return null;
        }

        public override void Initialize(object initializer)
        {
            // 初始化 AuthSettings 
            AuthConfiguration.Config();
        }
    }

}
然后给 WebMethod 加上 [SoapHeader("Authentication"), AuthCheck] 就OK了。 
using System;
using System.Collections.Generic;
using System.Web;
using System.Web.Services;
using WebService1.Entity;
using WebService1.Service;
using System.Web.Services.Protocols;
using WebService1.Common;

namespace WebService1
{
    [WebService(Namespace = "http://tempuri.org/")]
    [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
    [System.ComponentModel.ToolboxItem(false)]
    public class Service1 : System.Web.Services.WebService
    {
        public Authentication Authentication { get; set; }

        [WebMethod]
        [Trace]
        [SoapHeader("Authentication"), AuthCheck]
        public PageResult<Order> QueryOrder(Query<OrderCondition> queryInfo)
        {
            OrderService service = new OrderService();
            return service.Query(queryInfo);
        }

    }
}

最后我们拿 SoapUI 来测试一下：





再来看看错误处理，如果故意输错 UserName：


顺便要赞一下 SoapUI，真是 WebService 调试的利器，还可以生成 .NET / Java 代码，推荐大家使用。我们用 SoapUI 生成一下 Java 代码。
Java 客户端我决定用 CXF 来实现。所以要先配置一下 SoapUI：



JAVA CXF Client 代码：

public static void main(String[] args) {
        try {

            Service1 service1 = new Service1();
            Service1Soap service1Soap = service1.getService1Soap();
            BindingProvider provider = (BindingProvider)service1Soap;

            List<Header> headers = new ArrayList<Header>();
            Authentication authentication = new Authentication();
            authentication.setUserName("fangxing");
            authentication.setPassword("123456");
            Header authHeader = new Header(ObjectFactory._Authentication_QNAME, authentication,
                    new JAXBDataBinding(Authentication.class));

            headers.add(authHeader);
            provider.getRequestContext().put(Header.HEADER_LIST, headers);

            QueryOfOrderCondition queryInfo = new QueryOfOrderCondition();
            queryInfo.setPageNo(1);
            queryInfo.setPageSize(1000);

            OrderCondition condition = new OrderCondition();
            condition.setShopId("SHOP001");
            condition.setStartTime("2014-05-01 00:00:00");
            condition.setEndTime("2014-05-10 23:59:59");

            queryInfo.setCondition(condition);

            PageResultOfOrder result = service1Soap.queryOrder(queryInfo);
            System.out.println("get order size: " + result.getData().getOrder().size());

        } catch (Exception e) {
            e.printStackTrace();
        }

    }

示例代码下载，下载请阅 Readme.txt


Webservice 的设计和模式
12-23 1023
这片文章是片译文（原文在devx，具体记不得了），对于想初步了解webservice的朋友可能有些帮助。其中有一些模式的应用，不过个人觉得太简单了，忘大家多想想，发表些意见。 Webservice 作为一项新的技术出现在我们面前，它的出世是用于解决在不同的平台下的应用的协同的。目前几乎每家厂商都要去开发Webservice 应用，然而如果缺乏对Webservice更深的了解，不能很好的在设计阶
WebService接口设计
12-23
给出一个实例，详细讲述web服务接口的设计
WebService知识点总结
wujiaolong的专栏
09-09 1155
1.什么是webservice？/什么叫webservice？/webservice的基本概念是什么 webservice 也叫xml web service ,webservice是一种可以接收从internet或者intranet上的其他系统中传递过来的数据，是一种轻量级的独立的通讯技术。它与平台和变成语言无关，它是一个软件接口，描述了一组可以在网络上通过标准化的xml消息传递访问的操作。
调用webservice总结
让我们的手指敲起锋利的代码勇敢前进！
05-14 1267
调用webservice总结：   1.加入第三方的jar包 Ksoap2-android-XXX    2.访问响应的webservice的网站，查看响应的信息，得到nameSpace，methodName，url，soapAction   3.如果request信息还有带有SoapHander的。那么就要封装：依据参数封装                 Element[] head
WebService设计总结 Sample代码
05-26
在本文中，我们将深入探讨WebService的设计，特别是基于C#的实现，并参考提供的"WebService1"样本代码。 1. **WebService基础**：WebService是一个自包含、自解释的软件模块，通过HTTP协议暴露其功能，允许远程系统...
jQuery中调用WebService方法小结
10-28
根据给定文件信息，我们可以得出以下知识点： ### jQuery中调用WebService方法的优点 1. **URL请求的简化**： ...此外，为了提高用户体验，开发者应尽量减少请求的数据量，并合理设计数据传输格式。
WebService
08-09
总结来说，WebService接口开发是构建分布式系统和实现系统间互操作的重要手段。XML、SOAP、WSDL和UDDI是其核心技术，它们共同构成了WebService的基础框架。随着技术的演进，我们还需要关注新的接口设计原则和协议，...
webService总结1
08-08
总结起来，WebService是软件系统间进行交互的重要手段，通过规范化的接口和协议，实现了不同平台和语言间的互操作性，促进了企业级应用的集成与扩展。在实际开发中，利用如CXF这样的框架，可以高效地构建和消费Web ...
WebService.zip
04-16
总结来说，"WebService.zip"中的内容涉及了WebService服务端的构建和客户端的调用，利用mongoose库搭建服务，通过Libcurl库实现客户端对服务的访问，这两者结合，为开发者提供了一套完整的WebService解决方案。...
WebService实力以及总结
05-01
通过亲身试用Web Service时的一些摸索，以及对遇到问题的分析进行总结。包含Web Service的使用实例以及说明文档。
webserver总结
12-01
SOAP 1.什么是SOAP? 一种基于 XML 的、用于在 Web 上交换结构化和类型信息的简单的轻量协议 SOAP是一个跨平台的标准，用来格式化在WebService和客户端应用程序间传递的消息 2.SOAP的消息结构 SOAP Evenlop SOAP Header SOAP Body SOAP Default
WebService总结
chenxiyuan程序员
12-11 178
服务器端的实现 WebService是一种跨编程语言和跨操作系统平台的远程调用技术。 作用： 1.可重复使用的应用程序组件 Web services 可以把应用程序组件作为服务来提供，比如汇率转换、天气预报或者甚至是语言翻译等等。 2.连接现有的软件 通过使用 Web services，您可以在不同的应用程序与平台之间来交换数据。   Web Services 拥有三种基本的元素。...
【分布计算环境学习笔记】9 Web Service
weixin_34358092的博客
01-04 135
作者：gnuhpc 出处：http://www.cnblogs.com/gnuhpc/ 1.概述： 在现有的各种异构平台的基础上，构筑一个通用的，与应用无关、语言无关的技术层，各种不同平台之上的应用依靠这个技术层来实施彼此的连接和集成，即：传统的的Web技术解决的问题是如何让人来使用Web应用所提供的服务，而Web Service则要解决如何让计算机系统来使用Web应用所提供的服务。从...
关于webService的一些概念理解
weixin_41768263的博客
05-30 355
反编译（自动关联源码）操作步骤：http://www.cnblogs.com/godtrue/p/5499785.html一、WebService、CXF、jax-ws、jax-rs、Restful之间关系 WebService：部署网络服务  tomcat（jetty）上放java代码 CXF：是目前最主流WebService开发框架jax-ws和jax-rs是CXF的两种服务方式jax-rs采...
评论 6
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值