README.md · 李方鹏/lg-soar

__项目预览 [https://lgsoar.cn 去看看](https://lgsoar.cn "_blank")__
<br>
__开发文档 <https://gitee.com/lgx1992/lg-soar/wikis/pages>__
<br>
__移动端预览 [https://lgsoar.cn/uniapp 去看看](https://lgsoar.cn/uniapp "_blank")__

## 平台简介

lg-soar是一套全部开源的快速高性能的开发平台，推崇默认为主兼顾扩展个性化配置，具有简单易用不失灵活的特性，具有微服务与单体无缝切换，同一套代码既可以部署成微服务也可以部署成单体、多租户、多数据源、多规则IP白名单拦截、好用的前端查询器、自动签名验签
、自动数据脱敏、敏感数据加密、枚举字典翻译、分布式锁、统一异常处理、统一响应数据格式、丰富的开发工具、redis + caffeine + spring cache的缓存实现
、可插拔的redis支持等丰富的功能，毫无保留给个人及企业免费使用。<https://gitee.com/lgx1992/lg-soar>

* 采用前后端分离的模式
* 后端采用 Spring Boot、MyBatis-plus、swagger、knife4j、easyexcel、redis、mysql
* 微服务   Spring cloud、spring gateway、nacos、feign
* 前端使用 vue3、tdesign、axios、uniapp

## 架构图
<img src="./截图/单体架构图.png"/>
<img src="./截图/微服务架构图.png"/>

## 业务功能
1.  用户管理：用户是系统操作者，该功能主要完成系统用户配置(系统用户只代表当前操作系统的对象，包括但不仅限于人)
2.  组织机构：配置系统组织机构（公司、部门、科室、用户组等），树结构展现。配置角色，角色向上继承
3.  岗位职位：配置系统岗位（CEO、总经理、普通职员），基于部门。配置角色，角色向下包含
4.  角色管理：角色菜单分配、数据权限分配、支持常规角色和 __*向上继承*__ __*向下包含*__（RBAC1）
5.  菜单管理：配置系统菜单、分配权限（前端可见菜单、元素、__*简单易用*__ 的菜单设置分配界面）。
6.  数据权限：按接口、角色进行配置数据权限，可自由配置过滤字段组合方式，__*几乎无需编码*__，灵活实现
7.  权限管理：配置系统权限（接口访问权限）。（__*可自动扫描系统接口生成权限数据*__）
8.  字典管理：对系统中经常使用的一些较为固定的数据进行维护。（__*可自动扫描系统枚举生成字典数据*__）
9.  参数管理：对系统(或用户的)动态配置常用参数。
10. 操作日志：系统操作日志记录和查询；可通过注解或动态配置(无需编码部署，实时生效)的方式实现操作日志记录。
11. 在线用户：当前系统中有效token的管理
12. 代码生成：前后端代码的生成（java、vue），可自动生成到对应的目录下
13. 系统接口：根据业务代码自动生成相关的api接口文档。
14. 服务监控：监视当前系统CPU、内存、磁盘、堆栈等相关信息。
15. 多种登录方式：账号密码登录、临时密码登录、多账户绑定登录、授权码登录(扫码登录)、单点登录、可作为认证中心
16. 文件服务：文件上传、文件秒传、图片缩略图、图片裁剪、业务文件关联管理，支持 __*本地文件*__、__*S3协议*__（例如minIO等）、__*ftp协议*__
17. 信息服务：邮件发送、websocket、sse

# 赞助
开源不易如果该项目对您有帮助，您可以请我喝杯奶茶一瓶汽水，一分一文都是心意。
<table>
    <tr>
        <td><img src="./二维码/微信.jpg" alt="微信"/></td>
        <td><img src="./二维码/支付宝.jpg" alt="支付宝"/></td>
    </tr>
</table>

# 技术交流
<table>
    <tr>
        <td><img src="./二维码/QQ交流群.png" alt="QQ交流群"/></td>
        <td><img src="./二维码/QQ交流群.png" alt="QQ交流群"/></td>
    </tr>
</table>

# 演示图
<table>
    <tr>
        <td><img src="./截图/分配数据权限.png"/></td>
        <td><img src="./截图/分配菜单.png"/></td>
    </tr>
    <tr>
        <td><img src="./截图/数据权限管理1.png"/></td>
        <td><img src="./截图/数据权限管理2.png"/></td>
    </tr>
    <tr>
        <td><img src="./截图/数据字典1.png"/></td>
        <td><img src="./截图/数据字典2.png"/></td>
    </tr>
    <tr>
        <td><img src="./截图/系统其他配置.png"/></td>
        <td><img src="./截图/系统配置.png"/></td>
    </tr>
    <tr>
        <td><img src="./截图/操作日志列表.png"/></td>
        <td><img src="./截图/操作日志详情.png"/></td>
    </tr>
    <tr>
        <td><img src="./截图/组件文档.png"/></td>
        <td><img src="./截图/菜单管理.png"/></td>
    </tr>
    <tr>
        <td><img src="https://foruda.gitee.com/images/1694251227445252167/47dc4710_4914681.png"/></td>
        <td><img src="https://foruda.gitee.com/images/1694251286687412631/15f00bb6_4914681.png"/></td>
    </tr>
    <tr>
        <td><img src="https://foruda.gitee.com/images/1694251330086671666/11a195fa_4914681.png"/></td>
        <td><img src="./截图/操作日志配置.png"/></td>
    </tr>
    <tr>
        <td><img src="./截图/代码生成列表.png"/></td>
        <td><img src="./截图/代码生成java.png"/></td>
    </tr>
    <tr>
        <td><img src="./截图/代码生成web.png"/></td>
        <td><img src="./截图/表格列配置.png"/></td>
    </tr>
    <tr>
        <td><img src="./截图/单点登录子系统管理.png"/></td>
        <td><img src="./截图/在线用户管理.png"/></td>
    </tr>
</table>

# 安装启动
## 单体项目启动
```
环境准备：jdk1.8、maven
1.添加 server 模块下的 pom.xml 文件为maven项目
2.创建数据库 lg-soar (或另起名称需改yml数据源配置)，
3.执行文件 /server/sql/lg_soar.sql，生成表结构
4.执行文件 /server/sql/init.sql，生成初始化数据
5.等maven依赖完全加载，启动 demo-boot 模块下的 SoarBootApplication.java
后端启动完成
```

## 微服务项目启动
```
环境准备：jdk1.8、maven、nacos2.0、seata2.0
1.添加 server 模块下的 pom.xml 文件为maven项目
2.创建数据库 lg-soar (或另起名称需在nacos配置列表修改配置)，
3.执行文件 /server/sql/lg_soar.sql，生成表结构
4.执行文件 /server/sql/init.sql，生成初始化数据
5.启动nacos，访问nacos（http://localhost:8848/nacos）进入配置管理》配置列表
6.点导入配置 》上传文件，选择 项目目录\server\soar-cloud\config\nacos_config_export_20240323170740.zip 导入
7.启动seata，配置文件参考：项目目录\配置文件\seata\application.yml
8.分别启动SoarGatewayApplication、SoarSystemApplication、SoarGeneralApplication、SoarMessageApplication等服务
后端启动完成
```

## 前端启动
```
环境准备：node 12以上
1.在 soar-web-v3-td 目录下执行命令 yarn install 或 npm install
2.等依赖安装完成，在 soar-web-v3-td 目录下执行命令 yarn run dev 或 npm run serve
web端启动完成

在 .env 和 .env.development 文件配置后端接口路径、前端端口等
```

## 系统模块

~~~
server                                  # 后端代码
├── demo-boot                           # 单体示例，可以直接在这个模块下开发你的业务功能
├── demo-cloud                          # 微服务示例，可以直接在这个模块下开发你的业务功能
├── soar                                # lg-soar框架代码实现                        
│    ├── soar-base                      # 基础模块
│    │   ├── soar-common                # 工具模块    
│    │   ├── soar-core                  # 核心模块
│    │   ├── soar-database              # 数据库模块      
│    │   ├── soar-redis                 # redis模块   
│    │   └── soar-spring-mvc            # mvc模块       
│    ├── soar-modules                   # 内置业务模块
│    │   ├── soar-system                # 组织机构、角色、权限、菜单、系统参数、数据字典、操作日志   
│    │   ├── soar-general               # 文件系统、地址区域、页面元素   
│    │   └── soar-message               # websocket、SSE、邮件、站内通知、系统公告 
│    ├── soar-api                       # 内置业务模块对外接口定义（与内置业务模块对应）
│    │   ├── soar-system-api            # soar-system 对外接口定义
│    │   ├── soar-general-api           # soar-general 对外接口定义
│    │   └── soar-message-api           # soar-message 对外接口定义
│    └── soar-feign                     # 内置业务模块feign实现（与内置业务模块对应）
│        ├── soar-system-feign          # soar-system 的feign实现
│        ├── soar-general-feign         # soar-general 的feign实现
│        └── soar-message-feign         # soar-message 的feign实现   
├── soar-cloud                          # 内置业务微服务及网关（与内置业务模块对应）
│   ├── soar-gateway-cloud              # 网关、权限拦截、登录拦截    
│   ├── soar-system-cloud               # soar-system 的微服务启动入口   
│   ├── soar-general-cloud              # soar-general 的微服务启动入口   
│   └── soar-message-cloud              # soar-message 的微服务启动入口   
└── soar-generator                      # 代码生成模块
~~~

# 注解
    @Log：实现简单操作日志功能，并使用线程池保存异步保存操作日志不影响业务功能
    @ClusterLock：实现分布式锁功能，key支持el表达式
    @ClusterFairLock：分布式公平锁
    @ClusterReadLock：分布式读锁
    @ClusterWriteLock：分布式写锁
    @IdempotentByParam：通过请求数据信息摘要的方式实现接口幂等性校验功能
    @IdempotentByToken：通过后端生成唯一key的方式实现接口幂等性
    @IdempotentByKey：通过前端生成唯一key的方式实现接口幂等性
    @DictDefine：在实现 IDict 接口的枚举类加上该注解，可通过扫描生成指定字典信息
    @SignatureVerification 接口验签
    @SignatureIssue 接口数据签名
    @SignContain 数据签名包含字段
    @SignExclude 数据签名排除字段
    @Translate 用于字段和方法：翻译、绑定数据，用于自定义注解：绑定翻译处理器
    @TranslateByEnum 字段翻译注解，根据枚举翻译
    @TranslateByString 字段翻译注解，根据字符串翻译
    @TranslateByDict 字段翻译注解，根据数据字典翻译
    @TranslateByEntity 字段翻译注解，根据实体类翻译
    @TranslateName 自定义翻译后的字段名，默认目标字段名+Name
    @Desensitization：字段脱敏注解，用于配置字段脱敏方式
    @NumberSerialize 数值序列化（基于 java.text.NumberFormat）
    @DecimalSerialize 小数序列化（基于 java.text.DecimalFormat）
    @SoarFormat json格式化，
        日期时间：@SoarFormat("yyyy-MM-dd HH:mm:ss")、@SoarFormat("yyyy-MM-dd")
        数值：@SoarFormat(",##0.00")、@SoarFormat(",##0吨")、@SoarFormat("#.##%")
        脱敏：@SoarFormat("$TM:3****4")、@SoarFormat("$TM:1*1")、@SoarFormat("$TM:3···4")
        自定义替换：@SoarFormat({"<", "&lt;"})、@SoarFormat({"<", "&lt;", ">", "&gt;"})
    
    @BankCard 验证银行卡
    @Chinese 验证中文
    @ContactPhone 验证联系方式（固话和手机）
    @Distinct 验证数据是否重复(前端数组元素是否唯一)
    @Enum 验证提供数据是否符合枚举值
    @FixedPhone 验证固话
    @IdCard 验证身份证号码
    @IP 验证IP地址
    @License 验证营业执照号
    @MobilePhone 验证手机号
    @Id 验证数值id是否有效
    
    @CountMapping 相当于@RequestMapping(path = "count", method = RequestMethod.GET, name = "统计")
    @CreateMapping 相当于@RequestMapping(path = "create", method = RequestMethod.POST, name = "创建")
    @DetailMapping 相当于@RequestMapping(path = "detail", method = RequestMethod.GET, name = "详情")
    @ExistMapping 相当于@RequestMapping(path = "exist", method = RequestMethod.GET, name = "是否存在")
    @ExportMapping 相当于@RequestMapping(path = "export", method = RequestMethod.GET, name = "导出")
    @ImportMapping 相当于@RequestMapping(path = "import", method = RequestMethod.POST, name = "导入")
    @QueryMapping 相当于@RequestMapping(path = "query", method = RequestMethod.GET, name = "查询")
    @RemoveMapping 相当于@RequestMapping(path = "remove", method = RequestMethod.POST, name = "删除")
    @UpdateDisabledMapping 相当于@RequestMapping(path = "updateDisabled", method = RequestMethod.POST, name = "启/禁用")
    @UpdateMapping 相当于@RequestMapping(path = "update", method = RequestMethod.POST, name = "更新")
    @UpdateSortMapping 相当于@RequestMapping(path = "updateSort", method = RequestMethod.POST, name = "修改排序")
    
    @ResourceScanIgnore 系统扫描路径生成权限时忽略，放在类上忽略类内的所有接口，放在方法上忽略当前方法接口
    @SoarQueryIgnore 放在实体属性上，在SoarQuery构造查询条件时忽略该属性
    @SoarQueryField 放在实体属性上，可控制SoarQuery构造查询条件时的行为

# 工具
    SignatureData 数据签名工具
    SpringUtils 用于非Spring bean 类获取 spring bean
    DatetimeUtil 时间工具（格式化、格式解析、时间戳生成）
    AssertUtil 断言工具
    ClassUtils 类扫描工具
    DesensitizationUtil 脱敏工具
    SignatureUtils 数据签名工具（签名、验签）
    TranslateUtils 字段翻译工具
    SpelExpressionUtils spring el表达式支持工具
    DictEnumUtils 
    ExceptionUtil 异常格式工具
    FileUtil 文件工具
    IpUtil IP工具
    ParameterUtil 参数验证工具（类似断言工具）
    PojoUtil 类复制转换工具
    ReflectUtil 反射工具
    SerializeUtil 序列化工具
    Validator 验证器（校验数据）
    DataUtil 数据工具（base64、hex）
    NumberUtil 数值工具
    RandomUtil 随机数工具（随机int、随机long、随机字符串等）
    StringUtil 字符串工具
    SystemUtils 系统工具（内存、硬盘、jvm信息）
    PathMatcher 路径匹配器
    JacksonUtil json工具（对jackson进行封装）
    AESUtil 对称加密工具
    CRCUtil crc算法工具
    CryptoUtils hash加密工具（信息摘要算法工具）
    RSAUtils 非对称加密工具
    ExcelUtil Excel导出导入工具，基于阿里EasyExcel
    SoarQueryUtil 查询条件组装工具
    SoarJWT 自定义jwt实现，具有更简短更快速的特性
    Soar64 类似base64，需要压缩数据存储传输时使用，比如redis key
    TreeData 树形数据接口
    BitSet 位数据set，jdk有类似实现，本实现基于byte，jdk实现基于long，空间利用率比jdk实现高，性能比jdk实现差
    TwoBitSet 双数据set，类似BitSet，但支持四种状态
    
    CurrentUser：当前登录用户

# mybatis 类型处理器
    DynamicJsonTypeHandler 动态json类型数据处理器，数据类型不固定的
    AutoJsonTypeHandler 自动json类型数据处理器（类型固定的）
    AbstractAesHandler Aes对称加密类型处理器（抽象类）
    IntegerAesHandler int类型数据对称加密处理器
    LongAesHandler long类型数据对称加密处理器
    StringAesHandler 字符串类型数据对称加密处理器

# easy-excel 类型转换器
    TranslateConverter 翻译处理转换器需配合翻译注解实现导入导出翻译功能（@Translate系列）
    BooleanConverter 布尔类型转换器

# 异常
    BaseAException 用户异常基础异常类，异常码A开头，表示用户操作或数据不合法等用户原因产生的异常，用户可通过调整操作自行解决
    BaseBException 系统异常基础异常类，异常码B开头，表示系统内部问题，表示系统编码不够完善产生的异常，用户无法解决
    BaseCException 第三方异常基础异常类，异常码C开头，表示调用第三方服务时出现异常，用户无法解决
    AuthenticationException 未登录异常（用户异常）
    PermissionException 无权限异常（用户异常）
    ParameterException 参数不正确异常（用户异常）
    AlgorithmException 加密工具产生的异常（系统异常）

# nginx 配置示例

server {
        listen 80;  
        server_name 你的域名;
        rewrite ^(.*) https://$server_name$1 permanent;     
    }
    
    server {
        listen 443 ssl;
        server_name 你的域名;
        # ssl
        # 改成你的证书的名字
        ssl_certificate  你的域名证书.pem文件;
        # 你的证书的名字
        ssl_certificate_key 你的域名证书.key文件;
        ssl_session_cache    shared:SSL:1m;
        ssl_session_timeout  5m;
        ssl_ciphers  HIGH:!aNULL:!MD5;
        ssl_prefer_server_ciphers  on;

#charset koi8-r;

# 访问日志
        #access_log  logs/host.access.log  main;

# 前端配置
        location / {
            root  /www/apps/szsw/dist/; # 前端根目录
            try_files $uri $uri/ /index.html last;
            index  index.html;
        }
        # 接口配置
        location ^~ /soar-api {
            proxy_pass http://localhost:9001/; # 你的后端服务
            # 请求头设置
            proxy_set_header Host $host;
            proxy_set_header X-Real-IP $remote_addr;  #获取客户端真实IP
            proxy_set_header REMOTE-HOST $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        }
        # 附件配置（通过nginx直接访问文件）
        location /file-root {
            root  /www/apps/szsw/upload; # 文件上传根目录
            rewrite	"^\/file-root(.*)$" $1 break;
            try_files $uri @file-root; # 文件未找到的通过后端服务访问
            expires 7d; 
        }
        # 未发现附件则匹配以下规则（通过后端服务访问文件）
        location @file-root {
            proxy_pass http://localhost:9001/file/preview?path=/file-root$uri;
        }
        
        error_page   500 502 503 504  /50x.html;
        location = /50x.html {
            root   html;
        }
        
        gzip  on;
    }

友情链接：
+ [MyBatis-plus](https://baomidou.com)
+ [knife4j](https://doc.xiaominfo.com)
+ [easyexcel](https://easyexcel.opensource.alibaba.com)
+ [nacos](https://nacos.io/zh-cn)

+ [tdesign](https://tdesign.tencent.com/vue-next)
+ [uniapp](https://uniapp.dcloud.net.cn)
+ [vue](https://cn.vuejs.org/guide/introduction.html)
+ [axios](https://www.axios-http.cn)
+ [dayjs](https://day.js.org)
+ [pinia](https://pinia.web3doc.top)
+ [vite](https://vitejs.cn/guide/)
+ [nodejs](https://nodejs.org/zh-cn)
[each-star](https://each-star.com)

李方鹏/lg-soar

简介

发行版

贡献者

近期动态

李方鹏/lg-soar .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

李方鹏/lg-soar