Codex清理代码时怎么保留对外接口

秋宇酱_3199

秋宇酱_3199

2026-11-11

938人浏览

原创

Codex 清理代码需四步:先查配置文件与导出声明明确对外接口;再用--preserve锁定文件路径;接着用CONTRACT.md注入契约描述以约束清理范围;最后通过--dry-run报告验证是否误删导出项。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

codex清理代码时怎么保留对外接口

用 Codex 清理代码时,若直接让它“删掉所有无用函数”或“优化冗余逻辑”,它极可能把对外暴露的接口函数、导出符号、API 路由入口一并删掉——因为这些函数在项目内部调用链上常是“叶子节点”,静态分析判定为“未被调用”。你真正需要的是:让 Codex 精准识别哪些是必须保留的对外契约,再在此前提下清理其余部分。

第一步:明确对外接口的物理标识

打开项目根目录下的 package.json(Node.js)或 pyproject.toml(Python)或 Cargo.toml(Rust),找到 exports / [project.entry-points] / [[lib]] 等字段。Codex 不会自动猜你暴露了什么,它只认配置文件里白纸黑字写明的入口。如果这些字段为空或缺失,Codex 默认认为“没有对外接口”,后续所有清理都按内部模块处理。

检查 src/index.ts 或 main.py 或 lib.rs 文件顶部是否有显式导出声明,例如 export { init, render } from './core'; 或 if __name__ == '__main__': … 或 pub fn new() -> Self { … }。Codex 依赖这类语法锚点定位契约边界,而不是靠函数名含 “api” 或 “handler” 这类模糊关键词。

第二步:用 CLI 指令锁定接口范围

在终端中执行:codex clean --preserve=src/index.ts --preserve=api/ --preserve=types.d.ts。多个路径用空格分隔,支持通配符,如 --preserve="routes/**/*.ts"。

注意:--preserve 参数只保护文件或目录层级,不保护文件内某一行。如果你只希望保留某个函数但删掉同文件其他内容,必须先将该函数抽离到独立文件,再把该文件路径传给 --preserve。

这一步操作起来很简单,直接把文件拖进去就行。但漏掉一个关键路径,比如忘了加 types.d.ts,Codex 可能顺手删掉类型定义,导致下游 TypeScript 项目编译失败。

第三步:注入接口契约描述

在清理命令前,先运行:codex inject --role=contract --file=CONTRACT.md。CONTRACT.md 文件需包含三段内容:① 对外提供哪些能力(如“接收 JSON POST,返回用户 profile 数据”);② 入参格式与必填字段;③ 返回结构与错误码约定。Codex 会将此文档加载为上下文约束,后续清理时自动跳过所有与该契约强关联的函数、参数校验逻辑、序列化代码。

Marvis Codex Bridge
Marvis Codex Bridge

将来自 Marvis 或微信的可信远程软件开发请求中继至用户本地的 Codex CLI,等待编码任务完成,并返回经验证的结果。当用户通过 Codex 要求 Marvis 检查、实现、修复、测试、review 或继续在明确指定的本地项目目录中开展工作时,使用此功能。

下载

如果 CONTRACT.md 里写的是“支持 OAuth2 和 API Key 两种鉴权方式”,但代码中只实现了 API Key 校验,Codex 会保留现有校验,同时生成补全 OAuth2 的 stub 函数——它不会删,而是按契约补全。这是防止误删的最可靠机制。

第四步:验证清理结果是否破坏接口

1. 执行 codex clean --dry-run --report=clean-report.json → 生成清理预览报告。

2. 用命令 grep -E '"action":"remove".*"function"|.*"export"' clean-report.json 查看所有被标记为删除的导出项。

3. 对照 CONTRACT.md 中列出的能力条目,逐条确认对应函数名是否出现在删除列表中。出现即失败,必须回退并调整 --preserve 路径或 CONTRACT.md 描述。

4. 若全部通过,执行真实清理:codex clean --no-dry-run。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
WorkBuddy核心功能与实操模式
WorkBuddy核心功能与实操模式

深入探索WorkBuddy的强大功能。本专题包含智能问答、文档处理、会议纪要生成、日程管理、任务协作等核心模块的操作指南与最佳实践。通过图文并茂的教程,助您快速上手,最大化发挥WorkBuddy的办公效能。

2026.04.09

662

19

Codex AI 编程代理与智能开发工作流
Codex AI 编程代理与智能开发工作流

Codex 是一款超越传统代码生成的 AI 编程代理,致力于构建全生命周期的智能开发工作流。通过持久线程保留上下文,支持多智能体并行协作与后台自动化运维。借助沙箱权限控制、Plan/Steer 任务管理机制,Codex 既能自主拆解并执行复杂工程任务,又能让开发者牢牢掌控项目进程。从需求分析、编码测试到代码审查与部署,Codex 将 AI 深度融入研发全链路,极大提升了软件工程的交付效率与质量标准。

2026.05.26

694

10

Codex API集成与AI编程生态开发
Codex API集成与AI编程生态开发

Codex API 集成是构建下一代 AI 编程生态的核心基石,能通过 API 将强大的代码生成与推理能力无缝接入 VS Code、JetBrains 等主流 IDE 插件,还能将其深度嵌入 CI/CD 流水线,实现自动化的代码审查、单元测试生成与 Bug 修复。结合 Amazon Bedrock 等云平台的托管服务,企业可以灵活打造符合内部安全规范的专属 AI 编程助手。

2026.05.26

264

10

Codex 模型原理与AI软件工程进阶
Codex 模型原理与AI软件工程进阶

Codex 是基于通用大模型底座,通过海量代码语料与真实 Pull Request 进行专项微调的代码专用模型,能深度理解代码语法树与跨文件依赖,实现从自然语言到高质量工程代码的精准转化。在 AI 软件工程进阶中,Codex 推动了从提示词工程向“驾驭工程(Harness Engineering)”的范式跃迁。

2026.05.26

197

10

Codex AI编程工具新手指南
Codex AI编程工具新手指南

全面解析Codex AI编程工具的核心原理、功能特点与实际用途,提供适合新手的Codex入门教程、环境配置方法、代码生成演示与常见问题解答,帮助开发者快速掌握AI自动写代码能力,提升编程学习与开发效率。

2026.05.27

430

10

Codex Agent编程与自主开发能力调优专题
Codex Agent编程与自主开发能力调优专题

PHP中文网为您提供Codex Agent编程与自主开发能力调优专题。针对AI Agent全权委托开发模式,我们为您系统梳理了Harness Engineering(驾驭工程)核心理念,以及涵盖AGENTS.md规范编写、Skills技能配置、Worktree沙盒隔离与多Agent协作架构的实战指南。

2026.06.10

248

7

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

80

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

40

13

Postman接口请求发送教程
Postman接口请求发送教程

详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。

2026.11.06

80

10

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Codex 应用程序简介
Codex 应用程序简介

共0课时 | 184人学习

Codex官方文档
Codex官方文档

共0课时 | 0人学习