@bigtyphoon/melo 1.7.6

package/template/game-server/app/servers/connector/handler/entryHandler.ts

@@ -0,0 +1,50 @@
+import { Application, FrontendSession } from '@bigtyphoon/melo';
+
+export default function (app: Application) {
+    return new Handler(app);
+}
+
+export class Handler {
+    constructor(private app: Application) {
+
+    }
+
+    /**
+     * New client entry.
+     *
+     * @param  {Object}   msg     request message
+     * @param  {Object}   session current session object
+     */
+    async entry(msg: any, session: FrontendSession) {
+        return { code: 200, msg: 'game server is ok.' };
+    }
+
+    /**
+     * Publish route for mqtt connector.
+     *
+     * @param  {Object}   msg     request message
+     * @param  {Object}   session current session object
+     */
+    async publish(msg: any, session: FrontendSession) {
+        let result = {
+            topic: 'publish',
+            payload: JSON.stringify({ code: 200, msg: 'publish message is ok.' })
+        };
+        return result;
+    }
+
+    /**
+     * Subscribe route for mqtt connector.
+     *
+     * @param  {Object}   msg     request message
+     * @param  {Object}   session current session object
+     */
+    async subscribe(msg: any, session: FrontendSession) {
+        let result = {
+            topic: 'subscribe',
+            payload: JSON.stringify({ code: 200, msg: 'subscribe message is ok.' })
+        };
+        return result;
+    }
+
+}

package/template/game-server/app/servers/connector/remote/authRemoter.ts

@@ -0,0 +1,36 @@
+import {Application, RemoterClass, FrontendSession} from '@bigtyphoon/melo';
+
+export default function (app: Application) {
+    return new AuthRemoter(app);
+}
+
+// UserRpc的命名空间自动合并
+declare global {
+    interface UserRpc {
+        connector: {
+            // 一次性定义一个类自动合并到UserRpc中
+            authRemoter: RemoterClass<FrontendSession, AuthRemoter>;
+        };
+    }
+}
+
+
+export class AuthRemoter {
+    constructor(private app: Application) {
+
+    }
+
+    /**
+     *
+     * @param username
+     * @param password
+     */
+    public async auth(username: string , password: string) {
+        return true;
+    }
+
+    // 私有方法不会加入到RPC提示里
+    private async privateMethod(testarg:string,arg2:number){
+
+    }
+}

package/template/game-server/app.ts

@@ -0,0 +1,30 @@
+import { melo } from '@bigtyphoon/melo';
+import { preload } from './preload';
+
+/**
+ *  替换全局Promise
+ *  自动解析sourcemap
+ *  捕获全局错误
+ */
+preload();
+
+/**
+ * Init app for client.
+ */
+let app = melo.createApp();
+app.set('name', '$');
+
+// app configuration
+app.configure('production|development', 'connector', function () {
+    app.set('connectorConfig',
+        {
+            connector: melo.connectors.hybridconnector,
+            heartbeat: 3,
+            useDict: true,
+            useProtobuf: true
+        });
+});
+
+// start app
+app.start();
+

package/template/game-server/app.ts.mqtt

@@ -0,0 +1,32 @@
+import { melo } from '@bigtyphoon/melo';
+import { preload } from './preload';
+
+/**
+ *  替换全局Promise
+ *  自动解析sourcemap
+ *  捕获全局错误
+ */
+preload();
+
+/**
+ * Init app for client.
+ */
+var app = melo.createApp();
+app.set('name', '$');
+
+// app configuration
+app.configure('production|development', 'connector', function(){
+  app.set('connectorConfig',
+    {
+      connector : melo.connectors.mqttconnector,
+      publishRoute: 'connector.entryHandler.publish',
+      subscribeRoute: 'connector.entryHandler.subscribe'
+    });
+});
+
+// start app
+app.start();
+
+process.on('uncaughtException', function (err) {
+  console.error(' Caught exception: ' + err.stack);
+});

package/template/game-server/app.ts.sio

