IntelliJ IDEA用の新しいStepik.orgプラグイン

9月に、PythonおよびJavaをサポートするIntelliJ IDEAのプラグインをリリースしました。 この記事では、開発プロセス、およびプラグインがStepik.orgでプログラミングする学生の生活を簡素化する理由について説明します。







このプラグインは、 Stepik TelegramボットやiOSおよびAndroid向けモバイルアプリケーションの場合のように、サンクトペテルブルクのコンピューターサイエンスセンターの学生である新しいインターンピーターボグダノフによって設計されました。

プラグインの目的

なぜそれをしたのですか？ もちろん、学生の日常生活を強制するのではなく、学生の生活を簡素化するために、学習プロセスに完全に集中できるようにします。



プラットフォームでプログラミングのコースを受講する際に学生が最初に遭遇する問題は、IDEからブラウザにコピーアンドペーストする必要があることです。 ブラウザでのプログラミングは簡単ではありません。コードを実行してローカルでチェックすることはできません。自動補完やリファクタリングなどはありません。 また、IDEでプログラミングするときは、タスクの状態を表示したり、サンプル入力をコピーしたりするために、常にブラウザを覗く必要があります。



2番目の問題は、プロジェクトでコードを整理する問題です。 生徒は、サンドボックスにコードを入力して、通常は現在の問題のみを解決し、次の問題をどこで解決するかを考えません。 そして、おそらく、学生は以前の決定を保存しないか、彼のファイルが「new_file」「new_file7」「new_file777」のように呼ばれます。 これはすべてナビゲーションを複雑にし、コードの再利用を困難にします。

開発プロセス

今年の6月に、Javaのみをサポートするプラグインをリリースし、プロジェクトマネージャーにログインし、コンテキストメニューを使用してStepik.orgと対話しました。 しかし、彼はまた、アーキテクチャに重大な欠陥がありました。



プログラミングを学ぶための便利なプラットフォームとして、できるだけ多くのプログラミング言語をサポートすることが重要です。 プラグインは条件付きで2つの部分に分割できます。サポートされている言語に依存せず（承認、APIとの対話、設定）、直接言語サポート（基本的にプロジェクトのビルド）です。



古いプラグインはモノリシックであったため、新しい言語のサポートを追加し、他のIDEの新しいプラグインを作成することはできませんでした。 したがって、 PyCharmチームからトレーニングプラグインのコアに切り替えることが決定されました。

詳細に検討してください：

• ユーザーデータを保存する
• 承認とネットワーク通信
• プロジェクトツリーの構築

ユーザーデータを保存する

再起動中にユーザーデータが失われないようにするには、保存する必要があります。 これを行うために、IDEAにはPersistentStateComponentインターフェイスがあり、これを使用して、目的のクラスを.xmlでシリアル化できます。 これはドキュメントには示されていませんが、 PersistentStateComponentを実装するクラスは、アプリケーションレベル、プロジェクトレベル、モジュールレベルの3つの方法のいずれかでインスタンス化する必要があるシングルトンであると理解されています。



前者の場合、シングルトンはプラグイン全体で唯一のものであり、グローバル設定をそこに保存するのが妥当です。

他の場合には、多くのシングルトーンがあり、それらは./.ideaでシリアル化されます。 ユーザーデータ（名前、トークンなど）、およびコースに関するほぼすべてのメタ情報を保存するのはプロジェクトレベルです。



合理的な質問は、開いているプロジェクトがない場合にデータを保存する場所です。 このような場合、IDEAには defaultProject があり、次のように取得できます。

ProjectManager.getInstance().getDefaultProject()
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

そこから、プロジェクトを作成するときに資格情報を取得します。そのため、設定に明示的にログインする前にすべてのプロジェクトを閉じるようにユーザーに要求します。



このインターフェイスは2つの方法で実装できます（ 詳細についてはドキュメントを参照）。さらに、レベルに応じて、このコンポーネントをplugin.xml（最も重要な.xml）で確実に宣言する必要があります。

 <projectService serviceInterface="com.jetbrains.edu.learning.StudyTaskManager" serviceImplementation="com.jetbrains.edu.learning.StudyTaskManager"/>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

一般に、IntelliJ APIからのインターフェイスを実装したら、plugin.xmlで宣言する必要があります。



また、パスワードを保存するために、組み込みのパスワードマネージャーPasswordSafeを使用できます。 次のウィンドウが表示されるのは、時々それに対する魅力のためです。

承認とネットワーク通信

Stepik.orgは、完全なOAuth 2認証をサポートしています。 ただし、プラグインでは、これまでのところログインとパスワードによる認証のみが実装されています。 redirected_urlをリッスンするには、サーバーをlocalhostに上げる必要があるという点で、他のタイプの認証に問題があります。



Stepikと通信するために、コアには既に多数の静的メソッドのセットを含むEduStepicConnectorクラスと、リクエストを実行するためのHttpClientインスタンスがありました。 このクラスは、4つのクラスに分割されることが決定されました。







Client InitはHttpClientを初期化し、証明書の検証に関する問題を解決します。 StepikにはLet's Encryptからの証明書があり、IdenTrus CAはJava 8u101でのみ追加されました。 StepikConnectorLoginは承認を担当します。 そして、残りのクラスは、承認を必要とするリクエストを作成できます。



このようなスキームでは、アクティブなクライアントは1つだけですが、許可されたクライアントのインスタンスを作成して、それを複数に拡張することは難しくありません。 ただし、Stepicaで二重の生活を送る学生にふれたくありません。

