2
0

generic-crud.service.ts 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  1. import { DataSource, Repository, ObjectLiteral, DeepPartial } from 'typeorm';
  2. import { z } from '@hono/zod-openapi';
  3. export abstract class GenericCrudService<T extends ObjectLiteral> {
  4. protected repository: Repository<T>;
  5. private userTrackingOptions?: UserTrackingOptions;
  6. constructor(
  7. protected dataSource: DataSource,
  8. protected entity: new () => T,
  9. options?: {
  10. userTracking?: UserTrackingOptions;
  11. }
  12. ) {
  13. this.repository = this.dataSource.getRepository(entity);
  14. this.userTrackingOptions = options?.userTracking;
  15. }
  16. /**
  17. * 获取分页列表
  18. */
  19. async getList(
  20. page: number = 1,
  21. pageSize: number = 10,
  22. keyword?: string,
  23. searchFields?: string[],
  24. where?: Partial<T>,
  25. relations: string[] = [],
  26. order: { [P in keyof T]?: 'ASC' | 'DESC' } = {},
  27. filters?: {
  28. [key: string]: any;
  29. }
  30. ): Promise<[T[], number]> {
  31. const skip = (page - 1) * pageSize;
  32. const query = this.repository.createQueryBuilder('entity');
  33. // 添加关联关系(支持嵌套关联,如 ['contract.client'])
  34. if (relations.length > 0) {
  35. relations.forEach((relation, relationIndex) => {
  36. const parts = relation.split('.');
  37. let currentAlias = 'entity';
  38. parts.forEach((part, index) => {
  39. const newAlias = index === 0 ? part : `${currentAlias}_${relationIndex}`;
  40. query.leftJoinAndSelect(`${currentAlias}.${part}`, newAlias);
  41. currentAlias = newAlias;
  42. });
  43. });
  44. }
  45. // 关键词搜索
  46. if (keyword && searchFields && searchFields.length > 0) {
  47. query.andWhere(searchFields.map(field => `entity.${field} LIKE :keyword`).join(' OR '), {
  48. keyword: `%${keyword}%`
  49. });
  50. }
  51. // 条件查询
  52. if (where) {
  53. Object.entries(where).forEach(([key, value]) => {
  54. if (value !== undefined && value !== null) {
  55. query.andWhere(`entity.${key} = :${key}`, { [key]: value });
  56. }
  57. });
  58. }
  59. // 扩展筛选条件
  60. if (filters) {
  61. Object.entries(filters).forEach(([key, value]) => {
  62. if (value !== undefined && value !== null && value !== '') {
  63. const fieldName = key.startsWith('_') ? key.substring(1) : key;
  64. // 支持不同类型的筛选
  65. if (Array.isArray(value)) {
  66. // 数组类型:IN查询
  67. if (value.length > 0) {
  68. query.andWhere(`entity.${fieldName} IN (:...${key})`, { [key]: value });
  69. }
  70. } else if (typeof value === 'string' && value.includes('%')) {
  71. // 模糊匹配
  72. query.andWhere(`entity.${fieldName} LIKE :${key}`, { [key]: value });
  73. } else if (typeof value === 'object' && value !== null) {
  74. // 范围查询
  75. if ('gte' in value) {
  76. query.andWhere(`entity.${fieldName} >= :${key}_gte`, { [`${key}_gte`]: value.gte });
  77. }
  78. if ('gt' in value) {
  79. query.andWhere(`entity.${fieldName} > :${key}_gt`, { [`${key}_gt`]: value.gt });
  80. }
  81. if ('lte' in value) {
  82. query.andWhere(`entity.${fieldName} <= :${key}_lte`, { [`${key}_lte`]: value.lte });
  83. }
  84. if ('lt' in value) {
  85. query.andWhere(`entity.${fieldName} < :${key}_lt`, { [`${key}_lt`]: value.lt });
  86. }
  87. if ('between' in value && Array.isArray(value.between) && value.between.length === 2) {
  88. query.andWhere(`entity.${fieldName} BETWEEN :${key}_start AND :${key}_end`, {
  89. [`${key}_start`]: value.between[0],
  90. [`${key}_end`]: value.between[1]
  91. });
  92. }
  93. } else {
  94. // 精确匹配
  95. query.andWhere(`entity.${fieldName} = :${key}`, { [key]: value });
  96. }
  97. }
  98. });
  99. }
  100. // 排序
  101. Object.entries(order).forEach(([key, direction]) => {
  102. query.orderBy(`entity.${key}`, direction);
  103. });
  104. return query.skip(skip).take(pageSize).getManyAndCount();
  105. }
  106. /**
  107. * 根据ID获取单个实体
  108. */
  109. async getById(id: number, relations: string[] = []): Promise<T | null> {
  110. return this.repository.findOne({
  111. where: { id } as any,
  112. relations
  113. });
  114. }
  115. /**
  116. * 设置用户跟踪字段
  117. */
  118. private setUserFields(data: any, userId?: string | number, isCreate: boolean = true): void {
  119. if (!this.userTrackingOptions || !userId) {
  120. return;
  121. }
  122. const { createdByField = 'createdBy', updatedByField = 'updatedBy' } = this.userTrackingOptions;
  123. if (isCreate && createdByField) {
  124. data[createdByField] = userId;
  125. }
  126. if (updatedByField) {
  127. data[updatedByField] = userId;
  128. }
  129. }
  130. /**
  131. * 创建实体
  132. */
  133. async create(data: DeepPartial<T>, userId?: string | number): Promise<T> {
  134. const entityData = { ...data };
  135. this.setUserFields(entityData, userId, true);
  136. const entity = this.repository.create(entityData as DeepPartial<T>);
  137. return this.repository.save(entity);
  138. }
  139. /**
  140. * 更新实体
  141. */
  142. async update(id: number, data: Partial<T>, userId?: string | number): Promise<T | null> {
  143. const updateData = { ...data };
  144. this.setUserFields(updateData, userId, false);
  145. await this.repository.update(id, updateData);
  146. return this.getById(id);
  147. }
  148. /**
  149. * 删除实体
  150. */
  151. async delete(id: number): Promise<boolean> {
  152. const result = await this.repository.delete(id);
  153. return result.affected === 1;
  154. }
  155. /**
  156. * 高级查询方法
  157. */
  158. createQueryBuilder(alias: string = 'entity') {
  159. return this.repository.createQueryBuilder(alias);
  160. }
  161. }
  162. export interface UserTrackingOptions {
  163. createdByField?: string;
  164. updatedByField?: string;
  165. }
  166. export type CrudOptions<
  167. T extends ObjectLiteral,
  168. CreateSchema extends z.ZodSchema = z.ZodSchema,
  169. UpdateSchema extends z.ZodSchema = z.ZodSchema,
  170. GetSchema extends z.ZodSchema = z.ZodSchema,
  171. ListSchema extends z.ZodSchema = z.ZodSchema
  172. > = {
  173. entity: new () => T;
  174. createSchema: CreateSchema;
  175. updateSchema: UpdateSchema;
  176. getSchema: GetSchema;
  177. listSchema: ListSchema;
  178. searchFields?: string[];
  179. relations?: string[];
  180. middleware?: any[];
  181. userTracking?: UserTrackingOptions;
  182. };