12.4. STSの設定手順¶

Spring Tool Suite(以降STSと呼ぶ)とは、EclipseをベースにSpringでの開発に適した機能が組み込まれている統合開発環境である。

本章ではMacchinetta Server Framework (1.x)で解説するアプリケーション開発に適した設定方法について解説する。

なお、以降の解説はJava、Maven及びアプリケーションサーバーがインストールされていることを前提としている。これらのインストール手順については各自で調査されたい。

12.4.1. Spring Tool Suite とは ¶

STSはSpring Bootでの開発に適したツールとして作成されている。

Spring Bootを使用しないSpringアプリケーション開発に対しては不足している機能があるため、不足部分の補完方法についてこの章で解説していく。

12.4.2. STSの導入手順 ¶

12.4.2.1. STSの導入 ¶

STS本体はSTSの公式ページから取得することができる。

過去のバージョンのSTSを使用したい場合はSTSのGitHubからダウンロードされたい。

なお、以下で紹介する導入手順はWindowsを前提としているため注意されたい。

ダウンロードした「spring-tools-for-eclipse-xxx.zip」を任意のフォルダに展開する。展開されたフォルダ内の「SpringToolsForEclipse.exe」を実行することでSTSを起動することができる。

STSには従来のJakarta EE（Java EE）Webアプリケーション開発向けのWeb Tools Platform (WTP)やJSPエディタなどが搭載されていない、従来のSpring アプリケーション開発向けのXML形式のBean定義ファイルがサポートされていない等、Macchinetta Server Framework (1.x)で解説するアプリケーション開発に必要な機能が不足している。

プラグインの導入はEclipse Marketplace経由で行う。

STSのメニューから、Help > EclipseMarketplaceを選択し、以下のプラグインを導入する。

Eclipse Enterprise Java and Web Developer Tools

Webアプリ開発用のプラグイン(WTP)やJSPエディタを使用するために必要なプラグイン。

Note

プロキシ環境下でプラグインを導入する場合、プロキシ設定を行わないとEclipse MarketPlaceに接続できずプラグインを導入することができない。

プロキシ設定は以下の手順で行える。

STSのメニューから、Window > Preferences > General > Network Connections からプロキシ設定を開き、Active ProviderをManualにしてHTTPとHTTPSにプロキシを設定する。

12.4.3. 作業用の事前設定 ¶

12.4.3.1. JavaScriptのエディタ設定 ¶

eclipse 2020-06リリース以降、JavaScript用に使用されるエディタがJavaScript DevelopmentTools(以降JSDTと呼ぶ)で提供されていたJavaScript Editorから、Eclipse Wild Web Developerというプラグインで提供されるGeneric Text Editor（もしくは普通のText Editor）に変更されている。

この影響でformatter.xmlを使用してのJavaScriptのフォーマットが行えないため、以下の手順でJSDTを導入する必要がある。

STSのメニューから、Help > Install New Softwareを選択し、Work withに「https://download.eclipse.org/releases/latest/」を入力する。
Web,XML,Java EE and OSGi Enterprise Development > JavaScript Development Tools を選択し、インストールを行う。

Note

JSDTのインストール後、再起動を行うことで自動的に.jsファイルをJavaScript Editorで開くようになる。自動的に切り替わらない場合は、STSのメニューから、Window > Preferences > General > Editors > File Associations を開き、*.jsファイルに対してJavaScript Editorを関連付ける。

12.4.3.2. Java設定 ¶

STSの設定によっては予め用意したJDKではなくSTSに同梱されているJDKなどが使用される場合があるので、以下の手順でJDKの設定を確認する。

STSのメニューから、Window > Preferences > Java > Installed JREs を開き、予め用意したJDKにチェックがついていることを確認する。
用意したJDKが一覧に存在しない場合は AddからStandard VMを選択し、Directoryから用意したJDKを選択し追加する。

12.4.3.3. Maven設定 ¶

STSはデフォルトだとSTSに同梱されたMavenを使用するため、以下の手順で予め用意したMavenを使用するよう設定する。

Window > Preferences > Maven > Installations からAddを選択し、Directoryから用意したMavenを選択し追加する。

12.4.3.4. Server設定 ¶

以下の手順でアプリケーションサーバの追加を行う。

ここでは例としてTomcatを使用する場合の設定手順について説明する。

Window > Show View > Other… > Server > Servers を選択し、Serverビューを表示する。
Serverビューを右クリックし、New > Serverを選択する。
Apache配下から使用しているTomcatのバージョンと一致するTomcatを選択しNextを押下する。
Browseから事前にインストールしておいたtomcatを選択し、Finishを押下する。
サーバにアプリケーションを設定したい場合は、追加したサーバを右クリックしてAdd and Removeを選択する。表示された画面のAvailableにある動作させたいアプリケーションを選択し、AddでConfiguredに追加してFinishを押下する。
アプリケーションを設定したサーバを右クリックし、Startを選択してサーバを起動する。

12.4.4. Javaバージョンが異なる場合の対応 ¶

本ガイドラインで説明しているプロジェクトをインポートした際に、期待したJavaバージョンのJRE System Libraryを参照しない場合がある。
これは、STSが起動時に使用するJavaバージョンや事前に準備されたプロジェクトが参照するmaven-compiler-pluginやJDKアクティブプロファイルの設定などにより、プロジェクトのJavaバージョンが変更されてしまうためである。
ここでは、一時的にプロジェクトの設定を変更し、期待したJavaバージョンで動作させる方法を紹介する。ただし、一時的な手段であるため、設定変更やUpdate Maven Projectの実行などにより元に戻る点に注意されたい。

12.4.5. Maven Profileの設定 ¶

Maven Profileが設定されている場合、適切に切り替えることにより、状況に応じた設定にすることが可能となる。

プロジェクトを右クリック > 「Maven」->「Select Maven Profiles…」をクリックし、設定するプロファイルを選択して「OK」ボタンを押下する。

プロジェクトによりMaven Profileの設定は異なるため、各プロジェクトのpom.xmlを参照し、適切に設定を変更されたい。

12.4.6. STSの操作方法 ¶

STSの操作方法について知っていると便利なものについて説明する。

12.4.6.1. パッケージの表示形式 ¶

パッケージの表示形式は、デフォルトは「Flat」だが、「Hierarchical」にしたほうが見通しがよい。

Package Explorerの「View Menu」 (右端の3点リーダー)をクリックし、「Package Presentation」->「Hierarchical」を選択する。

../_images/presentation-hierarchical.png

Package PresentationをHierarchicalにすると、以下の様な表示になる。

../_images/presentation-hierarchical-view_JavaConfig.png

Table of Contents

Previous topic

Next topic

This Page