## 开源组织第一期里程碑 ### 什么是里程碑 项目里程碑是一个具体的目标或可交付成果，标志着项目进度表中的一个重要节点。项目里程碑可以帮助您跟踪项目的进展，并确保您在实现项目最终目标的轨道上。项目里程碑可以衡量一个项目的成败，并帮助指导未来的项目。 ### 规划里程碑的意义 项目里程碑是很重要的，因为可以帮助您跟踪项目进度，衡量项目是否成功，并且指导未来的项目。如果没有项目里程碑，您就很难知道项目是否在朝着正确的方向前进。项目里程碑还帮助您向相关方传达整个项目的状态和进展。 当您将一个截止日期设置为里程碑时，该里程碑是确定您是否在项目范围内实现某项成就的一种方式。这可以是一个项目目标，也可以是一个阶段任务，甚至可以是项目过程中需要实现的较小目标。如果您没有在项目内设置里程碑的话，您可能不知道是否已经达到了目标，并且缺乏量化的数据来判断加快或减缓项目的运行轨迹。 ### 规划里程碑的优点 项目目标是您试图通过您的项目实现的总体目标。而里程碑只是具体的检查点，可以帮助您跟踪项目的进展，确保您可以实现项目目标 ## 里程碑   ## 任务 | 目标描述 | 当前状态 | 多选 | 具体描述 | 备注 | | --- | --- | --- | --- | --- | | 代码风格约束 | 待开始 | 2023-04——2023-05 | 使用Eclipse Code Formatter插件约束 | | | 安装部署教程 | 待开始 | 2023-05——2023-12 | 前后端本地、服务器安装部署教程 | | | 前端js方法、封装 | 待开始 | 2023-05——2023-12 | 能否提供简单易用的公共js方法，比如打开窗口之类的 | | | 完善注释 | 待开始 | 2023-04——2023-05 | 类&方法注释 | | | 模块划分调整 | 待开始 | 2023-05——2023-06 | 业务功能进行pom模块化分割 | | | bug&漏洞、pom升级 | 待开始 | 2023-05——无期 | 使用码云的漏洞扫码工具进行xss、日志漏洞等升级 | | | 接口返回值完善封装 | 待开始 | 2023-05——2023-12 | 完善公共类的封装，是否合理，比如说controller曾的返回对象属性 | | | 模块(maven)命名合理性 | 待开始 | 2023-05——2023-12 | 模块(maven)命名、内类划分是否合理，不合理移动到合理的模块下 | | | 前端优化 | 待开始 | 2023-04——2023-10 | 前端布局调整 | | | 生成代码功能 | 待开始 | 2023-05——2023-12 | 代码生成的前提是后端各个层次curd，前端列表、新增、更新界面的规范化，和10一样能够简单易上手 | | | 文档工具集教程 | 进行中 | 2023-04——2023-12 | 提高开发效率的工具文档完善 | | | pom版本抽离 | 待开始 | 2023-05——2023-12 | 统一抽离出pom版本，统一管理 | | ### 1\. 代码风格约束(已完成) idea 使用Eclipse Code Formatter插件约束需要安装插件Eclipse Code Formatter。 约束xml在项目路径：`.codeStyle/eclipse-codestyle.xml` 当前代码已经由组织成员：说辞([oceangoing](https://gitee.com/ofwangq)) 完成，这里表示感谢。 ### 2\. 文档目标(同步进行) 1. 项目启动环境配置文档，建立快速部署本地、测试、生产环境的高效部署文档手册 2. java安装配置教程 3. idea下载安装\*\*(已完成)\*\* 4. maven 下载安装、配置idea教程 5. git 下载安装配、置idea教程 6. mysql下载安装教程 7. 其他 8. 组织项目下载启动教程 9. 整理前后技术亮点部分，让新手有兴趣参与，让老手有想法 10. 使用依赖(pom)介绍文档 11. 重要配置类说明文档 12. 其他 ### 3\. 前端任务 1. 前端优化 2. 优化UI界面，不限于表格界面、新增界面、更新界面、主界面的排版、样式、颜色搭配 3. 前端js方法、封装 4. 业务模块形成一套通用的curd html部分、js部分的封装，因为生成代码时需要一套前端UI标准模板 5. 去除多余的js或对现有js版本升级迭代 6. 其他 ### 4\. 后端任务 第一阶段：注释补充 与 逻辑优化 1. 按照模块完善代码注释 2. 模块下按照文件夹拆解分配到个人 第二阶段：架构调整 与 功能扩展 1. 当前多模块结构的优化 2. 多数据源（事务）支持 3. 定时任务框架选型(目前用的是储存在内存里的quartz，非常不合理)，需要负责人出方案，然后讨论 4. i18n多语言的支持，需要负责人出方案，然后讨论 5. 全局异常捕获器 与 i18n多语言的支持 6. 新增filter，只在测试环境打印接口请求的header、param、body，方便测试环境调接口 7. 接口返回值修改封装，目前使用返回对象如下： ~~~java public class LenResponse { // 默认成功 private boolean flag = true; private String msg; private JSONObject jsonObj; private Integer status; private Object data; } ~~~ 1. pom版本抽离，pom的版本需要抽离pom的`properties`内 ~~~xml <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <java.version>1.8</java.version> </properties> ~~~ 1. 模块(maven)命名合理性，目前模块命名为前缀`len-`+业务或使用场景命名，是否合理，需要改进 2. 模块划分调整，类所属模块分配是否合理，不合理的移动到合理模块下 3. 代码生成发，提供一套代码生成方案，入参为不同来源，比如表、表结构，中间统一转换成相同格式的元数据，然后利用freemarker模板，根据定义的模板解析生成代码(不限制)