radarbase/radar-app-config

RADAR app config 镜像文档

镜像概述

RADAR app config 是一个应用配置引擎，旨在提供按项目和条件的多作用域配置管理。该引擎能够合并不同层级（全局、项目、用户等）的配置，并根据优先级动态解析最终配置，未来可能与 https://github.com/radar-base/radar-appserver 合并。

核心功能与特性

主要功能

• 创建默认应用配置（全局作用域），从 ManagementPortal 获取 OAuth 客户端信息
• 创建按项目的应用配置，从 ManagementPortal 获取项目信息
• 创建按项目的条件配置，使用简单表达式语言定义触发条件
• 支持上传应用的用户统计数据
• 提供自定义客户端-用户配置的获取能力

配置合并机制

配置基于作用域解析，作用域按优先级从低到高排序，高优先级配置覆盖低优先级配置。若在某作用域中将变量显式设为 null，则会清除父作用域中的该变量。当前支持的作用域顺序（优先级从低到高）：

1. global（全局默认，仅系统管理员可更新）
2. project.{projectId}（项目级，仅项目管理员可更新）
3. group.{groupId}（未实现）
4. condition.{conditionId}（未实现）
5. user.{userId}（用户级，仅项目管理员可更新）

使用场景

适用于需要根据不同项目、用户或条件动态调整应用配置的场景，例如：

• 多项目环境下的配置隔离与定制
• 用户特定配置需求（如特定用户的插件、采集频率调整）
• 基于条件的动态配置切换（如用户属性匹配时应用特殊配置）

配置示例

默认配置（全局作用域）

yaml
clientA:
  sendRate: 50

clientB:
  sendRate: 100

项目配置（project.{projectId} 作用域）

项目 A 的配置：

yaml
clientB:
  plugins: A B
  collectRate: 15

条件配置

yaml
id: 1
name: SpecificUserAbcd
expression: user.id == 'abcd1234...'
config:
  clientB:
    plugins: B

最终配置合并结果

用户 abcd1234... 使用 clientB 时，最终解析的配置为：

yaml
plugins: B
sendRate: 100
collectRate: 15

支持的 API

作用域解析规则

变量基于作用域解析，优先级从低到高为：global < project.{projectId} < group.{groupId}（未实现）< condition.{conditionId}（未实现）< user.{userId}。父作用域变量可被高优先级作用域覆盖，或通过显式设为 null 清除。

API 端点列表

列出支持的客户端

GET /clients
---
HTTP 200 OK
{
  "clients": [
    {"clientId": "clientA"}
  ]
}

列出当前用户管理的项目

GET /projects
---
HTTP 200 OK
{
  "projects": [
    {"id": 1, "projectName": "projectA", "humanReadableProjectName": "Project A", "location": "乌得勒支, 荷兰", "organization": "The Hyve", "description": "我的项目计划。"}
  ]
}

获取客户端的默认配置（全局作用域）

仅系统管理员可访问：

GET /global/config/{clientId}
---
HTTP 200 OK
{
  "clientId": "{clientId}",
  "scope": "global",
  "config": [
    {"name": "plugins", "value": "A", "scope": "global"}
  ]
}

更新客户端的默认配置（全局作用域）

仅系统管理员可访问：

POST /global/config/{clientId}
{
  "config": [
    {"name": "plugins", "value": "A"}
  ]
}
---
HTTP 200 OK
{
  "clientId": "{clientId}",
  "scope": "global",
  "config": [
    {"name": "plugins", "value": "A"}
  ]
}

获取项目级客户端配置

GET /projects/{projectId}/config/{clientId}
---
HTTP 200 OK
{
  "clientId": "{clientId}",
  "scope": "project.projectA",
  "config": [
    {"name": "plugins", "value": "A B"}
  ],
  "defaults": [
    {"name": "plugins", "value": "A", "scope": "global"}
  ]
}

更新项目级客户端配置

POST /projects/{projectId}/config/{clientId}
{
  "config": [
    {"name": "rate", "value": "1"},
    {"name": "plugins", "value": "A B"}
  ]
}
---
HTTP 200 OK
{
  "clientId": "{clientId}",
  "scope": "project.projectA",
  "config": [
    {"name": "plugins", "value": "A B"},
    {"name": "rate", "value": "1"}
  ],
  "defaults": [
    {"name": "plugins", "value": "A", "scope": "global"}
  ]
}

获取用户级客户端配置（客户端调用接口）

GET /projects/{projectId}/users/{userId}/config/{clientId}
---
HTTP 200 OK
{
  "clientId": "{clientId}",
  "scope": "user.userA",
  "config": [
    {"name": "plugins", "value": "A B"}
  ],
  "defaults": [
    {"name": "plugins", "value": "A B", "scope": "project.projectA"},
    {"name": "rate", "value": "1", "scope": "project.projectA"}
  ]
}

更新用户级客户端配置

POST /projects/{projectId}/users/{userId}/config/{clientId}
{
  "config": [
    {"name": "rate", "value": "1"}
  ]
}
---
HTTP 200 OK
{
  "clientId": "{clientId}",
  "scope": "user.userA",
  "config": [
    {"name": "rate", "value": "1"}
  ],
  "defaults": [
    {"name": "plugins", "value": "A B", "scope": "project.projectA"},
    {"name": "rate", "value": "1", "scope": "project.projectA"}
  ]
}

Docker 部署与使用

启动与停止容器

使用 docker-compose 启动服务栈：

bash
docker-compose up -d

停止服务栈：

bash
docker-compose down

测试 API

1. 访问 API 根地址：http://localhost:8080/appconfig/api/
2. 使用 Postman 测试，配置 OAuth2 授权：
   • 回调 URL：http://localhost:8080/appconfig/login
   • 授权 URL：http://localhost:8080/managementportal/oauth/authorize
   • 访问令牌 URL：http://localhost:8080/managementportal/oauth/token
   • 客户端 ID：appconfig_frontend
   • 客户端密钥、作用域、状态留空
3. 使用用户 admin、密码 admin 登录并授权，获取访问令牌后即可调用 API。

项目与用户管理

如需创建项目或用户，访问 ManagementPortal：http://localhost:8080/managementportal/，使用 admin/admin 登录后进行管理。