mirror of
https://github.com/zccbbg/wms-ruoyi.git
synced 2024-11-10 09:02:51 +08:00
docs: README.md更新
This commit is contained in:
zccbbg
parent
7d0420b5a4
commit
defe28ccc3
2 changed files with 38 additions and 63 deletions
99
README.md
99
README.md
|
|
@ -9,6 +9,26 @@
|
||||||
> 项目代码、文档 均开源免费可商用 遵循开源协议在项目中保留开源协议文件即可<br>
|
> 项目代码、文档 均开源免费可商用 遵循开源协议在项目中保留开源协议文件即可<br>
|
||||||
活到老写到老 为兴趣而开源 为学习而开源 为让大家真正可以学到技术而开源
|
活到老写到老 为兴趣而开源 为学习而开源 为让大家真正可以学到技术而开源
|
||||||
|
|
||||||
|
若依wms是一套基于若依的wms仓库管理系统，支持lodop和网页打印入库单、出库单。毫无保留给个人及企业免费使用。
|
||||||
|
* 前端采用Vue、Element UI。
|
||||||
|
* 后端采用Spring Boot、Spring Security、Redis & Jwt。
|
||||||
|
* 权限认证使用Jwt，支持多终端认证系统。
|
||||||
|
* 支持加载动态权限菜单，多方式轻松权限控制。
|
||||||
|
* 高效率开发，使用代码生成器可以一键生成前后端代码。
|
||||||
|
|
||||||
|
## 若依wms功能
|
||||||
|
1. 首页：库存预警与到期提醒、基础数据报表展示
|
||||||
|
2. 仓库/库区：管理维护仓库基础数据
|
||||||
|
3. 物料：管理维护物料基础数据
|
||||||
|
4. 客户/供应商：管理维护联系人基础数据
|
||||||
|
5. 入库：创建入库单后包括如下几个状态：暂存、作废、完成入库，入库类型包括：采购入库、外协入库、退货入库，入库单支持网页打印
|
||||||
|
6. 出库：创建出库单后包括如下几个状态：暂存、作废、完成出库，入库类型包括：销售出库、外协出库、调拨出库，出库单支持网页打印
|
||||||
|
7. 移库：创建移库单后包括如下几个状态：暂存、作废、完成移库
|
||||||
|
8. 盘库：创建盘库单后包括如下几个状态：暂存、作废、完成盘库
|
||||||
|
9. 库存看板：查看当前物料库存数量，分仓库、库区、商品三个维度
|
||||||
|
10. 库存记录：查看当前物料库存操作记录
|
||||||
|
11. 库存明细：存放明细，分：仓库库区、商品两个维度
|
||||||
|
|
||||||
## 更新记录
|
## 更新记录
|
||||||
> 参考：[UpdateHistory.md](docs/UpdateHistory.md)
|
> 参考：[UpdateHistory.md](docs/UpdateHistory.md)
|
||||||
|
|
||||||
|
|
@ -24,70 +44,25 @@
|
||||||
#### github
|
#### github
|
||||||
[https://github.com/zccbbg/RuoYi-WMS-VUE](https://github.com/zccbbg/RuoYi-WMS-VUE)
|
[https://github.com/zccbbg/RuoYi-WMS-VUE](https://github.com/zccbbg/RuoYi-WMS-VUE)
|
||||||
|
|
||||||
## 本框架与RuoYi的功能差异
|
## 在线体验
|
||||||
|
- 演示地址：http://kc.ichengle.top
|
||||||
|
|
||||||
| 功能 | 本框架 | RuoYi |
|
## CSDN若依技术专栏
|
||||||
|-------------|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
|
- 常见问题：https://blog.csdn.net/qq_27575627/category_12336113.html
|
||||||
| 前端项目 | 基于vue3-element-admin开源项目重写<br/>Vue3 + TS + ElementPlus | 基于Vue2/Vue3 + JS |
|
- 后端技术：https://blog.csdn.net/qq_27575627/category_12331868.html
|
||||||
| 后端项目结构 | 采用插件化 + 扩展包形式 结构解耦 易于扩展 | 模块相互注入耦合严重难以扩展 |
|
- 前端技术：https://blog.csdn.net/qq_27575627/category_12331867.html
|
||||||
| 后端代码风格 | 严格遵守Alibaba规范与项目统一配置的代码格式化 | 代码书写与常规结构不同阅读障碍大 |
|
- 运维：https://blog.csdn.net/qq_27575627/category_12332546.html
|
||||||
| Web容器 | 采用 Undertow 基于 XNIO 的高性能容器 | 采用 Tomcat |
|
|
||||||
| 权限认证 | 采用 Sa-Token、Jwt 静态使用功能齐全 低耦合 高扩展 | Spring Security 配置繁琐扩展性极差 |
|
|
||||||
| 权限注解 | 采用 Sa-Token 支持注解 登录校验、角色校验、权限校验、二级认证校验、HttpBasic校验、忽略校验<br/>角色与权限校验支持多种条件 如 `AND` `OR` 或 `权限 OR 角色` 等复杂表达式 | 只支持是否存在匹配 |
|
|
||||||
| 缓存数据库 | 支持 Redis 5-7 支持大部分新功能特性 如 分布式限流、分布式队列 | Redis 简单 get set 支持 |
|
|
||||||
| Redis客户端 | 采用 Redisson Redis官方推荐 基于Netty的客户端工具<br/>支持Redis 90%以上的命令 底层优化规避很多不正确的用法 例如: keys被转换为scan<br/>支持单机、哨兵、单主集群、多主集群等模式 | Lettuce + RedisTemplate 支持模式少 工具使用繁琐<br/>连接池采用 common-pool Bug多经常性出问题 |
|
|
||||||
| 缓存注解 | 采用 Spring-Cache 注解 对其扩展了实现支持了更多功能<br/>例如 过期时间 最大空闲时间 组最大长度等 只需一个注解即可完成数据自动缓存 | 需手动编写Redis代码逻辑 |
|
|
||||||
| ORM框架 | 采用 Mybatis-Plus 基于对象几乎不用写SQL全java操作 功能强大插件众多<br/>例如多租户插件 分页插件 乐观锁插件等等 | 采用 Mybatis 基于XML需要手写SQL |
|
|
||||||
| SQL监控 | 采用 p6spy 可输出完整SQL与执行时间监控 | log输出 需手动拼接sql与参数无法快速查看调试问题 |
|
|
||||||
| 数据分页 | 采用 Mybatis-Plus 分页插件<br/>框架对其进行了扩展 对象化分页对象 支持多种方式传参 支持前端多排序 复杂排序 | 采用 PageHelper 仅支持单查询分页 参数只能从param传 只能单排序 功能扩展性差 体验不好 |
|
|
||||||
| 数据权限 | 采用 Mybatis-Plus 插件 自行分析拼接SQL 无感式过滤<br/>只需为Mapper设置好注解条件 支持多种自定义 不限于部门角色 | 采用 注解+aop 实现 基于部门角色 生成的sql兼容性差 不支持其他业务扩展<br/>生成sql后需手动拼接到具体业务sql上 对于多个Mapper查询不起作用 |
|
|
||||||
| 数据脱敏 | 采用 注解 + jackson 序列化期间脱敏 支持不同模块不同的脱敏条件<br/>支持多种策略 如身份证、手机号、地址、邮箱、银行卡等 可自行扩展 | 无 |
|
|
||||||
| 数据加解密 | 采用 注解 + mybatis 拦截器 对存取数据期间自动加解密<br/>支持多种策略 如BASE64、AES、RSA、SM2、SM4等 | 无 |
|
|
||||||
| 数据翻译 | 采用 注解 + jackson 序列化期间动态修改数据 数据进行翻译<br/>支持多种模式: `映射翻译` `直接翻译` `其他扩展条件翻译` 接口化两步即可完成自定义扩展 内置多种翻译实现 | 无 |
|
|
||||||
| 多数据源框架 | 采用 dynamic-datasource 支持世面大部分数据库<br/>通过yml配置即可动态管理异构不同种类的数据库 也可通过前端页面添加数据源<br/>支持spel表达式从请求头参数等条件切换数据源 | 基于 druid 手动编写代码配置数据源 配置繁琐 支持性差 |
|
|
||||||
| 多数据源事务 | 采用 dynamic-datasource 支持多数据源不同种类的数据库事务回滚 | 不支持 |
|
|
||||||
| 数据库连接池 | 采用 HikariCP Spring官方内置连接池 配置简单 以性能与稳定性闻名天下 | 采用 druid bug众多 社区维护差 活跃度低 配置众多繁琐性能一般 |
|
|
||||||
| 数据库主键 | 采用 雪花ID 基于时间戳的 有序增长 唯一ID 再也不用为分库分表 数据合并主键冲突重复而发愁 | 采用 数据库自增ID 支持数据量有限 不支持多数据源主键唯一 |
|
|
||||||
| 序列化 | 采用 Jackson Spring官方内置序列化 靠谱!!! | 采用 fastjson bugjson 远近闻名 |
|
|
||||||
| 分布式幂等 | 参考美团GTIS防重系统简化实现(细节可看文档) | 手动编写注解基于aop实现 |
|
|
||||||
| 文件存储 | 采用 Minio 分布式文件存储 天生支持多机、多硬盘、多分片、多副本存储<br/>支持权限管理 安全可靠 文件可加密存储 | 采用 本机文件存储 文件裸漏 易丢失泄漏 不支持集群有单点效应 |
|
|
||||||
| 云存储 | 采用 AWS S3 协议客户端 支持 七牛、阿里、腾讯 等一切支持S3协议的厂家 | 不支持 |
|
|
||||||
| 短信 | 采用 sms4j 短信融合包 支持数十种短信厂家 只需在yml配置好厂家密钥即可使用 可多厂家共用 | 不支持 |
|
|
||||||
| 邮件 | 采用 mail-api 通用协议支持大部分邮件厂商 | 不支持 |
|
|
||||||
| 接口文档 | 采用 SpringDoc、javadoc 无注解零入侵基于java注释<br/>只需把注释写好 无需再写一大堆的文档注解了 | 采用 Springfox 已停止维护 需要编写大量的注解来支持文档生成 |
|
|
||||||
| 校验框架 | 采用 Validation 支持注解与工具类校验 注解支持国际化 | 仅支持注解 且注解不支持国际化 |
|
|
||||||
| Excel框架 | 采用 Alibaba EasyExcel 基于插件化<br/>框架对其增加了很多功能 例如 自动合并相同内容 自动排列布局 字典翻译等 | 基于 POI 手写实现 功能有限 复杂 扩展性差 |
|
|
||||||
| 工具类框架 | 采用 Hutool、Lombok 上百种工具覆盖90%的使用需求 基于注解自动生成 get set 等简化框架大量代码 | 手写工具稳定性差易出问题 工具数量有限 代码臃肿需自己手写 get set 等 |
|
|
||||||
| 监控框架 | 采用 SpringBoot-Admin 基于SpringBoot官方 actuator 探针机制<br/>实时监控服务状态 框架还为其扩展了在线日志查看监控 | 无 |
|
|
||||||
| 代码生成器 | 只需设计好表结构 一键生成所有crud代码与页面<br/>降低80%的开发量 把精力都投入到业务设计上<br/>框架为其适配MP、SpringDoc规范化代码 同时支持动态多数据源代码生成 | 代码生成原生结构 只支持单数据源生成 |
|
|
||||||
| 项目路径修改 | 提供详细的修改方案文档 并为其做了一些改动 非常简单即可修改成自己想要的 | 需要做很多改造 文档说明有限 |
|
|
||||||
| 国际化 | 基于请求头动态返回不同语种的文本内容 开发难度低 有对应的工具类 支持大部分注解内容国际化 | 只提供基础功能 其他需自行编写扩展 |
|
|
||||||
| 代码单例测试 | 提供单例测试 使用方式编写方法与maven多环境单测插件 | 只提供基础功能 其他需自行编写扩展 |
|
|
||||||
| Demo案例 | 提供框架功能的实际使用案例 单独一个模块提供了很多很全 | 无 |
|
|
||||||
|
|
||||||
|
|
||||||
## 本框架与RuoYi的业务差异
|
|
||||||
|
|
||||||
| 业务 | 功能说明 | 本框架 | RuoYi |
|
|
||||||
|--------|-----------------------------------------|-----|------------------|
|
|
||||||
| 用户管理 | 用户的管理配置 如:新增用户、分配用户所属部门、角色、岗位等 | 支持 | 支持 |
|
|
||||||
| 部门管理 | 配置系统组织机构（公司、部门、小组） 树结构展现支持数据权限 | 支持 | 支持 |
|
|
||||||
| 岗位管理 | 配置系统用户所属担任职务 | 支持 | 支持 |
|
|
||||||
| 菜单管理 | 配置系统菜单、操作权限、按钮权限标识等 | 支持 | 支持 |
|
|
||||||
| 角色管理 | 角色菜单权限分配、设置角色按机构进行数据范围权限划分 | 支持 | 支持 |
|
|
||||||
| 字典管理 | 对系统中经常使用的一些较为固定的数据进行维护 | 支持 | 支持 |
|
|
||||||
| 参数管理 | 对系统动态配置常用参数 | 支持 | 支持 |
|
|
||||||
| 通知公告 | 系统通知公告信息发布维护 | 支持 | 支持 |
|
|
||||||
| 操作日志 | 系统正常操作日志记录和查询 系统异常信息日志记录和查询 | 支持 | 支持 |
|
|
||||||
| 登录日志 | 系统登录日志记录查询包含登录异常 | 支持 | 支持 |
|
|
||||||
| 文件管理 | 系统文件展示、上传、下载、删除等管理 | 支持 | 无 |
|
|
||||||
| 文件配置管理 | 系统文件上传、下载所需要的配置信息动态添加、修改、删除等管理 | 支持 | 无 |
|
|
||||||
| 在线用户管理 | 已登录系统的在线用户信息监控与强制踢出操作 | 支持 | 支持 |
|
|
||||||
| 系统接口 | 根据业务代码自动生成相关的api接口文档 | 支持 | 支持 |
|
|
||||||
| 服务监控 | 监视集群系统CPU、内存、磁盘、堆栈、在线日志、Spring相关配置等 | 支持 | 仅支持单机CPU、内存、磁盘监控 |
|
|
||||||
| 缓存监控 | 对系统的缓存信息查询，命令统计等。 | 支持 | 支持 |
|
|
||||||
| 使用案例 | 系统的一些功能案例 | 支持 | 不支持 |
|
|
||||||
|
|
||||||
## 贡献代码
|
## 贡献代码
|
||||||
|
|
||||||
欢迎各路英雄豪杰 `PR` 代码 请提交到 `dev` 开发分支 统一测试发版
|
欢迎各路英雄豪杰 `PR` 代码 请提交到 `dev` 开发分支 统一测试发版
|
||||||
|
|
||||||
|
## 关于我们
|
||||||
|
开发团队成立于2017年，我们前端开发、后端架构，有一颗热爱开源的心，致力于打造企业级的通用产品设计UI体系让项目 或者更直观，更高效、更简单，未来将持续关注UI交互，持续推出高质量的交互产品。
|
||||||
|
|
||||||
|
## 加群/技术支持
|
||||||
|
|
||||||
|
| 公众号 |
|
||||||
|
|:--------------------------------------:|
|
||||||
|
| <img src="docs/gzh.jpg" width="200px"> |
|
||||||
|
扫公众号二维码，关注后回复：“加群”或“支持”
|
||||||
BIN
docs/gzh.jpg
Normal file
BIN
docs/gzh.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 63 KiB |
Loading…
Reference in a new issue