MARS 功能介绍

  依据MARS使用手册之界面介绍图示，列举每个功能详细使用说明。以下将以 Mars Desktop 为例进行说明，Mars Console 实现的连接功能与 Mars Dekstop 相同。

1. 界面、功能菜单

   通过 ./MarsDesktop 运行后，默认会处于运行状态。运行状态显示的按钮说明如下。

• 停止/启动：停止或启动 MARS的运行。
• 退出：停止MARS的运行并退出 MARS Desktop 界面。
• 关于：显示MARS的版本信息。

2. 日志

  日志界面显示 MARS 的运行状态信息以及客户端的连接信息，日志生成的文件可在 log 目录中查看。

3. 参数设置

  点击参数设置的标签页，进入参数设置界面。界面中使用的按钮说明如下。

• 恢复默认值：将设置恢复为默认状态。
• 应用：将当前应用保存至配置文件中。

3.1. 常规参数

  常规参数中的内容说明如下。

• [常规设置]-常规

  • HTTP端口： HTTP协议代理服务器端口，默认的端口号为8809。
  • HTTTPS端口： HTTPS协议代理服务器端口，只有在配置了SSL的情况下才可启用该选项，默认的端口号为443。
  • 数据压缩级别： 数据压缩后，客户端调用数据相对会提高效率。可选择项包括：不压缩(cNone)、快速压缩(cFast)、默认(cDefault)、最大压缩(cMax)4种。
  • 线程池最大数： 设定数据连接的线程数目，通常设定为CPU个数 * 25，超过这个值系统的运行可能会不稳定（仅限于服务器，普通PC的上限数值更低）。
  • 下行最大速度： 设定下行数据传输的最大速率，默认设置为0，表示为不限制下行速率。
  • IP版本： IP地址类型，包括：rct_IPv4、rct_IPvOS4、rct_IPv6、rct_IPvOS6。
  • 最大连接数： 程序允许的客户端同时在线连接数。
  • 上行最大速度： 设定上行数据传输的最大速率，默认设置为0，表示为不限制上行速率。
  • 客户端空闲时间： 客户端连接状态保持时间。对于网络不稳定的环境可将数值设置小一些。

• [常规设置]-远程函数

  • 模块文件名： 自定义的远程模块函数名称，默认为/RemoteFunction。
  • 加密数据： 中间件进行数据交互时采用加密传输，默认未勾选。
  • 通讯安全码： 客户端与中间件交互时，需要提供通讯安全码。此项需要勾选[加密数据]才有效。
  • 验证用户身份： 勾选表示客户端与中间件交互时，需要进行身份验证。
  • 用户数据库： 指用验证用户所在数据库的连接名称。此项在验证用户身份勾选时可用。
  • 全局MD5盐值： MD5加盐值，使数据库更加安全。
  • Token有效期： Token是服务端生成的一串字符串，以作客户端进行请求的一个令牌，当第一次登录后，服务器生成一个Token便将此Token返回给客户端，以后客户端只需带上这个Token前来请求数据即可，无需再次带上用户名和密码。

• [常规设置]-文件传输

  • 存储目录： 文件根目录。
  • 文件不超过MB： 可指定文件大小限制，防止大文件传输，造成服务器压力。
  • 使用单一根目录： 勾选此项，以文件根目录为文件目录。

• [常规设置] - 消息服务

  • WebSocket消息服务： 勾选启用WebSocket消息服务。
  • 模块文件名称： WebSocket消息服务模块文件名，设置后，可使用ws://<host>:<port>/WebSocket来发起WebSocket连接。
  • 远程函数消息服务： 勾选启用远程函数消息服务。
  • 模块文件名称： 远程函数消息服务模块文件名。

    该功能需配合网页端的WebSocket功能来使用，此处可打开WebSocket测试网站来进行相关测试。

    在测试页面的地址框中输入TARS的地址，比如TARS本机的IP地址为192.168.0.201，开放的端口号为8809，消息提示函数名称为WebSocket，则对应的WebSocket地址设置为ws://192.168.0.201:8809/WebSocket。点击[连接]。待服务端回应Hello,Web Socket Client!时表示连接成功。此时可在网页页面底部的待发信息栏中输入要发送的信息，点击 [发送] 按钮。在MARS的日志列表中会显示此客户端发送的消息。

  

