create-meadminjs 1.0.0

package/template/meadmin/src/app/admin/dto/userQuery.dto.ts

@@ -0,0 +1,26 @@
+import { ApiPropertyRule } from '@/decorators/index.js';
+import { PageDto } from '@/dto/page.dto.js';
+import { IntersectionType, PartialType } from '@/helper/dto.js';
+import { RuleType } from '@/ruleType/index.js';
+import { InferAttributesLoose } from '@/types/entity.js';
+import { User } from '../../../entities/user.entity.js';
+
+//dto参数校验继承 entity必须使用 PickDtoType|OmitDtoType|PartialType|RequiredType|IntersectionType 之一 否则不会生效
+export class UserQueryDto extends IntersectionType(PageDto, PartialType(User as new () => InferAttributesLoose<User>)) {
+  @ApiPropertyRule({ description: '最后登录时间(起)', rule: RuleType.date() })
+  startLastLoginAt?: Date;
+
+  @ApiPropertyRule({ description: '最后登录时间(止)', rule: RuleType.date() })
+  endLastLoginAt?: Date;
+
+  @ApiPropertyRule({ description: '创建时间(起)', rule: RuleType.date() })
+  startCreatedAt?: Date;
+
+  @ApiPropertyRule({ description: '创建时间(止)', rule: RuleType.date() })
+  endCreatedAt?: Date;
+  @ApiPropertyRule({ description: '最后更新时间(起)', rule: RuleType.date() })
+  startUpdatedAt?: Date;
+
+  @ApiPropertyRule({ description: '最后更新时间(止)', rule: RuleType.date() })
+  endUpdatedAt?: Date;
+}

package/template/meadmin/src/app/admin/dto/userUpdate.dto.ts

@@ -0,0 +1,11 @@
+import { OmitDtoType, PartialType } from '@/helper/dto.js';
+import { InferAttributesLoose } from '@/types/entity.js';
+import { User } from '../../../entities/user.entity.js';
+
+//dto参数校验继承 entity必须使用 PickDtoType|OmitDtoType|PartialType|RequiredType|IntersectionType 之一 否则不会生效
+export class UserUpdateDto extends PartialType(
+  OmitDtoType(
+    User as new () => InferAttributesLoose<User>, //只保留声明属性
+    ['id', 'createdAt', 'updatedAt', 'deletedAt'], //排除自动创建的字段
+  ),
+) {}

package/template/meadmin/src/app/admin/middleware/admin.middleware.ts

@@ -0,0 +1,41 @@
+import { Config, IMiddleware, Inject, Middleware, NextFunction } from '@midwayjs/core';
+import { UnauthorizedError } from '@midwayjs/core/dist/error/http.js';
+import { Context } from '@midwayjs/koa';
+import { LoginService } from '../service/login.serveice.js';
+
+@Middleware()
+export class AdminMiddleware implements IMiddleware<Context, NextFunction> {
+  @Inject()
+  loginService: LoginService; // 这里注入的实例和上下文不绑定，无法获取到 ctx
+
+  @Config('admin.auth.noLoginUrl')
+  noLoginUrl: Array<string | RegExp>;
+
+  resolve() {
+    return async (ctx: Context, next: NextFunction) => {
+      if (
+        !this.noLoginUrl.some((item) => {
+          if (item instanceof RegExp) {
+            return item.test(ctx.path);
+          }
+          return item === ctx.path;
+        })
+      ) {
+        const token = ctx.get('Authorization').replace('Bearer ', '');
+        if (!token) {
+          throw new UnauthorizedError('请登录后再访问！');
+        }
+        const adminInfo = await this.loginService.getAdminByToken(token);
+        if (!adminInfo) {
+          throw new UnauthorizedError('登录信息已失效请重新登录！');
+        }
+        if (adminInfo.status !== 1) {
+          this.loginService.removeToken(token);
+          throw new UnauthorizedError('用户已被禁用！');
+        }
+        ctx.adminInfo = adminInfo;
+      }
+      await next();
+    };
+  }
+}

package/template/meadmin/src/app/admin/service/example/demo.service.ts

