SAP ABAP呼叫WEBAPI（一）

yangjulei發表於2019-06-01
WebAPI

開始先介紹下json和xml的定義，網上找的資訊，最後將用一個例項來講解sap abap如何實現呼叫webapi.

-------------------------------------------------------------------------------------------------------

JSON 定義

JSON(JavaScript Object Notation) 是一種輕量級的資料交換格式。簡單地說，JSON 將資料轉換為字串，在終端之間傳遞。

 

資料在名稱/值對中、資料由逗號分隔、花括號儲存物件、方括號儲存陣列

 

JSON 值可以是：數字（整數或浮點數）、字串（在雙引號中）、邏輯值（true 或 false）、陣列（在方括號中）、物件（在花括號中）、null

 

例如：

 

{

    "name":"小強",

    "age":16,

    "msg":["a","b"],

    "regex": "^http://.*"

};

 

JSON 與XML的區別比較

1.定義介紹

 

(1).XML定義

擴充套件標記語言 (Extensible Markup Language, XML) ，用於標記電子檔案使其具有結構性的標記語言，可以用來標記資料、定義資料型別，是一種允許使用者對自己的標記語言進行定義的源語言。 XML使用DTD(document type definition)文件型別定義來組織資料;格式統一，跨平臺和語言，早已成為業界公認的標準。

XML是標準通用標記語言 (SGML) 的子集，非常適合 Web 傳輸。XML 提供統一的方法來描述和交換獨立於應用程式或供應商的結構化資料。

 

(2).JSON定義