3.2. Web服务

  MARS的Web服务支持小型WEB网站架构，支持JS、HTML网页。

  图中内容说明如下：

• [Web服务]

  • 开启Web服务： 勾选以启用Web服务。
  • WEB根目录： Web网站内容目录。
  • 默认首页：设定自动打开的默认首页的文件名称类型。
  • Content Types：设定显示内容的类型。

3.3. 短信验证

  短信验证采用新版的阿里云通信短信接口，账号申请、获取Access Key Id 与Access Key Secret，以及短信模板的配置方式请在阿里云短信平台文档 (opens new window)查阅。此处设置的内容后，在客户端使用RFSmsSender类型的控件时，如不填写内容运行则默认使用此设置中的内容进行填充。

  图中内容说明如下：

• [短信验证]-阿里云通信

  • Access Key Id： 阿里通信的AccessKey ID，在阿里云官方开通阿里通信得到。
  • Access Key Secret： 阿里通信的AccessKey Secret，在阿里云官方网站得到。
  • 短信模板ID： 阿里通信短信模板的ID。
  • 短信签名： 阿里通信短信签名。

• [短信验证]-阿里大于

  • App Key： 阿里大于的App Key，在阿里云官方开通阿里通信得到。
  • App Secret： 阿里大于的App Secret，在阿里云官方网站得到。
  • 短信模板ID： 阿里大于短信模板的ID。
  • 短信签名： 阿里大于短信签名。

• 示例：短信验证设置完成后，可使用Smart中的短信发送范例来进行测试。在Smart中完成帐套设置的相关内容后，填写接收的手机号码，然后直接点击[TARS发送短信]，出现“短信下发成功”的提示时表示短信发送成功。

3.4. SSL证书

  使用SSL证书来加密通信连接，保证通信过程不被第三方窃听。请自行查询申请证书的方式有关内容。

  图中内容说明如下：

• [REST/SSL]-REST数据库

  • 访问方式： 设置REST模式下用户的访问方式。
    • 通过SQL命令(灵活性好)：用户在REST请求中可直接发送SQL脚本来执行。
    • 通过SQL编号(安全性高)：用户在REST请求中发送SQL编号来执行相应的脚本。
    • 根据用户设置：根据用户管理中的用户访问方式设置来确定访问方式。

• [REST/SSL]-PFX证书

  • 根证书： 设定根证书文件所在的地址。
  • PFX证书： 设定PFX证书文件所在的地址。
  • PFX证书密码： 设定PFX证书的密码。

• [REST/SSL]-X509证书

  • X509证书： 设定X509证书文件所在的地址。
  • X509 Key证书： 设定X509 Key证书文件所在的地址。
  • 证书密码： 设定X509证书的密码。

3.5. 黑白名单

  可设置黑名单IP限制用户访问中间件。每个IP地址设置一行。当指定的IP地址进入至黑名单后，此IP地址将不被允许接入至MARS服务器中。

3.6. 雪花算法

  Twitter的分布式雪花算法 SnowFlake 每秒自增生成26个万个可排序的ID。

  图中内容说明如下：

• Worker Id： 分布式系统中机器地址的位数。
• Datacenter Id： 分布式系统中集群地址的位数。
• 起始时间戳： 雪花算法下的起始Id生成的时刻，建议选择为中间件启用日期。

注意

当中间件为数据库启用了雪花算法用于生成主键后，请勿随意更改页面中的设置选项，否则会出现意想不到的错误。

3.7. 日志参数

  可设置中间件显示哪些类型的消息日志。

• 日志缓存大小(MB)： 设定日志缓存的大小，超过缓存大小后，日志将会被写入至日志文件中。
• 日志列表显示行数： 设定日志信息最多显示的行数，超出后将循环覆盖最早的日志。
  • 提示信息：客户端数据交互的相关信息。
  • 警告信息：一些重要操作的提示信息，比如服务停止等相关信息。
  • 错误信息：错误提示的相关信息，比如客户端连接验证错误的提示信息。
  • 连接信息：客户端连接请求发起的相关信息。
  • 断开信息：客户端断开连接的相关信息。
  • SQL信息：SQL服务端发起的相关信息。
  • 其他信息：其他的一些日志信息。
  • SQLMonitor：SQL监控的相关信息。当连接设置中SQLMonitorBy的功能设定为Custom时可用。
  • Web请求：客户端发起的Web请求的相关信息。

