1. API 介紹

幾個(gè)主要 HBase API 類和數(shù)據(jù)模型之間的對(duì)應(yīng)關(guān)系：

Java 類	HBase 數(shù)據(jù)模型
Admin	數(shù)據(jù)庫(kù)（Database）
HBaseConfiguration
Table	表（Table）
HTableDescriptor	列簇（Column Family）
HColumnDescriptor
Put	列修飾符（Column Qualifier）
Get
Delete
Result
Scan
ResultScanner

?

1.1 Admin

關(guān)系：org.apache.hadoop.hbase.client.Admin

作用：提供了一個(gè)接口來(lái)管理 HBase 數(shù)據(jù)庫(kù)的表信息。它提供的方法包括：創(chuàng)建表、刪除表、列出表項(xiàng)，使表有效或無(wú)效，以及添加或刪除表列簇成員等。

返回值	函數(shù)	描述
void	addColumn(TableName tableName, HColumnDescriptor column)	向一個(gè)已經(jīng)存在的表添加列
	checkHBaseAvaliable(HBaseConfiguration conf)	靜態(tài)函數(shù)，查看 HBase 是否處于運(yùn)行狀態(tài)
	createTable(HTableDescriptor desc)	創(chuàng)建一個(gè)表，同步操作
	deleteTable(TableName tableName)	刪除一個(gè)已經(jīng)存在的表
	enabelTable(TableName tableName)	使表處于有效狀態(tài)
	disableTable(TableName tableName)	使表處于無(wú)效狀態(tài)（在刪除一個(gè)表時(shí)候，要先使這個(gè)表處于無(wú)效狀態(tài)）
HTableDescriptor[]	listTables()	列出所有用戶控件表項(xiàng)
void	modifyTable(byte[] tableName, HTableDescriptor htd)	修改表的模式，是異步的操作，可能需要花費(fèi)一定的時(shí)間
boolean	tableExists(String tableName)	檢查表是否存在

?

1.2 HBaseConfiguration

關(guān)系：org.apache.hadoop.hbase.HBaseConfiguration

作用：對(duì) HBase 進(jìn)行配置

返回值	函數(shù)	描述
void	addResource(Path file)	通過(guò)給定的路徑所指的文件來(lái)添加資源
void	clear()	清空所有已設(shè)置的屬性
String	get(String name)	獲取屬性名對(duì)應(yīng)的值
String	getBoolean(String name, boolean defaultValue)	獲取為 boolean 類型的屬性值，如果其屬性值類型不為 boolean，則返回默認(rèn)屬性值
void	set(String name, String value)	通過(guò)屬性名來(lái)設(shè)置值
void	setBoolean(String name, boolean value)	設(shè)置 boolean 類型的屬性值

?

1.3?HTableDescriptor

關(guān)系：org.apache.hadoop.hbase.HTableDescriptor

作用：包含了表的名字及其對(duì)應(yīng)表的列簇

返回值	函數(shù)	描述
void	addFamily(HColumnDescriptor family)	添加一個(gè)列簇
HColumnDescriptor	removeFamily(byte[] column)	移除一個(gè)列簇
byte[]	getName()	獲取表的名字
byte[]	getValue(byte[] key)	獲取屬性的值
void	setValue(String key, String value)	設(shè)置屬性的值

?

1.4?HColumnDescriptor

關(guān)系：org.apache.hadoop.hbase.HColumnDescriptor

作用：維護(hù)著關(guān)于列簇的信息，例如版本號(hào)，壓縮設(shè)置等。它通常在創(chuàng)建表或者為表添加列簇的時(shí)候使用。列簇被創(chuàng)建后不能直接修改，只能通過(guò)刪除然后重新創(chuàng)建的方式。列簇被刪除的時(shí)候，列簇里面的數(shù)據(jù)也同時(shí)被刪除。

返回值	函數(shù)	描述
byte[]	getName()	獲取列簇的名字
byte[]	getValue(byte[] key)	獲取對(duì)應(yīng)的屬性的值
void	setValue(String key, String value)	設(shè)置對(duì)應(yīng)屬性的值

?

1.5 Table

關(guān)系：org.apache.hadoop.hbase.client.Table

作用：可以用來(lái)和 HBase 表來(lái)直接通信，此方法對(duì)于更新操作來(lái)說(shuō)是非線程安全的。

