美文网首页
Rest WebService

Rest WebService

作者: abapCiCi | 来源:发表于2020-10-30 11:00 被阅读0次

    Web Service有两种方式,一是SOAP方式,二是REST方式。SOAP是基于XML的交互,WSDL也是一个XML文档,可以使用WSDL作为SOAP的描述文件;REST是基于HTTP协议的交互,支持JSON、XML、ATOM、RSS等交互,不需要WSDL。
    使用SOAP封装的Web Service,通用性和安全性都高于Rest风格的Web Service,但效率较后者低。
    对于SOAP方式实现的Web Service,SAP可以通过企业服务功能直接创建Service Consumer来进行配置和调用;而对于Rest方式实现的Web Service则需要使用PI或者PO等SAP组件,网上也有通过一些配置,直接将Rest方式的Web Service配置成Service Consumer的那里,本文不做介绍。如果没有这些配置和PI的话,我们可以通过SAP的一个标准类CL_HTTP_CLIENT 来实现对Rest风格的Web Service的调用。

    1. 先调用CL_HTTP_CLIENT的CREATE_BY_URL方法,根据传入的URL生成一个IF_HTTP_CLIENT对象,然后根据这个对象不同方法来传递不同的参数,从而实现发送和接收数据的交互。

    2. 本例中的URL包含了三部分,rest的根链接以及一些Head参数和Body参数,可以通过根链接先创建IF_HTTP_CLIENT客户端对象,然后再设置Head和Body的传输参数,也可以将这些参数拼接成一个完整的URL字符串,直接创建IF_HTTP_CLIENT客户端对象,然后再通过该对象的SEND和RECEIVE方法进行数据交互。

    CALL METHOD CL_HTTP_CLIENT=>CREATE_BY_URL
        EXPORTING
            URL     = LV_URL
        IMPORTING
            CLIENT = LO_HTTP_CLIENT.
    

    这里的LV_URL就是用来生成IF_HTTP_CLIENT对象的URL;这里的LO_HTTP_CLIENT则表示生成的IF_HTTP_CLIENT对象。
    上一步生成的IF_HTTP_CLIENT对象的属性PROPERTYTYPE_LOGON_POPUP(显示登录框)。这个属性是一个I类型的变量,值可以为0,1,2,也可以引用这个对象的另外两个属性进行赋值,分别是:
    IF_HTTP_CLIENT->CO_DISABLED:值为0,表示不显示认证框;
    IF_HTTP_CLIENT->CO_ENABLED:值为1,表示显示认证框;
    IF_HTTP_CLIENT->CO_PROMPT:值为2,表示以弹出框形式显示认证框。
    设置的语法如下:
    LO_HTTP_CLIENT->PROPERTYTYPE_LOGON_POPUP = LO_HTTP_CLIENT->CO_DISABLED.

    设置认证信息

    当提供Web Service 的URL来自一个SAP系统,则可以使用IF_HTTP_CLIENT对象的一个方法叫做AUTHENTICATE,可以用来设置登录信息,调用方法如下:

    CALL METHOD LO_HTTP_CLIENT1->AUTHENTICATE
        EXPORTING
            PROXY_AUTHENTICATION = ''       "可选,是否使用代理
            CLIENT        = '200'     "可选,SAP客户端号
            USERNAME       = LV_USERNAME  "必输,用户名
            PASSWORD       = LV_PASSWORD  "必输,密码
            LANGUAGE       = SY-LANGU.   "可选,登录语言代码
    
    

    设置HEADER参数

    IF_HTTP_CLIENT对象有两个重要的属性,分别为:REQUEST和RESPONSE,这两个属性本身的类型又是类,也拥有自己的属性和方法。我们可以通过设置REQUEST的SET_HEADER_FIELD方法来传递一些Web Service的Head属性,比如Content-Type等。调用方法为:

    CALL METHOD LO_HTTP_CLIENT1->REQUEST->SET_HEADER_FIELD
        EXPORTING
            NAME  = 'Content-Type'
            VALUE = 'application/x-www-form-urlencoded'.
    
    

    设置BODY参数

    如果URL并没有传入全部链接,而是将Body部分的参数单独传入的话,则需要调用REQUEST的SET_CDATA方法,传入body中的数据。本例中rest_data的值就是一个json格式的数据。因此在传入所需要的数据之前,需要先通过SAP系统的中的JSON类来将数据转换成JSON类型的字符串(具体转换方法将在1.3节中详细讲述),并且有时候需要先调用REQUEST的SET_CONTENT_TYPE申明封装方式。

    CALL METHOD LO_HTTP_CLIENT1->REQUEST->SET_CONTENT_TYPE
           EXPORTING
             CONTENT_TYPE = 'application/x-www-form-urlencoded; charset=utf-8'.
    CALL METHOD LO_HTTP_CLIENT1->REQUEST->SET_CDATA
      EXPORTING
        DATA   = LV_BODY    
        OFFSET = 0
        LENGTH = LV_LEN.
    
    

    这里的LV_BODY就是上面REST_DATA中传递的数据转换成了JSON之后的字符串(不包括“rest_data=”),LV_LEN就是LV_BODY的字符串长度。

    调用发送和接收方法通讯

    当所有的传输的参数准备完毕后,就可以调用IF_HTTP_CLIENT对象的SEND和RECEIVE方法进行数据交互了。具体语法如下:

    CALL METHOD LO_HTTP_CLIENT->SEND
    *  EXPORTING
    *    TIMEOUT                    = 15   "超时时间:15秒
      EXCEPTIONS
        HTTP_COMMUNICATION_FAILURE = 1
        HTTP_INVALID_STATE         = 2.
    
    CALL METHOD LO_HTTP_CLIENT->RECEIVE
      EXCEPTIONS
        HTTP_COMMUNICATION_FAILURE = 1
        HTTP_INVALID_STATE         = 2
        HTTP_PROCESSING_FAILED     = 3.
    

    返回处理信息

    当调用完RECEIVE方法后,就可以通过调用IF_HTTP_CLIENT对象的RESPONSE属性来获取一些执行结果,其中几个比较常用的方法有:
    GET_STATUS:接收当前处理状态码,可根据该状态码判断接口调用成功与否,其中200表示成功;
    GET_CDATA:接收BODY的字符串;
    GET_DATA:接收BODY的二进制数据;
    GET_RAW_MESSAGE:接收返回的完整的二进制的HTML数据。
    具体调用示范如下:

    DATA: LV_HTTP_RETURN_MESSAGE      TYPE STRING,
      LV_HTTP_RETURN_MESSAGE_RAW TYPE XSTRING,
      LV_RESULT TYPE STRINIG.
    DATA: LV_HTTP_RETURN_CODE  TYPE I.
    
    LO_HTTP_CLIENT->RESPONSE->GET_STATUS( IMPORTING CODE   = LV_HTTP_RETURN_CODE ).
    LO_HTTP_CLIENT->RESPONSE->GET_STATUS( IMPORTING REASON = LV_HTTP_RETURN_MESSAGE ).
    LV_HTTP_RETURN_MESSAGE_RAW = LO_HTTP_CLIENT->RESPONSE->GET_RAW_MESSAGE( ).
    LV_RESULT = LO_HTTP_CLIENT->RESPONSE->GET_CDATA( ).
    

    关闭接口连接

    当已经获取到接口的调用结果后,为节省宽带资源,应该要关闭HTTP的链接,可以使用IF_HTTP_CLIENT对象的CLOSE方法,该方法没有传入传出参数,直接调用即可。示例代码如下:
    LO_HTTP_CLIENT->CLOSE( ). 或者 CALL METHOD LO_HTTP_CLIENT1->CLOSE.
    ABAP数据与JSON数据转换
    数据转换

    相关文章

      网友评论

          本文标题:Rest WebService

          本文链接:https://www.haomeiwen.com/subject/qdlkvktx.html