@mvx/typeorm-adapter
v4.0.0-beta5
Published
@mvx/typeorm-adapter is typeorm adapter orm for mvc, type-mvc is base on koa. Decorator, Ioc, AOP mvc frameworker on server.
Downloads
63
Maintainers
Readme
packaged @mvx/typeorm-adapter
This repo is for distribution on npm
. The source for this module is in the
main repo.
@mvx/typeorm-adapter
is model parser for MVC frameworker. base on ioc @tsdi
. help you develop your project easily.
Install
You can install this package either with npm
npm
npm install @mvx/typeorm-adapter
Documentation
create application
import { MvcApplication, DefaultMvcMiddlewares, MvcModule, MvcServer } from '@mvx/mvc';
import { TypeOrmModule } from '@mvx/typeorm-adapter';
// 1. use MvcHostBuilder to boot application.
MvcApplication.run();
// 2. use bootstrap module to boot application
@MvcModule({
// baseURL: __dirname,
imports: [
TypeOrmModule
//... you service, or controller, some extends module.
],
debug: true
})
class MvcApi {
constructor() {
console.log('boot application');
}
}
// 3. use MvcHostBuilder to boot application module.
@MvcModule({
imports: [
TypeOrmModule
// ... /... you service, or controller, some extends module.
// DebugLogAspect
],
middlewares: DefaultMvcMiddlewares,
// bootstrap: MvcServer
})
class MvcApi {
}
MvcApplication.run(MvcApi);
//4. use bootstrap module to boot application by main.
@MvcModule({
imports: [
TypeOrmModule
// ...
],
// bootstrap: MvcServer,
debug: true
})
class MvcApi {
constructor() {
console.log('boot application');
}
static main() {
console.log('run mvc api...');
MvcApplication.run(MvcApi);
}
}
Define Controller
default setting load controllers in your project folder
/controllers
- Each Controller action should return type
ResultValue
, also you can return base type or object, it deal with JsonResult. - The action can be
async
orsync
. Have provideFileResult
,JsonResult
,RedirectResult
,ViewResult
. - Also, you can extend with
BaseController
, it has implements some mothod to create theResultValue
types. - Model can auto create in action, it auto load value from request body.
- Restfull params or Query String params can auto set to Controller action(Controller method) via the name of param matched.
- Cors by
@Cors
decorator in class or method.
define as:
import { Controller, Get, Post, IContext, ContextToken, RequestMethod, Model, Field, Cors } from '@mvx/mvc';
import { Inject } from '@tsdi/core';
import { Mywork } from '../bi/Mywork';
import { User } from '../models';
@Cors
@Controller('/users')
export class UserController {
// @Inject(symbols.IContext)
// context: IContext;
constructor(private work: Mywork) {
}
@Get('')
index() {
console.log('home index invorked', this.work);
return this.work.workA();
}
// @Cors([RequestMethod.Post])
// also can define as below
// @Cors(['Post','Get'])
// @Cors('POST,GET')
@Post('/add')
async addUser(user: User, @Inject(ContextToken) ctx: IContext) {
console.log('user:', user);
console.log('request body', ctx.request.body);
return this.work.save(user);
}
@Get('/sub')
sub() {
return this.work.workB();
}
@Get('/:name')
getPerson(name: string) {
return this.work.find(name);
}
@Get('/find/:name')
query(name: string, @Inject(ContextToken) ctx) {
console.log(ctx);
return this.work.find(name);
}
@Get('/test/:id')
parmtest(id: number) {
if (id === 1) {
return this.work.workA();
} else if (id === 2) {
return this.work.workB();
} else {
return 'notFound';
}
}
@Post('/posttest/:id')
postTest(id: number) {
return {
id: id
}
}
}
@Controller('/')
export class HomeController extends BaseController {
// @Inject(ContextToken)
// context: IContext;
constructor() {
super();
}
@Get('')
index(): ResultValue {
return this.view('index.html');
}
@Get('/index2')
home2(): ResultValue {
return this.view('index2.html');
}
@Post('/goto/:pageName')
gotoPage(pageName: string): ResultValue {
return this.redirect( '/' + pageName);
}
}
Define AOP
Auto load Aspect service from folder /aop
in your project.
see simple demo
import { Aspect, Around, Joinpoint, Before } from '@tsdi/aop';
@Aspect
export class DebugLog {
@Around('execution(*Controller.*)')
log(joinPoint: Joinpoint) {
console.log('aspect append log, method name:', joinPoint.fullName, ' state:', joinPoint.state, ' Args:', joinPoint.args , ' returning:', joinPoint.returning, ' throwing:', joinPoint.throwing);
}
@Before(/Controller.\*$/)
Beforlog(joinPoint: Joinpoint) {
console.log('aspect Befor log:', joinPoint.fullName);
}
}
Define Middlewares
default setting load middlewares in your project folder
/middlewares
import { Middleware, IMiddleware, Application, Configuration } from '@mvx/mvc';
import { IContainer, Injectable } from '@tsdi/core';
@Middleware('logger')
export class Logger implements IMiddleware {
constructor() {
}
async execute (ctx, next) {
let start = Date.now();
await next();
const ms = Date.now() - start;
console.log(`mylog: ${ctx.method} ${ctx.url} - ${ms}ms`);
let end = new Date();
}
}
changes
1.0.1
- add useServer to add Server Middleware features.
0.6.3
- update compile task, zip lib.
- update tsioc for fix bug when inherit class with classAnnations
0.5.5
- fix ConsoleLog error console.debug in nuix will not console.
- update components for route.
v0.5.3
- fix bug in nuix linux load .d.ts file raise error, set default comfig load module with !./**/*.d.ts exclude.
v0.5.1
add Log aop aspect service. for Log easy. default user console to log, can config
logLib
,logConfig
in yourconfig.js
to use third logger lib. eg.{ logLib: 'log4js', logConfig:{...} }
. has implements log4js adapter see codeDebugAspect, config
debug: true
, in yourconfig.js
, will auto log debug info.AnnotationLogerAspect @annotation(Logger), logger some state via @Logger decorator config.
add Annotation Auth aspect service
AuthAspect
to support yourself auth check easy. eg.
@Aspect
export class YourSecrityAspect {
// before AuthAspect.auth check some.
@Before('execution(AuthAspect.auth)', 'authAnnotation')
sessionCheck(authAnnotation: AuthorizationMetadata[], joinPoint: Joinpoint) {
//TODO: you check by authAnnotation
}
}
- v0.4.1 fix assertUrlRegExp bug.
- v0.3.20 New Feature:
- Router and Cors middleware will check url is right route or not. add default route Url check in Configuartion. isRouteUrl method and routeUrlRegExp field.
- v0.3.19 New Feature: Fix bug, reset context middleware order to fix 500 error, when some time request.
- v0.3.18 New Feature:
- update tsioc to improvement method invoker.
- fix Model not register bug. get Model return empty object.
- v0.3.17 New Feature:
- add hostname for http or https to listen.
- v0.3.12 New Feature:
- es5 support. enable config https http server.
- v0.3.10 New Feature:
- Restfull params or Query String params can auto set to Controller action(Controller method) via the name of param matched.
Simples
License
MIT © Houjun