代码中的软件工程-menu实验

参考资料见：https://gitee.com/mengning997/se/blob/master/README.md#%E4%BB%A3%E7%A0%81%E4%B8%AD%E7%9A%84%E8%BD%AF%E4%BB%B6%E5%B7%A5%E7%A8%8B

环境配置

1.准备MinGW-64用于编译和调试。

下载后解压缩，在系统环境变量PATH中添加路径

下载成功后在终端运行"gcc -v"查看是否能够运行gcc命令。

2.下载C/C++插件

3.配置tasks.json用于编译文件，launch.json用于调试文件

//tasks.json
{
    "version": "2.0.0",
    "tasks": [{
            "label": "g++",
            "command": "g++",
            "args": [
                "-g",
                "${file}",
                "-o",
                "${fileDirname}/${fileBasenameNoExtension}.exe"
            ],
            "problemMatcher": {
                "owner": "cpp",
                "fileLocation": [
                    "relative",
                    "${workspaceRoot}"
                ],
                "pattern": {
                    "regexp": "^(.*):(\\d+):(\\d+):\\s+(warning|error):\\s+(.*)$",
                    "file": 1,
                    "line": 2,
                    "column": 3,
                    "severity": 4,
                    "message": 5
                }
            },
            "group": {
                "kind": "build",
                "isDefault": true
            }
        }
    ]
}

launch.json
{
    "version": "0.2.0",
    "configurations": [

        {
            "name": "(gdb) Launch",    
            "type": "cppdbg",       
            "request": "launch",    
            "program": "${fileDirname}/${fileBasenameNoExtension}.exe",
            "args": [],               
            "stopAtEntry": false,     
            "cwd": "${workspaceRoot}",
            "environment": [],
            "externalConsole": true,
            "MIMode": "gdb",
            "miDebuggerPath": "C:\\mingw64\\bin\\gdb.exe",
            "preLaunchTask": "g++",
            "setupCommands": [
                {
                    "description": "Enable pretty-printing for gdb",
                    "text": "-enable-pretty-printing",
                    "ignoreFailures": true
                }
            ]
        }
    ]
}

模块化设计

模块化的基本原理：

　　模块化（Modularity）是在软件系统设计时保持系统内各部分相对独立，以便每一个部分可以被独立地进行设计和开发。这个做法背后的基本原理是关注点的分离 (SoC, Separation of Concerns)。关注点的分离在软件工程领域是最重要的原则，我们习惯上称为模块化，翻译成我们中文的表述其实就是“分而治之”的方法。

模块化的优点：

　　模块化软件设计的方法如果应用的比较好，最终每一个软件模块都将只有一个单一的功能目标，并相对独立于其他软件模块，使得每一个软件模块都容易理解容易开发。从而整个软件系统也更容易定位软件缺陷bug，因为每一个软件缺陷bug都局限在很少的一两个软件模块内。而且整个系统的变更和维护也更容易，因为一个软件模块内的变更只影响很少的几个软件模块。

　　因此，软件设计中的模块化程度便成为了软件设计有多好的一个重要指标，一般我们使用耦合度（Coupling）和内聚度（Cohesion）来衡量软件模块化的程度。

　　耦合度：是指软件模块之间的依赖程度，一般可以分为紧密耦合（Tightly Coupled）、松散耦合（Loosely Coupled）和无耦合（Uncoupled）。一般在软件设计中我们追求松散耦合。

　　内聚度：是指一个软件模块内部各种元素之间互相依赖的紧密程度。理想的内聚是功能内聚，也就是一个软件模块只做一件事，只完成一个主要功能点或者一个软件特性（Feather）。

模块化代码的基本写法：将数据结构和它的操作与菜单业务处理进行分离处理，尽管还是在同一个源代码文件中，但是已经在逻辑上做了切分，可以认为有了初步的模块化。进行了模块化设计之后我们往往将设计的模块与实现的源代码文件有个映射对应关系，因此我们需要将数据结构和它的操作独立放到单独的源代码文件中，这时就需要设计合适的接口，以便于模块之间互相调用。

　　我们把与功能相关的代码放在menu.c文件中，把与数据结构及其操作相关的代码放在linklist.h文件中在，并且在linklist.c文件中实现所需函数。

　　进行了模块化设计之后我们往往将设计的模块与实现的源代码文件有个映射对应关系，因此我们需要将数据结构和它的操作独立放到单独的源代码文件中，这时就需要设计合适的接口，以便于模块之间互相调用。

软件设计中的一些基本方法：

KISS(Keep It Simple & Stupid)原则

使用本地化外部接口来提高代码的适应能力

先写伪代码的代码结构更好一些

可重用软件设计

消费者重用和生产者重用：消费者重用是指软件开发者在项目中重用已有的一些软件模块代码，以加快项目工作进度。

在重用已有的软件模块代码时一般会重点考虑如下四个关键因素：

　　该软件模块是否能满足项目所要求的功能；

