create-meadminjs 1.0.0

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

@@ -0,0 +1,28 @@
+import { 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 IndexMiddleware implements IMiddleware<Context, NextFunction> {
+  @Inject()
+  loginService: LoginService; // 这里注入的实例和上下文不绑定，无法获取到 ctx
+
+  resolve() {
+    return async (ctx: Context, next: NextFunction) => {
+      const token = ctx.get('Authorization').replace('Bearer ', '');
+      if (token) {
+        const userInfo = await this.loginService.getUserByToken(token);
+        if (!userInfo) {
+          throw new UnauthorizedError('登录信息已失效请重新登录！');
+        }
+        if (userInfo.status !== 1) {
+          this.loginService.removeToken(token);
+          throw new UnauthorizedError('用户已被禁用');
+        }
+        ctx.userInfo = userInfo;
+      }
+      await next();
+    };
+  }
+}

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

@@ -0,0 +1,127 @@
+import { InjectRepository } from '@/decorators/index.js';
+import { Inject, Provide } from '@midwayjs/core';
+import { BadRequestError } from '@midwayjs/core/dist/error/http.js';
+import { Context } from '@midwayjs/koa';
+import { Op } from '@sequelize/core';
+import { UserFile } from '../../../entities/userFile.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(UserFile)
+  FileRepository: typeof UserFile;
+
+  @Inject()
+  ctx: Context;
+
+  /**
+   * 创建数据
+   * @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: ['createdUser', 'updatedUser'],
+      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);
+    if (!entity) {
+      throw new BadRequestError('没有对应的信息');
+    }
+    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('没有对应的信息');
+    }
+    if (entity.createdUserId !== this.ctx.userInfo.id) {
+      throw new BadRequestError('只能更改自己的附件');
+    }
+    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('没有对应的信息');
+    }
+    if (entity.createdUserId !== this.ctx.userInfo.id) {
+      throw new BadRequestError('只能删除自己的附件');
+    }
+    await entity.destroy();
+  }
+}

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

@@ -0,0 +1,178 @@
+import { InjectRepository } from '@/decorators/sequelize.js';
+import { User } from '@/entities/user.entity.js';
+import { CachingFactory, MidwayCache } from '@midwayjs/cache-manager';
+import { Config, Context, Init, Inject, Singleton } from '@midwayjs/core';
+import { BadRequestError } from '@midwayjs/core/dist/error/http.js';
+import dayjs from 'dayjs';
+import { pbkdf2Sync, randomBytes } from 'node:crypto';
+
+export const tokenPrefix = 'Index:Token:';
+export const indexPrefix = 'Index:Index:';
+@Singleton()
+export class LoginService {
+  @InjectRepository(User)
+  userRepository: typeof User;
+
+  @Inject()
+  cachingFactory: CachingFactory;
+
+  @Config('index.login.expiresIn')
+  expiresIn: number; //过期时间ms
+
+  @Config('index.login.secret')
+  secret: string; //加密secret
+
+  @Config('index.login.cacheKey')
+  cacheKey: string; //token使用的缓存key对应cacheManager.clients
+
+  cache: MidwayCache;
+
+  @Init()
+  async init() {
+    this.cache = await this.cachingFactory.get(this.cacheKey);
+  }
+
+  getUserIdCacheKey(userId: string) {
+    return indexPrefix + userId;
+  }
+
+  getTokenCacheKey(token: string) {
+    return tokenPrefix + token;
+  }
+
+  //根据用户id获取token列表
+  async getUserTokens(userId: string) {
+    let userTokens = ((await this.cache.get(this.getUserIdCacheKey(userId))) ?? []) as Array<{ token: string; expiresInTime: number; expiresInTimeStr: string }>;
+    if (userTokens.length) {
+      const nowTime = +new Date();
+      userTokens = userTokens.filter((item) => item.expiresInTime > +nowTime);
+      await this.cache.set(this.getUserIdCacheKey(userId), userTokens);
+    }
+    return userTokens;
+  }
+
+  /**
+   * 创建token，极限情况下，会有概率token重复，如果并发过高，可以用redis lua重写这里。
+   * @param userId;
+   * @returns;
+   */
+  async createToken(userId: string) {
+    const secret = this.secret + new Date();
+    const token = pbkdf2Sync(tokenPrefix + userId, secret, 1000, 32, 'md5').toString('hex');
+    if (await this.cache.get(this.getTokenCacheKey(token))) {
+      return await this.createToken(userId);
+    }
+    this.cache.set(this.getTokenCacheKey(token), ' ', 2000);
+    return token;
+  }
+
+  //获取新token
+  async getToken(userId: string) {
+    const userTokens = await this.getUserTokens(userId);
+    const expiresInTime = this.expiresIn + +new Date();
+    const token = await this.createToken(userId);
+    const tokenInfo = {
+      token,
+      expiresInTime,
+      expiresInTimeStr: dayjs(expiresInTime).format('YYYY-MM-DD HH:mm:ss.SSS'),
+    };
+    userTokens.push(tokenInfo);
+    await this.cache.set(this.getTokenCacheKey(token), userId, this.expiresIn);
+    await this.cache.set(this.getUserIdCacheKey(userId), userTokens);
+    return tokenInfo;
+  }
+
+  //根据token获取用户id
+  async getIdByToken(token: string) {
+    return await this.cache.get<string>(this.getTokenCacheKey(token));
+  }
+
+  /**
+   * 根据token获取用户信息
+   * @param token
+   * @returns
+   */
+  async getUserByToken(token: string) {
+    const userId = await this.getIdByToken(token);
+    if (userId) {
+      return await this.getUserById(userId);
+    }
+    return null;
+  }
+
+  /**
+   * 根据管理员信息获取管理员详情
+   * @param userId
+   * @returns
+   */
+  async getUserById(userId: string) {
+    const user = await this.userRepository.findOne({
+      where: {
+        id: userId,
+      },
+      include: [
+        {
+          association: 'avatar',
+          attributes: { exclude: [] }, //必须设置attributes，否则file的附件属性 url属性返回给前端时没有，已提交[BUG反馈](https://github.com/sequelize/sequelize/issues/18059)
+        },
+      ],
+    });
+    return user;
+  }
+
+  //移除token
+  async removeToken(token: string) {
+    const userId = await this.getIdByToken(token);
+    if (userId) {
+      await this.cache.del(this.getTokenCacheKey(token));
+      let userTokens = await this.getUserTokens(userId);
+      userTokens = userTokens.filter((item) => item.token !== token);
+      await this.cache.set(this.getUserIdCacheKey(userId), userTokens);
+    }
+  }
+
+  /**
+   * 登录
+   * @param username 用户名
+   * @param password 密码
+   * @param ctx      请求上下文
+   * @returns
+   */
+  async login(username, password, ctx?: Context) {
+    const entity = await this.userRepository.findOne({ where: { username } });
+    if (entity && this.checkPassword(password, entity.salt, entity.password)) {
+      if (entity.status !== 1) {
+        throw new BadRequestError('用户已被禁用');
+      }
+      return await this.getToken(entity.id);
+    }
+    throw new BadRequestError('错误的用户名/密码');
+  }
+
+  /**
+   * 密码加密
+   * @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;
+  }
+}

package/template/meadmin/src/app/index/service/user.service.ts

@@ -0,0 +1,87 @@
+import { InjectRepository } from '@/decorators/index.js';
+import { Inject, Provide } from '@midwayjs/core';
+import { BadRequestError } from '@midwayjs/core/dist/error/http.js';
+import { User } from '../../../entities/user.entity.js';
+import { UserCreateDto } from '../dto/userCreate.dto.js';
+import { UserUpdateDto } from '../dto/userUpdate.dto.js';
+import { LoginService } from './login.serveice.js';
+
+//用户
+@Provide()
+export class UserService {
+  @InjectRepository(User)
+  UserRepository: typeof User;
+
+  @Inject()
+  loginService: LoginService;
+
+  /**
+   * 创建数据
+   * @param createDto
+   * @returns
+   */
+  async create(createDto: UserCreateDto) {
+    if (createDto.avatar?.id !== undefined) {
+      createDto.avatarFileId = createDto.avatar?.id ?? null;
+    }
+    if (createDto.password) {
+      Object.assign(createDto, this.loginService.entityPassword(createDto.password));
+    }
+    const entity = this.UserRepository.build(createDto);
+    return await entity.save();
+  }
+
+  /**
+   * 根据主键获取一条信息
+   * @param id 主键
+   * @returns
+   */
+  async findOne(id: string) {
+    const entity = await this.UserRepository.findByPk(id, {
+      include: [
+        {
+          association: 'avatar',
+          attributes: { exclude: [] }, //必须设置attributes，否则file的附件属性 url属性返回给前端时没有，已提交[BUG反馈](https://github.com/sequelize/sequelize/issues/18059)
+        },
+      ],
+    });
+    if (!entity) {
+      throw new BadRequestError('没有对应的信息');
+    }
+    return entity;
+  }
+
+  /**
+   * 更新数据
+   * @param id 主键
+   * @param updateDto 数据对象
+   * @returns
+   */
+  async update(id: string, updateDto: UserUpdateDto) {
+    const entity = await this.UserRepository.findByPk(id);
+    if (!entity) {
+      throw new BadRequestError('没有对应的信息');
+    }
+    if (entity.username != updateDto.username && updateDto.username !== undefined) {
+      if (await this.UserRepository.findOne({ where: { username: updateDto.username } })) {
+        throw new BadRequestError('用户名已被占用');
+      }
+    }
+    const password = entity.password;
+    const salf = entity.salt;
+    if (updateDto.avatar !== undefined) {
+      updateDto.avatarFileId = updateDto.avatar?.id ?? null;
+    }
+    Object.assign(entity, updateDto);
+    if (updateDto.password) {
+      if (!this.loginService.checkPassword(updateDto.orgPassword, salf, password)) {
+        throw new BadRequestError('原始密码错误');
+      }
+      Object.assign(entity, this.loginService.entityPassword(updateDto.password));
+    } else {
+      entity.password = password;
+      entity.salt = salf;
+    }
+    return await entity.save();
+  }
+}

