Ai编码+流程编排
框架结合Ai大模型微调训练，让Ai更懂框架，只需少量文字描述即可零代码实现部分功能。流程编排Ai开发必备神器，只需拖动配置，即可实现Ai开发的核心功能。
介绍
这是 Cool Admin(Java 版)的在线文档仓库，我们会尽力完善文档。也希望广大开发者粉丝帮助完善文档，积极提交Pull requests，共同参与开源，你的贡献可能给其他人代码巨大的帮助
这是 Cool Admin(Java 版)的在线文档仓库，我们会尽力完善文档。也希望广大开发者粉丝帮助完善文档，积极提交Pull requests，共同参与开源，你的贡献可能给其他人代码巨大的帮助
如果我们的项目对你有用，欢迎加入我们大家庭一起讨论，共创一些美好的事情。
扫一扫加入微信开发交流群
主要是做一些技术教程、技术分享、框架更新、插件分享等内容。你可以在这边了解到一些关于我们框架的最新动态，还可以了解到一些前沿的技术，特别是跟 Ai 相关的，有兴趣的可以关注我们。
COOL 的一些最新资讯、技术分享、框架更新、插件分享等
通过微调大模型学习框架特有写法，实现简单功能从 Api 接口到前端页面的一键生成
为了不过多依赖环境，框架自带基于 springCache 默认实现了两种缓存
spring:
+ # caffeine 缓存
+ cache:
+ type: caffeine
+ file: cache
+
+ #redis 缓存
+# cache:
+# type: redis
+# data:
+# redis:
+# host: 127.0.0.1
+# port: 6379
+# database: 0
+# password:可以选择你想使用的缓存，性能要求比较高或有分布式部署需求的建议配置成 redis
@CacheConfig(cacheNames = {"comm"})
+@Service
+public class DemoCacheServiceImpl implements DemoCacheService {
+ @Cacheable(key = "targetClass + methodName +#p0")
+ @Override
+ public Object test(String id) {
+ System.out.println("我被调用了");
+ return "我被缓存了";
+ }
+}@Service
+public class DemoCacheServiceImpl implements DemoCacheService {
+ @Resource
+ CoolCache coolCache;
+
+ @Override
+ public Object test(String id) {
+ coolCache.set("a", 1);
+ return coolCache.get("a", Integer.class);
+ }
+} public Object logistics(String num) {
+ // 物流单号
+ String num = orderInfoEntity.getLogistics().getNum();
+ String cacheKey = "logistics:" + orderId + ":" + num;
+ // 获取物流信息
+ return coolCache.get(cacheKey, Duration.ofMinutes(30),
+ () -> {
+ // 从第三方 或者DB 获取数据
+ Object invoke = CoolPluginInvokers.invoke("wuliu", "query", num, "");
+ if (ObjUtil.isEmpty(invoke)) {
+ return null;
+ }
+ String result = (String) invoke;
+ return JSONUtil.parseObj(result).get("result");
+ });
+}所有的 controller 都继承自 BaseController，该父类已经实现了以下六个基础方法：add、delete、update、page、list、info，可以大大简化代码，使得 controller 更加简洁。
@Tag(name = "测试CURD", description = "测试CURD")
+@CoolRestController(value = "/cool", api = {"add", "delete", "update", "page", "list", "info"})
+public class AdminDemoInfoController extends BaseController<DemoService, DemoEntity> {
+ @Override
+ protected void init(HttpServletRequest request, JSONObject requestParams) {
+ // 可以在这边实现一下列表数据排序规则,查询条件过滤，返回哪些字段等
+ }
+}这样就默认实现了以下六个接口：
@Tag(name = "测试CURD", description = "测试CURD")
+@CoolRestController(value = "/cool", api = {"add", "delete", "update", "page", "list", "info"})
+public class AdminDemoInfoController extends BaseController<DemoService, DemoEntity> {
+ @Override
+ protected void init(HttpServletRequest request, JSONObject requestParams) {
+ setPageOption(createOp() // 分页查询配置
+ .fieldEq("status") // 字段全匹配，对应请求参数中同名参数
+ .keyWordLikeFields("name", "phone") // 需要模糊查询的字段，对应请求参数中的 keyWord
+ .select("name", "phone", "age") // 返回字段
+ .queryWrapper(QueryWrapper.create())); // 其他查询方式 具体看 https://mybatis-flex.com/zh/base/querywrapper.html文档
+ setListOption(createOp()); // 列表查询 跟分页查询一样
+ }
+}以上是针对Entity单表查询方式，如果我们有需要连表查询，查询另一张表的字段，这样就需要在Entity加上另一张表的的字段，针对这种场景，我们可以使用 自定义的查询方式
public class AppMarketCouponUserController extends BaseController<MarketCouponUserService, MarketCouponUserEntity> {
+ protected void init(HttpServletRequest request, JSONObject requestParams) {
+ setPageOption(
+ createOp()
+ .select(MARKET_COUPON_INFO_ENTITY.ALL_COLUMNS,
+ MARKET_COUPON_USER_ENTITY.STATUS.as("useStatus")) // 查询连表字段
+ .queryWrapper(
+ QueryWrapper.create()
+ .from(MARKET_COUPON_USER_ENTITY)
+ .leftJoin(MARKET_COUPON_INFO_ENTITY) // leftJoin 连表查询
+ .on(MARKET_COUPON_USER_ENTITY.USER_ID.eq(
+ CoolSecurityUtil.getCurrentUserId())
+ .and(MARKET_COUPON_USER_ENTITY.COUPON_ID.eq(
+ MARKET_COUPON_INFO_ENTITY.ID))))
+ .queryModeEnum(QueryModeEnum.CUSTOM) // 自定义查询模式，默认为ENTITY 实体，自定义场景主要使用在关联表查询插件，
+ // 需要返回的字段分布在各个表里，需要组装数据，通过这种方式，就不需要在entity 中加非存储数据库的字段；默认转成map，注意如果该表有json字段，
+ // 需要通过下面的 transform 手动进行转换
+ .asType(Map.class) // 默认为Map，也可以自己定义VO
+ .transform(o -> {
+ Map map = (Map) o; // 没有设置asType ，自定义类型默认为 map
+ if (ObjUtil.isNotEmpty(map.get("condition"))) {
+ map.put("condition",
+ JSONUtil.toBean(map.get("condition").toString(), Map.class));
+ }
+ })); // 其他查询方式 具体看 https://mybatis-flex.com/zh/base/querywrapper.html文档
+ }
+}查询模式queryModeEnum 还有 ENTITY_WITH_RELATIONS, 实体中 使用了关联查询 @RelationOneToMany 如下面这个订单查询，订单产品列表也一并查出
关联查询用法参考：https://mybatis-flex.com/zh/base/relations-query.html
@Getter
+@Setter
+@Table(value = "order_info", comment = "订单信息")
+public class OrderInfoEntity extends BaseEntity<OrderInfoEntity> {
+
+ @Index
+ @ColumnDefine(comment = "用户ID", notNull = true)
+ private Long userId;
+ // ......
+ // 订单商品列表
+ @Ignore
+ @Column(ignore = true)
+ @RelationOneToMany(selfField = "id", targetField = "orderId")
+ private List<OrderGoodsEntity> goodsList;
+}为了方便获取参数，框架封装了一个请求属性，将 URL、表单、body
等参数封装在了一个 JSONObject requestParams，开发者可以从中方便的获取各种参数；
@Tag(name = "测试CURD", description = "测试CURD")
+@CoolRestController(value = "/cool", api = {"add", "delete", "update", "page", "list", "info"})
+public class AdminDemoInfoController extends BaseController<DemoService, DemoEntity> {
+ @Override
+ protected void init(HttpServletRequest request, JSONObject requestParams) {
+ // 可以在这边实现一下列表数据排序规则,查询条件过滤，返回哪些字段等
+ }
+
+ @PostMapping("/test")
+ public R test(@RequestAttribute JSONObject requestparams, String user) {
+ System.out.println(requestparams.getStr("user"));
+ return R.ok();
+ }
+}默认实现了通用的六个接口方法，如果不满足需求，可以在对应的 service 中重写方法。
@Tag(name = "测试CURD", description = "测试CURD")
+@CoolRestController(value = "/cool", api = {"add", "delete", "update", "page", "list", "info"})
+public class AdminDemoInfoController extends BaseController<DemoService, DemoEntity> {
+ @Override
+ protected void init(HttpServletRequest request, JSONObject requestParams) {
+ // 可以在这边实现一下列表数据排序规则,查询条件过滤，返回哪些字段等
+ }
+
+ @Override
+ @PostMapping("/page")
+ protected R page(JSONObject requestParams, CrudOption<DemoEntity> option) {
+ // 重写逻辑
+ return super.page(requestParams, option);
+ }
+}同样也可以对 service 进行重写
@Service
+public class DemoServiceImpl extends BaseServiceImpl<DemoMapper, DemoEntity> implements DemoService {
+ @Override
+ public Object page(JSONObject requestParams, Page<DemoEntity> page, QueryWrapper<DemoEntity> queryWrapper) {
+ // 重写逻辑
+ return super.page(requestParams, page, queryWrapper);
+ }
+}和传统的 controller 对比一下是简化了不少，接下来我们看看实现的原理
// 模块目录
+├── modules
+│ └── demo(模块名)
+│ │ └── controller(接口)
+│ │ │ └── admin(后端接口)
+│ │ │ │ └── AdminDemoInfoController.java
+│ │ │ └── app(前端接口)
+│ │ │ │ └── AppDemoInfoController.java该接口解析的前缀则是 /admin/demo/user/info/xxx
注意
这个解析规则在 v7.1.3(2024-08-25) 版本才有，在历史版本中需在 admin 包下加一级 user 包，否则这个controller eps识别不了
public @interface CoolRestController {
+
+ @AliasFor(annotation = RequestMapping.class)
+ String name() default "";
+
+ @AliasFor(annotation = RequestMapping.class)
+ String[] value() default {};
+
+ String[] api() default {};
+}我们不直接使用 spring 自带的注解，而是对它做一层封装，controller 上加了这个注解后
将由以下这个类实现自动配置模块路由，该类继承了 spring 的 RequestMappingHandlerMapping，并重写了 getMappingForMethod 方法
根据一定规则生成 path，返回给 spring 做解析。
public class AutoPrefixUrlMapping extends RequestMappingHandlerMapping {
+
+ @Override
+ protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType) {
+ CoolRestController[] annotations = handlerType.getAnnotationsByType(CoolRestController.class);
+ RequestMappingInfo info = super.getMappingForMethod(method, handlerType);
+ // ... 按规则组装 path
+ info = info.mutate().paths(path).build().combine(info);
+ return info;
+ }
+}Cool Admin 集成了比 Mybatis-Plus 更加强大的，Mybatis-Flex，详细用法请查看 Mybatis-Flex 官网文档
主要特点；
更轻量：除了 MyBatis 本身，再无任何第三方依赖，因此会带来更高的自主性、把控性和稳定性。在任何一个系统中，依赖越多，稳定性越差。
更灵活：提供了非常灵活的 QueryWrapper，支持关联查询、多表查询、多主键、逻辑删除、乐观锁更新、数据填充、数据脱敏等等。
高性能：通过独特的架构，没有任何 MyBatis 拦截器、在 SQL 执行的过程中，没有任何的 SQL Parse，因此会带来指数级的性能增长。
| 功能或特点 | MyBatis-Flex | MyBatis-Plus | Fluent-MyBatis |
|---|---|---|---|
| 对 entity 的基本增删改查 | ✅ | ✅ | ✅ |
| 分页查询 | ✅ | ✅ | ✅ |
| 分页查询之总量缓存 | ✅ | ✅ | ❌ |
| 分页查询无 SQL 解析设计（更轻量，及更高性能） | ✅ | ❌ | ✅ |
| 多表查询： from 多张表 | ✅ | ❌ | ❌ |
| 多表查询： left join、inner join 等等 | ✅ | ❌ | ✅ |
| 多表查询： union，union all | ✅ | ❌ | ✅ |
| 单主键配置 | ✅ | ✅ | ✅ |
| 多种 id 生成策略 | ✅ | ✅ | ✅ |
| 支持多主键、复合主键 | ✅ | ❌ | ❌ |
| 字段的 typeHandler 配置 | ✅ | ✅ | ✅ |
| 除了 MyBatis，无其他第三方依赖（更轻量） | ✅ | ❌ | ❌ |
| QueryWrapper 是否支持在微服务项目下进行 RPC 传输 | ✅ | ❌ | 未知 |
| 逻辑删除 | ✅ | ✅ | ✅ |
| 乐观锁 | ✅ | ✅ | ✅ |
| SQL 审计 | ✅ | ❌ | ❌ |
| 数据填充 | ✅ | ✅ | ✅ |
| 数据脱敏 | ✅ | ✔️ （收费） | ❌ |
| 字段权限 | ✅ | ✔️ （收费） | ❌ |
| 字段加密 | ✅ | ✔️ （收费） | ❌ |
| 字典回写 | ✅ | ✔️ （收费） | ❌ |
| Db + Row | ✅ | ❌ | ❌ |
| Entity 监听 | ✅ | ❌ | ❌ |
| 多数据源支持 | ✅ | 借助其他框架或收费 | ❌ |
多数据源是否支持 Spring 的事务管理，比如 @Transactional 和 TransactionTemplate 等 | ✅ | ❌ | ❌ |
| 多数据源是否支持 "非 Spring" 项目 | ✅ | ❌ | ❌ |
| 多租户 | ✅ | ✅ | ❌ |
| 动态表名 | ✅ | ✅ | ❌ |
| 动态 Schema | ✅ | ❌ | ❌ |
注意
以上内容来自第三方相关产品的官方文档或第三方平台，若有错误，欢迎纠正。
MyBatis-Flex 支持的数据库类型，如下表格所示，我们还可以通过自定义方言的方式，持续添加更多的数据库支持。
| 数据库 | 描述 |
|---|---|
| mysql | MySQL 数据库 |
| mariadb | MariaDB 数据库 |
| oracle | Oracle11g 及以下数据库 |
| oracle12c | Oracle12c 及以上数据库 |
| db2 | DB2 数据库 |
| H2 | H2 数据库 |
| hsql | HSQL 数据库 |
| sqlite | SQLite 数据库 |
| postgresql | PostgreSQL 数据库 |
| sqlserver2005 | SQLServer2005 数据库 |
| sqlserver | SQLServer 数据库 |
| dm | 达梦数据库 |
| xugu | 虚谷数据库 |
| kingbasees | 人大金仓数据库 |
| phoenix | Phoenix HBase 数据库 |
| gauss | Gauss 数据库 |
| clickhouse | ClickHouse 数据库 |
| gbase | 南大通用(华库)数据库 |
| gbase-8s | 南大通用数据库 GBase 8s |
| oscar | 神通数据库 |
| sybase | Sybase ASE 数据库 |
| OceanBase | OceanBase 数据库 |
| Firebird | Firebird 数据库 |
| derby | Derby 数据库 |
| highgo | 瀚高数据库 |
| cubrid | CUBRID 数据库 |
| goldilocks | GOLDILOCKS 数据库 |
| csiidb | CSIIDB 数据库 |
| hana | SAP_HANA 数据库 |
| impala | Impala 数据库 |
| vertica | Vertica 数据库 |
| xcloud | 行云数据库 |
| redshift | 亚马逊 redshift 数据库 |
| openGauss | 华为 openGauss 数据库 |
| TDengine | TDengine 数据库 |
| informix | Informix 数据库 |
| greenplum | Greenplum 数据库 |
| uxdb | 优炫数据库 |
| Doris | Doris 数据库 |
| Hive SQL | Hive 数据库 |
| lealone | Lealone 数据库 |
| sinodb | 星瑞格数据库 |
注意
虽然 Mybatis-flex 支持很多数据库，但是 Cool Admin 是具体的业务框架，无法做到全部支持，那样工作量太大了。但是它为我们提供了改造的可能，理论上你只需修改一些不兼容的代码就可以正常运行了。
除了 Mysql，我们正在适配：PostgreSQL、Sqlite
根据 Java 实体，自动映射成数据库的表结构。
用过 JPA 的都知道，JPA 有一项重要的能力就是表结构自动维护，这让我们可以可以专注于业务逻辑和实体，而不需要关心数据库的表、列的配置，尤其是开发过程中频繁的新增表及变更表结构，节省了大量手动工作。
框架集成了Auto Table，可以自动创建表，并且支持表字段的修改。
注意
切勿在生产环境开启自动建表功能，因为这可能会造成数据丢失。
注意
以下教程以 Nodejs 版本为例，Java 版本的也可以参考
本部署教程以 node 版本+宝塔为例，其他部署方式也可以参考这个流程。
config/config.prod.ts，查看 midway 官方多环境配置文档；注意
安装
npm install -g pnpm配置淘宝镜像
pnpm config set registry https://registry.npmmirror.com// 命令行安装 pm2
+npm install pm2 -g常用命令
// 启动一个服务
+pm2 start
+// 列出当前的服务
+pm2 list
+// 停止某个服务
+pm2 stop
+// 重启某个服务
+pm2 restart
+// 删除某个服务
+pm2 delete
+// 查看服务的输出日志
+pm2 logscluster 方式启动
// -i 表示 number-instances 实例数量
+// max 表示 PM2将自动检测可用CPU的数量 可以自己指定数量
+pm2 start ./bootstrap.js -i max --name cool-admin(改成自己的应用名称)
+
+// 重启
+pm2 restart cool-admin日志
pm2 logs cool-admin
+
+// 默认的日志位置
+/root/.pm2/logsupstream cool {
+ server 127.0.0.1:8001;
+ }
+server
+{
+ ...
+ # 前端打包完放这边
+ root /home/test/front;
+
+ # 防止刷新404
+ location / {
+ try_files $uri $uri/ /index.html;
+ }
+
+ # 代理服务端地址 访问/api 表示访问服务端接口而不是静态资源
+ location /api/
+ {
+ proxy_pass http://cool/;
+ proxy_set_header Host $host;
+ proxy_set_header X-Real-IP $remote_addr;
+ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+ proxy_set_header REMOTE-HOST $remote_addr;
+
+ proxy_cache_bypass no_cache;
+
+ #缓存相关配置
+ #proxy_cache cache_one;
+ #proxy_cache_key $host$request_uri$is_args$args;
+ #proxy_cache_valid 200 304 301 302 1h;
+
+ #持久化连接相关配置
+ proxy_connect_timeout 3000s;
+ proxy_read_timeout 86400s;
+ proxy_send_timeout 3000s;
+ #proxy_http_version 1.1;
+ #proxy_set_header Upgrade $http_upgrade;
+ #proxy_set_header Connection "upgrade";
+
+ add_header X-Cache $upstream_cache_status;
+
+ #expires 12h;
+ }
+
+ # socket需额外配置
+ location /socket {
+ proxy_pass http://cool/socket;
+ proxy_connect_timeout 3600s; #配置点1
+ proxy_read_timeout 3600s; #配置点2,如果没效,可以考虑这个时间配置长一点
+ proxy_send_timeout 3600s; #配置点3
+ proxy_set_header Host $host;
+ proxy_set_header X-Real-IP $remote_addr;
+ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+ proxy_set_header REMOTE-HOST $remote_addr;
+ #proxy_bind $remote_addr transparent;
+ proxy_http_version 1.1;
+ proxy_set_header Upgrade $http_upgrade;
+ proxy_set_header Connection "upgrade";
+ rewrite /socket/(.*) /$1 break;
+ proxy_redirect off;
+
+ }
+}docker 部署的配置方式可以参考普通的部署方式，以下是 docker 部署的简单流程；
注意
打包镜像之前，需要确保前端和后端在本地运行过一次，让前端能够自动生成eps.json文件，该文件是前端自动扫描后端接口生成的，有了该文件，前端不需要特意写调用接口的 service。
如果你是自动化部署，你需要把生成的eps.json也提交到代码仓库，否则你将无法正常访问你的 api 接口。
// 创建docker network
+docker network create cool
+
+// 打包后端镜像
+docker build -t cool-admin-midway:1.0 .
+
+// 打包前端镜像
+docker build -t cool-admin-vue:1.0 .// 运行后端
+docker run --network cool -p 8001:8001 --name midway cool-admin-midway:1.0
+
+// 运行后端
+docker run --network cool -p 80:80 --name vue cool-admin-vue:1.0docker 部署，建议将缓存换成 redis，文件上传换成云存储，如：oss，防止操作不当导致的数据丢失。
`,37),p=[h];function t(k,e,r,d,E,F){return a(),i("div",null,p)}const c=s(l,[["render",t]]);export{o as __pageData,c as default}; diff --git a/.vitepress/dist/assets/src_guide_deploy.md.CVc1dXEU.lean.js b/.vitepress/dist/assets/src_guide_deploy.md.CVc1dXEU.lean.js new file mode 100644 index 0000000..7e144c8 --- /dev/null +++ b/.vitepress/dist/assets/src_guide_deploy.md.CVc1dXEU.lean.js @@ -0,0 +1 @@ +import{_ as s,a as i,o as a,aj as n}from"./chunks/framework.BjhQB2K5.js";const o=JSON.parse('{"title":"项目部署","description":"","frontmatter":{},"headers":[],"relativePath":"src/guide/deploy.md","filePath":"src/guide/deploy.md","lastUpdated":1721207284000}'),l={name:"src/guide/deploy.md"},h=n("",37),p=[h];function t(k,e,r,d,E,F){return a(),i("div",null,p)}const c=s(l,[["render",t]]);export{o as __pageData,c as default}; diff --git a/.vitepress/dist/assets/src_guide_dev.md.DM1UjwvK.js b/.vitepress/dist/assets/src_guide_dev.md.DM1UjwvK.js new file mode 100644 index 0000000..a4efa0d --- /dev/null +++ b/.vitepress/dist/assets/src_guide_dev.md.DM1UjwvK.js @@ -0,0 +1,16 @@ +import{_ as s}from"./chunks/code.VH4xl6Z5.js";import{_ as i,a,o as n,aj as e}from"./chunks/framework.BjhQB2K5.js";const l="/guide/gen-vue.png",u=JSON.parse('{"title":"开发方式","description":"","frontmatter":{},"headers":[],"relativePath":"src/guide/dev.md","filePath":"src/guide/dev.md","lastUpdated":1721036629000}'),t={name:"src/guide/dev.md"},p=e('Cool Admin 推荐两种快速开发方式，可以大大节省开发时间，降低开发成本，提高开发效率。
零代码开发(非低代码)，通过微调大模型学习框架特有写法，实现简单功能从 Api 接口到前端页面的一键生成
开发过程只需点一点，调一调，不用写一行代码
只需三步，创建实体类生成表，生成后端代码，生成前端代码
文件：src/test/java/com/cool/CoolAdminJavaApplicationTests.java
public class CoolCodeGeneratorTest {
+ public static void main(String[] args) {
+ CodeGenerator codeGenerator = new CodeGenerator();
+ codeGenerator.init();
+
+ CodeModel codeModel = new CodeModel();
+ codeModel.setType(CodeTypeEnum.ADMIN);
+ codeModel.setName("测试CURD");
+ codeModel.setModule("demo");
+ codeModel.setEntity(DemoEntity.class);
+
+ codeGenerator.controller(codeModel);
+ codeGenerator.mapper(codeModel);
+ codeGenerator.service(codeModel);
+ }
+}Ui 组件会根据字段智能选择
项目按照模块化的方式组织，每个模块都有其特有的功能，清晰明了便于管理。
.
+main
+├─ java
+│ ├─ com.cool
+│ ├─ core 核心包
+│ │ ├─ annotation
+│ │ └─ ...
+│ ├─ modules 模块包
+│ │ ├─ base 基础模块（系统用户、菜单、资源、角色）
+│ │ │ ├─ controller
+│ │ │ ├─ entity
+│ │ │ ├─ mapper
+│ │ │ └─ service
+│ │ ├─ dict 字段模块
+│ │ ├─ plugin 插件模块
+│ │ ├─ recycle 数据回收站模块
+│ │ ├─ space 文件管理模块
+│ │ ├─ task 定时任务模块
+│ │ └─ user 用户管理模块(c端用户)
+│ └─ CoolApplication
+└─ resources 资源文件
+ ├─ cool
+ │ └─ data
+ │ └─ db 初始化数据json文件
+ └─ mapper mapper xml 文件提示
比如你有一个订单管理的模块，在 modules 新增一个 order 包，在 order 包下创建 controller、entity、mapper、service 等包
提供了简化的业务异常抛出工具
@RestControllerAdvice
+@Slf4j
+public class CoolExceptionHandler {
+
+ @ExceptionHandler(CoolException.class)
+ public R handleRRException(CoolException e) {
+ R r = new R();
+ r.put("code", e.getCode());
+ r.put("message", e.getMessage());
+
+ return r;
+ }
+
+ @ExceptionHandler(DuplicateKeyException.class)
+ public R handleDuplicateKeyException(DuplicateKeyException e) {
+ log.error(e.getMessage(), e);
+ return R.error("已存在该记录");
+ }
+
+ @ExceptionHandler(BadCredentialsException.class)
+ public R handleBadCredentialsException(BadCredentialsException e) {
+ log.error(e.getMessage(), e);
+ return R.error("账户密码不正确");
+ }
+
+ @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
+ public R handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e) {
+ log.error(e.getMessage(), e);
+ return R.error("不支持该请求方式，请区分POST、GET等请求方式是否正确");
+ }
+
+ @ExceptionHandler(IllegalArgumentException.class)
+ public R handleIllegalArgumentException(IllegalArgumentException e) {
+ log.error(e.getMessage(), e);
+ return R.error(e.getMessage());
+ }
+
+ @ExceptionHandler(Exception.class)
+ public R handleException(Exception e) {
+ log.error(e.getMessage(), e);
+ return R.error();
+ }
+}一般抛异常写法
public Long add(JSONObject requestParams, BaseSysUserEntity entity) {
+ BaseSysUserEntity check = getOne(
+ Wrappers.<BaseSysUserEntity>lambdaQuery().eq(BaseSysUserEntity::getUsername, entity.getUsername()));
+ if (check != null) {
+ throw new CoolException("用户名已存在");
+ }
+ entity.setPassword(MD5.create().digestHex(entity.getPassword()));
+ super.add(requestParams, entity);
+ return entity.getId();
+}系统提供了 业务校验的工具，无需手动通过 if 判断，在 手动抛异常 通过 CoolPreconditions.check 方法第一个参数如果为 true 即抛异常，异常信息为 "用户名已存在", 会更加简洁
public Long add(JSONObject requestParams, BaseSysUserEntity entity) {
+ BaseSysUserEntity check = getOne(
+ Wrappers.<BaseSysUserEntity>lambdaQuery().eq(BaseSysUserEntity::getUsername, entity.getUsername()));
+ CoolPreconditions.check(check != null, "用户名已存在");
+ entity.setPassword(MD5.create().digestHex(entity.getPassword()));
+ super.add(requestParams, entity);
+ return entity.getId();
+}开发 Ai 应用必备！！！
随着 Ai 的火热，很多应用希望接入 Ai 的能力，但是每次都是用代码手搓，容易把我们累死，而是也非常不灵活。
于是我们面向开发者和软件开发公司，做了一个 Ai 流程编排功能，结合知识库，通过拖动配置，很容易就能完成一个 Ai 的核心流程。
因此如果你需要开发 Ai 相关应用，这个可能会给你带来巨大的帮助。
i18n（Internationalization 的缩写，首末字符 i 和 n 之间有 18 个字母）是软件国际化的标准缩写。它是指让软件支持多种语言和地区的功能，使得同一个软件可以面向不同语言地区的用户，显示相应的语言界面。
随着互联网的发展，越来越多的企业开始走向国际化，多语言的支持已经成为了一个必备的功能。Cool Admin 也对此做了支持。
多语言是需要前后端共同支持的，前端请前往前端文档查看
与其它实现方案不同的是，Cool Admin前后端的多语言都是基于大模型翻译的（比传统机翻更加准确），无需手动配置，只要开启就能自动翻译，而且不需要改变任何原有代码。
以前该怎么写还是怎么写！！！
1、引入插件 在官网下载并安装国际化多语言插件
安装后，框架就会自动扫描并翻译成对应的语言。
当你在控制台看到这样的输出，则代表成功
// 翻译中
+/ i18n translate...
+// 翻译成功
+✅国际化 翻译 成功！！！2、实现原理 只要开启并配置了国际化，在开发环境下重启，框架就会自动扫描菜单、字典、异常消息（CoolPreconditions.check...），并调用大模型对其进行翻译
翻译完成之后会默认在路径assets/i18n下生成对应种类的语言文件，如果这个文件存在
则该种类的国际化将不会进行翻译，也就是后续你有新增相关的内容，要让其再次翻译，得对应地删除相应的文件。
3、语言配置对照表
有些功能模块上线时，需要初始化一些数据
可以在 resources 下的 cool/data/db 目录创建 demo.json 文件
json 格式如下,demo 为表的名称，里面是个数组，数组里可以包含多个对象，每个对象中的 key 为表的字段，value 为对应的值
规范：实体需以 Entity 结尾
{
+ "demo": [
+ {
+ "keyName": "rich",
+ "name": "富文本参数",
+ "remark": null
+ },
+ {
+ "keyName": "json",
+ "name": "JSON参数",
+ "remark": null
+ }
+ ]
+}创建 demo.json 文件后，在项目启动的时候会去加载该文件，并实现值的插入
处理逻辑在以下方法
package com.cool.core;
+
+
+/**
+ * 数据库初始数据初始化 在 classpath:cool/data/db 目录下创建.json文件 并定义表数据，
+ * 由该类统一执行初始化
+ **/
+@Slf4j
+@RequiredArgsConstructor
+public class DBFromJsonInit implements ApplicationRunner {
+ @Override
+ public void run(ApplicationArguments args) {
+ // 初始化自定义的数据
+ extractedDb();
+ // 初始化菜单数据
+ extractedMenu();
+ log.info("数据初始化完成！");
+ }
+ //......
+}`,10),t=[l];function h(k,e,E,d,r,o){return a(),i("div",null,t)}const y=s(p,[["render",h]]);export{g as __pageData,y as default}; diff --git a/.vitepress/dist/assets/src_guide_initData.md.BhdPvNop.lean.js b/.vitepress/dist/assets/src_guide_initData.md.BhdPvNop.lean.js new file mode 100644 index 0000000..bff8e46 --- /dev/null +++ b/.vitepress/dist/assets/src_guide_initData.md.BhdPvNop.lean.js @@ -0,0 +1 @@ +import{_ as s,a as i,o as a,aj as n}from"./chunks/framework.BjhQB2K5.js";const g=JSON.parse('{"title":"数据初始化","description":"","frontmatter":{},"headers":[],"relativePath":"src/guide/initData.md","filePath":"src/guide/initData.md","lastUpdated":1721812009000}'),p={name:"src/guide/initData.md"},l=n("",10),t=[l];function h(k,e,E,d,r,o){return a(),i("div",null,t)}const y=s(p,[["render",h]]);export{g as __pageData,y as default}; diff --git a/.vitepress/dist/assets/src_guide_lock.md.C8JTDlsP.js b/.vitepress/dist/assets/src_guide_lock.md.C8JTDlsP.js new file mode 100644 index 0000000..350dd71 --- /dev/null +++ b/.vitepress/dist/assets/src_guide_lock.md.C8JTDlsP.js @@ -0,0 +1,11 @@ +import{_ as a,a as s,o as n,aj as e}from"./chunks/framework.BjhQB2K5.js";const h=JSON.parse('{"title":"锁","description":"","frontmatter":{},"headers":[],"relativePath":"src/guide/lock.md","filePath":"src/guide/lock.md","lastUpdated":1724694022000}'),p={name:"src/guide/lock.md"},t=e(`注意：如果同一张表历史已经有初始化过数据，在某个版本需要新增数据的话，要新增一个.json 文件;
比如 demoV2.json, 如果在原文件直接修改将不生效，加载成功后文件名称将被当作唯一键标识，不会重复初始化。
简单锁的使用
如果项目中启用了redis，锁是基于redis 实现，否则使用 ReentrantLock
// 注入锁
+private final CoolLock coolLock;
+
+String key = "lockKey";
+// 尝试获取锁
+if (coolLock.tryLock(key, Duration.ofMillis(noRepeatSubmit.expireTime()))) {
+ // TODO 获取锁后的逻辑
+
+ // 释放锁
+ coolLock.unlock(key);
+}基于用户维度的防重复提交，该接口需要登录鉴权
@Aspect
+@Component
+@RequiredArgsConstructor
+public class NoRepeatSubmitAspect {
+
+ private final CoolLock coolLock;
+
+ @Around("@annotation(noRepeatSubmit)")
+ public Object around(ProceedingJoinPoint joinPoint, NoRepeatSubmit noRepeatSubmit) throws Throwable {
+ HttpServletRequest request = ((ServletRequestAttributes) Objects.requireNonNull(
+ RequestContextHolder.getRequestAttributes())).getRequest();
+ String key = request.getRequestURI() + ":" + CoolSecurityUtil.getCurrentUserId();
+ // 加锁
+ CoolPreconditions.check(!coolLock.tryLock(key, Duration.ofMillis(noRepeatSubmit.expireTime())), "请勿重复操作");
+ try {
+ return joinPoint.proceed();
+ } finally {
+ // 移除锁
+ coolLock.unlock(key);
+ }
+ }
+}使用 在controller接口上加上 @NoRepeatSubmit 注解
@Operation(summary = "'领取优惠券'")
+ @PostMapping("/receive")
+ @NoRepeatSubmit
+ public R receive(@RequestAttribute() JSONObject requestParams) {
+ Long couponId = requestParams.get("couponId", Long.class);
+ return R.ok(marketCouponInfoService.receive(couponId, CoolSecurityUtil.getCurrentUserId()));
+ }为了丰富系统功能，我们提供了插件系统，可以通过插件的方式来扩展系统功能。
而不用一味地堆功能，导致系统臃肿。你可以自己开发插件，也可以使用别人开发的插件。
首先下载插件包，然后在系统中安装插件包。插件包可以通过官网下载插件。
打开后台管理系统，点击左侧菜单扩展管理/插件管理，点击+按钮，选择插件包进行安装。
安装插件之后，就可以在代码中调用插件的方法了。
package com.cool.core.base.controller;
+
+import cn.hutool.core.util.ObjUtil;
+import com.cool.core.util.CoolPluginInvokers;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.ResponseBody;
+
+@Controller
+@RequiredArgsConstructor
+public class CommonController {
+
+ @PostMapping("/testPlugin/invokeMethod")
+ @ResponseBody
+ public String invokeMethod(@RequestParam String key, @RequestParam String methodName) {
+ Object result = null;
+ if (ObjUtil.isEmpty(methodName)) {
+ result = CoolPluginInvokers.invokePlugin(key);
+ } else {
+ result = CoolPluginInvokers.invokePlugin(key, methodName);
+ }
+ System.out.println(result);
+ return "invokeMethod Result: " + result;
+ }
+}运行结果
2024-07-13T20:01:18.543+08:00 INFO 32615 --- [cool-admin-java] [nio-8001-exec-5] com.cool.core.util.CoolPluginInvokers : 调用插件类: test, 方法: invokePlugin 参数: []
+Hello invokePlugin
+2024-07-13T20:01:18.543+08:00 DEBUG 32615 --- [cool-admin-java] [ task-5] c.c.m.b.m.sys.BaseSysLogMapper.insert : ==> Preparing: INSERT INTO \`base_sys_log\`(\`action\`, \`ip\`, \`params\`, \`create_time\`, \`update_time\`) VALUES (?, ?, ?, now(), now())
+2024-07-13T20:01:18.544+08:00 DEBUG 32615 --- [cool-admin-java] [ task-5] c.c.m.b.m.sys.BaseSysLogMapper.insert : ==> Parameters: /testPlugin/invokeMethod(String), 127.0.0.1(String), {"key":"test"}(String)
+2024-07-13T20:01:18.554+08:00 DEBUG 32615 --- [cool-admin-java] [ task-5] c.c.m.b.m.sys.BaseSysLogMapper.insert : <== Updates: 1
+2024-07-13T20:01:18.557+08:00 INFO 32615 --- [cool-admin-java] [nio-8001-exec-5] com.cool.core.plugin.BaseCoolPlugin : 调用主应用: coolCache, 方法: set
+2024-07-13T20:01:18.558+08:00 INFO 32615 --- [cool-admin-java] [nio-8001-exec-5] com.cool.core.plugin.BaseCoolPlugin : 调用主应用: coolCache, 方法: get
+缓存结果：一个项目用COOL就够了
+2024-07-13T20:01:18.559+08:00 INFO 32615 --- [cool-admin-java] [nio-8001-exec-5] com.cool.core.plugin.BaseCoolPlugin : 调用主应用: coolPluginService, 方法: getInstance
+2024-07-13T20:01:18.564+08:00 INFO 32615 --- [cool-admin-java] [nio-8001-exec-5] com.cool.core.plugin.BaseCoolPlugin : 调用其他插件aliyun-oss, 方法: invokePlugin
+{OSSAccessKeyId=LTAI5t8xtPD99YzSJQCC, signature=krlJ0Uv96TBliAgPJI/KyI=, success_action_status=200, host=https://xxx.oss-cn-hangzhou.aliyuncs.com, policy=eyJleHB0wNy0xM1QxMjowMTo0OC41NjVaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MDBdXX0=}
+ ______ ___ ___ _____ _ ______ ____ ____ _____ ____ _____
+ .' ___ | .' \`. .' \`.|_ _| V7.x / \\ |_ _ \`.|_ \\ / _||_ _||_ \\|_ _|
+/ .' \\_|/ .-. \\/ .-. \\ | | ______ / _ \\ | | \`. \\ | \\/ | | | | \\ | |
+| | | | | || | | | | | _|______|/ ___ \\ | | | | | |\\ /| | | | | |\\ \\| |
+\\ \`.___.'\\\\ \`-' /\\ \`-' /_| |__/ | _/ / \\ \\_ _| |_.' /_| |_\\/_| |_ _| |_ _| |_\\ |_
+ \`.____ .' \`.___.' \`.___.'|________| |____| |____||______.'|_____||_____||_____||_____|\\____|
+:: https://java.cool-admin.com ::
+Hello invokePlugin对应插件内的方法
package com.cool.plugin;
+
+import cn.hutool.core.io.IoUtil;
+import cn.hutool.core.util.StrUtil;
+import com.cool.core.annotation.CoolPlugin;
+import com.cool.core.plugin.BaseCoolPlugin;
+import java.io.InputStream;
+import lombok.extern.slf4j.Slf4j;
+
+/**
+ * - 类必须要有 @CoolPlugin 注解，一个插件jar有且只能有一个类被 @CoolPlugin 注解
+ * - 类必须继承 BaseCoolPlugin, 并实现 invokePlugin
+ * 插件方法
+ */
+@Slf4j
+@CoolPlugin
+public class MyCoolPlugin extends BaseCoolPlugin {
+
+ @Override
+ public Object invokePlugin(String... params) {
+ System.out.println("Hello invokePlugin");
+ useCache();
+ usePlugin();
+ getParentResource();
+ return "Hello invokePlugin";
+ }
+
+ /**
+ * 使用缓存，使用cool-admin的缓存，开发的时候只是模拟
+ */
+ private void useCache() {
+ // 调用主应用设置缓存
+ invokeMain("coolCache", "set", "a", "一个项目用COOL就够了");
+ // 调用主应用获取缓存
+ Object cache =
+ invokeMain("coolCache", "get", "a");
+ System.out.println("缓存结果：" + cache);
+ }
+
+ /**
+ * 调用其他插件
+ */
+ private void usePlugin() {
+ // 获得其他插件，开发的时候无法调试，只有安装到cool-admin中才能调试 xxx 为插件key
+ Object result = invokeOtherPlugin("aliyun-oss", "invokePlugin");
+ System.out.println(result);
+ }
+
+ /**
+ * 获取主应用resources目录下的资源文件
+ */
+ private void getParentResource() {
+ ClassLoader classLoader = getClass().getClassLoader();
+ ClassLoader parentClassLoader = classLoader.getParent();
+ // 获取主应用resources下的 banner.txt 文件内容
+ InputStream inputStream = parentClassLoader.getResourceAsStream("banner.txt");
+ System.out.println(StrUtil.str(IoUtil.readBytes(inputStream), "UTF-8"));
+ }
+}其中我们可以在插件包里通过 invokeMain 方法去调用主应用的一些对象方法
比如 coolCache 缓存对象, 通过反射实现
在加载 jar 包时会想该插件注入 ApplicationContext，使得可以在插件中获取主应用中的 bean
有时候开发时的配置和生产环境的配置是不一样的，我们可以通过配置文件来实现。
例如原本的配置文件是这样的
{
+ "appId": "xxxxx",
+ "appSecret": "xxxxx",
+ "filePath": "banner.txt"
+}其中 banner.txt 为主应用 resources 资源目录下的文件，路径可以自己指定，范围在 resources 下
为了方便开发插件和统一插件开发规范，我们提供了插件脚手架，可以快速开发我们的插件。
脚手架源码仓库：
https://github.com/cool-team-official/cool-admin-java-plugin
或
https://gitee.com/cool-team-official/cool-admin-java-plugin
.
+main
+├─ java
+│ └─ com.cool
+│ ├─core 核心包
+│ │ ├─ annotation
+│ │ └─ ...
+│ └─ plugin
+│ └─ MyCoolPlugin 插件包，插件类放在这个包下,在打包的时候选择要打包的插件，加上@CoolPlugin注解
+├─ resources
+│ └─ plugin.json 插件信息配置文件
+test
+│
+│─ java
+│ └─ com.cool.plugin
+│ └─ MyCoolPluginTest 插件运行测试类{
+ "name": "测试",
+ "key": "demo-plugin",
+ "hook": "",
+ "version": "1.0.0",
+ "description": "插件描述",
+ "author": "作者",
+ "logo": "assets/logo.png",
+ "readme": "assets/README.md",
+ "config": {
+ "aaa": "xxx",
+ "bbb": "xxx"
+ }
+}config 是插件的配置信息，不同的插件有不同的配置，上面只是个例子，实际开发中可以根据自己的需求来配置,在后台插件管理里可以动态修改
| 字段 | 说明 |
|---|---|
| name | 角色数组 |
| key | 插件唯一标识 |
| hook | 插件钩子，比如替换系统的上传组件，upload |
| version | 版本号 |
| description | 插件描述 |
| author | 作者 |
| logo | 插件 logo，建议尺寸 256x256 |
| readme | 插件介绍，会展示在插件的详情中 |
| config | 插件配置， 每个插件的配置各不相同 |
package com.cool.plugin;
+
+import com.cool.core.annotation.CoolPlugin;
+import com.cool.core.plugin.BaseCoolPlugin;
+import net.sourceforge.pinyin4j.PinyinHelper;
+import net.sourceforge.pinyin4j.format.HanyuPinyinOutputFormat;
+import net.sourceforge.pinyin4j.format.HanyuPinyinToneType;
+import net.sourceforge.pinyin4j.format.exception.BadHanyuPinyinOutputFormatCombination;
+
+/**
+ * - 类必须要有 @CoolPlugin 注解，一个插件jar有且只能有一个类被 @CoolPlugin 注解
+ * - 类必须继承 BaseCoolPlugin
+ */
+@CoolPlugin
+public class DemoCoolPlugin extends BaseCoolPlugin {
+
+ @Override
+ public Object invokePlugin(String... params) {
+ String chineseChar = params[0]; // 汉字字符
+ HanyuPinyinOutputFormat format = new HanyuPinyinOutputFormat();
+ format.setToneType(HanyuPinyinToneType.WITHOUT_TONE); // 不带声调
+
+ String pinyin = null;
+ try {
+ pinyin = PinyinHelper.toHanyuPinyinString(chineseChar, format, "");
+ } catch (BadHanyuPinyinOutputFormatCombination e) {
+ throw new RuntimeException(e);
+ }
+ System.out.println("汉字：" + chineseChar + "，拼音：" + pinyin);
+ Object cache = invokeMain("coolCache", "get", "verify:img:4fd03504-47ac-4b57-b8e4-3c64059230d0");
+ return String.format("hello，%s 我是插件", chineseChar);
+ }
+}<dependency>
+ <groupId>cn.hutool</groupId>
+ <artifactId>hutool-all</artifactId>
+ <version>5.8.26</version>
+</dependency>
+<!--***以上包在主应用已经引入，避免插件过大不会在打入jar包中***-->
+<!--***为了开发插件如果引入了主应用已经有的maven依赖可以在下面的 maven-shade-plugin 中排除掉不打入jar***-->
+<!--以下包会打入jar，主应用没有这些依赖，不然调用时会报错-->
+<dependency>
+ <groupId>com.belerweb</groupId>
+ <artifactId>pinyin4j</artifactId>
+ <version>2.5.0</version>
+</dependency>在我们脚手架上你可以发现，我们还引入了其他包 springframework、hutool 等，这会使得打包结果很臃肿，这边使用到了 maven-shade-plugin maven 插件可以在打包的时候将在我们 cool-admin-java 主应用项目已经有的依赖给排除掉，避免打包结果过大
<!--***为了开发插件如果引入了主应用已经有的maven依赖可以在下面的 maven-shade-plugin 中排除掉不打入jar***-->
+<build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-shade-plugin</artifactId>
+ <version>3.2.4</version>
+ <executions>
+ <execution>
+ <phase>package</phase>
+ <goals>
+ <goal>shade</goal>
+ </goals>
+ <configuration>
+ <artifactSet>
+ <excludes>
+ <!--主应用以有这些依赖，打包时可以排除-->
+ <exclude>org.springframework:spring-beans</exclude>
+ <exclude>org.springframework:spring-core</exclude>
+ <exclude>org.springframework:spring-jcl</exclude>
+ <exclude>org.springframework:spring-context</exclude>
+ <exclude>org.springframework:spring-aop</exclude>
+ <exclude>org.springframework:spring-expression</exclude>
+ <exclude>io.micrometer:micrometer-observation:jar</exclude>
+ <exclude>io.micrometer:micrometer-commons:jar</exclude>
+ <exclude>jakarta.annotation:jakarta.annotation-api</exclude>
+ <exclude>org.slf4j:slf4j-api</exclude>
+ <exclude>org.projectlombok:lombok</exclude>
+ <exclude>cn.hutool:hutool-core</exclude>
+ <exclude>cn.hutool:hutool-json</exclude>
+ <exclude>org.springframework:spring-beans</exclude>
+ <exclude>io.micrometer:micrometer-observation</exclude>
+ <exclude>io.micrometer:micrometer-commons</exclude>
+ </excludes>
+ </artifactSet>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+</build>在执行打包的过程，可以在打包日志中查看我们排除和引入了哪些包
[INFO] --- maven-shade-plugin:3.2.4:shade (default) @ cool-admin-java-plugin ---
+[INFO] Including com.belerweb:pinyin4j:jar:2.5.0 in the shaded jar.
+[INFO] Excluding org.springframework:spring-beans:jar:6.1.6 from the shaded jar.
+[INFO] Excluding org.springframework:spring-core:jar:6.1.6 from the shaded jar.
+[INFO] Excluding org.springframework:spring-jcl:jar:6.1.6 from the shaded jar.
+[INFO] Excluding org.springframework:spring-context:jar:6.1.6 from the shaded jar.
+[INFO] Excluding org.springframework:spring-aop:jar:6.1.6 from the shaded jar.
+[INFO] Excluding org.springframework:spring-expression:jar:6.1.6 from the shaded jar.
+[INFO] Excluding io.micrometer:micrometer-observation:jar:1.12.5 from the shaded jar.
+[INFO] Excluding io.micrometer:micrometer-commons:jar:1.12.5 from the shaded jar.
+[INFO] Excluding jakarta.annotation:jakarta.annotation-api:jar:2.1.1 from the shaded jar.
+[INFO] Excluding org.slf4j:slf4j-api:jar:2.0.13 from the shaded jar.
+[INFO] Excluding org.projectlombok:lombok:jar:1.18.32 from the shaded jar.
+[INFO] Excluding cn.hutool:hutool-core:jar:5.8.26 from the shaded jar.
+[INFO] Excluding cn.hutool:hutool-json:jar:5.8.26 from the shaded jar.打包命令
mvn clean package打包结果, 在 target 目录下 .cool 后缀的文件，就是我们的插件包
target/cool-admin-java-plugin-1.0-SNAPSHOT.cool其中对应的包名称 可在 pom.xml 中的 properties 里指定
<properties>
+ <cool.plugin.name>my_cool_plugin</cool.plugin.name>
+</properties>最终打出的包为: my_cool_plugin.cool
在后台插件管理页面，安装插件将打包好的.cool 文件上传。
动态加载 Jar 包
实现动态加载的技术方案
在 SpringBoot 中实现动态加载 Jar 包： URLClassLoader 是 Java 标准库中提供的一个类加载器，它可以加载指定的 URL 资源，包括本地文件系统、远程服务器和 JAR 文件等。
通过 URLClassLoader，我们可以在运行时动态地加载外部的 Jar 包或类。
优势：
1、灵活性高：可以动态指定 Jar 包的位置和版本。
2、可控性强：可以通过代码控制加载、卸载和替换 Jar 包。
实现方法：
URL jarUrl = new URL("jar:file:" + new File(jarFilePath).getAbsolutePath() + "!/");
+DynamicJarClassLoader dynamicJarClassLoader = new DynamicJarClassLoader(new URL[]{jarUrl}, Thread.currentThread().getContextClassLoader());动态加载 Jar 包具有以下几个显著的优势：
开始使用 Cool-Admin！！！
项目是前后端分离的，需要分别拉取前后端代码到本地，源码仓库
后端修改数据库配置，配置文件位于src/resources/application-local.yml
以 Mysql 为例，其他数据库适配中...
Mysql(>=5.7版本)，建议 8.0，首次启动会自动初始化并导入数据
# mysql，驱动已经内置，无需安装
+spring:
+ datasource:
+ url: jdbc:mysql://127.0.0.1:3306/cool?useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2b8
+ username: root
+ password: 123456
+ driver-class-name: com.mysql.cj.jdbc.Driver启动文件：src/main/java/com/cool/CoolApplication.java，控制台打印出下面信息，说明后端服务启动成功
2024-07-15T14:38:45.382+08:00 INFO 31908 --- [cool-admin-java] [ main] c.c.c.plugin.service.CoolPluginService : 没有可初始化的插件
+2024-07-15T14:38:45.383+08:00 INFO 31908 --- [cool-admin-java] [ main] com.cool.core.eps.EpsEvent : 构建eps信息
+2024-07-15T14:38:45.941+08:00 INFO 31908 --- [cool-admin-java] [ task-1] o.springdoc.api.AbstractOpenApiResource : Init duration for springdoc-openapi is: 556 ms
+2024-07-15T14:38:46.101+08:00 INFO 31908 --- [cool-admin-java] [pool-3-thread-1] com.cool.core.eps.CoolEps : 初始化eps完成，服务启动成功，端口：8001访问：http://127.0.0.1:8001，你将会看到后端的欢迎页面
在项目根目录下(跟 package.json 同级)执行命令：
# 安装依赖
+npm install
+# 启动
+npm run dev访问http://127.0.0.1:9000/ 默认账户密码
账户：admin
密码：123456
记录接口请求日志入库
public class BaseLogFilter implements Filter {
+ @Resource
+ private BaseSysLogService baseSysLogService;
+
+ @Override
+ public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
+ throws IOException, ServletException {
+ // 记录日志
+ HttpServletRequest request = (HttpServletRequest) servletRequest;
+ baseSysLogService.record(request, (JSONObject) request.getAttribute("requestParams"));
+ filterChain.doFilter(servletRequest, servletResponse);
+ }
+
+}同时如果个别接口需要忽略记录请求日志
可以在yml文件中配置， 默认忽略APP端接口
# 忽略url
+ignored:
+ # 忽略记录请求日志url
+ logUrls:
+ - /
+ - /app/**
+ - /css/*
+ - /js/*
+ - /favicon.ico采用 spring-security 与 jwt 作为框架安全与权限校验。
cool:
+ # token 相关配置
+ token:
+ # 过期时间 单位：秒 半小时
+ expire: 1800
+ # 刷新token过期时间 单位：秒 7天
+ refreshExpire: 6048001、系统启动的时候，系统会查询并向spring-security加载所有设置的权限；
@Component
+public class MySecurityMetadataSource implements FilterInvocationSecurityMetadataSource {
+ @Resource
+ private BaseSysPermsService baseSysPermsService;
+
+ private Map<String, Collection<ConfigAttribute>> map = null;
+
+ /**
+ * 加载权限表中所有操作请求权限
+ */
+ public void loadResourceDefine() {
+ map = new HashMap<>();
+ Collection<ConfigAttribute> configAttributes;
+ ConfigAttribute cfg;
+ String[] perms = baseSysPermsService.getAllPerms();
+ // 获取启用的权限操作请求
+ for (String perm : perms) {
+ configAttributes = new ArrayList<>();
+ cfg = new SecurityConfig(perm);
+ // 作为MyAccessDecisionManager类的decide的第三个参数
+ configAttributes.add(cfg);
+ // 用权限的path作为map的key，用ConfigAttribute的集合作为value
+ map.put(perm.replaceAll(":", "/"), configAttributes);
+ }
+ }
+
+ /**
+ * 判定用户请求的url是否在权限表中 如果在权限表中，则返回给decide方法，用来判定用户是否有此权限 如果不在权限表中则放行
+ *
+ * @param o
+ * @return
+ * @throws IllegalArgumentException
+ */
+ @Override
+ public Collection<ConfigAttribute> getAttributes(Object o) throws IllegalArgumentException {
+ if (map == null) {
+ loadResourceDefine();
+ }
+ // Object中包含用户请求request
+ String url = ((FilterInvocation) o).getRequestUrl();
+ return map.get(url.replace("/admin/", "").split("[?]")[0]);
+
+ }
+
+ @Override
+ public Collection<ConfigAttribute> getAllConfigAttributes() {
+ return new ArrayList<>();
+ }
+
+ @Override
+ public boolean supports(Class<?> aClass) {
+ return true;
+ }
+}2、用户登录，查询该用户所具有的权限并缓存；
/**
+ * 获得用户信息
+ */
+@Component
+public class JwtUserDetailsServiceImpl implements UserDetailsService {
+ @Resource
+ private BaseSysUserService baseSysUserService;
+ @Resource
+ private BaseSysPermsService baseSysPermsService;
+ @Resource
+ private CoolCache coolCache;
+
+ @Override
+ public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
+ BaseSysUserEntity sysUserEntity = baseSysUserService.getOne(Wrappers.<BaseSysUserEntity>lambdaQuery()
+ .eq(BaseSysUserEntity::getUsername, username).eq(BaseSysUserEntity::getStatus, 1));
+ if (ObjectUtil.isEmpty(sysUserEntity)) {
+ throw new UsernameNotFoundException("用户名不存在");
+ }
+ List<GrantedAuthority> authority = new ArrayList<>();
+ String[] perms = baseSysPermsService.getPerms(sysUserEntity.getId());
+ for (String perm : perms) {
+ authority.add(new SimpleGrantedAuthority(perm));
+ }
+ Long[] departmentIds = baseSysPermsService.getDepartmentIdsByRoleIds(sysUserEntity.getId());
+ JwtUser jwtUser = new JwtUser(sysUserEntity.getUsername(), sysUserEntity.getPassword(), authority,
+ sysUserEntity.getStatus() == 1);
+ Long[] roleIds = baseSysPermsService.getRoles(sysUserEntity);
+ coolCache.set("admin:userDetails:" + jwtUser.getUsername(), jwtUser);
+ coolCache.set("admin:passwordVersion:" + sysUserEntity.getId(), sysUserEntity.getPasswordV());
+ coolCache.set("admin:userInfo:" + sysUserEntity.getId(), sysUserEntity);
+ coolCache.set("admin:department:" + sysUserEntity.getId(), departmentIds);
+ coolCache.set("admin:roleIds:" + sysUserEntity.getId(), roleIds);
+ return jwtUser;
+ }
+}3、每次调用接口的时候spring-security权限拦截器校验当前用户权限；
/**
+ * 权限管理拦截器
+ * 监控用户行为
+ */
+@Slf4j
+@Component
+public class MyFilterSecurityInterceptor extends AbstractSecurityInterceptor implements Filter {
+ @Resource
+ private FilterInvocationSecurityMetadataSource securityMetadataSource;
+
+
+ @Autowired
+ public void setMyAccessDecisionManager(MyAccessDecisionManager myAccessDecisionManager) {
+ super.setAccessDecisionManager(myAccessDecisionManager);
+ }
+
+ @Override
+ public void init(FilterConfig filterConfig) throws ServletException {
+ }
+
+ @Override
+ public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
+ FilterInvocation fi = new FilterInvocation(request, response, chain);
+ invoke(fi);
+ }
+
+ public void invoke(FilterInvocation fi) throws IOException, ServletException {
+ InterceptorStatusToken token = super.beforeInvocation(fi);
+ try {
+ fi.getChain().doFilter(fi.getRequest(), fi.getResponse());
+ } finally {
+ super.afterInvocation(token, null);
+ }
+ }
+
+ @Override
+ public void destroy() {
+ }
+
+ @Override
+ public Class<?> getSecureObjectClass() {
+ return FilterInvocation.class;
+ }
+
+ @Override
+ public SecurityMetadataSource obtainSecurityMetadataSource() {
+ return this.securityMetadataSource;
+ }
+}4.鉴权拦截配置 jwt
@EnableWebSecurity
+@Configuration
+@Slf4j
+public class JwtSecurityConfig {
+
+ // 用户详情
+ @Resource
+ private UserDetailsService userDetailsService;
+
+ @Resource
+ private JwtAuthenticationTokenFilter jwtAuthenticationTokenFilter;
+ // 401
+ @Resource
+ private EntryPointUnauthorizedHandler entryPointUnauthorizedHandler;
+ // 403
+ @Resource
+ private RestAccessDeniedHandler restAccessDeniedHandler;
+ // 忽略权限控制的地址
+ @Resource
+ private IgnoredUrlsProperties ignoredUrlsProperties;
+
+ @Bean
+ public SecurityFilterChain securityFilterChain(HttpSecurity httpSecurity) throws Exception {
+ return httpSecurity
+ .authorizeHttpRequests(
+ conf -> conf.requestMatchers(ignoredUrlsProperties.getUrls().stream().toArray(String[]::new))
+ .permitAll().anyRequest().authenticated())
+ .headers(config -> config.frameOptions(HeadersConfigurer.FrameOptionsConfig::disable))
+ // 允许网页iframe
+ .csrf(AbstractHttpConfigurer::disable)
+ .sessionManagement(conf -> conf.sessionCreationPolicy(SessionCreationPolicy.STATELESS))
+ .addFilterBefore(jwtAuthenticationTokenFilter, UsernamePasswordAuthenticationFilter.class)
+ .exceptionHandling(config -> {
+ config.authenticationEntryPoint(entryPointUnauthorizedHandler);
+ config.accessDeniedHandler(restAccessDeniedHandler);
+ }).build();
+ }
+
+ @Bean
+ public PasswordEncoder passwordEncoder() {
+ return new PasswordEncoder() {
+ @Override
+ public String encode(CharSequence rawPassword) {
+ return DigestUtils.md5DigestAsHex(((String) rawPassword).getBytes());
+ }
+
+ @Override
+ public boolean matches(CharSequence rawPassword, String encodedPassword) {
+ return encodedPassword.equals(DigestUtils.md5DigestAsHex(((String) rawPassword).getBytes()));
+ }
+ };
+ }
+
+ @Bean
+ public AuthenticationProvider authenticationProvider() {
+ DaoAuthenticationProvider authProvider = new DaoAuthenticationProvider();
+ authProvider.setUserDetailsService(userDetailsService);
+ authProvider.setPasswordEncoder(passwordEncoder());
+ return authProvider;
+ }
+
+ @Bean
+ public AuthenticationManager authenticationManager(AuthenticationConfiguration config) throws Exception {
+ return config.getAuthenticationManager();
+ }
+}获取当前用户信息
@GetMapping("/person")
+public R person(@RequestAttribute() Long adminUserId); Long userId = CoolSecurityUtil.getCurrentUserId();
+ String username = CoolSecurityUtil.getAdminUsername(); JSONObject userInfo = CoolSecurityUtil.getAdminUserInfo(requestParams);userInfo
| 字段 | 类型 | 说明 |
|---|---|---|
| roleIds | Long[] | 角色数组 |
| username | String | 用户名 |
| userId | Long | 用户 ID |
| passwordVersion | Integer | 密码版本号 |
Long userId = CoolSecurityUtil.getCurrentUserId();开放接口，忽略 token 校验
通过在方法上加TokenIgnore注解可以的接口不会进行 token 校验
@TokenIgnore
+@GetMapping("/eps")
+public R eps() {
+ return R.ok(coolEps.getApp());
+}也可以注解在类上
/**
+ * 字典信息
+ */
+@TokenIgnore(value = {"page"})
+@CoolRestController(api = {"add", "delete", "update", "page", "list", "info"})
+public class AdminDictInfoController{ }注意
无论是注解在方法还是类上，都必须配合CoolRestController使用，其它的无效
在配置文件中加需要忽略的路径，支持通配
# 忽略url
+ignored:
+ # 忽略后台鉴权url
+ adminAuthUrls:
+ - /
+ - /upload/**
+ - /actuator/**
+ - /download/**
+ - /static/**
+ - /favicon.ico
+ - /v3/api-docs/**
+ - /swagger
+ - /swagger-ui/**
+ - /css/*
+ - /js/*
+ - /druid/**
+ - /admin/base/open/**处理业务逻辑的代码应该被封装在服务中。
BaseService中集成了常用的 CRUD 操作，可以参考BaseService的实现。
可以重写modifyBefore和modifyAfter方法，在修改数据之前或之后做一些处理
/**
+ * 修改之前
+ *
+ * @param requestParams 请求参数
+ * @param t 对应实体
+ * @param type 修改类型
+ */
+@Override
+public void modifyBefore(JSONObject requestParams, T t, ModifyEnum type) {
+
+}/**
+ * 修改之后
+ *
+ * @param requestParams 请求参数
+ * @param t 对应实体
+ * @param type 修改类型
+ */
+@Override
+public void modifyAfter(JSONObject requestParams, T t, ModifyEnum type) {
+}默认集成springdoc，作为文档。
@Tag(name = "测试CURD", description = "测试CURD")
+@CoolRestController(value = "/cool", api = {"add", "delete", "update", "page", "list", "info"})
+public class AdminDemoInfoController extends BaseController<DemoService, DemoEntity> {
+ @Override
+ protected void init(HttpServletRequest request, JSONObject requestParams) {
+ // 可以在这边实现一下列表数据排序规则,查询条件过滤，返回哪些字段等
+ }
+}系统启动完成访问：http://127.0.0.1:8001/swagger-ui/index.html#/
`,4),e=[n];function k(l,p,r,E,d,g){return a(),i("div",null,e)}const F=s(h,[["render",k]]);export{y as __pageData,F as default}; diff --git a/.vitepress/dist/assets/src_guide_swagger.md.CCfA6TBH.lean.js b/.vitepress/dist/assets/src_guide_swagger.md.CCfA6TBH.lean.js new file mode 100644 index 0000000..7a6ff25 --- /dev/null +++ b/.vitepress/dist/assets/src_guide_swagger.md.CCfA6TBH.lean.js @@ -0,0 +1 @@ +import{_ as s,a as i,o as a,aj as t}from"./chunks/framework.BjhQB2K5.js";const y=JSON.parse('{"title":"swagger 文档","description":"","frontmatter":{},"headers":[],"relativePath":"src/guide/swagger.md","filePath":"src/guide/swagger.md","lastUpdated":1720593505000}'),h={name:"src/guide/swagger.md"},n=t("",4),e=[n];function k(l,p,r,E,d,g){return a(),i("div",null,e)}const F=s(h,[["render",k]]);export{y as __pageData,F as default}; diff --git a/.vitepress/dist/assets/src_guide_tenant.md.CP_z92JB.js b/.vitepress/dist/assets/src_guide_tenant.md.CP_z92JB.js new file mode 100644 index 0000000..5b87426 --- /dev/null +++ b/.vitepress/dist/assets/src_guide_tenant.md.CP_z92JB.js @@ -0,0 +1,5 @@ +import{_ as a,a as e,o as t,aj as i}from"./chunks/framework.BjhQB2K5.js";const u=JSON.parse('{"title":"多租户（v8.0新增）","description":"","frontmatter":{},"headers":[],"relativePath":"src/guide/tenant.md","filePath":"src/guide/tenant.md","lastUpdated":1744512083000}'),s={name:"src/guide/tenant.md"},n=i(`多租户（Multi-tenancy）是一种软件架构模式，允许单个应用实例服务多个租户（客户组织）。每个租户的数据是相互隔离的，但共享同一个应用程序代码和基础设施。
多租户的数据隔离有许多种方案，但最为常见的是以列进行隔离的方式。Cool Admin 通过在TenantEntity中加入指定的列（租户ID tenantId）对数据进行隔离。
如果登录的用户token信息有携带tenantId，则框架会自动注入tenantId。
框架默认关闭多租户，需要手动开启 enable修改为 true
# Cool相关配置
+cool:
+ multi-tenant:
+ # 是否开启多租户，默认关闭
+ enable: false关于tenantId的使用请参考 mybatis-flex
对于需要租户隔离的表，需要对应的表实体继承对象进行调整 BaseEntity -> TenantEntity
`,15),l=[n];function h(r,o,d,p,c,k){return t(),e("div",null,l)}const m=a(s,[["render",h]]);export{u as __pageData,m as default}; diff --git a/.vitepress/dist/assets/src_guide_tenant.md.CP_z92JB.lean.js b/.vitepress/dist/assets/src_guide_tenant.md.CP_z92JB.lean.js new file mode 100644 index 0000000..4454c1a --- /dev/null +++ b/.vitepress/dist/assets/src_guide_tenant.md.CP_z92JB.lean.js @@ -0,0 +1 @@ +import{_ as a,a as e,o as t,aj as i}from"./chunks/framework.BjhQB2K5.js";const u=JSON.parse('{"title":"多租户（v8.0新增）","description":"","frontmatter":{},"headers":[],"relativePath":"src/guide/tenant.md","filePath":"src/guide/tenant.md","lastUpdated":1744512083000}'),s={name:"src/guide/tenant.md"},n=i("",15),l=[n];function h(r,o,d,p,c,k){return t(),e("div",null,l)}const m=a(s,[["render",h]]);export{u as __pageData,m as default}; diff --git a/.vitepress/dist/assets/src_guide_uniqueIDGen.md.BNiKKfQz.js b/.vitepress/dist/assets/src_guide_uniqueIDGen.md.BNiKKfQz.js new file mode 100644 index 0000000..762ce90 --- /dev/null +++ b/.vitepress/dist/assets/src_guide_uniqueIDGen.md.BNiKKfQz.js @@ -0,0 +1,30 @@ +import{_ as s,a as i,o as a,aj as n}from"./chunks/framework.BjhQB2K5.js";const o=JSON.parse('{"title":"唯一id","description":"","frontmatter":{},"headers":[],"relativePath":"src/guide/uniqueIDGen.md","filePath":"src/guide/uniqueIDGen.md","lastUpdated":1725802894000}'),t={name:"src/guide/uniqueIDGen.md"},h=n(`基于表来完成分布式ID生成
原理参考美团点评分布式ID
@Table(value = "leaf_alloc", comment = "唯一id分配")
+public class LeafAllocEntity extends BaseEntity<LeafAllocEntity> {
+
+ @UniIndex
+ @ColumnDefine(comment = "业务key ，比如orderId", length = 20, notNull = true)
+ private String key;
+
+ @ColumnDefine(comment = "当前最大id", defaultValue = "1", notNull = true)
+ private Long maxId;
+
+ @ColumnDefine(comment = "步长", defaultValue = "500", notNull = true)
+ private Integer step;
+
+ @ColumnDefine(comment = "描述")
+ private String description;
+}用法
// 注入service
+private final IDGenService idGenService;
+// 获取id，入参为key: orderId 需要提取初始化到上面那个
+Long orderId = idGenService.next("orderId");项目启动自动插入数据参考 数据初始化
{
+ "leaf_alloc": [{
+ "key": "orderId",
+ "max_id": 1,
+ "step": 500,
+ "description": "订单ID"
+ }]
+}启用唯一ID组件，默认禁用, 如需启用调整为 true
# 分布式唯一ID组件
+leaf:
+ segment:
+ # 默认禁用,如需启用调整为 true
+ enable: false框架自带两种文件上传方式本地上传与云存储，与前端紧密结合，
前端会根据后端返回的上传模式进行本地上传或者云存储签名直传(不经过服务器，直接上传到对应的云存储)
TIP
安装云存储插件，如 Oss，系统的文件上传就会自动替换成云存储上传的方式，云存储上传服务端值提供签名供前端直传到对应的云存储
application.yml
spring:
+ # Web设置
+ web:
+ resources:
+ add-mappings: true
+ static-locations: classpath:/static/,file:./assets/public/,file:/Users/mac/Desktop
+cool:
+ # 文件上传相关
+ file:
+ #上传模式
+ mode: local
+ # 本地上传配置
+ local:
+ # 文件根地址
+ base-url: http://127.0.0.1:\${server.port}/upload
+ # 可选，文件存放路径 线上环境请用nginx等静态服务器代理
+ uploadPath: /Users/mac/Desktop/upload # 默认是相对路径，也支持绝对路径（注意: 需和上面的 spring Web设置配合使用）动静分离有许多好处，如不占用主服务器带宽，防止上传恶意文件等。
条件允许的话尽量选择云存储上传，如：oss 还可以对图片进行各种如压缩、裁剪、水印等处理，方便一张图片使用在多种场景。
@RequiredArgsConstructor
+@Tag(name = "系统通用", description = "系统通用")
+@CoolRestController()
+public class AdminBaseCommController {
+ final private FileUploadStrategyFactory fileUploadStrategyFactory;
+
+ @Operation(summary = "文件上传")
+ @PostMapping(value = "/upload", consumes = {MediaType.MULTIPART_FORM_DATA_VALUE,
+ MediaType.ALL_VALUE})
+ public R upload(
+ @RequestPart(value = "file", required = false) @Parameter(description = "文件") MultipartFile[] files,
+ HttpServletRequest request) {
+ return R.ok(fileUploadStrategyFactory.upload(files, request));
+ }
+
+ @Operation(summary = "文件上传模式")
+ @GetMapping("/uploadMode")
+ public R uploadMode() {
+ return R.ok(fileUploadStrategyFactory.getMode());
+ }
+}按照简单、常用的技术进行选择，减少技术栈的复杂度。
随着技术不断地发展，特别是最近 Ai 相关的技术发展，以往的框架已经越来越不能满足现代化的开发需求。
Cool Admin 做为后来者有后发优势，主要特点：
功能几乎跟nodejs 版本一致
账户：admin 密码：123456
',5),n=[c];function _(i,d,p,h,l,m){return o(),a("div",null,n)}const T=t(s,[["render",_]]);export{w as __pageData,T as default}; diff --git a/.vitepress/dist/assets/src_introduce_show.md.Ck0DuCIX.lean.js b/.vitepress/dist/assets/src_introduce_show.md.Ck0DuCIX.lean.js new file mode 100644 index 0000000..73efb8f --- /dev/null +++ b/.vitepress/dist/assets/src_introduce_show.md.Ck0DuCIX.lean.js @@ -0,0 +1 @@ +import{_ as e}from"./chunks/admin.CyLBVO1a.js";import{_ as t,a,o,aj as r}from"./chunks/framework.BjhQB2K5.js";const w=JSON.parse('{"title":"演示","description":"","frontmatter":{},"headers":[],"relativePath":"src/introduce/show.md","filePath":"src/introduce/show.md","lastUpdated":1720593505000}'),s={name:"src/introduce/show.md"},c=r("",5),n=[c];function _(i,d,p,h,l,m){return o(),a("div",null,n)}const T=t(s,[["render",_]]);export{w as __pageData,T as default}; diff --git a/.vitepress/dist/assets/src_introduce_src.md.UlNmfnNt.js b/.vitepress/dist/assets/src_introduce_src.md.UlNmfnNt.js new file mode 100644 index 0000000..6013f2b --- /dev/null +++ b/.vitepress/dist/assets/src_introduce_src.md.UlNmfnNt.js @@ -0,0 +1 @@ +import{_ as a,a as o,o as e,aj as t}from"./chunks/framework.BjhQB2K5.js";const _=JSON.parse('{"title":"源码","description":"","frontmatter":{},"headers":[],"relativePath":"src/introduce/src.md","filePath":"src/introduce/src.md","lastUpdated":1722935307000}'),r={name:"src/introduce/src.md"},c=t('项目是开源免费、可商用、无需授权的，为了使项目能够持续，不要吝啬你们免费的Star哦！！！你的Star是我们最大的动力！！！
https://github.com/cool-team-official/cool-admin-java
或
https://gitee.com/cool-team-official/cool-admin-java
或
https://gitcode.com/cool_team/cool-admin-java
https://github.com/cool-team-official/cool-admin-vue
或
https://gitee.com/cool-team-official/cool-admin-vue
或
https://gitcode.com/cool_team/cool-admin-vue
如果文档有缺失，欢迎提交pr，您的贡献可能会给其他人来带巨大的帮助。
https://github.com/cool-team-official/cool-admin-java-docs
或
https://gitee.com/cool-team-official/cool-admin-java-docs
',20),i=[c];function l(n,s,m,p,d,h){return e(),o("div",null,i)}const u=a(r,[["render",l]]);export{_ as __pageData,u as default}; diff --git a/.vitepress/dist/assets/src_introduce_src.md.UlNmfnNt.lean.js b/.vitepress/dist/assets/src_introduce_src.md.UlNmfnNt.lean.js new file mode 100644 index 0000000..a4669b8 --- /dev/null +++ b/.vitepress/dist/assets/src_introduce_src.md.UlNmfnNt.lean.js @@ -0,0 +1 @@ +import{_ as a,a as o,o as e,aj as t}from"./chunks/framework.BjhQB2K5.js";const _=JSON.parse('{"title":"源码","description":"","frontmatter":{},"headers":[],"relativePath":"src/introduce/src.md","filePath":"src/introduce/src.md","lastUpdated":1722935307000}'),r={name:"src/introduce/src.md"},c=t("",20),i=[c];function l(n,s,m,p,d,h){return e(),o("div",null,i)}const u=a(r,[["render",l]]);export{_ as __pageData,u as default}; diff --git a/.vitepress/dist/assets/src_question_common.md.Caojqqth.js b/.vitepress/dist/assets/src_question_common.md.Caojqqth.js new file mode 100644 index 0000000..f8d2157 --- /dev/null +++ b/.vitepress/dist/assets/src_question_common.md.Caojqqth.js @@ -0,0 +1 @@ +import{_ as e,a as t,o as a,aj as o}from"./chunks/framework.BjhQB2K5.js";const u=JSON.parse('{"title":"常见问题","description":"","frontmatter":{},"headers":[],"relativePath":"src/question/common.md","filePath":"src/question/common.md","lastUpdated":1721036629000}'),l={name:"src/question/common.md"},i=o('项目中常见的问题
xxxTableDef文件 框架用到了Mybatis Flex 的 APT 功能，在项目编译的时候会自动生成这些文件。
你可以这样做：
mvn compile命令；Build project automatically自动编译功能（Settings -> Build, Execution, Deployment -> Compiler -> Build Project Automatically）；这些方式都可以解决这个问题。
',7),r=[i];function c(n,s,d,_,m,p){return a(),t("div",null,r)}const x=e(l,[["render",c]]);export{u as __pageData,x as default}; diff --git a/.vitepress/dist/assets/src_question_common.md.Caojqqth.lean.js b/.vitepress/dist/assets/src_question_common.md.Caojqqth.lean.js new file mode 100644 index 0000000..36501d8 --- /dev/null +++ b/.vitepress/dist/assets/src_question_common.md.Caojqqth.lean.js @@ -0,0 +1 @@ +import{_ as e,a as t,o as a,aj as o}from"./chunks/framework.BjhQB2K5.js";const u=JSON.parse('{"title":"常见问题","description":"","frontmatter":{},"headers":[],"relativePath":"src/question/common.md","filePath":"src/question/common.md","lastUpdated":1721036629000}'),l={name:"src/question/common.md"},i=o("",7),r=[i];function c(n,s,d,_,m,p){return a(),t("div",null,r)}const x=e(l,[["render",c]]);export{u as __pageData,x as default}; diff --git a/.vitepress/dist/assets/src_todo_plan.md.pGnBM6_r.js b/.vitepress/dist/assets/src_todo_plan.md.pGnBM6_r.js new file mode 100644 index 0000000..a39f975 --- /dev/null +++ b/.vitepress/dist/assets/src_todo_plan.md.pGnBM6_r.js @@ -0,0 +1 @@ +import{_ as a,a as t,o as e,aj as o}from"./chunks/framework.BjhQB2K5.js";const u=JSON.parse('{"title":"计划","description":"","frontmatter":{},"headers":[],"relativePath":"src/todo/plan.md","filePath":"src/todo/plan.md","lastUpdated":1721037096000}'),l={name:"src/todo/plan.md"},i=o('以下是我们的一些计划，如果你有更好的建议，欢迎联系我们。
因为有你们的支持，cool-admin 会持续不断地更新，如果方便请点下 Star，这将会给我们带来更多的动力！！！
Cool Admin 推荐两种快速开发方式，可以大大节省开发时间，降低开发成本，提高开发效率。
零代码开发(非低代码)，通过微调大模型学习框架特有写法，实现简单功能从 Api 接口到前端页面的一键生成
开发过程只需点一点，调一调，不用写一行代码
只需三步，创建实体类生成表，生成后端代码，生成前端代码
文件：src/test/java/com/cool/CoolAdminJavaApplicationTests.java
public class CoolCodeGeneratorTest {
+ public static void main(String[] args) {
+ CodeGenerator codeGenerator = new CodeGenerator();
+ codeGenerator.init();
+
+ CodeModel codeModel = new CodeModel();
+ codeModel.setType(CodeTypeEnum.ADMIN);
+ codeModel.setName("测试CURD");
+ codeModel.setModule("demo");
+ codeModel.setEntity(DemoEntity.class);
+
+ codeGenerator.controller(codeModel);
+ codeGenerator.mapper(codeModel);
+ codeGenerator.service(codeModel);
+ }
+}Ui 组件会根据字段智能选择
开发 Ai 应用必备！！！
随着 Ai 的火热，很多应用希望接入 Ai 的能力，但是每次都是用代码手搓，容易把我们累死，而是也非常不灵活。
于是我们面向开发者和软件开发公司，做了一个 Ai 流程编排功能，结合知识库，通过拖动配置，很容易就能完成一个 Ai 的核心流程。
因此如果你需要开发 Ai 相关应用，这个可能会给你带来巨大的帮助。
为了丰富系统功能，我们提供了插件系统，可以通过插件的方式来扩展系统功能。
而不用一味地堆功能，导致系统臃肿。你可以自己开发插件，也可以使用别人开发的插件。
首先下载插件包，然后在系统中安装插件包。插件包可以通过官网下载插件。
打开后台管理系统，点击左侧菜单扩展管理/插件管理，点击+按钮，选择插件包进行安装。
安装插件之后，就可以在代码中调用插件的方法了。
package com.cool.core.base.controller;
+
+import cn.hutool.core.util.ObjUtil;
+import com.cool.core.util.CoolPluginInvokers;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.ResponseBody;
+
+@Controller
+@RequiredArgsConstructor
+public class CommonController {
+
+ @PostMapping("/testPlugin/invokeMethod")
+ @ResponseBody
+ public String invokeMethod(@RequestParam String key, @RequestParam String methodName) {
+ Object result = null;
+ if (ObjUtil.isEmpty(methodName)) {
+ result = CoolPluginInvokers.invokePlugin(key);
+ } else {
+ result = CoolPluginInvokers.invokePlugin(key, methodName);
+ }
+ System.out.println(result);
+ return "invokeMethod Result: " + result;
+ }
+}运行结果
2024-07-13T20:01:18.543+08:00 INFO 32615 --- [cool-admin-java] [nio-8001-exec-5] com.cool.core.util.CoolPluginInvokers : 调用插件类: test, 方法: invokePlugin 参数: []
+Hello invokePlugin
+2024-07-13T20:01:18.543+08:00 DEBUG 32615 --- [cool-admin-java] [ task-5] c.c.m.b.m.sys.BaseSysLogMapper.insert : ==> Preparing: INSERT INTO `base_sys_log`(`action`, `ip`, `params`, `create_time`, `update_time`) VALUES (?, ?, ?, now(), now())
+2024-07-13T20:01:18.544+08:00 DEBUG 32615 --- [cool-admin-java] [ task-5] c.c.m.b.m.sys.BaseSysLogMapper.insert : ==> Parameters: /testPlugin/invokeMethod(String), 127.0.0.1(String), {"key":"test"}(String)
+2024-07-13T20:01:18.554+08:00 DEBUG 32615 --- [cool-admin-java] [ task-5] c.c.m.b.m.sys.BaseSysLogMapper.insert : <== Updates: 1
+2024-07-13T20:01:18.557+08:00 INFO 32615 --- [cool-admin-java] [nio-8001-exec-5] com.cool.core.plugin.BaseCoolPlugin : 调用主应用: coolCache, 方法: set
+2024-07-13T20:01:18.558+08:00 INFO 32615 --- [cool-admin-java] [nio-8001-exec-5] com.cool.core.plugin.BaseCoolPlugin : 调用主应用: coolCache, 方法: get
+缓存结果：一个项目用COOL就够了
+2024-07-13T20:01:18.559+08:00 INFO 32615 --- [cool-admin-java] [nio-8001-exec-5] com.cool.core.plugin.BaseCoolPlugin : 调用主应用: coolPluginService, 方法: getInstance
+2024-07-13T20:01:18.564+08:00 INFO 32615 --- [cool-admin-java] [nio-8001-exec-5] com.cool.core.plugin.BaseCoolPlugin : 调用其他插件aliyun-oss, 方法: invokePlugin
+{OSSAccessKeyId=LTAI5t8xtPD99YzSJQCC, signature=krlJ0Uv96TBliAgPJI/KyI=, success_action_status=200, host=https://xxx.oss-cn-hangzhou.aliyuncs.com, policy=eyJleHB0wNy0xM1QxMjowMTo0OC41NjVaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MDBdXX0=}
+ ______ ___ ___ _____ _ ______ ____ ____ _____ ____ _____
+ .' ___ | .' `. .' `.|_ _| V7.x / \ |_ _ `.|_ \ / _||_ _||_ \|_ _|
+/ .' \_|/ .-. \/ .-. \ | | ______ / _ \ | | `. \ | \/ | | | | \ | |
+| | | | | || | | | | | _|______|/ ___ \ | | | | | |\ /| | | | | |\ \| |
+\ `.___.'\\ `-' /\ `-' /_| |__/ | _/ / \ \_ _| |_.' /_| |_\/_| |_ _| |_ _| |_\ |_
+ `.____ .' `.___.' `.___.'|________| |____| |____||______.'|_____||_____||_____||_____|\____|
+:: https://java.cool-admin.com ::
+Hello invokePlugin对应插件内的方法
package com.cool.plugin;
+
+import cn.hutool.core.io.IoUtil;
+import cn.hutool.core.util.StrUtil;
+import com.cool.core.annotation.CoolPlugin;
+import com.cool.core.plugin.BaseCoolPlugin;
+import java.io.InputStream;
+import lombok.extern.slf4j.Slf4j;
+
+/**
+ * - 类必须要有 @CoolPlugin 注解，一个插件jar有且只能有一个类被 @CoolPlugin 注解
+ * - 类必须继承 BaseCoolPlugin, 并实现 invokePlugin
+ * 插件方法
+ */
+@Slf4j
+@CoolPlugin
+public class MyCoolPlugin extends BaseCoolPlugin {
+
+ @Override
+ public Object invokePlugin(String... params) {
+ System.out.println("Hello invokePlugin");
+ useCache();
+ usePlugin();
+ getParentResource();
+ return "Hello invokePlugin";
+ }
+
+ /**
+ * 使用缓存，使用cool-admin的缓存，开发的时候只是模拟
+ */
+ private void useCache() {
+ // 调用主应用设置缓存
+ invokeMain("coolCache", "set", "a", "一个项目用COOL就够了");
+ // 调用主应用获取缓存
+ Object cache =
+ invokeMain("coolCache", "get", "a");
+ System.out.println("缓存结果：" + cache);
+ }
+
+ /**
+ * 调用其他插件
+ */
+ private void usePlugin() {
+ // 获得其他插件，开发的时候无法调试，只有安装到cool-admin中才能调试 xxx 为插件key
+ Object result = invokeOtherPlugin("aliyun-oss", "invokePlugin");
+ System.out.println(result);
+ }
+
+ /**
+ * 获取主应用resources目录下的资源文件
+ */
+ private void getParentResource() {
+ ClassLoader classLoader = getClass().getClassLoader();
+ ClassLoader parentClassLoader = classLoader.getParent();
+ // 获取主应用resources下的 banner.txt 文件内容
+ InputStream inputStream = parentClassLoader.getResourceAsStream("banner.txt");
+ System.out.println(StrUtil.str(IoUtil.readBytes(inputStream), "UTF-8"));
+ }
+}其中我们可以在插件包里通过 invokeMain 方法去调用主应用的一些对象方法
比如 coolCache 缓存对象, 通过反射实现
在加载 jar 包时会想该插件注入 ApplicationContext，使得可以在插件中获取主应用中的 bean
有时候开发时的配置和生产环境的配置是不一样的，我们可以通过配置文件来实现。
例如原本的配置文件是这样的
{
+ "appId": "xxxxx",
+ "appSecret": "xxxxx",
+ "filePath": "banner.txt"
+}其中 banner.txt 为主应用 resources 资源目录下的文件，路径可以自己指定，范围在 resources 下
为了方便开发插件和统一插件开发规范，我们提供了插件脚手架，可以快速开发我们的插件。
脚手架源码仓库：
https://github.com/cool-team-official/cool-admin-java-plugin
或
https://gitee.com/cool-team-official/cool-admin-java-plugin
.
+main
+├─ java
+│ └─ com.cool
+│ ├─core 核心包
+│ │ ├─ annotation
+│ │ └─ ...
+│ └─ plugin
+│ └─ MyCoolPlugin 插件包，插件类放在这个包下,在打包的时候选择要打包的插件，加上@CoolPlugin注解
+├─ resources
+│ └─ plugin.json 插件信息配置文件
+test
+│
+│─ java
+│ └─ com.cool.plugin
+│ └─ MyCoolPluginTest 插件运行测试类{
+ "name": "测试",
+ "key": "demo-plugin",
+ "hook": "",
+ "version": "1.0.0",
+ "description": "插件描述",
+ "author": "作者",
+ "logo": "assets/logo.png",
+ "readme": "assets/README.md",
+ "config": {
+ "aaa": "xxx",
+ "bbb": "xxx"
+ }
+}config 是插件的配置信息，不同的插件有不同的配置，上面只是个例子，实际开发中可以根据自己的需求来配置,在后台插件管理里可以动态修改
| 字段 | 说明 |
|---|---|
| name | 角色数组 |
| key | 插件唯一标识 |
| hook | 插件钩子，比如替换系统的上传组件，upload |
| version | 版本号 |
| description | 插件描述 |
| author | 作者 |
| logo | 插件 logo，建议尺寸 256x256 |
| readme | 插件介绍，会展示在插件的详情中 |
| config | 插件配置， 每个插件的配置各不相同 |
package com.cool.plugin;
+
+import com.cool.core.annotation.CoolPlugin;
+import com.cool.core.plugin.BaseCoolPlugin;
+import net.sourceforge.pinyin4j.PinyinHelper;
+import net.sourceforge.pinyin4j.format.HanyuPinyinOutputFormat;
+import net.sourceforge.pinyin4j.format.HanyuPinyinToneType;
+import net.sourceforge.pinyin4j.format.exception.BadHanyuPinyinOutputFormatCombination;
+
+/**
+ * - 类必须要有 @CoolPlugin 注解，一个插件jar有且只能有一个类被 @CoolPlugin 注解
+ * - 类必须继承 BaseCoolPlugin
+ */
+@CoolPlugin
+public class DemoCoolPlugin extends BaseCoolPlugin {
+
+ @Override
+ public Object invokePlugin(String... params) {
+ String chineseChar = params[0]; // 汉字字符
+ HanyuPinyinOutputFormat format = new HanyuPinyinOutputFormat();
+ format.setToneType(HanyuPinyinToneType.WITHOUT_TONE); // 不带声调
+
+ String pinyin = null;
+ try {
+ pinyin = PinyinHelper.toHanyuPinyinString(chineseChar, format, "");
+ } catch (BadHanyuPinyinOutputFormatCombination e) {
+ throw new RuntimeException(e);
+ }
+ System.out.println("汉字：" + chineseChar + "，拼音：" + pinyin);
+ Object cache = invokeMain("coolCache", "get", "verify:img:4fd03504-47ac-4b57-b8e4-3c64059230d0");
+ return String.format("hello，%s 我是插件", chineseChar);
+ }
+}<dependency>
+ <groupId>cn.hutool</groupId>
+ <artifactId>hutool-all</artifactId>
+ <version>5.8.26</version>
+</dependency>
+<!--***以上包在主应用已经引入，避免插件过大不会在打入jar包中***-->
+<!--***为了开发插件如果引入了主应用已经有的maven依赖可以在下面的 maven-shade-plugin 中排除掉不打入jar***-->
+<!--以下包会打入jar，主应用没有这些依赖，不然调用时会报错-->
+<dependency>
+ <groupId>com.belerweb</groupId>
+ <artifactId>pinyin4j</artifactId>
+ <version>2.5.0</version>
+</dependency>在我们脚手架上你可以发现，我们还引入了其他包 springframework、hutool 等，这会使得打包结果很臃肿，这边使用到了 maven-shade-plugin maven 插件可以在打包的时候将在我们 cool-admin-java 主应用项目已经有的依赖给排除掉，避免打包结果过大
<!--***为了开发插件如果引入了主应用已经有的maven依赖可以在下面的 maven-shade-plugin 中排除掉不打入jar***-->
+<build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-shade-plugin</artifactId>
+ <version>3.2.4</version>
+ <executions>
+ <execution>
+ <phase>package</phase>
+ <goals>
+ <goal>shade</goal>
+ </goals>
+ <configuration>
+ <artifactSet>
+ <excludes>
+ <!--主应用以有这些依赖，打包时可以排除-->
+ <exclude>org.springframework:spring-beans</exclude>
+ <exclude>org.springframework:spring-core</exclude>
+ <exclude>org.springframework:spring-jcl</exclude>
+ <exclude>org.springframework:spring-context</exclude>
+ <exclude>org.springframework:spring-aop</exclude>
+ <exclude>org.springframework:spring-expression</exclude>
+ <exclude>io.micrometer:micrometer-observation:jar</exclude>
+ <exclude>io.micrometer:micrometer-commons:jar</exclude>
+ <exclude>jakarta.annotation:jakarta.annotation-api</exclude>
+ <exclude>org.slf4j:slf4j-api</exclude>
+ <exclude>org.projectlombok:lombok</exclude>
+ <exclude>cn.hutool:hutool-core</exclude>
+ <exclude>cn.hutool:hutool-json</exclude>
+ <exclude>org.springframework:spring-beans</exclude>
+ <exclude>io.micrometer:micrometer-observation</exclude>
+ <exclude>io.micrometer:micrometer-commons</exclude>
+ </excludes>
+ </artifactSet>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+</build>在执行打包的过程，可以在打包日志中查看我们排除和引入了哪些包
[INFO] --- maven-shade-plugin:3.2.4:shade (default) @ cool-admin-java-plugin ---
+[INFO] Including com.belerweb:pinyin4j:jar:2.5.0 in the shaded jar.
+[INFO] Excluding org.springframework:spring-beans:jar:6.1.6 from the shaded jar.
+[INFO] Excluding org.springframework:spring-core:jar:6.1.6 from the shaded jar.
+[INFO] Excluding org.springframework:spring-jcl:jar:6.1.6 from the shaded jar.
+[INFO] Excluding org.springframework:spring-context:jar:6.1.6 from the shaded jar.
+[INFO] Excluding org.springframework:spring-aop:jar:6.1.6 from the shaded jar.
+[INFO] Excluding org.springframework:spring-expression:jar:6.1.6 from the shaded jar.
+[INFO] Excluding io.micrometer:micrometer-observation:jar:1.12.5 from the shaded jar.
+[INFO] Excluding io.micrometer:micrometer-commons:jar:1.12.5 from the shaded jar.
+[INFO] Excluding jakarta.annotation:jakarta.annotation-api:jar:2.1.1 from the shaded jar.
+[INFO] Excluding org.slf4j:slf4j-api:jar:2.0.13 from the shaded jar.
+[INFO] Excluding org.projectlombok:lombok:jar:1.18.32 from the shaded jar.
+[INFO] Excluding cn.hutool:hutool-core:jar:5.8.26 from the shaded jar.
+[INFO] Excluding cn.hutool:hutool-json:jar:5.8.26 from the shaded jar.打包命令
mvn clean package打包结果, 在 target 目录下 .cool 后缀的文件，就是我们的插件包
target/cool-admin-java-plugin-1.0-SNAPSHOT.cool其中对应的包名称 可在 pom.xml 中的 properties 里指定
<properties>
+ <cool.plugin.name>my_cool_plugin</cool.plugin.name>
+</properties>最终打出的包为: my_cool_plugin.cool
在后台插件管理页面，安装插件将打包好的.cool 文件上传。
动态加载 Jar 包
实现动态加载的技术方案
在 SpringBoot 中实现动态加载 Jar 包： URLClassLoader 是 Java 标准库中提供的一个类加载器，它可以加载指定的 URL 资源，包括本地文件系统、远程服务器和 JAR 文件等。
通过 URLClassLoader，我们可以在运行时动态地加载外部的 Jar 包或类。
优势：
1、灵活性高：可以动态指定 Jar 包的位置和版本。
2、可控性强：可以通过代码控制加载、卸载和替换 Jar 包。
实现方法：
URL jarUrl = new URL("jar:file:" + new File(jarFilePath).getAbsolutePath() + "!/");
+DynamicJarClassLoader dynamicJarClassLoader = new DynamicJarClassLoader(new URL[]{jarUrl}, Thread.currentThread().getContextClassLoader());动态加载 Jar 包具有以下几个显著的优势：
开始使用 Cool-Admin！！！
项目是前后端分离的，需要分别拉取前后端代码到本地，源码仓库
后端修改数据库配置，配置文件位于src/resources/application-local.yml
以 Mysql 为例，其他数据库适配中...
Mysql(>=5.7版本)，建议 8.0，首次启动会自动初始化并导入数据
# mysql，驱动已经内置，无需安装
+spring:
+ datasource:
+ url: jdbc:mysql://127.0.0.1:3306/cool?useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2b8
+ username: root
+ password: 123456
+ driver-class-name: com.mysql.cj.jdbc.Driver启动文件：src/main/java/com/cool/CoolApplication.java，控制台打印出下面信息，说明后端服务启动成功
2024-07-15T14:38:45.382+08:00 INFO 31908 --- [cool-admin-java] [ main] c.c.c.plugin.service.CoolPluginService : 没有可初始化的插件
+2024-07-15T14:38:45.383+08:00 INFO 31908 --- [cool-admin-java] [ main] com.cool.core.eps.EpsEvent : 构建eps信息
+2024-07-15T14:38:45.941+08:00 INFO 31908 --- [cool-admin-java] [ task-1] o.springdoc.api.AbstractOpenApiResource : Init duration for springdoc-openapi is: 556 ms
+2024-07-15T14:38:46.101+08:00 INFO 31908 --- [cool-admin-java] [pool-3-thread-1] com.cool.core.eps.CoolEps : 初始化eps完成，服务启动成功，端口：8001访问：http://127.0.0.1:8001，你将会看到后端的欢迎页面
在项目根目录下(跟 package.json 同级)执行命令：
# 安装依赖
+npm install
+# 启动
+npm run dev访问http://127.0.0.1:9000/ 默认账户密码
账户：admin
密码：123456
按照简单、常用的技术进行选择，减少技术栈的复杂度。
随着技术不断地发展，特别是最近 Ai 相关的技术发展，以往的框架已经越来越不能满足现代化的开发需求。
Cool Admin 做为后来者有后发优势，主要特点：