项目 | 内容 |
---|---|
课程班级博客链接 | 19级卓越工程师班 |
这个作业要求链接 | 实验三 -- 结对项目 |
我的课程学习目标 | 1、提高自身团队合作能力 2、通过此次实验提高代码编写水平 |
这个作业在哪些方面帮助我实现学习目标 | 1、与同学结对完成本次实验 2、此次代码编写需要具有一定的python基础 |
结对方学号-姓名 | 201971010247-谢宇涵 |
结对方本次博客作业链接 | 结对方本次作业博客 |
本项目Github的仓库链接地址 | 本项目Github的仓库 |
1、实验目的与要求
(1)体验软件项目开发中的两人合作,练习结对编程(Pair programming)。
(2)掌握Github协作开发软件的操作方法。
2、实验内容和步骤
任务1:阅读《现代软件工程—构建之法》第3-4章内容,理解并掌握代码风格规范、代码设计规范、代码复审、结对编程概念;
1、《现代软件工程—构建之法》第3章内容知识总结
(一)对于初级软件工程师的成长,从以下5个方面开始:
1、积累软件开发相关的知识,提升技术技能
2、积累问题领域的知识和经验(例如:对医疗或金融行业的了解)
3、对通用的软件设计思想和软件工程思想的理解。
4、提升职业技能
5、实际成果
其中要注意职业技能和技术技能之间的区别,沟通表达能力,自我管理能力等在IT行业也是相当重要的。在这里也可以扩展阅读《软技能》一书,尤其是要注意沟通能力,好的程序猿应该不仅仅擅长与机器的沟通,与人的沟通方法也很重要。不仅工作上会有促进,生活上也会受益良多。
而工作量和质量的衡量,通常由项目大小、花费时长、每千行代码bug数量、能否按时交付等四个方面进行比较。其中 “ 稳定、一致的交付时间是衡量员工能力的重要方面。”
(二)职业成长上有书中列举了三种评价体系:
1、考级 (职业资格认证、行业协会认证等)
2、Steve McConnell版本(入门->数量->带头人->大师)
3、大公司版本(谷歌和微软等对工程师都有自己的认定标准,书中以微软为例:SDE->SDE II->Senior SDE->Principle SDE等(初级软件开发工程师->中级软件开发工程师->高级软件开发工程师->首席软件开发工程师等)
2、《现代软件工程—构建之法》第4章内容知识总结
(一)代码规范
1、代码风格规范。主要是文字上的规定,看似表面文章,实际上非常重要。
代码风格的原则是:简明,易读,无二义性
包括了:缩进、行宽、括号、断行与空白的{}行、分行、命名、下划线、大小写、注释。
2、代码设计规范。牵扯到程序设计、模块之间的关系、设计模式等方方面面的通用原则。
包括:函数、goto、错误处理。
(二)代码复审
包括:自我复审、同伴复审、团队复审
代码复审的目的:
1、找出代码的错误。
2、发现逻辑错误,程序可以编译通过,但是代码的逻辑是错的
3、发现算法错误,比如使用的算法不够优化,边界条件没有处理好等
4、发现潜在的错误和回归性错误
5、发现可能需要改进的地方
6、教育开发人员,传授经验,让更多的成员熟悉项目各部分的代码,同时熟悉和应用领域相关的实际知识
(三)结对编程
结对编程的好处:
①在开发层次,结对编程能提供更好的设计质量和代码质量,两人合作解决问题的能力更强。
②对开发人员自身来说,结对工作能带来更多的信心,高质量的产出能带来更高的满足感。
③在企业管理层次上,结对能更有效地交流,相互学习和传递经验,分享知识,能更好地应对人员流动。总之,如果运用的得当,结对编程可以取得更高的投入产出比。
(四)两人合作的不同阶段和技巧
1、萌芽阶段
2、磨合阶段
3、规范阶段
4、创造阶段
5、解体阶段
任务2:两两自由结对,对结对方《实验二 软件工程个人项目》的项目成果进行评价,具体要求如下:
(1)对项目博文作业进行阅读并进行评论,评论要点包括:博文结构、博文内容、博文结构与PSP中“任务内容”列的关系、PSP中“计划共完成需要的时间”与“实际完成需要的时间”两列数据的差异化分析与原因探究,将以上评论内容发布到博客评论区。
要求 | 成果 |
---|---|
结对方博客链接 | 实验二博客链接 |
结对方Github项目仓库链接 | 实验二仓库链接 |
实验二博客评论 | 结对方评论链接 |
(2)克隆结对方项目源码到本地机器,阅读并测试运行代码,参照《现代软件工程—构建之法》4.4.3节核查表复审同伴项目代码并记录。
1、克隆结对方项目源码到本地机器
2、阅读并测试运行代码,采用动态规划法求解{0-1}背包问题,并保存在checkresult.txt中,执行效果如下所示:
3、结对方代码核查表:
项目的开发者:谢宇涵
项目的复审者:张萌
提出问题 | 执行情况 |
---|---|
* 概要部分 | |
代码符合需求和规格说明么? | 代码符合需求和规格说明。 |
代码设计是否考虑周全? | 考虑周全。 |
代码可读性如何? | 可读性强。 |
代码容易维护么? | 容易维护。 |
代码的每一行都执行并检查过了吗? | 可执行。 |
* 设计规范部分 | |
设计是否遵从已知的设计模式或项目中常用的模式? | 遵从常用模式。 |
代码有没有依赖于某一平台,是否会影响将来的移植(如Win32到Win64)? | 不会影响移植,不依赖于某一平台。 |
开发者新写的代码能否用已有的Library/SDK/Framework中的功能实现?在本项目中是否存在类似的功能可以调用而不用全部重新实现? | 能;存在,有些代码是可以调用的 |
有没有无用的代码可以清除?(很多人想保留尽可能多的代码,因为以后可能会用上,这样导致程序文件中有很多注释掉的代码,这些代码都可以删除,因为源代码控制已经保存了原来的老代码) | 无。 |
* 代码规范部分 | |
修改的部分符合代码标准和风格么? | 修改的部分不符合代码标准和风格。 |
* 具体代码部分 | |
有没有对错误进行处理?对于调用的外部函数,是否检查了返回值或处理了异常? | 对错误都进行了处理,没有异常。 |
参数传递有无错误,字符串的长度是字节的长度还是字符(可能是单/双字节)的长度,是以0开始计数还是以1开始计数? | 无错误;本项目中是以0开始计数。 |
边界条件是如何处理的?switch语句的default分支是如何处理的?循环有没有可能出现死循环? | switch语句的default分支返回false,没有出现死循环。 |
有没有使用断言(Assert)来保证我们认为不变的条件真的得到满足? | 无。 |
对资源的利用是在哪里申请,在哪里释放的?有没有可能导致资源泄露(内存、文件、各种GUI资源、数据库访问的连接,等等)?有没有优化的空间? | 都在内存中完成,很有可能泄露 |
数据结构中有没有用不到的元素? | 无。 |
* 效能 | |
代码的效能(Performance)如何?最坏的情况如何? | 达到了具体任务的要求。 |
代码中,特别是循环中是否有明显可优化的部分(C++中反复创建类,C#中 string 的操作是否能用StringBuilder 来优化)? | 没有。 |
对于系统和网络调用是否会超时?如何处理? | 目前没有出现超时的现象。假如出现了我们会整理系统,减少运行的进程。 |
* 可读性 | |
代码可读性如何?有没有足够的注释? | 可读性强;代码有足够的注释 |
* 可测试性 | |
代码是否需要更新或创建新的单元测试?针对特定领域的开发(如数据库、网页、多线程等),可以整理专门的核查表。 | 可以继续开发。 |
(3)依据复审结果尝试利用github的Fork、Clone、Push、Pull request、Merge pull request等操作对同伴个人项目仓库的源码进行合作修改。
任务3:设计开发一款{0-1}KP 实例数据集算法实验平台
1、项目开发背景:
采用两人结对编程方式,设计开发一款{0-1}KP 实例数据集算法实验平台,使之具有以下功能:
(1)平台基础功能:实验二 任务3;
(2){0-1}KP 实例数据集需存储在数据库;
(3)平台可动态嵌入任何一个有效的{0-1}KP 实例求解算法,并保存算法实验日志数据;
(4)人机交互界面要求为GUI界面(WEB页面、APP页面都可);
(5)查阅资料,设计遗传算法求解{0-1}KP,并利用此算法测试要求(3);
(6)附加功能:除(1)-(5)外的任意有效平台功能实现。
2、需求分析陈述:
3、软件设计说明:
(1)在实验二-个人项目的基础上进行开发;
(2)人机交互界面通过python来编写GUI界面;
(3)将D{0-1}KP实例数据集存储在数据库,在GUI界面可进行数据的查询;
(4)输入需要绘制散点图或者需要排序的数据集以及数据项后进行散点图的绘制或者数据的排序;
(5)平台动态嵌入有效的D{0-1}KP实例求解算法,并且可以保存算法实验日志数据;
(6)添加遗传算法。在原来个人项目的基础上添加遗传算法,在GUI界面上添加遗传算法的选择按钮。
遗传算法(Genetic Algorithm,GA)最早是由美国的 John holland于20世纪70年代提出,该算法是根据大自然中生物体进化规律而设计提出的。是模拟达尔文生物进化论的自然选择和遗传学机理的生物进化过程的计算模型,是一种通过模拟自然进化过程搜索最优解的方法。该算法通过数学的方式,利用计算机仿真运算,将问题的求解过程转换成类似生物进化中的染色体基因的交叉、变异等过程。在求解较为复杂的组合优化问题时,相对一些常规的优化算法,通常能够较快地获得较好的优化结果。遗传算法已被人们广泛地应用于组合优化、机器学习、信号处理、自适应控制和人工生命等领域。
- 遗传算法的概述图:
4、软件实现及核心功能代码展示
(1)软件实现
(2)核心功能代码展示
- find函数:利用数据库进行数据查询
def find(result=[]):
win1 = tkinter.Toplevel()
win1.title('查询数据')
win1.geometry('500x300')
sw = win1.winfo_screenwidth()
sh = win1.winfo_screenheight()
win1.geometry('+%d+%d' % ((sw - 500) / 2, (sh - 300) / 2))
tkinter.messagebox.showinfo("结果如下", result)
win1.destroy()
- CreateDataBase函数:导入数据库
def CreateDataBase(self):
global i
global d
global cubage
global profit
global weight
global pw
conn = sqlite3.connect('mrsoft.db')
cursor = conn.cursor()
cursor.execute('DROP TABLE IF EXISTS user')
cursor.execute('create table if not exists user (num int(10) primary key,profit int(20), weight int(20))')
cubage[i] = max(list(map(int,re.findall(r'\d+',line[i*8+3]))))
profit[i] = list(map(int,re.findall(r'\d+',line[i*8+5])))
weight[i] = list(map(int,re.findall(r'\d+',line[i*8+7])))
pw[i] = list(map(lambda x:x[0]/x[1],zip(profit[i],weight[i])))
for j in range(0,d):
cursor.execute('insert into user (num,profit,weight) values ("%d","%d","%d")'%(j,profit[i][j],weight[i][j]))
cursor.execute('select * from user')
result=cursor.fetchall()
cursor.close()
conn.commit()
conn.close()
return result
- 遗传算法求解
##初始化,N为种群规模,n为染色体长度
def init(self,N,n):
C = []
for i in range(N):
c = []
for j in range(n):
a = np.random.randint(0,2)
c.append(a)
C.append(c)
return C
##评估函数
# x(i)取值为1表示被选中,取值为0表示未被选中
# w(i)表示各个分量的重量,v(i)表示各个分量的价值,w表示最大承受重量
def fitness(self,C,N,n,W,V,w):
S = []##用于存储被选中的下标
F = []## 用于存放当前该个体的最大价值
for i in range(N):
s = []
h = 0 # 重量
f = 0 # 价值
for j in range(n):
if C[i][j]==1:
if h+W[j]<=w:
h=h+W[j]
f = f+V[j]
s.append(j)
S.append(s)
F.append(f)
return S,F
## 适应值函数,B位返回的种族的基因下标,y为返回的最大值
def best_x(self,F,S,N):
y = 0
x = 0
B = [0]*N
for i in range(N):
if y<F[i]:
x = i
y = F[x]
B = S[x]
return B,y
## 计算比率
def rate(self,x):
p = [0] * len(x)
s = 0
for i in x:
s += i
for i in range(len(x)):
p[i] = x[i] / s
return p
## 选择
def chose(self,p, X, m, n):
X1 = X
r = np.random.rand(m)
for i in range(m):
k = 0
for j in range(n):
k = k + p[j]
if r[i] <= k:
X1[i] = X[j]
break
return X1
## 交配
def match(self,X, m, n, p):
r = np.random.rand(m)
k = [0] * m
for i in range(m):
if r[i] < p:
k[i] = 1
u = v = 0
k[0] = k[0] = 0
for i in range(m):
if k[i]:
if k[u] == 0:
u = i
elif k[v] == 0:
v = i
if k[u] and k[v]:
# print(u,v)
q = np.random.randint(n - 1)
# print(q)
for i in range(q + 1, n):
X[u][i], X[v][i] = X[v][i], X[u][i]
k[u] = 0
k[v] = 0
return X
## 变异
def vari(self,X, m, n, p):
for i in range(m):
for j in range(n):
q = np.random.rand()
if q < p:
X[i][j] = np.random.randint(0,2)
return X
5、程序运行:程序运行时每个功能界面截图。
(1)将{0-1}KP 实例数据集需存储在数据库中(以beibao0.in为例)
(2)人机交互界面通过python来编写GUI界面
- 一级界面
- 二级界面
- 三级界面
(3)绘制散点图(以beibao0.in为例)
(4)数据的排序(以beibao0.in为例)
(5)利用遗传算法进行求解
(6)拓展功能:绘制任意一组以价值/重量为纵轴的折线图(以beibao0.in为例)
6、描述结对的过程,提供两人在讨论、细化和编程时的结对照片(非摆拍)
7、提供此次结对作业的PSP
PSP2.1 | 任务内容 | 计划完成需要的时间(min) | 实际完成需要的时间(min) |
---|---|---|---|
-Planning | 计划 | 20 | 18 |
-Estimate | 估计这个任务需要多少时间,并规划大致工作步骤 | 10 | 16 |
-Development | 开发 | 480 | 460 |
- Analysis | - 需求分析(包括学习新技术) | 12 | 8 |
- Design Spec | - 生产设计文档 | 26 | 27 |
- Design Review | - 设计复审(和同事审核设计文档) | 16 | 15 |
- Coding Standard | - 代码规范(为目前的开发指定合适的规范) | 16 | 17 |
- Design | - 具体设计 | 100 | 120 |
- Coding | - 具体编码 | 300 | 450 |
- Code Review | - 代码复审 | 26 | 18 |
- Test | - 测试(自我测试,修改代码,提交修改) | 60 | 50 |
-Reporting | 报告 | 50 | 50 |
- Postmortem & Process Improvement Plan | - 事后总结,并提出过程改进计划 | 20 | 18 |
8、完成程序开发,将项目源码的完整工程文件提交到Github账号的项目仓库中
小结感受:两人合作真的能够带来1+1>2的效果吗?通过这次结对合作,请谈谈你的感受和体会。
通过对两次实验的实验过程和实现效率进行对比,发现确实两人合作的效果是1+1>2的。在本次实验中我们利用了对方的优势来弥补了自身的一些缺陷,虽然代码的编写不是很完美,但是实验要求基本满足。在实验中我们也遇到了很多困难,例如我们在数据库导入和遗传算法设计中遇到了一些技术性的问题,最后通过两人的协作配合,问题也得到了解决,实验完成。