package/template/meadmin/src/config/config.default.ts

@@ -0,0 +1,154 @@
+import { uploadWhiteList } from '@midwayjs/busboy';
+import { createRedisStore } from '@midwayjs/cache-manager';
+import { MidwayConfig } from '@midwayjs/core';
+import { TranslateOptions } from '@midwayjs/i18n';
+import { resolve } from 'path';
+import { formatText } from '../helper/utils.js';
+import database from './database.js';
+//配置文件避免出现@/等alisa，path引用
+export default {
+  // use for cookie sign key, should change to your own and keep security
+  keys: '1714030878233_897',
+  koa: {
+    port: +process.env.SERVER_PORT,
+  },
+  debug: true,
+  validate: {
+    validationOptions: {
+      allowUnknown: false, // 全局生效 允许未定义的字段
+      convert: true, // 当为true时，尝试将值转换为所需的类型（例如，将字符串转换为数字.
+      stripUnknown: true, // 全局生效,移除多余的字段
+    },
+  },
+  i18n: {
+    // 默认语言  "zh-cn"
+    defaultLocale: 'zh-cn',
+    // used to alter the behaviour of missing keys
+    missingKeyFn: function (locale, value) {
+      return value;
+    },
+
+    // 把你的翻译文本放到这里
+    localeTable: {
+      'zh-cn': {
+        validate: {
+          'string.mobile': '{{#label}} 必须是一个正确的手机号',
+        },
+      },
+      'en': {
+        default: await import('../locales/en.json', { with: { type: 'json' } }),
+        validate: await import('@midwayjs/validate/locales/en_US.json', { with: { type: 'json' } }),
+      },
+    },
+
+    missingKeyHandler: (message: string, options?: TranslateOptions) => (options?.args ? formatText(message, options.args) : message),
+  },
+  sequelize: await database(),
+  view: {
+    //midwayjs 视图配置 说明参考 https://midwayjs.org/docs/extensions/render
+    defaultViewEngine: 'viteView',
+  },
+  // ...
+  staticFile: {
+    dirs: {
+      default: {
+        prefix: '/',
+        dir: 'public',
+      },
+      viewAdmin: {
+        prefix: '/html/admin/',
+        dir: 'view/admin/dist',
+      },
+      viewIndex: {
+        prefix: '/html/index/',
+        dir: 'view/index/dist',
+      },
+    },
+  },
+  viteView: {
+    //midway-vite-view 配置配置详细说明见下方
+    rootDir: 'view',
+    views: {
+      admin: {
+        //相对于rootDir的前端包路径
+        // entryServer: 'admin/src/entry-server.ts',//admin暂未支持服务端渲染
+        entry: 'index.html', //html入库文件，相对于当前包路径
+        viteConfigFile: resolve(import.meta.dirname, '../../view/admin/vite.config.ts'),
+        staticFileKey: 'viewAdmin',
+        hmrPort: 23679,
+      },
+      index: {
+        //相对于rootDir的前端包路径
+        entryServer: 'src/entry-server.ts',
+        entry: 'index.html', //html入库文件，相对于当前包路径
+        viteConfigFile: resolve(import.meta.dirname, '../../view/index/vite.config.ts'),
+        staticFileKey: 'viewIndex',
+        hmrPort: 23680,
+      },
+    },
+  },
+  redis: {
+    clients: {
+      cache: {
+        host: process.env.REDIS_HOST,
+        port: process.env.REDIS_PORT,
+        password: process.env.REDIS_PASS,
+        db: 0,
+      },
+    },
+  },
+  cacheManager: {
+    //缓存配置
+    clients: {
+      admin: {
+        store: createRedisStore('cache'),
+      },
+      index: {
+        store: createRedisStore('cache'),
+      },
+    },
+  },
+  admin: {
+    login: {
+      secret: 'desec2ec3=ase$&e1#edad#$%%', //token加密平台标识
+      expiresIn: 3600000 * 6, //token过期时间ms
+      renewal: 60000 * 10, //续期时间ms
+      cacheKey: 'admin', //token使用的缓存key对应cacheManager.clients
+    },
+    auth: {
+      noLoginUrl: [`/api/admin/login/login`, `/api/admin/login/captcha`, new RegExp('/api/admin/file/get/.+')] as Array<string | RegExp>, //无需登录地址
+    },
+  },
+  index: {
+    login: {
+      secret: 'desndex=ase$&e1#edad#$%%', //token加密平台标识
+      expiresIn: 3600000 * 6, //token过期时间ms
+      renewal: 60000 * 10, //续期时间ms
+      cacheKey: 'index', //token使用的缓存key对应cacheManager.clients
+    },
+  },
+  busboy: {
+    mode: 'stream',
+    // 扩展名白名单
+    whitelist: uploadWhiteList,
+    limits: {
+      fileSize: 500 * 1024 * 1024, //上传限制 单位为byte
+    },
+    tmpdir: resolve(import.meta.dirname, '../../uploadFile/tmp'),
+    upDir: resolve(import.meta.dirname, '../../uploadFile/'),
+    cleanTimeout: 5 * 60 * 1000,
+  },
+  midwayLogger: {
+    default: {
+      transports: {
+        file: {
+          dir: resolve(import.meta.dirname, '../../logs'),
+        },
+        error: {
+          dir: resolve(import.meta.dirname, '../../logs'),
+        },
+      },
+    },
+    // ...
+  },
+} as MidwayConfig;

