# auth-system

**Repository Path**: gonghs/auth-system

## Basic Information

- **Project Name**: auth-system
- **Description**: 简单的权限系统
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-04-04
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# auth-system
## 简介
这是使用了springboot,shiro,mybatis-plus,redis等开发的一个简单的权限项目(目前完成了一些通用的封装 尚未全部完成)

## 项目结构介绍
```
mp-server(主服务)
.
├── common (一些通用的内容 不会涉及实现)
│   ├── anno 所有的自定义注解类
│   ├── entity 全局的实体类
│   └── enums 全局的基础枚举
├── controller(控制器)
├── dao(数据访问层)
├── dto(数据对象)
├── function(包含一些系统职能相关的内容 包括定时任务,策略服务,过滤器,拦截器等)
│   ├── aspect 放置所有的aop切面
│   ├── auth 权限相关的类
│   ├── basic 放置一些提供实现的基本类
│   ├── config 包含spring的一些bean配置
│   ├── filter 过滤器
│   ├── handler 处理器
│   ├── interceptor 拦截器
│   ├── job 定时任务
│   └── strategy 策略相关
│       ├── enums 策略枚举
│       ├── factory 策略工厂
│       └── service 策略服务
├── properties(系统配置类)
├── service(服务层)
├── tool(业务相关的工具类)
└── util(业务无关的工具类)
mp-common-core(核心工具 提供工具依赖和一些自定义工具)
mp-code-generator-spring-boot-starter(代码生成器starter)
mp-shiro-spring-boot-starter(shiro starter)
```

## starter配置介绍