3.8. 其它

  软件标题等一些参数设置。

• 软件标题：设置软件的标题名称。
• 设置密码：设置软件修改设置所需的密码。
• 定时检查数据库服务：是否启动数据库定时检查服务。
• 关闭程序时，弹出确认对话框：设置是否在关闭程序时，弹出确认关闭的对话框。
• 显示本机内外网IP地址：是否显示本机的内外网的IP地址。

4. 数据库

  数据库列表中显示可用的数据库连接设置。

  按钮说明如下。

• 新增：新增一条数据库连接设置。
• 修改：对选择的数据库连接设置进行修改。
• 测试：测试数据库连接设置是否正确。
• 删除：删除选择的数据库连接设置。

  表格列项说明如下。

• 序号： 连接设置的序号名称。
• 连接名称： MARS的连接设置的名称，此名称作为连接参数使用，用于指定要连接的数据库等信息。
• 数据库类型： 连接设置指定的此连接的数据库的类型，例如MySQL、MSSQL等。
• 数据库名称： 设置连接的数据库的名称。
• 连接池： 是否为此连接设置设立连接池，设置连接池可提高连接的利用率。
• 最大值： 连接池中允许的连接线程的最大数目。
• 删除权限： 该连接设置是否对数据库有删除权限，当删除权限被禁用后，使用此连接设置连接的客户端不能对表执行DELETE语句操作。存储过程除外。
• 插入权限： 该连接设置是否对数据库有插入权限，当插入权限被禁用后，使用此连接设置连接的客户端不能对表执行INSERT语句操作。存储过程除外。
• 更新权限： 该连接设置是否对数据库有更新权限，当插入权限被禁用后，使用此连接设置连接的客户端不能对表执行INSERT语句操作。存储过程除外。
• DDL权限： 该连接设置是否对数据库是否有DDL(数据库定义)权限，比如创建表，删除表，更改表结构等权限，当此权限被禁用后，使用此连接设置连接的客户端不能对执行表结构更新的相关操作。存储过程除外。
• 启用： 连接设置是否启用，只有在启用状态下可以通过此连接涉资连接至数据库。如果设置为禁用，则该连接设置不可用。

  点击新增按钮后，选择要连接的数据库类型，打开新建界面。显示如下：

  连接参数界面中的按钮说明如下。

• 确定：确认输入的连接设置并保存设置。
• 取消：取消输入的连接设置，并退出。

  连接参数界面中的说明如下。

• 数据库类型： 连接设置指定的此连接的数据库的类型，例如MySQL、MSSQL等。
• (账套名)连接名称： MARS的连接设置的名称，此名称作为连接参数使用，用于指定要连接的数据库等信息。
• 账套说明：针对连接设置的详细说明。
• 服务器地址：数据库服务器所在的地址。
• 通讯端口：数据库连接的端口名称。
• 用户名：数据库的登录用户名。
• 密码：数据库的登录密码。
• 数据库名称： 设置连接的数据库的名称。
• 最大连接池值： 连接池中允许的连接线程的最大数目。
• 启用连接池： 是否为此连接设置设立连接池，设置连接池可提高连接的利用率。
• 删除权限： 该连接设置是否对数据库有删除权限，当删除权限被禁用后，使用此连接设置连接的客户端不能对表执行DELETE语句操作。存储过程除外。
• 插入权限： 该连接设置是否对数据库有插入权限，当插入权限被禁用后，使用此连接设置连接的客户端不能对表执行INSERT语句操作。存储过程除外。
• 更新权限： 该连接设置是否对数据库有更新权限，当插入权限被禁用后，使用此连接设置连接的客户端不能对表执行INSERT语句操作。存储过程除外。
• DDL权限： 该连接设置是否对数据库是否有DDL(数据库定义)权限，比如创建表，删除表，更改表结构等权限，当此权限被禁用后，使用此连接设置连接的客户端不能对执行表结构更新的相关操作。存储过程除外。
• 启用当前连接(账套)： 连接设置是否启用，只有在启用状态下可以通过此连接涉资连接至数据库。如果设置为禁用，则该连接设置不可用。