做足球直播网站,企业信息系统开发,网络营销专业介绍,美食网站网页设计论文基于 AXIS2/C 的 C 语言库实现对提供 REST API 的系统进行数据访问宋 东平 和 赵 健2013 年 3 月 07 日发布AXIS2/C 简介和 REST 及 REST API 相关内容的简介AXIS2/C 简介Axis2/c 是基于 C 语言实现的 Web Service 引擎#xff0c;基于 Axis2 架构#xff0c;用于提供 Web 服…基于 AXIS2/C 的 C 语言库实现对提供 REST API 的系统进行数据访问宋 东平 和 赵 健2013 年 3 月 07 日发布AXIS2/C 简介和 REST 及 REST API 相关内容的简介AXIS2/C 简介Axis2/c 是基于 C 语言实现的 Web Service 引擎基于 Axis2 架构用于提供 Web 服务并具有良好的可移植性可以作为其他软件的一部分提供 Web 服务。Axis2/c 支持 SOAP1.1 及 SOAP1.2 协议并且支持 RESTful 风格的 Web 服务。基于 Axis2/c 开发的 Web 服务可以同时暴露为 SOAP 和 RESTful 风格的服务。用户可以基于 Axis2/c开发 Web 服务以供其他客户端进行调用亦可通过调用 Axis2/c 提供的 C 语言库开发客户端程序去访问其他的 Web 服务。REST 及 REST API 简介REST(REpresentational State Transfer表述性状态转移)指一组架构约束条件和原则是当下 Web Service 领域流行的一种软件架构风格。REST 强调从资源的角度观察整个网络基于 REST 的架构是一种面向资源的架构(Resource-Oriented ArchitectureROA)。资源通常由唯一的 URI(Uniform Resource Identifier统一资源标识符)来标识例如http://10.11.12.13:8080/rest/resources/Server。客户端的程序通过访问 URI 来获取资源的表述。REST 通常使用 HTTPURIXML 以及 HTML 这些现有的广泛流行的协议和标准。基于 REST 的 Web 服务以其架构简单、可扩展、安全有效通过 HTTP 直接传播数据等特性成为 Web 服务领域一个越来越流行的架构形式。REST API 是一个系统提供给外部系统的数据访问服务接口。基于 REST API 的服务以资源的形式存在 客户端通过对资源的操作实现相应的功能。在 RESTful 的 Web 服务中对资源的操作通过 HTTP 的四个标准方法实现且所有的业务需求均可映射成对资源的操作。例如获取资源的表述用 GET 方法修改资源用 PUT 方法添加一个资源用 POST 方法 或者 用 PUT 方法(POST 表示创建子资源PUT 在目标资源不存在时创建资源本身)删除资源用 DELETE 方法等。支持 HEAD 操作但它只返回报头不返回表述用于得到资源的元数据时使用。HTTP 通信过程中身份认证 Authentication 的分析在 HTTP 通信过程中认证是一种用来允许 Web 浏览器或者其他客户端程序在请求时提供以用户名及密码形式的凭证。HTTP 认证基于质询 / 回应 (challenge/response) 的认证模式并主要支持两种认证方式基本认证 (basic authentication) 以及摘要认证 (digest authentication)下面主要分析基本认证的步骤。通常情况下客户端第一次请求 URI 服务时不知晓是否需要验证因此会发送不带认证信息的 HTTP 请求服务端由于找不到认证信息认证失败向客户端发送一个 HTTP 响应状态码为 401(Unauthorized)并包含 WWW-Authenticate 消息头客户端收到 HTTP 响应后重新发送 HTTP 请求并在请求头中添加 Authorization 消息头格式为 Authorization:credentials其中 credentials 是认证信息具体认证信息根据不同的认证方案而不同当服务器对认证信息进行判断通过后即响应客户端请求如下显示了基本认证的步骤客户端访问一个受 HTTP 基本认证保护的资源。服务器返回 401 状态要求客户端提供用户名和密码进行认证。401 UnauthorizedWWW-AuthenticateBasic realmSecret World客户端将输入的用户名密码用 Base64 进行编码后采用非加密的明文方式传送给服务器Authorization:Basic xxxxxx(其中 xxxxxx 为 username:password 通过 Base64 编码的字符串)例如Authorization:Basic dXNlcm5hbWU6cGFzc3dvcmQ如果认证成功则返回相应的资源。如果认证失败则仍返回 401 状态要求重新进行认证。AXIS2/C 环境搭建AXIS2/C 环境搭建(Linux 环境)这里我们以 Red Hat 5.7 环境为例介绍一下如何搭建 Axis2/c 的运行环境。首先需要下载 Axis2c 的安装包下载地址可见参考资料。这里我们以最新的版本 1.6 为例。创建安装目录 axis2c解压缩 Axis2/c 的安装包 axis2c-src-1.6.0.tar.gz 到文件夹 axis2c-src-1.6.0 下如下图所示图 1. 解压缩 AXIS2/C 安装包解压之后编译源码进行安装。参数 prefix 用来指定安装目录enable-openssl 用来指定是否需要访问具有 SSL 的 REST API 系统。如下图所示图 2. 编译并安装Axis2/c 的安装包当中提供了很多用例用例当中使用到了某些环境变量所以这里我们需要设定两个环境变量export AXIS2C_HOME/zhaojian/axis2c // 指定 Axis2c 的安装目录export LD_LIBRARY_PATH$LD_LIBRARY_PATH:${AXIS2C_HOME}/lib/ // 指定 Axis2c 的 library 目录用例代码也需要进行编译安装。如下图所示图 3. 编译用例代码至此基本的 Axis2/c 开发运行环境已经搭建完成接下来运行示例代码并测试运行环境是否可以正常运行。用例代码是运行在 Axis2/c Server 之上的所以必须先启动 Axis2/c Server先看一下启动命令的帮助信息如下图所示图 4. 启动命令的帮助信息启动方法如下图所示图 5. 启动 AXIS2/C Server 成功如果输入服务器启动命令”./axis2_http_server”之后命令行一直处于 hang on 的状态表明 Server 已经启动成功用例代码可以运行了如果命令行中断退出如下图所示表明启动失败可以通过日志文件 axis2.log 找出失败原因。本实例中导致失败的原因是 Axis2/c Server 服务器的默认端口 9090 被其它应用程序占用导致启动失败。图 6. 启动 AXIS2/C Server 失败我们可以通过使用启动命令参数 -p 来修改端口号如下图所示图 7. 修改端口Axis2c Server 启动之后就可以运行用例代码了图 8. 运行用例代码这里要指出的是因为启动 Server 时如果修改了默认端口 9090 为其它端口比如 8080 时当运行用例比如上图中的 echo 命令时也需要修改用例当中的端口为已修改的端口号 8080(可以通过命令 echo 的参数来修改也可以修改用例源代码不过需要重新编译安装)。AXIS2/C 的参数配置为了能够通过 Axis2/c 提供的 C 语言库函数来访问具有 REST API 接口的系统数据我们必须对 Axis2/c 的环境做一些参数配置才能够让我们的 Sample Code 顺利运行。在 Axis2/c 中所有 Axis2/c 启动需要的配置都包括在配置文件 axis2.xml 当中。下面我们来看看都有哪些参数可以修改来满足我们的示例代码。首先如果用户需要访问或编写 RESTful 风格的 Web Service都需要将参数“enableREST”更改为“true”默认值已经设为“true”如下图所示图 9. 启用 REST 功能默认情况下Axis2/c 使用 HTTP 协议进行服务访问对于提供了安全层的服务访问这里需要启用 HTTPS 协议的配置首先确认安装部署了 Axis2/c 服务的机器上是否安装 openssl 以便我们进行 HTTPS 的数据访问确认方法如下图所示确保 openssl 包已安装即可图 10. 为 Axis2/c 添加 SSL 支持在 axis2.xml 当中启用如下几个参数图 11. 启用 HTTPS 参数另外在访问具有 HTTPS 的服务时服务端需要验证客户端的证书所以我们还需要提供访问证书的路径信息比如图 12. 证书路径查看服务端的证书的代码的命令是 openssl s_client – connect :. 请看如下图示例所示图 13. 查看服务端证书可以通过下面这三条命令在默认目录下生成本地证书 ( 可参考下图所示 )echo |\openssl s_client -connect : 21 |\sed -ne /-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p cert.pem其中 和 是所要访问的提供 REST API 系统的 IP 地址和端口。图 14. 制作本地证书在 HTTP 通信过程中部分 Web 服务需要验证访问该服务的用户身份可以通过修改 axis2.xml 中的参数实现也可以通过在代码中增加相应语句实现(后续章节会具体讲解)需要修改参数如下图 15. 添加 Authentication 信息做完以上这些参数配置之后如果一开始编译源码时就添加了参数 enable-openssl 并且值为 yes我们这里就不需要重新编译源码了只需要重新启动 Axis2 Server 就可以了否则需要重新编译并且添加参数 enable-openssl 为 yes 值。标准 REST API 方法的访问REST API 访问过程解析对于提供了 REST API 服务的系统进行数据请求调用是基于 HTTP 协议进行通信的并且使用了标准的 HTTP 方法 GETPOSTPUTDELETE 等。本节通过实例代码详细介绍如何通过 Axis2/c 提供的库函数使用 C 语言代码完成 REST 请求消息的创建访问 REST API 服务的标准方法实现以及对于响应消息的接收等内容。在接下来的实例清单和 Sample Code 当中我们都以 IBM Systems Director 产品提供的 REST API 服务为例所涉及到的 URI 信息也会以该服务提供的内容为例。该产品提供的 RES API 详情可见参考资料。创建一个完整的请求消息包括三个部分请求行、消息头以及请求体。请求行可以通过两种方法实现。第一种是通过符合要求的请求行字符串调用 axis2_http_request_line.h 中 axis2_http_request_line_parse_line 方法生成请求行如清单 1 所示清单 1. 请求行创建方式一axis2_http_request_line_t *request_line NULL;const char *request_line_str GET /ibm/director/rest/resources HTTP/1.1\r\n;request_line axis2_http_request_line_parse_line(env, request_line_str);第二种是调用 axis2_http_request_line.h 中 axis2_http_request_line_create 方法通过传递必要参数创建请求行如清单 2 所示清单 2. 请求行创建方式二axis2_http_request_line_t *request_line NULL;request_line axis2_http_request_line_create(env, GET, /ibm/director/rest/resources, HTTP/1.1);消息头的创建可以通过调用 axis2_http_header.h 中的 axis2_http_header_create 方法进行创建具体实例如清单 3 所示清单 3. 消息头的创建axis2_http_simple_request_t *request NULL;axutil_url_t *url NULL;axis2_http_header_t *header NULL;request axis2_http_simple_request_create(env,request_line,NULL,0 ,request_body);url axutil_url_create(env, https, 10.11.12.13,8422,/ibm/director/rest/resources);header axis2_http_header_create(env, Host, axutil_url_get_host(url, env));axis2_http_simple_request_add_header(request, env, header);在调用 REST API 过程中部分通信需要验证请求客户端的身份。客户端可以通过在请求消息的消息头中添加属性 Authentication向服务端传送身份认证信息。本例实现的认证为 HTTP 的基本认证Authentication 属性值的形式为 Basic xxxxxx 形式xxxxxx 代表 username:password 通过 base64 编码后的字符串形如Authorization:Basic dXNlcm5hbWU6cGFzc3dvcmQ可以通过调用 axutil_base64.h 中的 axutil_base64_encode 完成对字符串的编码请参阅清单 4 所示清单 4. Base64 编码实现及 Authentication 属性添加/***** 对 username:password 字符串进行编码 *********/int str_size 0;int encoded_len 0;axis2_char_t *str_src username:password;//“用户名 : 密码”字符串axis2_char_t *encoded_str NULL;// 对“用户名 : 密码”字符串进行 base64 编码后字符串axis2_char_t *firstStr Basic;//Authentication 值的头部分str_size strlen(str_src);encoded_len axutil_base64_encode_len(str_size);encoded_str AXIS2_MALLOC(env-allocator, encoded_len 2);encoded_len axutil_base64_encode(encoded_str,str_src,str_size);/*****Authentication 值的合成 *********/int size 0;int firstStrSize strlen(firstStr);int encoded_strSize strlen(encoded_str);size firstStrSize encoded_strSize;if(firstStrSize encoded_strSize){size ((int)strlen(firstStr)) * 2;}else{size ((int)strlen(encoded_str)) * 2;}char *str_return (char *) malloc((size 2) * sizeof(char));strcpy(str_return, firstStr);strcat(str_return, );strcat(str_return, encoded_str);/***** 在消息头中添加属性 Authentication*********/header axis2_http_header_create(env, Authorization, str_return);axis2_http_simple_request_add_header(request, env, header);在调用 REST API 过程中如果使用 POST 或 PUT 方法需要向服务端传递相应信息这些信息可以添加至请求消息中的消息体中。本例中创建的消息体是基于 JSON 格式的创建消息体的方式有两种第一种方式是按照标准的 JSON 格式直接书写字符串具体实例参照清单 5 所示示例 JSON 格式消息体为{IPAddress:[192.168.1.1]}。清单 5. 消息体创建方式一char *body_request NULL;int body_request_len 0;body_request {\IPAddress\:[\192.168.1.1\]};body_request_len strlen(body_request);第二种方式是通过调用 cJSON.h 中的方法生成消息体具体实例参照清单 6 所示示例 JSON 格式消息体为{entry,{name:Andrew,phone:555 123 456}}。清单 6. 消息体创建方式二char *body_request NULL;int body_request_len 0;cJSON *root;cJSON *value;cJSON *entry;rootcJSON_CreateObject();// 定义根节点entry cJSON_CreateObject();cJSON_AddItemToObject(root,entry,entry);// 创建 JSON 数据name 为 entry value 储存在 entry 中value cJSON_CreateString(Andew);// 将字符串创建为 cJSON 数据cJSON_AddItemToObject(entry,name,value);value cJSON_CreateString(555 123 456);cJSON_AddItemToObject(entry,phone,value);body_request cJSON_Print(root);// 将 JSON 数据转化为字符串body_request_len strlen(body_request);最后通过调用 axutil_stream.h 中的 axutil_stream_write 方法将需要添加的消息体字符串写入消息体中如清单 7 所示。清单 7. 将字符串写入消息体axutil_stream_t *request_body NULL;axutil_stream_write(request_body,env,body_request,body_request_len);// 写入消息体清单 8 详细写出了一个完整的请求发送响应接收过程中方法的调用涉及到的方法均包含在文件 axis2_http_client.h 中。清单 8. REST API 服务的请求与响应过程axis2_http_simple_request_t *request NULL;request axis2_http_simple_request_create(env, request_line,NULL,0 , request_body);int status 0;axis2_http_client_set_server_cert(client, env, /home/cert.pem);// 对于 https需要添加服务器端的证书即之前制作的证书 cert.pemaxis2_http_client_send(client, env, request, NULL);axis2_http_simple_response_t *response NULL;char *body_bytes NULL;int body_bytes_len 0;response axis2_http_client_get_response(client, env);body_bytes_len axis2_http_simple_response_get_body_bytes(response, env, body_bytes);// 其中 body_bytes 即为返回响应的结果字符串四种方法对 REST API 的访问实例对于 REST API 服务客户端主要通过标准方法对资源进行访问及处理标准方法主要包括四种GET、PUT、POST 以及 DELETE。下面将分别介绍这四种方法的使用。GET 操作会列出该服务所提供的相关数据信息实现 GET 操作的完整示例可以下载我们的 Sample Code参考文件 rest_sample.c 当中的 test_rest_get 方法。运行该方法后可以得到类似于如下图所示的运行结果图 16. GET 操作运行结果POST 操作可以通过消息体中含有的信息执行资源的创建。实现 POST 操作完整示例可以下载我们的 Sample Code参考文件 rest_sample.c 当中的 test_rest_post 方法。运行该方法后可以得到类似于如下图所示的运行结果图 17. POST 操作运行结果PUT 操作主要用于对资源进行修改需要修改的内容包含在 requestBody 中。实现 PUT 操作完整示例可以下载我们的 Sample Code参考文件 rest_sample.c 当中的 test_rest_put 方法。运行该方法后可以得到类似于如下图所示的运行结果图 18. PUT 操作运行结果DELETE 操作主要用于对资源进行删除。实现 DELETE 操作完整示例可以下载我们的 Sample Code参考文件 rest_sample.c 当中的 test_rest_delete 方法。运行该方法后可以得到类似于如下图所示的运行结果图表 19 DELETE 操作运行结果Figure xxx. Requires a heading另外附上清单 9常用状态码列表清楚的列出了各个返回码的含义方便读者查阅清单 9. 常用状态码列表200 表示服务器成功执行了客户端的 HTTP/HTTPS 请求201 表示服务器按客户端的请求成功创建了一个新资源202 表示服务器成功接收客户端请求并进行处理204 表示服务器已经成功处理了客户端请求但是没有可返回的内容303表示服务器将客户端的请求重定向到另一个 URI要完成请求必须进行进一步操作304 表示请求资源不能被更改400 表示客户端的请求参数不合法或没有表达足够的信息401 表示因为安全的原因导致对资源的操作没有完成404 表示客户端请求的资源不存在即 URI 无效405 表示请求的资源不支持该操作409 表示 URI 指定的资源发生冲突500 表示服务器端发生非预期情况导致请求没有完成503 表示处理请求的服务目前不可用C 语言对于 JSON 格式数据的处理JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式采用完全独立于语言的文本格式易于人的阅读和编写也易于机器的解析和生成这些特性使 JSON 成为理想的数据交换语言。在我们的 Sample Code 当中使用基于 Axis2/c 的 C 语言库来访问 REST API 时通过 GET 方法获取到的数据就是 JSON 格式的数据。由于 Axis2/c 的库函数中目前还没有对 JSON 格式数据处理的方法所以下面我们将简要介绍如何使用开源工具 cJSON 来完成对 JSON 格式数据的处理。下面一个例子介绍了使用方法 cJSON_Parse 来解析 JSON 数据字符串并转成数据对象 cJSON通过 cJSON_GetObjectItem 方法得到你想要的数据项。请看清单 10 所示清单 10. 将 JSON 字符串转换为数据对象 cJSONchar *document {\entry\:{\name\:\Andew\,\phone\:\555 123 456\}};char *result NULL;cJSON *root;cJSON *label;root cJSON_Parse(document);// 将字符型数据转换为 cJSON 型label cJSON_GetObjectItem(root,entry);// 通过已知的名称得到对应值result cJSON_Print(label);// 将 cJSON 数据转换成 char 型printf(the result is %s\n,result); // 打印输出结果使用 cJSON_Print 方法把 cJSON 数据对象 label 转换为字符串结果如下图所示图 . 20 JSON 字符串转化当然你也可以使用 cJSON.h 当中的方法来创建 JSON 格式的数据字符串。首先使用方法 cJSON_CreateObject 来创建根节点然后使用 cJSON_AddItemToObject 添加你想创建的数据项。下面一个例子就是如何生成 JSON 字符串 {entry :{name:Andrew,phone:555 123 456} }。请看清单 11 所示清单 11. 使用 cJSON 当中的方法创建 JSON 数据cJSON *root cJSON_CreateObject();// 定义根节点cJSON *entry cJSON_CreateObject();// 定义 entry 节点cJSON *value cJSON_CreateString(Andew);// 将字符串创建为 cJSON 数据cJSON_AddItemToObject(root, entry,entry);// 创建 JSON 数据name 为 entry value 储存在 entry 中cJSON_AddItemToObject(entry,name, value);value cJSON_CreateString(555 123 456);cJSON_AddItemToObject(entry, phone, value);char *result cJSON_Print(root);// 将 JSON 数据转化为字符串printf(the result is :%s\n,result); // 打印输出结果使用 cJSON_Print 方法把 cJSON 数据对象 root 转换为字符串并打印出来结果如下图所示图 21. JSON 数据创建在 Sample Code 当中我们列出来一段完整的代码包括使用cJSON和实例代码的编译Sample Code 当中使用了开源工具 cJSON为了能够运行 Sample Code必须对 Sample Code 和 cJSON 的源码进行编译。编译过程中会出现错误主要由于以下两个原因1)cJSON 代码中使用了 math.h 当中的函数所导致的可以通过修改 Makefile 当中的” CC gcc”为” CC gcc -lm”即可2)cJSON 代码中的注释格式使用不当所导致可以通过修改 cJSON.c 文件将” // “格式的注释改为”/* */”即可。Axis2/c 的 C 语言库函数来访问具有 REST API 系统获取数据并使用 cJSON.h 当中的方法来处理返回的结果等 ( 可参考方法 test_rest_get 当中处理返回结果的代码 )。详细内容请参考我们的 Sample Code这里就不再一一叙述了。结束语REST API 提供非常简洁的数据访问接口通过本文上述的示例我们能够使用 Axis2/c 的 C 语言库方便的访问提供了 REST API 的系统。这也是方便了我们对一些 C 语言系统需要访问 REST API 接口的支持。下载资源样例代码 (sample.zip | 4KB)相关主题Apache Axis2/c开源软件 Apache Axis2/C 官网首页。Axis2/c 环境搭建(Windows 环境)搭建 Windows 系统下 Axis2/c 开发环境。Axis2/c 软件包Axis2/c 软件包下载地址本例使用的软件包为 axsi2c-src-1.6.0.tar.gz。Axis2/c 附加功能配置在 Axis2/c 基本功能基础上提供了很多额外的功能根据不同的需要请参阅安装手册。OpenSSL 安装详解详细介绍 OpenSSL 的安装与配置过程。RESTWeb 服务REST-ful 服务详细介绍 REST 架构原理以及 RESTful 风格的 Web Service。HTTP 状态码详细介绍了 HTTP 通信过程中产生各种状态码的含义。cJSON 源码包下载 cJSON 源码包。随时关注 developerWorks 技术活动和网络广播。访问 developerWorks Open source 专区获得丰富的 how-to 信息、工具和项目更新以及最受欢迎的文章和教程帮助您用开放源码技术进行开发并将它们与 IBM 产品结合使用。
