create-meadminjs 1.0.0

package/template/meadmin/src/entities/systemAdmin.entity.ts

@@ -0,0 +1,164 @@
+import { ApiPropertyRule } from '@/decorators/index.js';
+import { uuid } from '@/helper/snowflake.js';
+import { RuleType } from '@/ruleType/index.js';
+import { BelongsManyModel, BelongsToModel } from '@/types/entity.js';
+import { getSchemaPath } from '@midwayjs/swagger';
+import { DataTypes, NonAttribute, Op } from '@sequelize/core';
+import { Attribute, BelongsTo, Default, DeletedAt, Index, PrimaryKey, Table } from '@sequelize/core/decorators-legacy';
+import { File } from './file.entity.js';
+import { SystemMenu } from './systemMenu.entity.js';
+import { SystemRole } from './systemRole.entity.js';
+// import { BaseModel } from './abstract/base.entity.js';
+import { BaseModel } from './abstract/base.entity.js';
+
+//rule规则使用添加接口的校验规则,建议字符串的默认值统一使用空串，否则RuleType.string需要显示声明allow(null)允许传入null
+@Table({ tableName: 'system_admin', comment: '管理员表' })
+//避免循环引用，继承BaseModel 而非 AdminBaseModel，其余后台表继承AdminBaseModel即可。注意SystemAdmin扩展字段时不能import其余Model以规避循环引用，如需增加外键关联,需用inverse将关联设置另一侧
+export class SystemAdmin extends BaseModel<SystemAdmin> {
+  @Attribute({ type: DataTypes.STRING(20), allowNull: false })
+  @PrimaryKey
+  @Default(uuid)
+  @ApiPropertyRule({ description: 'ID', rule: RuleType.string() })
+  id: string;
+
+  @Index({ unique: true, where: { deleted_at: { [Op.isNot]: null } } }) //局部唯一索引设置只有不删除的数据加索引
+  @Attribute({ type: DataTypes.STRING(50), comment: '用户名', allowNull: false, defaultValue: '' })
+  @ApiPropertyRule({ description: '用户名', rule: RuleType.string().max(50).min(1).required().empty('') })
+  username: string;
+
+  @Attribute({ type: DataTypes.STRING(20), comment: '昵称', allowNull: false, defaultValue: '' })
+  @ApiPropertyRule({ description: '昵称', rule: RuleType.string().max(20).min(1).required() })
+  nickname: string;
+
+  @Attribute({ type: DataTypes.STRING(64), comment: '密码', allowNull: false, defaultValue: '' })
+  @ApiPropertyRule({ description: '密码', rule: RuleType.string() })
+  password: string;
+
+  @Attribute({ type: DataTypes.STRING(32), comment: '密码盐', allowNull: false, defaultValue: '' })
+  salt: string;
+
+  @Attribute({ type: DataTypes.STRING(20), comment: '头像附件id' })
+  avatarFileId: string;
+
+  @ApiPropertyRule({ description: '头像', $ref: getSchemaPath('File'), rule: RuleType.object({ id: RuleType.string().required() }) })
+  // @BelongsTo(() => File, /* foreign key */ 'avatarFileId')避免循环引用，将外键配置放在file表中
+  avatar?: NonAttribute<File>;
+
+  @Index({ unique: true, where: { deleted_at: { [Op.isNot]: null } } }) //局部唯一索引设置只有不删除的数据加索引
+  @Attribute({ type: DataTypes.STRING(100), comment: '邮箱' })
+  @ApiPropertyRule({ description: '邮箱', rule: RuleType.string().email().max(100) })
+  email: string;
+
+  @Index({ unique: true, where: { deleted_at: { [Op.isNot]: null } } }) //局部唯一索引设置只有不删除的数据加索引
+  @Attribute({ type: DataTypes.STRING(11), comment: '手机号' })
+  @ApiPropertyRule({ description: '手机号', rule: RuleType.string().mobile().description('手机号').required() })
+  mobile: string;
+
+  @Attribute({
+    type: DataTypes.TINYINT.UNSIGNED,
+    comment: '登录失败次数',
+    allowNull: false,
+    defaultValue: 0,
+  })
+  @ApiPropertyRule({ description: '登录失败次数' })
+  loginFailure: number;
+
+  @Attribute({
+    type: DataTypes.DATE,
+    comment: '登录时间',
+  })
+  @ApiPropertyRule({ description: '最后登录时间', rule: RuleType.date() })
+  lastLoginAt: Date | null;
+
+  @Attribute({
+    type: DataTypes.STRING(50),
+    comment: '登录ip',
+    defaultValue: '',
+    allowNull: false,
+  })
+  @ApiPropertyRule({ description: '最后登录ip', rule: RuleType.string() })
+  lastLoginIp: string;
+
+  @Attribute({
+    comment: '状态:1=启用;0=禁用',
+    defaultValue: 1,
+    allowNull: false,
+    type: DataTypes.TINYINT.UNSIGNED,
+  })
+  @ApiPropertyRule({ description: '状态:1=启用;0=禁用', rule: RuleType.number().equal(1, 0).required() })
+  status: number;
+
+  @DeletedAt //设置为软删除
+  @Attribute({ comment: '删除时间' })
+  declare deletedAt: Date | null;
+
+  /** Declared by {@link SystemRole.admins} */
+  @ApiPropertyRule({
+    description: '具有的角色',
+    type: 'array',
+    items: {
+      $ref: () => getSchemaPath('SystemRole'),
+    },
+  })
+  declare roles?: NonAttribute<SystemRole[]>;
+
+  _roleMenus?: NonAttribute<SystemMenu[]>;
+  @ApiPropertyRule({
+    description: '具有权限的菜单',
+    type: 'array',
+    items: {
+      $ref: () => getSchemaPath('SystemMenu'),
+    },
+  })
+  get roleMenus(): NonAttribute<SystemMenu[]> {
+    return (
+      this._roleMenus ??
+      this.roles!.reduce((a, b) => {
+        return a.concat(b.menus);
+      }, [])
+    );
+  }
+
+  set roleMenus(roleMenus: SystemMenu[]) {
+    this._roleMenus = roleMenus;
+  }
+
+  @Attribute({
+    comment: '创建者(管理员)Id',
+    type: DataTypes.STRING(20),
+  })
+  createdAdminId: string;
+
+  @ApiPropertyRule({
+    description: '创建者(管理员)',
+    type: () => SystemAdmin,
+  })
+  @BelongsTo(() => SystemAdmin, { foreignKey: 'createdAdminId', foreignKeyConstraints: false })
+  declare createdAdmin?: NonAttribute<SystemAdmin | null>;
+
+  @Attribute({
+    comment: '最后更新者(管理员)Id',
+    type: DataTypes.STRING(20),
+  })
+  updatedAdminId: string;
+
+  @ApiPropertyRule({
+    description: '最后更新者(管理员)',
+    type: () => SystemAdmin,
+  })
+  @BelongsTo(() => SystemAdmin, { foreignKey: 'updatedAdminId', foreignKeyConstraints: false })
+  declare updatedAdmin?: NonAttribute<SystemAdmin | null>;
+
+  //json转义时丢弃password
+  toJSON() {
+    return Object.assign(
+      {},
+      this.get({
+        plain: true,
+      }),
+      { password: '', self: '' },
+    );
+  }
+}
+export declare interface SystemAdmin extends BelongsManyModel<'roles', 'role', 'roles', SystemRole> {}
+export declare interface SystemAdmin extends BelongsToModel<'avatar', File> {}

