AI 友好的软件代码结构:优化软件架构和代码结构以适应生成式 AI

1. 引言:AI 原生软件开发的黎明

随着生成式人工智能 (AI) 工具的快速集成,软件工程领域正在经历一场重大的变革。这些 AI 驱动的助手,包括 GitHub Copilot、ChatGPT 等平台,正越来越多地被开发人员采用,以增强软件开发生命周期的各个阶段。¹ 它们的能力涵盖了从提供实时代码补全、生成样板代码到协助复杂的重构任务和识别潜在错误。AI 工具的激增标志着软件构思、编写和维护方式的根本性转变。AI 能够在一系列编码任务中实现自动化并提供智能辅助,这使得我们有必要重新评估既有的软件开发实践,以充分利用这一变革性潜力。

推动这一演变的一个关键因素是 AI 基于自然语言描述和现有代码上下文理解和生成代码的能力。⁵ 这种对自然语言处理的依赖表明,清晰编写并采用明确命名约定的代码,可能会更容易被 AI 代理理解和有效操作。随着这些工具变得更加复杂并深度集成到开发工作流程中,它们对开发人员生产力、代码质量和软件交付速度的影响预计将大幅增长。

然而,将生成式 AI 应用于现有的复杂代码库并非没有挑战 [用户查询]。虽然 AI 在生成新代码或处理较小、定义明确的任务方面表现出非凡的能力,但修改或重构大型、复杂或结构不良的遗留系统却存在相当大的困难。研究表明,随着代码复杂性和规模的增加,AI 模型的性能可能会下降。³ 特别是,在庞大的代码库中识别和解决错误仍然是当前 AI 工具面临的一个重大障碍。¹⁷ 这表明生成式 AI 的有效性并非在所有类型的代码中都一样,而最初并非为 AI 交互而设计的现有系统,可能需要进行大量的预先修改才能充分受益于这些工具。此外,包容性方面的考虑至关重要,正如视障开发人员在使用 AI 编码助手时面临的可访问性挑战所强调的那样。¹

为了有效利用生成式 AI 在软件开发中 burgeoning 的能力,必须有意识地转向更符合这些 AI 工具运作方式的软件架构和编码实践 [用户查询]。这需要探索和采用模块化设计原则、编写简洁的代码、遵循既定的编程范式,并战略性地采用适当的架构模式。通过针对 AI 优化代码库,开发团队可以释放这些智能助手的全部潜力,从而实现更高效、可维护和健壮的软件系统。

2. 基本原则:面向 AI 的模块化和简洁代码

模块化代码的特点是将其组织成更小的、自包含的单元(称为模块),每个模块都有明确定义的接口,这在 AI 辅助的代码操作方面具有显著优势。¹⁸ 这种结构化方法简化了软件的复杂性,使人类开发人员和 AI 代理更容易理解和修改。在 AI 背景下,模块化的主要好处之一是更易于维护。由于模块被设计成独立的,因此可以在受限范围内执行更新、错误修复甚至完全替换特定功能,而无需在整个系统中进行更改。¹⁹ 这种隔离对 AI 特别有利,因为它允许这些工具针对代码库的特定区域进行修改或重构,从而降低在其他可能不相关的软件部分引入意外副作用的风险。¹⁹

此外,模块化促进了代码的可重用性。当代码被组织成自包含的模块时,这些单元可以轻松地在不同项目之间重用,或在同一项目内用于实现新功能。¹⁸ 这不仅减少了需要编写和维护的代码总量,而且还提高了代码的一致性和效率。AI 可以在识别和利用这些可重用组件方面发挥关键作用,甚至可能建议在新的上下文中使用现有模块,或识别从现有代码模式创建新的可重用模块的机会,从而进一步简化开发过程。独立测试单个模块的能力是另一个关键优势。¹⁹ 这种简化的测试过程允许对每个组件的功能进行更集中和彻底的验证,并且 AI 可以协助专门为这些模块化单元生成单元测试。在团队环境中,无论是人类开发人员还是人机结合的团队,模块化设计都有助于加强协作。¹⁹ 不同的个人或 AI 进程可以同时处理不同的模块,并且由于模块之间的接口定义明确,冲突的可能性降低。模块化代码的固有结构也使得重构更加容易。¹⁸ 更小、定义明确的模块本质上更容易理解和修改,这使得 AI 更容易分析、建议和执行重构操作以提高代码质量或适应新需求。最终,通过将大型复杂的软件程序分解成更小、更易于管理的部分,模块化编程降低了代码库的整体复杂性。¹⁹ 这种简化增强了人类开发人员和 AI 工具的可理解性和可导航性,为更有效的 AI 辅助开发和维护铺平了道路。

为了有效地编写既模块化又简洁且对 AI 友好的代码,应遵循以下几个最佳实践。分离关注点至关重要,确保系统中的每个模块都有单一、明确定义的职责。²¹ 例如,业务逻辑应与数据访问机制或用户界面组件保持分离。这种按关注点组织的方式提供了更清晰的边界,使 AI 能够更好地理解系统不同部分的用途和功能,并应用更有针对性的推理和转换。追求每个模块内部的高内聚性也很关键,这意味着模块内的函数和元素应紧密相关并协同工作以实现共同的目标。²¹ 相反,模块之间的低耦合应该是目标,最大限度地减少它们之间的依赖关系,以便它们可以独立运作。²¹ 当模块之间需要交互时,应通过明确定义的接口或应用程序编程接口 (API) 进行。¹⁹ 采用信息隐藏(也称为封装)是另一个基本实践,即隐藏模块的内部实现细节,仅通过清晰的接口公开必要的信息。²⁰ 这一原则保护了模块的完整性,并防止代码的其他部分依赖其内部工作方式,从而可以简化 AI 的修改。对模块、函数和变量使用清晰一致的命名约定,可以显著提高人类开发人员和 AI 代理的可读性。²¹ 描述性的名称有助于理解每个代码元素的用途和功能。遵循“不要重复自己”(DRY)原则,避免代码重复并将可重用逻辑提取到单独的模块或函数中,这对于可维护性至关重要,也使代码库更易于 AI 分析。¹⁸ 在更改代码时,建议采用增量方法并进行频繁测试,通常称为小步重构。²⁵ 这种受控方法使 AI 能够更轻松地跟踪更改并识别引入的任何潜在问题。利用自动化工具执行测试、代码风格检查(linting)和格式化等任务,可确保一致性并降低出错的可能性,从而进一步帮助 AI 分析和操作代码。²⁵ 最后,明确定义应用程序中每个模块的边界,将相关的任务和功能分组在一起,建立一个组织良好的结构,使 AI 更容易理解和使用。²¹

