Skip to content

ishi-o/SimpleManagementSystem

Repository files navigation

项目分工

  • 设计数据库, 最难
  • 开发repositoryentity, 比较简单
  • 开发业务逻辑接口service, 比较难
  • 开发命令行界面接口controller, 简单
  • 制作PPT和攥写文档

项目开发要求

项目配置

  • 本项目所用JDKJDK 21,所用构建器为Spring Boot Maven

  • 如果你用的是VSCode,可以用以下插件和配置:

    • Java
    • Extension Pack for Java
    • Spring Boot Extension Pack

    用户settings.json配置“保存文件时自动格式化”:

    "[java]": {
        "editor.defaultFormatter": "Oracle.oracle-java",
        "editor.formatOnSave": true
    }

项目代码注释

  • 统一使用JavaDoc风格 本项目只对类注释和方法注释作要求 需要对每一个类、每一个接口、每一个方法作注释 属性或方法内部不作要求

  • 类注释风格:

    /**
     * 类功能的简短描述
     *
     * @author 一作
     * @author 二作
     * @since 日期
     * @see 父类
     * @see 接口
     */

    如果希望用tab自动生成,可以在用户的settings.json里添加(或者找一下有没有好用的插件):

    "java.templates.typeComment": [
        "/**",
        " * @author ${user}",
        " * @since",
        " */"
    ],
    
  • 方法注释风格(上述插件应该提供了 tab生成注释的功能):

    /**
     * 方法功能的简短描述
     *
     * @param 参数名 参数1的简短描述
     * @param 参数名 参数2的简短描述
     * @return 返回值的简短描述
     * @throws 异常类型 造成异常1的原因
     * @throws 异常类型 造成异常2的原因
     */

项目标识符命名规范

  • 包名全部小写
  • 类名所有单词的首字母大写
  • 变量名和方法名首个单词全小写,其余单词首字母大写
  • 常量名全部大写
  • 如果为英文单词,有常见缩写则用常见缩写,否则写出全称 如果为中文拼音,必须写出全称

项目功能

项目实现

项目结构

  • 开发一个管理系统,我们将整个项目分为四个模块:数据库模块、数据库访问模块、工具模块、客户端模块,整体项目结构如下:

    src/main/java/com/project/project/
    |————exception/
    |————entity/
    |————repository/
    |————service/
    |————controller/
    
  • 数据库模块:以在我机子上的postgre数据库为主要部��,entity包中的实体类作为映射

  • 数据库访问模块:由repository包完成,是业务代码和数据库模块间的接口

  • 工具模块:由service包完成,任务是进行业务逻辑的封装

  • 客户端模块:由controller完成,任务是处理用户的输入并调用工具模块、输出工具模块返回的内容

数据库模块

  • 使用postgre数据库
  • 这个模块的任务是:
    • 进行需求分析
    • 设计ER模式和关系模式
    • 在数据库中创建设计好的关系、视图、索引等等
    • 把设计好的关系模式交给开发daoentity模块的兄弟
  • 对数据库进行操作,最简单的做法是把脚本发给我,我来���行 如果想调试代码,要访问这个数据库,可以问我要连接url,因为我没有域名,而我的ip总是会变的 或者使用你自己电脑上的数据库,修改一下application.properties即可

repository模块

  • 这个模块的任务是:
    • 编写实体类
    • 编写repository接口
    • 编写接口的实现
  • 对数据库操作的部分同上

其它模块

  • 工具模块的任务是编写并实现业务逻辑接口,例如提供合法性检查的接口
  • 客户端模块的任务是设计命令行界面,给主启动类提供完整的输入输出的解析、提示等

About

大连理工大学小学期Java高级编程大作业

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages