Browse Source

添加对应的扩展包

bobo 3 years ago
parent
commit
ffec3517a0
1 changed files with 49 additions and 112 deletions
  1. 49 112
      README.md

+ 49 - 112
README.md

@@ -1,112 +1,49 @@
-
-# 开发须知
-## 新增代码
-### 工具类
-    ShortCodeUtil 用于短编码生成 试用在邀请码,验证码等生成
-        ShortCodeUtil.generateShortUuid()
-    SnowFlakeUtil 用户组件id生成 采用雪花算法有效保证id的唯一性
-        SnowFlakeUtil snowFlakeUtil = new SnowFlakeUtil(2, 3);
-        snowFlakeUtil.nextId();
-### 返回体包装        
-    AjaxResultVo<Xxx> 接口实体返回推荐试用可定义泛型 用于Swagger返回体实体展示
-        AjaxResultVo.success(xxx)
-    TableDataInfo<Xxxx> 接口返回分页数据
-        TableDataInfo.getDataTable(list);
-## 推荐编码包结构
-    java
-        com.future
-            module (代码模块)
-                area
-                    controller
-                        XxxController
-                    mapper
-                        XxxMapper
-                        XxxMapper.xml
-                    model
-                        entity 
-                            Xxx 实体
-                        enum 
-                            XxxEnum 枚举
-                        form 
-                            XxxForm 表单实体
-                        parms 
-                            XxxParms 查询实体
-                        vo 
-                            XxxVo 返回实体
-                    service
-                        impl
-                            XxxServiceImpl
-                        XxxService
-
-
-## 平台简介
-
-Future是一套全部开源的快速开发平台.
-
-* 前端采用Vue、Element UI。
-* 后端采用Spring Boot、Spring Security、Redis & Jwt。
-* 权限认证使用Jwt,支持多终端认证系统。
-* 支持加载动态权限菜单,多方式轻松权限控制。
-* 高效率开发,使用代码生成器可以一键生成前后端代码。
-* 提供了单应用版本[future-Vue-fast](https://github.com/yangzongzhuan/future-Vue-fast),Oracle版本[future-Vue-Oracle](https://github.com/yangzongzhuan/future-Vue-Oracle),保持同步更新。
-* 不分离版本,请移步[future](https://gitee.com/y_project/future),微服务版本,请移步[future-Cloud](https://gitee.com/y_project/future-Cloud)
-* 特别鸣谢:[element](https://github.com/ElemeFE/element),[vue-element-admin](https://github.com/PanJiaChen/vue-element-admin),[eladmin-web](https://github.com/elunez/eladmin-web)。
-
-## 内置功能
-
-1.  用户管理:用户是系统操作者,该功能主要完成系统用户配置。
-2.  部门管理:配置系统组织机构(公司、部门、小组),树结构展现支持数据权限。
-3.  岗位管理:配置系统用户所属担任职务。
-4.  菜单管理:配置系统菜单,操作权限,按钮权限标识等。
-5.  角色管理:角色菜单权限分配、设置角色按机构进行数据范围权限划分。
-6.  字典管理:对系统中经常使用的一些较为固定的数据进行维护。
-7.  参数管理:对系统动态配置常用参数。
-8.  通知公告:系统通知公告信息发布维护。
-9.  操作日志:系统正常操作日志记录和查询;系统异常信息日志记录和查询。
-10. 登录日志:系统登录日志记录查询包含登录异常。
-11. 在线用户:当前系统中活跃用户状态监控。
-12. 定时任务:在线(添加、修改、删除)任务调度包含执行结果日志。
-13. 代码生成:前后端代码的生成(java、html、xml、sql)支持CRUD下载 。
-14. 系统接口:根据业务代码自动生成相关的api接口文档。
-15. 服务监控:监视当前系统CPU、内存、磁盘、堆栈等相关信息。
-16. 缓存监控:对系统的缓存信息查询,命令统计等。
-17. 在线构建器:拖动表单元素生成相应的HTML代码。
-18. 连接池监视:监视当前系统数据库连接池状态,可进行分析SQL找出系统性能瓶颈。
-
-
-## 演示图
-
-<table>
-    <tr>
-        <td><img src="https://oscimg.oschina.net/oscnet/cd1f90be5f2684f4560c9519c0f2a232ee8.jpg"/></td>
-        <td><img src="https://oscimg.oschina.net/oscnet/1cbcf0e6f257c7d3a063c0e3f2ff989e4b3.jpg"/></td>
-    </tr>
-    <tr>
-        <td><img src="https://oscimg.oschina.net/oscnet/up-8074972883b5ba0622e13246738ebba237a.png"/></td>
-        <td><img src="https://oscimg.oschina.net/oscnet/up-9f88719cdfca9af2e58b352a20e23d43b12.png"/></td>
-    </tr>
-    <tr>
-        <td><img src="https://oscimg.oschina.net/oscnet/up-39bf2584ec3a529b0d5a3b70d15c9b37646.png"/></td>
-        <td><img src="https://oscimg.oschina.net/oscnet/up-936ec82d1f4872e1bc980927654b6007307.png"/></td>
-    </tr>
-	<tr>
-        <td><img src="https://oscimg.oschina.net/oscnet/up-b2d62ceb95d2dd9b3fbe157bb70d26001e9.png"/></td>
-        <td><img src="https://oscimg.oschina.net/oscnet/up-d67451d308b7a79ad6819723396f7c3d77a.png"/></td>
-    </tr>	 
-    <tr>
-        <td><img src="https://oscimg.oschina.net/oscnet/5e8c387724954459291aafd5eb52b456f53.jpg"/></td>
-        <td><img src="https://oscimg.oschina.net/oscnet/644e78da53c2e92a95dfda4f76e6d117c4b.jpg"/></td>
-    </tr>
-	<tr>
-        <td><img src="https://oscimg.oschina.net/oscnet/up-8370a0d02977eebf6dbf854c8450293c937.png"/></td>
-        <td><img src="https://oscimg.oschina.net/oscnet/up-49003ed83f60f633e7153609a53a2b644f7.png"/></td>
-    </tr>
-	<tr>
-        <td><img src="https://oscimg.oschina.net/oscnet/up-d4fe726319ece268d4746602c39cffc0621.png"/></td>
-        <td><img src="https://oscimg.oschina.net/oscnet/up-c195234bbcd30be6927f037a6755e6ab69c.png"/></td>
-    </tr>
-    <tr>
-        <td><img src="https://oscimg.oschina.net/oscnet/b6115bc8c31de52951982e509930b20684a.jpg"/></td>
-    </tr>
-</table>
-
+# springboot插件化开发
+## 一 简介
+### 1.1 使用框架
+    使用spring boot插件式开发集成包SpringBoot Plugin Framework框架。此框架可在SpringBoot项目上开发出用于扩展项目的插件,可在插件模块中单独定义接口、静态文件、mybatis-xml等扩展功能。
+    
+这个框架的核心功能:
+1. 插件配置式插拔于springboot项目。
+2. 在springboot上可以进行插件式开发, 扩展性极强, 可以针对不同项目开发不同插件, 进行不同插件jar包的部署。
+3. 可通过配置文件指定要启用或者禁用插件。
+4. 支持上传插件和插件配置文件到服务器, 并且无需重启主程序, 动态部署插件、更新插件。
+5. 支持查看插件运行状态, 查看插件安装位置。
+6. 无需重启主程序, 动态的安装插件、卸载插件、启用插件、停止插件、备份插件、删除插件。
+7. 在插件应用模块上可以使用Spring注解定义组件, 进行依赖注入。
+8. 支持在插件中开发Rest接口。
+9. 支持在插件中单独定义持久层访问等需求。
+10. 可以遵循主程序提供的插件接口开发任意扩展功能。
+11. 支持注解进行任意业务场景扩展, 并使用定义的坐标进行场景命中。
+12. 插件可以根据生产和开发环境自定义独立的配置文件。目前只支持yml文件。
+13. 支持自定义扩展开发接口, 使用者可以在预留接口上扩展额外功能。
+14. 支持插件之间的通信。
+15. 支持插件接口文档: `Swagger`、`SpringDoc`。
+16. 插件支持`拦截器`的定制开发。
+
+### 1.2扩展包功能
+
+1. SpringBoot Mybatis扩展包
+
+- 支持在插件中自定义Mapper接口、Mapper xml 以及对应的实体bean
+- 支持插件独立定义数据源
+- 支持集成 `Mybatis`
+- 支持集成 `Mybatis-Plus`
+- 支持集成`Tk-Mybatis`
+
+详见 [插件SpringBoot Mybatis扩展(opens new window)](https://gitee.com/starblues/springboot-plugin-framework-parent/wikis/pages?sort_id=1693493&doc_id=343010)
+
+1. 静态资源访问扩展包
+
+- 支持通过http访问插件中静态资源
+- 支持集成`Thymeleaf`
+
+详见 [插件静态资源访问扩展(opens new window)](https://gitee.com/starblues/springboot-plugin-framework-parent/wikis/pages?sort_id=1719990&doc_id=343010)
+
+### [#](http://www.starblues.cn/doc/quick-doc/功能介绍.html#运行环境)运行环境
+
+1. jdk1.8+
+2. apache maven 3.6
+3. spring-boot 2.0.0+
+    
+