3.3 Thrift 与 REST API

文档摘要

3.3 Thrift 与 REST API 3.3 Thrift 与 REST API 除了原生的 Java API，HBase 还提供了 Thrift 和 REST 两种外部访问接口，允许使用非 Java 语言的客户端与 HBase 交互。这为不同技术栈的应用集成 HBase 提供了极大的便利性。 3.3.1 Thrift API 3.3.1.1 简介 Thrift 是 Apache 的一个跨语言的服务开发框架。它允许你定义数据类型和服务接口，然后使用 Thrift 编译器生成各种编程语言的代码，包括客户端和服务端代码。HBase 使用 Thrift 提供了一个服务接口，允许你通过 Thrift 客户端执行 HBase 的各种操作。 3.3.1.

3.3 Thrift 与 REST API

除了原生的 Java API，HBase 还提供了 Thrift 和 REST 两种外部访问接口，允许使用非 Java 语言的客户端与 HBase 交互。这为不同技术栈的应用集成 HBase 提供了极大的便利性。

3.3.1 Thrift API

3.3.1.1 简介

Thrift 是 Apache 的一个跨语言的服务开发框架。它允许你定义数据类型和服务接口，然后使用 Thrift 编译器生成各种编程语言的代码，包括客户端和服务端代码。HBase 使用 Thrift 提供了一个服务接口，允许你通过 Thrift 客户端执行 HBase 的各种操作。

3.3.1.2 Thrift 接口定义

HBase 的 Thrift 接口定义文件通常位于 HBase 的源代码目录中，名为 hbase.thrift。该文件定义了 HBase 的数据模型、操作接口和异常类型。通过查看该文件，你可以了解 HBase Thrift API 提供的所有功能。

3.3.1.3 使用 Thrift 客户端

要使用 Thrift 客户端与 HBase 交互，你需要以下步骤：

安装 Thrift 编译器： 根据你的操作系统和编程语言，安装 Thrift 编译器。
生成客户端代码： 使用 Thrift 编译器编译 hbase.thrift 文件，生成你所使用的编程语言的客户端代码。例如，如果你使用 Python，可以运行以下命令：
```
thrift -r --gen py hbase.thrift
```
这将生成一个名为 gen-py 的目录，其中包含 Python 客户端代码。
编写客户端代码： 在你的应用程序中，导入生成的客户端代码，并使用它来连接 HBase 服务，执行各种操作。

3.3.1.4 代码实践 (Python)

以下是一个使用 Python Thrift 客户端连接 HBase 并执行一些基本操作的示例：


import sys
from thrift import Thrift
from thrift.transport import TSocket
from thrift.transport import TTransport
from thrift.protocol import TBinaryProtocol
from hbase import Hbase
from hbase.ttypes import *
def main():
    try:
        # 1. 创建 socket
        transport = TSocket.TSocket('localhost', 9090)
        # 2. 设置 socket 的传输方式 (Buffered or Framed)
        transport = TTransport.TBufferedTransport(transport)
        # 3. 设置协议 (Binary, Compact, JSON, etc.)
        protocol = TBinaryProtocol.TBinaryProtocol(transport)
        # 4. 创建客户端
        client = Hbase.Client(protocol)
        # 5. 打开连接
        transport.open()
        # 6. 执行 HBase 操作
        # 列出所有表
        print("Tables: %r" % client.getTableNames())
        table_name = b'my_table'
        # 检查表是否存在
        if table_name not in client.getTableNames():
            # 创建表
            column_descriptor = ColumnDescriptor(name=b'cf1', maxVersions=1)
            client.createTable(table_name, [column_descriptor])
            print("Created table: %r" % table_name)
        # 插入数据
        row_key = b'row1'
        mutations = [Mutation(column=b'cf1:col1', value=b'value1')]
        client.mutateRow(table_name, row_key, mutations, {})
        print("Inserted data into row: %r" % row_key)
        # 获取数据
        result = client.getRow(table_name, row_key, {})
        print("Retrieved data: %r" % result)
        # 删除数据
        client.deleteAllRow(table_name, row_key, {})
        print("Deleted row: %r" % row_key)
        # 删除表 (可选)
        # client.disableTable(table_name)
        # client.deleteTable(table_name)
        # print("Deleted table: %r" % table_name)
        # 7. 关闭连接
        transport.close()
    except Thrift.TException as tx:
        print('Thrift failed: %s' % tx.message)