JSON(JavaScript Object Notation)一種輕量級的資料交換格式，具有良好的可讀和便於快速編寫的特性。可在不同平臺之間進行資料交換。JSON採用相容性很高的、完全獨立於語言文字格式，同時也具備類似於C語言的習慣(包括C, C++, C#, Java, JavaScript, Perl, Python等)體系的行為。這些特性使JSON成為理想的資料交換語言。

JSON基於JavaScript Programming Language , Standard ECMA-262 3rd Edition - December 1999 的一個子集。

 

2.XML和JSON優缺點

 

(1).XML的優缺點

<1>.XML的優點

　　A.格式統一，符合標準；

　　B.容易與其他系統進行遠端互動，資料共享比較方便。

<2>.XML的缺點

　　A.XML檔案龐大，檔案格式複雜，傳輸佔頻寬；

　　B.伺服器端和客戶端都需要花費大量程式碼來解析XML，導致伺服器端和客戶端程式碼變得異常複雜且不易維護；

　　C.客戶端不同瀏覽器之間解析XML的方式不一致，需要重複編寫很多程式碼；

　　D.伺服器端和客戶端解析花費較多的資源和時間。

 

(2).JSON的優缺點

<1>.JSON的優點：

　　A.資料格式比較簡單，易於讀寫，格式都是壓縮的，佔用頻寬小；

　　B.易於解析，客戶端JavaScript可以簡單的通過eval()進行JSON資料的讀取；

　　C.支援多種語言，包括ActionScript, C, C#, ColdFusion, Java, JavaScript, Perl, PHP, Python, Ruby等伺服器端語言，便於伺服器端的解析；

　　D.在PHP世界，已經有PHP-JSON和JSON-PHP出現了，偏於PHP序列化後的程式直接呼叫，PHP伺服器端的物件、陣列等能直接生成JSON格式，便於客戶端的訪問提取；

　　E.因為JSON格式能直接為伺服器端程式碼使用，大大簡化了伺服器端和客戶端的程式碼開發量，且完成任務不變，並且易於維護。

<2>.JSON的缺點

　　A.沒有XML格式這麼推廣的深入人心和喜用廣泛，沒有XML那麼通用性；

　　B.JSON格式目前在Web Service中推廣還屬於初級階段。

 

3.XML和JSON的優缺點對比

 

(1).可讀性方面。

JSON和XML的資料可讀性基本相同，JSON和XML的可讀性可謂不相上下，一邊是建議的語法，一邊是規範的標籤形式，XML可讀性較好些。

(2).可擴充套件性方面。

XML天生有很好的擴充套件性，JSON當然也有，沒有什麼是XML能擴充套件，JSON不能的。

(3).編碼難度方面。

XML有豐富的編碼工具，比如Dom4j、JDom等，JSON也有json.org提供的工具，但是JSON的編碼明顯比XML容易許多，即使不借助工具也能寫出JSON的程式碼，可是要寫好XML就不太容易了。

(4).解碼難度方面。

XML的解析得考慮子節點父節點，讓人頭昏眼花，而JSON的解析難度幾乎為0。這一點XML輸的真是沒話說。

(5).流行度方面。

XML已經被業界廣泛的使用，而JSON才剛剛開始，但是在Ajax這個特定的領域，未來的發展一定是XML讓位於JSON。到時Ajax應該變成Ajaj(Asynchronous Javascript and JSON)了。

(6).解析手段方面。

JSON和XML同樣擁有豐富的解析手段。

(7).資料體積方面。

JSON相對於XML來講，資料的體積小，傳遞的速度更快些。

(8).資料互動方面。

JSON與JavaScript的互動更加方便，更容易解析處理，更好的資料互動。

(9).資料描述方面。

JSON對資料的描述性比XML較差。

(10).傳輸速度方面。

JSON的速度要遠遠快於XML。

 

4.XML與JSON資料格式比較

 

(1).關於輕量級和重量級

輕量級和重量級是相對來說的，那麼XML相對於JSON的重量級體現在哪呢?應該體現在解析上，XML目前設計了兩種解析方式：DOM和 SAX。

<1>.DOM

DOM是把一個資料交換格式XML看成一個DOM物件，需要把XML檔案整個讀入記憶體，這一點上JSON和XML的原理是一樣的，但是XML要考慮父節點和子節點，這一點上JSON的解析難度要小很多，因為JSON構建於兩種結構：key/value，鍵值對的集合;值的有序集合，可理解為陣列；

<2>.SAX

SAX不需要整個讀入文件就可以對解析出的內容進行處理，是一種逐步解析的方法。程式也可以隨時終止解析。這樣，一個大的文件就可以逐步的、一點一點的展現出來，所以SAX適合於大規模的解析。這一點，JSON目前是做不到得。

所以，JSON和XML的輕/重量級的區別在於：

JSON只提供整體解析方案，而這種方法只在解析較少的資料時才能起到良好的效果；

XML提供了對大規模資料的逐步解析方案，這種方案很適合於對大量資料的處理。

 

(2).關於資料格式編碼及解析難度

<1>.在編碼方面。

雖然XML和JSON都有各自的編碼工具，但是JSON的編碼要比XML簡單，即使不借助工具，也可以寫出JSON程式碼，但要寫出好的XML程式碼就有點困難;與XML一樣，JSON也是基於文字的，且它們都使用Unicode編碼，且其與資料交換格式XML一樣具有可讀性。

主觀上來看，JSON更為清晰且冗餘更少些。JSON網站提供了對JSON語法的嚴格描述，只是描述較簡短。從總體來看，XML比較適合於標記文件，而JSON卻更適於進行資料交換處理。

<2>.在解析方面。

在普通的web應用領域，開發者經常為XML的解析傷腦筋，無論是伺服器端生成或處理XML，還是客戶端用 JavaScript 解析XML，都常常導致複雜的程式碼，極低的開發效率。

實際上，對於大多數Web應用來說，他們根本不需要複雜的XML來傳輸資料，XML宣稱的擴充套件性在此就很少具有優勢,許多Ajax應用甚至直接返回HTML片段來構建動態Web頁面。和返回XML並解析它相比，返回HTML片段大大降低了系統的複雜性，但同時缺少了一定的靈活性。同XML或 HTML片段相比，資料交換格式JSON 提供了更好的簡單性和靈活性。在Web Serivice應用中，至少就目前來說XML仍有不可動搖的地位。

 

(3).例項比較

XML和JSON都使用結構化方法來標記資料，下面來做一個簡單的比較。

<1>.用XML表示中國部分省市資料如下：

 

複製程式碼

<?xml version="1.0" encoding="utf-8" ?>

<country>

  <name>中國</name>

  <province>

    <name>黑龍江</name>

    <citys>

      <city>哈爾濱</city>

      <city>大慶</city>

    </citys>  　　

  </province>

  <province>

    <name>廣東</name>

    <citys>

      <city>廣州</city>

      <city>深圳</city>

      <city>珠海</city>

    </citys> 　　

  </province>

  <province>

    <name>臺灣</name>

    <citys>

      　<city>臺北</city>

      　<city>高雄</city>

    </citys>　

  </province>

  <province>

    <name>新疆</name>

    <citys>

      <city>烏魯木齊</city>

    </citys>

  </province>

</country>

複製程式碼

<2>.用JSON表示中國部分省市資料如下：

 

複製程式碼

 var country =

        {

            name: "中國",

            provinces: [

            { name: "黑龍江", citys: { city: ["哈爾濱", "大慶"]} },

            { name: "廣東", citys: { city: ["廣州", "深圳", "珠海"]} },

            { name: "臺灣", citys: { city: ["臺北", "高雄"]} },

            { name: "新疆", citys: { city: ["烏魯木齊"]} }

            ]

        }

複製程式碼

編碼的可讀性來說，XML有明顯的優勢，畢竟人類的語言更貼近這樣的說明結構。JSON讀起來更像一個資料塊，讀起來就比較費解了。不過，我們讀起來費解的語言，恰恰是適合機器閱讀，所以通過JSON的索引country.provinces[0].name就能夠讀取“黑龍江”這個值。

編碼的手寫難度來說，XML還是舒服一些，好讀當然就好寫。不過寫出來的字元JSON就明顯少很多。去掉空白製表以及換行的話，JSON就是密密麻麻的有用資料，而XML卻包含很多重複的標記字元。

以上內容轉載於 https://www.cnblogs.com/SanMaoSpace/p/3139186.html

 

--------------------------------------------------------------------------------------------------

實際案例:

ABAP、WEBAPI、JSON的應用

 

業務背景：

呼叫webapi，輸入員工號，返回員工資訊。

 

程式碼實現：

1、編寫webapi呼叫子程式 


*&---------------------------------------------------------------------*


*&      Form  frm_call_webapi


*&---------------------------------------------------------------------*


*       呼叫webapi


*----------------------------------------------------------------------*


*  -->  iv_json_input        輸入json字串


*  -->  iv_service_ur        服務地址（http://****）


*  <--  ev_json_output       輸出json字串


*----------------------------------------------------------------------*


FORM frm_call_webapi USING iv_json_input iv_service_url CHANGING ev_json_output.


  DATA: lo_http_client TYPE REF TO if_http_client,


        gv_json_out    TYPE string,


        lv_url         TYPE string,


        lv_len         TYPE i.




  lv_url = iv_service_url.




  "建立客戶端請求


  CALL METHOD cl_http_client=>create_by_url


    EXPORTING


      url                = lv_url


    IMPORTING


      client             = lo_http_client


    EXCEPTIONS


      argument_not_found = 1


      plugin_not_active  = 2


      internal_error     = 3


      OTHERS             = 4.


  IF sy-subrc <> 0.


    "lv_subrc = sy-subrc.


    MESSAGE ID sy-msgid TYPE sy-msgty NUMBER sy-msgno WITH


               sy-msgv1 sy-msgv2 sy-msgv3 sy-msgv4.


    EXIT.


  ENDIF.




  "設定傳輸請求內容格式以及編碼格式


  lo_http_client->request->set_content_type( content_type = 'application/json; charset=utf-8' ).




  "設定呼叫服務


  lo_http_client->request->set_method( if_http_request=>co_request_method_post ).




  "設定待傳輸內容長度


  lv_len = STRLEN( iv_json_input ).




  "設定呼叫方法


  CALL METHOD lo_http_client->request->set_header_field


    EXPORTING


      name  = '~request_method'


      value = 'POST'.


  "設定傳入字串


  CALL METHOD lo_http_client->request->set_cdata


    EXPORTING


      data   = iv_json_input


      offset = 0


      length = lv_len.


  "傳送資料


  lo_http_client->send(


    EXCEPTIONS


      http_communication_failure = 1


      http_invalid_state         = 2 ).


  "接收返回


  lo_http_client->receive(


    EXCEPTIONS


      http_communication_failure = 1


      http_invalid_state         = 2


      http_processing_failed     = 3 ).


  "提取返回字串


  ev_json_output = lo_http_client->response->get_cdata( ).


  "將字串中的回車符替換，否則abap將會識別為#


  REPLACE ALL OCCURRENCES OF REGEX '\n' IN ev_json_output WITH space.




ENDFORM.                    "frm_call_webapi

2、呼叫子例程，傳入引數 


REPORT yaiolos_test_05.




INCLUDE zbc_webapi_incl.




DATA : gv_service_url TYPE string VALUE 'http://10.100.0.232:8081/api_sapnew/ZRFM_HR_OA_GCQD_KH_MAINTAIN',


       gv_json_in     TYPE string VALUE '{"IT_INPUT":[{"CUSTOMER":"12345678","PERNR":"00190935"}]}',


       gv_json_out    TYPE string.




START-OF-SELECTION.


  "呼叫webapi


  PERFORM frm_call_webapi USING gv_json_in gv_service_url CHANGING gv_json_out.




END-OF-SELECTION.


  WRITE gv_json_out.

yaiolos_test_05.txt

frm_call_webapi.txt

程式碼中有html標籤<br>不便於copy使用，請參見上述附件。

3、結果確認

 

 

注意事項：

abap中經常會將特殊字元識別為#，需要特別處理。

1、正規表示式解釋及特殊字元如何對應正規表示式，請見以下連結

https://baike.baidu.com/item/%E6%AD%A3%E5%88%99%E8%A1%A8%E8%BE%BE%E5%BC%8F/1700215?fr=aladdin

 

2、debug時遇見#字元而不知其實際內容時，檢視十六進位制值，如0A00等。十六進位制和ASCII的對照關係，見以下連結

https://blog.csdn.net/wangzhyy/article/details/78720514

 


來自 “ ITPUB部落格 ” ，連結：http://blog.itpub.net/7714329/viewspace-2646444/，如需轉載，請註明出處，否則將追究法律責任。

相關文章