　　采用该软件模块代码是否比从头构建一个需要更少的工作量，包括构建软件模块和集成软件模块等相关的工作；

　　该软件模块是否有完善的文档说明；

　　该软件模块是否有完整的测试及修订记录

我们清楚了消费者重用时考虑的因素，那么生产者在进行可重用软件设计时需要重点考虑的因素也就清楚了

接口：接口就是互相联系的双方共同遵守的一种协议规范，在我们软件系统内部一般的接口方式是通过定义一组API函数来约定软件模块之间的沟通方式。

接口规格包含五个基本要素：

　　接口的目的；

　　接口使用前所需要满足的条件，一般称为前置条件或假定条件；

　　使用接口的双方遵守的协议规范；

　　接口使用之后的效果，一般称为后置条件；

　　接口所隐含的质量属性。

接口与耦合度之间的关系：耦合度进一步可以分为无耦合、数据耦合、标记耦合、控制耦合、公共耦合和内容耦合。

在使用通用的Linktable模块之后menu程序业务代码变得复杂了一些，使用起来比较繁琐，是因为我们的接口定义的还不够好。

给Linktable增加Callback方式的接口，需要两个函数接口，一个是call-in方式函数，如SearchLinkTableNode函数，其中有一个函数作为参数，这个作为参数的函数就是callback函数，如代码中Conditon函数。

下面是接口：

#ifndef _LINK_TABLE_H_
#define _LINK_TABLE_H_

#include <pthread.h>

#define SUCCESS 0
#define FAILURE (-1)

/*
 * LinkTable Node Type
 */
typedef struct LinkTableNode
{
    struct LinkTableNode * pNext;
}tLinkTableNode;

/*
 * LinkTable Type
 */
typedef struct LinkTable tLinkTable;

/*
 * Create a LinkTable
 */
tLinkTable * CreateLinkTable();
/*
 * Delete a LinkTable
 */
int DeleteLinkTable(tLinkTable *pLinkTable);
/*
 * Add a LinkTableNode to LinkTable
 */
int AddLinkTableNode(tLinkTable *pLinkTable,tLinkTableNode * pNode);
/*
 * Delete a LinkTableNode from LinkTable
 */
int DelLinkTableNode(tLinkTable *pLinkTable,tLinkTableNode * pNode);
/*
 * Search a LinkTableNode from LinkTable
 * int Conditon(tLinkTableNode * pNode,void * args);
 */
tLinkTableNode * SearchLinkTableNode(tLinkTable *pLinkTable, int Conditon(tLinkTableNode * pNode, void * args), void * args);
/*
 * get LinkTableHead
 */
tLinkTableNode * GetLinkTableHead(tLinkTable *pLinkTable);
/*
 * get next LinkTableNode
 */
tLinkTableNode * GetNextLinkTableNode(tLinkTable *pLinkTable,tLinkTableNode * pNode);

#endif /* _LINK_TABLE_H_ */

　　通过将linktable.h中不是在接口调用时必须内容转移到linktable.c中，这样可以有效地隐藏软件模块内部的实现细节，为外部调用接口的开发者提供更加简洁的接口信息，同时也减少外部调用接口的开发者有意或无意的破坏软件模块的内部数据。通过接口进行信息隐藏已经成为面向对象编程语言的标准做法，使用public和private来声明属性和方法对于外部调用接口的开发者是否可见。

利用callback函数参数使Linktable的查询接口更加通用

可重入函数与线程安全

线程：

　　是操作系统能够进行运算调度的最小单位。它包含在进程之中，是进程中的实际运作单位。一个线程指的是进程中一个单一顺序的控制流，一个进程中可以并发多个线程，每条线程并行执行不同的任务。一般默认一个进程中只包含一个线程。

函数调用堆栈：

　　借助函数调用堆栈可以将我们写的函数调用代码整理成一个顺序执行的指令流，也就是一个线程，每一个线程都有一个独自拥有的函数调用堆栈空间，同一个进程的多个线程是共享其他进程资源的。

可重入函数：可重入（reentrant）函数可以由多于一个任务并发使用，而不必担心数据错误。

线程安全：

　　如果你的代码所在的进程中有多个线程在同时运行，而这些线程可能会同时运行这段代码。如果每次运行结果和单线程运行的结果是一样的，而且其他的变量的值也和预期的是一样的，就是线程安全的。线程安全问题都是由全局变量及静态变量引起的。

Linktable软件模块的线程安全分析：

通过设置信号量mutex，每次只有一个线程可以执行。通过加锁，保证了对pLinkTable的数据的互斥访问。

总结：

　　我们在进行开发时，要深入理解模块化设计、可重用接口、线程安全等方面。模块化的设计有助于提升质量属性，使得代码易于维护和解耦，提高代码功能的内聚程度。使用可重用的接口，隐藏了底层不必要接触的细节。

posted @ 2020-11-04 20:59 AnWX 阅读(231) 评论(0) 收藏举报

刷新页面返回顶部

代码中的软件工程-menu实验

公告