3. 驾驭代码长度:优化 AI 理解

类和函数的长度会显著影响生成式 AI 工具在代码操作方面的有效性。¹⁸ 正如冗长而复杂的代码块对人类开发人员来说难以理解和维护一样,这些特性也可能给 AI 代理带来困难。研究表明,较短的代码例程与较低的缺陷发生率之间存在相关性。³¹ 极长的函数,有时跨越数百甚至数千行,通常被称为“失控方法”,由于其固有的复杂性和增加的错误可能性,可能会变得特别成问题。³¹

造成这种情况的一个潜在原因是,过长的函数和类可能会超出某些生成式 AI 模型的上下文窗口限制。⁸ 为许多此类 AI 工具提供支持的大型语言模型,在任何给定时间能够处理和考虑的代码量都是有限的。如果一个代码单元超过此限制,AI 可能会截断或无法完全处理整个块,这可能导致不完整或不准确的修改或重构建议。虽然各种风格指南和最佳实践都对理想的代码长度提出了建议,例如函数最好在 20 行以下,类在 200 行以下,但最终目标应该是优先考虑可读性和可维护性。³¹ 一个函数理想情况下应专注于执行单一、明确定义的任务。³³ 相反,过于简短的函数,尤其是那些只有几行的函数,可能表明分解过度,可能使整体代码流程更难遵循,因为开发人员(和 AI)需要在众多小型单元之间导航。³² 此外,一些人认为,通过圈复杂度(评估代码中独立路径数量)等指标衡量的代码复杂性,可能比简单地计算代码行数更能准确地指示函数是否变得过于庞大和笨重。³² 值得注意的是,AI 编码助手本身可能对其能够有效处理以生成建议的代码长度存在内部限制。³⁸ 例如,GitLab 代码建议对它分析的输入代码和它提供的输出建议都施加了标记限制。此外,研究表明,AI 生成功能正确代码的能力可能与生成代码的大小成反比,这表明编码问题的复杂性增加可能对这些模型构成重大挑战。³

考虑到这些因素,在 AI 辅助软件开发的背景下,一些关于类和函数长度的指导方针变得有益。主要目标应该是编写简洁且专注于单一、明确职责的函数。虽然具体的行数可能因任务的复杂性和编程语言而异,但一般建议是力求函数足够短,以便一目了然地轻松理解,理想情况下适合单个屏幕而无需过度滚动。³¹ 一个软限制,例如 30 到 50 行代码,可以作为开发人员审查函数并考虑是否可以将其进一步分解为更小、更易于管理的单元的触发器。³² 同样,类也应遵循单一职责原则并保持相对较小。一个类应该封装一组内聚的数据以及操作该数据的行为。虽然可能存在需要更大类的合理情况,特别是如果它们服务于明确定义的目的并且结构逻辑清晰 ³⁷,但一般指导方针是目标类在几百行代码以下。类中方法的数量也是一个相关考虑因素,一些建议建议将其限制在少于 10 到 20 个方法,以保持专注和可管理性。³¹ 然而,至关重要的是要强调,清晰性和逻辑连贯性应优先于严格遵守任意的行数限制。³² 如果一个稍长的函数或类保持清晰单一的目的并且结构良好,那么它可能是完全可以接受的。在使用 AI 工具时,注意它们潜在的上下文窗口限制也很重要。如果处理非常长的代码文件,开发人员应探索将其分解为更小、更易于理解的块的策略,然后再尝试应用 AI 驱动的修改。

表 1:面向 AI 的推荐代码长度指南

元素 建议 原因
函数 通常在 30-50 行以下;如果更长则进行审查 提高人类和 AI 的可读性;降低复杂性;更好地适应 AI 上下文窗口。
通常在 200-300 行以下;如果明显更长则进行审查 促进单一职责;增强人类和 AI 的可维护性和可理解性。
每个类的方法数量 理想情况下少于 10-20 个 保持类的专注和可管理性。
总体 优先考虑清晰性、单一职责和逻辑连贯性,而非严格限制 确保代码结构良好,易于人类和 AI 理解和使用。考虑 AI 的上下文窗口限制。

4. 面向对象编程:增强 AI 对代码的掌握

面向对象编程 (OOP) 通过围绕“对象”组织代码来提供软件开发的结构化范式,这些对象封装了数据和操作该数据的方法。⁴¹ 这种方法可以显著增强 AI 工具理解代码并与之交互的方式。OOP 的基本原则之一是封装,它涉及将数据和方法捆绑在单个单元(类)中。⁴³ 这创建了代码的模块化单元,改进了整体组织,并防止了对象外部对对象内部数据的意外修改。封装的这一特性为 AI 理解对象的范围和行为提供了清晰的边界。由于对象的内部工作受到保护,AI 可以通过对象的已定义方法进行交互来更安全地执行修改,从而降低无意中破坏其状态的风险。⁵¹ 封装本质上创建了一个“黑盒”视图,允许 AI 通过明确定义的接口与对象交互,从而最大限度地减少意外后果的可能性。

继承是 OOP 的另一个核心原则,它允许新类(派生类)从现有类(基类)继承属性和方法。⁴³ 这促进了代码的可重用性,并能够创建不同类型对象之间的层次关系。AI 可以利用这些继承层次结构来更好地理解代码库中各种类之间的关系。当 AI 识别出某个类继承自基类时,它可以推断出派生类共享某些特征和行为。这种理解使 AI 能够更智能地应用修改或扩展,尊重已建立的类层次结构,并确保更改与整体设计保持一致。

