Jv-account NPM

JV内部帐号系统

Single Page Application Isomorphic Example for Egg + Vue, Front-End and Node of The Application are Written in TypeScript.

Document

QuickStart

Development Mode

$ npm run dev

Publish Mode

npm run tsc
npm run build
npm start

Features

分层

后台分为 Model(数据类) Bll(业务逻辑层) Dal(DB层) 网上的三层介绍https://wenku.baidu.com/view/888e9be8f8c75fbfc77db29c.html

ORM

DB访问我们采用 typeorm https://github.com/typeorm/typeorm。

Model

model跟DB中的表一对一关联，无需我们手工创建和修改表，只要修改model。如果数据库用户有权限typeorm会帮我们维护表结构。示例：

'use strict';

import {Entity, BaseEntity, PrimaryGeneratedColumn, Column} from "typeorm";

@Entity('t_article')
export default class Article extends BaseEntity {
  @PrimaryGeneratedColumn({
    name: 'Fid',
    type: 'int',
    comment: '自增唯一健'
  })
  public id?: number;

  @Column({
    name: 'Ftitle',
    type: 'varchar',
    length: 32
  })
  public title?: string;
  
  @Column({
    name: 'Fcreate_time',
    type: 'datetime'
  })
  public createTime?: string;

  @Column({
    name: 'Fmodify_time',
    type: 'timestamp'
  })
  public modifyTime?: string;
}

数据库访问层

数据库访问也是全部放在了service/dal目录。如果业务场景不需要特殊的DB访问逻辑，那么它的逻辑层service只需继承dal/base.ts即可。

逻辑层

逻辑层全放在service/bll目录下，继承service/dal/base就可以拥有基础的数据库操作接口。如果需要特殊DB访问逻辑的，请在dal中创建独立的DB访问service并继承BaseService。

Controller

我们把controller封装成了一个统一的入口，不需要重复配置router。例如，我们在controller下创建一个admin.ts:

import { Context } from 'egg';
import Article from '../model/article';

export default class AdminController {
  public async list(ctx: Context) {
    return await ctx.service.bll.article.getAll();
  }
}

不需要做任何配置，我们就可以通过http://fmp.oa.com/framework/api/admin/list 访问到这个接口。

如果需要在controller中使用多级目录，则在访问url中用/表示，如：/api/my/admin/list, 表示在controller/my目录下的admin controller中的list方法。

返回数据

你只需要在你的接口中，直接return {} 任意你想返回的数据结构。api会把它赋给最终结果的data属性下。例如：

public async add(ctx: Context) {
    return {"name": "my"};
  }

最终调用者拿到的是

{
  ret: 0,
  msg: "",
  data: {
    "name": "my"
  }
}

如果你想自已定义返回的结果，你也可以返回IApiResult结构。底层会原样返回。

/**
 * api 返回数据标准结构
 */
declare interface IApiResult {
  ret: number,
  msg: string,
  data?: any
}

抛出异常

基础api会catch异常，然后按同上的返回方式返回ret和msg。这里的ret统一定义为10001。如果controller方想自定义异常信息，你可以直接抛出IApiResult结构信息。

throw {ret: 10086, msg: "我是自定义错误"};

服务鉴权

服务鉴权主要提供一个简单的拒绝非法请求功能，基于ts的decorator实现。服务端在config中需要配置一个accessKey，需要调用当前服务的必须知道这个服务的key并用通用方法计算出来。

// 中间件access配置
  // 用来请求鉴权  只需要针对/api/ 这类的service请求
  // 计算方法 md5(accessKey + ',' + timestamp)
  config.access = {
    enabled: true, // false 表示不启用鉴权
    accessKey: 'lct.framework' // 用来计算token的当前系统唯一key
  }

可以用配置enabled来启用关闭，每个系统自已可以配置唯一的accessKey来识别请求。

当一个接口需要使用鉴权时，只需加上装饰器即可。

import { Context } from 'egg';
import decorators from "../lib/decorator";

export default class AdminController {

  @decorators.checkApiToken(true) // 标记需要校验token
  public async list(ctx: Context) {
    return await ctx.service.bll.article.getAll();
  }
}

TypeScript

License

MIT