package/template/meadmin/src/entities/systemMenu.entity.ts

@@ -0,0 +1,161 @@
+import { ApiPropertyRule } from '@/decorators/index.js';
+import { uuid } from '@/helper/snowflake.js';
+import { RuleType } from '@midwayjs/validate';
+import { DataTypes, NonAttribute } from '@sequelize/core';
+import { Attribute, BelongsTo, Default, PrimaryKey, Table, Unique } from '@sequelize/core/decorators-legacy';
+import { AdminTreeModel } from './abstract/adminTree.entity.js';
+import { SystemRole } from './systemRole.entity.js';
+
+//rule规则使用添加接口的校验规则
+@Table({ tableName: 'system_menu', comment: '菜单表' })
+export class SystemMenu extends AdminTreeModel<SystemMenu> {
+  @Attribute({ type: DataTypes.STRING(20), allowNull: false })
+  @PrimaryKey
+  @Default(uuid)
+  @ApiPropertyRule({ description: 'ID', rule: RuleType.string() })
+  id: string;
+
+  @BelongsTo(() => SystemMenu, { foreignKey: 'parentId', foreignKeyConstraints: false }) //不创建数据库外键约束
+  @ApiPropertyRule({ description: '父级', type: () => SystemMenu })
+  declare parent?: NonAttribute<SystemMenu>;
+
+  @Attribute({
+    comment: '菜单名称',
+    type: DataTypes.STRING(100),
+    defaultValue: '',
+    allowNull: false,
+  })
+  @ApiPropertyRule({ description: '菜单名称', rule: RuleType.string().max(100).required() })
+  title: string;
+
+  @Attribute({
+    comment: '类型:1=目录;2=菜单;3=按钮',
+    type: DataTypes.TINYINT.UNSIGNED,
+    allowNull: false,
+  })
+  @ApiPropertyRule({ description: '类型:1=目录;2=菜单;3=按钮', rule: RuleType.number().valid(1, 2, 3).required() })
+  menuType: number;
+
+  @Attribute({
+    comment: '状态:1=启用;0=禁用',
+    defaultValue: 1,
+    allowNull: false,
+    type: DataTypes.TINYINT.UNSIGNED,
+  })
+  @ApiPropertyRule({ description: '状态:1=启用;0=禁用', rule: RuleType.number().valid(1, 0) })
+  status: number;
+
+  @Unique()
+  @Attribute({
+    comment: '权限',
+    type: DataTypes.STRING(100),
+    defaultValue: '',
+    allowNull: false,
+  })
+  @ApiPropertyRule({ description: '权限', rule: RuleType.string().max(100).required() })
+  rule: string;
+
+  @Attribute({
+    comment: '排序(降序)',
+    type: DataTypes.SMALLINT,
+    defaultValue: 0,
+    allowNull: false,
+  })
+  @ApiPropertyRule({ description: '排序(降序)', rule: RuleType.number().integer().max(9999) })
+  orderNum: number;
+
+  @Attribute({
+    comment: '路径',
+    type: DataTypes.STRING(500),
+    defaultValue: '',
+    allowNull: false,
+  })
+  @ApiPropertyRule({
+    description: '路径',
+    rule: RuleType.string()
+      .max(500)
+      .when('menuType', { is: 2, then: RuleType.required().not(null) }),
+  })
+  path: string;
+
+  @Attribute({
+    comment: '外链:1=是;0=否',
+    type: DataTypes.TINYINT.UNSIGNED,
+    defaultValue: 0,
+    allowNull: false,
+  })
+  @ApiPropertyRule({ description: '外链:1=是;0=否', rule: RuleType.number().valid(0, 1) })
+  isLink: number;
+
+  @Attribute({
+    comment: '组件路径(相对于views文件夹)',
+    type: DataTypes.STRING(500),
+    defaultValue: '',
+    allowNull: false,
+  })
+  @ApiPropertyRule({
+    description: '组件路径(相对于views文件夹)',
+    rule: RuleType.string()
+      .max(500)
+      .when('menuType', { is: 2, then: RuleType.when('isUrl', { is: 0, then: RuleType.required().not(null) }) }),
+  })
+  component: string;
+
+  @Attribute({
+    comment: '隐藏:1=是;0=否',
+    type: DataTypes.TINYINT.UNSIGNED,
+    defaultValue: 0,
+    allowNull: false,
+  })
+  @ApiPropertyRule({ description: '隐藏:1=是;0=否', rule: RuleType.number().valid(0, 1) })
+  hideMenu: number;
+
+  @Attribute({
+    comment: '缓存:1=是;0=否',
+    type: DataTypes.TINYINT.UNSIGNED,
+    defaultValue: 0,
+    allowNull: false,
+  })
+  @ApiPropertyRule({ description: '缓存:1=是;0=否', rule: RuleType.number().valid(0, 1) })
+  cache: number;
+
+  @Attribute({
+    comment: '图标',
+    type: DataTypes.STRING(50),
+    defaultValue: '',
+    allowNull: false,
+  })
+  @ApiPropertyRule({ description: '图标', rule: RuleType.string().max(50) })
+  icon: string;
+
+  @Attribute({
+    comment: '固定tag:1=是;0=否',
+    type: DataTypes.TINYINT.UNSIGNED,
+    defaultValue: 0,
+    allowNull: false,
+  })
+  @ApiPropertyRule({ description: '固定tag:1=是;0=否', rule: RuleType.number().valid(0, 1) })
+  affix: number;
+
+  @Attribute({
+    comment: '恒定展示(只有一个子元素时不隐藏):1=是;0=否',
+    type: DataTypes.TINYINT.UNSIGNED,
+    defaultValue: 0,
+    allowNull: false,
+  })
+  @ApiPropertyRule({ description: '恒定展示(只有一个子元素时不隐藏):1=是;0=否', rule: RuleType.number().valid(0, 1) })
+  alwaysShow: number;
+
+  @Attribute({
+    comment: '面包屑:1=展示;0=不展示',
+    type: DataTypes.TINYINT.UNSIGNED,
+    defaultValue: 1,
+    allowNull: false,
+  })
+  @ApiPropertyRule({ description: '面包屑:1=展示;0=不展示', rule: RuleType.number().valid(0, 1) })
+  breadcrumb: number;
+
+  /** Declared by {@link SystemRole.menus} */
+  //具有当前菜单的角色
+  declare roles?: NonAttribute<SystemRole[]>;
+}

