如何在WSO2 Custom handler中访问publisher定义的API Properties等API信息

嘿，我来给你讲讲怎么在WSO2自定义Handler里获取各类API相关信息，包括在Publisher里定义的API Properties。其实操作起来并不复杂，我把关键步骤和代码示例整理好了：

1. 获取基础API元数据（名称、版本、上下文等） #

WSO2的MessageContext对象里已经封装了很多常用的API元数据，直接通过getProperty()就能拿到，比如：

// 获取当前请求的MessageContext实例
MessageContext messageContext = getMessageContext();

// 获取API名称
String apiName = (String) messageContext.getProperty("API_NAME");
// 获取API版本
String apiVersion = (String) messageContext.getProperty("API_VERSION");
// 获取API上下文路径
String apiContext = (String) messageContext.getProperty("API_CONTEXT");
// 获取调用API的应用名称
String appName = (String) messageContext.getProperty("APPLICATION_NAME");
// 获取发起请求的用户
String username = (String) messageContext.getProperty("REMOTE_USER");

这些属性都是WSO2网关自动注入的，不用额外配置，直接拿就行。

2. 读取Publisher中定义的自定义API Properties #

如果你在Publisher里给API加了自定义Properties（比如在API编辑页面的"Properties"标签里设置的键值对），需要从API的Synapse定义里获取，步骤如下：

// 从MessageContext拿到Synapse配置对象
SynapseConfiguration synapseConfig = messageContext.getConfiguration();

// 拼接API的唯一标识（名称+版本）
String apiName = (String) messageContext.getProperty("API_NAME");
String apiVersion = (String) messageContext.getProperty("API_VERSION");
String apiArtifactKey = apiName + ":" + apiVersion;

// 获取对应的API定义
API apiDefinition = (API) synapseConfig.getArtifact(apiArtifactKey);

// 拿到自定义Properties集合
Properties apiCustomProps = apiDefinition.getProperties();

// 读取指定的自定义属性
if (apiCustomProps != null) {
    String myCustomProp = (String) apiCustomProps.get("my_custom_property_key");
    // 这里写你的业务逻辑
}

小提示 #

• 确保你的Handler执行顺序在API元数据加载之后（一般默认的顺序就没问题，但如果是自定义序列里的Handler，要注意位置）
• 如果是在租户环境下，可能需要额外处理租户域的信息，可以通过messageContext.getProperty("TENANT_DOMAIN")获取租户域，辅助定位API

这些方法应该能覆盖你大部分的需求，如果还有特定场景的问题，随时再细化讨论哈～

内容的提问来源于stack exchange，提问作者ulab