Gemini Code Assist - 代码重构

代码重构对于保持程序优化、可维护和无错误至关重要。Gemini Code Assist 通过提供智能建议并直接在您的开发环境中自动执行重构任务来简化此过程。

在这里,我们将看到用于代码重构的不同提示以及项目场景,以更好地了解代码重构的好处。

Gemini Code Assist Code Refactoring

什么是代码重构?

您可以重构当前项目中的任何代码,它将使代码更紧凑,同时保持其简单性和可扩展性。在这里,逻辑不会改变,但内部结构会改变,从而消除冗余逻辑和不必要的循环并提高可读性。您对项目代码进行进一步修改的任务变得更加容易。

Gemini 如何识别重构机会?

Gemini 使用经过训练的高级静态代码分析以及依赖关系映射来扫描代码库并提出改进建议。以下是它检测重构需求的主要方法 −

  • 静态代码分析 − 识别代码逻辑、反模式以及潜在的改进或进一步简化(如果需要)。
  • 检测代码变量 − 它标记诸如长方法、深度嵌套和冗余变量等问题。
  • 与 Linters 集成 − Gemini 可以根据样式指南(如 Python 中的 PEP8 或 JavaScript 的 ESLint)建议立即修复。
  • 依赖关系分析 −通过这种方式,Gemini 可确保重构不会破坏模块之间的链接或导致项目出现意外行为。

Gemini 中支持的重构技术

Gemini 可自动执行各种重构任务,包括 −

  • 重命名变量/方法 − 确保整个项目的命名约定有意义,并查找以前的变量名称(如果使用)。
  • 提取方法 − 将复杂的逻辑分解为更小的可重用方法。
  • 内联重构 − 当不需要那些不必要的部分时,将逻辑从单独的函数移到主体中。
  • 简化控制结构 −用更清晰的逻辑替换深层的 if-else 链。
  • 循环重构 − 将循环转换为功能代码,例如 map/filter 函数。

使用 Gemini 的代码重构示例

让我们来看一些使用 Gemini Code Assist − 进行代码重构的示例

Python 示例:提取方法

这是一个计算给定数字平均值的简单函数。

重构之前,

def process_data(data):
   result = sum(data) / len(data)
   print(f"The average is {result}")
   print(f"Data has total {len(data)} elements")

process_data([10, 20, 30, 40, 50])

您可以向 Gemini 添加提示,例如:"建议对 Python 中的大型函数进行方法提取。"这将使上述代码更加通用和可扩展。

使用 Gemini 建议进行重构后,

def calculate_average(data):
   return sum(data) / len(data)

def print_data_info(data):
   print(f"The average is {calculate_average(data)}")
   print(f"Data has total {len(data)} elements")

print_data_info([10, 20, 30, 40, 50])

此示例演示了上述函数中的方法提取。最终,它通过将逻辑分解为更小、更集中的方法来促进模块化。

JavaScript 示例:重构控制结构

重构之前,

function getUserAccess(role) {
   if (role === 'admin') {
      return 'Full Access';
   } else if (role === 'editor') {
      return 'Edit Content';
   } else {
      return 'View Only';
   }
}

向 Gemini 添加建议,例如:"使用基于对象的模式简化 if-else 条件。"。此重构使用对象映射来简化条件逻辑并提高可读性。

重构后,

function getUserAccess(role) {
   const access = {
      admin: 'Full Access',
      editor: 'Edit Content',
   };
   return access[role] || 'View Only';
}

Java 示例:使用流进行循环重构

重构之前,

int sum = 0;
for (int i = 1; i <= 10; i++) {
   sum += i;
}
System.out.println("Sum: " + sum);

使用类似"在 Java 中将循环重构为函数式流"的提示。它将简化循环并将其替换为函数式流,以提高可读性和性能。

重构后,

int sum = IntStream.rangeClosed(1, 10).sum();
System.out.println("Sum: " + sum);

您可以使用 Gemini 重构任何编程语言中的任何代码,它适用于不同的平台、框架和多种类型的个性化项目。

使用 Gemini Code Assist 实现重构自动化

  • 实时建议 −此功能直接集成在 IDE 中,以提供即时反馈,当它用作轻量级扩展时也是如此。
  • 批量重构 − 适当的提示将自动重命名同一项目中多个文件中的函数和方法提取。
  • 版本控制集成 − 跟踪更改以避免协作开发期间发生冲突。
  • 回滚机制 − 当代码发生不必要的重构时,它会安全地将更改恢复到原始代码,尤其是在遇到任何问题或可扩展性错误时。

