Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/umajs/umajs
UMajs，an easy-to-use framework base on Typescript
https://github.com/umajs/umajs
koa nodejs typescript webserver
Last synced: about 13 hours ago
JSON representation
UMajs，an easy-to-use framework base on Typescript
- Host: GitHub
- URL: https://github.com/umajs/umajs
- Owner: Umajs
- License: mit
- Created: 2020-03-06T03:02:40.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T13:32:03.000Z (over 1 year ago)
- Last Synced: 2024-05-13T17:26:32.739Z (6 months ago)
- Topics: koa, nodejs, typescript, webserver
- Language: TypeScript
- Homepage: https://umajs.github.io
- Size: 1.66 MB
- Stars: 307
- Watchers: 10
- Forks: 33
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# `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.github.io)
备用站点【推荐】：[https://umajs.gitee.io/](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` 方法进行方法的拦截，对方法的 `参数` 进行校验, 对 `返回值` 进行校验/修改
```js
// 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,
});
}
}
```
```js
// 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;
});
```
```js
// 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;
}
}
```