跳到主要内容

自定义弹出消息提示

Chameleon 系统支持两种弹出消息提示方式。

消息提示类型​

类型说明特点
Message普通提示消息默认居中弹出展示
Notification通知消息默认在右上角显示，带关闭倒计时进度

自定义方式​

我们提供了两种方式来自定义弹出消息提示类型以及提示相关的配置。本质都是在操作请求 response 中的弹出消息属性配置，具体的属性释义参考 消息提示定义。

方式一：通过自定义响应组件​

通过自定义响应组件可以直接返回一个自定义的消息提示。根据需要可以将该组件配置在任意有返回值的组件后，来改变默认的返回值操作方式。

配置示例​

在自定义响应组件中配置：

配置项值
执行操作提示消息-普通
消息提示方式通知
提示信息操作成功
提示更多信息xxxx
提示自动关闭时间0（默认）
通知弹出位置右上角（默认）
输出到最终结果是

使用场景​

场景一：直接返回自定义消息

在接口末尾添加自定义响应组件，直接返回自定义的消息提示。

场景二：修改业务操作后的默认返回值

在实际应用开发中，可以根据业务需要和其他组件结合修改默认返回操作：

组件输出到最终结果
其他业务组件勾选
自定义响应组件不勾选
注意

如果修改其他业务操作后的默认值，应该在其他业务组件中勾选【输出到最终结果】，自定义响应组件不勾选【输出到最终结果】。

方式二：通过脚本抛出异常​

通过抛出 ChameleonException 异常的方式，直接响应一个错误提示。通常用在脚本处理复杂业务时，对参数进行校验后立即做出提示。

代码示例​

using System;
using System.Linq;
using System.Collections.Generic;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;
using Chameleon.Common;
using Chameleon.Common.Context;
using Chameleon.Common.Exceptions;
using Chameleon.Common.Models;
using Chameleon.Database;

public class ChameleonCSharpScript
{
    public object Execute(ComponentContext context, IChameleonDbContext dbContext, ILogger logger)
    {
        throw new ChameleonException("这是一个错误消息提示")
        {
            Action = ActionEnum.Error,
            MoreMessage = "操作失败额外信息",
            PopType = PopTypeEnum.Notification
        };
        return null;
    }
}

异常属性配置​

异常支持通过属性配置消息的各项配置：

属性类型说明
ActionActionEnum动作类型
Codenumber状态码
MoreMessagestring更多消息
Durationdouble自动关闭时间
PopTypePopTypeEnum消息提示方式
PlacementNotificationPlacementEnum通知弹出位置
RedirectUrlstring重定向 URL

ActionEnum 枚举值​

值说明
None = -1无操作（不显示任何提示）
Success = 0成功
Error = 1错误
Warning = 2警告
Info = 3信息
Redirect = 4重定向
Open = 5打开新地址

PopTypeEnum 枚举值​

值说明
Default = 0系统默认
Message = 1普通提示消息
Notification = 2通知消息

NotificationPlacementEnum 枚举值​

值说明
Top = 0顶部
TopLeft = 1左上
TopRight = 2右上
Bottom = 3底部
BottomLeft = 4左下
BottomRight = 5右下
注意

由于是通过抛出异常的方式，因此会阻断任何的业务操作立即执行消息提示。

相关文档​