【项目新功能开发篇】需求分析和开发设计

news2024/11/20 21:30:01

作者介绍：本人笔名姑苏老陈，从事JAVA开发工作十多年了，带过大学刚毕业的实习生，也带过技术团队。最近有个朋友的表弟，马上要大学毕业了，想从事JAVA开发工作，但不知道从何处入手。于是，产生了写一个博客专栏想法，介绍当前互联网企业JAVA项目开发如何快速入门。

本文收录于《30天企业JAVA项目开发实战入门》专栏，该专栏内容以当前互联网软件企业中的项目实战为线索，介绍企业JAVA项目开发中涉及到的开发流程、技术、工具、规范要求等等。帮助想从事JAVA开发的大学生或新人，更快的、更好的入门JAVA后端开发工作。

文章目录

- 一、前言
- 二、需求分析和开发设计
- - - （1）需求分析
    - （2）接口设计
    - （3）数据存储设计
- 三、总结

一、前言

由于本专栏项目实战学习，是以若依开源项目RuoYi-Cloud为示例。所以，本文介绍一下若依开源项目RuoYi-Cloud中若依管理后台系统的新功能开发，如何做需求分析和开发设计，以管理后台系统中的兴趣爱好管理模块开发为示例。

若依项目RuoYi-Cloud简介

若依项目RuoYi-Cloud 是一个 Java EE 企业级的开源免费的快速开发平台，是一个基于Spring Boot、Spring Cloud & Alibaba的微服务的权限管理系统。如果想快速的开发一个Java EE 企业级项目，可以在若依项目的基础上，开发定制自己的项目。尤其是如果要开发一个后台管理系统，由于若依开源项目中已经内置完整的权限管理模块，所以能够更加快速的完成项目的开发工作；
若依项目RuoYi-Cloud技术选型

采用前后端分离的模式，微服务版本前端基于 Vue/Element UI ；
后端采用Spring Boot、Spring Cloud & Alibaba微服务架构；
注册中心、配置中心选型Nacos，权限认证使用Redis；
流量控制框架选型Sentinel，分布式事务选型Seata；
若依项目官方网站和文档地址

若依官网地址：https://www.ruoyi.vip/
若依演示地址：https://vue.ruoyi.vip/login
技术文档地址：https://doc.ruoyi.vip/ruoyi-cloud/
代码下载地址：https://gitee.com/y_project/RuoYi-Cloud

二、需求分析和开发设计

在若依项目RuoYi-Cloud中，开发新的功能模块，如何进行需求分析和开发设计呢？

这里以兴趣爱好管理模块开发为示例，介绍如何进行需求分析和开发设计。其中，开发设计，一般包括接口设计和数据存储设计。

（1）需求分析

首先，要了解兴趣爱好管理模块包括哪些功能。一般在实际项目中，通过召开需求会议的方式，产品人员会给开发人员，介绍产品的功能需求。

兴趣爱好管理模块主页面设计如下：
在这里插入图片描述
兴趣爱好管理模块新增页面设计如下：

兴趣爱好管理模块修改页面设计如下：

兴趣爱好管理模块导出Excel字段内容设计如下：

从以上设计页面可知，兴趣爱好管理模块包括如下功能；

新增：通过新增功能，可以新增一条兴趣爱好记录。其中，新增的内容字段信息包括兴趣爱好编码、兴趣爱好名称、显示顺序、备注；
修改：通过修改功能，可以修改兴趣爱好记录。其中，可以修改的内容字段信息包括兴趣爱好编码、兴趣爱好名称、显示顺序、备注；
删除：通过删除功能，可以删除一条或多条兴趣爱好记录；
查询：通过查询功能，可以根据用户输入的查询条件，查询符合条件的兴趣爱好记录列表；其中，查询条件字段信息包括兴趣爱好编码、兴趣爱好名称、显示顺序；查询的列表信息字段包括兴趣爱好ID、兴趣爱好编码、兴趣爱好名称、显示顺序、状态、备注；
导出：通过导出功能，可以把查询出来的兴趣爱好记录，导出为Excel文档格式；其中，导出的字段信息包括兴趣爱好编码、兴趣爱好名称、显示顺序、状态；
重置：通过重置功能，可以重置查询条件；

（2）接口设计

需求分析完成后，进行后端API接口设计。通过API接口设计，确定API接口的名称、请求URL地址、请求方式、入参、返回值等信息；

接口名称：查询兴趣爱好信息列表
请求URL地址：/system/interest/list
请求方式：get
入参：兴趣爱好编码、兴趣爱好名称、显示顺序
返回值：兴趣爱好ID、兴趣爱好编码、兴趣爱好名称、显示顺序、状态、备注
接口名称：查询兴趣爱好信息详细
请求URL地址：/system/interest/{ interestId}
请求方式：get
入参：兴趣爱好ID
返回值：兴趣爱好ID、兴趣爱好编码、兴趣爱好名称、显示顺序、状态、备注
接口名称：新增兴趣爱好信息
请求URL地址：/system/interest
请求方式：post
入参：兴趣爱好编码、兴趣爱好名称、显示顺序、备注
返回值：无
接口名称：修改兴趣爱好信息
请求URL地址：/system/interest
请求方式：put
入参：兴趣爱好ID、兴趣爱好编码、兴趣爱好名称、显示顺序、备注
返回值：无
接口名称：删除兴趣爱好信息
请求URL地址：/system/interest/{ interestId}
请求方式：delete
入参：兴趣爱好ID字符串
返回值：无
接口名称：导出兴趣爱好信息列表
请求URL地址：/system/interest/export
请求方式：export
入参：兴趣爱好编码、兴趣爱好名称、显示顺序
返回值：兴趣爱好编码、兴趣爱好名称、显示顺序、状态

（3）数据存储设计

之后，进行数据存储设计。计划将兴趣爱好信息记录数据存储在MySQL数据库的兴趣爱好信息表sys_interest中；

其中，兴趣爱好信息表sys_interest结构设计如下：
在这里插入图片描述

兴趣爱好信息表sys_interest创建表的脚本内容如下：

CREATE TABLE `sys_interest` (
 `interest_id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '兴趣爱好ID',
 `interest_code` varchar(64) NOT NULL COMMENT '兴趣爱好编码',
 `interest_name` varchar(128) NOT NULL COMMENT '兴趣爱好名称',
 `interest_sort` int(4) NOT NULL COMMENT '显示顺序',
 `status` char(1) NOT NULL DEFAULT '0' COMMENT '状态（0正常 1停用）',
 `create_by` varchar(64) DEFAULT '' COMMENT '创建者',
 `create_time` datetime DEFAULT NULL COMMENT '创建时间',
 `update_by` varchar(64) DEFAULT '' COMMENT '更新者',
 `update_time` datetime DEFAULT NULL COMMENT '更新时间',
 `remark` varchar(500) DEFAULT NULL COMMENT '备注',
 PRIMARY KEY (`interest_id`)
) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8mb4 COMMENT='兴趣爱好信息表';