Armory-IntelliJ IDEAのプラグイン

こんにちは、Habrの読者の皆さん！ この記事では、IDEのインターフェイスの開発における理論的背景と既存の問題について説明します。最後に、Intellij IDEA開発環境のプラグインの形で作業の結果を理解することを提供します。

開発者向けに別のツールを作成することにした理由

長い間、私たちのチームは開発環境用の代替インターフェイスエルゴノミクスのアイデアを開発してきました。これにより、ボード上の多数のクラスとファイルを含む複雑で混乱したプロジェクトに簡単に対処できます。 まず、プログラマーとして、割り当てられたタスクに取り組む際の効率と満足度を高めることに関心がありました。 これは、新しいクラスの作成、コードの入力、既存のコードの学習、学習する適切な場所の検索、プロジェクトのさまざまな部分間の移動などの通常のプログラミングタスクを指します。



一言で言えば、この代替エルゴノミクスが解決すべき主なタスクは、次のように定式化できます。

• コード内の適切な場所またはツリー内の要素へのスクロール、ツリーのノードの展開、大きなリスト内の要素の視覚的検索など、日常的なアクションの数を減らします。
  
  
  
  
• 認知負荷の最小化。 プログラマーの問題を解決することはすでに知能とメモリに大きな負荷をかけるため、開発者に追加情報を覚えて分析するように要求するのは間違っています。 これは、仕事からの喜びのレベルを下げるだけでなく、生産性にも大きく影響します。
  
  
  
  
• 気晴らしの数を減らす。 可能であれば、現在のタスクに関係のない余分な情報を非表示にするか、視覚的な重みを小さくする必要があります。
  
  
  
  
• 自動化の再利用。 インターフェイスに何らかの新しいスキルの開発が含まれる場合、このスキルはできるだけ多く使用する必要があります。
  
  

これらの各ポイントについて詳しく説明します。

日常的な活動を減らす

実験中、生産性はターゲットコードセクションへのアクセス時間によって大きく影響を受けることが判明しました。 さらに、この影響は、一見すると思われるような線形関数ではなく、ある種の放物線によって表されます。









非線形依存性の説明は、明らかに人間の短期記憶の特性にあります。 開発環境が、大切な数秒でコードの目的のセクションにアクセスすることを許可せず、短期メモリがまだ「生きている」場合、ほとんどの場合、開発者は頭の中のタスクコンテキストを復元するためにしばらくの間、スイッチバックまたは「考える」ことを余儀なくされます。 確かに誰もが同じクラスで同じメソッドを見つけたときの状況に精通していますが、なぜそれを探したのかを完全に忘れていました。 アクセス時間と作業効率の間のこの関係のプラス面は、検索時間のわずかな減少でさえ、全体の結果に大きく影響することです。



アクセス時間を短縮するという問題を解決するために提案する重要な合理化は、複数のプロジェクトツリーの使用です。 使い慣れた1つのツリーの代わりに、任意の数のプロジェクトツリーを使用することをお勧めします。各プロジェクトツリーは、構造の特定のブランチで構成できます。 このアプローチにより、特定のニーズに合わせてプロジェクトの「デスクトップ」を微調整し、すべてが手元にあるように要素を配置できます。

気晴らしを減らす

検索時間とその実装に必要な動きの数だけでなく、ユーザーの全体的な認知負荷に影響します。 もう1つの重要な要素は、無関係な情報によるワークスペースの混雑です。 もちろん、特に開発環境を使用するさまざまな方法を考慮すると、現在どのオブジェクトが主なものであり、どのオブジェクトが関連せず、干渉源に過ぎないかを判断するのはそれほど簡単ではありません。 それにもかかわらず、開発者に不要なものを隠す能力を与えることは、私たちにとって非常に重要な仕事のようです。



コード編集レベルでは、現在のクラスメソッドを除くすべての周囲のコードを非表示にすると、良い結果が得られました。 これにより、このクラスの残りのコードの存在をしばらく忘れて、現在のメソッドの完成または研究に集中することができます。



プロジェクトツリーのナビゲーションレベルでは、いわゆるビジュアルグループの現在のタスクに関係のない要素を非表示にすることで、良い結果が得られました。 グループは、フォルダーやクラスとは異なり、プロジェクトの構造には影響しませんが、適切な視覚的レイアウトを迅速かつ簡単に作成して優先順位を付けることができます。



