Qodana logo

Qodana

The code quality platform for teams

Opinion

压力下的代码质量:通过基于 IntelliJ 的 IDE 中的 Qodana 集成为开发者提供支持

开发者面对的需求时常增加,紧迫的期限往往意味着重量不重质,同时还要被迫以更少的资源做更多的事。 

在应用程序(例如 CI 解决方案和 IDE)之间切换时,还存在上下文切换的问题。 由此,即使是代码质量这样的大事也可能会被忽视。

那么,怎样才能获得支持来切实应对期限、专注于手头工作,并将代码质量作为关键事项优先考量? 答案就是使用 JetBrains Qodana。 

什么是 Qodana?

Qodana 是一个静态代码分析平台,有助于直接在 IDE 中提高代码质量。 将代码扫描作为 CI 管道的一部分自动执行可以帮助专业软件开发者节省代码验证时间。 

因此,Qodana 使质量门可以在这些管道中更易使用,确保代码符合团队定义的标准。 Qodana 提供的代码检查以 JetBrains 20 多年的软件开发经验为基础。

检查包括但不限于安全扫描和第三方许可证审核,使开发者能够了解项目的概括状态,并快速分类、确定优先级并首先解决关键问题。 

静态分析很容易入门。 如果您刚接触 Qodana,可以直接从 IDE 运行第一次扫描,并快速查看本地检查的结果。 接下来,您可以使用 CI 向导将 Qodana 添加到管道。 我们来看看该如何开始。 

使用 Qodana IDE 插件简化设置 

在下面的视频中,Anton Arhipov(我们的技术布道师)将引导您完成 Qodana 的设置过程。 如需分步说明,请观看视频。

 

在 Anton 的演示中,IDE 为 IntelliJ IDEA。 不过,Qodana 已经与许多您喜爱的 IDE 捆绑,开箱即用。 我们目前支持 IntelliJ IDEAPhpStormGoLandRiderWebStormPyCharm。 其他 JetBrains IDE 将很快添加! 

您还可以将 Qodana 添加到 CI/CD 管道

Qodana IDE 插件可以帮助您将 Qodana 添加到 CI 管道,以便及早发现问题。 转到 Tools(工具)菜单,选择 Qodana,然后向 CI 管道选择 Add Qodana(添加 Qodana)。 向导将为您选择的 CI 服务器生成配置文件。 例如,点击 GitHub Actions 的 Add(添加)按钮,工作流配置文件就会在项目中创建。 还有适用于其他 CI 服务器(例如 TeamCity、GitLab CI/CD、Jenkins 等)的帮助程序。 

留在 IDE 中、访问问题并更快实现修正

Qodana IDE 插件会将结果直接传递到 IDE 中,当您浏览问题报告时,直接在代码中高亮显示问题。 您还可以使用 Qodana 直接查看失败的检查和漏洞。 

当 CI 管道中新的代码扫描报告准备就绪时,Qodana 还可以发出通知,让您开始修正 IDE 中标记的问题。 

减少上下文和应用切换,实现更深入的专注

基于反馈,我们得知在标签页之间切换通常意味着失去专注,降低效率,这在交期紧张的情况下尤其明显。 无法集中注意力时,工作也需要更长时间,而企业通常无法为质量反馈及其实现留出足够的时间。

如果待办列表很长并且截止日期较为严格,解决方案似乎相当有限。 不过,借助插件即时访问 Qodana,您可以消除多任务处理所产生的噪音,完全保持专注。 两种工具始终触手可及 – 您无需离开 IDE。

您还可以在 CI/CD 系统(如 GitHub Actions)或 Qodana Cloud 中访问 Qodana 报告,并使用 Open in IDE(在 IDE 中打开)按钮快速访问。 这意味着可以通过多种方式集中编码任务并突出代码质量,同时保持流程简单。 

准备好开始了吗? 

尝试 Qodana 的 60 天免费试用! 或者,使用 Qodana Ultimate Plus 的五折优惠,每位开发者仅 7.50 美元起。 如果您有任何疑问或需要帮助,请点击屏幕右上角的 New Issue(新建问题)向 YouTrack 中的问题跟踪器提交工单,或在下方留言。 您也可以在 Twitter 上或发送电子邮件至 qodana-support@jetbrains.com 与我们联系。

免费试用 Qodana!

本博文英文原作者:

Opinion

プレッシャー下におけるコード品質確保: IntelliJ ベース IDE での Qodana 統合で開発者をサポート

開発者への要求は絶えず増え続けています。常に少ない時間でより多くの作業を完了するように求められる一方で、締め切りが切迫しているほど品質よりも量が優先されてしまうことがよくあります。

このような場合、CI ソリューションと IDE などの複数のアプリケーションを切り替える際にコンテキスト切り替えの問題が発生します。 これを踏まえると、コード品質のように重要なものでさえ見過ごされる可能性があることは容易に理解できます。

