小米便签结对泛读报告

目的

• 完成项目部署，能够正常运行
• 采用git管理源码
• 完成相关的用例图，体系结构图，类之间的调用关系图，核心类的主要作用

项目部署

• 下载链接：https://codeload.github.com/MiCode/Notes/zip/master
• 参考链接：https://www.learnerhub.net/#/spaces/146/resources-docs/6353
• 搭建过程中遇到的问题采用的博客链接：https://blog.csdn.net/HINOTOR_/article/details/129895423#:~:text=下载小米便签源代码 下载链接 GitHub - richard0305%2FNotes-master 将源代码转换成gradle项目,打开 Android studio ，依次点击File->New->Import Project， 选择源代码的路径，点击Next 选择gradle项目的下载路径，点击Next
• 部署成功

git的使用

仓库地址：https://gitee.com/GoodNanmu/xiaomi-notes-extensive-reading
1.完成仓库的创建

2.邀请开发者加入（组员）

3.加入队友的ssh密钥

4.在本地创建新分支dev

5.推送到远端仓库

6.在dev分支下面创建“src”和“doc”文件夹

7.Master分支上同步

8.提交报告

9.将报告推送到远端

10.拉取队友新增的文件，用于准备后续的merge操作

11.切换至master，并同步到最新的仓库

12.在本地进行合并

13.将分支推向远端

完成相关的用例图，体系结构图，类之间的调用关系图，核心类的主要作用

(1) 用例图：通过用例图来描述小米便签的主要功能以及它们之间的关系；

(2) 体系结构图（包图）：通过绘制体系结构图来了解整个软件的总体设计思路；

(3) 类之间的调用关系图：通过绘制类之间的调用关系图来掌握微人事（或小米便签）的具体设计；



(4) 核心类的主要作用：通过给出核心类的主要作用来进一步加深对软件设 计的理解。
核心类为 WorkingNote
这里我们首先要了解一下什么是核心类：
核心类在不同的编程语境和框架中可能有不同的定义和用途，但一般来说，它们通常具有以下重要作用：
①　基础功能提供:核心类通常包含程序或框架中最基本、最关键的功能。这些功能通常是其他类所依赖的，是构建更复杂功能的基础。
②　稳定性与可靠性:由于核心类被频繁使用，它们需要具有较高的稳定性和可靠性。这意味着这些类经过了充分的测试和优化，以确保在各种情况下都能正常工作。
③　性能优化:核心类通常也是性能优化的重点。因为它们被频繁调用，所以优化这些类的性能可以直接提高整个程序或框架的运行效率。
④　扩展性与可维护性:核心类通常设计得具有良好的扩展性和可维护性。这意味着它们可以方便地添加新功能或修改现有功能，同时保持代码的稳定性和清晰性。
⑤　统一接口:核心类可以为其他类提供一个统一的接口或协议，使得不同的类之间能够协同工作，实现特定的功能或业务逻辑。
⑥　安全性保障:在涉及到安全性的应用中，核心类可能会包含一些关键的加密、验证或权限控制功能，以确保系统的安全性。

选择他的原因是因为小米便签所有功能都围绕着便签展开，全都以便签作为基础，所以将范围固定在WorkingNote和Note两个类之中。从类图中可以看出WorkingNote与Note是聚合关系，即Note是WorkingNote的一部分切可以单独存在。

根据PPT上的范例，如下图所示：我们也可以类比得到WorkingNote是我们的核心类。

WorkingNote（当前活动便签）的作用：可以实现加载Note（通过数据库找到第一个条目）、加载NoteData、创建空的Note（传入参数：context，文件夹ID，widget，背景颜色）、保存Note、设置mNoteSettingStatusListener、设定删除标记、设定背景颜色、设定检查列表模式、设定WigetType WigetID 、设定WorkingTex、转变mCallData及CallNote信息、判断是否存在时钟、创建接口NoteSettingStatusListener便签更新监视（为NoteEditActivity提供接口）