logo
0
0
WeChat Login
zhangjin<23231269@qq.com>
docs(readme): 更新 AuthServiceHelper 和 uw-common-app 相关文档- 更新 AuthServiceHelper 文档,增加 logRef 和 logSysInfo 方法说明 - 更新 uw-common-app 文档,详细说明权限自动化管理的实现方式 - 新增 IdQueryParam、IdStateQueryParam 等预置 QueryParam 说明

[TOC]

简介

uw-common-app是基于uw框架web端的公共库。

  • 基于uw-auth-service的AuthServiceHelper和uw-dao的QueryParam的自动化权限注入管理。
  • 基于后台应用管理中,常见的关键操作日志(SysCritLog)和数据历史(SysDataHistory)功能。
  • 基于Json的应用配置管理功能。

后台查询的自动化权限注入管理

通过结合uw-auth-service的AuthServiceHelper和uw-dao的QueryParam,提供自动化权限注入管理。 Auth权限自动化管理通过四个关键字段来组成,包括saasId,mchId,groupId,userId。

  • saasId:saasId,默认为0,表示当前系统为单租户系统。
  • mchId:mchId,默认为0,表示当前系统为单商户系统。
  • groupId:groupId,默认为0,表示当前系统为单用户组系统。
  • userId:userId,默认为0,表示当前系统为单用户系统。 提供了如下预制QueryParam:
  • IdQueryParam 封装了id查询参数,支持链式调用,可以消除sql连接。
  • IdStateQueryParam 封装了id和状态查询参数,支持链式调用,可以消除sql连接。
  • AuthQueryParam 封装了Auth查询参数,支持链式调用,可以消除sql连接。
  • AuthIdQueryParam 封装了Auth处理的id和状态查询参数,支持链式调用,可以消除sql连接。
  • AuthIdStateQueryParam 封装了Auth处理的id和状态查询参数,支持链式调用,可以消除sql连接。 同时,基于QueryParam的SET_COND_PARAM可以方便的附加额外参数。

后台关键操作记录

后台操作历史已经由uw-auth-service的uw.auth.action.log日志实现,但是Es的生命周期管理可能会导致日志的周期性删除。 通过设置Log.CRIT属性,可以将关键日志中转之第三方存储系统,如默认的AuthCriticalLogStorage,可以将日志存储于mysql数据库中。

数据历史记录

通过SysDataHistoryHelper,可以将数据变更记录到数据库中,便于数据回滚。 同时提供了对应的QueryParam和entity,方便后期查询。

JSON配置管理

通过JsonConfigHelper和JsonConfigParam,可以方便的将JSON配置管理到数据库中,方便后期查询。 通过对JsonConfigParam对参数进行定义,实际存储可使用Map结构。 同时提供了配置参数读取的强类型方法,提供了强类型的校验方法。

  • JsonConfigHelper: 可以方便的将JSON配置管理到数据库中,方便后期查询。
  • JsonConfigBox: 封装一组配置数据到一个盒子中,提供参数校验和类型化读取方法。
  • JsonConfigParam: Json配置参数定义接口。封装了类型,变量key,变量默认值,参数名,参数描述,校验规则等信息。
  • JsonConfigParam.ParamType: Json配置参数类型。
  • JsonConfigParam.ParamData: Json配置参数数据。

i18n国际化

针对i18n国际化,提供了uw-common-app的i18n国际化支持。