多态性,意为“多种形式”,是一个使不同类的对象能够被视为共同超类的对象的原则。⁴³ 这在软件系统中提供了高度的灵活性和互操作性。多态性允许 AI 通过通用接口与对象交互,即使方法的具体实现在对象之间有所不同。这可以极大地简化代码转换和集成,因为 AI 可以基于对象的共享接口来推理其行为,而无需在编译时了解具体类型。当 AI 遇到多态行为时,它可以理解不同的对象可能以不同的方式响应相同的方法调用,从而使其能够在不需要详细了解每个对象的具体类型的情况下,在分析中考虑到这些变化。

除了这些核心原则之外,其他 OOP 概念,如抽象(涉及隐藏复杂的实现细节并仅公开基本特征)和 SOLID 原则(单一职责、开闭、里氏替换、接口隔离、依赖倒置),也有助于编写更清晰、更易于维护,并最终对 AI 更友好的代码。⁴¹ 这些原则共同促进了模块化,减少了耦合,并增强了面向对象代码库的整体结构,使其更易于 AI 解析和推理。由封装促进的 OOP 的模块化特性有助于管理 AI 系统本身的复杂性,使其更有条理和易于理解。⁴⁴ 此外,基于 OOP 原则的设计模式为 AI 开发中遇到的常见挑战提供了可重用的解决方案。⁴⁴ OOP 及其相关设计模式的广泛采用和成熟性为 AI 模型提供了大量的训练数据。这种广泛的接触可能使 AI 更容易理解、生成和修改使用面向对象原则编写的代码。

5. 函数式编程:辅助 AI 进行代码生成和重写

函数式编程 (FP) 是一种强调使用纯函数和不可变数据的范式,在 AI 辅助的代码操作方面具有几个引人注目的优势。⁵ 纯函数是 FP 的基石,其特点是确定性:对于给定的输入,它们总是产生相同的输出,并且没有副作用,这意味着它们不会改变其自身范围之外的任何状态。⁵³ 这种可预测性对 AI 非常有利,因为它简化了对代码进行推理和测试的过程。纯函数的确定性使得代码生成和重写的任务对 AI 来说更加直接,因为结果完全取决于提供的输入。由于纯函数不依赖或修改任何外部状态,AI 可以自信地预测它们的行为,并将它们用作可靠且一致的构建块,用于生成新代码和转换现有代码。

FP 中的另一个关键概念是不可变性,这意味着一旦创建数据,其值就不能更改。⁵³ 这一特性有助于避免意外问题,并显著简化了 AI 推理程序状态的任务。不可变性降低了跟踪状态随时间变化的固有复杂性,使 AI 更容易理解程序内的数据流,并在代码修改期间避免引入错误。当数据不可变时,AI 无需担心代码某一部分的更改可能如何无意中影响其他看似无关的部分,从而简化了分析和修改过程。

函数式编程还将函数视为一等公民。⁵³ 这意味着函数可以分配给变量、作为参数传递给其他函数,并作为函数的返回值。这种能力使得创建强大的抽象和促进代码组合成为可能,这些是 AI 可以潜在利用以生成更复杂和灵活代码的特性。FP 通过组合小型、专注和纯函数来内在地鼓励模块化。⁵³ 这种模块化结构与 AI 处理孤立问题和生成离散代码单元的能力非常契合。此外,由于没有副作用和可变共享状态,FP 的原则可以增强代码的可并行性,这在 AI 应用中经常遇到的计算密集型任务中可能是有利的。⁵³ AI 工具还可以显著加速在函数式编程范式中创建特定任务函数的过程。FP 对数据转换的核心关注与 AI 在识别和操作数据模式方面的固有能力特别吻合。⁵⁴ 函数式编程的声明式风格,强调需要完成什么而不是明确详述如何做,对于那些被训练来从高级规范理解和生成代码的 AI 模型来说,也可能更直观。⁵⁴ FP 中的这种抽象级别可能使 AI 模型更容易处理需求并将其转换为函数式代码。

6. 概念清晰度和抽象:为 AI 弥合差距

抽象是软件开发中的一个基本概念,它通过关注基本特征同时隐藏不必要的实现细节来简化复杂系统。²⁰ 这种实践对于使代码对人类开发人员和 AI 代理都更易于理解和管理至关重要。良好抽象的代码提供了简化的接口,允许 AI 与系统的不同组件交互,而无需深入了解其底层实现的复杂细节。清晰的抽象有效地定义了各种代码组件的边界和职责,为 AI 提供了对整体系统架构及其预期功能的更高级别的理解。当 AI 遇到围绕明确定义的抽象组织的代码时,它可以在概念层面上推理系统不同部分之间的交互,而不是被低级实现细节所淹没。

概念清晰度,通过一致使用有意义的命名约定、包含信息性注释和代码的逻辑组织来实现,在帮助 AI 理解代码背后的意图和目的方面起着至关重要的作用。²¹ 抽象还促进了代码的可重用性 ²⁰,这是 AI 可以轻松利用的一个特性,通过识别和利用已建立的抽象组件来更有效地生成新代码或修改现有代码。在多个抽象层次上进行推理和操作的能力对于有效解决问题很重要。⁶⁷ 能够理解从高级架构设计到实现细节等不同层次代码的 AI 代理,更有能力执行更复杂和上下文感知的转换。数据抽象,具体来说,简化了复杂数据结构的表示和操作,使它们更易于 AI 处理和理解。⁶⁴ 同样,过程抽象通过将复杂过程分解为更小、更专注的函数,提高了代码的整体可读性和可维护性,这反过来又有益于 AI 分析和修改代码的能力。⁶⁴ 此外,AI 本身可以被用来通过分析代码的句法和语义上下文,识别通过抽象和其他技术可以改进的领域,来协助代码优化和重构。⁶⁸ 概念清晰且抽象良好的代码与 AI 模型处理信息的方式相一致,这涉及在各种细节层次上识别模式和关系。正如人类通过将复杂思想分解为更简单的概念和抽象来促进理解一样,AI 模型也可以从以清晰和抽象的方式组织和呈现的代码中显著受益。

