Spring Boot 画面表示について

Question

前提・実現したいこと

Spring Bootを使って画面表示を行ったのですが、パッケージの場所によって表示出来たり、出来なかったりして理解できなかったので、教えて頂きたいです。
ファイル構成です。
app
├ なし
config
├ WebMvcControllerAdvice.java
demo
├ MyFirstAplicationApplication.java
└ SampleController.java

上記の状態だと正常に表示されます。
しかし、SampleController.javaをappパッケージに移動するとWhitelabel Error Pageが出て表示されません。
パッケージ関係なくcontrollerがついたアノテーションを見て表示するのかと思ってました。。
なぜdemoパッケージ内じゃないと動かないのかがわかりません。demoパッケージを指定した記憶などなく
SampleController.javaをappパッケージに移動させて表示させるにはどうしたらいいでしょうか。分かる方教えて頂きたいです。

package com.example.config;


import org.springframework.beans.propertyeditors.StringTrimmerEditor;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.InitBinder;


/**
 * 全てのControllerで共通処理を定義
 */
@ControllerAdvice
public class WebMvcControllerAdvice {

	/*
	 * This method changes empty character to null
	 * こちらのメソッドを用意しておくと送信された空文字はnullに変換されます
	 */
    @InitBinder
    public void initBinder(WebDataBinder dataBinder) {
        dataBinder.registerCustomEditor(String.class, new StringTrimmerEditor(true));
    }
   
}

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyFirstAplicationApplication {

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

}

package com.example.demo;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequestMapping("/sample")
public class SampleController {
	@GetMapping("/test")
	public String test(Model model) {
		model.addAttribute("title","info");
		return "test";
	}
}

Comments

[m.ts10806]

>Whitelabel Error Pageが出て
コンソールに出ているエラーを追えば明白かと思います

Answer 1

SpringBoot のコンポーネントスキャンは
デフォルトでは
ベースとなるアプリケーションと「同じパッケージ」と「それ以下の階層のパッケージ」をスキャンするため、
質問者様の疑問に感じるような挙動が発生しているのだと予想します。

質問者様のケースでは、
「demo 配下に Controller を置いた」場合、「Application と同じパッケージ」のため、コンポーネントスキャンが可能でしたが、
「app 配下に Controller を置いた」場合、「Application とは別のパッケージ」のため、コンポーネントスキャンがされていないのだと思います。
そのため、設定・実装したルーティングが取り込まれず、表示がうまくできていないものと思われます。

ここでベースのアプリケーションクラスというのは
@SpringBootApplication のアノテーションのついたクラスのことです。

関係性を表すと、
スキャンできるクラス、できないクラスの例としては以下のようになります。

com.sample
  ├app
  | ├ sub
  | |  └ SubController.java （下の階層のパッケージなのでスキャンできる）
  | ├ Application.java (@SpringBootApplication がついてる)
  | └ AppController.java （同じパッケージなのでスキャンできる）
  └ another
    └ AnotherController.java （app とは別のパッケージなのでスキャンできない）

デフォルトの場合、と書きましたが、設定次第で並列のパッケージも読み取ることは可能です。
並列のパッケージもスキャンしたい場合の対応の例としては、
@SpringBootApplication の引数に scanBasePackages={<引き込みたい親のpackage 名>}を指定します。
上の例だと、com.sample 以下をスキャンしたい場合は、
アプリケーションクラス（例だと Application.javaに）以下を設定します

@SpringBootApplication(scanBasePackages={"com.sample"})
public class Application{

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

}

こうすることで、com.sample.app以下も、com.sample.another以下のクラスもスキャンできるようになると思います。

Answer 2

MyFirstAplicationApplication.java

こいつもappフォルダに移動してみてください
こいつがある場所を基準にコントローラーの読み込みが行われているはずだから

app
├ MyFirstAplicationApplication.java
├ SampleController.java
config
└ WebMvcControllerAdvice.java