質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.62%

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

解決済

回答 2

投稿 編集

  • 評価
  • クリップ 0
  • VIEW 6,031

4321bocya

score 13

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

実現したいこと

現在、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

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 2

checkベストアンサー

0

ソースコードを拝見する限り、@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 {
  // 省略
}

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2019/03/05 10:54

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

    キャンセル

0

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

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2019/03/01 08:14

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

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

    キャンセル

  • 2019/03/01 21:42

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

    キャンセル

  • 2019/03/02 08:46

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

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

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.62%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る

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