目录
前言
上一篇文章中我们已经认识了结构体如何定义、如何初始化、成员在内存中是存储的等知识,接下来我们就来利用结构体实现一个简易版的通讯录应用。
一、模块分工
为了代码的整体结构更加清晰,我们需要将全部代码分为两个模块进行书写:
第一个是测试模块,主要任务是进行通讯录功能书写完成后的测试环节,测试功能是否完善,是否能够正常运行,该包含一个源文件:test.c ;
第二个是功能模块,这一模块主要是对于通讯录各个功能的书写,包含一个头文件和一个源文件:Contact.h 和 Contact.c 。其中每个功能都被封装成为一个函数,函数的声明、其他头文件的包含、常量的声明等需要复用的代码放在头文件中,这是由于后续两个源文件都需要使用到这些功能,这样只需包含头文件即可而无需书写重复的代码。函数的定义书写在源文件中完成。
二、通讯录代码书写
1. 设计通讯录界面
首先我们需要设计一个界面,供使用者选择功能,界面的结构根据我们所需要编写的功能种类和多少确立。
由于我们设计的是一个简易版的通讯录,所以在此处我们设计一些基本的功能即可,例如:增删查改、展示通讯录、清空通讯录、通讯录排序、退出通讯录……
界面只需在测试环节使用,所以定义在 test.c 中即可。
//test.c
void menu(void)
{
printf("**********************************\n");
printf("****** 1.add 2.del ******\n");
printf("****** 3.search 4.modify ******\n");
printf("****** 5.show 6.clear ******\n");
printf("****** 7.sort 0.exit ******\n");
printf("**********************************\n");
}
有了界面之后,那么我们就需要让使用者输入数字选择功能,为了能够多次使用,我们需要将此部分放于循环结构中。那么选择哪种循环结构呢?最适合的是:do...while 循环,因为选择界面需要在使用者输入前就打印的,所以需要先打印一次选择界面。
接收到输入后的数字,我们就应该运行相对应的功能,应该使用选择结构进行对应。我们使用输入的数字作为循环条件,因为我们上面使用 0 对应退出程序,所以当循环条件为 0 时,循环停止。这部分内容同样是书写在 test.c 中。
//test.c
int input = 0;
do
{
menu();
printf("请选择:>");
scanf("%d", &input);
switch (input)
{
case 1:
AddContact(&con);
break;
case 2:
DelContact(&con);
break;
case 3:
SearchContact(&con);
break;
case 4:
ModifyCotact(&con);
break;
case 5:
ShowContact(&con);
break;
case 6:
ClearContact(&con);
break;
case 7:
SortContact(&con);
break;
case 0:
printf("已退出程序\n");
break;
default:
printf("输入错误,请重新输入\n");
break;
}
} while (input);
2. 初始化通讯录
在书写功能之前,我们还需要先将通讯录进行定义和初始化。
每一个联系人都有多种属性:姓名、年龄、性别、电话……所以我们应该将其定义为一个结构体变量。为了后续方便修改,我们尽量把代码中多处需要使用到的数字使用 #define 声明为标识符常量。这部分我们需要放在头文件中,因为两个源文件都需要使用到这部分内容。
//Contact.h
#define Name_Max 10
#define Sex_Max 5
#define Tele_Max 12
#define Addr_Max 10
typedef struct PeoInfo
{
char name[Name_Max];
int age;
char sex[Sex_Max];
char tele[Tele_Max];
char addr[Addr_Max];
}PeoInfo;
此处为了创建变量时更加方便,我们使用 typedef 进行类型的重命名。
一般情况下,通讯录都可以存储许多个联系人,此处我们定义一个结构体数组,内含 1000 个元素。
除此之外,我们还需要定义一个变量 sz 来记录当前通讯录有着多少个联系人。如果没有该变量,我们在添加联系人时就无从下手了,不知道该从什么位置进行添加。并且我们也可以使用该变量作为新添加联系人的下标:假设现在通讯录中已有 3 个联系人,即 sz = 3 ,那么下一个联系人在数组中的下标也为 3 (因为数组首元素下标为 0 ),所以可以用 sz 表示。
为了更加明确清晰,我们将上面这两个变量同样封装成为一个结构体,这样两个变量就可以看作是一个整体。
//Contact.h
#define Max 1000
typedef struct Contact
{
PeoInfo arr[Max];
int sz;
}Contact;
接下来就是对结构体内的成员进行初始化。
如果想要简单粗暴,直接在定义变量同时初始化为 { 0 } 是可以的。
但是为了满足后续个性化的设计,我们将初始化过程封装为一个函数,以满足不同情况下对于通讯录初始化内容的不同需求,否则按照上面的初始化方法只能固定初始化。
//Contact.h
void InitContact(Contact* pc);
//Contact.c
void InitContact(Contact* pc)
{
assert(pc);
memset(pc->arr, 0, sizeof(pc->arr));
pc->sz = 0;
}
//test.c
Contact con;
InitContact(&con);
上面代码中,我们直接使用前面文章讲到的 memset 将所需要初始化的部分直接初始化为 0 。
在功能书写中,我们经常需要传递结构体指针作为参数,所以我们需要尽量使用断言判断参数是否是空指针。如果函数内部无需对结构体内容进行改变,还需使用 const 对指针进行修饰,防止误操作对结构体内容进行修改。这样可以大大增加函数的健壮性。
3. 增加联系人
增加联系人,我们只需打印录入信息的提示,提示使用者该录入的是什么信息,然后将其存入结构体中即可,末尾还需要让 sz++ ,记录此时联系人增加了一个。
//Contact.h
void AddContact(Contact* pc);
//Contact.c
void AddContact(Contact* pc)
{
assert(pc);
if (pc->sz == Max)
{
printf("通讯录已满,无法添加\n");
return;
}
printf("请输入姓名:>");
scanf("%s", pc->arr[pc->sz].name);
printf("请输入年龄:>");
scanf("%d", &(pc->arr[pc->sz].age));
printf("请输入性别:>");
scanf("%s", pc->arr[pc->sz].sex);
printf("请输入地址:>");
scanf("%s", pc->arr[pc->sz].addr);
printf("请输入电话:>");
scanf("%s", pc->arr[pc->sz].tele);
printf("新增联系人成功\n");
(pc->sz)++;
}
4. 删除联系人
删除联系人有两种方式,一种是将该联系人后续的联系人都往前移动,然后 sz-- ,这样即便最后一个联系人还是依然没有变化,但是 sz 减少一位之后,已经是访问不到最后一个联系人了。
我们使用一个 int 型的数组,里面包含 1~10 ,然后例如想要删除 6 ,按照上面的方法就是 7,8,9,10 往前移动,虽然此时最后一个元素不变,依然是 10 ,但是我们使 sz-- ,此时就相当于此时只有 9 个元素,访问不到第十个元素,所以是什么都无所谓了。
第二种方法是,直接将最后一个元素移动到想要删除元素的位置,即是将 10 移动到 6 的位置上,此时我们可以使得最后一个元素置为 0 或者不变,然后依然 sz-- 。这种做法相较于前者较为麻烦,但是这样会使得元素乱序,如果进行多次删除,整个数组内的元素顺序就会变得十分混乱。
这里我们采用第一种做法。
//Contact.h
void DelContact(Contact* pc);
//Contact.c
//根据姓名匹配联系人
int FindByName(const Contact* pc, char name[])
{
assert(pc);
int i = 0;
for (i = 0; i < pc->sz; i++)
{
if (strcmp(name, pc->arr[i].name) == 0)
{
return i;
}
}
return -1;
}
void DelContact(Contact* pc)
{
assert(pc);
if (pc->sz == 0)
{
printf("通讯录为空,无法删除\n");
return;
}
char name[Name_Max] = { 0 };
printf("请输入想要删除的联系人姓名:>");
scanf("%s", name);
int ret = FindByName(pc, name);
if (ret == -1)
{
printf("该联系人不存在\n");
return;
}
else
{
int i = 0;
for (i = ret; i < pc->sz - 1; i++)
{
pc->arr[i] = pc->arr[i + 1];
}
(pc->sz)--;
printf("删除联系人成功\n");
}
}
此处还有一处可以简化代码:如果仔细思考一番我们会发现,删除、查询、修改联系人都是需要先根据姓名查询到是哪个联系人,然后再进行操作。所以我们将“ 根据姓名查找联系人 ”这一部分封装为一个函数,后续可以进行复用,减少重复代码的书写。如何查找到该联系人,则返回对应下标,如果没有就返回 -1 。此处使用 strcmp 进行传递过来的姓名跟各个联系人进行比较。
5. 查询联系人
查询功能,我们只需将查询之后的联系人信息打印出来,而且再打印出表头则更加完整。此处需要注意的是打印格式,需要将打印出来的信息进行对齐。
//Contact.h
void SearchContact(const Contact* pc);
//Contact.c
void SearchContact(const Contact* pc)
{
assert(pc);
char name[Name_Max] = { 0 };
printf("请输入想要查询的联系人姓名->");
scanf("%s", name);
int ret = FindByName(pc, name);
if (ret == -1)
{
printf("该联系人不存在\n");
}
else
{
printf("%-10s\t%-5s\t%-2s\t%-10s\t%-12s\t\n",
"姓名", "年龄", "性别", "地址", "电话");
printf("%-10s\t%-5d\t%-2s\t%-10s\t%-12s\t\n",
pc->arr[ret].name,
pc->arr[ret].age,
pc->arr[ret].sex,
pc->arr[ret].addr,
pc->arr[ret].tele);
}
}
6. 修改联系人
修改联系人,只需在匹配到相应的联系人之后,重新录入信息即可。
//Contact.h
void ModifyCotact(Contact* pc);
//Contact.c
void ModifyCotact(Contact* pc)
{
assert(pc);
char name[Name_Max] = { 0 };
printf("请输入想要修改的联系人姓名:>");
scanf("%s", name);
int ret = FindByName(pc, name);
if (ret == -1)
{
printf("该联系人不存在\n");
}
else
{
printf("请输入姓名:>");
scanf("%s", pc->arr[ret].name);
printf("请输入年龄:>");
scanf("%d", &(pc->arr[ret].age));
printf("请输入性别:>");
scanf("%s", pc->arr[ret].sex);
printf("请输入地址:>");
scanf("%s", pc->arr[ret].addr);
printf("请输入电话:>");
scanf("%s", pc->arr[ret].tele);
printf("修改联系人成功\n");
}
}
7. 展示通讯录
展示功能的逻辑就是直接将每个联系人的信息打印出来而已。同样地,如果将表头打印出来就更加完整了。
//Contact.h
void ShowContact(const Contact* pc);
//Contact.c
void ShowContact(const Contact* pc)
{
assert(pc);
printf("%-10s\t%-5s\t%-2s\t%-10s\t%-12s\t\n",
"姓名", "年龄", "性别", "地址", "电话");
int i = 0;
for (i = 0; i < pc->sz; i++)
{
printf("%-10s\t%-5d\t%-2s\t%-10s\t%-12s\t\n",
pc->arr[i].name,
pc->arr[i].age,
pc->arr[i].sex,
pc->arr[i].addr,
pc->arr[i].tele);
}
}
8. 清空通讯录
清空通讯录即是清空所有联系人,此处可以直接使用 memset 直接将数组内所占的所有内存空间都置为 0 ,同时将 sz 也置为 0 。
//Contact.h
void ClearContact(Contact* pc);
//Contact.c
void ClearContact(Contact* pc)
{
if (pc->sz == 0)
{
printf("通讯录为空,无需清空\n");
return;
}
else
{
memset(pc->arr, 0, sizeof(pc->arr));
pc->sz = 0;
printf("通讯录已清空\n");
}
}
9. 将通讯录按照姓名排序
排序功能,我们可以使用 qsort 对所有联系人进行排序,所以需要自己先定义出一个排序函数,将其传递 qsort 。
//Contact.h
void SortContact(Contact* pc);
//Contact.c
//按照姓名排序
int SortByName(const void* p1, const void* p2)
{
assert(p1 && p2);
return strcmp(((PeoInfo*)p1)->name, ((PeoInfo*)p2)->name);
}
//将通讯录按照姓名排序
void SortContact(Contact* pc)
{
assert(pc);
qsort(pc->arr, pc->sz, sizeof(pc->arr[0]), SortByName);
printf("排序成功\n");
}
注意在我们自己定义的排序函数中,需要将 void* 强制类型转换的结构体类型是联系人结构体而不是通讯录结构体。
总结
虽然这个简易版本的通讯录的整体逻辑是比较简单,而且每个功能的实现也不难,但是却可以将之前文章中所提到的结构体、字符串函数、回调函数等知识点串联到一起进行使用,这便可以使我们对之前学过的知识点串联起来,对它们的使用场景和使用方法加深印象。通讯录的完整代码在下一篇博客中,有兴趣的朋友可以适当参考一下。如果有不足之处请指出,我定会加以学习并改正。