返回值	函數(shù)	描述
void	checkAndPut(byte[] row, byte[] family, byte[] qualifier, byte[] value, Put put)	自動(dòng)的檢查 row, family, qualifier 是否與給定的值匹配
void	close()	釋放所有的資源或掛起內(nèi)部的緩沖區(qū)中的更新
boolean	exists(Get get)	檢查 Get 實(shí)例所指定的值是否存在于 HTable 的列中
Result	get(Get get)	獲取指定行的某些單元格所對(duì)應(yīng)的值
byte[][]	getEndKeys()	獲取當(dāng)前打開(kāi)的表每個(gè)區(qū)域的結(jié)束鍵值
ResultScanner	getScanner(byte[] family)	獲取當(dāng)前給定列簇的 Scanner 實(shí)例
HTableDescriptor	getTableDescriptor()	獲取當(dāng)前表的 HTableDescriptor 實(shí)例
byte[]	getTableName()	獲取表名
static boolean	isTableEnabled(TableName tableName)	檢查表是否有效
void	put(Put put)	向表中添加值

?

1.6 Put

關(guān)系：org.apache.hadoop.hbase.client.Put

作用：用來(lái)對(duì)單個(gè)行執(zhí)行添加操作

返回值	函數(shù)	描述
Put	add(byte[] family, byte[] qualifier, byte[] value)	將指定的列和對(duì)應(yīng)的值添加到 Put 實(shí)例中
Put	add(byte[] family, byte[] qualifier, long timeStamp, byte[] value)	將指定的列和對(duì)應(yīng)的值及時(shí)間戳添加到 Put 實(shí)例中
byte[]	getRow()	獲取 Put 實(shí)例的行
RowLock	getRowLock()	獲取 Put 實(shí)例的行鎖
long	getTimeStamp()	獲取 Put 實(shí)例的時(shí)間戳
boolean	isEmpty()	檢查 familyMap 是否為空
Put	setTimeStamp(long timeStamp)	設(shè)置 Put 實(shí)例的時(shí)間戳

用法示例：

Table table = ConnectionFactory.createConnection(conf).getTable(TableName.valueOf(tableName)); Put p = new Put(row); // 為指定行創(chuàng)建一個(gè) Put 操作 put.addColumn(Bytes.toBytes(familyName), Bytes.toBytes(column), Bytes.toBytes(value)); table.put(p);

?

1.7?Get

關(guān)系：org.apache.hadoop.hbase.client.Get

作用：用來(lái)獲取單個(gè)行的相關(guān)信息

返回值	函數(shù)	描述
Get	addColumn(byte[] family, byte[] qualifier)	獲取指定列簇和列修飾符對(duì)應(yīng)的列
Get	addFamily(byte[] family)	通過(guò)指定的列簇獲取其對(duì)應(yīng)列的所有列
Get	setTimeRange(long minStamp, long maxStamp)	獲取指定范圍的列的版本號(hào)
Get	setFilter(Filter filter)	當(dāng)執(zhí)行 Get 操作時(shí)設(shè)置服務(wù)器端的過(guò)濾器

用法示例：

Table table = ConnectionFactory.createConnection(conf).getTable(TableName.valueOf(tableName)); Get get = new Get(Bytes.toBytes(row));

?

1.8 Delete

關(guān)系：org.apache.hadoop.hbase.client.Delete

作用：用來(lái)封裝一個(gè)要?jiǎng)h除的信息

?

1.9 Scan

關(guān)系：org.apache.hadoop.hbase.client.Scan

作用：用來(lái)封裝一個(gè)作為查詢條件的信息

?

1.10 Result

關(guān)系：org.apache.hadoop.hbase.client.Result

作用：存儲(chǔ) Get 或 Scan 操作后獲取表的單行值。使用此類提供的方法可以直接獲取值或各種 Map 結(jié)構(gòu)（Key-Value 對(duì)）

返回值	函數(shù)	描述
boolean	containsColumn(byte[] family, byte[] qualifier)	檢查指定的列是否存在
NavigableMap<byte[], byte[]>	getFamilyMap(byte[] family)	獲取對(duì)應(yīng)列簇所包含的修飾符與值的鍵值對(duì)
byte[]	getValue(byte[] family, byte[] qualifier)	獲取對(duì)應(yīng)列的最新值

?

1.11 ResultScanner