package/template/meadmin/src/entities/systemRole.entity.ts

@@ -0,0 +1,99 @@
+import { ApiPropertyRule } from '@/decorators/index.js';
+import { uuid } from '@/helper/snowflake.js';
+import { BelongsManyModel } from '@/types/entity.js';
+import { RuleType } from '@midwayjs/validate';
+import { DataTypes, NonAttribute } from '@sequelize/core';
+import { Attribute, BelongsTo, BelongsToMany, Default, PrimaryKey, Table, Unique } from '@sequelize/core/decorators-legacy';
+import { AdminTreeModel } from './abstract/adminTree.entity.js';
+import { SystemAdmin } from './systemAdmin.entity.js';
+import { SystemMenu } from './systemMenu.entity.js';
+
+//rule规则使用添加接口的校验规则
+@Table({ tableName: 'system_role', comment: '角色表' })
+export class SystemRole extends AdminTreeModel<SystemRole> {
+  @Attribute({ type: DataTypes.STRING(20), allowNull: false })
+  @PrimaryKey
+  @Default(uuid)
+  @ApiPropertyRule({ description: 'ID', rule: RuleType.string() })
+  id: string;
+
+  @BelongsTo(() => SystemRole, { foreignKey: 'parentId', foreignKeyConstraints: false }) //不创建数据库外键约束
+  @ApiPropertyRule({ description: '父级', type: () => SystemMenu })
+  declare parent?: NonAttribute<SystemRole>;
+
+  @Attribute({ type: DataTypes.STRING(50), comment: '角色名称', defaultValue: '', allowNull: false })
+  @ApiPropertyRule({ description: '角色名称', rule: RuleType.string().max(50).min(1).required().empty('') })
+  roleName: string;
+
+  @Unique()
+  @Attribute({ type: DataTypes.STRING(50), comment: '角色标识', defaultValue: '', allowNull: false })
+  @ApiPropertyRule({ description: '角色标识', rule: RuleType.string().max(50).min(1).required().empty('') })
+  roleKey: string;
+
+  @Attribute({
+    comment: '排序(降序)',
+    type: DataTypes.SMALLINT,
+    defaultValue: 0,
+    allowNull: false,
+  })
+  @ApiPropertyRule({ description: '排序(降序)', rule: RuleType.number().integer().max(9999).default(0) })
+  orderNum: number;
+
+  @Attribute({
+    comment: '状态:1=启用;0=禁用',
+    defaultValue: 1,
+    allowNull: false,
+    type: DataTypes.TINYINT.UNSIGNED,
+  })
+  @ApiPropertyRule({ description: '状态:1=启用;0=禁用', rule: RuleType.number().valid(1, 0).default(1) })
+  status: number;
+
+  @Attribute({ type: DataTypes.STRING(100), comment: '备注', defaultValue: '', allowNull: false })
+  @ApiPropertyRule({ description: '备注', rule: RuleType.string().max(100).min(1) })
+  remark: string;
+
+  @BelongsToMany(() => SystemAdmin, {
+    through: 'admin_role', //中间表名称 或者 对应的Model
+    inverse: {
+      as: 'roles',
+    },
+    foreignKeyConstraints: false, //数据库不创建外键，外键应用层解决
+  })
+  @ApiPropertyRule({
+    description: '关联管理员',
+    type: 'array',
+    items: {
+      type: () => SystemAdmin,
+    },
+  })
+  declare admins?: NonAttribute<SystemAdmin[]>;
+
+  @BelongsToMany(() => SystemMenu, {
+    through: 'role_menu', //中间表名称 或者 对应的Model
+    inverse: {
+      //对向模型的反向关联declare字段
+      as: 'roles',
+    },
+    foreignKeyConstraints: false, //数据库不创建外键，外键应用层解决
+  })
+  @ApiPropertyRule({
+    description: '具有权限菜单',
+    type: 'array',
+    items: {
+      type: () => SystemMenu,
+    },
+    rule: RuleType.array().items(RuleType.object({ id: RuleType.string().required() })),
+  })
+  menus?: NonAttribute<SystemMenu[]>;
+
+  @Attribute({
+    comment: '超级管理员:1=是;0=不是',
+    defaultValue: 0,
+    allowNull: false,
+    type: DataTypes.TINYINT.UNSIGNED,
+  })
+  @ApiPropertyRule({ description: '超级管理员:1=是;0=不是', rule: RuleType.number().equal(1, 0).required() })
+  isSuper: number;
+}
+//扩展BelongsManyModel方法，应只声明在一侧，避免ts 循环引用错误
+export declare interface SystemRole extends BelongsManyModel<'menus', 'menu', 'menus', SystemMenu> {}

