本文所说的 后台服务(Service) 是指在服务器电脑上由任擎(tasgine)软件执行的代码,它可以根据客户端发送的请求数据,进行数据库增删改查、数据导入导出、文件上传下载、文件读写等操作,并向客户端返回处理结果。后台服务运行时是没有界面的,占用的是服务器电脑的相关资源。
后台服务文件一般不需要开发者手动创建,使用向导创建前端页面,或者在前端页面里为各个组件设置数据增删改查操作时,都会自动创建对应的后台服务文件。但如果后台服务的业务逻辑比较复杂,自动创建的无法满足要求,则可以手动创建并进行详细的设置。
3.2.1后台服务文件的格式
任擎服务器目前支持编辑两种格式的后台服务:
js格式:扩展名为.js,内容为JavaScript代码,这种格式任擎可以直接加载运行,是后台服务最终运行时的代码格式,不需要编译,但只能使用代码编辑器编辑,不能可视化设计,本文档主要讲低代码开发,所以不会深入介绍这种纯代码格式的后台服务。
tbs格式:扩展名为.tbs(Taskmsg Back-end Service),实际内容格式为JSON。这种格式支持在TaskBuilder内进行可视化设计,在客户端请求这种格式的后台服务时,任擎会将该文件自动编译为js代码并加载运行。这种格式是一种中性的格式,理论上可以编译为任意编程语言,例如Java、C#、Python等。
js格式的后台服务用代码编辑器打开后的界面如下图所示,在此可以直接编写后台服务的js代码:
在tbs格式的后台服务文件内,定义了具体有哪些操作及其详细的参数设置,如下图所示:
注意:在TaskBuilder内,可以将tbs格式的后台服务另存为js格式的,但无法把js格式还原为tbs格式。
3.2.2后台服务设计器简介
tbs后台服务设计器由以下几个部分构成:
3.2.2.1基本信息
后台服务的基本信息设置界面如下图所示:
在后台服务的基本信息里可以设置以下内容:
服务名称:用来设置后台服务类的名称,一般不需要设置,创建后台服务时会自动生成,只能是字母、数字和下划线,且必须是字母开头,建议首字母大写。
服务说明:用来设置后台服务的功能说明。
不校验是否登录:后台服务默认都是需要登录才能访问的,如果某些后台服务不需要登录也可以访问,则需要在基本信息里,将“不校验是否登录”这个复选框勾上。
不检查SQL注入:任擎默认会对客户端发送给后台服务的所有请求参数进行校验,判断参数中是否存在SQL注入的可疑字符,如果存在,则会自动拦截该请求,并向客户端返回错误。如果您在开发某个应用时,前端页面提交的数据包含insert、update、select等SQL关键字,或者一些特殊字符,例如:、%、' 、" 等,则可以在对应的后台服务的基本信息里,把“不检查SQL注入”这个选项选中。
请求参数:在此可以设置客户端可能会提交给当前后台服务的所有请求参数,并设置这些参数的一些细节信息,包括:参数备注、参数类型、是否不能为空、默认值、是否忽略SQL注入、文本验证的正则表达式等。设置好这些信息后,当有客户端请求该服务时,任擎会自动对这些参数进行校验,包括数据类型是否正确、不能为空的参数是否传递了值、是否有SQL注入的非法内容、是否满足文本验证的正则表达式的要求等,如果校验未通过,会向客户端返回详细的错误信息。如果设置了参数备注,在错误信息里会使用备注来提示,否则用参数名提示。另外,如果设置了默认值,当前端传递的参数为空时,会使用默认值作为该参数的值。
*3.2.2.2业务逻辑设计器**
tbs后台服务的业务逻辑设计器如下图所示:
该设计器提供了丰富的功能,可以通过鼠标拖拽快速创建常用的后台操作,包括数据库增删改查、Excel文件导入导出、附件上传下载、邮件和短信发送等。
tbs后台服务的业务逻辑设计器由以下几个部分构成:
3.2.2.2.1模块引用
如果在后台服务里需要用到第三方js模块(文件)的功能,则可以点击设计器左上角“引用”栏右侧的加号,然后弹出以下窗口:
在该对话框中,首先需要选择模块的类型,包括以下三种类型:
系统模块:指node.js运行环境内置的模块,例如文件访问模块fs、加解密模块crypto、网络操作模块net等,具体有哪些内置模块以及如何使用请查看node.js的官方文档;
npm包:指通过npm install命令安装在tasgine\node_modules目录里的npm包,npm 是 JavaScript 的包管理工具,让 JavaScript 开发人员可以轻松地使用其他开发人员共享的代码,开发者可以上网站 https://www.npmjs.com/ 搜索自己所需的模块。如果要引用npm包,模块路径只需要设置为npm包的包名即可,任擎会自动去tasgine\node_modules目录查找该包对应的模块文件,我们连接MySQL数据使用的mysql模块、导入导出Excel文件使用的node-xlsx模块就是属于这种npm模块。
自定义模块:指部署在tasgine\app\项目代码\service目录里的各种后台业务服务,如果选择这种类型,上面的对话框中会显示当前任擎服务器上的项目列表,可以层层展开找到需要的服务,然后选中。
在后台服务中引入的js模块必须满足CommonJS或ES6这两种js模块规范中的一种,否则无法正确引入,CommonJS是Node.js默认的模块规范,Node.js内置的系统模块、大部分npm模块和用TaskBuilder创建的后台服务都是采用的这种规范,有一些比较新的npm模块可能会采用ES6模块,具体哪个npm模块采用的什么规范请查看该模块的说明文档。
上图对话框中的模块名称是指在当前后台服务中为引用的模块分配的一个变量名,可以和npm包的名称一致,也可以改成其他名称,开发者可以根据自身需要进行设置。
模块路径是指模块的引用路径,如果是系统模块或npm模块,模块路径就是模块名称,不需要加其他目录名,如果是自定义模块,则需要在模块路径中提供相对于tasgine\app目录的完整路径,例如:/demo/service/test.js,否则调用该服务时,会出现无法找到服务的错误。
3.2.2.2.2属性
如果后台服务中定义了多个方法,而且需要在多个方法之间共享数据,则可以通过后台服务中的属性来实现,点击后台服务设计器左侧“属性”栏右侧的加号按钮,即可打开“添加属性”的对话框,如下图所示:
属性类似前端页面里的全局变量,只不过在后台服务的各个方法里访问时,需要在属性前面加上 self. 前缀,表示是当前后台服务对象的属性,而不是方法参数或方法内的局部变量。
3.2.2.2.3方法
后台服务里的方法类似前端页面里的js函数,用来实现某个特定的功能。点击后台服务设计器左侧“方法”栏右侧的加号按钮,即可打开“添加方法”的对话框,如下图所示:
输入方法名称、备注,选择返回值类型和编辑模式,设置好调用该方法需要传入的参数,点确定即可完成方法的创建。
其中,方法的编辑模式支持图形化和代码两种模式,如果是图形化模式,会在设计器右侧显示一个可视化业务逻辑编排区,可以在此编排当前方法的业务逻辑,可以从左侧语句库中拖拽各种语句到右侧可视化业务逻辑编排区,并设置其详细参数,TaskBuilder提供了一百多个常用的后台操作语句,包括基本语句、数据格式校验、数据格式转换、字符串处理、数值处理、日期时间处理、数组处理、系统数据、数据库操作、数据缓存操作、导入导出、附件操作、文件操作、通讯和加密解密这几大类,如下图所示:
如果是代码模式,则只能在代码编辑器中编写当前方法的逻辑代码,如下图所示:
当然,也可以从左侧语句库中拖拽语句到代码编辑器,但需要先设置好语句的参数,点确定后,就会将该语句的相应代码插入到光标位置,插入完之后,就不能再图形化修改了。
用TaskBuilder创建的所有后台服务都默认有一个 process(req, res) 的入口方法,该方法为图形化模式,不能修改为代码模式,也不能删除。在客户端请求该服务时,任擎会加载该服务的内容,并编译为js代码,然后调用这个服务的 process 方法,传入客户端请求对象 req(Request的缩写)和服务器响应对象 res(Response的缩写)。req对象里包含了客户端发送过来的所有请求参数,在后台服务的各个语句里,可以通过 req.参数名 的形式从客户端请求对象req中获取指定参数的值。服务器响应对象res默认仅提供了一个名为 code 的属性,值为 0 ,表示后台服务执行成功,在后台服务的各个语句里,可以用 res.参数名 的形式,将需要返回给客户端的数据保存到res对象中。在所有操作都执行完毕后,可以通过“终止服务”语句结束当前服务,并把响应结果返回给客户端。
在大多数情况下,通过拖拽相关的语句到默认的 process 方法里,然后设置好相关参数,就能实现很多常见的功能,例如数据库增删改查、导入导出、上传下载等。如果业务逻辑特别复杂,则建议对业务逻辑进行拆分,将某些相对独立的操作或者可以复用的语句放到单独的方法内,以便查看和维护。新建的方法建议都要求传递req和res参数,以便在新方法里通过req对象获得客户端请求参数,通过res对象向客户端返回数据。在一个方法内,可以使用基本语句中的“方法调用”语句调用当前后台服务内的其他方法。
3.2.2.3 TBS代码
点击后台服务设计器底部的“TBS代码”选项卡,可以查看和编辑当前后台服务的tbs源码,但一般不建议直接改tbs源码,除非对tbs代码的结构很熟悉。
3.2.2.4 JS代码
点击后台服务设计器底部的“JS代码”选项卡,可以查看编译后的JavaScript代码,如下图所示:
TaskBuilder低代码开发必须的三种文件—后台服务文件
点赞
收藏