global-common

功能介绍

使用的组件

组件	功能	默认配置
crossDomain	跨域	跳转
koa	http 框架	跳转
validate	参数校验	跳转
passport	身份验证	跳转
captcha	验证码	跳转
swagger	接口文档	跳转
casbin	鉴权	跳转
consul	微服务注册	跳转

配置

crossDomain

// 跨域设置
cors: {
    allowHeaders: ['Content-Type', 'Authorization', 'X-Requested-With', 'authCode'],
    allowMethods: ['GET', 'POST', 'PUT', 'PATCH', 'DELETE','OPTIONS', 'HEAD'],
    credentials: true,
    origin: (req: { headers: { origin: any; }; }) => reqheaders.origin,
},

koa

// koa的配置
koa: {
    port: 7001,
},

validate

// 参数校验
validationOptions: {
    // 不允许出现未定义的参数
    stripUnknown: true, // 全局生效
},

passport

// passport
passport: {
    session: false,
},

captcha

// 验证码配置
captcha: {
    default: { // 默认配置
        size: 4,
        noise: 1,
        width: 120,
        height: 40,
    },
    image: {      // 最终会合并 default 配置
        type: 'mixed',
    },
    formula: {},  // 最终会合并 default 配置
    text: {},     // 最终会合并 default 配置
    expirationTime: 3600,
    idPrefix: 'midway:vc',
},

midwayLogger

// 日志配置
midwayLogger: {
    clients: {
        coreLogger: {
            level: 'debug',
            consoleLevel: 'debug',
        },
        appLogger: {
            level: 'debug',
            consoleLevel: 'debug',
        },
    },
},

swagger

未配置

casbin

未配置

consul

未配置

提供的内容

service (服务)

menu.service

前端路由菜单自动注册服务，配合装饰器 @MenuReg 使用

helpComMenu

取回 menu 的元信息

MenuService

自动加载的服务，加载装饰器的配置内容注入到 menu 配置中

common (常用)

base.common.exception

CommonException

通用异常

base.controller

BaseController

Controller 基础类 快捷创建的 CURD

base.dto

各种常用的类型数据

PowerType

权限类型

UserContext

用户上下文

nickName

RuleType

username

RuleType

password

RuleType

power

RuleType

phone

RuleType

cc

RuleType

email

RuleType

captchaId

RuleType

answer

RuleType

search

RuleType

MFACaptcha

RuleType

menuInfo

菜单的数据类型

Page

分页数据

IdsDTO

whereDTO

pageDTO

limitDTO

selectDTO

base.entity

BaseEntityC

基础 Entity,用于继承

base.error.code

ErrorCode

异常代码

base.service

whereStringToObj

解析查询数据

BaseService

SERVICE 的基类

utils (工具)

assert

Assert

断言工具类

country.code

Country

国家区号转国家代码

countryCodePhoneCode

国家代码

mccCode

MCC 代码

file.tools

readLines

逐行读取文件

snowflake

SnowflakeIdGenerate

Snowflake 主键生成算法, 由于 js 最大值 9007199254740991,所以只能生成 16 位 uuid

unique

取随机数

request

guard (守卫)

auth.guard

UserGuard

用户权限检查

captcha.guard

CaptchaGuard

验证码验证

strategy (策略)

jwt.strategy

JwtStrategy

token 验证

filter (过滤器)

default.filter

DefaultErrorFilter

接口异常处理

notfound.filter

NotFoundFilter

404 的错误处理

validate.filter

ValidateErrorFilter

参数错误的异常处理

middleware (中间件)

format.middleware

FormatMiddleware

对接口返回的数据统一包装

jwt.middleware

JwtPassportMiddleware

验证 token, 使用 JwtStrategy

report.middleware

ReportMiddleware

统计接口耗时

decorator (装饰器)

menuReg.decorator

MenuReg

模块菜单路由装饰器

user.decorator

User

用户上下文装饰器