7. 架构分层:构建代码库以适应 AI

架构模式,如模型-视图-控制器 (MVC) 和领域驱动设计 (DDD),通过分离不同的关注点为组织代码库提供了结构框架。⁶⁹ 这种职责分离可能使代码对生成式 AI 工具更易于理解和适应。MVC 模式将应用程序分为三个主要组件:模型 (Model),表示数据逻辑和状态;视图 (View),处理用户界面;控制器 (Controller),管理模型和视图之间的通信和交互。⁷⁰ 这种清晰的角色分离可能使 AI 能够根据任务的性质针对特定层进行修改。例如,可以训练 AI 识别 MVC 架构中每一层的不同职责,使其能够根据更改是与数据处理、用户界面表示还是应用程序控制流相关,在适当的层内生成或修改代码。

领域驱动设计 (DDD) 采用不同的方法,专注于核心业务领域及其底层逻辑,旨在使软件设计与领域专家所理解的实际领域模型紧密对齐。²³ DDD 强调关键概念,如实体(具有随时间持续存在的唯一身份的对象)、值对象(仅由其属性定义而没有唯一身份的对象)、聚合(被视为单个单元的相关对象集群)和限界上下文(明确定义的边界,特定领域模型在此边界内适用)。DDD 中对业务领域的显式建模可以为 AI 提供对代码库更丰富的语义理解。这种更深入的理解可能有助于实现更智能的代码生成和重构,这些代码不仅在语法上正确,而且在应用程序业务需求的上下文中也具有语义意义。在 DDD 中将核心业务逻辑隔离在领域层内 ⁶⁹ 对 AI 可能特别有利,因为它提供了一个集中的分析和修改区域,而没有基础设施特定关注点引入的复杂性。此外,DDD 中的限界上下文概念 ⁶⁹ 有助于在项目中定义清晰的语言和概念边界。这可以通过允许 AI 将其分析和修改集中在特定的、明确定义的上下文中,来帮助 AI 管理大型系统中的复杂性。虽然 MVC 模式有时在非常大的项目中可能会变得复杂且难以管理 ⁷⁰,但对于具有广泛且定义明确的业务领域的复杂系统,DDD 通常被推荐为更合适的架构方法。⁷⁰ 有趣的是,生成式 AI 工具本身甚至可以被用来加速 DDD 框架内的初始领域建模过程。⁷³ 总之,由于其对概念清晰度、基于业务逻辑的关注点分离以及建立明确定义边界的强烈强调,使用 DDD 原则构建的代码库可能为与 AI 工具的交互提供更健壮和适应性更强的基础。代码结构与底层业务领域的一致性为 AI 操作创造了一个比 MVC 架构中常见的更侧重于技术的分层更可预测和语义更丰富的环境。

8. 新兴领域:对生成式 AI 友好的软件架构

有意识地设计软件架构,使其与生成式 AI 工具的兼容性和交互性更佳,这是一个新兴且快速发展的研究和开发领域。⁷⁸ 尽管 AI 在软件开发的各个方面的应用已日益普遍,但它在塑造软件系统基础架构方面的作用仍处于早期阶段。然而,人们越来越认识到需要优化软件的结构方式,以充分利用 AI 在代码生成、重构和维护等任务中的能力。AI 已经被用于自动化各种设计流程、提高系统的可扩展性、增强安全措施以及优化整体系统性能。⁴ 正在开发的 AI 驱动工具可以根据高级需求生成初始架构模型,甚至可以识别现有架构中的潜在漏洞。⁴ “AI 优先架构”的概念正在获得关注,它涉及将机器学习和其他 AI 功能集成到系统设计的核心,使其能够根据实时数据进行学习、演进和自我调整。⁴ 研究还表明,生成式 AI 在为人类架构师提供架构决策支持以及协助重建现有软件架构方面得到了广泛采用。⁷⁸ 流行的软件架构建模和图表工具,如 ArchiMate 和 Structurizr,现在允许用户将其架构图和相关的结构细节导出为机器可读的格式。⁷⁹ 这种能力使 AI 工具能够通过处理这些结构化数据来理解架构,从而进行更明智的分析和建议。此外,AI 可用于生成与治理相关的结构和约束适应度函数,这有助于确保实施的架构遵守定义的原则和标准。⁷⁹ 生成式 AI 系统本身的架构是复杂的,通常涉及多个层次,例如数据收集和预处理、底层的神经网络和机器学习算法、模型训练和优化过程,以及输出生成和反馈的机制。⁸⁰ 在考虑设计对 AI 友好的软件架构时,需要考虑几个关键因素,包括 AI 将与之交互的数据的准备情况和质量、为 AI 任务选择合适的基础模型、评估这些模型的性能和安全性的方法、评估和减轻与 AI 相关的潜在风险,甚至包括训练和运行大型 AI 模型的环境影响。⁸² 专门为生成式 AI 架构量身定制的新兴设计模式,例如提示工程(专注于优化给予 AI 模型的输入提示)和检索增强生成(RAG)(通过从外部来源检索相关信息来增强 AI 的知识),也变得越来越重要。⁸¹ 虽然 AI 在增强甚至自动化软件架构方面具有巨大潜力,但必须记住,人类的监督和专业知识对于确保这些技术的可靠性、安全性和合乎道德的使用仍然至关重要。⁴ 对 AI 生成输出中潜在偏见的担忧,以及在软件设计中使用 AI 的安全和伦理影响,也必须仔细考虑。⁹ 围绕开发专门设计为“对 AI 友好”的软件架构的研究和讨论日益增多,这清楚地表明软件工程界越来越意识到需要优化代码库和系统设计,以有效地与生成式 AI 工具日益增长的能力进行交互和利用。