マイナーな要素を隠すことに加えて、視覚的なアクセント（太字、斜体、下線など）を使用して重要な部分を強調するために、正確に反対側からアプローチすることが役立つ場合があります。 このようなメモを使用すると、木の枝を閲覧しているときに目を引き、意味のある何かを思い出すことができます。

オートメーションの再利用

頻繁に使用される要素への迅速なアクセスの編成に関する最も明白な一見した決定でさえ、ユーザーの開発した自動化が申し立てられた単純さを引き継ぐという事実のために失敗する運命にあります。 この種の失敗の例は、Windows開発者が、この目的のために特別に設計されたフォルダー「Pictures」、「Music」、および「Video」にマルチメディアファイルを配置する提案です。 なぜこれがうまく機能しないのですか？ 事実、ユーザーはオペレーティングシステムの作成者によって丁寧に作成された、この目的のために特別に設計されたディレクトリの存在を覚えているよりも、新しいフォルダを作成して音楽を入れるというおなじみの普遍的なスキルを使用します。 そして、この動作は非常に合理的です。 問題を解決する新しい方法を学ぶことは、常に時間と労力の追加の支出に関連付けられます。このスキルがかなり狭い範囲のタスクでのみ有用である場合、それをマスターして最新の状態に保つコストは、結果によって正当化されない可能性が非常に高いです結果として受信されます。



したがって、インターフェイスを開発するとき、私たちが提案した作業を整理するためのすべてのアイデアがユーザーの間ですぐに承認されると期待するのは単純です。 さらに、新しいスキルを習得するか、新しい情報を記憶することを申し出た場合、これは真に正当化されるべきであり、このスキルは可能な限り普遍的でなければなりません。



このため、お気に入りを個別のダイアログまたはコンポーネントとして使用することは好ましくありませんでした。 代わりに、各プロジェクトツリーを、特定の目的のために開発者が選択した必要なクラスまたはパッケージのセットに、手首を軽く動かすだけで変換するようにします。 したがって、ツリーを調整する普遍的なスキルは、プロセスで繰り返し使用できます。 さらに、これにより、コンテキストで選択さ れたものを支持して、 単一の グローバル 選択されたものの原則から離れることができます 。

実装

上記の原則を実装する最初の開発環境は、1996年にVisual Programming Armoryという名前で登場しました。 当時、C ++は私たちにとって最も関連性のある言語であり、Java時代の未来の開花はまだ始まったばかりでした。 開発環境は、オブジェクトリレーショナルサブシステム、モデリング用アドイン、およびその他の独自のツールを含む、さまざまなプログラミング言語のプラグインサポートを備えたWindows用のスタンドアロンアプリケーションでした。









多くの作業が行われ、多くのアイデアが実装されましたが、残念なことに、不可抗力の状況によりプロジェクトは2001年に削減されました。



それにもかかわらず、私たちは個人使用のためにアーモリーを改善し続けました。 開発をスピードアップして収益を上げることができるツールを放棄することは困難です。



その間、進歩は止まりませんでした。 オートコンプリート、使用方法の検索、Ctrl +クリックによるコード内のナビゲーション、およびさまざまな種類のスマート検索が、一般的なIDEの標準になりつつあります。



2001年にIntelliJ IDEAが登場し、ゆっくりと、しかし確実にプログラマの心をつかみ始めました。 予測コード分析は、コンパイル前でもエラーを見つけるのに役立ち、リファクタリングツールを使用すると、開発者はプログラムのソースコードをすばやく再編成できます。 ここでは、JetBrainsにクレジットを付与する必要があります。ソースコード要素の完全な構造を作成し、いわゆるPsiオブジェクトの階層に反映させるという素晴らしい仕事をしました。 この抽象モデルに基づいて、コード検査、コード分析、マイクロリファクタリング、およびプロジェクトツリーの表示を実行できるようになります。



この素晴らしい開発環境（Intellij IDEA）に対する私たちの愛にもかかわらず、特に人間工学に基づいたワークスペースの編成で得られた経験を考えると、私たちにはあまり適さないものがありました。