### mp-code-generator-spring-boot-starter
示例表创建语句:
```mysql
create table test
(
    id           varchar(32)         not null
        primary key comment '主键',
    username     varchar(30) null comment '用户名',
    audit_status int         null comment '状态 #E{1(UN_SUBMIT):未提交,2:待审核,3:审核中,4:审核通过,5:审核不通过}',
    create_user  varchar(30) null comment '创建人',
    create_time  date        null comment '创建时间',
    modify_user  varchar(30) null comment '修改人',
    modify_time  date        null comment '修改时间',
    data_status  int null comment '数据状态 #E{1:有效,0:无效}'
) comment '测试表';
```
配置前缀为mp.tool.generator,数据库配置默认由spring.datasource或spring.datasource.druid下读取
为了方便配置读取需要借助spring注入运行
```java
@RunWith(SpringRunner.class)
@SpringBootTest(classes = CodeGeneratorAutoConfiguration.class)
public class AutoGeneratorTest {
    @Autowired
    private CodeGeneratorUtils codeGeneratorUtils;

    @Test
    public void generator() {
        codeGeneratorUtils.generator();
    }
}
```
支持所有的原生配置,例如:
```yaml
mp:
  tool:
    generator:
      global:
        fileOverride: true
```
将部分配置移动至顶层并新增部分配置,以下仅介绍新增配置
枚举序列化配置可以参考文章[如何在springboot优雅的使用枚举](http://www.ice-maple.com/2020/06/23/Springboot%20Enum/)
```yaml
hx:
  tool:
    # 相当于globalConfig.include
    gen-tables: xxx,xxx
    # 相当于packageConfig.parent
    base-package: com.maple
    # 模块名 模块名将统一插入实际生成的文件之前 例如entity的文件路径将是 basePackage + entity + modelName + '文件名'
    model-name: admin
    # 定义组织目录的方式(即文件的目录结构) 以entity为例默认为 entityDir(dir) + basePackage(pkg) + entity(subPkg) + modelName(dir)
    path-struct: '{dir}/{pkg}/{subPkg}/{mod}'
    # 增加相关的dir配置 dir不会纳入包名中 可使用%s占位 将会全部替换为modelName
    package-config:
      entity-dir: mp-entity-%s
      mapper-dir: mp-mapper-%s
      service-dir: mp-service-%s
      serviceImpl-dir: mp-service-%s
      controller-dir: mp-controller-%s
      # 如果需要单独为某个生成模板组织目录 可采用此配置 定义方式与path-struct类似 可以使用｛global｝直接获取path-struct的值
      custom-path: 
        serviceImpl: '{global}.impl'
        reqDto: '{global}.req'
        respDto: '{global}.resp'
    # 自定义模板 template-type指定拷贝某个模板 class-name为变更的类名（若无变更则相当于没配置） 若要重新指定目录则在 custom-path 以template.name为key处指定
    template-config:
      custom-templates:
        - name: reqDto
          template-type: entity
          class-name: '%sReqDTO'
        - name: respDto
          template-type: service
          class-name: '%sRespDTO'  
     
    #枚举生成相关配置 由于是额外功能 因此单独列一个配置 根据注释生成枚举 基本格式为 注释满足格式#E{} 则生成一个枚举类 默认枚举名自动翻译 内容为[码值](枚举名):[描述]:[字段]...,[码值]:[描述]:[字段]... 
    # 例如 #E{1(VALID):有效,0:无效};
    enum-config:
      # 是否开启 默认不开启
      enabled: true
      # 是否使用lombok 默认使用 为枚举增加@Getter和@AllArgsConstructor
      lombokModel: true
      # 目录名
      enumDir: 
      # 包名
      enum-pkg-name: com.maple.BaseEnum
      # 实现接口 目前只支持一个
      implement-interface: com.maple.BaseEnum
      # 枚举模板路径
      template-path: /templates/fieldEnum.java
      # 反序列化配置 目前只支持fastJson和jackson 如果采用全局配置的方式可以忽略 
      # fastJson在类上追加 @JsonDeserialize(using = JacksonEnumSerializer.class)
      # jackson在类上追加 @JSONType(deserializer = ${deserializerClassName}.class)   
      deserializer-type: jackson
      # 反序列化类 此配置为空则不会增加反序列配置注解
      deserializer-class: com.maple.JacksonEnumSerializer
```

计划变更: 优化生成枚举功能，自行解析yaml文件
  
### mp-shiro-spring-boot-starter
基于官方starter再封装  
配置前缀为mp.shiro,支持所有官方starter配置,例如:
```yaml
shiro:
  loginUrl: /login
  successUrl: /
  sessionManager:
    cookie:
      name: MPJSESSIONID
      maxAge: 200000
  unauthorizedUrl: /error/403
```
额外增加的配置:
```yaml
mp:
  shiro:
    # 过滤链 由最后一个:分隔anon user等权限动作
    filter-chain:
      - /login:anon
      - /logout:logout
      - /**:jwt,authc
    # 由全限定包名自动加载realms并设置加密方式 也支持直接用bean形式定义 自选即可
    realms:
      - realm:
        target: com.maple.server.function.auth.MyRealm
        credentials-matcher:
          target: org.apache.shiro.authc.credential.HashedCredentialsMatcher
          property:
            hashAlgorithmName: MD5
            hashIterations: 2
            storedCredentialsHexEncoded: true
    # 自动代理创建配置 由于官方默认配置会使权限注解与aop冲突 因此增加此配置自定义
    advisor-auto-proxy-creator:
      use-prefix: true
      proxy-target-class: false
    cache:
      redis:
        # 是否开启redis进行session管理 redis配置自动由spring.redis下读取
        enable: true
        # 标识不同用户所用的字段
        principalIdFieldName: id
        # 过期时间
        expire: 20000
    web:
      # 以map形式读取并覆盖默认shiro filter
      filters:
        authc: com.maple.starter.shiro.filter.CustomUserFilter
    jwt:
      # 是否开启jwt 开启则自动注册jwtRealm jwtFilter(name为jwt)
      enable: true
      # token生成秘钥
      secret: xxxxxx
      # 过期时间
      expire: 200000
      # token请求时的前缀
      prefix: Bearer 
      # token签名时返回的前缀 通常和prefix是一个值
      sign-prefix: Bearer 
      # 请求头携带token的key
      header-key: Authorization
```

计划变更: 从官方starter依赖中独立出来

## 数据库介绍
初始化sql详见init.sql项目引入了liquibase配置数据库启动项目将会自动执行
如果需要关闭自动执行请修改配置spring.liquibase.enabled属性为false

## 系统工具介绍
### 后台工具
#### 缓存工具
```
// 配置项目prefix 在application.yml/application.properties 工具类和注解中的实际key将加上这个值
cache.prefix=...
// 普通工具类(注入使用)
@Autowired
RedisUtils redisUtils;
//设置缓存且不超时
redisUtils.set(key,object);
//设置缓存且自定义超时时间(/分钟)
redisUtils.set(key,object,ttlMinutes);
//设置缓存且自定义超时时间和时间单位
redisUtils.set(key,object,ttl,timeUnit);
//获取对象 什么类型存入就以什么类型取出来
redisUtils.get(key);
 
// 缓存切面(任意方法上使用,key支持SpEL表达式) 
// 此例将为该方法返回值设置10分钟的key为 fileCache-[key]的缓存,即接下来10分钟从缓存获取方法返回值。
// 注: 当切面方法返回值为 Optional,Map,List类型时 内容不存在不会存储缓存
@Cache(key = "'fileCache-' + #key",ttlMinutes = 10)
public List<UserDTO> queryList(String key)
```
#### 用户上下文注入
```
//方法拦截器将会为任意带CurrentUser注解的UserDTO对象注入获取到的用户上下文
public UserDTO getUser(@CurrentUser UserDTO userDTO)
```
#### 策略模式
提供的策略实现包含三部分内容:策略工厂，策略枚举和策略服务
工厂声明 策略使用时主要是注入工厂根据枚举值获取服务,为了便于拓展 策略接口可由使用方自行定义:
```java
@Component
public class TestStrategyFactory extends BaseStrategyFactory<TestStrategyEnum, StrategyService> {}
```
枚举声明 枚举的码值需要和spring的bean名称相同:
```java
public enum TestStrategyEnum implements BaseStrategyEnum {
    /**
     * 枚举信息
     */
    SERVICE1(TestService1Impl.class, "测试策略1"), SERVICE2(TestService2Impl.class, "测试策略2");

    TestStrategyEnum(Class<?> clazz, String strategyDesc) {
        this.value = SpringUtils.getBeanNameByType(clazz);
        this.strategyDesc = strategyDesc;
    }

    /**
     * 策略值
     */
    private String value;
    /**
     * 策略描述
     */
    private String strategyDesc;

    @Override
    public String getValue() {
        return value;
    }

    @Override
    public String getStrategyDesc() {
        return strategyDesc;
    }
}
```
服务声明 提供了几个可用的接口(分别对应无参数无返回值[StrategyService] 一参数一返回值[FunctionStrategyService] 二参数一返回值[BiFunctionStrategyService]) 
不满足需求也可自行定义:
```java
@Service
@Slf4j
public class TestService1Impl implements StrategyService {
    @Override
    public void exec() {
        log.info("service1");
    }
}
```
使用:
```java
public class StrategyFactoryTest extends BaseTest {
    @Autowired
    private TestStrategyFactory testStrategyFactory;

    @Test
    public void testService() {
        testStrategyFactory.getByType(TestStrategyEnum.SERVICE1).exec();
    }
}
```


### 前端工具

#### tableServer.js
基于amaze-ui data-tables的一层封装详见文档:
[tableServer](http://note.youdao.com/noteshare?id=d1831a1a33f68265315104999e5d8085&sub=9EF2DC58A15C42E78290038D73133345)

#### operateServer.js

#### strTool.js

#### optional.js