# 监听上下文
>[info] 核心版本`1.5.0`后更新
核心版本`1.5.0`之后,我为所有的监听函数增加了一个新的动态参数:`ListenContext (监听上下文)` 。
## 如何使用
>[success] 与监听消息、送信器一样,直接放在方法的参数中即可使用。
## 提供功能
>[success] 监听上下文提供了两个**值域**,一个是单次监听生效的当前域,一个是全局永久生效的全局域。
### **当前域**
**当前域**中,你保存的值仅会在当前一次监听中生效。此域被当前一次监听中被触发的所有监听函数共享。
例如你接收到了一个消息,触发了三个监听函数,则此次监听中的三个监听函数所使用的**监听上下文**对象为同一个,并且可以通过**当前域**在不同的监听函数之间进行值传递。当前域一般会有`Normal`字样。
### **全局域**
与**当前域**不同,**全局域**不会因不同的监听任务而发生改变,永久生效。全局域一般会有`Global`字样。
>[info] 简单来说,域就是一个`Map<String, Object>`,用来保存一些自定义的值。
## API
```java
/**
* 默认的get方法。<br>
* 会优先从当前域获取,获取不到则寻找全局域
* @param key key
* @return 值
*/
public Object get(String key);
/**
* 从当前域中获取
* @param key key
* @return 值
*/
public Object getNormal(String key);
/**
* 从全局域中获取
* @param key key
* @return 值
*/
public Object getGlobal(String key);
/**
* 默认的记录一个值,默认记录在当前域
* @param key 键
* @param value 值
*/
public Object set(String key, Object value);
/**
* 记录一个当前域值
* @param key 键
* @param value 值
*/
public Object setNormal(String key, Object value);
/**
* 记录一个全局域值
* @param key 键
* @param value 值
*/
public Object setGlobal(String key, Object value);
/**
* 清除域。默认为清除当前域
*/
public void clear();
/**
* 清除全局域
*/
public void clearGlobal();
/**
* 清除全局域
*/
public static void clearContext();
/**
* 当前域keySet
*/
public Set<String> normalKeySet();
/**
* 全局域keySet
*/
public Set<String> globalKeySet();
/**
* 全局域keySet
*/
public static Set<String> keySet();
```
- 前言
- 简单介绍
- 我该如何阅读文档
- 视频教程
- 安装与使用
- 开源协议
- 免责&捐助
- 注意事项
- 版本命名规则简介
- 主要功能版本历史
- 功能指引
- 通用API与功能
- 国际化语言
- 异常
- 消息监听
- @Listen
- @OnListen模板
- @Filter
- 消息参数截取
- @Spare
- @Constr
- @Ignore
- @ListenBreak
- @ListenBreakPlugin
- @ListenBody
- 监听响应
- 成功判定与返回值
- 监听上下文
- 动态参数
- 监听消息API
- 异步监听 @Async
- 限流监听 @Limit
- 自定义Http送信器
- 枚举与类型
- 送信器
- SENDER
- SETTER
- GETTER
- 返回值
- 其他位置
- 日志与日志拦截
- 异常处理
- 依赖注入
- 自定义依赖获取
- 批量依赖载入
- 注意事项
- 常量
- 定时任务
- 自定义过滤
- 拦截器
- 拦截器总定义
- 上下文对象总定义
- 监听消息拦截
- 送信器拦截
- 监听函数拦截
- CAT码
- CQ码
- CQCode
- CQ码工具类
- CQ扩展工具类
- AppendList拼接链
- 高级内容
- 阻断机制
- 截断机制
- 自定义枚举类型
- 枚举工厂
- byName注解
- 自定义注解
- 配置
- 文件配置
- 注解配置
- 参数配置
- 多配置
- 多账号
- 自定义账号管理器
- 小心!
- 核心版本与组件如何升级核心
- 核心版本迭代指南
- 核心
- 更新日志
- jar包与依赖
- 监听消息类结构图
- 快速启动
- 模组与扩展
- 模组开发
- 现有模组
- 通用模组-延时任务
- 通用模组-CQ码工具
- 转义器
- CQ码操作工具类
- CQ码模板-CodeTemplate
- CQ码载体-KQCode
- CQ码构建器
- MQ码工具类
- 通用模组-redis-bot管理器
- 通用模组-Debugger
- Debugger-common模块
- Debugger-server模块
- Debugger-client模块
- 通用模组-钉钉机器人
- 组件-Mirai(JVM)
- 快速开始(1.13+)
- springboot-starter
- 注意事项
- 配置
- 额外的内容
- 快速回复
- 额外监听
- CQ码解析
- 组件-酷Q(QQ)-CQ HTTP API(基本失效)
- 快速开始(推荐)
- 快速开始(1.7.x以下,不推荐)
- 快速开始(Springboot启动器)
- 启动器、启动接口与配置类
- 配置
- 文件配置
- 注意事项
- 更新日志
- 额外的内容
- 自定义额外监听
- CQ送信器
- 元事件
- 监听消息类结构图
- 组件-酷Q(QQ)-JCQ(失效)
- 快速开始
- 更新日志
- 额外的内容
- JCQ日志
- 配置
- 注意事项
- 监听消息类结构图
- 组件-酷Q(QQ)-HTTP TO CQ(失效)
- 快速开始(核心1.7.x及以下)
- 启动器、启动接口与配置类
- 配置
- 文件配置
- 注意事项
- 更新日志
- 监听消息类结构图
- 组件-酷Q(QQ)-LEMOC (失效)
- 快速开始(核心1.7.x及以下)
- 配置
- 注意事项
- 更新日志
- 监听消息类结构图
- Springboot快速启动器
- 常见问题汇总
- BUG反馈
- 更新计划总览