# kalvan-framework
**Repository Path**: aron-z/kalvan-framework
## Basic Information
- **Project Name**: kalvan-framework
- **Description**: 安全可靠的金融级分布式后端开发框架，项目基于 spring-cloud 2.2.5 、Nacos、Sentinel、openfeign、Sharding-Jdbc、 Mybatis-Pagehelper、Redis、rocketmq 实现分库分表、读写分离、加密存储、日志脱敏、日志链路跟踪、权限控制 RBAC、菜单动态路由，权限控制按钮级；整合SkyWalking实现服务调用链路监控；整合yapi实现接口文档管理和接口测试管理；自研IDEA插件提供UI设计能力根据表字段进行反转生成整套前端+后端+ORM代码快速开发前后端分离的WEB管理系统
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 11
- **Created**: 2024-04-25
- **Last Updated**: 2024-04-25
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
精简·极致
KV平台
在线演示
在线文档
代码生成器视频教程
腾讯课堂在线视频
-------------------------------------------------------------------------------
* [背景](#背景)
* [快速开始](#快速开始)
* [前端开发](https://gitee.com/spring_thunder/kalvan-admin/tree/master/kalvan-admin-frontend/README.md)
* [后端开发](https://gitee.com/spring_thunder/kalvan-admin/tree/master/kalvan-admin-backend/README.md)
* [微服务开发](https://gitee.com/spring_thunder/kalvan-demo)
* [日志方案](https://gitee.com/spring_thunder/kalvan-framework/tree/master/kalvan-log-slf4j)
* [功能与特性](#功能与特性)
* [基础组件](#基础组件)
* [开发运维](#开发运维)
* [kalvan-admin](#kalvan-admin)
* [功能预览](#功能预览)
* [代码生成插件](#代码生成插件)
* [市场安装](#市场安装)
* [本地安装](#本地安装)
* [使用方法](#使用方法)
* [软件截图](#软件截图)
* [联系交流](#联系交流)
## 背景
> 解放双手：甩掉繁琐、专注服务、专注设计、做高效的工作
>
> 容易维护：设计合理、学习简单、维护简单、做轻松的工作
>
> 追求性能：流量控制、异步解耦、善用缓存、做专业的系统
>
> 稳定安全：数据安全、日志安全、接口安全、做安全的服务
## 快速开始
[官网教程](https://kalvan.store/docs/index-cn)
## 功能与特性
### 基础组件
| 服务 | 使用技术 |进度 | 备注|
|----------|-------------------------|-----------|-----------|
| 注册中心 | Nacos |✅ |服务注册与发现、服务健康监控、服务优雅更新|
| 配置中心 | Nacos |✅ | |
| 消息总线 | SpringCloud Bus+Rocketmq|✅ | |
| 授权认证 | RSA签名加密认证 |✅ | |
| 服务容错 | SpringCloud Sentinel |✅ | |
| 服务调用 | SpringCloud OpenFeign |✅ | |
| 文件存储 | FastDFS |✅ | |
| 任务调度 | Elastic-Job |✅ | |
| 分库分表、数据库加密 | Sharding-jdbc |✅ | |
| 日志脱敏、日志全链路跟踪|kalvan-log-slf4j|✅ | |
| 缓存中间件 | redis+JetCache |✅ | |
| 消息推送 | 企业微信、邮箱、https |✅ | |
### 开发运维
| 服务 | 使用技术 |进度 | 备注|
|----------|-------------------------|-----------|-----------|
| 接口文档 | yapi |✅ | |
| 接口测试 | yapi+postman |✅ | |
| 代码生成 | 自开发 |✅ | 前后端代码的生成,idea插件市场搜索kalvan-gen |
| 操作审计 | 自开发 |✅ | 系统关键操作日志记录和查询|
| 流量控制 | sentinel |✅ | 框架自研发了redis版本，也可以使用第三方sentinel|
| 日志管理 | ES + Kibana ＋logstash |✅ | |
| 服务监控 | Spring Boot Admin |✅ | |
| 链路追踪 | SkyWalking |✅ | |
| 监控告警 | Grafana、Prometheus |✅ | |
| sql监控 | druid |✅ | |
### kalvan-admin
| 服务 | 使用技术 |进度 | 备注|
|----------|-------------|---------------|-----------|
| 用户管理 | 自开发 |✅ | 用户是系统操作者，该功能主要完成系统用户配置。 |
| 角色管理 | 自开发 |✅ | 角色菜单权限分配、设置角色按机构进行数据范围权限划分。 |
| 菜单管理 | 自开发 |✅ | 配置系统菜单，操作权限，按钮权限标识等。 |
| 字典管理 | 自开发 |✅ | 配置字典转换,页面查询条件下拉、显示、下载自动转换 |
| 审计日志 | 自开发 |✅ | 数据操作审计，支持json记录操作前操作后的内容 |
| 数据安全 | 自开发 |✅ | 日志脱敏、加密存储 |
### 功能预览
**用户登录**
**管理员管理**
**角色管理**
**菜单管理**
**字典管理**
**日志管理**
**插件自动生成demo**
## 代码生成插件
>本人开发工具`idea 2020.2.1`其它版本如不兼容可以升级
### 市场安装
- 进入IDEA 插件管理`Preferences > Plugins > MarketPlace`
- 在输入框搜索 `kalvan-gen` 完成安装
- 重启生效
### 本地安装
- [离线下载](https://note.youdao.com/ynoteshare1/index.html?id=7759b0f54e90123a71101088dbbceda1&type=notebook#/WEBc3464a27644340bf900dd96aa91877fc)
- 进入IDEA 插件管理 `Preferences > Plugins > 设置图标 > Install Plugin From Disk...`
- 选中本地zip包安装重启生效
### 使用方法
1. 选择菜单 `Preferences > Other Settings > kalvan-gen` 进行数据库配置
2. 使用快捷键 ctrl + alt + k 快速打开代码生成插件 或者选择项目右键打开工具
3. 根据需求生成代码
- 选择好后端代码和前端代码输出路径可右键项目打开插件会自动识别
- 输入表名全称,如果是分表下面的分表符需要填写
- 全局勾选需要的功能
- 全字段检查显示的title
- 全字段勾选需要的功能
- 全字段数据转换配置
- 分功能勾选字段补充相关配置
- vue src/router/generator-routers.js 配置组件
- 将生成的菜单sql挂在相应的父菜单下
— 启动运行再个性化修改代码
### 软件截图
## 联系交流
1. email：464441135@qq.com
2. 技术沟通群：请联系本人，群仅为技术交流群，请大家不要讨论政治、发广告等与技术无关的东西。大家如若有问题可以在群里直接发问，我会抽空答复。
**问问题的三要素**
1. 说明背景，使用了哪个模块，要做什么？
2. 怎么输入或操作的得到了什么结果？ 截图，日志
3. 哪里不明白或有什么疑问 ？