プロジェクトツリーの構築

プロジェクトツリーの構築は、プラグインの最初のバージョンに比べて大幅に変更されましたが、カーネルに対しては比較的弱いです。

これで、コースがダウンロードされ、キャッシュされ、キャッシュからのみ構築されます。 これは、プロジェクトの構築が遅いために実現されました。コース全体をダウンロードするには、約100件のリクエストを完了する必要があります。 ここでは、多くのIDをAPIへの1つのリクエストに結合することで、大幅な高速化を実現しました。



プラグインの6月バージョンはYandex.Translatorによってサポートされ、コース名、レッスン、セクションを英語に翻訳しました。 これは、Javaのパッケージ名が英語であり、特定のファイルがステップに対応するために必要でした。 そして、それは少し不快でした。 送信する前にファイルを編集する必要があり、追加の制限を課しました。



これで、ステップレベルがソースのあるディレクトリに対応するようになったため、これは不要になりました。 しかし、それでも、ディレクトリには現在作業名（lesson1 / task1）があり、 TreeStructreProviderの助けを借りて、ディレクトリ名の架空の置換があり、コースの言語で表示されます。





TreeStructureProviderのオン /オフ。



TreeStructureProviderは、。 / src / hideディレクトリも非表示にします。 このディレクトリには、異なる言語でステップテンプレートが保存されます。 また、言語を変更すると、ファイルが移動されます。

プラグインの依存関係

この写真は、JetBrainsのすべての教育用プラグインと、Stepikプラグインとその依存関係を示しています。 PyCharmのLilacプラグインが表示されます。 プラグインが機能するには、さらに3つのプラグインが必要であることがわかります。 Python依存関係はまだ正しく構成されていません（したがって、手動でインストールする必要があります）。 興味深いことに、CommunityとUltimate IDEAは異なるプラグインに依存しています。 Edu-IntelliJは、プロジェクトマネージャーの単なる拡張ポイントです。 おそらく、この依存関係を削除します。



また、カーネルへの主な依存関係は残っています。カーネルの現在の変更はまだ公式リポジトリにアップロードされていないため、不安定版を手動でインストールする必要があります。 この場合、Edu-JavaおよびEdu-Kotlinプラグインはまだ機能しません。

新しいUI

最初に追加したのは、設定での承認、GitHubです。







ただし、このアクションをまだスキップすると、より侵入的な承認が得られます。







プロジェクトを構築するとき、サブスクライブしているコースのリストからコースを選択できます。 しかし、これはそれらがすべてプラグインと互換性があるという意味ではありません。 エラーなしでコースを作成するには、プログラミングタスクを含む少なくとも1つのステップが必要です。







このウィンドウでは、目的のプログラミング言語を選択できますが、使用できない場合は、最も人気のある言語が選択されます。



参照によってコースをアンロードする機会はまだありますが、以前にコースにサブスクライブしていない場合は、サブスクリプションが発生します。 リンクフィールドに、コースIDまたはコースからのリンクを入力できます。



ステップのステータスはプロジェクトツリーに表示されます。







また、主なアクションは右側のタスクの説明パネルにあります。







その中には、ソリューションの送信、前/次のステップ、最初からやり直す（まだ利用できません）、最新のソリューションのダウンロード、言語の変更があります。

互換性

Stepik.orgには、特定のコースがサードパーティアプリケーションと互換性があるかどうかを理解するためのAPIがまだないので、すべてがどのように機能するかを想像すると便利です。



承認後、プラグインはプロジェクトツリーをダウンロードします。これにより、コースの開いている部分のすべてのステップに関する情報が収集されます。 次に、サポートされているステップのデータのみを保存します。 現時点では、これらは「コード」タイプのタスクのみです。 ただし、このタイプのタスクには特殊性があります-隠されたテンプレートを使用します。 隠しパターンは、ファイルの先頭と末尾に追加されるコードの一部です。 また、定義上、学生は利用できません。



Javaの例を考えてみましょう。 テンプレートを使用すると、教師は別のメソッドを実装するためのタスクを作成でき、メソッドはサーバー上の既存のクラスにラップされます。 したがって、すべてのJavaコードがクラスに含まれている必要があるため、学生は正しいソリューションをコンパイルしません。



しかし、良いニュースは、そのようなタスクがそれほど多くないことです。 ほとんどの場合、語学コースで見られます。

したがって、プラグインはアルゴリズムとHadoopの コースに最適です。

今後の計画

近い将来、さまざまなプログラミング言語のサポートを開発したいと考えています。 現時点では、R、ScalaをStepik Unionに簡単に追加できますが、たとえば、Haskellのサポートはまだ未熟です。 また、C ++ではさらに複雑になります。ここでは、CLion用に別のプラグインを作成する必要があります。



さらに、プラグインによる他のタイプのタスクのサポートの実装を検討しています。

謝辞

ヘルプと高品質のコアを提供してくれたPyCharmチームに感謝します。

おわりに

コメントやVKプラグインの作成者との議論で、プラグインに関する質問、フィードバック、提案、建設的な批判を喜んで受け取ります 。



リンク： Stepik.orgプラグイン 、 StepikOrg / intellij-community 、 Stepik APIドキュメント 、 IntelliJ Platform SDKドキュメント 、 IntelliJ Platform SDKドキュメントの リポジトリ