package/template/meadmin/src/entities/user.entity.ts

@@ -0,0 +1,160 @@
+import { ApiPropertyRule } from '@/decorators/index.js';
+import { uuid } from '@/helper/snowflake.js';
+import { RuleType } from '@/ruleType/index.js';
+import { BelongsToModel } from '@/types/entity.js';
+import { getSchemaPath } from '@midwayjs/swagger';
+import { DataTypes, NonAttribute, Op } from '@sequelize/core';
+import { Attribute, BelongsTo, Default, DeletedAt, Index, PrimaryKey, Table } from '@sequelize/core/decorators-legacy';
+import { BaseModel } from './abstract/base.entity.js';
+import { SystemAdmin } from './systemAdmin.entity.js';
+import { UserFile } from './userFile.entity.js';
+
+//rule规则使用添加接口的校验规则,建议字符串的默认值统一使用空串，否则RuleType.string需要显示声明allow(null)允许传入null
+@Table({ tableName: 'user', comment: '用户表' })
+//避免循环引用，继承BaseModel 而非 IndexBaseModel，其余前台表继承IndexBaseModel即可。注意User扩展字段时不能import其余Model以规避循环引用，如需增加外键关联,需用inverse将关联设置在另一侧
+export class User extends BaseModel<User> {
+  @Attribute({ type: DataTypes.STRING(20), allowNull: false })
+  @PrimaryKey
+  @Default(uuid)
+  @ApiPropertyRule({ description: 'ID', rule: RuleType.string() })
+  id: string;
+
+  @Index({ unique: true, where: { deleted_at: { [Op.isNot]: null } } }) //局部唯一索引设置只有不删除的数据加索引
+  @Attribute({ type: DataTypes.STRING(50), comment: '用户名', allowNull: false, defaultValue: '' })
+  @ApiPropertyRule({ description: '用户名', rule: RuleType.string().max(50).min(1).required().empty('') })
+  username: string;
+
+  @Attribute({ type: DataTypes.STRING(20), comment: '昵称', allowNull: false, defaultValue: '' })
+  @ApiPropertyRule({ description: '昵称', rule: RuleType.string().max(20).min(1).required() })
+  nickname: string;
+
+  @Attribute({ type: DataTypes.STRING(64), comment: '密码', allowNull: false, defaultValue: '' })
+  @ApiPropertyRule({ description: '密码', rule: RuleType.string() })
+  password: string;
+
+  @Attribute({ type: DataTypes.STRING(32), comment: '密码盐', allowNull: false, defaultValue: '' })
+  salt: string;
+
+  @Attribute({ type: DataTypes.STRING(20), comment: '头像附件id' })
+  avatarFileId: string;
+
+  @ApiPropertyRule({ description: '头像', $ref: getSchemaPath('UserFile'), rule: RuleType.object({ id: RuleType.string().required() }) })
+  // @BelongsTo(() => UserFile, /* foreign key */ 'avatarFileId')  避免循环引用，将外键配置放在userFile表中
+  avatar?: NonAttribute<UserFile>;
+
+  @Index({ unique: true, where: { deleted_at: { [Op.isNot]: null } } }) //局部唯一索引设置只有不删除的数据加索引
+  @Attribute({ type: DataTypes.STRING(100), comment: '邮箱', defaultValue: null })
+  @ApiPropertyRule({ description: '邮箱', rule: RuleType.string().email().max(100) })
+  email: string | null;
+
+  @Index({ unique: true, where: { deleted_at: { [Op.isNot]: null } } }) //局部唯一索引设置只有不删除的数据加索引
+  @Attribute({ type: DataTypes.STRING(11), comment: '手机号', defaultValue: null })
+  @ApiPropertyRule({ description: '手机号', rule: RuleType.string().mobile() })
+  mobile: string | null;
+
+  @Attribute({
+    type: DataTypes.TINYINT.UNSIGNED,
+    comment: '登录失败次数',
+    allowNull: false,
+    defaultValue: 0,
+  })
+  @ApiPropertyRule({ description: '登录失败次数' })
+  loginFailure: number;
+
+  @Attribute({
+    type: DataTypes.DATE,
+    comment: '登录时间',
+  })
+  @ApiPropertyRule({ description: '最后登录时间', rule: RuleType.date() })
+  lastLoginAt: Date | null;
+
+  @Attribute({
+    type: DataTypes.STRING(50),
+    comment: '登录ip',
+    defaultValue: '',
+    allowNull: false,
+  })
+  @ApiPropertyRule({ description: '最后登录ip', rule: RuleType.string() })
+  lastLoginIp: string;
+
+  @Attribute({
+    comment: '状态:1=启用;0=禁用',
+    defaultValue: 1,
+    allowNull: false,
+    type: DataTypes.TINYINT.UNSIGNED,
+  })
+  @ApiPropertyRule({ description: '状态:1=启用;0=禁用', rule: RuleType.number().equal(1, 0).required() })
+  status: number;
+
+  @DeletedAt //设置为软删除
+  @Attribute({ comment: '删除时间' })
+  declare deletedAt: Date | null;
+
+  @ApiPropertyRule({
+    description: '创建者(用户)Id',
+    type: 'string',
+  })
+  @Attribute({
+    comment: '创建者(用户)Id',
+    type: DataTypes.STRING(20),
+  })
+  createdUserId: string | null;
+
+  @ApiPropertyRule({
+    description: '创建者(用户)',
+    type: () => User,
+  })
+  @BelongsTo(() => User, { foreignKey: 'createdUserId', foreignKeyConstraints: false })
+  declare createdUser?: NonAttribute<User>;
+
+  @Attribute({
+    comment: '最后更新者(用户)Id',
+    type: DataTypes.STRING(20),
+  })
+  updatedUserId: string | null;
+
+  @ApiPropertyRule({
+    description: '最后更新者(用户)',
+    type: () => User,
+  })
+  @BelongsTo(() => User, { foreignKey: 'updatedUserId', foreignKeyConstraints: false })
+  declare updatedUser?: NonAttribute<User>;
+
+  @Attribute({
+    comment: '创建者(管理员)Id',
+    type: DataTypes.STRING(20),
+  })
+  createdAdminId: string | null;
+
+  @ApiPropertyRule({
+    description: '创建者(管理员)',
+    type: () => SystemAdmin,
+  })
+  @BelongsTo(() => SystemAdmin, { foreignKey: 'createdAdminId', foreignKeyConstraints: false })
+  declare createdAdmin?: NonAttribute<SystemAdmin | null>;
+
+  @Attribute({
+    comment: '最后更新者(管理员)Id',
+    type: DataTypes.STRING(20),
+  })
+  updatedAdminId: string | null;
+
+  @ApiPropertyRule({
+    description: '最后更新者(管理员)',
+    type: () => SystemAdmin,
+  })
+  @BelongsTo(() => SystemAdmin, { foreignKey: 'updatedAdminId', foreignKeyConstraints: false })
+  declare updatedAdmin?: NonAttribute<SystemAdmin | null>;
+
+  //json转义时丢弃password
+  toJSON() {
+    return Object.assign(
+      {},
+      this.get({
+        plain: true,
+      }),
+      { password: '', self: '' },
+    );
+  }
+}
+export declare interface User extends BelongsToModel<'avatar', UserFile> {}