9. 面向 AI 的战略性重构:改造现有代码库

重构,即在不改变外部行为的情况下重新组织现有计算机代码的过程,是提高软件质量、可维护性和适应性的关键实践。¹⁸ 在准备代码库以便与生成式 AI 工具进行有效交互的背景下,战略性重构变得更加重要。为了使现有的、可能庞大而复杂的代码更容易被 AI 驱动的修改所访问和管理,可以采用几种关键策略。¹⁸ 一种基本方法是将大型代码文件分解为更小、更专注的模块、类和函数。这种模块化使 AI 更容易在其上下文窗口内处理代码,并对特定功能进行推理,而无需分析庞大、单一的文件。同样,长方法或函数应重构为更小、更易于管理的单元,每个单元都致力于执行单一、明确定义的任务。¹⁸ 这提高了代码对人类和 AI 的可读性和可理解性。消除代码重复是另一个关键的重构目标。¹⁸ 通过将冗余代码段提取到可重用组件中来识别和删除它们,不仅使代码库更简洁,而且简化了 AI 的分析和修改。改进命名约定也至关重要。为变量、函数和类使用有意义且描述性的名称可以提高代码的清晰度,并使 AI 能够更好地理解不同代码元素的用途。¹⁸ 复杂的条件语句对人类和 AI 都可能难以理解,应通过将其分解为更小、更易读的单元来简化。¹⁸ 引入成熟的设计模式可以改善代码的整体结构和灵活性。²⁸ AI 工具通常经过训练以识别这些常见模式,这有助于更好地理解和更有效地生成或修改代码。添加清晰简洁的注释和文档来解释代码的逻辑和目的也非常有益。⁶ AI 可以利用这些自然语言信息来更深入地理解代码的意图。在整个代码库中遵循一致的编码风格和约定可以创建可预测的模式,AI 在生成或修改代码时可以学习和遵循这些模式。¹⁸ 在执行重构时,通常建议进行增量更改,并通过频繁运行测试来确保代码在每次更改后保持功能正常。²⁵ 利用自动重构工具,无论是集成开发环境(IDE)内置的还是作为独立应用程序提供的,都可以帮助简化一些更常规的重构任务。²⁵ AI 驱动的工具本身也可以通过建议潜在的改进甚至执行自动转换来协助重构过程。¹⁸ 采用红-绿-重构方法,这是测试驱动开发(TDD)的核心实践,可以通过首先编写一个失败的测试,然后编写最少的代码使其通过,最后重构代码以改进其设计,为重构提供结构化的方法。²⁶ 在专门使用 AI 进行重构时,通过提示提供清晰具体的指令,例如“简化此代码”、“提高可读性”或“将此逻辑提取到单独的函数中”,可以帮助引导 AI 实现期望的结果。¹⁸ 最终,从 AI 的角度战略性地重构现有代码库需要着重于提高模块化、清晰度和简洁性,以使代码对 AI 工具更易于访问、理解和管理,从而最大限度地发挥 AI 辅助软件开发和维护的优势。

10. 结论:拥抱 AI 与软件设计的协同作用

将生成式 AI 集成到软件开发中,为提高生产力、改善代码质量和加速开发周期提供了变革性的机遇。然而,要充分发挥这一潜力,需要有意识地努力调整传统的软件架构和编码实践,使其更符合 AI 工具的运作方式。本报告探讨了优化代码库以适应生成式 AI 的几个关键原则和策略。模块化和简洁代码的好处、管理代码长度的重要性,以及遵循面向对象编程和函数式编程等成熟编程范式的优势,都有助于创建一个 AI 能够更有效地协助代码生成、重构和维护的环境。此外,对概念清晰度和抽象性的强调,以及对 MVC 和 DDD 等架构分层模式的战略性使用,可以为 AI 交互提供坚实的结构基础。AI 友好型软件架构这一新兴领域突显了人们日益认识到需要从 AI 的角度设计系统,而重构现有代码库的策略为改造遗留系统以更好地利用 AI 能力提供了实用的指导。随着软件开发中 AI 格局的不断演变,致力于持续学习和适应对于开发人员和架构师充分利用这种协同关系的全部力量至关重要。

11. 构建和重构对 AI 友好的软件的建议

基于本报告的分析,为构建新软件和重构现有代码库以使其与生成式 AI 工具更兼容,提供以下可操作的建议:

  • 拥抱模块化: 设计软件时要高度重视模块化。将应用程序分解为具有明确定义接口的更小、自包含的模块,以增强人类和 AI 的可维护性、可重用性和可测试性。¹⁸
  • 编写简洁和专注的代码: 目标是使函数和类简洁并专注于单一职责。通常将函数保持在 30-50 行以下,类保持在 200-300 行以下,同时优先考虑清晰度和逻辑连贯性,而不是严格的行数限制。³¹
  • 遵守 OOP 原则: 利用面向对象编程的原则,包括封装、继承和多态性,创建结构良好、组织有序的代码,使 AI 更容易理解和修改。⁴¹
  • 考虑函数式编程: 探索函数式编程范式的好处,例如使用纯函数和不可变数据,特别是在代码生成和需要 AI 辅助以保证可预测性和可测试性的任务中。⁵
  • 优先考虑概念清晰度和抽象性: 编写概念清晰的代码,使用有意义的名称、注释和逻辑组织。运用抽象来简化复杂系统,并为 AI 提供清晰的交互接口。²⁰
  • 智能地组织代码库: 对于复杂的应用程序,考虑使用像领域驱动设计(DDD)这样的架构模式,使代码结构与业务领域保持一致,这可能为 AI 提供更丰富的语义理解。²³
  • 战略性地重构: 对于现有代码库,采用面向 AI 的战略性重构方法。分解大型文件、提取方法、消除代码重复、改进命名并简化复杂逻辑,使代码对 AI 工具更易于管理和理解。¹⁸
  • 自动化和测试: 利用自动化工具进行测试、代码检查(linting)和格式化,以确保代码的一致性和质量,这也有利于 AI 分析。通过小步重构和频繁测试来确保代码功能得以维持。²⁵
  • 向 AI 提供清晰的指令: 在使用 AI 进行代码生成或重构时,通过精心设计的提示提供清晰具体的指令,以引导 AI 实现期望的结果。¹⁸
  • 保持信息灵通并适应: 软件开发中的 AI 领域正在迅速发展。持续学习新的 AI 工具、最佳实践和研究发现,以相应地调整软件架构和编码策略。¹⁷

