[pinus]:DictionaryComponent 添加选项 ignoreAutoRouter

不自动按照路由生成router,仅使用 config/dictionary 内的路由. 这样路由的 id 就可以通过dictionary的顺序来控制了,方便proto变更不影响原顺序id (为也热更新考虑) 另外这样也少一次load handler
node-pinus · Sep 27, 2020 · 780b0ef · 780b0ef
1 parent 1e38571
commit 780b0ef
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 18 deletions.
diff --git a/examples/websocket-chat-ts-run/game-server/app.ts b/examples/websocket-chat-ts-run/game-server/app.ts
@@ -51,6 +51,11 @@ app.configure('production|development', 'connector', function () {
             useDict: true,
             useProtobuf: true
         });
+    // 不自动按照路由生成router,仅使用 config/dictionary 内的路由.
+    // 具体看 packages/pinus/lib/components/dictionary.ts DictionaryComponentOptions
+    app.set('dictionaryConfig', {
+        ignoreAutoRouter: true,
+    })
 
     /**
      // 缓存大小不够 日志示例

diff --git a/examples/websocket-chat-ts-run/game-server/config/dictionary.ts b/examples/websocket-chat-ts-run/game-server/config/dictionary.ts
@@ -1 +1,6 @@
-module.exports = [];
+module.exports = [
+    "chat.chatHandler.send",
+    "connector.entryHandler.enter",
+    "connector.entryHandler.onUserLeave",
+    "gate.gateHandler.queryEntry",
+];
diff --git a/packages/pinus/lib/components/dictionary.ts b/packages/pinus/lib/components/dictionary.ts
@@ -1,17 +1,19 @@
-import * as fs from 'fs';
 import * as path from 'path';
-import * as utils from '../util/utils';
 import * as Loader from 'pinus-loader';
+import { LoaderPathType } from 'pinus-loader';
 import * as pathUtil from '../util/pathUtil';
 import * as crypto from 'crypto';
 import { Application } from '../application';
 import { IComponent } from '../interfaces/IComponent';
 import { listEs6ClassMethods } from 'pinus-rpc';
-import { RESERVED, ServerInfo } from '../util/constants';
-import { LoaderPathType } from 'pinus-loader';
 
+// app.set('dictionaryConfig',{dict,ignoreAutoRouter})
 export interface DictionaryComponentOptions {
     dict?: string;
+    // 不自动按照路由生成router,仅使用 config/dictionary 内的路由.
+    // 这样路由的 id 就可以通过dictionary的顺序来控制了,方便proto变更不影响原顺序id (为也热更新考虑)
+    // 另外这样也少一次load handler
+    ignoreAutoRouter?: boolean;
 }
 
 function canResolve(path: string) {
@@ -30,6 +32,7 @@ export class DictionaryComponent implements IComponent {
     userDicPath: string;
     version = '';
     name = '__dictionary__';
+    ignoreAutoRouter: boolean;
 
     constructor(app: Application, opts: DictionaryComponentOptions) {
         this.app = app;
@@ -39,6 +42,9 @@ export class DictionaryComponent implements IComponent {
         if (!!opts && !!opts.dict) {
             p = opts.dict;
         }
+        if (!!opts) {
+            this.ignoreAutoRouter = opts.ignoreAutoRouter ?? false;
+        }
         if (canResolve(p)) {
             this.userDicPath = p;
         }
@@ -48,25 +54,27 @@ export class DictionaryComponent implements IComponent {
     start(cb: () => void) {
         let servers = this.app.get('servers');
         let routes = [];
+        if (!this.ignoreAutoRouter) {
+            // Load all the handler files
+            for (let serverType in servers) {
+                let p = pathUtil.getHandlerPath(this.app.getBase(), serverType);
+                if (!p) {
+                    continue;
+                }
+                let handlers = Loader.load(p, this.app, false, false, LoaderPathType.PINUS_HANDLER);
 
-        // Load all the handler files
-        for (let serverType in servers) {
-            let p = pathUtil.getHandlerPath(this.app.getBase(), serverType);
-            if (!p) {
-                continue;
-            }
-            let handlers = Loader.load(p, this.app, false, false, LoaderPathType.PINUS_HANDLER);
-
-            for (let name in handlers) {
-                let handler = handlers[name];
+                for (let name in handlers) {
+                    let handler = handlers[name];
 
-                let proto = listEs6ClassMethods(handler);
-                for (let key of proto) {
-                    routes.push(serverType + '.' + name + '.' + key);
+                    let proto = listEs6ClassMethods(handler);
+                    for (let key of proto) {
+                        routes.push(serverType + '.' + name + '.' + key);
+                    }
                 }
             }
         }
 
+
         // Sort the route to make sure all the routers abbr are the same in all the servers
         routes.sort();