疑問が生じました。古いアーマリーの人間工学とIDEAの知能を組み合わせることは可能ですか？ IntelliJ Platform SDKのソースコードを検討した結果、Open APIは開発環境のすべての主要機能へのアクセスを提供し、そのような組み合わせが非常に可能であることがわかりました。 最も先進的なエディターのすべての機能を使用するための便利なツールを手に入れる見込みがあり、私たちはそれを開発者コミュニティと共有しないのではないかと考えました。



作業の結果、JetBrains製品のプラグイン-Armory-が登場しました。 プラグインはIntelliJ IDEA Community Editionに対して完全に無料であり、このプラットフォームでJava、Scala、Groovyなどの言語をサポートします。

Armoryプラグインの使用方法

プラグインは、公式のJetBrains プラグインリポジトリから、またはプログラムWebサイトのダウンロードページからインストールできます。 プラグインの配布はまったく同じです。唯一の違いは、更新が1日か2日早くサイトに表示されることです。 これは、JetBrainsプラグインリポジトリに更新プログラムを公開した後、モデレートを行う必要があるためです。



プラグインをインストールしてIDEAを再起動すると、Armoryタブが右側に表示されます（左ペインのプロジェクトウィンドウのタブに似ています）。 プロジェクトツリー自体、ツールバー、ツリー内の選択されたアイテムに関する情報のパネルを含む、プラグインのメイン作業ウィンドウを開く場所をクリックします。 IDEAのすべてのツールウィンドウと同様に、アーモリーウィンドウはいくつかのモードで動作できます：ピン留め、フローティング、ドッキング。 ツールウィンドウの管理の詳細については、 こちらをご覧ください 。 デフォルトでは、ドッキングモードは固定モードとともに設定されます。 ドッキングモードとは、プラグインウィンドウが開いたときに他のIDEコンポーネントのワークスペースを「食い込ませる」ことを意味します。 ピン留めモードでは、入力フォーカスが失われたときにArmoryウィンドウが自動的に非表示になりません。 ここでは、目的のモードの組み合わせを設定して、この動作を好みに合わせてカスタマイズしたり、モニターのサイズを変更したりできます。



これで、ワークスペースをセットアップする準備が整いました。 アニメーションに示すように、フォルダー、パッケージ、またはクラスを特別なドロップゾーンにドラッグすることで、新しいプロジェクトツリーを作成できます。









プログラムのヘルプで、新しいツリーを追加する他の方法について読むことができます。



ここで、プロジェクトツリーとエディター間のナビゲーションについて個別に言及する価値があります。 実際、ビルトインのプロジェクトビューコンポーネントとは異なり、アーマリーウィンドウの水平サイズははるかに大きくなっています。 その理由は明らかです。ここでは、1つのツリーではなく、一度に複数のツリーを扱います。 これに関連して、エディターのナビゲーションアルゴリズムも変更されています。 デフォルトでは、ArmoryはキーボードショートカットCtrl + Enterを使用して、ツリーからエディターへ、またはその逆にナビゲートします。 何らかの理由で、エディターでこの組み合わせを使用してカーソルを移動せずに改行を挿入することに慣れている場合（これはIDEAのデフォルトの目的です）、プラグイン設定でこのキーボードショートカットを変更できます。









気づいた場合、プロジェクトツリーからクラスメソッドを開くと、エディターはクラス全体ではなく、現在のメソッドのコードのみを表示します。 実際、現在のメソッドの前後のすべてのコードは、2つの折りたたみ領域によって折りたたまれています。 クラス全体を表示するには、エディターで[ エスケープ]を 2回押します。 プラグインの設定では、この動作を変更することもできます。たとえば、周囲のコードを折りたたむ代わりに、指定した背景色で強調表示することを選択できます。



Ctrl + Enterでエディターに移動すると、Armoryウィンドウが閉じることに注意してください 。 十分な大きさのモニターがあり、エディターに行くときにツリーでウィンドウを閉じたくない場合は、IDEAの標準ナビゲーションキーを使用できます。

• Enter-エディターでフォーカスを設定せずに要素のソースコードを開きます。
• F4またはダブルクリック -エディターでフォーカスのある要素のソースコードを開きます 。
  
  
  
  