@@ -0,0 +1,36 @@
+import { melo } from '@bigtyphoon/melo';
+import { preload } from './preload';
+
+/**
+ *  替换全局Promise
+ *  自动解析sourcemap
+ *  捕获全局错误
+ */
+preload();
+
+/**
+ * Init app for client.
+ */
+var app = melo.createApp();
+app.set('name', '$');
+
+// app configuration
+app.configure('production|development', 'connector', function(){
+  app.set('connectorConfig',
+    {
+      connector : melo.connectors.sioconnector,
+      // 'websocket', 'polling-xhr', 'polling-jsonp', 'polling'
+      transports : ['websocket', 'polling'],
+      heartbeats : true,
+      closeTimeout : 60 * 1000,
+      heartbeatTimeout : 60 * 1000,
+      heartbeatInterval : 25 * 1000
+    });
+});
+
+// start app
+app.start();
+
+process.on('uncaughtException', function (err) {
+  console.error(' Caught exception: ' + err.stack);
+});

package/template/game-server/app.ts.sio.wss

@@ -0,0 +1,34 @@
+import { melo } from '@bigtyphoon/melo';
+import { preload } from './preload';
+
+/**
+ *  替换全局Promise
+ *  自动解析sourcemap
+ *  捕获全局错误
+ */
+preload();
+
+var fs = require('fs');
+
+/**
+ * Init app for client.
+ */
+var app = melo.createApp();
+app.set('name', '$');
+
+// app configuration
+app.configure('production|development', function(){
+  app.set('connectorConfig',
+    {
+      connector : melo.connectors.sioconnector,
+      key: fs.readFileSync('../../shared/server.key'),
+  		cert: fs.readFileSync('../../shared/server.crt')
+    });
+});
+
+// start app
+app.start();
+
+process.on('uncaughtException', function (err) {
+  console.error(' Caught exception: ' + err.stack);
+});

package/template/game-server/app.ts.udp

@@ -0,0 +1,31 @@
+import { melo } from '@bigtyphoon/melo';
+import { preload } from './preload';
+
+/**
+ *  替换全局Promise
+ *  自动解析sourcemap
+ *  捕获全局错误
+ */
+preload();
+
+/**
+ * Init app for client.
+ */
+var app = melo.createApp();
+app.set('name', '$');
+
+// app configuration
+app.configure('production|development', function(){
+  app.set('connectorConfig',
+    {
+      connector : melo.connectors.udpconnector,
+     	heartbeat : 3
+    });
+});
+
+// start app
+app.start();
+
+process.on('uncaughtException', function (err) {
+  console.error(' Caught exception: ' + err.stack);
+});

package/template/game-server/app.ts.wss

@@ -0,0 +1,40 @@
+import { melo } from '@bigtyphoon/melo';
+import { preload } from './preload';
+
+/**
+ *  替换全局Promise
+ *  自动解析sourcemap
+ *  捕获全局错误
+ */
+preload();
+
+var fs = require('fs');
+
+/**
+ * Init app for client.
+ */
+var app = melo.createApp();
+app.set('name', '$');
+
+// app configuration
+app.configure('production|development', 'connector', function(){
+  app.set('connectorConfig',
+    {
+      connector : melo.connectors.hybridconnector,
+      heartbeat : 3,
+      useDict : true,
+      useProtobuf : true,
+      ssl: {
+        type: 'wss',
+      	key: fs.readFileSync('../../shared/server.key'),
+  			cert: fs.readFileSync('../../shared/server.crt')
+      }
+    });
+});
+
+// start app
+app.start();
+
+process.on('uncaughtException', function (err) {
+  console.error(' Caught exception: ' + err.stack);
+});

package/template/game-server/config/adminServer.json

@@ -0,0 +1,5 @@
+[{
+    "type": "connector",
+    "token": "agarxhqb98rpajloaxn34ga8xrunpagkjwlaw3ruxnpaagl29w4rxn"
+}
+]

package/template/game-server/config/adminUser.json

@@ -0,0 +1,22 @@
+[
+  {
+    "id": "user-1",
+    "username": "admin",
+    "password": "admin",
+    "level": 1
+  },
+  
+  {
+    "id": "user-2",
+    "username": "monitor",
+    "password": "monitor",
+    "level": 2
+  },
+
+  {
+    "id": "user-3",
+    "username": "test",
+    "password": "test",
+    "level": 2
+  }
+]

