Spring Bootのマルチプロジェクトで@ComponentScanにより参照先プロジェクトにある依存クラスを@Autowiredしようとすると 参照元クラスのbeanも生成されなくなる

Question

※初めて質問します。よろしくお願いいたします。

実現したいこと

現在、Spring Bootのマルチプロジェクトを作成しており、参照元のプロジェクトの中で
参照先の別モジュールにある依存クラスを@Autowiredしたいです。

現在、発生している問題(概要)

@ComponentScanにより参照先プロジェクトにある依存クラスを@Autowiredしようとした際に
参照元クラスのbeanも生成されなくなります。
具体的には@RestControllerアノテーションをつけたContorollerです。

前提

フォルダ構成は以下のパッケージエクスプローラーの通りです。
sample-appがcommon-businessを参照しているという関係性です。

現在、発生している問題(詳細)

sample-app/build.gradleにcommon-businessへの参照設定を追記してマルチプロジェクトとし、
sample-appのmainクラスにて@ComponentScanを付与したところsample-appのBean自体が生成されなくなりました。
具体的には以下のControllerで@ComponentScanをはずすとBeanがうまく生成され、localhost:8080/sample/api/testへのアクセスも成功します。

package spring.demo.controller;
import spring.common.demo.ItemService;
@RestController
public class ItemController {
	@Autowired
	ItemService itemService;

    @GetMapping("/sample/api/test")
    public String test() {
    	return "Hello World";
    }
}

sample-appからcommon-businessを参照するビルドスクリプトが悪いのか、
別モジュールにある依存クラスへの参照設定が悪いのか
それともその他の部分に問題があるのかわかりません。

お手数をおかけしますが、原因部分とその対応策のご教示をお願い致します。

該当のソースコード

sample-appのbuild.gradle及びsetting.gradleは以下の通りです。
/sample-app/build.gradle

buildscript {
    ext {
        springBootVersion = '2.1.3.RELEASE'
    }
}
plugins {
	id 'org.springframework.boot' version '2.1.3.RELEASE'
	id 'java'
}
apply plugin: 'io.spring.dependency-management'
group = 'spring.demp'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

repositories {
	mavenCentral()
}

subprojects {
    apply plugin: "java"
    apply plugin: "io.spring.dependency-management"

    repositories {
        mavenCentral()
    }
    dependencyManagement {
        imports {
            mavenBom "org.springframework.boot:spring-boot-dependencies:$springBootVersion"
        }
    }
}

dependencies {
	compile project(':common-business')
	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
	implementation 'org.springframework.boot:spring-boot-starter-jdbc'
	implementation 'org.springframework.boot:spring-boot-starter-web'
	compileOnly 'org.projectlombok:lombok'
	runtimeOnly 'org.postgresql:postgresql'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

/sample-app/setting.gradle

rootProject.name = 'sample-app'

include ':common-business'
project(':common-business').projectDir = new File('../common-business')

/common-business/build.gradle

plugins {
	id 'java'
}

repositories {
	mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
	implementation 'org.springframework.boot:spring-boot-starter-jdbc'
	implementation 'org.springframework.boot:spring-boot-starter-web'
	compileOnly 'org.projectlombok:lombok'
	runtimeOnly 'org.postgresql:postgresql'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'

    // Use JUnit test framework
    testImplementation 'junit:junit:4.12'
}

試したこと

別モジュールにある依存クラスを@Autowiredするために@ComponentScan("common-business")としています。

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

Spring Boot 2.1.3
Gradle 4.10.2

Answer 1

ソースコードを拝見する限り、@ComponentScan("common-business") を付与したことにより、コンポーネントである ItemController が bean として登録されなくなったためだと思われます。

@ComponentScan に指定する文字列は、コンポーネントスキャンを行うパッケージ（例： "spring.demo.controller"）です。ここに "common-business" が指定されたので、common-business パッケージ配下がコンポーネントスキャンの対象となっています。実際に登録したいコンポーネントが存在するのは ItemController が位置する spring.demo.controller と ItemService が位置する spring.common.demo なので、それらを指定してあげる必要があります。

@ComponentScan({ "spring.demo.controller", "spring.common.demo" })
@SpringBootApplication
public class Sample Application {
  // 省略
}

なお、@SpringBootApplication は @ComponentScan を包含しており、このアノテーションが付与されたクラスが存在するパッケージとその配下のパッケージをコンポーネントスキャンの対象とします（@ComponentScan アノテーションを付与する前に ItemController が正常に動作していたのは、ItemController クラスが @SpringBootApplication アノテーションを付与したクラスが存在するパッケージの配下のパッケージに存在したため）。@SpringBootApplication アノテーションでもコンポーネントスキャン対象のパッケージを指定することが可能です。

@SpringBootApplication(scanBasePackages = { "spring.demo.controller", "spring.common.demo" })
public class Sample Application {
  // 省略
}

Comments

[4321bocya]

お返事が遅くなり、申し訳ございません。
上記の対応をした結果、問題が解決しました。
ありがとうございました。

Answer 2

参照しているプロジェクトを含めたことで 404 (FileNotFound) になっているのであれば、インポートしているプロジェクトそのもの、もしくは依存関係で示しているモジュールの設定が不足していて、Webアプリケーションが起動していないのではないでしょうか。

ビルドエラーや、SpringBootを起動しなおしたときに何らかのエラーは出ているかと思いますが、現状の設定だけ書かれている状態ではこれ以上のことはわかりません。

Comments

[4321bocya]

コメントありがとうございます。
参照先のプロジェクトのbuild.gradleを質問文に追記しました。

またビルドエラーやSpring Bootの起動時のエラーは起きていません。

[rubytomato]

ページにアクセスして404エラーが出たときにもエラーは出力されていないのでしょうか?

[A-pZ]

common-business側の設定で`@ComponentScan`ないしはそれに代替される設定がすでになされており、common-businessの`@ComponentScan`パッケージ対象とことなるパッケージならば、Controllerとして生成されません。

なお、Controllerに`@ComponentScan`はつけずに、通常は起動クラスにつけます。