Python的Web编程[2] -> WebService技术[0] -> 利用 Python 调用 WebService 接口

WebService技术 / WebService Technology


 

1 关于webservice / Constants

WebService是一种跨编程语言和跨操作系统平台的远程调用技术。

WebService主要由以下三种技术构成,XML+XSDSOAPWSDL

XML+XSD:

WebService采用HTTP协议传输数据,采用XML格式封装数据(即XML中说明调用远程服务对象的哪个方法,传递的参数是什么,以及服务对象的返回结果是什么)。XML是WebService平台中表示数据的格式。除了易于建立和易于分析外,XML主要的优点在于它既是平台无关的,又是厂商无关的。无关性是比技术优越性更重要的:软件厂商是不会选择一个由竞争对手所发明的技术的。

XML解决了数据表示的问题,但它没有定义一套标准的数据类型,更没有说怎么去扩展这套数据类型。例如,整形数到底代表什么?16位,32位,64位?这些细节对实现互操作性很重要。XML Schema(XSD)就是专门解决这个问题的一套标准。它定义了一套标准的数据类型,并给出了一种语言来扩展这套数据类型。WebService平台就是用XSD来作为其数据类型系统的。当你用某种语言(如VB.NET或C#)来构造一个Web service时,为了符合WebService标准,所有你使用的数据类型都必须被转换为XSD类型。你用的工具可能已经自动帮你完成了这个转换,但你很可能会根据你的需要修改一下转换过程。

SOAP:

WebService通过HTTP协议发送请求和接收结果时,发送的请求内容和结果内容都采用XML格式封装,并增加了一些特定的HTTP消息头,以说明HTTP消息的内容格式,这些特定的HTTP消息头XML内容格式就是SOAP协议。SOAP提供了标准的RPC方法来调用Web Service。

SOAP协议 = HTTP协议 + XML数据格式

SOAP协议定义了SOAP消息的格式,SOAP协议是基于HTTP协议的,SOAP也是基于XML和XSD的,XML是SOAP的数据编码方式。打个比喻:HTTP就是普通公路,XML就是中间的绿色隔离带和两边的防护栏,SOAP就是普通公路经过加隔离带和防护栏改造过的高速公路。

WSDL:

好比我们去商店买东西,首先要知道商店里有什么东西可买,然后再来购买,商家的做法就是张贴广告海报。 WebService也一样,WebService客户端要调用一个WebService服务,首先要有知道这个服务的地址在哪,以及这个服务里有什么方法可以调用,所以,WebService务器端首先要通过一个WSDL文件来说明自己家里有啥服务可以对外调用,服务是什么(服务中有哪些方法,方法接受的参数是什么,返回值是什么),服务的网络地址用哪个url地址表示,服务通过什么方式来调用。

WSDL(Web Services Description Language)就是这样一个基于XML的语言,用于描述Web Service及其函数、参数和返回值。它是WebService客户端和服务器端都能理解的标准格式。因为是基于XML的,所以WSDL既是机器可阅读的,又是人可阅读的,这将是一个很大的好处。一些最新的开发工具既能根据你的Web service生成WSDL文档,又能导入WSDL文档,生成调用相应WebService的代理类代码。

WSDL文件保存在Web服务器上,通过一个url地址就可以访问到它。客户端要调用一个WebService服务之前,要知道该服务的WSDL文件的地址。WebService服务提供商可以通过两种方式来暴露它的WSDL文件地址:1.注册到UDDI服务器,以便被人查找; 2.直接告诉给客户端调用者。

 

2 suds模块 / suds Module

Python中可以利用suds模块实现对WebService的调用。

环境安装:

pip install suds-jurko  

使用方法:

(1)    建立初始数据,用户名/密码/url(url常为WSDL页面)等

(2)    实例化Client,print出实例化后的client可以查看WSDL上的函数及参数等

(3)    利用client.servic对WSDL定义的方法调用

示例代码:

下面的代码是一个简单的调用示例,可以通过 print 获得的实例来查看所有可调用的函数接口。

from suds.client import Client
class BarApixServiceException(Exception):
    pass
class BarApixWrongUser(Exception):
    pass
class BarApixIDNotFoundException(Exception):
    pass


class Service():
    def __init__(self, url, userid, password, barApix_id, timeout=0):
        self.client = None
        self.userid = userid
        self.password = password
        self.barApix_id = barApix_id

        try:
            if timeout == 0:
                self.client = Client(url=url)
            else:
                self.client = Client(url=url, timeout=timeout)
        except:
            raise BarApixServiceException
        # Show the function of service 
        # print(self.client)
        self.login()

    def login(self):
        try:
            response = self.client.service.WS_XStartup(self.userid, self.password)
            # print(response)
            if response['WS_XStartupResult'] == 0:
                raise BarApixWrongUser
            print('=== Login in success')
        except:
            raise BarApixServiceException

    def get_id_info(self):
        try:
            response = self.client.service.WS_XGetIdInfoBaso(self.userid, self.barApix_id)
            if response['WS_XGetIdInfoBasoResult'] == 0:
                raise BarApixIDNotFoundException
        except:
            raise BarApixServiceException
        return_response = {}
        for r in response:
            if isinstance(r[1], str):
                return_response[str(r[0])] = str(r[1].strip())
            else:
                # Handle None value
                return_response[str(r[0])] = r[1]
        print(return_response)
        return return_response

    def get_test_status(self):
        try:
            response = self.client.service.WS_XGetTestStatus(self.userid, self.barApix_id)
            if response['WS_XGetTestStatusResult'] == 0:
                raise BarApixIDNotFoundException
        except:
            raise BarApixServiceException
        return_response = response
        return return_response

info = {'service_1': {'userid': 'user1',
                      'password': 'password',
                      'barApix_id': ['Dxxxxx'],
                      'url': 'http://xxxxx/BarApix/BarApixService/?wsdl'
                      },
        'service_2': {'userid': 'user2',
                      'password': 'password',
                      'barApix_id': ['Cxxxxx'],
                      'url': 'http://xxxxxxx/BarApix/BarApixService/?wsdl'
                      },
        }

user = info['service_1']
service = Service(user['url'], user['userid'], user['password'], user['barApix_id'][0])
# More Function please check 'barApixFunc.txt'
service.get_id_info()
service.get_test_status()

 

参考链接 


http://blog.csdn.net/wooshn/article/details/8069087/

http://www.cnblogs.com/walkerwang/archive/2011/07/27/2118401.html

http://www.cnblogs.com/nottobe/p/5718823.html

http://www.cnblogs.com/Tommy-Yu/p/5567091.html

posted @ 2018-01-13 16:44  StackLike  阅读(568)  评论(0编辑  收藏  举报