当前位置: 首页 > news >正文

SAP CAP篇十二:AppRouter 深入研究

本文目录

  • 本系列文章
  • 理解现有程序
    • `app`文件夹中的`package.json`
    • 理解`approuter.js`
  • 修改现有程序
    • 修改`package.json`
    • 新建`index.js`
    • 在Approuter中显示额外的逻辑
  • 添加一些额外的Logger
  • 对应代码及branch

本系列文章

SAP CAP篇一: 快速创建一个Service,基于Java的实现
SAP CAP篇二:为Service加上数据库支持
SAP CAP篇三:定义Model
SAP CAP篇四:为CAP添加Fiori Elements程序(1)
SAP CAP篇五:为CAP添加Fiori Elements程序(2)
SAP CAP篇六:为CAP添加Fiori Elements程序(3)
SAP CAP篇七:为CAP添加Fiori Launchpad入口 (Sandbox环境)
SAP CAP篇八:为CAP添加App Router并支持Fiori Launchpad (Sandbox环境)
SAP CAP篇九:升级为SAP CDS 7.0, CAP Java 2以及Spring Boot 3
SAP CAP篇十:理解Fiori UI的Annoation定义
SAP CAP篇十一:支持Media Object:图片、附件等
SAP CAP篇十二:AppRouter 深入研究

理解现有程序

本篇基于上一篇 SAP CAP篇十一:支持Media Object:图片、附件等 代码基础。

app文件夹中的package.json

打开app文件夹中的package.json,可以发现start命令定义如下:

"scripts": {"start": "node node_modules/@sap/approuter/approuter.js"
}

理解approuter.js

看看上述start命令的approuter.js,其中,关键的部分是文件末尾的启动AppRouter部分。

if (require.main === module) {let ar = new Approuter();ar.start();
}

修改现有程序

理解了现有程序之后,可以对现有程序进行修改。

修改package.json

本步骤的修改是在app文件夹下。

修改package.json文件中的’scripts’部分:

"scripts": {"start": "node index.js"
}

新建index.js

由上述script所示,这里的start命令将执行index.js

该新建的index.js文件如下:

const approuter = require('@sap/approuter');
const ar = approuter();ar.start();

其实,上段代码其实就是Approuter.js的核心启动代码:

这时候,启动Service跟Approuter,所有功能都正常运行。换言之,上述代码修改是功能无损的修改,但是它提供了额外的可能。

在Approuter中显示额外的逻辑

如果仔细研读approuter.js的源码,它其实是node.js的程序。而其中的start方法是其中的关键:

Approuter.prototype.start = function (options, callback) {let self = this;if (dynamicRoutingUtils.isDynamicRouting()) {self.first.use(dynamicRoutingUtils.initialize(self));if (options) {delete options.port;options.getRouterConfig = dynamicRoutingUtils.getRouterConfig;} else {options = {'getRouterConfig': dynamicRoutingUtils.getRouterConfig};}}if (options) {validators.validateApprouterStartOptions(options);options = _.cloneDeep(options);} else {options = {};}callback = optionalCallback(callback);if (this.cmdParser) {this.cmdParser.parse(process.argv);options = _.defaults(options, this.cmdParser);}addImplicitExtension(this, options);let logger = loggerUtil.getLogger('/approuter');logger.info('Application router version %s', require('./package.json').version);let app = bootstrap(options);app.logger = logger;app.approuter = this;this._app = app;loggerUtil.getAuditLogger(function(err, auditLogger){if (err) {throw err;}app.auditLogger = auditLogger;serverLib.start(app, function (err, server) {self._server = server;callback(err);});});
};

继续研读下去,其中最关键的serverLib.start(...)的逻辑实现在一个server.js的文件中,而server的start方法:

exports.start = function (app, callback) {let routerConfig = app.get('mainRouterConfig');let server;if (routerConfig.http2Support){server = http2.createServer(app);} else if (routerConfig.httpsOptions) {server = https.createServer(routerConfig.httpsOptions, app);} else {server = http.createServer(app);}if (routerConfig.incomingConnectionTimeout !== undefined) {server.timeout = routerConfig.incomingConnectionTimeout;}server.keepAliveTimeout = routerConfig.serverKeepAlive || 0;let wsServer = new WsProxy(app);wsServer.listen(server);server.on('error', callback);server.listen(routerConfig.serverPort, function () {app.logger.info('Application router is listening on port: ' +server.address().port);callback(undefined, new Server(server, wsServer));});
};