package/template/meadmin/src/entities/userFile.entity.ts

@@ -0,0 +1,68 @@
+import { ApiPropertyRule } from '@/decorators/index.js';
+import { uuid } from '@/helper/snowflake.js';
+import { RuleType } from '@/ruleType/index.js';
+import { DataTypes, NonAttribute } from '@sequelize/core';
+import { Attribute, Default, HasMany, PrimaryKey, Table } from '@sequelize/core/decorators-legacy';
+import { IndexBaseModel } from './abstract/indexBase.entity.js';
+import { User } from './user.entity.js';
+
+//rule规则使用添加接口的校验规则
+@Table({ tableName: 'user_file', comment: '用户附件表(前台)' })
+export class UserFile extends IndexBaseModel<UserFile> {
+  @Attribute({ type: DataTypes.STRING(20), allowNull: false })
+  @PrimaryKey
+  @Default(uuid)
+  @ApiPropertyRule({ description: 'ID', rule: RuleType.string() })
+  id: string;
+
+  @Attribute({ type: DataTypes.STRING(300), comment: '文件名', allowNull: false, defaultValue: '' })
+  @ApiPropertyRule({ description: '文件名', rule: RuleType.string().max(300).min(1).required().empty('') })
+  name: string;
+
+  @Attribute({ type: DataTypes.STRING(200), comment: '路径', allowNull: false, defaultValue: '' })
+  @ApiPropertyRule({ description: '路径', rule: RuleType.string() })
+  path: string;
+
+  @Attribute({ type: DataTypes.STRING(50), comment: 'mime类型', allowNull: false, defaultValue: '' })
+  @ApiPropertyRule({ description: 'mime类型', rule: RuleType.string() })
+  mimeType: string;
+
+  @Attribute({ type: DataTypes.INTEGER(), comment: '文件大小(b)' })
+  @ApiPropertyRule({ description: '文件大小', rule: RuleType.number() })
+  size: number;
+
+  @Attribute({ type: DataTypes.STRING(50), comment: '存储引擎', allowNull: false, defaultValue: 'storage' })
+  @ApiPropertyRule({ description: '存储引擎', rule: RuleType.string() })
+  storage: string;
+
+  @Attribute({ type: DataTypes.STRING(32), comment: '文件MD5值', allowNull: false, defaultValue: '' })
+  @ApiPropertyRule({ description: '文件MD5值', rule: RuleType.string() })
+  md5: string;
+
+  @Attribute(DataTypes.VIRTUAL(DataTypes.STRING, ['storage', 'id', 'name', 'path'])) //增加DataTypes.VIRTUAL可以确保在属性列表中model.get获得到对应属性，并且包含在查询的属性列表中时，此属性用于自动加载依赖项。
+  @ApiPropertyRule({
+    description: '文件url',
+    type: 'string',
+  })
+  get url(): string {
+    return '/api/index/file/get/' + this.id + '/' + this.name;
+  }
+
+  //为了规避user和userFile的循环引用问题，在userFile声明user avatar的关联
+  @HasMany(() => User, {
+    foreignKey: 'avatarFileId',
+    inverse: { as: 'avatar' },
+    foreignKeyConstraints: false, //数据库不创建外键，外键应用层解决
+  })
+  declare avatarUsers?: NonAttribute<User[]>;
+
+  //json转义需要加上url属性，否则创建成功后的返回实体没有对应参数返回
+  toJSON() {
+    return Object.assign(
+      { url: this.url },
+      this.get({
+        plain: true,
+      }),
+    );
+  }
+}

package/template/meadmin/src/fileManage/index.ts

@@ -0,0 +1,12 @@
+import { UpStorageFunction } from '@/types/fileManage.js';
+import { LocalStorage } from './storage/local.js';
+export interface UploadStorageInterface {
+  [key: string]: UpStorageFunction;
+}
+class UploadStorage implements UploadStorageInterface {
+  [key: string]: UpStorageFunction;
+  localStorage(model: string) {
+    return new LocalStorage(model);
+  }
+}
+export const uploadStorage = new UploadStorage();

package/template/meadmin/src/fileManage/storage/base.ts

@@ -0,0 +1,6 @@
+export class BaseStorage {
+  model: string;
+  constructor(model: string) {
+    this.model = model;
+  }
+}