@hlw-midway/core 1.0.0

package/dist/service/mysql.js

@@ -0,0 +1,524 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseMysqlService = void 0;
+const core_1 = require("@midwayjs/core");
+const core_2 = require("@midwayjs/core");
+const validate_1 = require("../exception/validate");
+const global_1 = require("../constant/global");
+const SqlString = require("sqlstring");
+const typeorm_1 = require("@midwayjs/typeorm");
+const typeorm_2 = require("typeorm");
+const _ = require("lodash");
+const event_1 = require("../event");
+/**
+ * 服务基类
+ */
+let BaseMysqlService = class BaseMysqlService {
+    // 设置模型
+    setEntity(entity) {
+        this.entity = entity;
+    }
+    // 设置请求上下文
+    setCtx(ctx) {
+        this.baseCtx = ctx;
+    }
+    // 设置应用对象
+    setApp(app) {
+        this.baseApp = app;
+    }
+    // 初始化
+    init() {
+        this.sqlParams = [];
+    }
+    /**
+     * 设置sql
+     * @param condition 条件是否成立
+     * @param sql sql语句
+     * @param params 参数
+     */
+    setSql(condition, sql, params) {
+        let rSql = false;
+        if (condition || condition === 0) {
+            rSql = true;
+            this.sqlParams = this.sqlParams.concat(params);
+        }
+        return rSql ? sql : '';
+    }
+    /**
+     * 获得查询个数的SQL
+     * @param sql
+     */
+    getCountSql(sql) {
+        sql = sql
+            .replace(new RegExp('LIMIT', 'gm'), 'limit ')
+            .replace(new RegExp('\n', 'gm'), ' ');
+        if (sql.includes('limit')) {
+            const sqlArr = sql.split('limit ');
+            sqlArr.pop();
+            sql = sqlArr.join('limit ');
+        }
+        return `select count(*) as count from (${sql}) a`;
+    }
+    /**
+     * 参数安全性检查
+     * @param params
+     */
+    async paramSafetyCheck(params) {
+        const lp = params.toLowerCase();
+        return !(lp.indexOf('update ') > -1 ||
+            lp.indexOf('select ') > -1 ||
+            lp.indexOf('delete ') > -1 ||
+            lp.indexOf('insert ') > -1);
+    }
+    /**
+     * 原生查询
+     * @param sql
+     * @param params
+     * @param connectionName
+     */
+    async nativeQuery(sql, params, connectionName) {
+        if (_.isEmpty(params)) {
+            params = this.sqlParams;
+        }
+        let newParams = [];
+        newParams = newParams.concat(params);
+        this.sqlParams = [];
+        for (const param of newParams) {
+            SqlString.escape(param);
+        }
+        return await this.getOrmManager(connectionName).query(sql, newParams || []);
+    }
+    /**
+     * 获得ORM管理
+     *  @param connectionName 连接名称
+     */
+    getOrmManager(connectionName = 'default') {
+        return this.typeORMDataSourceManager.getDataSource(connectionName);
+    }
+    /**
+     * 操作entity获得分页数据，不用写sql
+     * @param find QueryBuilder
+     * @param query
+     * @param autoSort
+     * @param connectionName
+     */
+    async entityRenderPage(find, query, autoSort = true) {
+        const { size = this._hlwConfig.crud.pageSize, page = 1, order = 'id', sort = 'desc', isExport = false, maxExportLimit, } = query;
+        const count = await find.getCount();
+        let dataFind;
+        if (isExport && maxExportLimit > 0) {
+            dataFind = find.limit(maxExportLimit);
+        }
+        else {
+            dataFind = find.offset((page - 1) * size).limit(size);
+        }
+        if (autoSort) {
+            find.addOrderBy(order, sort.toUpperCase());
+        }
+        return {
+            list: await dataFind.getRawMany(),
+            pagination: {
+                page: parseInt(page),
+                size: parseInt(size),
+                total: count,
+            },
+        };
+    }
+    /**
+     * 执行SQL并获得分页数据
+     * @param sql 执行的sql语句
+     * @param query 分页查询条件
+     * @param autoSort 是否自动排序
+     * @param connectionName 连接名称
+     */
+    async sqlRenderPage(sql, query, autoSort = true, connectionName) {
+        const { size = this._hlwConfig.crud.pageSize, page = 1, order = 'id', sort = 'desc', isExport = false, maxExportLimit, } = query;
+        if (order && sort && autoSort) {
+            if (!(await this.paramSafetyCheck(order + sort))) {
+                throw new validate_1.HlwValidateException('非法传参~');
+            }
+            sql += ` ORDER BY ${SqlString.escapeId(order)} ${this.checkSort(sort)}`;
+        }
+        if (isExport && maxExportLimit > 0) {
+            this.sqlParams.push(parseInt(maxExportLimit));
+            sql += ' LIMIT ? ';
+        }
+        if (!isExport) {
+            this.sqlParams.push((page - 1) * size);
+            this.sqlParams.push(parseInt(size));
+            sql += ' LIMIT ?,? ';
+        }
+        let params = [];
+        params = params.concat(this.sqlParams);
+        const result = await this.nativeQuery(sql, params, connectionName);
+        const countResult = await this.nativeQuery(this.getCountSql(sql), params, connectionName);
+        return {
+            list: result,
+            pagination: {
+                page: parseInt(page),
+                size: parseInt(size),
+                total: parseInt(countResult[0] ? countResult[0].count : 0),
+            },
+        };
+    }
+    /**
+     * 检查排序
+     * @param sort 排序
+     * @returns
+     */
+    checkSort(sort) {
+        if (!['desc', 'asc'].includes(sort.toLowerCase())) {
+            throw new validate_1.HlwValidateException('sort 非法传参~');
+        }
+        return sort;
+    }
+    /**
+     * camelCase 转 snake_case，用于前端传入排序字段映射数据库列名
+     */
+    toSnakeCase(str) {
+        return str.replace(/[A-Z]/g, letter => `_${letter.toLowerCase()}`);
+    }
+    /**
+     * 将对象数组的 key 从 snake_case 转为 camelCase
+     */
+    keysToCamel(list) {
+        return list.map(row => {
+            const obj = {};
+            for (const key of Object.keys(row)) {
+                const camel = key.replace(/_([a-z])/g, (_, c) => c.toUpperCase());
+                obj[camel] = row[key];
+            }
+            return obj;
+        });
+    }
+    /**
+     * 获得单个ID
+     * @param id ID
+     * @param infoIgnoreProperty 忽略返回属性
+     */
+    async info(id, infoIgnoreProperty) {
+        if (!this.entity)
+            throw new validate_1.HlwValidateException(global_1.ERRINFO.NOENTITY);
+        if (!id) {
+            throw new validate_1.HlwValidateException(global_1.ERRINFO.NOID);
+        }
+        const info = await this.entity.findOneBy({ id: (0, typeorm_2.Equal)(id) });
+        if (info && infoIgnoreProperty) {
+            for (const property of infoIgnoreProperty) {
+                delete info[property];
+            }
+        }
+        return info;
+    }
+    /**
+     * 删除
+     * @param ids 删除的ID集合 如：[1,2,3] 或者 1,2,3
+     */
+    async delete(ids) {
+        var _a;
+        if (!this.entity)
+            throw new validate_1.HlwValidateException(global_1.ERRINFO.NOENTITY);
+        if (ids instanceof String) {
+            ids = ids.split(',');
+        }
+        // 启动软删除发送事件
+        if ((_a = this._hlwConfig.crud) === null || _a === void 0 ? void 0 : _a.softDelete) {
+            this.softDelete(ids);
+        }
+        await this.entity.delete(ids);
+    }
+    /**
+     * 软删除
+     * @param ids 删除的ID数组
+     * @param entity 实体
+     */
+    async softDelete(ids, entity) {
+        const data = await this.entity.find({
+            where: {
+                id: (0, typeorm_2.In)(ids),
+            },
+        });
+        if (_.isEmpty(data))
+            return;
+        const _entity = entity ? entity : this.entity;
+        const params = {
+            data,
+            ctx: this.baseCtx,
+            entity: _entity,
+        };
+        if (data.length > 0) {
+            this.hlwEventManager.emit(global_1.EVENT.SOFT_DELETE, params);
+        }
+    }
+    /**
+     * 新增|修改
+     * @param param 数据
+     */
+    async addOrUpdate(param, type = 'add') {
+        var _a;
+        if (!this.entity)
+            throw new validate_1.HlwValidateException(global_1.ERRINFO.NOENTITY);
+        delete param.createdAt;
+        // 判断是否是批量操作
+        if (param instanceof Array) {
+            param.forEach(item => {
+                item.updatedAt = new Date();
+                if (type == 'add') {
+                    item.createdAt = new Date();
+                }
+            });
+            await this.entity.save(param);
+        }
+        else {
+            const upsert = ((_a = this._hlwConfig.crud) === null || _a === void 0 ? void 0 : _a.upsert) || 'normal';
+            if (type == 'update') {
+                if (upsert == 'save') {
+                    const info = await this.entity.findOneBy({ id: (0, typeorm_2.Equal)(param.id) });
+                    if (!info) {
+                        throw new validate_1.HlwValidateException(global_1.ERRINFO.NOTFOUND);
+                    }
+                    param = {
+                        ...info,
+                        ...param,
+                    };
+                }
+                param.updatedAt = new Date();
+                upsert == 'normal'
+                    ? await this.entity.update(param.id, param)
+                    : await this.entity.save(param);
+            }
+            if (type == 'add') {
+                param.createdAt = new Date();
+                param.updatedAt = new Date();
+                upsert == 'normal'
+                    ? await this.entity.insert(param)
+                    : await this.entity.save(param);
+            }
+        }
+    }
+    /**
+     * 非分页查询
+     * @param query 查询条件
+     * @param option 查询配置
+     * @param connectionName 连接名
+     */
+    async list(query, option, connectionName) {
+        if (!this.entity)
+            throw new validate_1.HlwValidateException(global_1.ERRINFO.NOENTITY);
+        const sql = await this.getOptionFind(query, option);
+        return this.nativeQuery(sql, [], connectionName);
+    }
+    /**
+     * 分页查询
+     * @param query 查询条件
+     * @param option 查询配置
+     * @param connectionName 连接名
+     */
+    async page(query, option, connectionName) {
+        if (!this.entity)
+            throw new validate_1.HlwValidateException(global_1.ERRINFO.NOENTITY);
+        const sql = await this.getOptionFind(query, option);
+        return this.sqlRenderPage(sql, query, false, connectionName);
+    }
+    /**
+     * 构建查询配置
+     * @param query 前端查询
+     * @param option
+     */
+    async getOptionFind(query, option) {
+        let { order = 'id', sort = 'desc', keyWord = '' } = query;
+        const sqlArr = ['SELECT'];
+        const selects = ['a.*'];
+        const find = this.entity.createQueryBuilder('a');
+        if (option) {
+            if (typeof option === 'function') {
+                // @ts-ignore
+                option = await option(this.baseCtx, this.baseApp);
+            }
+            // 判断是否有关联查询，有的话取个别名
+            if (!_.isEmpty(option.join)) {
+                for (const item of option.join) {
+                    selects.push(`${item.alias}.*`);
+                    find[item.type || 'leftJoin'](item.entity, item.alias, item.condition);
+                }
+            }
+            // 默认条件
+            if (option.where) {
+                const wheres = typeof option.where === 'function'
+                    ? await option.where(this.baseCtx, this.baseApp)
+                    : option.where;
+                if (!_.isEmpty(wheres)) {
+                    for (const item of wheres) {
+                        if (item.length == 2 ||
+                            (item.length == 3 && (item[2] || item[2] === 0))) {
+                            for (const key in item[1]) {
+                                this.sqlParams.push(item[1][key]);
+                            }
+                            find.andWhere(item[0], item[1]);
+                        }
+                    }
+                }
+            }
+            // 附加排序
+            if (!_.isEmpty(option.addOrderBy)) {
+                for (const key in option.addOrderBy) {
+                    if (order && order == key) {
+                        sort = option.addOrderBy[key].toUpperCase();
+                    }
+                    find.addOrderBy(SqlString.escapeId(key), this.checkSort(option.addOrderBy[key].toUpperCase()));
+                }
+            }
+            // 关键字模糊搜索
+            if (keyWord || keyWord === 0) {
+                keyWord = `%${keyWord}%`;
+                find.andWhere(new typeorm_2.Brackets(qb => {
+                    var _a;
+                    const keyWordLikeFields = option.keyWordLikeFields || [];
+                    for (let i = 0; i < ((_a = option.keyWordLikeFields) === null || _a === void 0 ? void 0 : _a.length) || 0; i++) {
+                        qb.orWhere(`${keyWordLikeFields[i]} like :keyWord`, {
+                            keyWord,
+                        });
+                        this.sqlParams.push(keyWord);
+                    }
+                }));
+            }
+            // 筛选字段
+            if (!_.isEmpty(option.select)) {
+                sqlArr.push(option.select.join(','));
+                find.select(option.select);
+            }
+            else {
+                sqlArr.push(selects.join(','));
+            }
+            // 字段全匹配
+            if (!_.isEmpty(option.fieldEq)) {
+                for (let key of option.fieldEq) {
+                    const c = {};
+                    // 如果key有包含.的情况下操作
+                    if (typeof key === 'string' && key.includes('.')) {
+                        const keys = key.split('.');
+                        const lastKey = keys.pop();
+                        key = { requestParam: lastKey, column: key };
+                    }
+                    // 单表字段无别名的情况下操作
+                    if (typeof key === 'string') {
+                        if (query[key] || query[key] === 0) {
+                            c[key] = query[key];
+                            const eq = query[key] instanceof Array ? 'in' : '=';
+                            if (eq === 'in') {
+                                find.andWhere(`${key} ${eq} (:${key})`, c);
+                            }
+                            else {
+                                find.andWhere(`${key} ${eq} :${key}`, c);
+                            }
+                            this.sqlParams.push(query[key]);
+                        }
+                    }
+                    else {
+                        if (query[key.requestParam] || query[key.requestParam] === 0) {
+                            c[key.column] = query[key.requestParam];
+                            const eq = query[key.requestParam] instanceof Array ? 'in' : '=';
+                            if (eq === 'in') {
+                                find.andWhere(`${key.column} ${eq} (:${key.column})`, c);
+                            }
+                            else {
+                                find.andWhere(`${key.column} ${eq} :${key.column}`, c);
+                            }
+                            this.sqlParams.push(query[key.requestParam]);
+                        }
+                    }
+                }
+            }
+            // 字段模糊查询
+            if (!_.isEmpty(option.fieldLike)) {
+                for (let key of option.fieldLike) {
+                    // 如果key有包含.的情况下操作
+                    if (typeof key === 'string' && key.includes('.')) {
+                        const keys = key.split('.');
+                        const lastKey = keys.pop();
+                        key = { requestParam: lastKey, column: key };
+                    }
+                    // 单表字段无别名的情况下操作
+                    if (typeof key === 'string') {
+                        if (query[key] || query[key] === 0) {
+                            find.andWhere(`${key} like :${key}`, {
+                                [key]: `%${query[key]}%`,
+                            });
+                            this.sqlParams.push(`%${query[key]}%`);
+                        }
+                    }
+                    else {
+                        if (query[key.requestParam] || query[key.requestParam] === 0) {
+                            find.andWhere(`${key.column} like :${key.column}`, {
+                                [key.column]: `%${query[key.requestParam]}%`,
+                            });
+                            this.sqlParams.push(`%${query[key.requestParam]}%`);
+                        }
+                    }
+                }
+            }
+        }
+        else {
+            sqlArr.push(selects.join(','));
+        }
+        // 接口请求的排序
+        if (sort && order) {
+            const sorts = sort.toUpperCase().split(',');
+            const orders = order.split(',');
+            if (sorts.length != orders.length) {
+                throw new validate_1.HlwValidateException(global_1.ERRINFO.SORTFIELD);
+            }
+            for (const i in sorts) {
+                find.addOrderBy(SqlString.escapeId(orders[i]), this.checkSort(sorts[i]));
+            }
+        }
+        if (option === null || option === void 0 ? void 0 : option.extend) {
+            await (option === null || option === void 0 ? void 0 : option.extend(find, this.baseCtx, this.baseApp));
+        }
+        const sqls = find.getSql().split('FROM');
+        sqlArr.push('FROM');
+        // 取sqls的最后一个
+        sqlArr.push(sqls[sqls.length - 1]);
+        return sqlArr.join(' ');
+    }
+};
+exports.BaseMysqlService = BaseMysqlService;
+__decorate([
+    (0, core_1.Config)('hlw'),
+    __metadata("design:type", Object)
+], BaseMysqlService.prototype, "_hlwConfig", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", typeorm_1.TypeORMDataSourceManager)
+], BaseMysqlService.prototype, "typeORMDataSourceManager", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", event_1.HlwEventManager)
+], BaseMysqlService.prototype, "hlwEventManager", void 0);
+__decorate([
+    (0, core_1.App)(),
+    __metadata("design:type", Object)
+], BaseMysqlService.prototype, "baseApp", void 0);
+__decorate([
+    (0, core_1.Inject)('ctx'),
+    __metadata("design:type", Object)
+], BaseMysqlService.prototype, "baseCtx", void 0);
+__decorate([
+    (0, core_1.Init)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], BaseMysqlService.prototype, "init", null);
+exports.BaseMysqlService = BaseMysqlService = __decorate([
+    (0, core_1.Provide)(),
+    (0, core_2.Scope)(core_2.ScopeEnum.Request, { allowDowngrade: true })
+], BaseMysqlService);

