diboot/README.md

79 lines
3.7 KiB
Markdown
Raw Normal View History

2019-06-04 20:51:41 +08:00
<p align="center">
<a href="http://www.apache.org/licenses/LICENSE-2.0.html" target="_blank">
<img src="https://img.shields.io/hexpm/l/plug.svg">
</a>
</p>
# diboot-v2
diboot 2.0版本项目,实现: diboot-core全新内核 + diboot-devtools代码生成。
2019-06-22 16:28:28 +08:00
### ** diboot-core: 精简优化内核
全新精简内核主要实现单表CRUD和多表关联绑定的无SQL实现方案并提供其他常用开发场景的简单封装。
#### 单表CRUD无SQL
> 基于Mybatis-Plus实现Mybatis-Plus具备通用Mapper方案和灵活的查询构造器
#### 多表关联查询无SQL适用于大多数场景拆分成单表查询自动实现结果绑定
2019-06-22 16:01:36 +08:00
> 通过注解实现多数场景下的关联查询无SQL化自动绑定
2019-06-27 11:49:49 +08:00
##### 1. @BindDict 注解自动绑定数据字典(枚举值)的显示值Label
2019-06-22 16:01:36 +08:00
##### 2. @BindField 注解自动绑定其他表的字段
##### 3. @BindEntity 注解自动绑定单个其他表实体Entity
##### 4. @BindEntityList 注解自动绑定其他表实体集合List<Entity>
2019-06-22 16:01:36 +08:00
具体请查看: [diboot-core 注解自动绑定多表关联](https://github.com/dibo-software/diboot-v2/tree/master/diboot-core "注解自动绑定多表关联").
2019-06-22 16:28:28 +08:00
> ...
2019-06-22 16:28:28 +08:00
### ** diboot-shiro: 基于RBAC+Shiro的权限认证模块
2019-06-22 16:01:36 +08:00
RBAC的角色权限+基于Shiro的细粒度权限控制
2019-06-23 01:40:35 +08:00
#### 1、@AuthorizationPrefix
2019-06-23 01:33:43 +08:00
类注解,与@AuthorizationWrapper搭配使用设置通用权限前缀作用域为当前类的所有方法
2019-06-23 01:40:35 +08:00
#### 2、@AuthorizationWrapper
2019-06-23 01:33:43 +08:00
类/方法注解在保证shiro的@RequirePermissions注解的功能基础上增加名称、权限前缀特性使用方式同@RequiresPermissions
2019-06-23 01:40:35 +08:00
2019-08-06 10:46:49 +08:00
#### 3、@AuthorizationCache
方法注解,在资源授权校验过程中,系统会频繁与数据库进行交互,故而提供缓存机制
* 缓存时机:缓存会在用户第一次进行权限验证的之后缓存数据
* 当前注解作用:如果通过系统调整权限,只需要将该注解加在更新或添加权限处,将会清空权限缓存,下次进入将重新加载权限
#### 3、AuthorizationProperties
提供一些权限相关的配置,主要包括:
- 权限环境变量提供dev、test、prod三种选项
- 默认dev非dev状态下每次都将读取当前启动系统中所有权限不在系统内的权限将会自动物理删除多人协作的开发环境建议使用默认配置
- 权限是否入库:
- 默认false但是我们建议开启将会自动读取系统中的权限到数据库
- 拥有所有权限的角色:
- 如果想给予角色所有资源权限那么直接设置用户为配置的角色即可如果不配置那么默认使用的是ADMIN角色
示例配置:
```
#权限是否存储数据库:默认不开启
diboot.shiro.auth.storage=true
#存储环境默认dev环境不会删除代码中不存在的权限
diboot.shiro.auth.env=dev
#配置所有资源均可访问的角色ALL1、ALL2、ALL3不配置时默认最高权限为ADMIN
diboot.shiro.auth.has-all-permissions-role-list[0]=ALL1
diboot.shiro.auth.has-all-permissions-role-list[1]=ALL2
diboot.shiro.auth.has-all-permissions-role-list[2]=ALL3
2019-08-06 10:46:49 +08:00
#配置权限缓存机制
##是否开启缓存
diboot.shiro.cache.permission-caching-enabled=true
##缓存方式暂时提供shiro内置的内存缓存
diboot.shiro.cache.cache-way=memory
```
#### 4、AuthorizationStorage
调用该类autoStorage传入spring上下文参数使用参考diboot-example 中ExampleListener类
2019-06-23 01:33:43 +08:00
2019-06-22 16:28:28 +08:00
### ** diboot-example: 示例
各组件使用示例项目
2019-06-22 16:01:36 +08:00
> 运行example需先执行/resources/init-mysql.sql到数据库。
2019-06-22 16:28:28 +08:00
### ** diboot-devtools 代码生成工具
2019-06-22 16:01:36 +08:00
> 比 1.x 版本更强大的代码生成工具 ...
...