[软工*理解组] 0416第8次会议

2024-02-16 12:15:16

例会时间：4月16日12:30，主持者：郭骏

下次例会时间：4月17日12:30，主持者：杜博玮

一、工作汇报

人员	昨日完成任务	明日要完成的任务
乔玺华	计网实验，休息	学习并制作空教室查询前后端交互
张艺璇	学习登录页面的前后端交互 https://github.com/SE2020-TopUnderstanding/BUAA-Campus-Tools-Frontend/issues/18	编写登录页面的前后端交互
单彦博	完成了课程中心的页面设计 https://github.com/SE2020-TopUnderstanding/BUAA-Campus-Tools-Frontend/issues/7	完成课程中心和后端的交互
胡彬彬	完成加密解密函数、接口、返回格式 https://github.com/SE2020-TopUnderstanding/BUAA-Campus-Tools-Backend/issues/45	制作前端或爬虫的交互
李嘉铖	优化数据库设计，制作供爬虫调用的数据库修改接口 https://github.com/SE2020-TopUnderstanding/BUAA-Campus-Tools-Backend/issues/22	制作前端或爬虫的交互
杜博玮	爬取课程中心DDL https://github.com/SE2020-TopUnderstanding/BUAA-Campus-Tools-Backend/issues/9	整合现有的三个功能
郭骏	提交会议记录，完成Alpha-1阶段验收 https://github.com/SE2020-TopUnderstanding/BUAA-Campus-Tools-Backend/issues/18	继续跟进项目

二、会议截图

三、工作中遇到的困难

Alpha-1阶段验收

现阶段能供参考的打分项实在太少，且与打分项密切相关的Bug、日期等现阶段均无法测试。所以考虑还是Alpha阶段结束时进行打分，此处仅为验收。同理，为了保持和大家打分的一致性，对PM的评价也延后到Alpha阶段结束。

前端：

根据燃尽图，前端进度未达到一半。虽然在Alpha-1阶段不设置时间扣分项，但还是希望前端加快进度，如果真的有困难务必及时沟通，尽量不要耽误进度。

代码方面，我看完了前端的所有PR。张艺璇的代码中存在对行的注释，而乔玺华和单彦博没有什么注释。当然，作为一个前端框架而言，注释的重要性未必像后端那样显著，可以写注释的地方也不是很多，主要是页面设计。

此外，我对Java的Android编程规范不熟悉，不方便在此多加点评，验收成果会主要从功能和体验上来进行评价。个人认为，每一行的注释必要不大，但缺少注释也不太好。建议按组件编写简单的注释，以及对代码中自己设置的数据结构进行必要的注释说明。

后端：

对app的命名方式不太合理，interface，interface2这种命名方式毫无参考价值，这两个APP之间不存在顺序关系，建议学习下方的命名。

将“DDL”错写为“dll”，及时修改。

但是需要注意：1.根据Python的lint规则，注释应当写在函数/类定义一行的下方，如：
```
class query_ddl(APIView):
	"""查询DDL页面
	"""
	def get(self, request, format=None):
        """GET方法，获取ddl
        参数：student_id - 学生学号
        返回值：content - ddl信息
        """
        foo()
```
2.注释没必要写这么长和详细，这些详细的规则定义应当写在接口文档中，因为需要调用这些消息的前端开发者不会看你的源码，而是看文档。希望后端和爬虫能将写接口文档设置为一项重要的issue来完成。

多行注释建议使用三引号"""作为定界符。

以及，定义了错误处理的信息，虽然status code不太符合规范，但是框架是有了，所谓的鲁棒性也更强了。

后端要互相商量好统一的错误处理方式，甚至可以将错误类型和返回信息作为一个utils.py包装在后端中。

爬虫：

杜博玮的代码整体质量偏高，使用OOP模式对爬虫进行编程，注释也比较到位，值得提倡。

目前来说，不清楚这份代码是否有Bug、复用性、性能上的问题，需要等待与后端的交互完全搭建起来之后才可以评价。
加解密：加密算法使用容易实现的算法，以保证前端能够实现加密。
数据库使用本地数据库进行测试，以防迁移出现问题。