2021年1月25日 星期一

glib函式庫 GHashTable 介紹及簡單範例應用

從前在程式碼流看到雜湊hash這個東西總感覺這什麼鬼啊!搞這麼複雜幹嘛...後來才發現這東西太好用了,以往在coding的時候,時常會遇到一個管理序號的隨機問題,新增一個成員要給序號1,下一個成員給序號2,以此類推,但是當情況變成在某情況下的某個成員會被刪除,那它的序號就空出來了,這時就要把這空出來的序號留給下一個加入的成員使用,否則序號會遞增個沒完沒了。在當時會自己寫程式去管理這個序號,接著呢~當整個程式愈來愈大,愈來愈複雜,用到序號的地方愈多,參與開發的人愈多,沒搞懂整體架構就開始解bug的人愈來愈多,bug就愈來愈多,如果一 開始就使用hash table來管理這些序號的對應,不僅省時省力,程式碼也會簡潔一點,相對的bug就可以減少一些。以下是網上看來的介紹,相當簡單易用也易懂的一個範例。

補充說明:

除了下面的範例,其實真正使用上不是這麼單純,範例中不管是key還是value都是用常數

("1"、"one"),當程式中使用的是變數的時候,整數型態的變數要使用GINT_TO_POINTER(key)當做參數傳進去,例如:

int iKey;

g_hash_table_insert(table,  GINT_TO_POINTER(iKey) ,  " one " );

char *pValue;

pValue = g_hash_table_lookup(table, GINT_TO_POINTER(iKey));

這樣才會拿到剛才插進去的"one"。

另外初始化的參數也很重要:

GHashTable * table = g_hash_table_new_full(g_direct_hash, g_direct_equal, NULL, destroyTable);

g_direct_hash、g_direct_equal會影響之後參數key的型別轉換應用,目前還沒試過g_int_equal、g_str_equal,g_direct_equal己符合我現在的使用需求。


hash表是一種提供key-value訪問的數據結構,通過指定的key值可以快速的訪問到與它相關聯的value值。 hash表的一種典型用法就是字典,通過單詞的首字母能夠快速的找到單詞。關於hash表的詳細介紹請查閱數據結構的相關書籍,我這裡只介紹glib庫中hash表的基本用法。


要使用一個hash表首先必須創建它,glib庫裡有兩個函數可以用於創建hash表,分別是g_hash_table_new()和g_hash_table_new_full(),它們的原型如下:

GHashTable  * g_hash_table_new(GHashFunc hash_func, GEqualFunc key_equal_func);


GHashTable *  g_hash_table_new_full(GHashFunc hash_func,

                                   GEqualFunc key_equal_func,

                                   GDestroyNotify key_destroy_func,

                                   GDestroyNotify value_destroy_func);

其中hash_func是一個函數,它為key創建一個hash值;key_equal_func用於比較兩個key是否相等;

key_destroy_func當你從hash表裡刪除、銷毀一個條目時,glib庫會自動調用它釋放key所佔用的內存空間,

這對於key是動態分配內存的hash表來說非常有用;value_destroy_func的作用與key_destroy_func相似,

只是它釋放的是value佔用的內存空間。


下面以一段代碼來演示glib庫中hash表的基本用法

 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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/* **************************************************************************
   file: g_hash.c
   desc: 这个文件用于演示glib库中hash表的用法
   compile: gcc -o g_hash g_hash.c `pkg-config --cflags --libs glib-2.0`
 ************************************************************************** */

#include  < glib.h >

void  print_key_value(gpointer key, gpointer value, gpointer user_data);
void  display_hash_table(GHashTable  * table);
void  free_key(gpointer data);
void  free_value(gpointer value);

void  print_key_value(gpointer key, gpointer value, gpointer user_data)
{
    printf( " %s ---> %s/n " , key, value);
}

void  display_hash_table(GHashTable  * table)
{
    g_hash_table_foreach(table, print_key_value, NULL);
}

void  free_key(gpointer data)
{
    printf( " We free key: %s /n" , data);
    free(data);
}

void  free_value(gpointer data)
{
    printf( " We free value: %s /n" , data);
    free(data);
}

int  main( int  argc,  char   * argv[])
{
    GHashTable  * table  =  NULL;

    table  =  g_hash_table_new(g_str_hash, g_str_equal);

    g_hash_table_insert(table,  " 1 " ,  " one " );
    g_hash_table_insert(table,  " 2 " ,  " two " );
    g_hash_table_insert(table,  " 3 " ,  " three " );
    g_hash_table_insert(table,  " 4 " ,  " four " );
    g_hash_table_insert(table,  " 5 " ,  " five " );
    display_hash_table(table);
    printf( " Size of hash table: %d /n " , g_hash_table_size(table));

    printf( " Before replace: 3 ---> %s /n " , g_hash_table_lookup(table,  " 3 " ));
    g_hash_table_replace(table,  " 3 " ,  " third " );
    printf( " After replace: 3 ---> %s /n" , g_hash_table_lookup(table,  " 3 " ));

    g_hash_table_remove(table,  " 2 " );
    display_hash_table(table);
    printf( " Now size of hash table: %d /n" , g_hash_table_size(table));

    g_hash_table_destroy(table);

    table  =  g_hash_table_new_full(g_str_hash, g_str_equal, free_key, free_value);
    g_hash_table_insert(table, strdup( " one " ), strdup( " first " ));
    g_hash_table_insert(table, strdup( " two " ), strdup( " second " ));
    g_hash_table_insert(table, strdup( " three " ), strdup( " third " ));
    
    printf( " Remove an item from hash table: /n " );
    g_hash_table_remove(table,  " two " );

    printf( " Destroy hash table: /n" );
    g_hash_table_destroy(table);

     return   0 ;
}
GINT_TO_POINTERGINT_TO_POINTER

 通過代碼我們看到glib庫為hash表接供了非常簡單的接口。下面是代碼的輸出

[plusboy@localhost c]$ ./g_hash

1 ---> one

2 ---> two

3 ---> three

4 ---> four

5 ---> five

Size of hash table: 5

Before replace: 3 ---> three

After replace: 3 ---> third

1 ---> one

3 ---> third

4 ---> four

5 ---> five

Now size of hash table: 4

Remove an item from hash table:

We free key: two

We free value: second

Destroy hash table:

We free key: three

We free value: third

We free key: one

We free value: first


對代碼的說明:


1、首先我們調用了g_hash_table_new()來創建一個hash表,然後用g_hash_table_insert()向hash表裡插入條目,插入的條目必須是一個key-value對,要查看hash表裡有多少個條目可以用g_hash_table_size ()。

2、用g_hash_table_lookup()通過key可以查找到與它相對應的value,g_hash_table_replace()可以替換掉一個key對應的value。

3、用g_hash_table_foreach()可以遍歷hash表裡的每一個條目,並對它們進行相應的操作。

4、用g_hash_table_remove()把一個條目從hash表裡刪除。

5、用g_hash_table_destroy()銷毀一個hash表。

6、對於用g_hash_table_new_full()創建並提供了key_destroy_func和value_destroy_func的hash表,刪除hash表中的條目或者銷毀hash表的時候,庫自動調用這兩個函數釋放內存,在銷毀hash表的時候,銷毀條目的順序與插入條目的順序並不總是相同的。代碼中我們用strdup()來為hash表的key和value動態分配內存。


對glib庫更多參考:

http://developer.gnome.org/doc/API/2.0/glib/index.html

沒有留言:

張貼留言