では、どうすれば現実的に締め切りを守りながら作業に集中し、コードの品質を重視して優先するのに必要な支援を得られるのでしょうか? その答えは、JetBrains Qodana を使用することにあります。

Qodana とは?

Qodana は IDE 内で直接コードの品質を改善するのに役立つ静的コード解析プラットフォームです。 コードスキャンを CI パイプラインに組み込んで自動化することで、プロのソフトウェア開発者が時間を節約できるようにします。

これにより、Qodana はこのようなパイプラインでより簡単にクオリティゲートを使用し、チームが定義した標準にコードを確実に準拠できるようにしています。 Qodana には JetBrains の 20 年を超えるソフトウェア開発の経験を基に作られたコードインスペクションが備わっています。

このようなインスペクションにはセキュリティスキャンとサードパーティライセンスの監査などが含まれているため、開発者はプロジェクトの状態を俯瞰し、素早くトリアージし、優先順位を付け、重大な課題から先に解決することができます。

静的解析は簡単に始められます。 Qodana を初めて使用する場合は IDE から直接初回のスキャンを実行し、ローカルチェックの結果を素早く確認することができます。 次に、CI ウィザードを使用して Qodana をパイプラインに追加できます。 それでは、その手順を見てみましょう。

Qodana IDE プラグインによるセットアップの合理化 

以下の動画では、Anton Arhipov(JetBrains のデベロッパーアドボケイト)が Qodana のセットアッププロセスを説明しています。 詳細な手順を確認したい方はこの動画をご覧ください。

Anton のデモで使用されている IDE は IntelliJ IDEA です。 ただし、Qodana は IDE の多くに初期状態でバンドルされています。 現在は IntelliJ IDEAPhpStormGoLandRiderWebStormPyCharm をサポートしています。 その他の JetBrains IDE も近日中に追加される予定です!

Qodana を CI/CD パイプラインに追加することも可能

Qodana IDE プラグインを使用すると、Qodana を CI パイプラインに追加して課題を早期に検出することができます。 Tools(ツール)メニューを開き、Qodana を選択して、CI パイプラインに Add Qodana(Qodana を追加)します。 すると、ウィザードによって選択した CI サーバー用の構成ファイルが生成されます。 たとえば、GitHub Actions の Add (追加)ボタンをクリックするだけでワークフロー構成ファイルがプロジェクトに作成されます。 TeamCity、GitLab CI/CD、Jenkins など、その他の CI サーバー用のヘルパーもあります。

IDE 内で課題にアクセスし、より素早く修正を実装

Qodana IDE プラグインは結果を IDE に直接送信します。課題レポートを確認すると、直接コードに問題がハイライトされているのが分かります。 Qodana を使用して失敗したチェックと脆弱性をすぐに確認することもできます。

Qodana では CI パイプラインで新しいコードスキャンレポートの準備が完了した際に通知を受け取り、IDE 内でフラグのついた課題の修正に着手することもできます。

コンテキストとアプリの切り替え操作回数を減らして集中力をアップ

タブの切り替えによって集中力が途切れ、特に納品のプレッシャーがかかっている場合にはパフォーマンスが低下することがあるとのフィードバックをいただきました。 集中できなければ作業の完了にかかる時間が増えるため、時間の無駄にもなります。また、企業が品質関連のフィードバックを得てそれを取り込む時間を考慮していないこともよくあります。

ToDo リストに多数の項目があり、厳しい締め切りが設定されている場合は解決策が限られているように思えるかもしれません。 しかし、プラグインを使用して Qodana にすぐにアクセスすればマルチタスクに起因する雑音を消せるため、作業中に完全に「ゾーン状態」を維持できます。 どちらのツールも常にすぐに使用できるため、IDE から離れる必要はありません。

Qodana のレポートは GitHub Actions などの CI/CD システム内または Qodana Cloud 内からでもアクセス可能で、Open in IDE(IDE で開く)ボタンを使用して素早くアクセスできます。 このように、単純なワークフローでコーディングタスクに集中してコード品質を重視する方法は豊富にあります。

始める準備はできましたか? 

Qodana の無料 60 日間体験版をお試しください! または、Qodana Ultimate Plus を 50% オフで入手できます。開発者 1 人あたりわずか ¥900 からご利用いただけます。 ご質問がある場合や作業中にサポートが必要になった場合は、画面の右上にある New Issue(新しい課題)をクリックして YouTrack の課題トラッカーにチケットを提出してください。コメント欄でも受け付けています。 X(旧 Twitter) で弊社をタグ付けするか、qodana-support@jetbrains.com にお問い合わせいただくことも可能です。

Qodana を無料で試す!

オリジナル(英語)ブログ投稿記事の作者: