HBase客户端API实战指南：从基础操作到高级功能
HBase 提供了丰富的 Java 客户端 API，用于实现数据的增删改查、过滤器查询和计数器等功能。本文基于实战场景，详细讲解 HBase 客户端 API 的核心用法，包括连接管理、数据操作、过滤器使用及计数器功能，帮助开发者快速上手。
环境准备与连接管理
在使用 HBase API 前，需确保项目引入 HBase 依赖（以 Maven 为例），并正确配置 HBase 连接信息（hbase-site.xml 需放在项目 classpath 下）。
依赖引入
1
2
3
4
5
| <dependency>
<groupId>org.apache.hbase</groupId>
<artifactId>hbase-client</artifactId>
<version>2.2.7</version>
</dependency>
|
连接初始化
HBase 客户端通过 Connection 对象管理与集群的连接，Admin 用于 DDL 操作，Table 用于 DML 操作。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
| import org.apache.hadoop.hbase.client.Admin;
import org.apache.hadoop.hbase.client.Connection;
import org.apache.hadoop.hbase.client.ConnectionFactory;
import org.apache.hadoop.hbase.client.Table;
import org.apache.hadoop.hbase.TableName;
public class HBaseClient {
private static Connection conn;
private static Admin admin;
private static Table table;
static {
try {
conn = ConnectionFactory.createConnection();
admin = conn.getAdmin();
table = conn.getTable(TableName.valueOf("test"));
} catch (IOException e) {
e.printStackTrace();
}
}
}
|
核心数据操作 API
插入数据（Put）
使用 Put 类向表中插入或更新数据，需指定 RowKey、列族、列名和值（均为字节数组）。
方法实现
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
public static void testPut(String rowKey, String family, String qualifier, String value) throws IOException {
Put put = new Put(Bytes.toBytes(rowKey));
put.addColumn(
Bytes.toBytes(family),
Bytes.toBytes(qualifier),
Bytes.toBytes(value)
);
table.put(put);
System.out.println("数据插入成功");
}
|
调用示例
1
| testPut("123456", "info", "name", "zs");
|
查询数据（Get）
使用 Get 类查询单行数据，支持指定列族或列名，减少无效数据传输。
方法实现
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
public static void testGet(String rowKey, String family, String qualifier) throws IOException {
Get get = new Get(Bytes.toBytes(rowKey));
get.addColumn(Bytes.toBytes(family), Bytes.toBytes(qualifier));
Result result = table.get(get);
byte[] valueBytes = result.getValue(Bytes.toBytes(family), Bytes.toBytes(qualifier));
if (valueBytes != null) {
System.out.println("查询结果：" + Bytes.toString(valueBytes));
}
}
|
调用示例
1
| testGet("123456", "info", "name");
|
删除数据（Delete）
使用 Delete 类删除指定行或列，支持删除单行、单列或多列。
方法实现
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
public static void testDelete(String rowKey, String family, String qualifier) throws IOException {
Delete delete = new Delete(Bytes.toBytes(rowKey));
delete.addColumn(Bytes.toBytes(family), Bytes.toBytes(qualifier));
table.delete(delete);
System.out.println("数据删除成功");
}
|
调用示例
1
| testDelete("123456", "info", "name");
|
批量扫描（Scan）
使用 Scan 类批量查询数据，支持范围扫描、列过滤和分页，适合全表或大范围数据查询。
方法实现（带过滤器）
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
public static void testScanWithFilter(String family, String qualifier) throws IOException {
Scan scan = new Scan();
scan.addColumn(Bytes.toBytes(family), Bytes.toBytes(qualifier));
Filter pageFilter = new PageFilter(1);
scan.setFilter(pageFilter);
ResultScanner scanner = table.getScanner(scan);
for (Result result : scanner) {
byte[] rowKey = result.getRow();
byte[] valueBytes = result.getValue(Bytes.toBytes(family), Bytes.toBytes(qualifier));
System.out.println("RowKey: " + Bytes.toString(rowKey) + ", Value: " + Bytes.toString(valueBytes));
}
scanner.close();
}
|
调用示例
1
| testScanWithFilter("info", "name");
|
计数器（Increment）
HBase 提供原子性计数器功能，通过 incrementColumnValue 实现累加，适合统计曝光量、点击量等场景。
方法实现
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
public static void testIncr(String rowKey, String family, String qualifier) throws IOException {
long newValue = table.incrementColumnValue(
Bytes.toBytes(rowKey),
Bytes.toBytes(family),
Bytes.toBytes(qualifier),
1
);
System.out.println("自增后的值：" + newValue);
long currentValue = table.incrementColumnValue(
Bytes.toBytes(rowKey),
Bytes.toBytes(family),
Bytes.toBytes(qualifier),
0
);
System.out.println("当前值：" + currentValue);
}
|
调用示例
1
| testIncr("did222", "camp", "501");
|
API 核心类与注意事项
1. 核心类作用
| 类名 |
作用 |
Connection |
管理 HBase 集群连接，线程安全，推荐单例复用 |
Admin |
用于表的创建、删除、启用 / 禁用等 DDL 操作 |
Table |
用于数据的插入、查询、删除等 DML 操作，非线程安全，建议用完即关 |
Put/Get/Delete/Scan |
分别对应插入、查询、删除、扫描操作的参数封装类 |
Filter |
扫描过滤器，如 PageFilter（分页）、RowFilter（行键过滤）等 |
2. 注意事项
- 资源释放：
Table、ResultScanner 等对象需手动关闭（或用 try-with-resources），避免连接泄漏。
- 字节数组转换：HBase 内部数据均为字节数组，需使用
Bytes.toBytes() 和 Bytes.toString() 转换。
- 线程安全：
Connection 和 Admin 线程安全，Table 非线程安全，多线程需单独创建。
- 异常处理：所有 API 可能抛出
IOException，需捕获或向上传递。
完整示例代码结构
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
| import org.apache.hadoop.hbase.client.*;
import org.apache.hadoop.hbase.util.Bytes;
import org.apache.hadoop.hbase.TableName;
import org.apache.hadoop.hbase.filter.PageFilter;
import org.apache.hadoop.hbase.filter.Filter;
import java.io.IOException;
public class HBaseClient {
private static Connection conn;
private static Admin admin;
private static Table table;
static {
try {
conn = ConnectionFactory.createConnection();
admin = conn.getAdmin();
table = conn.getTable(TableName.valueOf("test"));
} catch (IOException e) {
e.printStackTrace();
}
}
public static void testPut(...) throws IOException { ... }
public static void testGet(...) throws IOException { ... }
public static void testDelete(...) throws IOException { ... }
public static void testScanWithFilter(...) throws IOException { ... }
public static void testIncr(...) throws IOException { ... }
public static void main(String[] args) throws IOException {
testPut("123456", "info", "name", "zs");
testGet("123456", "info", "name");
testScanWithFilter("info", "name");
testIncr("did222", "camp", "501");
testDelete("123456", "info", "name");
table.close();
admin.close();
conn.close();
}
}
|
v1.3.10