引数が渡ってきている部分がどこか特定したい

Question

前提・実現したいこと

SpringBootインストラクション内のConsumingRestApplication.javaのコードで分からない部分があります。runメソッドのreturnの後に記載されている、argsはラムダ式の引数に該当すると思われますが、どこから、代入されているのでしょうか？
アドバイスなど頂けましたら幸いです。

該当のソースコード

package com.example.consumingrest;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;

@SpringBootApplication
public class ConsumingRestApplication {

	private static final Logger log = LoggerFactory.getLogger(ConsumingRestApplication.class);

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

	@Bean
	public RestTemplate restTemplate(RestTemplateBuilder builder) {
		return builder.build();
	}

	@Bean
	public CommandLineRunner run(RestTemplate restTemplate) throws Exception {
		return args -> {
			Quote quote = restTemplate.getForObject(
					"https://gturnquist-quoters.cfapps.io/api/random", Quote.class);
			log.info(quote.toString());
		};
	}
}

試したこと

デバッガーで処理を追ってみたのですが、// Warning: No line numbers available in class fileと表示され処理が途中から追えませんでした。

補足情報（FW/ツールのバージョンなど）

SpringBoot2.3

Answer 1

args配列にはアプリケーション起動時に指定された引数が格納されています。
つまり下記のように引数を与えて実行した場合

java -jar ./path/to/consuming-rest-0.0.1-SNAPSHOT.jar aaa bbb ccc

args配列には3つの文字列が格納されています。

[aaa, bbb, ccc]

試しに以下のようにlogを出力するコードを追加してみると(1),(2)の順番でログに出力されていると思います。

public static void main(String[] args) {
  // (1)
  log.info(Arrays.toString(args));
  SpringApplication.run(ConsumingRestApplication.class, args);
}

return args -> {
  // (2)
  log.info(Arrays.toString(args));
  Quote quote = restTemplate.getForObject(  
    "https://gturnquist-quoters.cfapps.io/api/random", Quote.class);
  log.info(quote.toString());  
};

Spring Bootに限らず、Javaのプログラムは引数を与えるとmainメソッドのargsで受け取ります。
その引数をSpring Bootアプリケーション内で利用するために、さらに下記のようにして持ちまわしています。

// (3) アプリケーション実行時の引数を持ちまわす
SpringApplication.run(ConsumingRestApplication.class, args);

それを確認するには、下記のようにmainメソッド内で別の配列を定義して実行してみます。すると(2)の部分ではこのnewArgs配列の値が出力されたと思います。

String[] newArgs = {"ddd", "eee", "fff"};
SpringApplication.run(ConsumingRestApplication.class, newArgs);

argsはラムダ式の引数に該当すると思われますが

蛇足ですが、この部分は従来の書き方をすると以下のようになります。
このCommandLineRunnerインターフェースを実装したインスタンスのrunメソッドには、Spring Bootによって(3)の部分で指定したargsが渡されます。

return new CommandLineRunner() {
	@Override
	public void run(String... args) throws Exception {
		Quote quote = restTemplate.getForObject(
			"https://gturnquist-quoters.cfapps.io/api/random", Quote.class);
		log.info(quote.toString());
	}
};

2020/06/06 追記

一点のみどうしても疑問があるのですが、元コードの「run」メソッドの引数「args」はメソッド内で一度も使用されていないにも関わらず、記載されているのは何故

元コードというのは下記のことだと思いますが、端的に言うと引数argsが記載されているのはCommandLineRunnerインターフェースを実装しているからであり、引数を使用していないのはサンプルコード上必要がなかったから、ということではないでしょうか？

return args -> {
  Quote quote = restTemplate.getForObject(
    "https://gturnquist-quoters.cfapps.io/api/random", Quote.class);
  log.info(quote.toString());
};

以下はCommandLineRunnerインターフェースのコードです。このインターフェースを実装するということはvoid run(String... args) throws Exceptionをオーバーライドする必要があるということです。

@FunctionalInterface
public interface CommandLineRunner {

	/**
	 * Callback used to run the bean.
	 * @param args incoming main method arguments
	 * @throws Exception on error
	 */
	void run(String... args) throws Exception;

}

このインターフェースを実装したクラスのコードは例えば以下のようになります。このようにrunメソッドをオーバーライドして、Springアプリケーションの起動時に実行したい処理を記述します。

@Component
public class CustomRunner implements CommandLineRunner {
  private static final Logger log = LoggerFactory.getLogger(CustomRunner.class);

  private final RestTemplate restTemplate;

  public CustomRunner(RestTemplate restTemplate) {
    this.restTemplate = restTemplate;
  }

  @Override
  public void run(String... args) throws Exception {
    log.info(Arrays.toString(args));
    Quote quote = restTemplate.getForObject(
      "https://gturnquist-quoters.cfapps.io/api/random", Quote.class);
    log.info("2nd : {}", quote.toString());
  }

}

