IntelliJ IDEAのパッケージ検索プラグインとパッケージ検索サイト

概要

IntelliJ IDEAにはパッケージ検索 (Package Search) という依存ライブラリを検索してプロジェクトへ追加するプラグインがあります。
Mavenプロジェクトに依存ライブラリを追加する場合、[Maven Repository] (https://mvnrepository.com/)というサイトを利用することがありますが、このプラグインを利用するとIntelliJ IDEAの操作だけで簡単に依存ライブラリを探しプロジェクトを追加することができます。

• [Package Search] (https://plugins.jetbrains.com/plugin/12507-package-search)

Find and manage dependencies for JVM and Kotlin Multiplatform projects. Supports Maven and Gradle projects.

この記事は、以下のコーディング中にGsonをMavenプロジェクトに追加するという想定で、パッケージ検索プラグインを利用する場合と利用しない場合の操作手順の違いを比較する形でまとめました。

public class MyProjectService {

  public MyProjectService() {
    Gson gson = new GsonBuilder().setPrettyPrinting().disableHtmlEscaping().create();
  }

}

環境

• Windows 10 Professional 1903
• IntelliJ IDEA 2019.3.4

参考

• [Package Search on the Web] (https://blog.jetbrains.com/idea/2020/04/package-search-on-the-web/)

パッケージ検索プラグインを利用しない場合

Gsonという部分でクイックフィックス (Ctrl + Enter) すると、図のメニューが表示されるので、この中のAdd Maven Dependency...を選択します。

Maven Artifact Search画面が開くので、Search for artifactタブの検索フィールドにGsonと入力してEnterを押します。
検索結果からcom.google.code.gson:gson:2.8.6を選択しAddボタンをクリックします。

バージョンを変えたい場合、com.google.code.gson:gson:2.8.6をクリックするとバージョンの一覧が展開されるので、任意のバージョンを選択します。

Mavenの場合は自動的にpom.xmlファイルの依存関係にGsonが追加されます。

以上がパッケージ検索プラグインを利用しない場合の操作です。

パッケージ検索プラグインを利用する場合

プラグインのインストール

マーケットプレイスから"package search"という検索文字でプラグインを探しインストールします。

Gsonという部分でクイックフィックス (Ctrl + Enter) すると、図のメニューが表示されます。この中にPackage Searchが追加されているのでこれを選択します。

packagesビューが開きGsonで検索した結果が表示されます。この中からcom.google.code.gson:gsonを選択します。

すると右側に選択した依存ライブラリの詳細が表示されます。ここでバージョンやスコープを確認もしくは変更し、緑色の＋アイコンをクリックします。

Mavenの場合は自動的にpom.xmlファイルの依存関係にGsonが追加されます。

以上がパッケージ検索プラグインを利用した場合の操作です。

packagesビューについて

ちなみにpackagesビューは依存ライブラリの検索と追加だけではなく、プロジェクトの依存ライブラリを管理することができます。
packagesビューを開くと、図の左側にそのプロジェクトの依存ライブラリが一覧で表示されます。依存ライブラリに新しいバージョンがある場合はそのバージョンが表示されます。また依存ライブラリを除去することも可能です。
このように直接プロジェクトファイルを開いて編集することなく、プロジェクトの依存ライブラリを管理することが可能になっています。

パッケージ検索サイトを利用する

パッケージ検索プラグインの他に、同じ検索機能を持つ[Package Search | JetBrains] (https://package-search.jetbrains.com/)というウェブサイトがあります。このサイトはIntelliJ IDEAのパッケージ検索プラグインに連携しています。

依存ライブラリの検索

検索フィールドにGsonと入力して検索すると候補が表示されます。この中からcom.google.code.gsonを選択します。

パッケージ検索プラグインをインストールしていない場合

依存ライブラリの詳細が表示されます。パッケージ検索プラグインをインストールしていない場合は、このページの下に表示されているコードをコピーしてpom.xmlへペーストします。

パッケージ検索プラグインをインストールしている場合

IntelliJ IDEAにパッケージ検索プラグインがインストールされており、且つIntelliJ IDEAで対象のプロジェクトを開いている状態だと、右上のAdd projectボタンをクリックして依存ライブラリを自動的にプロジェクトへ追加できます。

ボタンをクリックするとプロジェクト名 (この例ではdemo-java13-webfluxがプロジェクト名) が表示されるのでクリックします。

あとは検索プラグインを利用したときと同様の操作になります。
IntelliJ IDEAのpackagesビューに反映されるので、この依存ライブラリで問題なければ緑色の＋アイコンをクリックしてプロジェクトへ追加します。

まとめ

プロジェクトファイルの依存関係の管理にパッケージ検索プラグインを利用すると、プロジェクトファイルをエディタで編集する必要がなくなり、すべてIntellij IDEAのUI操作で完結することができます。
この記事ではMavenプロジェクトを例に取り上げましたが、Gradleプロジェクトでも同じことができます。