@@ -0,0 +1,260 @@
+import { InjectRepository, Transaction } from '@/decorators/index.js';
+import { Inject, Provide } from '@midwayjs/core';
+import { BadRequestError } from '@midwayjs/core/dist/error/http.js';
+import { MidwayI18nService } from '@midwayjs/i18n';
+import { Op } from '@sequelize/core';
+import { ExampleBook } from '../../../../entities/exampleBook.entity.js';
+import { ExampleDemo } from '../../../../entities/exampleDemo.entity.js';
+import { User } from '../../../../entities/user.entity.js';
+import { ExampleDemoCreateDto } from '../../dto/example/demoCreate.dto.js';
+import { ExampleDemoQueryDto } from '../../dto/example/demoQuery.dto.js';
+import { ExampleDemoUpdateDto } from '../../dto/example/demoUpdate.dto.js';
+
+//示例_Demo
+@Provide()
+export class ExampleDemoService {
+  @InjectRepository(ExampleDemo)
+  exampleDemoRepository: typeof ExampleDemo;
+
+  @Inject()
+  i18nService: MidwayI18nService;
+
+  //查询belongsTo关联模型user用户
+  @InjectRepository(User)
+  userRepository: typeof User;
+
+  /**
+   * 获取用户信息
+   * @param queryDto
+   * @returns
+   */
+  @Transaction()
+  async getUser(page: number, pageSize: number, id: string, username: string = '') {
+    const where = {};
+    if (id) {
+      where['id'] = id;
+    }
+    if (username) {
+      where['username'] = { [Op.like]: '%' + username + '%' };
+    }
+    const { count, rows } = await this.userRepository.findAndCountAll({
+      where,
+      offset: (page - 1) * pageSize,
+      limit: pageSize,
+    });
+    return {
+      list: rows,
+      total: count,
+      page: page,
+      pageSize: pageSize,
+    };
+  }
+
+  //查询belongsToMany关联模型books示例_书籍
+  @InjectRepository(ExampleBook)
+  exampleBookRepository: typeof ExampleBook;
+
+  /**
+   * 获取示例_书籍信息
+   * @param queryDto
+   * @returns
+   */
+  @Transaction()
+  async getExampleBook(page: number, pageSize: number, id: string, name: string = '') {
+    const where = {};
+    if (id) {
+      where['id'] = id;
+    }
+    if (name) {
+      where['name'] = { [Op.like]: '%' + name + '%' };
+    }
+    const { count, rows } = await this.exampleBookRepository.findAndCountAll({
+      where,
+      offset: (page - 1) * pageSize,
+      limit: pageSize,
+    });
+    return {
+      list: rows,
+      total: count,
+      page: page,
+      pageSize: pageSize,
+    };
+  }
+
+  /**
+   * 创建数据
+   * @param createDto
+   * @returns
+   */
+  @Transaction()
+  async create(createDto: ExampleDemoCreateDto) {
+    const entity = await this.exampleDemoRepository.create(createDto);
+
+    if (createDto.user) {
+      //关联模型用主键进行设置，用对象设置时必须确保对象为模型model的实例
+      await entity.setUser(createDto.user.id);
+    }
+
+    if (createDto.avatar) {
+      //关联模型用主键进行设置，用对象设置时必须确保对象为模型model的实例
+      await entity.setAvatar(createDto.avatar.id);
+    }
+
+    if (createDto.books) {
+      //关联模型用主键进行设置，用对象设置时必须确保对象为模型model的实例
+      await entity.setBooks(createDto.books.map((v) => v.id));
+    }
+
+    if (createDto.files) {
+      //关联模型用主键进行设置，用对象设置时必须确保对象为模型model的实例
+      await entity.setFiles(createDto.files.map((v) => v.id));
+    }
+
+    return entity;
+  }
+
+  /**
+   * 列表分页查询
+   * @param queryDto 查询条件
+   * @returns
+   */
+  @Transaction()
+  async list(queryDto: ExampleDemoQueryDto) {
+    const where = {};
+    Object.keys(queryDto).forEach((key) => {
+      if (['page', 'pageSize'].includes(key)) {
+        return;
+      }
+      if ([null, undefined, ''].includes(queryDto[key])) {
+        return;
+      }
+      if (key === 'startCreatedAt') {
+        where['createdAt'] = where['createdAt'] ?? {};
+        where['createdAt'][Op.gte] = queryDto[key];
+        return;
+      }
+      if (key === 'endCreatedAt') {
+        where['createdAt'] = where['createdAt'] ?? {};
+        where['createdAt'][Op.lte] = queryDto[key];
+        return;
+      }
+      if (key === 'startUpdatedAt') {
+        where['updatedAt'] = where['updatedAt'] ?? {};
+        where['updatedAt'][Op.gte] = queryDto[key];
+        return;
+      }
+      if (key === 'endUpdatedAt') {
+        where['updatedAt'] = where['updatedAt'] ?? {};
+        where['updatedAt'][Op.lte] = queryDto[key];
+        return;
+      }
+      where[key] = queryDto[key];
+    });
+    const { count, rows } = await this.exampleDemoRepository.findAndCountAll({
+      where,
+      offset: (queryDto.page - 1) * queryDto.pageSize,
+      limit: queryDto.pageSize,
+      include: [
+        'createdAdmin',
+        'updatedAdmin',
+        'books',
+        'user',
+        {
+          association: 'avatar',
+          attributes: { exclude: [] }, //必须设置attributes，否则file的附件属性 url属性返回给前端时没有，已提交[BUG反馈](https://github.com/sequelize/sequelize/issues/18059)
+        },
+        {
+          association: 'files',
+          attributes: { exclude: [] }, //必须设置attributes，否则file的附件属性 url属性返回给前端时没有，已提交[BUG反馈](https://github.com/sequelize/sequelize/issues/18059)
+        },
+      ],
+      order: [['createdAt', 'DESC']],
+    });
+    return {
+      list: rows,
+      total: count,
+      page: queryDto.page,
+      pageSize: queryDto.pageSize,
+    };
+  }
+
+  /**
+   * 根据主键获取一条信息
+   * @param id 主键
+   * @returns
+   */
+  @Transaction()
+  async findOne(id: string) {
+    const entity = await this.exampleDemoRepository.findByPk(id, {
+      include: [
+        'createdAdmin',
+        'updatedAdmin',
+        'books',
+        'user',
+        {
+          association: 'avatar',
+          attributes: { exclude: [] }, //必须设置attributes，否则file的附件属性 url属性返回给前端时没有，已提交[BUG反馈](https://github.com/sequelize/sequelize/issues/18059)
+        },
+        {
+          association: 'files',
+          attributes: { exclude: [] }, //必须设置attributes，否则file的附件属性 url属性返回给前端时没有，已提交[BUG反馈](https://github.com/sequelize/sequelize/issues/18059)
+        },
+      ],
+    });
+    if (!entity) {
+      throw new BadRequestError(this.i18nService.translate('没有对应的信息'));
+    }
+    return entity;
+  }
+
+  /**
+   * 更新数据
+   * @param id 主键
+   * @param updateDto 数据对象
+   * @returns
+   */
+  @Transaction()
+  async update(id: string, updateDto: ExampleDemoUpdateDto) {
+    const entity = await this.exampleDemoRepository.findByPk(id);
+    if (!entity) {
+      throw new BadRequestError(this.i18nService.translate('没有对应的信息'));
+    }
+    Object.assign(entity, updateDto);
+
+    if (updateDto.user !== undefined) {
+      //关联模型用主键进行设置，用对象设置时必须确保对象为模型model的实例
+      await entity.setUser(updateDto.user?.id ?? null);
+    }
+
+    if (updateDto.avatar !== undefined) {
+      //关联模型用主键进行设置，用对象设置时必须确保对象为模型model的实例
+      await entity.setAvatar(updateDto.avatar?.id ?? null);
+    }
+
+    if (updateDto.books) {
+      //关联模型用主键进行设置，用对象设置时必须确保对象为模型model的实例
+      await entity.setBooks(updateDto.books.map((v) => v.id));
+    }
+
+    if (updateDto.files) {
+      //关联模型用主键进行设置，用对象设置时必须确保对象为模型model的实例
+      await entity.setFiles(updateDto.files.map((v) => v.id));
+    }
+
+    return await entity.save();
+  }
+
+  /**
+   * 删除数据
+   * @param id 主键
+   * @returns
+   */
+  @Transaction()
+  async remove(id: string) {
+    const entity = await this.exampleDemoRepository.findByPk(id);
+    if (!entity) {
+      throw new BadRequestError(this.i18nService.translate('没有对应的信息'));
+    }
+    await entity.destroy();
+  }
+}