if __name__ == '__main__':
    main()

代码解释：

首先，我们导入必要的 Thrift 模块和 HBase 相关的模块。
然后，我们创建一个 Thrift socket，并设置传输方式和协议。
接下来，我们创建一个 HBase 客户端，并打开连接。
然后，我们可以使用客户端执行各种 HBase 操作，例如列出所有表、创建表、插入数据、获取数据和删除数据。
最后，我们关闭连接。

注意：

确保 HBase Thrift 服务已启动。默认情况下，它监听 9090 端口。你可以在 hbase-site.xml 文件中配置 Thrift 服务的端口。
你需要将 hbase.thrift 文件复制到你的项目目录中，并使用 Thrift 编译器生成 Python 客户端代码。

3.3.1.5 Thrift 优缺点

优点：

跨语言支持： Thrift 支持多种编程语言，允许你使用任何你喜欢的语言与 HBase 交互。
性能： Thrift 使用二进制协议进行数据传输，因此性能通常比 REST API 更好。
类型安全： Thrift 使用 IDL 定义数据类型和服务接口，因此可以提供更好的类型安全。

缺点：

学习曲线： Thrift 需要学习 Thrift IDL 和 Thrift 编译器，这可能会增加学习曲线。
部署复杂性： Thrift 需要部署 Thrift 服务端，这可能会增加部署复杂性。

3.3.2 REST API

3.3.2.1 简介

HBase REST API 允许你通过 HTTP 请求与 HBase 交互。它提供了一组 RESTful 接口，允许你执行各种 HBase 操作，例如创建表、插入数据、获取数据和删除数据。

3.3.2.2 REST 接口定义

HBase REST API 的接口定义可以在 HBase 的官方文档中找到。它定义了各种 HTTP 方法（例如 GET、POST、PUT、DELETE）和 URI，用于执行不同的 HBase 操作。

3.3.2.3 使用 REST 客户端

要使用 REST 客户端与 HBase 交互，你需要以下步骤：

启动 HBase REST 服务： 启动 HBase REST 服务。默认情况下，它监听 8080 端口。你可以在 hbase-site.xml 文件中配置 REST 服务的端口。
编写客户端代码： 在你的应用程序中，使用 HTTP 客户端库发送 HTTP 请求到 HBase REST 服务。

3.3.2.4 代码实践 (Python)

以下是一个使用 Python requests 库连接 HBase REST 服务并执行一些基本操作的示例：


import requests
import json
HBASE_REST_URL = 'http://localhost:8080'
def create_table(table_name, column_family):
    url = f'{HBASE_REST_URL}/{table_name}'
    headers = {'Content-Type': 'text/xml'}
    data = f'''<?xml version="1.0" encoding="UTF-8"?>
<Table schema="{table_name}">
    <ColumnSchema name="{column_family}" />
</Table>'''
    response = requests.put(url, headers=headers, data=data)
    if response.status_code == 201:
        print(f"Table '{table_name}' created successfully.")
    else:
        print(f"Error creating table: {response.status_code} - {response.text}")
def insert_data(table_name, row_key, column_family, column_qualifier, value):
    url = f'{HBASE_REST_URL}/{table_name}/{row_key}/{column_family}:{column_qualifier}'
    headers = {'Content-Type': 'text/plain'}
    response = requests.put(url, headers=headers, data=value)
    if response.status_code == 201:
        print(f"Data inserted into row '{row_key}' successfully.")
    else:
        print(f"Error inserting data: {response.status_code} - {response.text}")
def get_data(table_name, row_key, column_family, column_qualifier):
    url = f'{HBASE_REST_URL}/{table_name}/{row_key}/{column_family}:{column_qualifier}'
    headers = {'Accept': 'text/plain'}
    response = requests.get(url, headers=headers)
    if response.status_code == 200:
        print(f"Retrieved data: {response.text}")
    else:
        print(f"Error retrieving data: {response.status_code} - {response.text}")
