HBase 工具 | hbase-sdk 推出HQL功能

hbase-sdk

基于HBase Client的相关API开发而来的一款轻量级的HBase ORM框架。提供SQL查询功能，以类SQL的方式——HQL读写HBase数据。😋

针对HBase 1.x和2.xAPI的不同之处，在其上做了一层统一的封装。

hbase-sdk分为spring-boot-starter-hbase和hbase-sdk-core两部分。

SpringBoot项目中引入spring-boot-starter-hbase，在普通的Java项目中则可以使用hbase-sdk-core。

---

 

hbase-sdk 是一款轻量级的ORM框架，封装了对HBase数据表的读写操作和对集群的运维管理，并针对HBase1.x的API和2.xAPI的差异，做了统一的定义， 提供更加方便的调用API。同时，HQL的功能也已上线，提供了类SQL读写数据的能力，这将大大降低HBase Client API的使用门槛。API文档地址: 

•  

https://weixiaotome.gitee.io/hbase-sdk/

如果觉得这个项目不错可以 star 支持或者打赏它。

功能特性

• [x] 消除不同版本API的差异，重新定义接口规范

• [x] 优良的ORM特性，数据查询结果集自动映射Java实体类

• [x] HQL，以类SQL的形式读写HBase的表中数据

• [x] 利用spring-boot-starter-hbase无缝与SpringBoot集成

• [x] HBatis，类似于myBatis，提供配置文件管理HQL的功能（努力规划中）

• [x] 熔断能力，提供API级别的主备集群自动切换功能，保障服务的高可用（努力规划中）

• [x] JDK8+

快速开始

hbase-sdk 的每个版本经过测试完成之后，都会编译打包至各个模块，最后发布到maven中央仓库之中，只是最新版本的代码有一定的延迟。如果你想在第一时间体验该项目， 可以选择在Gitee或Github中克隆源码，在本地编译并运行测试用例。

hbase-sdk 基于java8开发，如果你想自己编译或体验，请确保已经安装了Java8和maven3+。此外，如果你想在本地进行开发调试，建议在本地存在一个可连通的HBase环境。如果你想快速搭建一个HBase的开发环境，请参考：

•  

https://www.jielongping.com/archives/dockerhbasetest

hbase-sdk 开发所用的工具为IDEA，所以也极力推荐导入项目到idea中。

1. 普通项目

Maven 配置：

创建一个基础的 Maven 工程，HBase SDK API开发时基于的HBase版本主要是1.4.3和2.1.0。

所以，如果你的HBase版本是1.x，可以使用如下依赖。

<dependency>
    <groupId>com.github.CCweixiao</groupId>
    <artifactId>hbase-sdk-core_1.4</artifactId>
    <version>2.0.6</version>
</dependency>

如果你的HBase版本是2.x，则可以使用如下依赖。

<dependency>
    <groupId>com.github.CCweixiao</groupId>
    <artifactId>hbase-sdk-core_2.1</artifactId>
    <version>1.0.5</version>
</dependency>

hbase-sdk目前最新的版本是2.0.6。你可以在maven仓库中搜索CCweixiao来获取hbase-sdk相关jar包的最新版本。

•  

https://mvnrepository.com/artifact/com.github.CCweixiao

当然，如果你想重新编译，以适配你自己的HBase版本，也可以选择下载源码，修改项目根pom.xml文件中的hbase.version，之后运行如下编译命令：

git clone https://github.com/CCweixiao/hbase-sdk.git  or
git clone https://gitee.com/weixiaotome/hbase-sdk.git
cd hbase-sdk
mvn clean install -Dmaven.test.skip=true

2. 项目结构

project

API核心类继承结构示意图：

3. 在SpringBoot项目中使用

Maven 配置：

创建一个基于Maven的spring boot工程。

<dependency>
    <groupId>com.github.CCweixiao</groupId>
    <artifactId>spring-boot-starter-hbase_1.4</artifactId>
    <version>2.0.6</version>
</dependency>

or

<dependency>
    <groupId>com.github.CCweixiao</groupId>
    <artifactId>spring-boot-starter-hbase_2.1</artifactId>
    <version>2.0.6</version>
</dependency>

spring-boot-starter-hbase这个模块中已经包含了hbase-sdk-core。

4. 引入hbase-client的依赖

除了引入hbase-sdk的相关依赖之外，你还需要引入hbase-client的依赖，hbase-client的版本目前建议为1.2.x、1.4.x、2.1.x。hbase-client1.x和2.x的新旧API有所差异。未来，hbase-sdk会持续完善该依赖的版本兼容。

<dependency>
    <groupId>org.apache.hbase</groupId>
    <artifactId>hbase-client</artifactId>
    <version>1.4.3</version>
</dependency>        

or

<dependency>
    <groupId>org.apache.hbase</groupId>
    <artifactId>hbase-client</artifactId>
    <version>2.1.0</version>
</dependency>        

5. 配置HBase数据库连接

普通项目

// 数据读写API
HBaseTemplate hBaseTemplate = new HBaseTemplate("node1", "2181");
// 管理员API
HBaseAdminTemplate hBaseAdminTemplate = new HBaseAdminTemplate("node1", "2181");
// HQL操作API
HBaseSqlTemplate hBaseSqlTemplate = new HBaseSqlTemplate("localhost", "2181");