package/dist/service/postgres.d.ts

@@ -0,0 +1,160 @@
+import { Application, Context } from '@midwayjs/koa';
+import { TypeORMDataSourceManager } from '@midwayjs/typeorm';
+import { Repository, SelectQueryBuilder } from 'typeorm';
+import { QueryOp } from '../decorator/controller';
+import { HlwEventManager } from '../event';
+/**
+ * 服务基类
+ */
+export declare abstract class BasePgService {
+    private _hlwConfig;
+    entity: Repository<any>;
+    sqlParams: any;
+    typeORMDataSourceManager: TypeORMDataSourceManager;
+    hlwEventManager: HlwEventManager;
+    setEntity(entity: any): void;
+    setCtx(ctx: Context): void;
+    baseApp: Application;
+    setApp(app: Application): void;
+    baseCtx: Context;
+    init(): void;
+    /**
+     * 设置sql
+     * @param condition 条件是否成立
+     * @param sql sql语句
+     * @param params 参数
+     */
+    setSql(condition: any, sql: any, params: any): any;
+    /**
+     * 获得查询个数的SQL
+     * @param sql
+     */
+    getCountSql(sql: any): string;
+    /**
+     * 参数安全性检查
+     * @param params
+     */
+    paramSafetyCheck(params: any): Promise<boolean>;
+    /**
+     * 原生查询
+     * @param sql
+     * @param params
+     * @param connectionName
+     */
+    nativeQuery(sql: any, params?: any, connectionName?: any): Promise<any>;
+    /**
+     * 获得ORM管理
+     *  @param connectionName 连接名称
+     */
+    getOrmManager(connectionName?: string): import("typeorm").DataSource;
+    /**
+     * 操作entity获得分页数据，不用写sql
+     * @param find QueryBuilder
+     * @param query
+     * @param autoSort
+     * @param connectionName
+     */
+    entityRenderPage(find: SelectQueryBuilder<any>, query: any, autoSort?: boolean): Promise<{
+        list: any[];
+        pagination: {
+            page: number;
+            size: number;
+            total: number;
+        };
+    }>;
+    /**
+     * 将mysql语句转换为postgres语句
+     * @param sql
+     * @returns
+     */
+    protected convertToPostgres(sql: any): any;
+    /**
+     * 查询sql中的参数个数
+     * @param sql
+     * @returns
+     */
+    protected countDollarSigns(sql: any): any;
+    /**
+     * 执行SQL并获得分页数据
+     * @param sql 执行的sql语句
+     * @param query 分页查询条件
+     * @param autoSort 是否自动排序
+     * @param connectionName 连接名称
+     */
+    sqlRenderPage(sql: any, query: any, autoSort?: boolean, connectionName?: any): Promise<{
+        list: any;
+        pagination: {
+            page: number;
+            size: number;
+            total: number;
+        };
+    }>;
+    /**
+     * 检查排序
+     * @param sort 排序
+     * @returns
+     */
+    checkSort(sort: any): any;
+    /**
+     * 获得单个ID
+     * @param id ID
+     * @param infoIgnoreProperty 忽略返回属性
+     */
+    info(id: any, infoIgnoreProperty?: string[]): Promise<any>;
+    /**
+     * 删除
+     * @param ids 删除的ID集合 如：[1,2,3] 或者 1,2,3
+     */
+    delete(ids: any): Promise<void>;
+    /**
+     * 软删除
+     * @param ids 删除的ID数组
+     * @param entity 实体
+     */
+    softDelete(ids: number[], entity?: Repository<any>): Promise<void>;
+    /**
+     * 新增|修改
+     * @param param 数据
+     */
+    addOrUpdate(param: any | any[], type?: 'add' | 'update'): Promise<void>;
+    /**
+     * 非分页查询
+     * @param query 查询条件
+     * @param option 查询配置
+     * @param connectionName 连接名
+     */
+    list(query: any, option: any, connectionName?: any): Promise<any>;
+    /**
+     * 分页查询
+     * @param query 查询条件
+     * @param option 查询配置
+     * @param connectionName 连接名
+     */
+    page(query: any, option: any, connectionName?: any): Promise<{
+        list: any;
+        pagination: {
+            page: number;
+            size: number;
+            total: number;
+        };
+    }>;
+    /**
+     * 构建查询配置
+     * @param query 前端查询
+     * @param option
+     */
+    getOptionFind(query: any, option: QueryOp): Promise<string>;
+    /**
+     * 替换sql中的表别名
+     * @param sql
+     * @returns
+     */
+    replaceOrderByPrefix(sql: any): any;
+    /**
+     * 筛选的字段匹配
+     * @param select 筛选的字段
+     * @param field 字段
+     * @returns 字段在哪个表中
+     */
+    protected matchColumn(select: string[], field: string): string;
+}