在一个夜黑风高的晚上,小孩吵着要出去玩,于是和程序员老婆
一起带小孩出去放风,路上顺便讨论起项目要换个什么名字,在各自想出的名字都被对方一一否决后,大家陷入了沉思。
走着走着,在一盏路灯下,孩砸盯着路灯打破宁静,喊出:灯灯~ 我和媳妇愣了一下,然后对视着一起说:哈哈,这个名字好~
灯灯
: 是我小孩学说话时会说的第一个词,也是我在想了很多项目名后,小孩一语点破的一个名字,灯灯象征着光明,给困境的我们带来希望,给加班夜归的程序员们指引前方~
灯灯
(简称灯, 英文名:lamp),他是一个项目的统称,包含以下几个子项目
项目 | gitee | github | 备注 |
---|---|---|---|
工具集 | https://gitee.com/zuihou111/lamp-util | https://github.com/zuihou/lamp-util | 业务无关的工具集,cloud和boot 项目都依赖它 |
微服务版 | https://gitee.com/zuihou111/lamp-cloud | https://github.com/zuihou/lamp-cloud | SpringCloud 版 |
单体版 | https://gitee.com/zuihou111/lamp-boot | https://github.com/zuihou/lamp-boot | SpringBoot 版(和lamp-cloud功能基本一致) |
租户后台 | https://gitee.com/zuihou111/lamp-web | https://github.com/zuihou/lamp-web | PC端管理系统 |
代码生成器 | https://gitee.com/zuihou111/lamp-generator | https://github.com/zuihou/lamp-generator | 给开发人员使用 |
定时调度器 | https://gitee.com/zuihou111/lamp-job | https://github.com/zuihou/lamp-job | 尚未开发 |
lamp-cloud
的前身是zuihou-admin-cloud
,从3.0.0版本开始,改名为lamp-cloud,它是lamp
项目的其中一员。
lamp-cloud
基于SpringCloud(Hoxton.SR9)
+ SpringBoot(2.3.6.RELEASE)
的微服务快速开发平台,其中的可配置的SaaS功能尤其闪耀,
具备RBAC功能、网关统一鉴权、Xss防跨站攻击、自动代码生成、多种存储系统、分布式事务、分布式定时任务等多个模块,支持多业务系统并行开发,
支持多服务并行开发,可以作为后端服务的开发脚手架。代码简洁,注释齐全,架构清晰,非常适合学习和企业作为基础框架使用。
核心技术采用Spring Cloud Alibaba、SpringBoot、Mybatis、Seata、Sentinel、RabbitMQ、FastDFS/MinIO、SkyWalking等主要框架和中间件。
希望能努力打造一套从 JavaWeb基础框架
- 分布式微服务架构
- 持续集成
- 系统监测
的解决方案。本项目旨在实现基础能力,不涉及具体业务。
切记:使用本项目之前,先下载并编译 lamp-util
切记:使用本项目之前,先下载并编译 lamp-util
切记:使用本项目之前,先下载并编译 lamp-util
- master 分支为最新的稳定版本,每次提交都会升级一个版本号
- dev 分支为作者的开发分支,作者开发的最新功能会实时提交上来,喜欢尝鲜的可以切换为dev。 但可能有报错、漏提等,对项目不是很熟的朋友千万别尝试。
- tag 每个固定的版本都会打一个tag方便后续切换任意版本。
本项目真正实现了同一套代码(sql都不用改),只改一个配置类型,即轻松切换项目的 租户模式。
租户模式 | 描述 | 优点 | 缺点 |
---|---|---|---|
NONE(非租户模式) | 没有租户 | 简单、适合独立系统 | 缺少租户系统的优点 |
COLUMN(字段模式) | 租户共用一个数据库,在业务表中增加字段来区分 | 简单、不复杂、开发无感知 | 数据隔离性差、安全性差、数据备份和恢复困难、 |
SCHEMA(独立schema) | 每个租户独立一个 数据库(schema),执行sql时,动态在表名前增加schema | 简单、开发无感知、数据隔离性好 | 配置文件中必须配置数据库的root账号、不支持复杂sql和 sql嵌套自定义函数 |
DATASOURCE(独立数据源) | 每个租户独立一个 数据库(数据源),执行代码时,动态切换数据源 | 可独立部署数据库,数据隔离性好、扩展性高、故障影响小 | 相对复杂、开发需要注意切换数据源时的事务问题、需要较多的数据库 |
- (已完成) 基于 FEBS-Cloud-Web 改造的前端项目演示地址: http://tangyh.top:10000/lamp-web/
- (正在开发中...)基于 vue-admin-beautiful 改造的前端项目演示地址: http://tangyh.top:180
- (敬请期待...)基于 ant-design 开发的前端项目演示地址:???
- 以下内置账号仅限于内置的0000租户
- 平台管理员: lamp_pt/lamp (内置给公司内部运营人员使用)
- 超级管理员: lamp/lamp
- 普通管理员: general/lamp
- 普通账号: normal/lamp
ps: 演示环境中内置租户没有写入权限,若要在演示环境测试增删改,请使用lamp_pt账号查询租户管理员账号后,登录新租户测试
- 租户管理:运营人员管理所有的租户创建
- 工作台:普通用户常用功能
- 组织管理:组织、岗位、用户数据维护、重置用户密码等
- 资源中心:消息、短信、附件管理
- 流程管理:流程部署、模型管理、流程示例
- 系统设置:菜单、资源配置、角色管理、给角色绑定用户、给角色授权菜单和资源、字典、地区、系统参数、操作日志、登录日志、应用管理等
- 网关设置:限流和阻止访问
- 开发者管理:定时任务、接口文档、注册&配置中心、服务监控、数据库监控、zipkin监控、SkyWalking监控
-
服务注册&发现与调用:
基于Nacos来实现的服务注册与发现,使用使用Feign来实现服务互调, 可以做到使用HTTP请求远程调用时能与调用本地方法一样的编码体验,开发者完全感知不到这是远程方法,更感知不到这是个HTTP请求。
-
负载均衡:
将服务保留的rest进行代理和网关控制,除了平常经常使用的node.js、nginx外,Spring Cloud系列的zuul和ribbon,可以帮我们进行正常的网关管控和负载均衡。其中扩展和借鉴国外项目的扩展基于JWT的Zuul限流插件,方面进行限流。
-
服务鉴权:
通过JWT的方式来加强服务之间调度的权限验证,保证内部服务的安全性。
-
熔断机制:
因为采取了服务的分布,为了避免服务之间的调用“雪崩”,采用了Hystrix的作为熔断器,避免了服务之间的“雪崩”。
-
监控:
利用Spring Boot Admin 来监控各个独立Service的运行状态;利用turbine来实时查看接口的运行状态和调用频率;通过Zipkin来查看各个服务之间的调用链等。
-
链路调用监控:
同时实现了Zipkin和SkyWalking作为本项目的全链路性能监控, 从整体维度到局部维度展示各项指标,将跨应用的所有调用链性能信息集中展现,可方便度量整体和局部性能,并且方便找到故障产生的源头,生产上可极大缩短故障排除时间。
-
数据权限
利用基于Mybatis的DataScopeInnerInterceptor拦截器实现了数据权限功能
-
SaaS(多租户)的无感解决方案
本项目支持3种常见的租户解决方案和无租户方案,同一套代码,修改一个配置即可实现租户模式只有切换。
-
缓存抽象
采用CacheOps操作缓存,内置2种实现:Caffeine、 Redis,可以让项目应急时在无Redis环境正常运行
-
优雅的Bean转换
采用Dozer、BeanUtil等组件来对 DTO、DO、PO等对象的优化转换
-
前后端统一表单验证
严谨的表单验证通常需要 前端+后端同时验证, 但传统的项目,均只能前后端各做一次检验, 后期规则变更,又得前后端同时修改。 故在
hibernate-validator
的基础上封装了lamp-validator-starter
起步依赖,提供一个通用接口,可以获取需要校验表单的规则,然后前端使用后端返回的规则, 以后若规则改变,只需要后端修改即可。 -
防跨站脚本攻击(XSS)
- 通过过滤器对所有请求中的 表单参数 进行过滤
- 通过Json反序列化器实现对所有 application/json 类型的参数 进行过滤
-
当前登录用户信息注入器
- 通过注解实现用户身份注入
-
在线API
由于原生swagger-ui某些功能支持不够友好,故采用了国内开源的
knife4j
,并制作了stater,方便springboot用户使用。 -
代码生成器
基于Mybatis-plus-generator自定义了一套代码生成器, 通过配置数据库字段的注释,自动生成枚举类、数据字典注解、SaveDTO、UpdateDTO、表单验证规则注解、Swagger注解等。
-
定时任务调度器:
基于xxl-job进行了功能增强。(如:指定时间发送任务、执行器和调度器合并项目、多数据源)
-
大文件/断点/分片续传
前端采用webupload.js、后端采用NIO实现了大文件断点分片续传,启动Eureka、Zuul、File服务后,直接打开docs/chunkUploadDemo/demo.html即可进行测试。 经测试,本地限制堆栈最大内存128M启动File服务,5分钟内能成功上传4.6G+的大文件,正式服耗时则会受到用户带宽和服务器带宽的影响,时间比较长。
-
分布式事务
集成了阿里的分布式事务中间件:seata,以 高效 并且对业务 0侵入 的方式,解决 微服务 场景下面临的分布式事务问题。
-
跨表、跨库、跨服务的关联数据自动注入器
用于解决跨表、跨库、跨服务分页数据的属性或单个对象的属性 回显关联数据之痛, 支持对静态数据属性(数据字典)、动态主键数据进行自动注入。
-
灰度发布
为了解决频繁的服务更新上线,版本回退,快速迭代,公司内部协同开发,本项目采用修改ribbon的负载均衡策略来实现来灰度发布。
- 所涉及的相关的技术有:
- JSON序列化:Jackson
- 消息队列:RabbitMQ
- 缓存:Redis
- 数据库: MySQL 5.7.9 或者 MySQL 8.0.19
- 定时器:采用xxl-job项目进行二次改造
- 前端:vue + element-ui
- 持久层框架: Mybatis-plus
- 代码生成器:基于Mybatis-plus-generator自定义
- API网关:Gateway/zuul
- 服务注册&发现和配置中心: Nacos
- 服务消费:OpenFeign
- 负载均衡:Ribbon
- 服务熔断:Hystrix
- 项目构建:Maven
- 分布式事务: seata
- 分布式系统的流量防卫兵: Sentinel
- 监控: spring-boot-admin
- 链路调用跟踪: zipkin/SkyWalking
- 文件服务器:FastDFS 5.0.5/阿里云OSS/本地存储/MinIO
- Nginx
- 部署方面:
- 服务器:CentOS
- Jenkins
- Docker
- Kubernetes
预览 | 预览 |
---|---|
- 63202894(主群 满员请加群2)
- 1011148503(群2)
ps: gitee捐献 或者 二维码打赏(本页最下方): 45元及以上 并 备注邮箱,可得离线开发文档一份 (支持后续更新) (该文档跟看云上的文档一致!)
打赏或者捐献后直接加群:1039545140 并备注打赏时填写的邮箱,可以持续的获取最新的文档。
发现bug请提交 issues
使用项目遇到问题请先查看历史 discussions ,未找到解决方案,在提交discussions(问题描述详细一些,报错截图大一些,复现步骤全一些)
本项目分为开源版和会员版,github和gitee上能搜索到的为开源版本,遵循Apache协议。 会员版源码在私有gitlab托管,购买后开通账号。
会员版和开源版区别请看:会员版
- 微服务快速开发平台:https://github.com/zuihou/lamp-cloud
- 单体快速开发平台:https://github.com/zuihou/lamp-boot
- MyBatis-Plus:https://mybatis.plus/
- knife4j:http://doc.xiaominfo.com/
- hutool:https://hutool.cn/
- xxl-job:http://www.xuxueli.com/xxl-job/
- kkfileview:https://kkfileview.keking.cn
- FEBS Cloud Web: https://gitee.com/mrbirdd/FEBS-Cloud-Web lamp-web 基于本项目改造, 感谢 wuyouzhuguli
- Cloud-Platform: https://gitee.com/geek_qi/cloud-platform 作者学习时接触到的第一个微服务项目
- vue-admin-beautiful : 前端框架