package/template/game-server/config/clientProtos.json

@@ -0,0 +1 @@
+{}

package/template/game-server/config/dictionary.json

@@ -0,0 +1 @@
+{}

package/template/game-server/config/log4js.json

@@ -0,0 +1,150 @@
+{
+  "appenders": {
+    "console": {
+      "type": "console"
+    },
+    "con-log": {
+      "type": "file",
+      "filename": "${opts:base}/logs/con-log-${opts:serverId}.log",
+      "pattern": "connector",
+      "maxLogSize": 1048576,
+      "layout": {
+        "type": "basic"
+      },
+      "backups": 5
+    },
+    "rpc-log": {
+      "type": "file",
+      "filename": "${opts:base}/logs/rpc-log-${opts:serverId}.log",
+      "maxLogSize": 1048576,
+      "layout": {
+        "type": "basic"
+      },
+      "backups": 5
+    },
+    "forward-log": {
+      "type": "file",
+      "filename": "${opts:base}/logs/forward-log-${opts:serverId}.log",
+      "maxLogSize": 1048576,
+      "layout": {
+        "type": "basic"
+      },
+      "backups": 5
+    },
+    "rpc-debug": {
+      "type": "file",
+      "filename": "${opts:base}/logs/rpc-debug-${opts:serverId}.log",
+      "maxLogSize": 1048576,
+      "layout": {
+        "type": "basic"
+      },
+      "backups": 5
+    },
+    "crash-log": {
+      "type": "file",
+      "filename": "${opts:base}/logs/crash.log",
+      "maxLogSize": 1048576,
+      "layout": {
+        "type": "basic"
+      },
+      "backups": 5
+    },
+    "admin-log": {
+      "type": "file",
+      "filename": "${opts:base}/logs/admin.log",
+      "maxLogSize": 1048576,
+      "layout": {
+        "type": "basic"
+      },
+      "backups": 5
+    },
+    "melo": {
+      "type": "file",
+      "filename": "${opts:base}/logs/melo-${opts:serverId}.log",
+      "maxLogSize": 1048576,
+      "layout": {
+        "type": "basic"
+      },
+      "backups": 5
+    },
+    "melo-admin": {
+      "type": "file",
+      "filename": "${opts:base}/logs/melo-admin.log",
+      "maxLogSize": 1048576,
+      "layout": {
+        "type": "basic"
+      },
+      "backups": 5
+    },
+    "melo-rpc": {
+      "type": "file",
+      "filename": "${opts:base}/logs/melo-rpc-${opts:serverId}.log",
+      "maxLogSize": 1048576,
+      "layout": {
+        "type": "basic"
+      },
+      "backups": 5
+    }
+  },
+  "categories": {
+    "default": {
+      "appenders": [
+        "console",
+        "melo"
+      ],
+      "level": "debug"
+    },
+    "con-log": {
+      "appenders": [
+        "con-log"
+      ],
+      "level": "debug"
+    },
+    "rpc-log": {
+      "appenders": [
+        "rpc-log"
+      ],
+      "level": "debug"
+    },
+    "forward-log": {
+      "appenders": [
+        "forward-log"
+      ],
+      "level": "debug"
+    },
+    "rpc-debug": {
+      "appenders": [
+        "rpc-debug"
+      ],
+      "level": "debug"
+    },
+    "crash-log": {
+      "appenders": [
+        "crash-log"
+      ],
+      "level": "debug"
+    },
+    "admin-log": {
+      "appenders": [
+        "admin-log"
+      ],
+      "level": "debug"
+    },
+    "melo-admin": {
+      "appenders": [
+        "melo-admin"
+      ],
+      "level": "debug"
+    },
+    "melo-rpc": {
+      "appenders": [
+        "melo-rpc"
+      ],
+      "level": "debug"
+    }
+  },
+  "prefix": "${opts:serverId} ",
+  "replaceConsole": true,
+  "lineDebug": false,
+  "errorStack": true
+}

package/template/game-server/config/master.json

