README

Tora

基于 typescript reflect 实现的依赖注入服务框架。

安装

需要 typescript 4.2 以上。

$ npm install tora

Hello Tora

import { ApiParams, Platform, Post, ToraRouter } from 'tora'

@ToraRouter('/hello')
export class TestRouter {

    @Post()
    async test(
            params: ApiParams<{
                hello: string
            }>) {

        return { hello: params.get('hello') }
    }

}

new Platform()
        .load_config({ tora: { port: 3000 } })
        .route(TestRouter)
        .start()

// $ curl --request POST --url http://localhost:3000/hello/test --header 'Content-Type: application/json' --data '{ "hello": "world" }'
// $ {"hello":"world"}

认识 Tora 组件

Tora 中的核心组件有四种：

[[ToraService]] 用来实现可以注入的服务。
[[ToraModule]] 用于提供 ToraService，加载其他 ToraModule，是连接服务的中枢。
[[ToraRoot]] 特殊 ToraModule，可以携带 routers 和 tasks，作为 Platform 的启动入口。
[[ToraRouter]] 特殊 ToraModule，用于实现 API，提供服务，加载模块。
[[ToraTrigger]] 特殊 ToraModule，用于实现定时任务。

先实现一个最基础的 Service，以一定格式把两个字符串拼起来。

import { ToraService } from 'tora'

@ToraService()
export class AssembleStringService {

    assemble(front: string, rear: string) {
        return `${front}^_^${rear}`
    }
}

接下来我们来使用这个服务。我们先构建一个可以请求的接口，这样可以直接看到运行结果。

@ToraRouter('/test', {
    providers: [
        AssembleStringService, // 需要有一个可以提供这个服务的模块在，
    ]
})
export class SampleRouter {

    constructor(
            // 这样就获得了这个服务。
            private assemble_string: AssembleStringService
    ) {
    }

    @Get()
    async sample() {
        return {
            // 使用服务生成字符串并返回。
            res: this.assemble_string.assemble('@@@', '$

)
        }
    }
}

// $ curl -X GET --url http://localhost:3000/test/sample
// $ { "res": "@@@^_^$quot; }

下面展示如何使用 ToraModule 进行模块连接。先创建一个 ToraModule。

@ToraModule({
    providers: [
        AssembleStringService, // 这次由 SampleModule 进行服务提供。，
    ]
})
export class SampleModule {

}

将 ToraRouter 元数据做如下修改。

@ToraRouter('/test', {
    // providers: [
    //     AssembleStringService,
    // ]
    imports: [
        SampleModule, // 这次将模块加在这里。
    ]
})
export class SampleRouter {

    constructor(
            // 同样的方式使用这个服务。
            private assemble_string: AssembleStringService
    ) {
    }
}

启动 Tora

我们现在有了一个使用自定义服务的 API。下面看看怎么启动它。 Tora 的启动入口是 Platform 类。


new Platform()
        .load_config({ tora: { port: 3000 } }) // 这个配置文件格式定义在了 global.ToraConfigSchema 接口中，可以通过生命合并扩展这个接口。
        .route(SampleRouter) // 这样就挂载了 SampleRouter
        .start() // 这样就开始监听了。

// 输出内容如下：
// tora server starting...
//     listen at port 3000...
//
// tora server started successfully in 0.004s.

大多数情况我们的一个服务不止是启动一个接口，而是一批接口以及若干定时任务。这时我们可以使用 [[ToraRoot]]

@ToraRoot({
    imports: [SampleModule1, SampleModule2, /* ... */],
    providers: [SampleService1, SampleService2, /* ... */],
    routers: [SampleRouter1, SampleRouter2, /* ... */],
    tasks: [SampleTrigger1, SampleTrigger2, /* ... */],
})
export class SampleRoot {
}

new Platform()
        .load_config({ tora: { port: 3000 } })
        .bootstrap(SampleRoot) // 这样就可以加载一个 Root 模块。
        .start()

Usage no npm install needed!

README

Tora

安装

Hello Tora

认识 Tora 组件

启动 Tora