package/template/meadmin/src/app/admin/service/file.service.ts

@@ -0,0 +1,123 @@
+import { InjectRepository } from '@/decorators/index.js';
+import { Inject, Provide } from '@midwayjs/core';
+import { BadRequestError } from '@midwayjs/core/dist/error/http.js';
+import { MidwayI18nService } from '@midwayjs/i18n';
+import { Op } from '@sequelize/core';
+import { File } from '../../../entities/file.entity.js';
+import { FileCreateDto } from '../dto/fileCreate.dto.js';
+import { FileQueryDto } from '../dto/fileQuery.dto.js';
+import { FileUpdateDto } from '../dto/fileUpdate.dto.js';
+
+//附件
+@Provide()
+export class FileService {
+  @InjectRepository(File)
+  FileRepository: typeof File;
+
+  @Inject()
+  i18nService: MidwayI18nService;
+
+  /**
+   * 创建数据
+   * @param createDto
+   * @returns
+   */
+  async create(createDto: FileCreateDto) {
+    const entity = this.FileRepository.build(createDto);
+    return await entity.save();
+  }
+
+  /**
+   * 列表分页查询
+   * @param queryDto 查询条件
+   * @returns
+   */
+  async list(queryDto: FileQueryDto) {
+    const where = {};
+    Object.keys(queryDto).forEach((key) => {
+      if (['page', 'pageSize'].includes(key)) {
+        return;
+      }
+      if ([null, undefined, ''].includes(queryDto[key])) {
+        return;
+      }
+      if (key === 'startCreatedAt') {
+        where['createdAt'] = where['createdAt'] ?? {};
+        where['createdAt'][Op.gte] = queryDto[key];
+        return;
+      }
+      if (key === 'endCreatedAt') {
+        where['createdAt'] = where['createdAt'] ?? {};
+        where['createdAt'][Op.lte] = queryDto[key];
+        return;
+      }
+      if (key === 'startUpdatedAt') {
+        where['updatedAt'] = where['updatedAt'] ?? {};
+        where['updatedAt'][Op.gte] = queryDto[key];
+        return;
+      }
+      if (key === 'endUpdatedAt') {
+        where['updatedAt'] = where['updatedAt'] ?? {};
+        where['updatedAt'][Op.lte] = queryDto[key];
+        return;
+      }
+      where[key] = queryDto[key];
+    });
+    const { count, rows } = await this.FileRepository.findAndCountAll({
+      include: ['createdAdmin', 'updatedAdmin'],
+      where,
+      offset: (queryDto.page - 1) * queryDto.pageSize,
+      limit: queryDto.pageSize,
+      order: [['createdAt', 'DESC']],
+    });
+    return {
+      list: rows,
+      total: count,
+      page: queryDto.page,
+      pageSize: queryDto.pageSize,
+    };
+  }
+
+  /**
+   * 根据主键获取一条信息
+   * @param id 主键
+   * @returns
+   */
+  async findOne(id: string) {
+    const entity = await this.FileRepository.findByPk(id, {
+      include: ['createdAdmin', 'updatedAdmin'],
+    });
+    if (!entity) {
+      throw new BadRequestError(this.i18nService.translate('没有对应的信息'));
+    }
+    return entity;
+  }
+
+  /**
+   * 更新数据
+   * @param id 主键
+   * @param updateDto 数据对象
+   * @returns
+   */
+  async update(id: string, updateDto: FileUpdateDto) {
+    const entity = await this.FileRepository.findByPk(id);
+    if (!entity) {
+      throw new BadRequestError(this.i18nService.translate('没有对应的信息'));
+    }
+    Object.assign(entity, updateDto);
+    return await entity.save();
+  }
+
+  /**
+   * 删除数据
+   * @param id 主键
+   * @returns
+   */
+  async remove(id: string) {
+    const entity = await this.FileRepository.findByPk(id);
+    if (!entity) {
+      throw new BadRequestError(this.i18nService.translate('没有对应的信息'));
+    }
+    await entity.destroy();
+  }
+}

