方向反转:此前 SKILL.md 是「模板渲染产物」、sap-cli 是源;现 sap-cli 归档, sap-cli-skill 承接开发与分发,SKILL.md 回归手工维护的正本。 迁移(来自 sap-cli,共 104 文件): - tests/ 692 例测试(15 个文件的内联 sys.path 改指 assets/) - openspec/ SDD 规格与归档变更(42 文件) - docs/ 开发文档与 ADT 原理(含 dev/CLAUDE.md、AGENTS.md) - .claude/ rules 副本 + settings.json(供 Claude Code) - .github/ .hermes/ .pre-commit-config.yaml .editorconfig CLAUDE.md - scripts/ 保持仅 setup.py(pack_skill.py 已随旧仓归档,不迁) 修复(迁移暴露的真实缺陷): - assets/pyproject.toml 的 build-backend 写作 `setuptools.backends._legacy:_Backend`, 该模块在 setuptools 中不存在 → `pip install -e` 从来装不上。改为 build_meta。 实测:临时 venv 安装成功,sap-cli --help 正常列出 31 个命令 - pyproject readme 指向不存在的 assets/README.md(editable 安装会失败)→ 改内联文本 - pyproject urls 改指 sap-cli-skill 机制调整: - .github/workflows/ci.yml 适配 assets/ 布局;顶部注明该工作流仅 GitHub 执行, 本仓在 Gitee 不会自动跑 - pre-commit 增本地测试门禁(Gitee 上真正生效的那道) - .gitignore 合并旧仓完整规则(保留 log/ 下 md 知识库入库,只忽略运行日志) - 大文件上限 100KB→1MB(架构图 512KB) 守卫测试 tests/unit/test_repo_guards.py(10 → 18 例): - SKILL.md 须记录 parser 全部 CLI 命令 / 铁律 1-5 须为真实小节标题 / 示例不得违反铁律 5 - references/ 规则齐备;.claude/rules 与 references 必须一致(实测抓到一次真实漂移) - VERSION == sapcli.__version__ == README 版本 - 仓内不得再出现 pack_skill.py / skill-src(防废弃流程回潮) 698 tests OK;editable 安装与 CLI 入口经临时 venv 实测通过。 docs/RELEASING.md 重写为单源开发流程。
6.1 KiB
6.1 KiB
title, created, tags, parent, prev, next
| title | created | tags | parent | prev | next | ||||
|---|---|---|---|---|---|---|---|---|---|
| 查询代码 - 原理 | 2026-05-18 |
|
sap-cli/README | sap-cli/01.ADT架构与通信原理 | sap-cli/03.修改代码-原理 |
查询代码 — 原理
[!abstract] 概述 ADT 提供三种主要的代码查询能力:仓库对象搜索(按名称/类型)、源代码全文搜索(按代码片段)和 Where-Used 导航(引用追踪)。这些功能全部通过
/sap/bc/adt/repository端点的 REST API 实现。
1. 仓库对象搜索 (Repository Object Search)
原理
通过 REST API 向 /sap/bc/adt/repository/informationsystem/search 发送 GET 请求,在后端 ABAP Repository 中搜索对象。
REST API 调用
GET /sap/bc/adt/repository/informationsystem/search
?operation=quickSearch
&query=<搜索关键词>
&maxResults=50
&objectType=<对象类型> (可选)
参数说明
| 参数 | 说明 | 示例 |
|---|---|---|
operation |
搜索操作类型 | quickSearch |
query |
搜索关键词 | ZCL_SALES* |
maxResults |
最大返回数量 | 50 |
objectType |
对象类型过滤 | CLAS, PROG, FUGR, TABL, DTEL, DOMA |
响应格式
<atom:feed xmlns:atom="http://www.w3.org/2005/Atom"
xmlns:is="http://www.sap.com/adt/repository/informationsystem">
<is:object name="ZCL_SALES_ORDER"
type="CLAS"
uri="/sap/bc/adt/oo/classes/zcl_sales_order"
packageName="Z_SALES"/>
</atom:feed>
后端处理流程
1. Eclipse 发送 GET 请求到 repository search 端点
2. ICF Handler 将请求路由到 ABAP Repository Search 类
3. 搜索引擎扫描 ABAP Repository(类似 SE80 搜索)
4. 返回匹配对象的元数据:名称、类型、URI、包名
5. Eclipse 在 Project Explorer 中展示搜索结果
6. 双击结果 → 通过 URI 加载对象的源代码编辑器
对应的 SAP GUI 事务码
| ADT 搜索 | SAP GUI 等效 |
|---|---|
| 快速搜索 | SE80 — Repository Browser |
| 按类型搜索 | SE24(类) / SE38(程序) / SE37(函数) |
| 按包搜索 | SE80 — Package 节点 |
2. 源代码全文搜索 (ABAP Source Code Search)
原理
[!info] 前置条件 源代码搜索需要激活业务功能
SRIS_SOURCE_SEARCH。
ADT 提供了一个 搜索控制台,允许在整个 ABAP 源码仓库中进行全文搜索,类似 IDE 中的 "Search in Files" 功能。
工作流程
1. 用户在 Eclipse 搜索控制台输入代码片段
↓
2. 客户端发送搜索请求到 ADT REST 端点
↓
3. 后端搜索引擎执行全文本索引查找
↓
4. 返回匹配的源码位置(对象名 + 行号)
↓
5. Eclipse 展示搜索结果,点击可直接跳转到编辑器
搜索能力
- 任意代码片段搜索 — 搜索变量名、方法调用、SQL 语句等
- 正则表达式支持 — 模式匹配搜索
- 范围限定 — 可限定搜索范围(包、对象类型等)
- 直接导航 — 搜索结果可直接跳转到对应的开发对象
对应 SAP GUI 的优势
在传统 SAP GUI 中,不存在等效的全文本源码搜索功能。这是 ADT 相对于 SE80 的重大改进之一。
3. 对象浏览与导航
Repository Browser
GET /sap/bc/adt/repository/informationsystem
浏览 ABAP Repository 的层级结构:
- 按包浏览 — 展开包 → 查看其中所有对象
- 按类型浏览 — 按类、程序、表等类型分类
- 按传输层浏览 — 按传输层组织查看
对象详情获取
GET /sap/bc/adt/oo/classes/{class_name}
GET /sap/bc/adt/programs/programs/{program_name}
GET /sap/bc/adt/functions/groups/{group_name}
每个对象类型的详细信息通过对应的端点获取。
4. Where-Used 导航
原理
Where-Used 分析追踪对象在整个仓库中的引用关系。例如:查找哪些程序使用了某个类或方法。
处理流程
1. 用户在编辑器中选中一个标识符(类名/方法名/变量)
↓
2. Eclipse 发送 Where-Used 请求到 Repository 端点
↓
3. 后端 ABAP Runtime 执行交叉引用分析
↓
4. 返回所有引用位置(对象 + 行号 + 列号)
↓
5. Eclipse 展示引用列表,支持直接导航
对应的 SAP GUI 事务码
| ADT Where-Used | SAP GUI 等效 |
|---|---|
| 引用查找 | SE80 → Where-Used List |
| 类型层次 | SE24 → Superclass/Subclass |
5. 数据预览 (Data Preview)
原理
ADT 提供了表数据读取能力,可以替代传统的 SE16N 事务码。
REST API 调用
POST /sap/bc/adt/datapreview/{table_name}
Content-Type: application/xml
<?xml version="1.0" encoding="utf-8"?>
<dataPreview:tableSettings
xmlns:dataPreview="http://www.sap.com/adt/dataPreview">
<dataPreview:column>*</dataPreview:column>
<dataPreview:maxRows>100</dataPreview:maxRows>
</dataPreview:tableSettings>
优势对比
| 特性 | SE16N (SAP GUI) | ADT Data Preview |
|---|---|---|
| 访问方式 | 事务码,需要 SAP GUI | REST API,任何 HTTP 客户端 |
| 数据格式 | ALV Grid(屏幕渲染) | 结构化 XML/JSON |
| 并行查询 | 不支持 | 支持多线程并发 |
| 自动化 | 困难 | 可编程访问 |
| 平台限制 | Windows + SAP GUI | 任何平台 |