Codiga 是一款面向开发团队和个人开发者的实时代码静态分析工具，支持主流 IDE 与代码托管平台，专注于代码质量与安全问题的自动检测与修复。通过可视化规则配置和 Codiga Hub，用户可以在几分钟内创建并共享自定义规则，将团队最佳实践固化到日常开发流程中。

产品详细介绍

Codiga 提供从本地 IDE 到远程 CI/CD 全链路的静态代码分析能力，帮助开发者在编码阶段就发现潜在问题，减少后期修复成本，并显著提升代码安全性与可维护性。

核心特性

  1. 实时代码静态分析（Real-Time Static Code Analysis）

    • 在 VS Code、JetBrains、Visual Studio 等 IDE 中实时运行。
    • 开发者在输入代码的同时即可获得问题提示与修复建议。
    • 支持多种语言和框架的常见错误、坏味道和风格问题检测。

  2. 跨平台与全流程集成

    • 支持 VS Code、JetBrains、Visual Studio 等主流 IDE。
    • 支持 GitHub、GitLab、Bitbucket 等代码托管平台。
    • 可集成到 CI/CD 流水线中，在代码合并和发布前自动执行分析。
    • 适用于个人开发、本地开发、代码评审和持续集成等多种场景。

  3. 自动修复（Autofix）

    • 对检测到的部分问题提供一键修复能力。
    • 自动生成修复补丁，开发者只需确认即可应用。
    • 降低重复性修复工作量，提升团队整体开发效率。

  4. 安全分析与合规（Security-focused）

    • 覆盖 OWASP Top 10、MITRE CWE、SANS/CWE Top 25 等主流安全标准。
    • 自动识别常见安全漏洞，如注入、XSS、不安全反序列化、弱加密等。
    • 帮助团队在日常开发中持续落实安全编码规范，降低安全风险。

  5. 自定义规则与 Codiga Hub

    • 通过 Codiga Hub 在浏览器中快速创建、测试和管理静态分析规则。
    • 无需复杂配置，几分钟内即可完成自定义规则设计。
    • 支持将规则分享给团队或社区，实现统一的代码规范与最佳实践。
    • 可复用社区已有规则，快速搭建适合自身项目的规则集。

  6. 自动化代码评审（Automated Code Reviews）

    • 在 Pull Request 或 Merge Request 中自动运行分析。
    • 将检测结果直接展示在代码评审界面，辅助 Reviewer 快速定位问题。
    • 减少人工审查的重复劳动，让评审更聚焦于架构与业务逻辑。

  7. 代码片段与复用（Code Snippets）

    • 支持管理和复用常用代码片段。
    • 结合规则与片段，可将安全、规范的实现方式固化为模板，降低新成员上手成本。

简单使用教程

一、基础使用流程概览

  1. 在 IDE 中安装 Codiga 插件或扩展。
  2. 登录或关联 Codiga 账号。
  3. 打开项目后，Codiga 自动对当前文件进行静态分析。
  4. 根据提示查看问题详情，并使用一键修复（如可用）。
  5. 在 Codiga Hub 中创建或启用适合团队的规则集。
  6. 在 GitHub/GitLab/Bitbucket 或 CI/CD 中启用 Codiga 分析，实现自动化代码评审。

二、在 IDE 中启用实时代码分析

  1. 安装扩展/插件

    • VS Code：在扩展市场搜索“Codiga”，点击安装。
    • JetBrains 系列（IntelliJ、PyCharm 等）：在插件市场搜索“Codiga”并安装。
    • Visual Studio：在扩展管理器中搜索“Codiga”进行安装。

  2. 登录与配置

    • 安装完成后，在 IDE 中找到 Codiga 面板或设置入口。
    • 使用 Codiga 账号登录，或通过浏览器完成授权。
    • 选择默认规则集（可使用官方推荐规则或团队自定义规则）。

  3. 实时查看分析结果

    • 打开项目文件开始编码，Codiga 会在保存或输入时自动分析。
    • 问题会以下划线、高亮或图标形式显示在编辑器中。
    • 悬停或点击提示可查看问题描述、风险等级和修复建议。

  4. 使用自动修复（Autofix）

    • 对支持自动修复的问题，Codiga 会提供“Fix”或类似操作按钮。
    • 点击后自动生成修改方案，确认后应用到代码中。
    • 建议在提交前统一运行一次分析，确保主要问题已修复。

三、在 Codiga Hub 中创建自定义规则

  1. 访问 Codiga Hub

    • 使用浏览器打开 Codiga 网站并登录账号。
    • 进入 Codiga Hub 或 Rules 管理页面。

  2. 创建新规则

    • 点击“Create Rule”或类似按钮。
    • 选择目标语言（如 Java、Python、JavaScript 等）。
    • 定义要匹配的代码模式、触发条件和问题描述。
    • 可设置严重级别（如 Info、Warning、Error）和分类（安全、性能、风格等）。

  3. 测试与发布规则

    • 在浏览器中使用示例代码测试规则匹配效果。
    • 调整规则直到结果符合预期。
    • 保存并发布规则，可选择仅自己可见或团队共享。
    • 在 IDE 或项目配置中启用该规则集，使其在日常开发中生效。

四、在代码托管与 CI/CD 中使用 Codiga

  1. GitHub/GitLab/Bitbucket 集成

    • 在 Codiga 网站中添加对应代码仓库或组织。
    • 按向导完成授权与安装应用/插件。
    • 配置在 Pull Request 或 Merge Request 创建/更新时自动运行分析。

  2. CI/CD 流水线集成

    • 在 CI 配置文件（如 GitHub Actions、GitLab CI、Jenkins 等）中加入 Codiga 分析步骤。
    • 设置在构建或测试阶段前后执行静态分析。
    • 根据分析结果决定是否阻止合并或发布（例如：存在高危安全问题时失败流水线）。

常见问题 FAQ

1. Codiga 支持哪些开发环境？
Codiga 支持 VS Code、JetBrains 系列 IDE、Visual Studio，并可与 GitHub、GitLab、Bitbucket 等代码托管平台集成，同时也可嵌入 CI/CD 流水线中使用。

2. 是否可以自定义静态分析规则？
可以。通过 Codiga Hub，用户可以在浏览器中创建、测试和管理自定义规则，并将其分享给团队或社区，几分钟内即可完成规则设计与应用。

3. Codiga 能检测哪些安全问题？
Codiga 覆盖 OWASP Top 10、MITRE CWE、SANS/CWE Top 25 等主流安全标准，可检测常见的安全漏洞和不安全编码模式，帮助团队提升整体安全水平。

4. 自动修复是否会影响业务逻辑？
自动修复主要针对格式、风格、简单缺陷和部分安全问题的标准化修复方案。建议开发者在应用自动修复前查看变更内容，确保与业务逻辑一致。

5. 团队如何统一使用同一套规则？
团队可以在 Codiga Hub 中创建或选择一套规则集，并将其设为组织或项目的默认规则。成员在 IDE 或仓库中启用该规则集后，即可在整个团队范围内统一代码规范与安全标准。