Works cited

  1. The Impact of Generative AI Coding Assistants on Developers Who Are Visually Impaired, accessed April 1, 2025, https://arxiv.org/html/2503.16491v1
  2. Measuring the Impact of AI Coding Assistants - Tabnine, accessed April 1, 2025, https://www.tabnine.com/blog/measuring-the-impact-of-ai-coding-assistants/
  3. Studying the Quality of Source Code Generated by Different AI Generative Engines: An Empirical Evaluation - MDPI, accessed April 1, 2025, https://www.mdpi.com/1999-5903/16/6/188
  4. The Role of AI in Software Architecture: Trends and Innovations, accessed April 1, 2025, https://www.imaginarycloud.com/blog/ai-in-software-architecture
  5. AI Code Generation Explained: A Developer's Guide - GitLab, accessed April 1, 2025, https://about.gitlab.com/topics/devops/ai-code-generation-guide/
  6. AI Code Generator: Automate Repetitive Coding & Accelerate Development, accessed April 1, 2025, https://www.getambassador.io/blog/ai-code-generator-automate-coding
  7. What is AI code generation? - GitHub, accessed April 1, 2025, https://github.com/resources/articles/ai/what-is-ai-code-generation
  8. Understanding User Mental Models in AI-Driven Code Completion Tools: Insights from an Elicitation Study - arXiv, accessed April 1, 2025, https://arxiv.org/html/2502.02194v1
  9. Generative AI: What Is It, Tools, Models, Applications and Use Cases - Gartner, accessed April 1, 2025, https://www.gartner.com/en/topics/generative-ai
  10. Exploring Generative AI - Martin Fowler, accessed April 1, 2025, https://martinfowler.com/articles/exploring-gen-ai.html
  11. 10 generative AI programming tools for developers - LeadDev, accessed April 1, 2025, https://leaddev.com/velocity/generative-ai-programming-tools-developers
  12. How AI code generation works - The GitHub Blog, accessed April 1, 2025, https://github.blog/ai-and-ml/generative-ai/how-ai-code-generation-works/
  13. 20 Examples of Generative AI Applications Across Industries - Coursera, accessed April 1, 2025, https://www.coursera.org/articles/generative-ai-applications
  14. AI Code Generation: The Risks and Benefits of AI in Software - Legit Security, accessed April 1, 2025, https://www.legitsecurity.com/blog/ai-code-generation-benefits-and-risks
  15. AI Code Generation: An Introduction - Zencoder, accessed April 1, 2025, https://zencoder.ai/blog/about-ai-code-generation
  16. Top 8 Generative AI Tools For Software Development In 2024, accessed April 1, 2025, https://www.gsdcouncil.org/blogs/generative-ai-tools-for-software-development
  17. Code and Beyond: A Review on the Impact of AI on Modern Software Development, accessed April 1, 2025, https://www.researchgate.net/publication/390003415_Code_and_Beyond_A_Review_on_the_Impact_of_AI_on_Modern_Software_Development
  18. How to refactor code with GitHub Copilot, accessed April 1, 2025, https://github.blog/ai-and-ml/github-copilot/how-to-refactor-code-with-github-copilot/
  19. Modular programming: Definitions, benefits, and predictions - TinyMCE, accessed April 1, 2025, https://www.tiny.cloud/blog/modular-programming-principle/
  20. Developing modular software: Top strategies and best practices ..., accessed April 1, 2025, https://vfunction.com/blog/modular-software/
  21. Best Practices for Modular Code Design - PixelFreeStudio Blog, accessed April 1, 2025, https://blog.pixelfreestudio.com/best-practices-for-modular-code-design/
  22. AI Copilot Code Quality: Evaluating 2024's Increased Defect Rate with Data - AWS, accessed April 1, 2025, https://gitclear-public.s3.us-west-2.amazonaws.com/AI-Copilot-Code-Quality-2025.pdf
  23. Domain Driven Design in AI-Driven Era - Intuitive Cloud, accessed April 1, 2025, https://intuitive.cloud/blog/domain-driven-design-in-ai-driven-era
  24. How to write AI friendly code. AI tools are making a significant… | by Scott Boring - Medium, accessed April 1, 2025, https://medium.com/@scott.boring.sb/how-to-write-ai-friendly-code-1d24b3fbe1c9
  25. Code Refactoring in 2025: Best Practices & Popular Techniques - Maruti Techlabs, accessed April 1, 2025, https://marutitech.com/code-refactoring-best-practices/
  26. Code Refactoring: 6 Techniques and 5 Critical Best Practices - CodeSee, accessed April 1, 2025, https://www.codesee.io/learning-center/code-refactoring
  27. Chapter 10 Refactoring Code | AI for Efficient Programming - Fred Hutch Data Science Lab, accessed April 1, 2025, https://hutchdatascience.org/AI_for_Efficient_Programming/refactoring-code.html
  28. Top Code Refactoring Best Practices for 2025 - DocuWriter.ai, accessed April 1, 2025, https://www.docuwriter.ai/posts/code-refactoring-best-practices
  29. Code refactoring principles, techniques, and automation with generative AI - Tabnine, accessed April 1, 2025, https://www.tabnine.com/blog/code-refactoring-with-generative-ai/
  30. 35 Code Refactoring Prompts to Know for Generative AI | Built In, accessed April 1, 2025, https://builtin.com/articles/code-refactoring-prompt
  31. Rule of 30 – When is a Method, Class or Subsystem Too Big? - DZone, accessed April 1, 2025, https://dzone.com/articles/rule-30-%E2%80%93-when-method-class-or
  32. What is the ideal length of a method for you? - Software Engineering Stack Exchange, accessed April 1, 2025, https://softwareengineering.stackexchange.com/questions/133404/what-is-the-ideal-length-of-a-method-for-you
  33. How Long Should Functions Be? How Do We Measure It? | by Sara Khandaker - Medium, accessed April 1, 2025, https://medium.com/swlh/how-long-should-functions-be-how-do-we-measure-it-cccbdcd8374c
  34. Should Functions Be Small?. Clean Code tells us: | by Gregory Leman | CodeX | Medium, accessed April 1, 2025, https://medium.com/codex/should-functions-be-small-e76b45aa93f
  35. What is the ideal length of a code for you? - DEV Community, accessed April 1, 2025, https://dev.to/devstoriesplayground/what-is-the-ideal-length-of-a-code-for-you-4hff
  36. code formatting - How small should functions be? - Software Engineering Stack Exchange, accessed April 1, 2025, https://softwareengineering.stackexchange.com/questions/350205/how-small-should-functions-be
  37. How Long Should a Class Be — When Clean Code Isn't Really Clean | by Matt Chmielewski | Better Programming - Medium, accessed April 1, 2025, https://medium.com/better-programming/how-long-should-a-class-be-when-clean-code-isnt-really-clean-f3dd6945c0b2
  38. Code Suggestions - GitLab Docs, accessed April 1, 2025, https://docs.gitlab.com/user/project/repository/code_suggestions/
  39. Setting Parameters in OpenAI - Codecademy, accessed April 1, 2025, https://www.codecademy.com/article/setting-parameters-in-open-ai
  40. Understanding Temperature, Top P, and Maximum Length in LLMs - Learn Prompting, accessed April 1, 2025, https://learnprompting.org/docs/intermediate/configuration_hyperparameters
  41. Understanding SOLID Principles: Why OOP is the Foundation 🏗️ - DEV Community, accessed April 1, 2025, https://dev.to/arjun98k/understanding-solid-principles-why-oop-is-the-foundation-eng
  42. Agent-Oriented Programming vs. Object-Oriented Programming: Key Differences Explained, accessed April 1, 2025, https://smythos.com/ai-agents/ai-agent-development/agent-oriented-programming-vs-object-oriented-programming/
  43. Understanding the Four Pillars of Object-Oriented Programming: Encapsulation, Inheritance, Polymorphism, and Abstraction | Galaxy.ai, accessed April 1, 2025, https://galaxy.ai/youtube-summarizer/understanding-the-four-pillars-of-object-oriented-programming-encapsulation-inheritance-polymorphism-and-abstraction-b3GccK5_KSQ
  44. Object Oriented Programming in Artificial Intelligence | by Hashim Abbas - Medium, accessed April 1, 2025, https://medium.com/@hashimabbas.nhu/object-oriented-programming-in-artificial-intelligence-8d9a3a8589ce
  45. 10 Applications of Object-Oriented Programming (OOP) - QuickStart, accessed April 1, 2025, https://www.quickstart.com/blog/software-engineering/10-applications-of-object-oriented-programming/
  46. Application of OOPs (Object Oriented Programming) - AlmaBetter, accessed April 1, 2025, https://www.almabetter.com/bytes/articles/application-of-oops
  47. OOP in Python for Artificial intelligence - II | Live Session | Applied AI Course - YouTube, accessed April 1, 2025, https://www.youtube.com/watch?v=LWYNCCulUwc
  48. How to Use Generative AI for Coding: The Ultimate Guide for Every Programmer, accessed April 1, 2025, https://learnprompting.org/blog/how_to_use_generative_AI_for_code
  49. Optimizing AI Systems: The Power of OOP - Lejhro Bootcamp, accessed April 1, 2025, https://www.bootcamp.lejhro.com/resources/object-oriented-programming/how-does-oop-enhance-in-ai-development
  50. 0: Polymorphic Agents: Applying Object-Oriented Design Principles to AI Agentic Systems, accessed April 1, 2025, https://joshua-j-morley.medium.com/applying-object-oriented-design-principles-to-ai-agentic-systems-a-novel-approach-0e2cc3db55db
  51. What are the differences between polymorphism, encapsulation, and inheritance? - The IoT Academy Blogs - Best Tech, Career Tips & Guides, accessed April 1, 2025, https://www.theiotacademy.co/blog/what-are-the-differences-between-polymorphism-encapsulation-and-inheritance/
  52. Understanding essential SOLID Principles in OOP: A Developer's Guide - Curiosum, accessed April 1, 2025, https://curiosum.com/blog/bringing-solid-to-elixir
  53. Functional Programming for Beginners - Daily.dev, accessed April 1, 2025, https://daily.dev/blog/functional-programming-for-beginners
  54. Actual benefits of FP : r/functionalprogramming - Reddit, accessed April 1, 2025, https://www.reddit.com/r/functionalprogramming/comments/1f21riy/actual_benefits_of_fp/
  55. Why Functional Programming Matters, accessed April 1, 2025, https://www.cs.kent.ac.uk/people/staff/dat/miranda/whyfp90.pdf
  56. Everything You Need to Know When Assessing Functional Programming Skills - Alooba, accessed April 1, 2025, https://www.alooba.com/skills/concepts/programming/functional-programming/
  57. Leveraging AI to Enhance Functional Programming in 2025 | R ..., accessed April 1, 2025, https://www.r-bloggers.com/2024/12/leveraging-ai-to-enhance-functional-programming-in-2025/
  58. Functional Programming is just programming | by Marko Novakovic - Medium, accessed April 1, 2025, https://markonovakovic.medium.com/functional-programming-is-just-programming-6e5fda1c5ce8?source=rss------programming-5
  59. What is Functional Programming and Why it is Important to Learn? - Turing, accessed April 1, 2025, https://www.turing.com/kb/introduction-to-functional-programming
  60. The Essentials of Functional Programming - XenonStack, accessed April 1, 2025, https://www.xenonstack.com/insights/functional-programming
  61. Unlocking the Power of Functional Programming Patterns | by Murat Aslan | Medium, accessed April 1, 2025, https://medium.com/@murataslan1/unlocking-the-power-of-functional-programming-patterns-0a97f29a5c0f
  62. What is functional programming actually useful for? : r/learnprogramming - Reddit, accessed April 1, 2025, https://www.reddit.com/r/learnprogramming/comments/1i83lpq/what_is_functional_programming_actually_useful_for/
  63. Abstraction in AI: Concepts and Applications - Insight7 - AI Tool For Interview Analysis & Market Research, accessed April 1, 2025, https://insight7.io/abstraction-in-ai-concepts-and-applications/
  64. Data Abstraction Vs Procedural Abstraction | Restackio, accessed April 1, 2025, https://www.restack.io/p/threshold-concepts-in-ai-answer-data-abstraction-vs-procedural-abstraction-cat-ai
  65. A Guide to Data Abstraction and Its Significant Benefits - CelerData, accessed April 1, 2025, https://celerdata.com/glossary/a-guide-to-data-abstraction
  66. Top 7 Refactoring Techniques and 7 Critical Best Practices - Brainhub, accessed April 1, 2025, https://brainhub.eu/library/refactoring-best-practices
  67. Why reasoning across multiple abstraction layers is important. | by ..., accessed April 1, 2025, https://zerofilter.medium.com/why-reasoning-across-multiple-abstraction-layers-is-important-aaef2a5c65f3
  68. (PDF) Artificial Intelligence in Code Optimization and Refactoring - ResearchGate, accessed April 1, 2025, https://www.researchgate.net/publication/389884213_Artificial_Intelligence_in_Code_Optimization_and_Refactoring
  69. Another Way to Structure your Symfony Project - DEV Community, accessed April 1, 2025, https://dev.to/etienneleba/another-way-to-structure-your-symfony-project-llo
  70. Introduction to .NET Architecture Patterns: MVC, MVP, MVVM, Domain Driven Design, accessed April 1, 2025, https://dev.to/adrianbailador/introduction-to-net-architecture-patterns-mvc-mvp-mvvm-domain-driven-design-4i3f
  71. MVC, Delivery Mechanism and Domain Model - Codurance, accessed April 1, 2025, https://www.codurance.com/publications/2017/09/20/mvc-delievery-mechanism-dm
  72. Implementing DDD Entity class in C# - Stack Overflow, accessed April 1, 2025, https://stackoverflow.com/questions/2326288/implementing-ddd-entity-class-in-c-sharp
  73. Enhancing Domain-Driven Design with Generative AI | by Clair Mary Sebastian - Medium, accessed April 1, 2025, https://medium.com/inspiredbrilliance/enhancing-domain-driven-design-with-generative-ai-5447f909e1a7
  74. DDD & Domain Modeling: Using AI to Accelerate Design - with Staffan Palopää, accessed April 1, 2025, https://virtualddd.com/sessions/ddd-domain-modeling-using-ai-to-accelerate-design-with-staffan-palopaa/
  75. Importance of Domain-Driven Design (DDD) in .NET Development? - Concetto Labs, accessed April 1, 2025, https://www.concettolabs.com/blog/what-is-the-importance-of-domain-driven-design-ddd-in-net-development/
  76. The Architecture Journey — Adapting DDD from MVC | by Muthu R Gurumoorthy | Assembly Engineering | May, 2022 - Medium, accessed April 1, 2025, https://medium.com/assembly-engineering/the-architecture-journey-adapting-ddd-from-mvc-fa5a237f3b23
  77. DDD & Domain Modeling: Using AI to Accelerate Design - with Staffan Palopää - YouTube, accessed April 1, 2025, https://www.youtube.com/watch?v=fyN8yGtlIjs
  78. [2503.13310] Generative AI for Software Architecture. Applications, Trends, Challenges, and Future Directions - arXiv, accessed April 1, 2025, https://arxiv.org/abs/2503.13310
  79. The Use of AI in Software Architecture - Neueda, accessed April 1, 2025, https://neueda.com/enterprise-learning/resources/blogs/ai-in-software-architecture/
  80. Generative AI Architecture: A Master Guide - Debut Infotech, accessed April 1, 2025, https://www.debutinfotech.com/blog/generative-ai-architecture
  81. Generative AI Design Patterns & Architecture: Best Practices - Code B, accessed April 1, 2025, https://code-b.dev/blog/gen-ai-architecture
  82. The Complete Guide to Generative AI Architecture - XenonStack, accessed April 1, 2025, https://www.xenonstack.com/blog/generative-ai-architecture
  83. 7 Architecture Considerations for Generative AI | Accenture, accessed April 1, 2025, https://www.accenture.com/us-en/blogs/cloud-computing/7-generative-ai-architecture-considerations
  84. How AI Software Will Change Architecture and Design - Broscorp, accessed April 1, 2025, https://broscorp.net/how-ai-software-will-change-architecture/
  85. Generative AI Architecture: A Comprehensive Guide - Systango, accessed April 1, 2025, https://www.systango.com/blog/generative-ai-architecture
  86. Code Refactoring and Workflows | Digital.ai, accessed April 1, 2025, https://digital.ai/glossary/code-refactoring/
  87. Can AI help me refactor legacy code?, accessed April 1, 2025, https://understandlegacycode.com/blog/can-ai-refactor-legacy-code/
  88. Large codebase refactoring in phases with o1 pro - Community ..., accessed April 1, 2025, https://community.openai.com/t/large-codebase-refactoring-in-phases-with-o1-pro/1102984

或许您还需要下面的文章:

关于我

Github: @phodal     微博:@phodal     知乎:@phodal    

微信公众号(Phodal)

围观我的Github Idea墙, 也许,你会遇到心仪的项目

QQ技术交流群: 321689806