团队作业（三）——任务分工
一、修改需求规格说明书
本次修改，是对整体格式进行了进一步的规范，以及将小的内容分点进行突出列出，并对初版说明书一些表达不恰当的地方进行了修改。
[https://gitee.com/lin-daokun/linear-correlation-group/blob/master/docx]
二、编写代码规范
1. 代码规范
使用有意义的变量和函数命名，避免使用缩写或无意义的名称。
代码缩进应一致，通常使用四个空格作为一个缩进层级。
注释应清晰明了，解释代码的功能、意图和实现方式。
代码文件应按照功能或模块进行组织，遵循一定的目录结构。
避免冗余代码和重复代码，尽量使用函数和类进行封装和复用。
代码应符合编程语言的语法和惯例，避免使用过时或不推荐的语法。
代码应具有一定的文档和注释，方便其他开发人员理解和维护。
代码应合理使用换行，避免过长的代码行，提高代码可读性。
应在适当的位置添加空格和逗号，保证代码的格式整齐。
应在需要强调的地方使用大写字母，例如变量名、方法名等。
2. 代码管理
编写代码时要注意随时保存，每次关闭前进行保存，并定期备份，防止由于断电、硬盘损坏等原因造成代码丢失。
当代码出现问题，其他组员帮助检查。
同一项目组内，最好使用相同的软件编辑器，并使用相同的设置选项。
打开编译器的所有告警开关对程序进行编译。
使用工具软件、代码托管网站对代码进行维护。
3. 编码规范
变量命名：变量名应具有明确的意义，遵循驼峰命名法，避免使用拼音或拼音缩写。
函数命名：函数名应简洁明了，体现函数功能，遵循驼峰命名法。
数据类型：根据实际需求选择合适的数据类型，避免数据类型的滥用。
注释规范：注释应简洁明了，突出重点，便于理解。
4. 编码原则
单一职责原则：一个类或函数应该只有一个责任，只做一件事情。
依赖倒置原则：高层模块不应该依赖于低层模块，而是依赖于抽象。
接口隔离原则：使用多个专门的接口，而不是使用单一的总接口。
最少知识原则：一个对象应该对其他对象有尽可能少的了解，减少对象之间的耦合。
三、数据库设计和ER图
四、后端架构设计
- 文本上传界面
用户认证：admin 字段表明可能需要用户认证模块来处理管理员登录。
文件处理：处理文本文件上传的模块，需要处理文件存储和可能的文件名冲突问题。
数据库：存储用户提交的元数据，如标题 Hello world 和文件名 1.txt。
- API 接口：
登录认证接口。
文件上传接口，接收文件和相关元数据。
操作成功反馈界面
状态管理：用来追踪用户操作状态，以显示操作成功或失败的信息。 - API 接口：
提供操作状态查询接口，返回当前操作的成功或失败状态。
- 登录界面
用户认证：需要用户登录模块，处理用户名和密码的验证。
安全性：使用HTTPS和密码加密来保护用户凭证。
会话管理：创建和管理用户会话，提供安全的登录状态保持。
- API 接口：
用户登录接口，验证凭证并创建会话。
用户登出接口，销毁会话。
- 总体后端架构设计
服务器：使用RESTful API设计。
数据库：
用户表：存储用户信息和加密密码。
文件表：存储文件的元数据和存储路径。
- 认证和授权：
使用JWT（JSON Web Tokens）或类似机制进行状态无关的会话管理。
角色基础的访问控制（RBAC）来限制对敏感操作的访问。
- 文件存储：
选择云存储服务如Amazon S3，或使用服务器的本地存储。
文件名冲突解决策略，例如通过添加唯一标识符来保证文件名的唯一性。
- 服务器端框架：
使用Node.js/Express.js，Ruby on Rails，Django，Spring Boot等，根据实际技术栈和团队熟悉程度决定。
- 安全性
使用SSL/TLS加密所有的通信。
存储密码时，使用强散列函数（如bcrypt）。
对用户输入进行清理，以防止SQL注入等攻击。
- 性能和可伸缩性
使用缓存机制（如Redis）来提升性能。
设计可伸缩的架构，比如使用负载均衡，以应对未来流量增长。
- 开发和部署
使用容器化（如Docker）和持续集成/持续部署（CI/CD）流程。
实施日志记录和监控策略，以便于问题追踪和性能优化。
五、团队分工和WBS图
六、燃尽图及任务完成说明
六、上述任务分工及工作量比例
| 任务 | 完成成员 | 工作量 |
|---|---|---|
| 需求规格说明书的修改与编码规范 | 李文婧 | 1/5 |
| 列出TODOList，燃尽图 | 林道坤 | 1/5 |
| 数据库设计和ER图 | 周擎睿 | 1/5 |
| 项目的后端架构设计 | 张树杰 | 1/5 |
| 确定团队分工 | 宁心宇 | 1/5 |
