功能描述

实现对数据库的增删改查操作及日志记录。 支持mysql、mongdb、elasticsearch数据库。 系统支持mybatis，可配置是否开启mybatis。 系统支持表结构导出、表结构同步、表数据导出、表数据同步。

mybatis配置一览表

提示

需在application.yml中设置mybatis-plus.enabled为true才能开启mybatis服务。

mybatis-plus:
  enabled: false  #是否开启mybatis-plus
  #全局config参数配置
  #config-location: classpath:mybatis/mybatis-config.xml
  #扫描mapper类路径配置
  mapper-scan: sei.cloud.data.mapper
  #扫描mapper的xml文件路径配置
  mapper-locations: classpath*:mybatis/mapper/**/*.xml
  #实体扫描，多个package用逗号或者分号分隔
  type-aliases-package: sei.cloud.data.entry
#  type-enums-package: com.baomidou.springboot.entity.enums
  global-config:
    #主键类型  0:"数据库ID自增", 1:"用户输入ID",2:"全局唯一ID (数字类型唯一ID)", 3:"全局唯一ID UUID";
    id-type: 2
    #字段策略 0:"忽略判断",1:"非 NULL 判断"),2:"非空判断"
    field-strategy: 2
    #驼峰下划线转换
    db-column-underline: true
    #刷新mapper 调试神器
    refresh-mapper: true
    #数据库大写下划线转换
    #capital-mode: true
    #序列接口实现类配置,不在推荐使用此方式进行配置,请使用自定义bean注入
#    key-generator: com.baomidou.mybatisplus.incrementer.H2KeyGenerator
    #逻辑删除配置（下面3个配置）
    logic-delete-value: 0
    logic-not-delete-value: 1
    #自定义sql注入器,不在推荐使用此方式进行配置,请使用自定义bean注入
#    sql-injector: com.baomidou.mybatisplus.mapper.LogicSqlInjector
    #自定义填充策略接口实现,不在推荐使用此方式进行配置,请使用自定义bean注入
#    meta-object-handler: com.baomidou.springboot.MyMetaObjectHandler
    #自定义SQL注入器
    #sql-injector: com.baomidou.springboot.xxx
    # SQL 解析缓存，开启后多租户 @SqlParser 注解生效
    sql-parser-cache: true
  configuration:
    map-underscore-to-camel-case: true
    cache-enabled: false

mysql配置一览表

配置文件为application-sqldb.yml

提示

需在application.yml中增加spring.profiles.active中增加datasource-sqldb才能激活配置文件

spring:
  jpa:
    open-in-view: false
    database: MYSQL # 配置 DBMS 类型
    show-sql: true  # 配置是否将执行的 SQL 输出到日志
    properties:
      hibernate:
        hbm2ddl:
          auto: update  # 配置开启自动更新表结构

  # 数据库密码加密设置方式
  # 1、找到 druid-1.1.22.jar 文件并进入该目录
  # 2、假设数据库口令为root，则执行命令： java -cp druid-1.1.22.jar com.alibaba.druid.filter.config.ConfigTools root
  # 3、将生成的 password 字符串拷贝到下面的配置文件中的 password 选项中
  # 4、将生成的 publicKey 字符串拷贝到下面的配置文件中的 publicKey 选项中并去掉注释
  # 5、重新启动服务器
  datasource:
    #druid的监控页面用户名口令设置
    druid-filters:
      user-name: admin
      user-password: xiong
      # wall: 127.0.0.1

    master: #缺省数据库
      key: seicloud
      name: 系统账套
      type: com.alibaba.druid.pool.DruidDataSource
      # 如果对数据库密码进行了加密，则设置公钥，否则不设置
      # publicKey:
      url: jdbc:mysql://127.0.0.1:3306/sei-cloud?autoReconnect=true&useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&noAccessToProcedureBodies=true&serverTimezone=Asia/Shanghai&nullCatalogMeansCurrent=true
      username: root
      password: root
      driver-class-name: com.mysql.cj.jdbc.Driver
      initial-size: 10
      min-idle: 10
      max-active: 150
      # 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒
      time-between-eviction-runs-millis: 90000
      # 配置一个连接在池中最小生存的时间，单位是毫秒
      min-evictable-idle-time-millis: 300000
      # Oracle请使用select 1 from dual
      validation-query: SELECT 1
      test-while-idle: true
      test-on-borrow: false
      test-on-return: false
      # 配置监控统计拦截的filters，去掉后监控界面sql无法统计，'wall'用于防火墙
      filters: stat
      log-slow-sql: false
      # 通过connectProperties属性来打开mergeSql功能；慢SQL记录
      connection-properties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000
      # 合并多个DruidDataSource的监控数据
      use-global-data-source-stat: true

#    slave:  #其它数据库
#      - key: slave1  #其它数据库1
#        。。。其它配置选项与master相同
#      - key: slave2  #其它数据库2
#        。。。其它配置选项与master相同

mongodb配置一览表

配置文件为application-mongodb.yml

提示

(1) 需在application.yml中增加spring.profiles.active中增加datasource-mongodb才能激活配置文件 (2) 需设置application-mongodb.yml中的spring.data.mongodb.enabled为true才能开启mongodb服务

spring:
  data:
    mongodb:
      enabled: true #设置为true才开启mongodb服务
      host: 127.0.0.1
      port: 27017
#      authentication-database: admin
#      username:
#      password:
      database: sei-cloud-log    #指定操作的数据库

elasticsearch配置一览表

配置文件为application-elasticsearch.yml

提示