@@ -0,0 +1,8 @@
+{
+  "development": {
+    "id": "master-server-1", "host": "127.0.0.1", "port": 3005
+  },
+  "production": {
+    "id": "master-server-1", "host": "127.0.0.1", "port": 3005
+  }
+}

package/template/game-server/config/serverProtos.json

@@ -0,0 +1 @@
+{}

package/template/game-server/config/servers.json

@@ -0,0 +1,12 @@
+{
+  "development":{
+    "connector": [
+    {"id": "connector-server-1", "host": "127.0.0.1", "port": 3150, "clientHost": "127.0.0.1", "clientPort": 3010, "frontend": true , "args" : " --inspect=10001"}
+    ]
+  },
+  "production":{
+    "connector": [
+    {"id": "connector-server-1", "host": "127.0.0.1", "port": 3150, "clientHost": "127.0.0.1", "clientPort": 3010, "frontend": true , "args" : " --inspect=10002"}
+    ]
+  }
+}

package/template/game-server/copy.js

@@ -0,0 +1,5 @@
+const cpy = require('cpy')
+// 复制配置文件到打包好的目录中
+cpy(['./config/**'], './dist/config').then(() => {
+    console.log('build. config files copied')
+})

package/template/game-server/package.json

@@ -0,0 +1,28 @@
+{
+    "name":"__melo_app_name__",
+    "version":"0.0.1",
+    "private":false,
+
+    "bin": {
+        "__melo_app_name__": "./dist/bin/app.js"
+      },
+    "main": "./dist/app",
+    "scripts": {
+        "start": "npm run build && cd dist &&  node app",
+        "build": "tsc  && node copy"
+    },
+    "dependencies":{
+        "@types/node": "^16.3.3",
+        "@types/bluebird": "^3.5.19",
+        "@bigtyphoon/melo":"__melo_app_version__",
+        "bluebird": "^3.5.1",
+        "source-map-support": "^0.5.0",
+        "reflect-metadata": "^0.1.13"
+    },
+    "devDependencies": {
+        "cpy": "^8.1.0",
+	    "tslint": "6.1.3",
+        "typescript": "^4.3.5"
+    }
+}
+

package/template/game-server/preload.ts

@@ -0,0 +1,40 @@
+import { Promise } from 'bluebird';
+// 支持注解
+import 'reflect-metadata';
+import { melo } from '@bigtyphoon/melo';
+
+/**
+ *  替换全局Promise
+ *  自动解析sourcemap
+ *  捕获全局错误
+ */
+export function preload() {
+    // 使用bluebird输出完整的promise调用链
+    ((global as any).Promise as any) = (Promise as any);
+    // 开启长堆栈
+    Promise.config({
+        // Enable warnings
+        warnings: true,
+        // Enable long stack traces
+        longStackTraces: true,
+        // Enable cancellation
+        cancellation: true,
+        // Enable monitoring
+        monitoring: true
+    });
+
+    // 自动解析ts的sourcemap
+    require('source-map-support').install({
+        handleUncaughtExceptions: false
+    });
+
+    // 捕获普通异常
+    process.on('uncaughtException', function (err) {
+        console.error(melo.app ? melo.app.getServerId() : "unknownServerId", 'uncaughtException Caught exception: ', err);
+    });
+
+    // 捕获async异常
+    process.on('unhandledRejection', (reason: any, p) => {
+        console.error(melo.app ? melo.app.getServerId() : "unknownServerId", 'Caught Unhandled Rejection at:', p, 'reason:', reason);
+    });
+}

package/template/game-server/tsconfig.json

@@ -0,0 +1,36 @@
+{
+  "compilerOptions": {
+    "skipLibCheck": true,
+    // types option has been previously configured
+    "types": [
+      // add node as an option
+      "node"
+    ],
+    "module": "commonjs", //指定生成哪个模块系统代码
+    "target": "es2017",
+    "lib": [
+      "es2015",
+      "es2016",
+      "es2017",
+      "esnext.asynciterable",
+      "DOM"
+    ],
+    "noImplicitAny": false, //在表达式和声明上有隐含的'any'类型时报错。
+    "noImplicitThis": false,
+    "inlineSourceMap": true,
+    "newLine": "lf", // 统一跨平台下编译文件的换行符
+
+    "rootDirs": ["."], //仅用来控制输出的目录结构--outDir。
+    "outDir": "./dist", //重定向输出目录。
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "moduleResolution": "node"
+  },
+  "include": [
+    "./**/*.ts"
+  ],
+  "exclude": [
+    "./dist/**/*.*",
+    "node_modules"
+  ]
+}