package/template/meadmin/src/config/config.unittest.ts

@@ -0,0 +1,7 @@
+import { MidwayConfig } from '@midwayjs/core';
+
+export default {
+  koa: {
+    port: null,
+  },
+} as MidwayConfig;

package/template/meadmin/src/config/database.ts

@@ -0,0 +1,30 @@
+import { importModels, Options } from '@sequelize/core';
+import { PostgresDialect } from '@sequelize/postgres';
+import { appLogger } from '../logger.js';
+export default async () => ({
+  dataSource: {
+    default: {
+      dialect: PostgresDialect,
+      host: process.env.DATABASE_HOST ?? '127.0.0.1',
+      port: process.env.DATABASE_PORT ?? 5342,
+      database: process.env.DATABASE_DB ?? 'meadmin',
+      user: process.env.DATABASE_USER ?? 'root',
+      password: process.env.DATABASE_PASSWORD ?? 'root',
+      client_encoding: 'utf8',
+      models: await importModels((import.meta.dirname + '/../**/*.entity.js').replace(/\\/g, '/')),
+      options: `-c search_path=${process.env.DATABASE_SCHEMA}`, //设置模式查询顺序
+      define: {
+        underscored: true, //强制表名和列名转换为snake_case
+        freezeTableName: true, //强制模型名称不变换（取消表名的单词复数转换和snake_case转换)
+        timestamps: false, // 禁用createAt和updateAt的自动声明
+        noPrimaryKey: true, //禁止自动创建主键id
+        schema: process.env.DATABASE_SCHEMA ?? 'public',
+        timezone: 'Asia/Shanghai',
+      },
+      logging(sql, timing, seqlize?) {
+        appLogger.info('[sql]耗时 %d ms，%s', timing, sql, seqlize?.bind);
+      },
+      benchmark: true, //开启日志打印sql耗时参数传递
+    } as Options<PostgresDialect>,
+  },
+});