为重构代码生成完美的测试用例

重构后,测试至关重要,以确保功能保持完整。它可以根据重构的代码自动生成测试用例,以验证所有可能的结果。

Gemini 扫描代码并识别关键的输入和输出。它确保所有代码路径(包括边缘情况)都经过测试。依赖关系检查会为边缘情况生成测试用例,并包括函数中的任何交互组件。

示例:在 Python 中生成测试用例

重构函数 −

def multiply(a, b):
   return a * b

提示 − "使用 pytest 在 Python 中生成参数化乘法测试。"

使用 Pytest 的测试用例 −

import pytest
pytest.mark.parametrize("a, b, expected", [(2, 3, 6), (0, 5, 0), (-1, 4, -4)])
def test_multiply(a, b, expected):
    assert multiply(a, b) == expected

示例:在 JavaScript (Jest) 中生成测试用例

重构函数 −

function add(a, b) {
    return a + b;
}

提示 − "为附加功能创建具有多个输入的 Jest 测试用例。"

使用 Jest 的测试用例 −

test.each([
   [2, 3, 5],
   [0, 0, 0],
   [-1, 4, 3]
])('adds %i and %i to give %i', (a, b, expected) => {
   expect(add(a, b)).toBe(expected);
});

真实场景:重构 Web 应用程序以优化性能

让我们考虑一个用于管理组织中的员工记录的 Python-Django Web 应用程序。最初,代码是在极少优化的情况下编写的,导致性能问题,例如数据库查询速度慢和逻辑冗余。

Gemini Code Assist 帮助逐步重构项目,以提高性能、可读性和可维护性。

初始问题:未优化的代码结构

原始代码从数据库检索员工数据,手动过滤,然后将其呈现到前端。

重构前 −

未优化的代码结构 1 未优化的代码结构 2

上述函数从数据库检索所有员工并手动执行过滤。但是,视图函数内的逻辑可以提取到服务层以供重用。

重构数据库查询

提示 − "我可以优化这些 Django ORM 查询来过滤 50,000 以上的员工工资吗?"

Gemini 的代码建议 −

重构数据库查询 1 重构数据库查询 2

在这里,过滤、按工资排序、索引、缓存、分页和查询优化等因素都付诸行动,并提供重构代码,可以创建更高效​​、更可扩展的 Django 应用程序来过滤 50000 以上的员工工资。

将逻辑提取到服务中层

提示 − "将员工过滤逻辑提取到单独的函数中,以便更好地重用代码。"

Gemini 的代码建议 −

将逻辑提取到服务层

此重构通过将逻辑封装到单独的函数中来提高代码的可重用性,以便您可以将此逻辑应用于应用程序的其他部分。

为重构代码生成测试用例

提示 − "生成 pytest 测试用例以验证员工过滤逻辑。"

Gemini 的测试用例建议 −

Generating Test Cases for Refactored Code

测试用例验证 filter_high_earners 函数并确保过滤逻辑与数据库中的员工正确配合使用。

使用 Gemini 进行性能测试

提示 − "分析重构函数的性能并提出改进建议。"

Gemini 的建议 −

如果涉及外键,请使用 select_related() 减少查询次数。

对经常访问的数据应用缓存以进一步提高性能。

重构对项目性能的影响

以下是重构对项目性能的影响 −

  • 提高效率
  • 更好的可维护性
  • 减少技术债务
  • 增加协作

使用 Gemini Code Assist 进行重构的最佳实践

以下是使用 Gemini Code Assist 进行重构的最佳实践 −

  • 小步重构 − 避免一次进行多项更改。
  • 定期提交 − 使用版本控制逐步跟踪更改。
  • 频繁运行测试 − 确保每次更改后所有功能都完好无损。
  • 监控代码指标 −跟踪循环复杂度并保持代码质量。
  • 团队合作评审 − 与团队成员协作以验证重构工作。

结论

总体而言,您在项目应用程序中编写的逻辑必须精确且最终。 Gemini 将查看您编写的逻辑并建议以小片段的形式重构代码。开发人员可以很好地理解这些代码建议,并且本质上可以高度扩展。您需要做的就是编写完美的提示并获得完美的输出,而无需添加太多不必要的信息。这不仅可以提高生产力,还可以减少制作更优化、更可靠的可扩展应用程序所需的时间。