package/template/meadmin/src/app/admin/service/login.serveice.ts

@@ -0,0 +1,209 @@
+import { Transaction } from '@/decorators/index.js';
+import { InjectRepository } from '@/decorators/sequelize.js';
+import { SystemAdmin } from '@/entities/systemAdmin.entity.js';
+import { SystemMenu } from '@/entities/systemMenu.entity.js';
+import { SystemRole } from '@/entities/systemRole.entity.js';
+import { CachingFactory, MidwayCache } from '@midwayjs/cache-manager';
+import { Config, Init, Inject, Singleton } from '@midwayjs/core';
+import { BadRequestError } from '@midwayjs/core/dist/error/http.js';
+import { MidwayI18nService } from '@midwayjs/i18n';
+import { Context } from '@midwayjs/koa';
+import dayjs from 'dayjs';
+import { pbkdf2Sync, randomBytes } from 'node:crypto';
+
+export const tokenPrefix = 'Admin:Token:';
+export const adminPrefix = 'Admin:Admin:';
+@Singleton()
+export class LoginService {
+  @InjectRepository(SystemAdmin)
+  adminRepository: typeof SystemAdmin;
+
+  @InjectRepository(SystemMenu)
+  menuRepository: typeof SystemMenu;
+
+  @Inject()
+  cachingFactory: CachingFactory;
+
+  @Config('admin.login.expiresIn')
+  expiresIn: number; //过期时间ms
+
+  @Config('admin.login.secret')
+  secret: string; //加密secret
+
+  @Config('admin.login.cacheKey')
+  cacheKey: string; //token使用的缓存key对应cacheManager.clients
+
+  cache: MidwayCache;
+
+  @Init()
+  async init() {
+    this.cache = await this.cachingFactory.get(this.cacheKey);
+  }
+
+  getAdminIdCacheKey(adminId: string) {
+    return adminPrefix + adminId;
+  }
+
+  getTokenCacheKey(token: string) {
+    return tokenPrefix + token;
+  }
+
+  //根据管理员id获取token列表
+  async getAdminTokens(adminId: string) {
+    let adminTokens = ((await this.cache.get(this.getAdminIdCacheKey(adminId))) ?? []) as Array<{ token: string; expiresInTime: number; expiresInTimeStr: string }>;
+    if (adminTokens.length) {
+      const nowTime = +new Date();
+      adminTokens = adminTokens.filter((item) => item.expiresInTime > +nowTime);
+      await this.cache.set(this.getAdminIdCacheKey(adminId), adminTokens);
+    }
+    return adminTokens;
+  }
+
+  /**
+   * 创建token，极限情况下，会有概率token重复，如果并发过高，可以用redis lua重写这里。
+   * @param adminId;
+   * @returns;
+   */
+  async createToken(adminId: string) {
+    const secret = this.secret + new Date();
+    const token = pbkdf2Sync(tokenPrefix + adminId, secret, 1000, 32, 'md5').toString('hex');
+    if (await this.cache.get(this.getTokenCacheKey(token))) {
+      return await this.createToken(adminId);
+    }
+    this.cache.set(this.getTokenCacheKey(token), ' ', 2000);
+    return token;
+  }
+
+  //获取新token
+  async getToken(adminId: string) {
+    const adminTokens = await this.getAdminTokens(adminId);
+    const expiresInTime = this.expiresIn + +new Date();
+    const token = await this.createToken(adminId);
+    const tokenInfo = {
+      token,
+      expiresInTime,
+      expiresInTimeStr: dayjs(expiresInTime).format('YYYY-MM-DD HH:mm:ss.SSS'),
+    };
+    adminTokens.push(tokenInfo);
+    await this.cache.set(this.getTokenCacheKey(token), adminId, this.expiresIn);
+    await this.cache.set(this.getAdminIdCacheKey(adminId), adminTokens);
+    return tokenInfo;
+  }
+
+  //根据token获取用户id
+  async getIdByToken(token: string) {
+    return await this.cache.get<string>(this.getTokenCacheKey(token));
+  }
+
+  /**
+   * 根据token获取用户信息
+   * @param token
+   * @returns
+   */
+  async getAdminByToken(token: string) {
+    const adminId = await this.getIdByToken(token);
+    if (adminId) {
+      return await this.getAdminById(adminId);
+    }
+    return null;
+  }
+
+  /**
+   * 根据管理员信息获取管理员详情
+   * @param adminId
+   * @returns
+   */
+  async getAdminById(adminId: string) {
+    const admin = await this.adminRepository.findOne({
+      where: {
+        id: adminId,
+      },
+      include: {
+        model: SystemRole,
+        where: { status: 1 },
+        required: false,
+        include: [
+          {
+            model: SystemMenu,
+            where: { status: 1 },
+            required: false,
+          },
+        ],
+      },
+    });
+    if (admin?.roles.some((item) => item.isSuper === 1)) {
+      admin.roleMenus = await this.menuRepository.findAll({
+        where: { status: 1 },
+      });
+    }
+    return admin;
+  }
+
+  //移除token
+  async removeToken(token: string) {
+    const adminId = await this.getIdByToken(token);
+    if (adminId) {
+      await this.cache.del(this.getTokenCacheKey(token));
+      let adminTokens = await this.getAdminTokens(adminId);
+      adminTokens = adminTokens.filter((item) => item.token !== token);
+      await this.cache.set(this.getAdminIdCacheKey(adminId), adminTokens);
+    }
+  }
+
+  /**
+   * 登录
+   * @param username 用户名
+   * @param password 密码
+   * @param ctx      请求上下文
+   * @returns
+   */
+  @Transaction()
+  async login(username, password, ctx?: Context) {
+    const entity = await this.adminRepository.findOne({ where: { username } });
+
+    let translate: MidwayI18nService['translate'];
+    if (ctx) {
+      const i18n = await ctx.requestContext.getAsync(MidwayI18nService);
+      translate = (...args) => i18n.translate(...args);
+    }
+    if (entity && this.checkPassword(password, entity.salt, entity.password)) {
+      if (entity.status !== 1) {
+        throw new BadRequestError(translate ? translate('用户已被禁用') : '用户已被禁用');
+      }
+      entity.lastLoginAt = new Date();
+      entity.lastLoginIp = ctx?.ip ?? '';
+      entity.save();
+      return await this.getToken(entity.id);
+    } else {
+      await entity.increment('loginFailure', { by: 1 });
+    }
+    throw new BadRequestError(translate ? translate('错误的{key}', { args: { key: translate('用户名') + '/' + translate('密码') } }) : '错误的用户名/密码');
+  }
+
+  /**
+   * 密码加密
+   * @param password 密码
+   * @returns {salt:密码盐,password:密码密文}
+   */
+  public entityPassword(password: string, salt?: string) {
+    let newSalt: string;
+    if (salt) {
+      newSalt = salt;
+    } else {
+      newSalt = randomBytes(16).toString('hex');
+    }
+    const ciphertext = pbkdf2Sync(password, newSalt, 1000, 32, 'sha3-256').toString('hex');
+    return { salt: newSalt, password: ciphertext };
+  }
+
+  /**
+   * 校验密码
+   * @param password 密码
+   * @param salt 密码盐
+   * @param encode 加密字符串
+   * @returns 是否通过
+   */
+  public checkPassword(password: string, salt: string, encode: string) {
+    return this.entityPassword(password, salt).password === encode;
+  }
+}