The koa-ts from unix

koa-ts

The best practice of building Koa2 with TypeScript. 中文

Usage

Run npm init koa-ts
Install dependencies: yarn
Rename .env.example to .env, and run prisma db push to synchronize the data model
Start the server: yarn dev. visit: http://127.0.0.1:3000/apis/sessions

(Optional) the project has built-in a docker compose, run yarn dev:db to run database automatic.

Project Layout

├── app
│   ├── controllers         ---  server controllers
│   ├── helpers             ---  helper func (interceptor / error handler / validator...)
│   ├── jobs                ---  task (periodic task / trigger task / email server...)
│   ├── entities            ---  database entities/models
│   └── services            ---  adhesive controller and model
├── config
│   ├── constants        ---  environment variable
│   ├── koa.middlewares     ---  middlewares for Koa
│   ├── routing.middlewares ---  middlewares for Routing Controller
│   ├── routing.options     ---  configs for Routing Controller
│   ├── bootstrap           ---  lifecycle
│   └── interceptors        ---  global interceptor
│   └── utils               ---  pure functions for help
└── test                    ---  utils for testcase
├── .env           ---  environment file

Feature

Separation configuration and business logic.
Export scheme model and interface, follow style of TypeScript.
Test cases and lint configuration.
The best practice for Dependency Injection in Koa project.
Get constraints on your data model with Prisma.
TypeScript hotload.

Lifecycle

app.ts -> collect env vars constants -> collect env files variables.env
envs ready, call bootstrap.before()
lift routing-controllers -> lift Koa middlewares -> register Container for DI
start Koa & invoke bootstrap.after() after startup

Databases

The project uses Prisma as the intelligent ORM tool by default. Supports PostgreSQL, MySQL and SQLite.

You can change the data type and connection method in the .env file
After each modification to file /prisma/schema.prisma, you need to run prisma migrate dev to migrate the database.
After each modification to file /prisma/schema.prisma, you need to run prisma generate to sync types.

About Environments

When nodejs is running, ENV does not mean NODE_ENV:

After NodeJS project is built, we always run it as NODE_ENV=PRODUCTION, which may affect some framework optimizations.
NODE_ENV only identifies the NodeJS runtime, independent of the business.
You should use ENV to identify the environment.

For the data settings of each environment, you can refer to the following:

Development Mode (ENV=development): read configurations from configs/constants/development.ts file, but it will still be overwritten by .env file.
Production Mode (ENV=production): read configurations from configs/constants/production.ts file, but it will still be overwritten by .env file.

Reference

LICENSE

This project is licensed under the MIT License. See the LICENSE file for more info.

请教一下ConnectionManager的用法

Type:

Bug
Feature
Help

Description:

数据库：Mysql 5.7

我在使用Repository的过程中遇到一些小问题：
首先我定义了一个Service，在对应的Controller中调用Service时出现ConnectionNotFoundError: Connection "default" was not found.报错，打断点排查发现走至constructor给reponsitory赋值的这一步就出现了异常。

@Service()
export class IpProxyService {
    repository:Repository<IpProxy>
    constructor() {
        this.repository = getRepository(IpProxy)
    }
     ..............
}

经过排查以及查阅官方文档，我发现系connection.ts中定义的connectionManager初始化方式的差异所致：
在大大的项目中，使用的是new ConnectionManager()方法，而如果需要像大大给的session.service.ts演示中的Repository使用方法一致的话，需要变成getConnectionManager()，与您在session.services.ts中演示的不一致。

以下摘自TypeORM文档
This is not a general way of creating a connection, but it may be useful for some users. For example, users who want to create connection and store its instance, but have to control when the actual "connection" will be established. Also you can create and maintain your own ConnectionManager:

import {getConnectionManager, ConnectionManager, Connection} from "typeorm";

const connectionManager = new ConnectionManager();

const connection = connectionManager.create({
    type: "mysql",
    host: "localhost",
    port: 3306,
    username: "test",
    password: "test",
    database: "test",
});
await connection.connect(); // performs connection

But note, this way you won't be able to use getConnection() anymore - you'll need to store your connection manager instance and use connectionManager.get to get a connection you need.

Generally avoid this method and avoid unnecessary complications in your application, use ConnectionManager only if you really think you need it.

文档中说到new ConnectionManager(); 并不是一个比较常见的用法，需要开发者自己手动存储这个ConnectionManager实例（比如说挂载在global上），然后在各个地方引用才可以使用。

使用这种方式连接，在我个人的理解里面，使用的过程中应该是不能使用typeorm提供的那些方法去获取getConnection以及getRepository，需要直接维护/获取存储的ConnectionManager实例。

不知道是不是我使用上出现了问题，麻烦大大看这一大片文字了。

unix / koa-ts Goto Github PK

koa-ts's Introduction

koa-ts

Usage

Project Layout

Feature

Lifecycle

Databases

About Environments

Reference

LICENSE

koa-ts's People

Contributors

Stargazers

Watchers

Forkers

koa-ts's Issues

Type

Description

Recommend Projects

Recommend Topics

Recommend Org