(1) 需在application.yml中增加spring.profiles.active中增加datasource-elasticsearch才能激活配置文件 (2) 需设置application-elasticsearch.yml中的spring.elasticsearch.enabled为true才能开启elasticsearch服务

spring:
  elasticsearch:
    enabled: false #设置为true才启动elasticsearch服务
    host: 127.0.0.1:9200  #多个ip之间用逗号分隔
    user:
    password:

mysql接口

第一步 引入包

<dependency>
    <groupId>sei-cloud</groupId>
    <artifactId>datasource</artifactId>
</dependency>

第二步 引入接口

@Resource
    DataService dataService;

第三步 使用接口

package sei.cloud.datasource;

/**
 * SQL操作
 * @author xiong
 */
public interface SQLService {

    /**
     * 获得数据源
     * @return Connection
     */
    Connection getConnection();

    /**
     * 释放数据源
     * @param con: 数据库连接
     */
    void closeConnection(@NonNull Connection con);

    /**
     * 执行sql的ddl语句(建表/导入数据等)
     * @param reader: 读取
     */
    void runSQLScript(Reader reader);

    /**
     * 导出数据
     * @param table: 要导入的表
     * @param SQL: 导出数据的SQL
     * @param insert: 是否需要插入语句
     * @param duplicate: 在插入语句中是否使用 ON DUPLICATE KEY UPDATE,即：如果主键或唯一索引不存在则插入，如果存在则更新
     * @param checkExists: 是否需要检查存在的语句
     * @param delete: 是否需要删除语句
     * @param update: 是否需要更新语句
     * @param deleteOrUpdateWhere: 使用删除语句或更新语句时的where条件字段
     * @return Map
     * @throws SQLException: 异常
     * 规则：
     *   checkExists为true时则先根据deleteOrUpdateWhere判断是否存在，如果不存在则插入，如果存在则删除后再插入(delete为true时)，或者更新或插入
     *   checkExists为false时，先删除再插入或先更新失败后再插入
     */
    Map<String, Object> exportSQLData(String table, String SQL, boolean insert, boolean duplicate, boolean checkExists, boolean delete, boolean update, String... deleteOrUpdateWhere) throws SQLException;

    /**
     * 导入SQL数据
     * @param map: 系统固定的res格式的文件实例化后的map
     * @throws SQLException: 异常
     */
    void importSQLData(Map<String, JSONObject> map) throws SQLException;

    /**
     * 导入SQL数据
     * @param filePathName: 系统固定的res格式的文件
     * @param delFile: 完成后是否删除文件
     * @throws SQLException: 异常
     */
    void importSQLData(String filePathName, boolean delFile) throws SQLException, IOException;

    /**
     * 判断表是否具有软删除特性(判断标准为表中有_del字段)
     * @param tableName: 表名称
     * @return boolean
     * @throws SQLException 异常
     */
    boolean isDeleteTable(@NonNull String tableName) throws SQLException;

    /**
     * 判断表是否为树型结构(判断标准为表中有_pid字段)
     * @param tableName: 表名称
     * @return boolean
     * @throws SQLException 异常
     */
    boolean isTreeTable(@NonNull String tableName) throws SQLException;

    /**
     * 判断表是否为工作流表结构(判断标准为表中有_flowid字段)
     * @param tableName: 表名称
     * @return boolean
     * @throws SQLException 异常
     */
    boolean isWorkflowTable(@NonNull String tableName) throws SQLException;

    /**
     * 获得指定模块的主表名
     * @param module: 模块标识
     * @return String | null
     * @throws SQLException 异常
     */
    String getMainTableName(@NonNull String module) throws SQLException;

    /**
     * 获得指定模块的子表名
     * @param module: 模块标识
     * @return List
     * @throws SQLException 异常
     */
    List<String> getSubTableName(@NonNull String module) throws SQLException;