この基本情報は、プラグインの使用を開始し、いくつかのツリーを使用することですでに一定の利益を得るのに十分です。 次に、各プロジェクトツリーをさらに微調整し、要素のグループを作成することを検討します。

ツリーのルート要素の構成

上記からわかるように、Armoryツリーには、プロジェクト構造内の特定のノードを指すルート要素が含まれている場合があります。 さらに、各ツリーには、プロジェクト内のさまざまな場所を指すそのようなルート要素がいくつか含まれている場合があります。 これは、ツリーをお気に入りとして構成し、ソースコードのさまざまなコーナーから特定のクラスまたはパッケージを収集する場合に役立ちます。 ツリーのルートとして要素を追加するには、次のアニメーションに示すように、この要素をツリーヘッダーの特別な領域にドラッグするだけです。









要素をルートとして追加するには、キーボードを使用してCtrl +上矢印を押し、キーボードの矢印を使用して、このルート要素を追加するツリーを指定します。



ツリーからルート要素を削除することも、ヘッダー領域にプルするか、ホットキーCtrl + Deleteを使用して実行されます。



Armoryのすべてのコマンドは、Armoryのコンテキストメニューから利用できます。 Ctrl +右クリックまたはキーボードショートカットCtrl + Menuを押すことで呼び出すことができます 。











このアプローチでは、両方のメニュー（標準のIDEAコンテキストメニューとプラグインコンテキストメニュー）が常に手元にあります。

グルーピング

ツリー要素のグループ化は、多数の定数と変数を持つクラス内の順序を復元するために不可欠なツールです。 さらに、いくつかのクラスメソッドを分離し、その意味に従ってグループ化するために使用すると便利です。 ファイル、フォルダー、パッケージなど、ツリーの任意の要素をグループ化できます。









このようなグループ化は、ソースコードを揺るがすことはなく、視覚的にのみ行われます。 グループを削除すると、そのグループに含まれるすべての要素がグループ解除されます。 マウスを使用せずに選択したアイテムをグループ化するには、ホットキーCtrl + Alt + Page Downを使用します。 グループ解除の場合-Ctrl + Alt + Page Up 。

ツリー内のアイテムを並べ替える

ツリー内の要素の順序は、現在の並べ替えスキームによって決まります。 要素の順序を変更するには、定義済みの並べ替えスキームのいずれかを選択するか、プラグイン設定で新しい並べ替えスキームを作成します。 次の図は、ツールバーのボタンを使用して並べ替えスキームを切り替える方法を示しています。









プラグインのヘルプで、新しいソートスキームの作成方法と既存のスキームの編集方法について読むことができます。

アクセントツリー要素

前述のように、グループ内のマイナー要素を非表示にするか、ルート要素を設定してツリーの可視性の外側に移動することに加えて、重要な要素を視覚的に強調表示することも役立ちます。 現時点では、Armoryは3つのスタイルの強調表示をサポートしています。太字、斜体、下線です。 これらの組み合わせも許容されます。 エディターで一般的に受け入れられているキーの組み合わせは、エレメントを選択するために使用されます： Ctrl + B 、 Ctrl + IおよびCtrl +U。 Armoryコンテキストメニューからスタイルを適用することもできます。









写真はArmoryのコンテキストメニューを示し、左側はさまざまなスタイルで強調表示された要素の外観の例です。

おわりに

結論として、上記のすべてのテクニックは、ある程度のトレーニングと中毒の後、驚くべき結果をもたらします。 その状態を記憶するソースコードの「マップ」を手元に置き、ユーザーが「余白に」メモすることで、前の作業のコンテキストを非常にすばやく呼び出して行動を開始できます。 時間を節約します。 注意と強さを保存します。



これは、何時間も街を歩き回る代わりに、マップ上の目的のポイントをクリックするだけで、即座にテレポートできるようになるという事実と比較することができます。



このプラグインがあなたに利益をもたらし、あなたの仕事の信頼できるアシスタントになることを願っています。



記事に記載されていることについてご意見がある場合、何かに同意できない場合、またはプログラムを改善するための提案がある場合は、コメントで共有してください。



ご清聴ありがとうございました。

参照資料

• Armory Pluginサポートフォーラム
• 開発者サイトのプラグインページ
• JetBrainsリポジトリのプラグインページ