ABAP 使用 web socket 向 TCP server 发送消息的 demo

ABAP WebSocket Demo 逐行解释

1. REPORT demo_apc_tcp_client.

定义一个 ABAP 程序，程序名为 demo_apc_tcp_client。REPORT 是 ABAP 中定义独立执行程序的关键字。

2. CLASS apc_handler DEFINITION FINAL .

定义一个名为 apc_handler 的类，该类是 FINAL 类，意味着不能被继承。

3. PUBLIC SECTION.

定义类的公共部分，所有外部调用都可以访问此部分的内容。

4. INTERFACES if_apc_wsp_event_handler.

实现接口 if_apc_wsp_event_handler，这个接口提供 WebSocket 事件的处理方法，例如连接打开、消息接收、连接关闭等事件。

5. DATA message TYPE string.

定义一个名为 message 的变量，类型为字符串，用于存储接收到的 WebSocket 消息或错误信息。

6. ENDCLASS.

结束类定义部分。

7. CLASS apc_handler IMPLEMENTATION.

开始类 apc_handler 的实现部分。

8. METHOD if_apc_wsp_event_handler~on_open.

定义接口方法 on_open，在 WebSocket 连接打开时被调用。当前这个方法没有具体实现，表示在连接打开时没有额外的操作。

9. ENDMETHOD.

结束 on_open 方法的实现。

10. METHOD if_apc_wsp_event_handler~on_message.

定义接口方法 on_message，在收到 WebSocket 消息时调用。这个方法用于处理接收到的消息。

11-15. TRY...CATCH...ENDTRY

通过 TRY...CATCH 块来捕获可能的异常。在 TRY 块中，调用 i_message->get_text() 获取传入的消息。如果发生错误（比如网络异常），则会进入 CATCH 块，捕获 cx_apc_error 异常，并将异常信息存储在 message 变量中。

16. ENDMETHOD.

结束 on_message 方法的实现。

17. METHOD if_apc_wsp_event_handler~on_close.

定义接口方法 on_close，在 WebSocket 连接关闭时调用。这里直接将关闭的消息存储到 message 变量中，值为 'Connection closed!'。

18. ENDMETHOD.

结束 on_close 方法的实现。

19. METHOD if_apc_wsp_event_handler~on_error.

定义接口方法 on_error，在 WebSocket 通信中发生错误时调用。当前这个方法没有具体实现。

20. ENDMETHOD.

结束 on_error 方法的实现。

21. ENDCLASS.

结束 apc_handler 类的实现部分。

22. CLASS apc_demo DEFINITION.

定义一个新的类 apc_demo，负责处理 WebSocket 通信的核心逻辑。

23. PUBLIC SECTION.

定义类的公共部分。

24. CLASS-METHODS main.

定义一个类方法 main，这是程序的主执行方法，包含核心的客户端连接、消息发送、接收等功能。

25. ENDCLASS.

结束类定义部分。

26. CLASS apc_demo IMPLEMENTATION.

开始类 apc_demo 的实现部分。

27. METHOD main.

开始定义 main 方法，这是程序的核心执行逻辑。

28. DATA(tcp_server) = C:\ncat\ncat.exe.

定义变量 tcp_server，并赋值为 NCAT 可执行文件的路径。NCAT 是一个用于网络通信的工具，在此用作 TCP 服务器。

29. DATA(ip_adress) = cl_gui_frontend_services=>get_ip_address( ).

定义变量 ip_adress，并调用 cl_gui_frontend_services=>get_ip_address() 方法获取本机的 IP 地址。

30. DATA(port) = 12345.

定义变量 port，并设置端口号为 12345。该端口用于客户端与服务器之间的通信。

31. DATA(terminator) = 0A.

定义变量 terminator，代表消息结束符，0A 是换行符的十六进制表示，通常用作消息的结束标志。

32. DATA(msg) = Hello TCP, answer me!.

定义变量 msg，存储要发送的消息，内容为 Hello TCP, answer me!。

33-39. cl_demo_input=>new(...)

创建一个用户输入界面，提示用户输入 TCP 服务器路径、IP 地址、端口号、终止符以及消息内容。这部分代码允许用户自定义这些参数。

40-42. IF cl_gui_frontend_services=>file_exist(...).

检查 TCP 服务器文件（NCAT）的存在性。如果该文件不存在，输出 TCP Server not found!，并退出程序。

43-46. cl_gui_frontend_services=>execute(...).

使用 execute 方法调用命令行工具 cmd.exe，并通过该工具启动 NCAT 服务器。命令行参数是 /c 后跟 tcp_server 的路径，-l 表示监听模式，后面跟 IP 地址和端口号。

47. WAIT UP TO 1 SECONDS.

让程序等待 1 秒，以便 TCP 服务器启动并准备好接受连接。

48-50. TRY...CATCH...ENDTRY

进入 TRY...CATCH 块，处理可能的异常。

51. DATA(event_handler) = NEW apc_handler( ).

创建一个新的 apc_handler 实例，用于处理 WebSocket 事件。

52-56. DATA(client) = cl_apc_tcp_client_manager=>create(...)

通过 cl_apc_tcp_client_manager=>create() 方法创建 TCP 客户端连接。设置目标主机为 ip_adress，端口为 port，并指定消息终止符为 terminator。event_handler 用于处理来自服务器的事件。

57. client->connect( ).

客户端尝试连接到服务器。

58-61. DATA(message_manager)...

从客户端获取消息管理器，并创建一个新的消息。通过 set_binary() 方法，将二进制形式的消息和终止符发送给服务器。

62-64. DATA(binary_msg)...

将消息与终止符连接在一起，并将其转换为二进制模式。

65. message_manager->send( message ).

将消息通过客户端的消息管理器发送给服务器。

66-68. WAIT FOR PUSH CHANNELS...

等待从服务器接收消息，最多等待 10 秒。如果在等待期间接收到消息，将其存储在 event_handler->message 中。

69-71. IF sy-subrc = 4...

检查 sy-subrc 的值，以确定通信结果。如果没有注册 APC 消息处理程序，输出相应的错误信息。

72-75. ELSEIF sy-subrc = 8...

检查是否发生超时，并输出 Timeout occured!。

76-80. ELSE...

如果收到服务器的响应，输出接收到的消息内容。

81. client->close( i_reason = 'Application closed connection!' ).

关闭客户端连接，关闭原因是 Application closed connection!。

82-84. CATCH cx_apc_error...

捕获通信中的任何异常，并将异常信息输出到控制台。

85. ENDTRY.

结束异常处理。

86. ENDMETHOD.

结束 main 方法的实现。

87. ENDCLASS.

结束 apc_demo 类的实现。

88. START-OF-SELECTION.

程序执行的起点，调用 apc_demo=>main() 方法，启动 WebSocket 客户端的主逻辑。

通过这段代码，程序启动一个 TCP 客户端并连接到指定的服务器，发送消息并等待响应，同时处理通信中的事件和错误情况。