    /**
     * 分页函数
     * @param currPageNumber: 当前页码
     * @param pageSize: 每一页记录数
     * @param beanClass: 结果类型
     * @param sql: SQL语句
     * @param parameterValue: SQL语句中的问号参数值
     * @param <T> T
     * @return PageVo
     * @throws SQLException 异常
     */
    <T> PageVo<T> getPage(int currPageNumber, int pageSize, Class<T> beanClass, @NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 分页函数
     * @param currPageNumber: 当前页码
     * @param pageSize: 每一页记录数
     * @param sql: SQL语句
     * @param parameterValue: SQL语句中的问号参数值
     * @return PageVo
     * @throws SQLException 异常
     */
    PageVo<XJSONObject> getPage(int currPageNumber, int pageSize, @NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 获得树形结构表的所有上级指定字段内容
     * @param includeSelf: 是否包含自身
     * @param table: 表
     * @param keyField: 主键字段
     * @param value: 主键字段值
     * @param fields: 要拿的字段,逗号分隔
     * @return List
     * @throws SQLException 异常
     */
    List<XJSONObject> getTreeParent(boolean includeSelf, String table, String keyField, String value, String fields) throws SQLException;

    /**
     * 获得树形结构表的所有下级指定字段内容
     * @param includeSelf: 是否包含自身
     * @param table: 表
     * @param keyField: 主键字段
     * @param value: 主键字段值
     * @param fields: 要拿的字段,逗号分隔
     * @return List
     * @throws SQLException 异常
     */
    List<XJSONObject> getTreeChildren(boolean includeSelf, String table, String keyField, String value, String fields) throws SQLException;

    /**
     * 获得树型结构的父级字段以斜杠/分隔的联合值
     * @param table: 树型表名称
     * @param fieldName: 树型表当前记录树字段名称
     * @param parentFieldValue: 树型表当前记录树字段值
     * @param fields: 要获得的字段列表
     * @return List(与fields内字段顺序对应的结果列表)
     * @throws SQLException 异常
     */
    List<String> getTreeParentFieldValue(@NonNull String table, @NonNull String fieldName, @Nullable Object parentFieldValue, @NonNull List<String> fields) throws SQLException;

    /**
     * 获得父ID值为fieldValue的所有子节点fieldName字段的值
     * @param table: 树型表名称
     * @param fieldName:  要拿的树型表字段名
     * @param isIncludeParent: 是否包含父节点值
     * @param parameterValue: 父ID值
     * @return List(返回父ID值为fieldValue的所有子节点fieldName字段值,多个值间分后分割)
     * @throws SQLException 异常
     */
    List<Object> getTreeChildFieldValue(@NonNull String table, @NonNull String fieldName, boolean isIncludeParent, Object... parameterValue) throws SQLException;

    /**
     * 获得指定的下级表(子表)和平行表关系
     * @param tableName: 表名
     * @return List | null
     * @throws SQLException  异常
     */
    List<JSONObject> getTableRelation(String tableName) throws SQLException;

    /**
     * 获得平行表数据
     * @param tableName: 源表名称
     * @param keyFieldName: 源表主键字段
     * @param fields: 要获取的字段,为null则所有字段,数据库不存在的字段自动剔除
     * @param row: 源表数据
     * @param targetTableName: 设置要获得的平行表的表名,为null则为所有平行表
     * @return Map
     * @throws SQLException 异常
     */
    Map<String, XJSONObject> getMergeParallelTableData(@NonNull String tableName, @Nullable String keyFieldName, @Nullable Collection<String> fields, @NonNull XJSONObject row, @Nullable String... targetTableName) throws SQLException;

    /**
     * 获得或融合平行表数据
     * @param tableName: 源表名称
     * @param keyFieldName: 源表主键字段
     * @param fields: 要获取的字段,为null则所有字段,数据库不存在的字段自动剔除
     * @param row: 源表数据
     * @param targetTableName: 设置只融合的表,否则获得或融合所有平行表
     * @return Map
     * @throws SQLException 异常
     */
    Map<String, List<XJSONObject>> getSubTableData(@NonNull String tableName, @Nullable String keyFieldName, @Nullable Collection<String> fields, @NonNull XJSONObject row, @Nullable String... targetTableName) throws SQLException;

    /**
     * 将实体Map内容插入到数据库
     * @param tableName: 表名
     * @param map: 字段及值
     * @return int
     * @throws SQLException 异常
     */
    int insertByMap(@NonNull String tableName, @NonNull Map<String, ?> map) throws SQLException;

    /**
     * 将实体Map内容插入或更新到数据库
     * 如果主键或唯一索引不存在则插入，如果存在则更新
     * 注意返回值，如果插入则返回1，更新了数据则返回2，不更新数据则返回0
     * @param tableName: 表名
     * @param map: 字段及值
     * @return int
     * @throws SQLException 异常
     */
    int insertOrUpdateByMap(@NonNull String tableName, @NonNull Map<String, ?> map) throws SQLException;

    /**
     * 将实体Map内容插入或更新到数据库
     * 如果主键或唯一索引不存在则插入，如果存在则先删除后再插入
     * @param tableName: 表名
     * @param map: 字段及值
     * @return int
     * @throws SQLException 异常
     */
    int insertOrReplaceByMap(@NonNull String tableName, @NonNull Map<String, ?> map) throws SQLException;

    /**
     * 将实体Map内容插入到数据库
     * 如果主键或唯一索引不存在则插入，如果存在则忽略
     * @param tableName: 表名
     * @param map: 字段及值
     * @return int
     * @throws SQLException 异常
     */
    int insertOrIgnoreByMap(@NonNull String tableName, @NonNull Map<String, ?> map) throws SQLException;

    /**
     * 插入实体对象数据到数据库
     * @param tableName: 表名
     * @param entity: 字段及值
     * @return int
     * @throws SQLException 异常
     * @throws IllegalArgumentException 异常
     * @throws IllegalAccessException 异常
     */
    int insertByEntity(@NonNull String tableName, @NonNull Object entity) throws SQLException, IllegalArgumentException, IllegalAccessException;

    /**
     * 插入或更新实体对象数据到数据库
     * 如果主键或唯一索引不存在则插入，如果存在则更新数据
     * 注意返回值，如果插入则返回1，更新了数据则返回2，不更新数据则返回0
     * @param tableName: 表名
     * @param entity: 字段及值
     * @return int
     * @throws SQLException 异常
     * @throws IllegalArgumentException 异常
     * @throws IllegalAccessException 异常
     */
    int insertOrUpdateByEntity(@NonNull String tableName, @NonNull Object entity) throws SQLException, IllegalArgumentException, IllegalAccessException;

    /**
     * 插入或替换实体对象数据到数据库
     * 如果主键或唯一索引不存在则插入，如果存在则先删除后再插入
     * @param tableName: 表名
     * @param entity: 字段及值
     * @return int
     * @throws SQLException 异常
     * @throws IllegalArgumentException 异常
     * @throws IllegalAccessException 异常
     */
    int insertOrReplaceByEntity(@NonNull String tableName, @NonNull Object entity) throws SQLException, IllegalArgumentException, IllegalAccessException;

    /**
     * 插入实体对象数据到数据库
     * 如果主键或唯一索引不存在则插入，如果存在则忽略
     * @param tableName: 表名
     * @param entity: 字段及值
     * @return int
     * @throws SQLException 异常
     * @throws IllegalArgumentException 异常
     * @throws IllegalAccessException 异常
     */
    int insertOrIgnoreByEntity(@NonNull String tableName, @NonNull Object entity) throws SQLException, IllegalArgumentException, IllegalAccessException;

    /**
     * 插入数据
     * @param sql: SQL语句
     * @param parameterValue: SQL语句中的问号参数值
     * @return int
     * @throws SQLException 异常
     */
    int insertBySQL(@NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 插入或更新数据
     * 如果主键或唯一索引不存在则插入，如果存在则更新
     * 注意返回值，如果插入则返回1，更新了数据则返回2，不更新数据则返回0
     * @param sql: SQL语句
     * @param parameterValue: SQL语句中的问号参数值
     * @return int
     * @throws SQLException 异常
     */
    int insertOrUpdateBySQL(@NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 插入数据或替换数据
     * 如果主键或唯一索引不存在则插入，如果存在则先删除后再插入
     * @param sql: SQL语句
     * @param parameterValue: SQL语句中的问号参数值
     * @return int
     * @throws SQLException 异常
     */
    int insertOrReplaceBySQL(@NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 插入数据或忽略已经存在的数据
     * 如果主键或唯一索引不存在则插入，如果存在则忽略
     * @param sql: SQL语句
     * @param parameterValue: SQL语句中的问号参数值
     * @return int
     * @throws SQLException 异常
     */
    int insertOrIgnoreBySQL(@NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 插入数据并获得插入记录的自增长主键值
     * @param sql: SQL语句
     * @param returnList: 接收执行结果的返回值,用于插入时获得插入记录的自增长主键值, 为null表示不要
     * @param parameterValue: SQL语句中的问号参数值
     * @return int
     * @throws SQLException 异常
     */
    int insertCallBackBySQL(@NonNull String sql, @Nullable Collection returnList, Object... parameterValue) throws SQLException;

    /**
     * 根据主键字段值删除数据
     * @param tableName: 表名
     * @param keyFieldValue: 主键字段值
     * @return int
     * @throws SQLException 异常
     */
    int deleteByID(@NonNull String tableName, @NonNull String keyFieldValue) throws SQLException;

    /**
     * 根据主键字段值删除数据
     * @param tableName: 表名
     * @param keyFieldName: 主键字名
     * @param keyFieldValue: 主键字段值
     * @return int
     * @throws SQLException 异常
     */
    int deleteByID(@NonNull String tableName, @NonNull String keyFieldName, @NonNull String keyFieldValue) throws SQLException;

    /**
     * 删除数据
     * @param sql: SQL语句
     * @param parameterValue: 对应的参数值
     * @return int
     * @throws SQLException 异常
     */
    int deleteBySQL(@NonNull String sql, @Nullable Object... parameterValue) throws SQLException;

    /**
     * 根据map值删除数据
     * @param tableName: 表名
     * @param map: 条件(字段及值)
     * @return int
     * @throws SQLException 异常
     */
    int deleteByMap(@NonNull String tableName, @NonNull Map<String, Object> map) throws SQLException;

    /**
     * 数据实体值删除数据
     * @param tableName: 表名
     * @param entity: 条件(字段及值)
     * @return int
     * @throws SQLException 异常
     * @throws IllegalArgumentException 异常
     * @throws IllegalAccessException 异常
     */
    int deleteByEntity(@NonNull String tableName, @NonNull Object entity) throws SQLException, IllegalArgumentException, IllegalAccessException;

    /**
     * 根据主键值修改数据
     * @param tableName: 表名
     * @param keyFieldValue: 主键字段值
     * @param newFieldVal: 字段及值
     * @return int
     * @throws SQLException 异常
     */
    int updateByMap(@NonNull String tableName, @NonNull String keyFieldValue, @NonNull Map<String, ?> newFieldVal) throws SQLException;

    /**
     * 根据主键值修改数据
     * @param tableName: 表名
     * @param keyFieldName: 主键字名
     * @param keyFieldValue: 主键字段值
     * @param newFieldVal: 字段及值
     * @return int
     * @throws SQLException 异常
     */
    int updateByMap(@NonNull String tableName, @NonNull String keyFieldName, @NonNull Object keyFieldValue, @NonNull Map<String, ?> newFieldVal) throws SQLException;

    /**
     * 根据主键值修改数据
     * @param tableName: 表名
     * @param keyFieldValue: 主键字段值
     * @param newFieldVal: 字段新的值
     * @return int
     * @throws SQLException 异常
     * @throws IllegalArgumentException 异常
     * @throws IllegalAccessException 异常
     */
    int updateByEntity(@NonNull String tableName, @NonNull String keyFieldValue, @NonNull Object newFieldVal) throws SQLException, IllegalArgumentException, IllegalAccessException;

    /**
     * 根据主键值修改数据
     * @param tableName: 表名
     * @param keyFieldName: 主键字名
     * @param keyFieldValue: 主键字段值
     * @param newFieldVal: 字段及值
     * @return int
     * @throws SQLException 异常
     * @throws IllegalArgumentException 异常
     * @throws IllegalAccessException 异常
     */
    int updateByEntity(@NonNull String tableName, @NonNull String keyFieldName, @NonNull String keyFieldValue, @NonNull Object newFieldVal) throws SQLException, IllegalArgumentException, IllegalAccessException;

    /**
     * 更新数据
     * @param sql: SQL语句
     * @param parameterValue: 对应的参数值
     * @return int
     * @throws SQLException 异常
     */
    int updateBySQL(@NonNull String sql, @Nullable Object... parameterValue) throws SQLException;

    /**
     * 批量更新数据
     * @param sql: SQL语句
     * @param fieldVal: 每一个List条目对应更新的一条数据, 每条数据如果有多个字段则将多个字段值放入List或者Array中
     * @return int
     * @throws SQLException 异常
     */
    int updateBatchBySQL(@NonNull String sql, @NonNull Collection fieldVal) throws SQLException;

    /**
     * 返回查询结果的总行数
     * @param sql: SQL语句,必须包含count函数
     * @param parameterValue: 对应的参数值
     * @return int
     * @throws SQLException 异常
     */
    int selectCountBySQL(@NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 查询数据,返回一条数据指定类型的对象
     * @param sql: SQL语句
     * @param beanClass: 结果转换类型
     * @param parameterValue: 对应的参数值
     * @param <T> T
     * @return T | null
     * @throws SQLException 异常
     * @throws InstantiationException 异常
     * @throws IntrospectionException 异常
     * @throws IllegalAccessException 异常
     * @throws IllegalArgumentException 异常
     */
    <T> T selectOneBySQL(@NonNull String sql, @NonNull Class<T> beanClass, Object... parameterValue) throws SQLException, InstantiationException, IntrospectionException, IllegalAccessException, IllegalArgumentException;

    /**
     * 查询数据,返回一条数据指定类型的对象,每个字段带表名
     * @param sql: SQL语句
     * @param beanClass: 结果转换类型
     * @param parameterValue: 对应的参数值
     * @param <T> T
     * @return T | null
     * @throws SQLException 异常
     * @throws InstantiationException 异常
     * @throws IntrospectionException 异常
     * @throws IllegalAccessException 异常
     * @throws IllegalArgumentException 异常
     */
    <T> T selectOneWithTableNameBySQL(@NonNull String sql, @NonNull Class<T> beanClass, Object... parameterValue) throws SQLException, InstantiationException, IntrospectionException, IllegalAccessException, IllegalArgumentException;

    /**
     * 查询数据,返回第一条数据的Map对象
     * @param sql: SQL语句
     * @param parameterValue: 对应的参数值
     * @return Map
     * @throws SQLException 异常
     */
    XJSONObject selectOneBySQL(@NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 查询数据,返回第一条数据的Map对象
     * @param sql: SQL语句
     * @param fieldCase: 结果字段是否转为大小写,0:数据库原样，1:转小写，2:转大写
     * @param parameterValue: 对应的参数值
     * @return Map
     * @throws SQLException 异常
     */
    XJSONObject selectOneFieldCaseBySQL(@NonNull String sql, int fieldCase, Object... parameterValue) throws SQLException;

    /**
     * 查询数据,返回第一条数据的Map对象并缓存
     * @param cacheKey: 缓存的key
     * @param sql: SQL语句
     * @param parameterValue: 对应的参数值
     * @return XJSONObject | null
     * @throws SQLException 异常
     */
    XJSONObject selectOne2CacheBySQL(@NonNull String cacheKey, @NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 查询数据,返回第一条数据的第一个字段值
     * @param sql: SQL语句
     * @param parameterValue: 参数值
     * @return Object | null
     * @throws SQLException 异常
     */
    Object selectOneValueBySQL(@NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 查询数据,返回第一条数据的第一个字段值并缓存
     * @param cacheKey: 缓存的key
     * @param sql: SQL语句
     * @param parameterValue: 参数值
     * @return Object | null
     * @throws SQLException 异常
     */
    Object selectOneValue2CacheBySQL(@NonNull String cacheKey, @NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 查询数据,返回一条数据的Map对象,每个字段带表名
     * @param sql: SQL语句
     * @param parameterValue: 对应的参数值
     * @return Map
     * @throws SQLException 异常
     */
    XJSONObject selectOneWithTableNameBySQL(@NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 查询条数据,返回多条数据列表,每条数据为指定的类型
     * @param sql: SQL语句
     * @param beanClass: 要转换的对象类
     * @param parameterValue: 对应的参数值
     * @param <T> T
     * @return List
     * @throws SQLException 异常
     */
    <T> List<T> selectListBySQL(@NonNull String sql, @NonNull Class<T> beanClass, Object... parameterValue) throws SQLException;

    /**
     * 查询返回多条数据列表,每条数据转换为指定的类型,并且每个字段带表名
     * @param sql: SQL语句
     * @param beanClass: 要转换的对象类
     * @param parameterValue: 对应的参数值
     * @param <T> T
     * @return List
     * @throws SQLException 异常
     */
    <T> List<T> selectListWithTableNameBySQL(@NonNull String sql, @NonNull Class<T> beanClass, Object... parameterValue) throws SQLException;

    /**
     * 查询条数据,返回多条数据列表,每条数据为XJSONObject类型
     * @param sql: SQL语句
     * @param parameterValue: 对应的参数值
     * @return List
     * @throws SQLException 异常
     */
    List<XJSONObject> selectListBySQL(@NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 查询条数据,返回多条数据列表,每条数据为XJSONObject类型
     * @param sql: SQL语句
     * @param fieldCase: 结果字段是否转为大小写,0:数据库原样，1:转小写，2:转大写
     * @param parameterValue: 对应的参数值
     * @return List
     * @throws SQLException
     */
    List<XJSONObject> selectListFieldCaseBySQL(@NonNull String sql, int fieldCase, Object... parameterValue) throws SQLException;

    /**
     * 查询条数据并缓存结果,返回多条数据列表,每条数据为XJSONObject类型
     * @param cacheKey: 缓存的key
     * @param sql: SQL语句
     * @param parameterValue: 对应的参数值
     * @return List | null
     * @throws SQLException 异常
     */
    List<XJSONObject> selectList2CacheBySQL(@NonNull String cacheKey, @NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 返回每条记录的第一个字段的值
     * @param sql: SQL语句
     * @param parameterValue: 对应的参数值
     * @return List
     * @throws SQLException 异常
     */
    List<Object> selectFirstFieldListBySQL(@NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 查询条数据,返回多条数据列表,每条数据为Map类型,所有字段带表名
     * @param sql: SQL语句
     * @param parameterValue: 对应的参数值
     * @return List
     * @throws SQLException 异常
     */
    List<XJSONObject> selectListWithTableNameBySQL(@NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 查询并遍历查询结果,每次遍历执行回调函数(每行回调一次)
     * @param action: 每次遍历执行回调函数
     * @param sql: SQL语句
     * @param parameterValue: 对应的参数值
     * @throws SQLException 异常
     */
    void selectEachRowCallBySQL(Consumer<? super ResultSet> action, @NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 查询但不遍历查询结果(只回调一次)
     * @param action: 回调函数(只回调一次)
     * @param sql: SQL语句
     * @param parameterValue: 对应的参数值
     * @throws SQLException 异常
     */
    void selectCallBySQL(Consumer<? super ResultSet> action, @NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 查询或更新多次数据, 可多次设置条件并返回执行结果或执行回调函数
     * @param sql: SQL语句
     * @param action: 查询条件及结果或回调函数
     * @throws SQLException 异常
     */
    void prepareStatementBySQL(@NonNull String sql, Consumer<? super PreparedStatementVo> action) throws SQLException;

    /**
     * 使用statement进行链式操作
     * @param action: 执行的回调函数
     * @throws SQLException 异常
     */
    void statementBySQL(Consumer<? super StatementVo> action) throws SQLException;

    /**
     * 获得sql查询语句执行结果中的的字段名称
     * @param sql: SQL语句
     * @param parameterValue: 对应的参数值
     * @return List
     * @throws SQLException 异常
     */
    List<XJSONObject> getFieldNameBySQL(@NonNull String sql, Object... parameterValue) throws SQLException;

    /**
     * 将查询结果转换为excel文件
     * @param titles: 字段标题数组
     * @param pathName: 文件绝对路径及名称
     * @param sql: sql语句
     * @param dict: 字典翻译配置
     * @param parameterValue: sql参数值
     * @return boolean
     * @throws SQLException 异常
     * @throws IOException 异常
     */
    boolean selectToExcelBySQL(@NonNull JSONObject titles, @NonNull String pathName, @NonNull String sql, @Nullable JSONObject dict, Object... parameterValue) throws SQLException, IOException;

    /**
     * 执行SQL语句(支持插入/修改/删除/DDL等)
     * @param sql: SQL语句
     * @param parameterValue: SQL占位符对应的值
     * @return int
     * @throws SQLException 异常
     */
    int executeUpdateBySQL(String sql, Object... parameterValue) throws SQLException;

    /**
     * 执行SQL语句(支持插入/修改/删除/DDL等)
     * @param sql: SQL语句
     * @param returnList: 插入时主键的返回值
     * @param parameterValue: SQL占位符对应的值
     * @return int
     * @throws SQLException 异常
     */
    int executeUpdateBySQL(String sql, Collection returnList, Object... parameterValue) throws SQLException;

    /**
     * 执行SQL语句(支持插入/修改/删除/DDL等, 注意执行DDL后返回值为0，执行了DML后返回的是受影响的数据条数)
     * @param sql: SQL语句
     * @return long
     * @throws SQLException 异常
     */
    long executeLargeUpdate(@NonNull String sql) throws SQLException;

    /**
     * 获得数据库服务器信息
     * @return List
     * @throws SQLException 异常
     */
    List<Map<String, Object>> getServerInfo() throws SQLException;

    /**
     * 获得当前操作的数据库名称
     * @return String
     * @throws SQLException 异常
     */
    String getDatabaseCatalog() throws SQLException;

    /**
     * 获得数据库支持的引擎
     * @return List
     * @throws SQLException 异常
     */
    List<XJSONObject> getEngines() throws SQLException;

    /**
     * 获得数据库支持的字符集
     * @return List
     * @throws SQLException 异常
     */
    List<XJSONObject> getCharset() throws SQLException;

    /**
     * 获得数据库所有的Collation
     * @return List
     * @throws SQLException 异常
     */
    List<XJSONObject> getCollation() throws SQLException;

    /**
     * 判断模块在当前数据库中是否存在
     * @param moduleId: 模块名称
     * @return boolean
     * @throws SQLException 异常
     */
    boolean getModuleExists(@NonNull String moduleId) throws SQLException;

    /**
     * 判断表在当前数据库中是否存在
     * @param tableName: 表名
     * @return boolean
     * @throws SQLException 异常
     */
    boolean getTableExists(@NonNull String tableName) throws SQLException;

    /**
     * 查询视图是否存在
     * @param viewName: 视图名
     * @return boolean
     * @throws SQLException 异常
     */
    boolean getViewExists(String viewName) throws SQLException;

    /**
     * 获得视图数据
     * @param viewName
     * @return list
     * @throws SQLException
     */
    List<XJSONObject> getView(String viewName) throws SQLException;

    /**
     * 判断表中的字段在当前数据库中是否存在
     * @param tableName: 表名
     * @param fieldName: 字段名
     * @return boolean
     * @throws SQLException 异常
     */
    boolean getTableFieldExists(@NonNull String tableName, @NonNull String fieldName) throws SQLException;

    /**
     * 获得指定表主键字段名称
     * @param tableName: 表名
     * @return String | null
     * @throws SQLException 异常
     */
    String getTablePrimaryFieldName(@NonNull String tableName) throws SQLException;

    /**
     * 获得指定表主键字段信息
     * @param tableName: 表名
     * @return FieldInfo | null
     * @throws SQLException 异常
     */
    FieldInfo getTablePrimaryFieldInfo(@NonNull String tableName) throws SQLException;

    /**
     * 获得指定表的所有索引
     * @param tableName: 表名
     * @return List
     * @throws SQLException 异常
     */
    List<XJSONObject> getTableIndexs(String tableName) throws SQLException;

    /**
     * 获得指定表的所有触发器
     * @param tableName: 表名
     * @return List
     * @throws SQLException 异常
     */
    List<XJSONObject> getTableTigger(String tableName) throws SQLException;

    /**
     * 获得指定表所有字段的结构信息
     * @param tableName: 表名
     * @param fieldNames: 字段名
     * @return Map | null
     * @throws SQLException 异常
     */
    Map<String, FieldInfo> getTableFieldInfos(@NonNull String tableName, String... fieldNames) throws SQLException;

    /**
     * 获得指定表所有字段的结构信息
     * @param tableName: 表名
     * @return List
     * @throws SQLException 异常
     */
    List<FieldInfo> getTableFieldInfos2List(@NonNull String tableName) throws SQLException;

    /**
     * 获得所有表的名称并缓存
     * @return List
     * @throws SQLException 异常
     */
    List<String> getTableNames() throws SQLException;

    /**
     * 获得所有表的详细信息并缓存
     * @return List
     * @throws SQLException 异常
     */
    List<XJSONObject> getAllTableInfo() throws SQLException, NoSuchFieldException, IllegalAccessException;

    /**
     * 获得表所属模块列表并缓存
     * @param tableName: 表名
     * @return List
     * @throws SQLException 异常
     */
    List<String> getTableModule(@NonNull String tableName) throws SQLException;

    /**
     * 获得数据源source数据并缓存
     * @param sourceId: 数据源source的id
     * @return XJSONObject
     * @throws SQLException 异常
     */
    XJSONObject getSource(@NonNull String sourceId) throws SQLException;

    /**
     * 获得模块数据并缓存
     * @param moduleId: 模块的id
     * @return XJSONObject
     * @throws SQLException 异常
     */
    XJSONObject getModule(String moduleId) throws SQLException;

    /**
     * 获得shi视图所属模块列表并缓存
     * @param view: 视图名
     * @return List
     * @throws SQLException 异常
     */
    List<String> getViewModule(@NonNull String view) throws SQLException;

    /**
     * 获得所有表的所有字段名称并缓存
     * @return Map
     * @throws SQLException 异常
     */
    Map<String, List<String>> getTablesNamesFieldsNames() throws SQLException;

    /**
     * 获得指定表的信息并缓存
     * @param tableName: 表名
     * @return XJSONObject
     * @throws SQLException 异常
     */
    XJSONObject getTableInfo(String tableName) throws SQLException;

    /**
     * 获得指定表所有字段名称并缓存
     * @param tableName: 表名
     * @return List
     * @throws SQLException 异常
     */
    ArrayFieldList getTableFieldNames(@NonNull String tableName) throws SQLException;

    /**
     * 获得指定表的存放附件的所有字段名
     * @param tableName : 表名
     * @return List
     * @throws SQLException 异常
     */
    List<String> getTableFileFieldNames(String tableName) throws SQLException;

    /**
     * 获得指定表的外键
     * @param tableName: 表名称
     * @return List
     * @throws SQLException 异常
     */
    List<XJSONObject> getTableForeignKeys(String tableName) throws SQLException;

    /**
     * 获得指定表的触发器
     * @param tableName: 表名称
     * @return List
     * @throws SQLException 异常
     */
    List<XJSONObject> getTableTriggers(String tableName) throws SQLException;

    /**
     * 获得当前数据库的视图
     * @return List
     * @throws SQLException 异常
     */
    List<XJSONObject> getDataBaseViews() throws SQLException, NoSuchFieldException, IllegalAccessException;

    /**
     * 缓存所有库的所有表或指定的表结构信息
     * @param tableNames: 表名,多个表名用逗号分隔,为null表示所有表
     */
    void cacheAllTableStructure(@Nullable String... tableNames);

    /**
     * 获得本机或上级组织机构的编号,每个编号单逗号分隔和包围(用于权限SQL语句中的 IN() 函数)
     * @param includeSelf: 是否包含自己
     * @param oidValue: 当前组织机构oid
     * @return String
     * @throws SQLException 异常
     */
    String getOrgParentOid(boolean includeSelf, String oidValue) throws SQLException;

    /**
     * 获得本机或下级组织机构的编号,每个编号单逗号分隔和包围(用于权限SQL语句中的 IN() 函数)
     * @param includeSelf: 是否包含自己
     * @param oidValue: 当前组织机构oid
     * @return String
     * @throws SQLException 异常
     */
    String getOrgChildrenOid(boolean includeSelf, String oidValue) throws SQLException;

}

mongdb接口

第一步 引入包

<dependency>
    <groupId>sei-cloud</groupId>
    <artifactId>datasource</artifactId>
</dependency>

第二步 引入接口

@Resource
    MongoTemplate mongoTemplate;

elasticsearch接口

第一步 引入包

<dependency>
    <groupId>sei-cloud</groupId>
    <artifactId>datasource</artifactId>
</dependency>

第二步 引入接口

@Resource
    RestHighLevelClient restHighLevelClient;

操作日志

本日志指对数据库的增加/修改/删除/登录/退出等操作的日志，而非系统日志。

日志配置

日志默认表名为sys_log存储到mysql数据库中，可配置存储到任意数据库或者本地文件中。 例如配置存储到文件,则修改application.yml文件中的data-base选项。

sei:
  cloud:
    data-base:  #注意顺序，找表时根据顺序查找
      - mysql:
          include: "*" # 星号*代表所有表, 多个表逗号分隔
          exclude: "sys_log" # 要排除的表
      - mongodb:
          include: "" #将指定表数据保存到mongodb数据库，如果前面已经包含则以前面的为准
          exclude:
      - elasticsearch:
          include: "" #将指定表数据保存到mongodb数据库，如果前面已经包含则以前面的为准
          exclude:
      - hbase:
          include:
          exclude:
      - file:
          include: "sys_log" #要存储的表名称
          file-path: /Users/xiong/Desktop/temp # 数据文件的存放目录

操作日志

public class DBLog {
    /** 日志表名 */
    private static final String TABLE_LOG_USER = "_SYS_LOG";
    private enum LogType {
        /** 用户操作日志 */
        USER,
        /** 系统日志 */
        SYSTEM
    }

    /**
     * 用户操作日志
     * @param action: 操作
     * @param moduleID: 模块编号
     * @param table: 表名
     * @param key: 表的主键值
     * @param diff: 差异数据
     * @param info: 操作信息
     * @param other: 其它信息
     */
    public static void userLog(String action, String moduleID, String table, Object key, Object diff, Object info, Object... other);

    /**
     * 用户操作日志
     * @param action: 操作
     * @param map: 操作信息
     */
    public static void userLog(String action, Map<String, Object> map);

    /**
     * 系统日志
     * @param action: 操作类型
     * @param map: 日志内容
     */
    public static void sysLog(String action, Map<String, Object> map);
}

例1: 更改(定制化)操作日志

public class MyLog extends DBLogEvent{

    /**
     * 不是必须的，如果有多个，可通过构造函数设置执行的顺序
     */
    public MyLog() {
        this.setOrder(0);
    }
    
    /**
     * 日志保存前回调
     * @param message: 日志内容
     * message格式:
     * {
     *     _UUID: 主键，唯一序列号
     *     _TYPE: 日志类型
     *     _TIME: 操作时间
     *     _IP: 用户IP
     *     _SEQUENCE: 前端请求时的唯一序列号
     *     _UID: 用户ID
     *     _NAME: 用户姓名
     *     _MID: 模块编号
     *     _TABLE: 操作的表名称
     *     _KEY: 操作的表的主键字段值
     *     _DIFF: 差异数据
     *     格式:
     *     {
     *          字段名: {
     *              _T: 标题
     *              _O: 原始数据
     *              _V: 新数据
     *          }
     *     }
     *     _ACTION: 操作类型,add:新增, edit:编辑, del: 删除
     *     _INFO: 操作的具体内容
     *     _OTHER: 附加信息
     * }
     * @return
     */
    public boolean beforeSave(Map message) {
        // TODO 更改 message 的内容
        return true;
    }

    /**
     * 日志保存后回调
     * @param message: 日志内容
     * message格式:
     * {
     *     _UUID: 主键，唯一序列号
     *     _TYPE: 日志类型
     *     _TIME: 操作时间
     *     _IP: 用户IP
     *     _SEQUENCE: 前端请求时的唯一序列号
     *     _UID: 用户ID
     *     _NAME: 用户姓名
     *     _MID: 模块编号
     *     _TABLE: 操作的表名称
     *     _KEY: 操作的表的主键字段值
     *     _DIFF: 差异数据
     *     格式:
     *     {
     *          字段名: {
     *              _T: 标题
     *              _O: 原始数据
     *              _V: 新数据
     *          }
     *     }
     *     _ACTION: 操作类型,add:新增, edit:编辑, del: 删除
     *     _INFO: 操作的具体内容
     *     _OTHER: 附加信息
     * }
     * @param databaseType: 数据库类型
     */
    public void afterSave(Map message, DbType databaseType) {

    }
}

表结构导出同步/表数据导入导出

/**
 * 数据表结构导出/同步及表数据导入导出
 */
public class SyncTable {

	/**
	 * 导出表结构为json文件
	 * @param con: 连接
	 * @param pathFileName: 存放的文件路径及名称
	 * @param tableNames: 表名,多个表使用逗号分隔
	 * @throws IOException 异常
	 * @throws SQLException 异常
	 */
	public void exportTable(Connection con, String pathFileName, String tableNames) throws IOException, SQLException;

	/**
	 * 从json文件中同步表结构
	 * @param con: 连接
	 * @param in: 文件流
	 * @return 新创建的表的列表
	 * @throws SQLException 异常
	 */
	public synchronized List<String> importTable(Connection con, InputStream in) throws SQLException;

	/**
	 * 导出表所有数据到json文件
	 * @param con: 连接
	 * @param pathFileName: 存放的文件路径及名称
	 * @param tableNames: 表名
	 * @throws SQLException 异常
	 * @throws IOException 异常
	 */
	public void exportTableData(Connection con, String pathFileName, String... tableNames) throws SQLException, IOException;

	/**
	 * 从json文件中导入表数据
	 * @param con: 连接
	 * @param in: 数据文件
	 * @throws SQLException 异常
	 * @throws IOException 异常
	 */
	public void importTableData(Connection con, InputStream in) throws SQLException, IOException;
}