开放平台总览
本章节面向谁
本章节面向基于 MDP 源码做二次开发的工程师——您部署了自己的 MDP 平台,需要扩展它的开放平台能力:新增开放接口、发布接口文档、配置接口授权、审核开发者应用、为第三方编写 SDK。
与「应用接入」章节的区别
| 本章节(开放平台) | 应用接入 | |
|---|---|---|
| 面向群体 | 平台方/二开工程师(改 MDP 源码的人) | 第三方开发者/ISV(用 MDP 能力的人) |
| 视角 | 开放平台怎么实现、怎么扩展 | 开放平台怎么用、怎么对接 |
| 典型问题 | 如何新增一个 @Open 接口并上架文档?如何审核应用、配置接口权限? | 如何拿 appKey 调 user.page?如何接收事件推送? |
两章节互为镜像:这里改的每一行代码,就是那里第三方遵循的契约。
开放平台由什么组成
MDP 开放平台不是单个服务,在微服务架构和单体架构中架构方式有所区别:
单体架构

微服务架构

| 组成 | 模块 | 职责 |
|---|---|---|
| 注册中心 | mdp-apps/md-gateway/zookeeper-server nacos | 单体架构:本地开发时可以使用zookeeper, 生产环境必须使用nacos 微服务架构:统一使用nacos |
| 开放网关 | mdp-apps/md-gateway/sop-gateway-server | 第三方请求统一入口(/api):负责参数解析、参数校验、RSA2 验签、Dubbo 泛化路由、结果包装、记录调用日志。 |
| 对外接口实现 | mdp-apps/md-api/api-service | 将需要对外提供的接口使用@Open 标记,标记的接口启动时会自动注册进网关的接口表。单体架构:启动 worker-server 微服务架构:启动 api-server |
| 管理后台 | 后端:mdp-apps/md-open前端: mdp-vben/apps/web-console | 应用审核、密钥管理、权限分组授权、文档同步发布、事件订阅与推送、OAuth2 数据。 |
| 开发者中心 | 后端:mdp-apps/md-open前端: mdp-vben/apps/web-open | 应用申请、文档查看、接口查看/调试。 |
| Java SDK | mdp-sdk | 交付第三方的独立 jar |
| 文档组件 | Torna | 接口文档的载体:smart-doc 从代码生成文档推送到 Torna,开放平台再从 Torna 同步拉回对外展示 |
读完您能做什么
- 写接口:按
@Open+@DubboService规范新增开放接口,启动即自动注册上架——接口开发与发布 - 发文档:打通「smart-doc → Torna → 开放平台」的文档链路,发布并支持在线调试——接口开发与发布
- 配权限:用「权限分组」把接口授权给指定应用,理解网关的授权判定与缓存——应用审核与授权
- 审应用:走完「开发者申请 → 运营审核 → 密钥签发」全流程,并知道每一步改了哪些表——应用审核与授权
- 懂链路:一次第三方请求在网关里经过的每个环节,以及在哪个扩展点插入自己的逻辑——调用链路与扩展点
- 管调用:管理 accessToken、按错误码给第三方排障、扩展调用日志——接口调用
- 管事件:新增一种事件类型、订阅匹配与推送任务的全链路排障——事件回调
- 写 SDK:按三件套规范为新业务域封装 SDK,复用签名/加解密工具——SDK开发
篇目导航
| 篇目 | 内容 | 关键收获 |
|---|---|---|
| 架构设计 | 业务/技术/总体架构、部署形态 | 各服务如何协作,单体与微服务落点差异 |
| 表结构设计 | 25 张 mdo_ 表五域分组、ER 图、重点字段 | 授权链/审核流/推送管道落在哪些表 |
| 接口开发与发布 | @Open 开发、自动注册、文档链路、接口权限配置 | 从写代码到文档上架的完整路径 |
| 调用链路与扩展点 | 网关请求全链路、验签/token、扩展点清单 | 在哪个环节插入二开逻辑 |
| 接口调用 | 平台侧管理面:协议配置、accessToken 管理、错误码体系、调用日志、排障手册 | 第三方报障时按错误码定位到具体环节 |
| 事件回调 | 平台侧事件体系:新增事件、订阅匹配、任务生成、重试与排障 | 新增一种事件类型的四步操作 |
| 应用审核与授权 | 应用生命周期、密钥管理、scope 授权、事件订阅与推送 | 运营侧全部配置动作及其代码落点 |
| SDK开发 | 三件套规范、签名/加解密工具、回调接收端 | 为第三方产出新 SDK 的完整步骤 |
前置阅读
- 平台整体架构与单体/微服务双形态:架构介绍、服务介绍
- 框架层机制(
md-sop-support注册器、AES 组件):md-sop-support - SDK 内核与业务封装源码:mdp-sdk-core、mdp-simple-sdk
- 第三方视角的接入文档:应用接入(写二开代码前建议先读,理解契约的使用方式)