@hlw-midway/core 1.0.0

package/dist/service/base.js

@@ -0,0 +1,281 @@
+"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.BaseService = void 0;
+const core_1 = require("@midwayjs/core");
+const core_2 = require("@midwayjs/core");
+const mysql_1 = require("./mysql");
+const postgres_1 = require("./postgres");
+const validate_1 = require("../exception/validate");
+const global_1 = require("../constant/global");
+const typeorm_1 = require("@midwayjs/typeorm");
+const event_1 = require("../event");
+const core_3 = require("../exception/core");
+const sqlite_1 = require("./sqlite");
+/**
+ * 服务基类
+ */
+let BaseService = class BaseService {
+    async init() {
+        const services = {
+            mysql: this.baseMysqlService,
+            mariadb: this.baseMysqlService,
+            postgres: this.basePgService,
+            sqlite: this.baseSqliteService,
+        };
+        this.service = services[this.ormType];
+        if (!this.service)
+            throw new core_3.HlwCoreException('暂不支持当前数据库类型');
+        this.sqlParams = this.service.sqlParams;
+        await this.service.init();
+    }
+    /**
+     * 获取用户ID
+     * @param type 类型
+     * @returns
+     */
+    /**
+     * 获取用户ID
+     * @param type 类型
+     * @returns
+     */
+    getUserId(type = 'admin') {
+        var _a, _b;
+        return type === 'admin'
+            ? (_a = this.baseCtx.admin) === null || _a === void 0 ? void 0 : _a.userId
+            : (_b = this.baseCtx.user) === null || _b === void 0 ? void 0 : _b.id;
+    }
+    // 设置模型
+    setEntity(entity) {
+        this.entity = entity;
+        this.service.setEntity(entity);
+    }
+    // 设置请求上下文
+    setCtx(ctx) {
+        this.baseCtx = ctx;
+        this.service.setCtx(ctx);
+    }
+    // 设置应用对象
+    setApp(app) {
+        this.baseApp = app;
+        this.service.setApp(app);
+    }
+    /**
+     * 设置sql
+     * @param condition 条件是否成立
+     * @param sql sql语句
+     * @param params 参数
+     */
+    setSql(condition, sql, params) {
+        return this.service.setSql(condition, sql, params);
+    }
+    /**
+     * 获得查询个数的SQL
+     * @param sql
+     */
+    getCountSql(sql) {
+        return this.service.getCountSql(sql);
+    }
+    /**
+     * 参数安全性检查
+     * @param params
+     */
+    async paramSafetyCheck(params) {
+        return await this.service.paramSafetyCheck(params);
+    }
+    /**
+     * 原生查询
+     * @param sql
+     * @param params
+     * @param connectionName
+     */
+    async nativeQuery(sql, params, connectionName) {
+        return await this.service.nativeQuery(sql, params, connectionName);
+    }
+    /**
+     * 获得ORM管理
+     *  @param connectionName 连接名称
+     */
+    getOrmManager(connectionName = 'default') {
+        return this.service.getOrmManager(connectionName);
+    }
+    /**
+     * 操作entity获得分页数据，不用写sql
+     * @param find QueryBuilder
+     * @param query
+     * @param autoSort
+     * @param connectionName
+     */
+    async entityRenderPage(find, query, autoSort = true) {
+        return await this.service.entityRenderPage(find, query, autoSort);
+    }
+    /**
+     * 执行SQL并获得分页数据
+     * @param sql 执行的sql语句
+     * @param query 分页查询条件
+     * @param autoSort 是否自动排序
+     * @param connectionName 连接名称
+     */
+    async sqlRenderPage(sql, query = {}, autoSort = true, connectionName) {
+        return await this.service.sqlRenderPage(sql, query, autoSort, connectionName);
+    }
+    /**
+     * 获得单个ID
+     * @param id ID
+     * @param infoIgnoreProperty 忽略返回属性
+     */
+    async info(id, infoIgnoreProperty) {
+        this.service.setEntity(this.entity);
+        return await this.service.info(id, infoIgnoreProperty);
+    }
+    /**
+     * 删除
+     * @param ids 删除的ID集合 如：[1,2,3] 或者 1,2,3
+     */
+    async delete(ids) {
+        this.service.setEntity(this.entity);
+        await this.modifyBefore(ids, 'delete');
+        await this.service.delete(ids);
+        await this.modifyAfter(ids, 'delete');
+    }
+    /**
+     * 软删除
+     * @param ids 删除的ID数组
+     * @param entity 实体
+     */
+    async softDelete(ids, entity) {
+        this.service.setEntity(this.entity);
+        await this.service.softDelete(ids, entity);
+    }
+    /**
+     * 修改
+     * @param param 数据
+     */
+    async update(param) {
+        this.service.setEntity(this.entity);
+        if (!this.entity)
+            throw new validate_1.HlwValidateException(global_1.ERRINFO.NOENTITY);
+        if (!param.id && !(param instanceof Array))
+            throw new validate_1.HlwValidateException(global_1.ERRINFO.NOID);
+        await this.addOrUpdate(param, 'update');
+    }
+    /**
+     * 新增
+     * @param param 数据
+     */
+    async add(param) {
+        if (!this.entity)
+            throw new validate_1.HlwValidateException(global_1.ERRINFO.NOENTITY);
+        delete param.id;
+        await this.addOrUpdate(param, 'add');
+        return {
+            id: param instanceof Array
+                ? param.map(e => {
+                    return e.id ? e.id : e._id;
+                })
+                : param.id
+                    ? param.id
+                    : param._id,
+        };
+    }
+    /**
+     * 新增|修改
+     * @param param 数据
+     */
+    async addOrUpdate(param, type = 'add') {
+        this.service.setEntity(this.entity);
+        await this.modifyBefore(param, type);
+        await this.service.addOrUpdate(param, type);
+        await this.modifyAfter(param, type);
+    }
+    /**
+     * 非分页查询
+     * @param query 查询条件
+     * @param option 查询配置
+     * @param connectionName 连接名
+     */
+    async list(query, option, connectionName) {
+        this.service.setEntity(this.entity);
+        return await this.service.list(query, option, connectionName);
+    }
+    /**
+     * 分页查询
+     * @param query 查询条件
+     * @param option 查询配置
+     * @param connectionName 连接名
+     */
+    async page(query, option, connectionName) {
+        this.service.setEntity(this.entity);
+        return await this.service.page(query, option, connectionName);
+    }
+    /**
+     * 构建查询配置
+     * @param query 前端查询
+     * @param option
+     */
+    async getOptionFind(query, option) {
+        this.service.setEntity(this.entity);
+        return await this.service.getOptionFind(query, option);
+    }
+    /**
+     * 新增|修改|删除 之后的操作
+     * @param data 对应数据
+     */
+    async modifyAfter(data, type) { }
+    /**
+     * 新增|修改|删除 之前的操作
+     * @param data 对应数据
+     */
+    async modifyBefore(data, type) { }
+};
+exports.BaseService = BaseService;
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", mysql_1.BaseMysqlService)
+], BaseService.prototype, "baseMysqlService", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", postgres_1.BasePgService)
+], BaseService.prototype, "basePgService", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", sqlite_1.BaseSqliteService)
+], BaseService.prototype, "baseSqliteService", void 0);
+__decorate([
+    (0, core_1.Config)('typeorm.dataSource.default.type'),
+    __metadata("design:type", Object)
+], BaseService.prototype, "ormType", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", typeorm_1.TypeORMDataSourceManager)
+], BaseService.prototype, "typeORMDataSourceManager", void 0);
+__decorate([
+    (0, core_1.Inject)(),
+    __metadata("design:type", event_1.HlwEventManager)
+], BaseService.prototype, "hlwEventManager", void 0);
+__decorate([
+    (0, core_1.Inject)('ctx'),
+    __metadata("design:type", Object)
+], BaseService.prototype, "baseCtx", void 0);
+__decorate([
+    (0, core_1.App)(),
+    __metadata("design:type", Object)
+], BaseService.prototype, "baseApp", void 0);
+__decorate([
+    (0, core_1.Init)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], BaseService.prototype, "init", null);
+exports.BaseService = BaseService = __decorate([
+    (0, core_1.Provide)(),
+    (0, core_2.Scope)(core_2.ScopeEnum.Request, { allowDowngrade: true })
+], BaseService);

package/dist/service/mysql.d.ts

@@ -0,0 +1,143 @@
+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 BaseMysqlService {
+    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;
+        };
+    }>;
+    /**
+     * 执行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;
+    /**
+     * camelCase 转 snake_case，用于前端传入排序字段映射数据库列名
+     */
+    toSnakeCase(str: string): string;
+    /**
+     * 将对象数组的 key 从 snake_case 转为 camelCase
+     */
+    keysToCamel(list: 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>;
+}