關(guān)系：org.apache.hadoop.hbase.client.ResultScanner

作用：存儲(chǔ) Scan 操作后獲取表的單行值

?

2. 基本增刪改查的代碼實(shí)現(xiàn)

Note: 切記，在將 string 類型轉(zhuǎn)換為 byte[] 時(shí)，要使用 HBase 提供的工具類 Bytes.toBytes() 方法來(lái)轉(zhuǎn)換。同樣，在將 byte[] 轉(zhuǎn)換為 string 類型時(shí)，要使用 Bytes.toString() 方法來(lái)進(jìn)行轉(zhuǎn)換操作。

package cn.gldwolf.hbase;import org.apache.hadoop.conf.Configuration; import org.apache.hadoop.hbase.*; import org.apache.hadoop.hbase.KeyValue.Type; import org.apache.hadoop.hbase.client.*; import org.apache.hadoop.hbase.util.Bytes;import java.io.IOException; import java.io.UnsupportedEncodingException;/*** @author: Gldwolf* @email: ZengqiangZhao@sina.com* @date: 2019/6/20 10:41*/public class HBaseDemo {public static Configuration conf;private static final String ZK_CONNECT_STR = "hdp01:2181,hdp02:2181,hdp03:2181";static {conf = HBaseConfiguration.create();conf.set("hbase.zookeeper.quorum", ZK_CONNECT_STR);}/*** 創(chuàng)建表* @param tableName 表名* @param family 列簇列表* @throws IOException*/public static void createTable(String tableName, String[] family) throws IOException {Admin admin = ConnectionFactory.createConnection(conf).getAdmin();TableName tbName = TableName.valueOf(tableName); // 表的名稱HTableDescriptor desc = new HTableDescriptor(tbName); // 創(chuàng)建一個(gè)表的描述信息對(duì)象for (int i = 0; i < family.length; i++) {desc.addFamily(new HColumnDescriptor(family[i])); // 將表的列簇信息添加到 HTableDescriptor 中}if (admin.tableExists(tbName)) { // 判斷表是否已經(jīng)存在System.out.println(tbName.getNameAsString() + " is exists!");System.exit(0);} else { // 如果不存在：創(chuàng)建一個(gè)表admin.createTable(desc);System.out.println("Congratulations, " + tbName.getNameAsString() + " created successfully!");}}/*** 往表中按照 rowKey 添加數(shù)據(jù)* @param rowKey* @param tableName 表名* @param column1 第一個(gè)列簇列表* @param value1 第一個(gè)列的值的列表* @param column2 第二個(gè)列簇* @param value2 第二個(gè)列的值的列表* @throws IOException*/public static void addData(String rowKey, String tableName, String[] column1, String[] value1,String[] column2, String[] value2) throws IOException {// 設(shè)置 rowKeyPut put = new Put(Bytes.toBytes(rowKey)); // Put 用來(lái)對(duì)單個(gè)行執(zhí)行添加操作// HTable 即 HBase 中的表，負(fù)責(zé)跟蹤記錄相關(guān)的操作：如增刪改查等Table table = ConnectionFactory.createConnection(conf).getTable(TableName.valueOf(tableName));// 獲取所有的列簇HColumnDescriptor[] columnFamilies = table.getTableDescriptor().getColumnFamilies();for (int i = 0; i < columnFamilies.length; i++) {// 獲取列簇名String familyName = columnFamilies[i].getNameAsString();// 往 article 列簇中 put 數(shù)據(jù)if (familyName.equals("article")) {for (int j = 0; j < column1.length; j++) {put.addColumn(Bytes.toBytes(familyName), Bytes.toBytes(column1[j]), Bytes.toBytes(value1[j]));}}// 往 author 列簇中添加數(shù)據(jù)if (familyName.equals("author")) {for (int j = 0; j < column2.length; j++) {put.addColumn(Bytes.toBytes(familyName), Bytes.toBytes(column2[j]), Bytes.toBytes(value2[j]));}}}table.put(put);System.out.println("Add data success!");}/*** 根據(jù) rowKey 獲取表中的數(shù)據(jù)* @param tableName 表名* @param rowKey* @return Result 一個(gè) rowKey 對(duì)應(yīng)的結(jié)果集合* @throws IOException*/public static Result getResult(String tableName, String rowKey) throws IOException {Get get = new Get(Bytes.toBytes(rowKey)); // Get 是用來(lái)獲取單行數(shù)據(jù)的對(duì)象// 獲取表對(duì)象Table table = ConnectionFactory.createConnection(conf).getTable(TableName.valueOf(tableName));// 獲取結(jié)果集Result result = table.get(get);for (Cell cell : result.listCells()) {printCell(cell);}return result;}/*** 打印單個(gè) cell 信息* @param cell 一個(gè)數(shù)據(jù)單元*/public static void printCell(Cell cell) throws UnsupportedEncodingException {byte[] rowArray = cell.getRowArray();for (byte row : rowArray) {}System.out.println("RowKey: " + Bytes.toString(cell.getRowArray()));System.out.println("Family: " + Bytes.toString(cell.getFamilyArray()));System.out.println("Qualifier: " + Bytes.toString(cell.getQualifierArray()));System.out.println("Value: " + Bytes.toString(cell.getValueArray()));System.out.println("TimeStamp: " + cell.getTimestamp());System.out.println("-------------------------");}/*** 獲取整個(gè)表的所有行數(shù)據(jù)，并打印所有的 Cell* @param tableName 表名* @throws IOException*/public static void getResultScan(String tableName) throws IOException {Scan scan = new Scan(); // 在創(chuàng)建對(duì)象的時(shí)候要傳入掃描的起始行和結(jié)束行，如果不給參數(shù)，那么就會(huì) Scan 整個(gè)表Table table = ConnectionFactory.createConnection(conf).getTable(TableName.valueOf(tableName));// 獲取 scan 后的結(jié)果對(duì)象ResultScanner rs = table.getScanner(scan);// 結(jié)果對(duì)象包含所有行的數(shù)據(jù)，而每個(gè)行中又有許多的 Cellfor (Result r : rs) {for (Cell cell : r.listCells()) {printCell(cell);}}rs.close();}/*** 獲取從 startRowKey 到 stopRowKey 的所有的行的數(shù)據(jù)，并打印包含的所有 Cell* @param tableName 表名* @param startRowKey 起始行* @param stopRowKey 結(jié)束行* @throws IOException*/public static void getResultScan(String tableName, String startRowKey, String stopRowKey) throws IOException {Scan scan = new Scan(Bytes.toBytes(startRowKey), Bytes.toBytes(stopRowKey)); // 在創(chuàng)建對(duì)象的時(shí)候傳入掃描的起始行和結(jié)束行Table table = ConnectionFactory.createConnection(conf).getTable(TableName.valueOf(tableName));// 獲取 scan 后的結(jié)果對(duì)象ResultScanner rs = table.getScanner(scan);// 結(jié)果對(duì)象包含所有行的數(shù)據(jù)，而每個(gè)行中又有許多的 Cellfor (Result r : rs) {for (Cell cell : r.listCells()) {printCell(cell);}}rs.close();}/*** 查詢表的某一列的數(shù)據(jù)* @param tableName 表名* @param rowKey rowKey* @param familyName 列簇名* @param columName 列名* @throws IOException*/public static void getResultByColumn(String tableName, String rowKey, String familyName, String columName) throws IOException {Table table = ConnectionFactory.createConnection(conf).getTable(TableName.valueOf(tableName));Get get = new Get(Bytes.toBytes(rowKey));// 獲取指定列簇和列修飾符對(duì)應(yīng)的列g(shù)et.addColumn(Bytes.toBytes(familyName), Bytes.toBytes(columName));Result results = table.get(get);for (Cell cell : results.listCells()) {printCell(cell);}}/*** 更新一個(gè)單元格中的數(shù)據(jù)* @param tableName 表名* @param rowKey* @param familyName 列簇名* @param columnName 列名* @param value 值* @throws IOException*/public static void updateTable(String tableName, String rowKey, String familyName, String columnName, String value) throws IOException {Table table = ConnectionFactory.createConnection(conf).getTable(TableName.valueOf(tableName));Put put = new Put(Bytes.toBytes(rowKey));// 創(chuàng)建一個(gè) Cell，需要用 CellUtil 的 createCell 方法來(lái)創(chuàng)建Cell cell = CellUtil.createCell(Bytes.toBytes(rowKey),Bytes.toBytes(familyName), // 列簇名Bytes.toBytes(columnName), // 列名System.currentTimeMillis(), // 時(shí)間戳Type.Put.getCode(), // 類型Bytes.toBytes(value)); // 值// 住 Put 對(duì)象中添加 Cellput.add(cell);// 執(zhí)行 update 操作table.put(put);System.out.println("Update table success!");}/*** 查詢某列數(shù)據(jù)的多個(gè)版本* @param tableName 表名* @param rowKey* @param familyName 列簇名* @param columnName 列名* @throws IOException*/public static void getResultByVersion(String tableName, String rowKey, String familyName, String columnName) throws IOException {Table table = ConnectionFactory.createConnection(conf).getTable(TableName.valueOf(tableName.getBytes()));Get get = new Get(Bytes.toBytes(rowKey));// 往 Get 對(duì)象中添加列簇信息和列信息get.addColumn(Bytes.toBytes(familyName), Bytes.toBytes(columnName));// 設(shè)置 version 為 5get.setMaxVersions(5);Result results = table.get(get);for (Cell cell : results.listCells()) {printCell(cell);}}/*** 刪除一行中的一個(gè)指定的列* @param tableName 表名* @param rowKey* @param familyName 列簇名* @param columnName 列名* @throws IOException*/public static void deleteOneColumnOfOneRow(String tableName, String rowKey, String familyName, String columnName) throws IOException {Table table = ConnectionFactory.createConnection(conf).getTable(TableName.valueOf(tableName));// 創(chuàng)建一個(gè)行級(jí)的 Delete 對(duì)象Delete deleteColumn = new Delete(Bytes.toBytes(rowKey));// 指定要?jiǎng)h除的列deleteColumn.addColumns(Bytes.toBytes(familyName), Bytes.toBytes(columnName));table.delete(deleteColumn);System.out.println(rowKey + ": " + familyName + ": " + columnName + "is deleted!");}/*** 刪除一行的所有列* @param tableName 表名* @param rowKey* @throws IOException*/public static void deleteAllColumnOfOneRow(String tableName, String rowKey) throws IOException {Table table = ConnectionFactory.createConnection(conf).getTable(TableName.valueOf(tableName));Delete deleteColumn = new Delete(Bytes.toBytes(rowKey)); // 此時(shí)就不用添加列簇名和列名了，因?yàn)橐獎(jiǎng)h除這一行中的所有數(shù)據(jù)table.delete(deleteColumn);System.out.println(rowKey + " all columns are deleted!");}/*** 刪除一個(gè)表* @param tableName 表名* @throws IOException*/public static void deleteTable(String tableName) throws IOException {Admin admin = ConnectionFactory.createConnection(conf).getAdmin();// 在刪除表之前要先將表停admin.disableTable(TableName.valueOf(tableName));admin.deleteTable(TableName.valueOf(tableName));System.out.println(tableName + " is deleted!");}public static void main(String[] args) throws IOException {// 創(chuàng)建表String tableName = "blog";String[] family = { "article", "author" };createTable(tableName, family);// 為表添加數(shù)據(jù)String[] column1 = {"title", "content", "tag"};String[] value1 = {"Head First HBase","HBase is the Hadoop database","Hadoop, HBase, NoSQL"};String[] column2 = {"name", "nickname"};String[] value2 = {"nicholas", "lee"};String[] value3 = {"lilaoshi", "malaoshi"};addData("rowkey1", "blog", column1, value1, column2, value2);addData("rowkey1", "blog", column1, value1, column2, value3);addData("rowkey2", "blog", column1, value1, column2, value2);addData("rowkey3", "blog", column1, value1, column2, value2);// 遍歷查詢， 根據(jù) row key 范圍遍歷查詢getResultScan("blog", "rowkey2", "rowkey3");// 查詢getResult("blog", "rowkey1");// 查詢某一列的值getResultByColumn("blog", "rowkey1", "author", "name");// 更新列updateTable("blog", "rowkey1", "author", "name", "bin");// 查詢某一列的值getResultByColumn("blog", "rowkey1", "author", "name");// 查詢某列的多版本getResultByVersion("blog", "rowkey1", "author", "name");// 刪除一列deleteOneColumnOfOneRow("blog", "rowkey1", "author", "nickname");// 刪除所有列deleteAllColumnOfOneRow("blog", "rowkey1");// 刪除表 // deleteTable("blog");} }

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

總結(jié)

以上是生活随笔為你收集整理的HBase Java API 代码开发的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。