简介
魔笔平台提供Redis连接模块,可提供快速访问外部Redis数据库的能力,本文介绍如何使用Redis连接模块。
适用场景
在搭建应用时,如需连接第三方Redis数据库并执行基本的数据库操作,可直接引用魔笔平台物料市场提供的Redis数据库模块。
模块介绍
Redis连接模块包含三个模型:数据模型、页面模型和自定义逻辑流操作。
数据模型:用于储存Redis数据库连接配置信息,和连接池信息。
页面模型:用于访问页面并进行Redis连接的初始化配置。
自定义逻辑流操作:用于执行基本的数据库操作。
数据模型
Redis连接配置:储存Redis数据库连接配置信息,和连接池信息,具体介绍如下:
参数 | 参数说明 |
主机 | Redis连接主机。即目标服务实例的域名或IP。
|
端口 | Redis连接端口,默认为6379。 |
密码 | Redis连接密码。 |
数据库 | Redis数据库,默认0。 |
最大连接数 | Redis连接池最大连接数,默认值是8 。 |
预备连接数 | Redis连接池预备连接数,默认值是8 。 |
最小连接数 | Redis连接池最小连接数,默认值是0。 |
等待时间 | Redis连接池等待时间,默认值是10000, 单位:毫秒。 |
页面模型
页面模型包含两个页面:Redis连接配置-列表页和Redis连接配置-配置页。
Redis连接配置-列表页:用于展示、删除Redis连接配置信息的列表页。
Redis连接配置-配置页:用于新增、编辑Redis连接配置的编辑页。
通常情况下只有该应用的管理员可以访问此页面,并进行连接的初始化设置。开发者可根据需要为该页面添加权限控制,详细操作请参见:权限管理。
自定义逻辑流操作
Redis连接模块支持以下自定义逻辑流操作,具体介绍如下:
字符串操作 | 说明 |
SET | 设置指定键的值。 |
GET | 获取指定键的值。 |
MGET | 获取所有(一个或多个)给定键的值。 |
MSET | 依次设置一个或多个键、值。 说明 输入为List,依次按照键、值存入。 |
SETNX | 只有在键不存在时,设置键的值。 |
SETEX | 将值关联到键 ,并将键的过期时间设为seconds (以秒为单位)。 |
GETSET | 将给定键的值设为值 ,并返回键的旧值(old value)。 |
GETRANGE | 返回键中字符串值的子字符 :通过开始位和结束位进行获取。 |
MSETNX | 同时设置一个或多个键-值对,当且仅当所有给定键都不存在。 |
APPEND | 如果键已经存在并且是一个字符串, APPEND命令将指定的值追加到该键原来值(value)的末尾。 |
DEL | 删除该键和值。 |
DECR | 将键中储存的数字值减一。 |
DECRBY | 键所储存的值减去给定的减量值。 |
INCR | 将键中储存的数字值加一。 |
INCRBY | 键所储存的值加给定的加量值。 |
Hash操作 | 说明 |
HSET | 将哈希表键中的字段的值设为值 。 |
HGET | 获取存储在哈希表中指定字段的值 |
HMSET | 同时将多个字段-值 (域-值)对设置到哈希表键中。 |
HMGET | 获取所有给定字段的值。 |
HSETNX | 只有在字段不存在时,设置哈希表字段的值。 |
HDEL | 删除一个或多个哈希表字段。 |
HEXISTS | 查看哈希表键中,指定的字段是否存在。 |
关于操作命令说明,请参见Redis官方文档。
操作步骤
本文操作步骤以与外部阿里云Redis数据库建立连接为例。
前提条件
与外部Redis数据库建立连接,如阿里云Redis数据库,需要获取如下信息,以便对连接进行初始化配置:主机地址、端口、密码,更多配置参数及解释请参见:数据模型。
步骤一、引入Redis连接模块
物料市场收藏Redis连接模块,具体操作请参见收藏应用模板和模块。
登录魔笔。
在顶部菜单栏选择应用管理,在右上角搜索框中输入目标应用,例如TEST。
在指定的应用卡片中单击进入设计器,进入应用开发页面。
在左侧功能区单击
> 添加引用模块 > 物料市场,在Redis连接模块的操作列,单击引用。
步骤二、对连接进行初始化配置
对连接进行初始化配置的方式推荐两种:一种是使用Redis连接模块的页面模型,完成初始化配置。一种是应用发布后,进入管理后台,对连接进行初始化配置。
以阿里云Redis为例,需先从阿里云Redis的控制台获取主机、端口号、密码。
对连接进行初始化配置。
使用Redis连接模块的页面模型,完成初始化配置。
为Redis连接配置-列表页配置路由,并根据需要为该页面添加权限控制,具体请参见权限管理。
说明通常情况下只有该应用的管理员可以访问此页面进行连接的初始化设置。
在左侧功能区单击
> 页面路由 > 添加页面路由。在编辑页面路由页面,页面选择Redis连接模块的Redis连接配置-列表页,在URL路径填入config/Redis。
完成后,页面右上角单击发布。启动应用,可以直接通过URL访问该页面,以便对Redis连接进行初始化配置。URL形如: https://cluster-3.mobiapp.cloud/应用id/link/config/redis。
在Redis连接配置-列表页单击添加Redis连接配置进入编辑页。
在Redis连接配置-编辑页进行初始化配置。
应用发布后,进入管理后台,对连接进行初始化配置。
应用发布后,可通过用户名、密码、验证码,登录数据管理后台。
在应用管理后台页面,单击添加数据,对Redis连接进行初始化配置。
步骤三、使用自定义逻辑流操作
新建逻辑流,并调用Redis连接模块中的自定义逻辑流操作来完成相应业务,以SET操作为例:
在左侧功能区单击
> 后端逻辑流 > 添加逻辑流,填入逻辑流名称为Redis操作演示。
在左侧组件区,展开Redis连接模块,拖入SET逻辑流操作,右侧属性区配置相关参数,详情请参见:字符串操作说明。
拖入查询对象与显示消息组件,填写操作入参,如下图所示:
逻辑流编排完成后,即可调用此逻辑流。