渔船产品功能说明文档1.0

线上地址：http://101.200.121.215:9090/

git前端: https://gitee.com/cinblx/fishboat-ui.git

git后端：https://gitee.com/cinblx/fishboat-server.git

产品介绍

为什么使用该产品

该产品致力于两方面。1.实现基础功能，提供二次开发基础版本；2.结合实际生产设计提供实用性功能。

本产品相对其他一些产品核心特点

功能架构（关键内容）

权限控制

系统菜单、按钮等关联某个权限点；

每个角色可以关联多个权限点。如：角色：配置管理员，具备权限点：权限配置、菜单配置等

每个用户可以关联多个角色；

控制：操作某个功能时，通过当前用户查询关联所有权限点和当前操作功能需要权限点比对，存在即具备权限

低代码设计

表配置：通过配置数据生成表基础信息，包括字段信息、表信息等

实体配置：对每种需要管理的实体通过一个实体ID管理配置表示，配置实体的基础属性信息，详细见低代码管理

查询配置：通过配置实现一个常规查询需要具备的内容

动态管理页面：基于实体配置生成动态CRUD表单操作

动态查询页面：基于查询配置生成查询页面

环境部署

主要技术选型：vue（elementUI）、springboot、springcloud、mysql、redis

前端：下载代码在根路径执行：npm install， 完成后执行npm run dev即可

配置：.env.development 配置开发环境后端地址

后端： maven工程，下载代码后正常编译打包启动即可

配置：结合springboot配置文件进行本地化配置

三方服务分发

第三方服务接入，对于前端请求，后端接收后需要转发到其他服务上去。

配置：配置第三方服务路径名和注册中心注册服务名，如果请求路径第一段匹配上则转发到对应目标服务上

代码控制：com/fishboat/framework/filter/ServiceProxyFilter.java

首页

公告

系统管理里可以管理公告，首页显示最近公告记录，点击标题进入公告阅读

快捷操作

显示具备权限的操作菜单项

日历便签

首页右侧显示日历情况，双击日期进入当天标签记录，日期下面有蓝色横杠表示当前有便签

基础管理

部门/用户管理

包括：部门增、删、查、改，用户：增、删、查、改、禁用、启用、重置密码、角色分配

权限点管理

角色管理

权限:可以对单个角色添加其关联的权限点清单，进而控制用户和权限之后关系

字典管理

定义系统或者用户使用的离散值列表

字典项：管理字典项列表清单

清除缓存：指定字典进行redis缓存清除

字典项管理内容：编码、名称、顺序、状态、风格

风格：该字典项在结合使用过程中展示效果，如公告中等级为“重要”显示效果如下

状态：在功能使用中，只展示有效状态选项

组件管理

结合前端开发配置，配置前端view页面路径，用于系统菜单动态配置

标准动态查询(dynamic/DynamicQuery):该组件为系统的特殊组件，结合后续配置零代码实现动态查询

菜单管理

只有有效菜单才能显示使用

管理菜单内容主要包括：名称、图标、顺序、状态、类型、权限等

权限：具备该权限点的用户才能看到该功能（用户->角色->权限，详见系统权限控制）

类型：目录：表示为树形目录，有下一层；菜单项：表示为叶子节点，没有下一级，点击会进入具体功能页面

组件：如果类型是菜单项显示该设置，下拉框为系统配置的组件列表，点击该菜单时，系统自动打开该组件对应前端页面

路由参数：设置该页面打开时，router中携带的参数

公告管理

管理公告，用于首页显示。

公告在确认之后可以设置为草稿状态，该类无法在首页查看。确认之后可以点击发布变为已发布状态，可以在首页阅读。

低代码管理

实现目标：基础CRUD 零代码实现

功能分析：

查询页面：查询条件、查询结果、分页、操作功能：新增、删除、修改、查看、其他自定义功能，同时包括权限控制、状态控制、打开页面控制等常用功能

CRUD管理：

打开方式：新增、修改等打开包括：自动添加tab页面、打开为单个对话框

tab页面：用户自定义个性化的管理页面

表单控制：修改、新增等操作时，有哪些属性、属性风格、属性默认值、是否可编辑等

表配置

表类型：常规表建模分为主表、纵表、扩展表、关系表。对于纵表和扩展表需要有对应的主表。

扩展表：对于主表的横向扩充，主键一般为主表的外键

纵表：对于主表的纵表扩充，通过实体ID、属性规格、属性值三者确定唯一性，其中实体ID为主表的主键外键

关系表：暂时未支持低代码

字段管理：记录表的全部字段信息，包括：是否主键、类型、名称等。对于纵表同时需要指定对于实体ID、属性ID、属性值对应用途的字段

自动功能：自动根据数据库系统表配置识别字段信息，无需一个个输入

实体配置

对需要管理的每个实体通过实体ID表示关联，进而配置该类实体的属性信息

管理

管理方式：新增、修改、查看时候以什么样方式打开页面

通用功能：该实体基础管理功能配置：是否启用，校验权限点

管理查询：打开该查看页面时候，查询条件、查询结果等使用哪项配置

tab页面：查看、修改时候支持哪些tab页面扩展，每个tab页面关联哪个组件（前端开发）新增时候不显示

属性

配置该实体具备哪些属性

用途： 该属性在实体上用途，如关键字、第一展示、第二展示、外部实体等。第一展示、第二展示：用于该实体对外展示时候使用哪个字段进行展示，优先第一，相当于该实体名片。外部实体：与外键意义一致，表示该字段来源于其他实体，值为实体ID；动态属性：不对应字段，展示时候通过动态sql展示

风格：页面呈现效果，如：文本框、日期、选项等，其中选项可以通过字典值或者动态sql配置实现

属性存储：物理存储：属性存储到某个表某个字段，逻辑视图：该属性不做存储，在管理查看时候通过动态sql查询实现

新增必填、新增只读、修改必填、不允许修改：字面意思

查询配置

配置动态查询页面如何显示加载

菜单

配置该页面工具栏显示哪些菜单（基础功能在规格管理上配置）

数据依赖：该菜单在什么情况下生效。不需要选择数据：即无效选择数据，任何情况下生效；可选多条数据：即至少选择一条数据时候可用；可选一条数据：即只能在选择一条数据时候使用

组件：点击按钮时候打开的组件页面

校验权限：具备什么权限点才能使用该功能

配置

包括查询页面涉及所有实体属性，查询条件属性，查询结果，排序字段等

属性清单：通过查询依赖的主实体加载实体属性和其依赖的实体(结合实体属性用途为外部实体)属性

动态管理

结合前面实体、查询等配置实体实体的管理页面

菜单配置

需要配置组件为系统特定组件，路由菜单为需要管理的实体ID

动态查询

查询条件：根据查询配置确认有哪些属性、查询方式有哪些、是否必须等，结合实体属性配置确认查询条件是文本框、下拉框、外部查询等，如图点击所属班级后面查询图标打开班级的动态查询页面，并将选择结果显示在该文本框内（显示内容根据属性用途第一展示、第二展示确认），所在班级同理

查询结果：由于学号、姓名配置为第一展示、第二展示所以具备链接功能，点击后进入实体查看页面

同班人数：该属性在实体上为动态属性，不对应实际字段，为动态sql配置查询结果