def delete_data(table_name, row_key, column_family, column_qualifier):
    url = f'{HBASE_REST_URL}/{table_name}/{row_key}/{column_family}:{column_qualifier}'
    response = requests.delete(url)
    if response.status_code == 200:
        print(f"Data deleted from row '{row_key}' successfully.")
    else:
        print(f"Error deleting data: {response.status_code} - {response.text}")
def delete_table(table_name):
    # Disable the table first
    disable_url = f'{HBASE_REST_URL}/{table_name}/disable'
    response = requests.put(disable_url)
    if response.status_code == 200:
        print(f"Table '{table_name}' disabled successfully.")
    else:
        print(f"Error disabling table: {response.status_code} - {response.text}")
        return
    # Delete the table
    delete_url = f'{HBASE_REST_URL}/{table_name}'
    response = requests.delete(delete_url)
    if response.status_code == 200:
        print(f"Table '{table_name}' deleted successfully.")
    else:
        print(f"Error deleting table: {response.status_code} - {response.text}")
# Example usage
table_name = 'my_rest_table'
column_family = 'cf1'
row_key = 'row1'
column_qualifier = 'col1'
value = 'rest_value'
# Create table
create_table(table_name, column_family)
# Insert data
insert_data(table_name, row_key, column_family, column_qualifier, value)
# Get data
get_data(table_name, row_key, column_family, column_qualifier)
# Delete data
delete_data(table_name, row_key, column_family, column_qualifier)
# Delete table
delete_table(table_name)

代码解释：

首先，我们定义 HBase REST 服务的 URL。
然后，我们定义了几个函数，用于创建表、插入数据、获取数据和删除数据。
每个函数都使用 requests 库发送 HTTP 请求到 HBase REST 服务。
最后，我们调用这些函数来执行一些基本操作。

注意：

确保 HBase REST 服务已启动。默认情况下，它监听 8080 端口。你可以在 hbase-site.xml 文件中配置 REST 服务的端口。
你需要安装 requests 库。可以使用 pip install requests 命令安装它。
HBase REST API 使用 XML 或 JSON 格式进行数据传输。你需要根据你的需求设置 Content-Type 和 Accept header。

3.3.2.5 REST 优缺点

优点：

简单易用： REST API 使用 HTTP 协议，因此非常简单易用。
跨语言支持： REST API 可以被任何支持 HTTP 协议的编程语言使用。
无状态： REST API 是无状态的，因此易于扩展。

缺点：

性能： REST API 使用 HTTP 协议进行数据传输，因此性能通常比 Thrift API 差。
安全性： REST API 需要额外的安全措施来保护数据安全。

3.3.3 Thrift vs REST

以下是一个比较 Thrift 和 REST API 的表格：

特性	Thrift	REST
协议	二进制协议	HTTP
数据格式	Thrift IDL 定义的数据类型	XML 或 JSON
性能	较高	较低
跨语言支持	支持多种编程语言	支持任何支持 HTTP 的编程语言
易用性	相对复杂	简单易用
安全性	需要额外的安全措施	需要额外的安全措施
部署复杂性	较高	较低

3.3.4 总结

Thrift 和 REST API 都提供了访问 HBase 的外部接口。选择哪个 API 取决于你的具体需求。如果你需要高性能和类型安全，并且愿意学习 Thrift IDL，那么 Thrift API 是一个不错的选择。如果你需要简单易用和跨语言支持，那么 REST API 是一个不错的选择。

3.3.5 Mermaid 图表

以下是一个使用 Mermaid 绘制的 Thrift 和 REST API 的架构图：

图表解释：

客户端应用程序可以使用 Thrift 客户端或 REST 客户端与 HBase 交互。
Thrift 客户端与 Thrift 服务端通信，Thrift 服务端与 HBase 交互。
REST 客户端与 REST 服务端通信，REST 服务端与 HBase 交互。

希望这篇文章能够帮助你理解 HBase 的 Thrift 和 REST API。

作者与出处

原作者：灏天文库

来源：灏天文库

原文： https://aiknowledge.cn/collection/151-hbase%E5%88%86%E5%B8%83%E5%BC%8F%E6%95%B0%E6%8D%AE%E5%BA%93%E5%85%A5%E9%97%A8%E4%B8%8E%E5%AE%9E%E6%88%98

整理：灏天文库整理

由灏天文库平台收录，内容或由平台用户上传，仅供学习交流