package/template/npm-install.bat

@@ -0,0 +1,4 @@
+::npm-install.bat
+@echo off
+::install web server dependencies && game server dependencies
+cd web-server && npm install -d && cd .. && cd game-server && npm install -d

package/template/npm-install.sh

@@ -0,0 +1,5 @@
+cd ./game-server && npm install -d
+echo '============   game-server npm installed ============'
+cd ..
+cd ./web-server && npm install -d
+echo '============   web-server npm installed ============'

package/template/readme.md

@@ -0,0 +1,31 @@
+这是melo的简单示例工程，包含：
+1、game-server，游戏服务器
+2、web-server，网页客户端的服务
+
+启动方法：
+1、执行npm-install.bat或npm-install.sh
+2、编译游戏服
+cd game-server
+npm run build
+2、启动游戏服
+cd dist
+node app
+显示“all servers startup in xxx ms”即表示启动成功
+
+3、启动网页服务器
+cd web-server
+node app
+显示“Please log on http://127.0.0.1:3001/index.html”即表示启动成功
+
+4、进入客户端网页
+浏览器输入
+http://127.0.0.1:3001/index.html
+点击“Test Game Server”，如返回“game server is ok.”即表示连接游戏服务器返回成功
+
+
+调试游戏服务器的方法：
+1、安装vscode
+2、在game-server目录启动vscode
+3、按照正常流程启动游戏服
+4、在“调试”界面，选择Attach To Connector或Attach To Master
+5、按F5把调试器挂上去，然后就可以断点调试了。

package/template/shared/server.crt

@@ -0,0 +1,15 @@
+-----BEGIN CERTIFICATE-----
+MIICSzCCAbQCCQCQVN8rD6MylDANBgkqhkiG9w0BAQUFADBqMQswCQYDVQQGEwJD
+TjERMA8GA1UECAwIemhlamlhbmcxETAPBgNVBAcMCGhhbmd6aG91MRAwDgYDVQQK
+DAdOZXRFYXNlMQ8wDQYDVQQLDAZwb21lbG8xEjAQBgNVBAMMCWxvY2FsaG9zdDAe
+Fw0xNDA0MjIwNjEwMDJaFw0xNDA1MjIwNjEwMDJaMGoxCzAJBgNVBAYTAkNOMREw
+DwYDVQQIDAh6aGVqaWFuZzERMA8GA1UEBwwIaGFuZ3pob3UxEDAOBgNVBAoMB05l
+dEVhc2UxDzANBgNVBAsMBnBvbWVsbzESMBAGA1UEAwwJbG9jYWxob3N0MIGfMA0G
+CSqGSIb3DQEBAQUAA4GNADCBiQKBgQDMPe8oscKpTlQFZRrpbWmSO1UE+H65nq50
+l5+ptOVPMK3wgEj+YRyGWhBjugj9teVmLXY9ImWdZkBlvdAiQj7/S/1MxRbRtwEF
+GRE5ul/X1M6I+F0UyTGYA1Mo0jIlQaBDXAAyDujCWi+qlyZ28efNDUlO2KBY1H4r
+Xobm9hoEFQIDAQABMA0GCSqGSIb3DQEBBQUAA4GBAMIuL8KqEEtjbfL/tR2+5dQ5
+958gtDtA62L7bMosl4hmuzdyWADu3IcKSaXAESLhIuIClt2Pwc14iFf9qRyB/cjY
+4kLgwDGhK5EJw1kQS+Hs9NNSGxJTXUkoms3kEdRGy4hrZpTheJJNaKuv3oXrdvYQ
+85yoc/P5OnJapB3huYL9
+-----END CERTIFICATE-----