BallCat项目模块结构
功能模块功能模块和业务无关,非ballcat项目也可以引入这些模块获得功能增强,用户按照实际业务需求选择模块进行集成。包括但不限于以下这些功能 :•数据权限控制,在orm层实现,基于Jsqparse解析Sql,进行权限范围的sql注入•国际化功能,不仅支持spring原生的文件配置形式,还可以自定义动态加载国际化配置•注解使用redis 缓存、分布式锁,防击穿,全局key前缀等功能•注解快速实现excel导入导出功能•支付功能:包括支付宝、微信、USDT虚拟货币等•基于S3协议的对象存储封装,方便一套代码兼容大部分云平台,如阿里云,七牛云,腾讯云目前提供的功能模块列表|--ballcat-common--基础公用组件||--ballcat-common-core--核心组件||--ballcat-common-desensitize--脱敏基础组件||--ballcat-common-i18n--国际化基础组件||--ballcat-common-idempoten--幂等基础组件||--ballcat-common-log--日志基础组件||--ballcat-common-model--公用的一些模型||--ballcat-common-redis--redis基础组件||--ballcat-common-security--安全相关,以及资源服务器配置||--ballcat-common-util--公用的工具|`--ballcat-common-websocket--对于springwebsocket的一些抽象封装|--ballcat-dependencies--ballcat项目本身各子模块的依赖管理,以及第三方模块的依赖管理|--ballcat-extends--扩展模块,大多是对于一些第三方组件的扩展处理||--ballcat-extend-dingtalk--钉钉的一些操作封装||--ballcat-extend-kafka--kafka的一些操作扩展||--ballcat-extend-kafka-stream--kafka流处理的一些操作扩展||--ballcat-extend-mybatis-plus--基于mybatis-plus相关的一些扩展||--ballcat-extend-pay-ali--针对支付宝支付的一些操作封装||--ballcat-extend-pay-virtual--针对虚拟货币支付的一些操作封装||--ballcat-extend-pay-wx--针对微信支付的一些操作封装|`--ballcat-extend-redis-module--redismodule的扩展功能(暂时只有布隆过滤器)|--ballcat-starters||--ballcat-spring-boot-starter-datascope--数据权限控制||--ballcat-spring-boot-starter-dingtalk--钉钉集成工具||--ballcat-spring-boot-starter-easyexcel--通过注解快速导入导出excle(easyexcel)||--ballcat-spring-boot-starter-i18n--国际化方案||--ballcat-spring-boot-starter-job--定时任务集成(目前仅xxl-job)||--ballcat-spring-boot-starter-kafka--消息队列kafka集成||--ballcat-spring-boot-starter-log--访问日志,操作日志,TraceId注入||--ballcat-spring-boot-starter-mail--邮件发送||--ballcat-spring-boot-starter-oss--对象存储(所有支持AWSS3协议的云存储,如阿里云,七牛云,腾讯云)||--ballcat-spring-boot-starter-pay--支付相关||--ballcat-spring-boot-starter-redis--提供注解使用redis,分布式锁,防击穿,全局key前缀等功能||--ballcat-spring-boot-starter-sms--短信接入starter||--ballcat-spring-boot-starter-swagger--swagger文档配置(提供无注册中心的文档聚合方案)||--ballcat-spring-boot-starter-websocket--基于common-websocket的自动配置|`--ballcat-spring-boot-starter-xss--xss防注入相关快速上手环境准备开始之前,请先确保您已经配置好以下环境名称版本JDK1.8MySQL5.7.8+Redis3.2+node10.0+npm6.0+另:请在您的开发工具中安装好 Lombok 插件,Lombok的使用参看其官方文档最新版本的Idea中已经自带了Lombok插件数据库配置•版本:mysql5.7.8+•默认字符集:utf8mb4•默认排序规则:utf8mb4_general_ci按下面顺序依次执行 ballcat/docs 目录下的数据库脚本:#建库语句scheme.sql#核心库ballcat.sql#国际化相关SQL,无需国际化功能则不用执行此处代码ballcat-i18n.sql配置本地hosts建议使用switchHost软件管理hosts配置!也可直接修改本地host文件:windows系统下host文件位于 C:\Windows\System32\drivers\etc\hosts新增如下host:127.0.0.1ballcat-mysql127.0.0.1ballcat-redis127.0.0.1ballcat-admin其中 127.0.0.1 按需替换成开发环境ip服务端准备代码下载gitclonehttps://github.com/ballcat-projects/ballcat-boot.git项目启动直接在开发工具中启动SpringBoot的启动类 AdminApplication 即可前端准备代码下载gitclonehttps://github.com/ballcat-projects/ballcat-ui-vue.git依赖安装安装项目依赖,使用yarn或npm都可以#安装依赖yarninstall-----或者--------#安装依赖npminstall项目启动打开命令行进入项目根目录,或在IDE提供的命令行工具中执行#启动服务yarnserve-----或者-----#启动服务npmrunserve访问项目默认前端项目路径:https://localhost:8000/默认用户名密码:admin/a123456更多文档参看官方文档,快速搭建一章:https://www.ballcat.cn/guide/quick-start.html点击空白处退出提示
评论