feat: SessionLoader

Author: Houfeng

package.json

@@ -37,28 +37,26 @@
  "dependencies": {
  "confman": "^0.2.10",
  "console3": "^1.0.6",
- "express": "^4.16.4",
  "globby": "^9.2.0",
  "koa": "^2.7.0",
  "koa-compose": "^4.1.0",
  "koa-conditional-get": "^2.0.0",
  "koa-etag": "^3.0.0",
  "koa-router": "^7.4.0",
+ "koa-session": "^5.12.0",
  "koa-static": "^5.0.0",
  "ntils": "^4.0.8",
  "nunjucks": "^3.2.0",
  "oneport": "^1.0.2",
- "reflect-metadata": "^0.1.13",
- "stp": "^0.0.4"
+ "reflect-metadata": "^0.1.13"
  },
  "devDependencies": {
  "@types/express": "^4.16.1",
  "@types/globby": "^9.1.0",
  "@types/koa": "^2.0.48",
  "@types/koa-compose": "^3.2.3",
- "@types/koa-conditional-get": "^2.0.0",
- "@types/koa-etag": "^3.0.0",
  "@types/koa-router": "^7.0.40",
+ "@types/koa-session": "^5.10.0",
  "@types/koa-static": "^4.0.1",
  "@types/node": "^12.0.1",
  "@types/nunjucks": "^3.1.1",

src/AbstractLoader/AbstractLoader.ts

@@ -17,6 +17,34 @@ export abstract class AbstractLoader<T = any> implements ILoader<T> {
  this.options = { ...options };
  }
 
+ /**
+ * Koa 实例
+ */
+ protected get server() {
+ return this.app.server;
+ }
+
+ /**
+ * IoC 容器
+ */
+ protected get container() {
+ return this.app.container;
+ }
+
+ /**
+ * 应用根目录
+ */
+ protected get root() {
+ return this.app.root;
+ }
+
+ /**
+ * 环境标识
+ */
+ protected get env() {
+ return this.app.env;
+ }
+
  /**
  * 已加载的资源或类型列表
  */

src/Application/builtInLoaders.ts

@@ -1,7 +1,9 @@
 import { ControllerLoader } from "../ControllerLoader";
 import { ILoaderInfoMap } from "../AbstractLoader";
 import { InfoLoader } from "../InfoLoader";
+import { ModelLoader } from "../ModelLoader";
 import { ServiceLoader } from "../ServiceLoader";
+import { SessionLoader } from "../SessionLoader";
 import { SetupLoader } from "../SetupLoader";
 import { StaticLoader } from "../StaticLoader";
 import { ViewLoader } from "../ViewLoader";
@@ -15,13 +17,16 @@ export const builtLoaders: ILoaderInfoMap = {
  options: { path: "./{src}/setups/**/*.{ext}" }
  },
  model: {
- loader: ServiceLoader,
+ loader: ModelLoader,
  options: { path: "./{src}/models/**/*.{ext}" }
  },
  service: {
  loader: ServiceLoader,
  options: { path: "./{src}/services/**/*.{ext}" }
  },
+ session: {
+ loader: SessionLoader
+ },
  controller: {
  loader: ControllerLoader,
  options: { path: "./{src}/controllers/**/*.{ext}" }

src/Application/constants.ts

@@ -1,4 +1,4 @@
-const pkg = require("../../package.json");
+import { pkg } from "../common/utils";
 
 /**
  * ENV 环境变量名

src/ConfigLoader/ConfigLoader.ts

@@ -15,8 +15,8 @@ export class ConfigLoader<T = any> extends AbstractLoader<T> {
  const { root } = this.app;
  const { path } = this.options;
  const configFile = resolve(root, path);
- const configParser = new Parser({ env: this.app.env });
+ const configParser = new Parser({ env: this.env });
  const configObject = configParser.load(configFile);
- this.app.container.registerValue(CONFIG_ENTITY_KEY, configObject);
+ this.container.registerValue(CONFIG_ENTITY_KEY, configObject);
  }
 }

src/ControllerLoader/ControllerLoader.ts

@@ -35,9 +35,9 @@ export class ControllerLoader<T = any[]> extends IoCLoader<T> {
  this.app.router.register(
  normalize(`/${ctlInfo.path}/${path}`),
  httpMethods,
- async (ctx: Context, next: Function) => {
+ async (ctx: any, next: Function) => {
  const ctlInstance = new CtlType();
- this.app.container.inject(ctlInstance);
+ this.container.inject(ctlInstance);
  ctx.body = await this.execCtlMethod(ctx, ctlInstance, method);
  ctx.preventCahce = true;
  await next();

src/ControllerLoader/context.ts

@@ -13,7 +13,7 @@ export interface ICtxMappingInfo {
  * 从 ctx 上获取内容
  * @param name JSON Path
  */
-export function ctx(name: string) {
+export function ctx(name = ".") {
  return (target: any, member: string, index: number) => {
  const type = "ctx",
  list = getCtxMappingInfos(target, member);
@@ -32,6 +32,11 @@ export const req = () => ctx("request");
  */
 export const res = () => ctx("response");
 
+/**
+ * Cookie 信息
+ */
+export const cookie = () => ctx("cookies");
+
 /**
  * 路由参数
  * @param name 路由参数名

src/InfoLoader/InfoLoader.ts

@@ -1,6 +1,5 @@
 import { AbstractLoader } from "../AbstractLoader";
-
-const pkg = require("../../package.json");
+import { pkg } from "../common/utils";
 
 /**
  * 静态资源加载器
@@ -10,7 +9,7 @@ export class InfoLoader<T = any> extends AbstractLoader<T> {
  * 加载一个框架信息
  */
  public async load() {
- this.app.server.use(async (ctx, next) => {
+ this.server.use(async (ctx, next) => {
  ctx.set("Server", pkg.displayName);
  await next();
  });

src/IoCLoader/IoCLoader.ts

@@ -9,6 +9,6 @@ export class IoCLoader<T = any[]> extends AbstractLoader<T> {
  */
  public async load<T>() {
  await super.load<T>();
- this.app.container.registerTypes(this.content);
+ this.container.registerTypes(this.content);
  }
 }

src/SessionLoader/SessionLoader.ts

@@ -0,0 +1,22 @@
+import * as session from "koa-session";
+import { AbstractLoader } from "../AbstractLoader";
+import { pkg } from "../common/utils";
+
+const defaultOptions: any = {
+ key: `${pkg.name[0]}sid`.toUpperCase(),
+ maxAge: 86400000
+};
+
+/**
+ * Session 加载器
+ */
+export class SessionLoader<T = any> extends AbstractLoader<T> {
+ /**
+ * 加载 Session
+ */
+ public async load() {
+ const options = { ...defaultOptions, ...this.options };
+ this.server.keys = options.keys || [options.key];
+ this.server.use(session(options, this.server));
+ }
+}