Spring Tool Suiteを用いてgradleでwarを作成する方法

Spring Tool Suiteを用いてgradleでwarを作成する方法をご紹介します。

1 条件
2 前提
- 2.1 TestController.java
- 2.2 動作確認
3 warの作成
4 ローカルPC上でのwar実行確認
5 参考

条件

Spring Tool Suite 4
Spring Boot 2.5.0
gradle

前提

以下のようなSpringプロジェクトを作成します。
依存関係は「Spring Web」のみを選択しています。

TestControllerクラスを作成し、以下のように記述します。

TestController.java

package com.example;

import javax.servlet.http.HttpServletRequest;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {


    @GetMapping(path = "/test")
    public String getTest(HttpServletRequest request) {

        return "Hello World!";
    }
}

動作確認

プロジェクトを右クリック > 実行 > Spring Bootアプリケーションを選択します。

アプリケーションが実行されたのを確認し、ブラウザで以下のURLを開きます。

http://localhost:8080/test

以下のように表示されればＯＫです。

warの作成

ソースの編集

main関数のあるクラスに、以下を記述します。

クラスに「extends SpringBootServletInitializer」を追加。
@Overrideでconfigureメソッドを追加。

以下のような記述となりました。

Test1Application.java

package com.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;

@SpringBootApplication
public class Test1Application extends SpringBootServletInitializer {

    public static void main(String[] args) {
        SpringApplication.run(Test1Application.class, args);
    }

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(Test1Application.class);
    }
}

build.gradleの編集

build.gradleに以下を追記します。

apply plugin: ‘war’
providedRuntime(“org.springframework.boot:spring-boot-starter-tomcat”)

また、warの名称を指定するために以下も追記します。

war {archiveName ‘test1.war’}

今回は以下のようになりました。

build.gradle

plugins {
  id 'org.springframework.boot' version '2.5.2'
  id 'io.spring.dependency-management' version '1.0.11.RELEASE'
  id 'java'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'

repositories {
  mavenCentral()
}

apply plugin: 'war'

war {
    archiveName 'test1.war'
}

dependencies {
  implementation 'org.springframework.boot:spring-boot-starter-web'
  testImplementation 'org.springframework.boot:spring-boot-starter-test'
  providedRuntime("org.springframework.boot:spring-boot-starter-tomcat")
}

test {
  useJUnitPlatform()
}