runメソッドの引数を使う必要がないからといって以下のようにオーバーライドしてもコンパイルエラーになります。なぜならこれではCommandLineRunnerインターフェースを実装していることにならないからです。

@Override
public void run() throws Exception {

  // 省略

}

ちなみに、引数を使うように実装するのであれば、以下のようにすることもできます。

サンプルコードで使用しているAPIのhttps://gturnquist-quoters.cfapps.io/api/randomは、randomの部分を任意の数値に変えると、それがID指定になります。
たとえば、https://gturnquist-quoters.cfapps.io/api/10でリクエストすると、以下のjsonがレスポンスされます。

{
  "type":"success",
  "value":{
    "id":10,
    "quote":"Really loving Spring Boot, makes stand alone Spring apps easy."
  }
}

このように実装すると（引数のチェックをしていないので例は悪いですが）、アプリケーション実行時の引数にIDを指定することができるようになります。

return args -> {
  String id = args[0];
  Quote quote = restTemplate.getForObject(
    "https://gturnquist-quoters.cfapps.io/api/" + id, Quote.class);
  log.info(quote.toString());
};

2020/06/07 追記

「Quote quote = restTemplate.getForObject(」こちらの行から読み取れるに、「Quote」型の変数を返しているということではないのでしょうか...?

すでに回答に記載していますがCommandLineRunnerインターフェースのrunメソッドのシグネチャは以下の通りです。
このように戻り値の型がvoidとなっているのでrunメソッドは何も返しません。argsという文字列の配列を引数に取り（それを使うかどうかは別として）実装した処理を実行する(Springフレームワークが）だけです。

void run(String... args) throws Exception;

なので

「Quote」型の変数を返している

ということではありません。

以下が参考にされているページのオリジナルコードですが、このrunメソッド内でreturnしているのはラムダ式で書かれたCommandLineRunnerインターフェースを実装したクラス（匿名クラス、無名クラスとも）のインスタンスです。

@Bean
public CommandLineRunner run(RestTemplate restTemplate) throws Exception {

  return args -> {
    Quote quote = restTemplate.getForObject(
      "https://gturnquist-quoters.cfapps.io/api/random", Quote.class);
    log.info(quote.toString());
  };

}

上記の書き方を少し冗長化すると下記のようになります。returnはCommandLineRunner型の変数runnerを返していることが分かりやすくなったかとおもいます。
ラムダ式について少し触れておくと、args -> { ... }は、argsがメソッドの引数で、-> { ... }がメソッドの本体ということになります。

@Bean
public CommandLineRunner run(RestTemplate restTemplate) throws Exception {

  CommandLineRunner runner;

  runner = args -> {
    Quote quote = restTemplate.getForObject(
      "https://gturnquist-quoters.cfapps.io/api/random", Quote.class);
    log.info(quote.toString());
  };

  return runner;
}

上記の書き方をラムダ式を使わずに記述すると下記のようになります。
これはいわゆるラムダ式導入以前の匿名クラス（無名クラス）を利用している書き方です。runner変数には匿名クラスのインスタンスが代入され、それがreturnされています。
さらにオーバーライドしたrunメソッドが何もreturnしていないことがわかると思います。

@Bean
public CommandLineRunner run(RestTemplate restTemplate) throws Exception {

  CommandLineRunner runner = new CommandLineRunner() {
    @Override
    public void run(String... args) throws Exception {
      Quote quote = restTemplate.getForObject(
        "https://gturnquist-quoters.cfapps.io/api/random", Quote.class);
      log.info(quote.toString());
    }
  };

  return runner;
}

上記の書き方は匿名クラスを使った例ですが、下記のように書くこともできます。

public class CustomRunner implements CommandLineRunner {
  private static final Logger log = LoggerFactory.getLogger(CustomRunner.class);

  private final RestTemplate restTemplate;

  public CustomRunner(RestTemplate restTemplate) {
    this.restTemplate = restTemplate;
  }

  @Override
  public void run(String... args) throws Exception {
    Quote quote = restTemplate.getForObject(
      "https://gturnquist-quoters.cfapps.io/api/random", Quote.class);
    log.info(quote.toString());
  }

}

これでCommandLineRunnerインターフェースを実装したクラスのインスタンスを返していることがわかるでしょうか？

@Bean
public CommandLineRunner run(RestTemplate restTemplate) throws Exception {

  CommandLineRunner runner = new CustomRunner(restTemplate);

  return runner;
}

すでに説明したと思いますが、returnしたインスタンスのrunメソッドは、アプリケーション起動時にSpringフレームワークによって実行されます。

Comments

[s-lll]

ご丁寧にご回答頂きましてありがとうございます。
何故「args」が使いまわせるか、非常に分かりやすく、理解することが出来ました。
しかし、一点のみどうしても疑問があるのですが、元コードの「run」メソッドの引数「args」はメソッド内で一度も使用されていないにも関わらず、記載されているのは何故だとお考えになられますでしょうか？
重ね重ねのご質問となり、恐縮ですが、ご返信頂けましたら幸いです。

[rubytomato]

回答欄に追記しましたのでご確認ください。

[s-lll]

追記頂きありがとうございます。
大変ご丁寧、ご親切にご回答頂いているのに、申し訳ないのですが、あと一歩の所でどうしても分からない部分がございます...
「CommandLineRunner」の「run」メソッドを引数を指定し実装する必要がある、といった部分までは理解することが出来たのですが、そうだとした場合、「 return args -> { 」こちらの部分がなくとも、以下のような形でもインターフェースは実装されるのではないか、と疑問に思ってしまいました...

「　 public CommandLineRunner run(RestTemplate restTemplate) throws Exception {

Quote quote = restTemplate.getForObject(
"https://gturnquist-quoters.cfapps.io/api/random", Quote.class);
log.info(quote.toString())
} 」

こちらのような形では、良くありませんでしょうか...？
本当に何度も申し訳ありません。

[rubytomato]

確認したいのですが、以下のConsumingRestApplicationクラスのrunメソッドは、CommandLineRunnerインターフェースのrunメソッドの実装だと認識されているのでしょうか？

@Bean
public CommandLineRunner run(RestTemplate restTemplate) throws Exception {
// 省略
}

だとすれば、それは違います。このrunメソッドはCommandLineRunnerインタフェースのrunメソッドの実装ではありません。たまたまrunという名前が付いているだけのメソッドです。（またシグネチャも違っています）
試しにrun以外の名前に変えて実行してみてください。

仮にanythingというメソッド名に変えても実行されます。このメソッドには@Beanアノテーションが付いていますが、このアノテーションが付いているとSpringアプリケーションの起動時に自動的に呼び出され、メソッドの戻り値のインスタンス（この例ではCommandLineRunnerインターフェースを実装した）がDIコンテナに登録されます。
この後は既に説明した通り、DIコンテナに登録されたCommandLineRunnerインタフェースを実装したインスタンス(Bean)は、あるタイミングで順次実行されます。（これもSpringによって）

@Bean
public CommandLineRunner anything(RestTemplate restTemplate) throws Exception {
// 省略
}

[s-lll]

ご返信ありがとうございます。
>CommandLineRunnerインターフェースのrunメソッドの実装だ認識されているのでしょうか？
はい。こちら勘違いしてしまっておりました。どうも、ようやくですが、自分が理解出来ていない部分がわかってきた気がいたします...

>メソッドの戻り値のインスタンス（この例ではCommandLineRunnerインターフェースを実装した）がDIコンテナに登録されます。
こちらなのですが、「メソッドの戻り値のインスタンス」は「CommandLineRunnerのインスタンス」ではなく、「Quote quote = restTemplate.getForObject(」こちらの行から読み取れるに、「Quote」型の変数を返しているということではないのでしょうか...?
重ね重ね、申し訳ありません。

[rubytomato]

回答欄に追記しましたのでご確認ください。
ちょっと確認したいのですが、ご質問の主旨はSpringフレームワークについてでしょうか？それともラムダ式の書き方についてでしょうか？

[s-lll]

大変ご丁寧に教えて頂きまして、ありがとうございます。
追記の方、読ませて頂きました。
>ご質問の主旨はSpringフレームワークについてでしょうか？それともラムダ式の書き方についてでしょうか？
こちらなのですが、最初はSpringフレームワークの処理の流れが分からずご質問させて頂いたのですが、途中から、ラムダ式についても分からなくなってしまいまして...
参考書も読んでみたのですが、どうしても分からない状況に陥ってしまいました...

>これはいわゆるラムダ式導入以前の匿名クラス（無名クラス）を利用している書き方です
こちらなのですが、匿名クラスにも書き換えてくださいましたおかげで、抽象メソッドのCommandLineRunnerをオーバーライドしているということが理解できました。
そもそも、単純に自分の認識に問題があっただけであるかとは思うのですが、ラムダ式について学習している際に、メソッドの引数に、ラムダ式を組み込み、抽象メソッドを一つだけ持つ「関数型インターフェース」をオーバーライドするといった部分は理解できたのですが、「インスタンスが作成される」といった部分まで、分かっておりませんでした。
質問に記載させて頂きましたコードでは、「　return args -> { 」となっていますが、変数などに、ラムダ式で無名クラスのインスタンスを代入する場合は、「CommandLineRunner a = args->{ }」などと左側の代入先から、ラムダ式のクラスを特定できますが、メソッドの場合、ラムダ式の部分ではなんの無名クラスのインスタンスを返そうとするのか、どのように特定しているのかが分からず、混乱してしまっておりました...
単純に、「public CommandLineRunner run(RestTemplate restTemplate) 」こちらから、「CommandLineRunner 」であると読み取れるということに気がつくのに、時間がかかってしまいました。
本当に、長々とご丁寧にご説明下さり、感謝しかございません。
本当に、ありがとうございました。