• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    迪恩网络公众号

Umajs/Umajs: UMajs,an easy-to-use framework base on Typescript

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称:

Umajs/Umajs

开源软件地址:

https://github.com/Umajs/Umajs

开源编程语言:

TypeScript 97.1%

开源软件介绍:

Umajs(Launched by 58)

An easy-to-use framework base on Typescript

简介

Umajs 是 58同城 推出的一款基于 Typescript 轻量级 Nodejs Web 框架。它的中文含义是大熊座,北斗七星都是它的组成部分;正如同 Umajs 也是由不同的 package 所组合在一起。我们希望 Umajs 的每一部分,都是优秀的、闪耀的、经受的住各种大型项目检验的。

Features

  • 基于 Koa2,兼容 middleware
  • 统一响应 (Result), 让 Controller 响应数据更便捷清晰
  • 装饰器 (Decorator),代码组织更优雅方便
  • 自定义装饰器 (createArgDecorator), 可以快速的扩展参数装饰器,用于参数校验、参数转换、参数聚合等
  • 面向切面 (AOP),基于装饰器的 Aspect 可以很方便的对任意方法进行拦截、修改等,并且能将中间件转换成 Aspect.around 使用
  • 依赖注入 (IOC),模块依赖不再需要引入和实例化
  • 插件、切面形式让中间件(Middleware)使用更优雅
  • 高稳定高性能,单元测试覆盖全
  • 路由分层,优化路由寻址
  • 推荐 TS 开发,开发维护更清晰,对于依赖注入的方法使用也更便捷
  • 统一约束和规范

使用方法

请参考: Umajs使用文档

备用站点【推荐】:https://umajs.gitee.io/

初始化项目

yarn install
yarn run init

运行Sample

cd packages/app && npm run app

开发

  • 开发子项目时,在子项目根目录执行

    npm start
    
  • 启动 web 工程,在 app 项目根录目执行

    npm run app
    
  • 启动调试模式,在根目录按 F5 即可

贡献

欢迎提交 PR 或者 Issue,向我们反馈建议和问题。

特性展示

下面代码展示了以下几个特性:

1、通过 createArgDecorator 创建参数装饰器,对 age 参数进行校验和类型转换

2、controller 通过框架提供的 Result 便捷的响应数据

3、Aspect 通过 around 方法进行方法的拦截,对方法的 参数 进行校验, 对 返回值 进行校验/修改

// index.controller.ts
import Method from './method.aspect';
import { AgeCheck } from './ArgDecorator';

@Aspect(Method) // 可以装饰在类上对所有方法进行装饰
export default class extends  BaseController {

    // @Aspect(Method) // 可以装饰在方法上对单一方法进行装饰
    @Path('/hello')
    index(@Query('name') name: string, @AgeCheck('age') age: number ) {
        return Result.json({
            name,
            age,
        });
    }
}
// ArgDecorator.ts
export const AgeCheck = createArgDecorator((ctx: IContext, ageKey: string) => {
    let age = ctx.query[ageKey];

    if (age === undefined) return Result.json({
        code: 0,
        msg: '请加上 age 参数',
    });

    age = +age;

    if (Number.isNaN(age) || age < 0 || age > 120) return Result.json({
        code: 0,
        msg: '请传入正确的 age 参数',
    });

    return age;
});
// method.aspect.ts
import { IAspect, IProceedJoinPoint } from '@umajs/core';

export default class implements IAspect {
    async around(proceedPoint: IProceedJoinPoint) {
        const { proceed, args } = proceedPoint;

        // 校验参数
        if (args[0] !== 'Umajs') return Result.send('name 必须为 Umajs');

        const result = await proceed(...args);

        if (result.type === 'json') {
            // 为 JSON 返回值加上时间戳
            result.data.time = new Date();
        }

        return result;
    }
}



鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap