Spring Bootコンソールアプリケーション

Spring Boot Consoleアプリケーション

1. 概要

このクイックチュートリアルでは、SpringBootを使用して単純なコンソールベースのアプリケーションを作成する方法について説明します。

2. Mavenの依存関係

私たちのプロジェクトは、スプリングブートの親に依存しています。


    org.springframework.boot
    spring-boot-starter-parent
    2.0.3.RELEASE

最初に必要な依存関係は次のとおりです。


    org.springframework.boot
    spring-boot-starter

3. コンソールアプリケーション

コンソールアプリケーションは、SpringBootConsoleApplication.java という単一のクラスで構成されています。これは、SpringBootコンソールアプリケーションのメインクラスです。

メインクラスでSpring’s @SpringBootApplication annotationを使用して、自動構成を有効にしています。

このクラスはSpring’s CommandLineRunner interfaceも実装します。 CommandLineRunnerは、runメソッドを使用する単純なSpringBootインターフェースです。 Spring Bootは、アプリケーションコンテキストがロードされた後、このインターフェースを実装するすべてのBeanのrunメソッドを自動的に呼び出します。

コンソールアプリケーションは次のとおりです。

@SpringBootApplication
public class SpringBootConsoleApplication
  implements CommandLineRunner {

    private static Logger LOG = LoggerFactory
      .getLogger(SpringBootConsoleApplication.class);

    public static void main(String[] args) {
        LOG.info("STARTING THE APPLICATION");
        SpringApplication.run(SpringBootConsoleApplication.class, args);
        LOG.info("APPLICATION FINISHED");
    }

    @Override
    public void run(String... args) {
        LOG.info("EXECUTING : command line runner");

        for (int i = 0; i < args.length; ++i) {
            LOG.info("args[{}]: {}", i, args[i]);
        }
    }
}

spring.main.web-application-type=NONESpring propertyも指定する必要があります。 このプロパティは、これがWebアプリケーションではないことをSpringに明示的に通知します。

SpringBootConsoleApplicationを実行すると、次のログが記録されます。

00:48:51.888 [main] INFO  c.b.s.SpringBootConsoleApplication - STARTING THE APPLICATION
00:48:52.752 [main] INFO  c.b.s.SpringBootConsoleApplication - No active profile set, falling back to default profiles: default
00:48:52.851 [main] INFO  o.s.c.a.AnnotationConfigApplicationContext
  - Refreshing org.spring[email protected]6497b078: startup date [Sat Jun 16 00:48:52 IST 2018]; root of context hierarchy
00:48:53.832 [main] INFO  o.s.j.e.a.AnnotationMBeanExporter - Registering beans for JMX exposure on startup
00:48:53.854 [main] INFO  c.b.s.SpringBootConsoleApplication - EXECUTING : command line runner
00:48:53.854 [main] INFO  c.b.s.SpringBootConsoleApplication - args[0]: Hello World!
00:48:53.860 [main] INFO  c.b.s.SpringBootConsoleApplication - Started SpringBootConsoleApplication in 1.633 seconds (JVM running for 2.373)
00:48:53.860 [main] INFO  c.b.s.SpringBootConsoleApplication - APPLICATION FINISHED
00:48:53.868 [Thread-2] INFO  o.s.c.a.AnnotationConfigApplicationContext
  - Closing org.spring[email protected]6497b078: startup date [Sat Jun 16 00:48:52 IST 2018]; root of context hierarchy
00:48:53.870 [Thread-2] INFO  o.s.j.e.a.AnnotationMBeanExporter - Unregistering JMX-exposed beans on shutdown

runメソッドは、アプリケーションコンテキストが読み込まれた後、mainメソッドの実行が完了する前に呼び出されることに注意してください。

ほとんどのコンソールアプリケーションには、CommandLineRunnerを実装する単一のクラスしかありません。 アプリケーションにCommandLineRunnerを実装する複数のクラスがある場合、実行の順序はSpring’s @Order annotationを使用して指定できます。

4. 結論

この記事では、SpringBootを使用して単純なコンソールベースのアプリケーションを作成する方法を要約しました。

ここでの例の完全なソースコードは、いつものように、over on GitHubです。