而引用到的lib在文件头部有定义:

const http = require('http');
const https = require('https');
const http2 = require('http2');
const WsProxy = require('./websockets/WsProxy');
const util = require('util');

至此,AppRouter的逻辑很清楚了,就是一个基于nodejs的server。所以,通过其可以实现一定额外的逻辑,譬如proxy之类。

添加一些额外的Logger

虽然可以通过Approuter实现类似proxy的逻辑,但是这不是本篇的重点。接下来,通过AppRouter来实现额外的Log写入逻辑,作为测试。

const approuter = require('@sap/approuter');
const { Console } = require("console");// get fs module for creating write streams
const fs = require("fs");ar.beforeRequestHandler.use('/api', async (req, res, next) => {const myLogger = new Console({stdout: fs.createWriteStream("normalStdout.txt"),stderr: fs.createWriteStream("errStdErr.txt"),});const { rawHeaders, method, originalUrl, url } = req;let body = [];let errorMessage = null;// saving to normalStdout.txt filemyLogger.log(`originalUrl = ${originalUrl}`);myLogger.log(`method = ${method}`);myLogger.log(JSON.stringify(rawHeaders));//    if (method === 'POST' || method === 'PUT') {
//        myLogger.log(`========================================`);
//        myLogger.log(req);//        for await (const chunk of req) {
//            myLogger.log(`+++ 111 ++++++++++++++++++++++++++++++`);
//            myLogger.log(`+++ ${Date.now()} for each data`);
//            myLogger.log(`Log Callback of 'on': ${chunk}`);
//            body.push(chunk);
//        }
//        myLogger.log(`+++ 222 ++++++++++++++++++++++++++++++`);
//        myLogger.log(`+++ ${Date.now()} of all`);
//        body = Buffer.concat(body).toString();
//        myLogger.log(`Log Callback of 'end': ${body}`);//        myLogger.log(`========================================`);
//        myLogger.log(req);
//    }myLogger.log(`+++ 000 ++++++++++++++++++++++++++++++`);myLogger.log(`+++ ${Date.now()} before next()`);next();
});

运行后,所有的对/api的情节都会被写入额外的normalStdout.txt

其中,被注释的代码部分会打印完整requestbody部分,但是作为副作用,request这个stream已经被close了,next()再发送到后续的处理就会失败,所以这里的代码仅作为参考用途。

对应代码及branch

与本文配套的代码参见这里。

本篇对应的branch是8_approuter

http://www.lryc.cn/news/106804.html

相关文章:

  • HDFS中数据迁移的使用场景和考量因素
  • 科普 | 以太坊坎昆升级是什么
  • C# 一些知识整理
  • SpringBoot复习:(15)Spring容器的核心方法refresh是在哪里被调用的?
  • Android安卓实战项目(5)---完整的健身APP基于安卓(源码在文末)可用于比赛项目或者作业参考中
  • AutoSAR系列讲解(实践篇)11.2-存储处理与Block
  • K8s总结
  • 3.playbook剧本二
  • 【MySQL】视图与用户管理
  • LINUX系统监控工具ATOP的使用
  • [回馈]ASP.NET Core MVC开发实战之商城系统(五)
  • iPhone 8透明屏的透明度高吗?
  • Vue2 第十五节 组件间通信方式
  • maven的下载与安装
  • BroadcastChannel 实现浏览器tab无刷新通讯
  • 98. Python基础教程:try...except...finally语句
  • c语言实现简单的tcp客户端
  • RocketMQ详解及注意事项
  • 选择适合的项目管理系统,了解有哪些选择和推荐
  • linux基础命令-cd
  • MySQL数据库分库分表备份
  • PyTorch 中的累积梯度
  • 【面试精品】运维工程师需要具备的核心能力有哪些?
  • 微服务实战项目-学成在线-选课学习(支付与学习中心)模块
  • postman和jmeter的区别何在?
  • maven安装(windows)
  • 自学安全卷不动,是放弃还是继续?
  • Django实现音乐网站 ⑶
  • (13) Qt事件系统(two)
  • PHP的知识概要