Sensei 是什么？

Sensei 插件提供了一种简便的方法，可在源代码中查找特定的代码模式，并应用重写规则来修改匹配的代码。所有操作均在 IntelliJ IDE 中实时完成。

‍

‍

例如，您可以创建一个规则来匹配没有原因说明的 JUnit `@Disabled` 注解，Sensei 会通过在 IDE 中高亮显示代码来提醒您注意该问题。

此外，当您按下 `alt+enter` 时，可以选择 `Add a todo comment parameter`（添加待办事项注释参数）。

选中后，代码将被修改并添加一个样板原因说明，您可以对其进行编辑；如果不编辑，它将显示在您的 TODO 面板中。

例如，`@Disabled` 将变为 `@Disabled("TODO: add a description here")`

Sensei 将静态分析代码扫描器的功能与代码重写引擎相结合。

IntelliJ 意图操作 (Intention Actions)

根据上述描述，显而易见的替代方案（如果您不使用 Sensei）是使用 IntelliJ 的意图操作功能。

Sensei 与 IntelliJ 意图操作的不同之处在于，Sensei 旨在提供一种创建项目特定甚至是个体开发者本地专用的匹配器和重写器的方法。

我们尝试构建了一个图形用户界面 (GUI)，使匹配和重写规则的编写与实验变得简单易行。

它如何帮助我个人提升？

在学习新库时，我需要时间来建立对方法和格式的肌肉记忆。因此，我可能会选择创建个人方案，用于

• 链接到官方文档或教程页面
• 提供最有效的样板模板
• 修复不良编码习惯
• 添加样板代码以辅助库的使用

我可以使用 Sensei 构建临时方案，提示我采用当前选择的实践，并帮助我养成有效的习惯。这些方案是临时的，因为当我不再需要它们时，可以将它们移除。

它如何帮助我的团队提升？

同样，我们可以帮助团队围绕商定的编码标准建立肌肉记忆。

通过创建方案手册，当我们发现拉取请求 (PR) 评审中出现重复的注释时，即可应用这些方案。由于方案手册与项目一起存储在版本控制中，项目中的每个人都可以使用它们。当我们不再需要提示时，还可以将其关闭。

Sensei 有助于尽早提供反馈

我们开发 Sensei 的初衷，是希望在编码过程中尽早获取改进建议和纠错提醒。

与其等待

• 静态分析结果
• 代码审查意见

我们可以在编码时直接看到针对自定义标准的反馈。

通过提醒或自动重写规则，帮助我们编写符合标准的代码。

Sensei 非常灵活

正因如此，Sensei 兼具多种特性：

• 部分静态分析器
• 编码导师
• 重写引擎

Sensei 的灵活性让“Sensei 是什么”这个问题变得有些难以定义。

Sensei 填补了编程工作流中的空白

我们致力于让 Sensei 成为程序员工作流中缺失的一环，帮助你改进团队当前使用的编码风格或库的特定用法。

这种灵活性意味着上手 Sensei 比使用静态分析工具或 IntelliJ 内置的 Intentions 需要更多时间。但通过实践，你将找到一种加速个人成长的新方法。

如何进行实践？

下载并安装 Sensei 后，请访问 [Intellij Marketplace]

让 Sensei 发挥作用的最简单方法是审视你的编码过程，并思考：

• 你经常查阅哪些文档？
  -- 你可以添加一些指向这些文档的 Sensei 配方。
• 你总是犯哪些简单错误？
  -- 你可以将这些不良模式定义为匹配器，并编写快速修复规则来自动修正代码。
• 使用库时，你编写了哪些样板代码？
  -- 你可以创建快速修复规则来自动生成这些代码。

Sensei 可与任何静态分析工具配合使用。如果静态分析频繁报告相同违规，你可以将其条件复制到 Sensei 配方中，并添加快速修复功能，不仅能识别错误，还能助你快速写出正确的代码。