SpringBoot + MyBatis Autowired時にエラーが発生する

Question

前提・実現したいこと

サービスクラスでマッパーインターフェースをDIしたい

発生している問題・エラーメッセージ

Description:

Field mapper in com.example.demo.service.HK2ConvertService required a bean of type 'com.example.demo.mapper.hk3_comsys.ChargeCustomerMapper' that could not be found.

The injection point has the following annotations:
	- @org.springframework.beans.factory.annotation.Autowired(required=true)


Action:

Consider defining a bean of type 'com.example.demo.mapper.hk3_comsys.ChargeCustomerMapper' in your configuration.

該当のソースコード

package com.example.demo.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;

import com.example.demo.service.HK2ConvertService;

@Controller
public class HK2ConvertController {
	@Autowired
	HK2ConvertService hService;

	@RequestMapping("/hello")
	public String mainPage(Model model) {
		model.addAttribute("customerList", hService.getCustomerList());
		return "main";
	}
}

package com.example.demo.mapper.hk3_comsys;

import java.util.ArrayList;
import java.util.List;

import org.apache.ibatis.annotations.Param;
import org.springframework.stereotype.Repository;

import com.example.demo.domain.hk3_comsys.ChargeCustomer;
import com.example.demo.domain.hk3_comsys.ChargeCustomerExample;
import com.example.demo.domain.hk3_comsys.ChargeCustomerKey;

@Repository
public interface ChargeCustomerMapper {

	public ArrayList<ChargeCustomer> getChargeCustomers();

	/**
	 * This method was generated by MyBatis Generator. This method corresponds to the database table HK3_COMSYS.CHARGE_CUSTOMER
	 * @mbg.generated  Tue Jan 26 11:09:24 JST 2021
	 */
	long countByExample(ChargeCustomerExample example);

	/**
	 * This method was generated by MyBatis Generator. This method corresponds to the database table HK3_COMSYS.CHARGE_CUSTOMER
	 * @mbg.generated  Tue Jan 26 11:09:24 JST 2021
	 */
	int deleteByExample(ChargeCustomerExample example);

	/**
	 * This method was generated by MyBatis Generator. This method corresponds to the database table HK3_COMSYS.CHARGE_CUSTOMER
	 * @mbg.generated  Tue Jan 26 11:09:24 JST 2021
	 */
	int deleteByPrimaryKey(ChargeCustomerKey key);

	/**
	 * This method was generated by MyBatis Generator. This method corresponds to the database table HK3_COMSYS.CHARGE_CUSTOMER
	 * @mbg.generated  Tue Jan 26 11:09:24 JST 2021
	 */
	int insert(ChargeCustomer record);

	/**
	 * This method was generated by MyBatis Generator. This method corresponds to the database table HK3_COMSYS.CHARGE_CUSTOMER
	 * @mbg.generated  Tue Jan 26 11:09:24 JST 2021
	 */
	int insertSelective(ChargeCustomer record);

	/**
	 * This method was generated by MyBatis Generator. This method corresponds to the database table HK3_COMSYS.CHARGE_CUSTOMER
	 * @mbg.generated  Tue Jan 26 11:09:24 JST 2021
	 */
	List<ChargeCustomer> selectByExample(ChargeCustomerExample example);

	/**
	 * This method was generated by MyBatis Generator. This method corresponds to the database table HK3_COMSYS.CHARGE_CUSTOMER
	 * @mbg.generated  Tue Jan 26 11:09:24 JST 2021
	 */
	ChargeCustomer selectByPrimaryKey(ChargeCustomerKey key);

	/**
	 * This method was generated by MyBatis Generator. This method corresponds to the database table HK3_COMSYS.CHARGE_CUSTOMER
	 * @mbg.generated  Tue Jan 26 11:09:24 JST 2021
	 */
	int updateByExampleSelective(@Param("record") ChargeCustomer record,
			@Param("example") ChargeCustomerExample example);

	/**
	 * This method was generated by MyBatis Generator. This method corresponds to the database table HK3_COMSYS.CHARGE_CUSTOMER
	 * @mbg.generated  Tue Jan 26 11:09:24 JST 2021
	 */
	int updateByExample(@Param("record") ChargeCustomer record, @Param("example") ChargeCustomerExample example);

	/**
	 * This method was generated by MyBatis Generator. This method corresponds to the database table HK3_COMSYS.CHARGE_CUSTOMER
	 * @mbg.generated  Tue Jan 26 11:09:24 JST 2021
	 */
	int updateByPrimaryKeySelective(ChargeCustomer record);

	/**
	 * This method was generated by MyBatis Generator. This method corresponds to the database table HK3_COMSYS.CHARGE_CUSTOMER
	 * @mbg.generated  Tue Jan 26 11:09:24 JST 2021
	 */
	int updateByPrimaryKey(ChargeCustomer record);
}

package com.example.demo.service;

import java.util.ArrayList;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import com.example.demo.domain.hk3_comsys.ChargeCustomer;
import com.example.demo.mapper.hk3_comsys.ChargeCustomerMapper;

@Service
public class HK2ConvertService {

	@Autowired
	ChargeCustomerMapper mapper;

	public ArrayList<ChargeCustomer> getCustomerList() {
		return mapper.getChargeCustomers();
	}

}

試したこと

ComponentScanでcom.example.demo.mapperを明示的に指定する事でエラーは出なくなりましたが、コントローラーが動作しなくなりました。

###補足情報
パッケージ構成は
com.example.demoにメインアプリケーションファイルが存在し、その配下に
com.example.demo.〇〇のような形で各種コントローラーやサービス、マッパーのパッケージが存在しています(com.example.demo.controller,com.example.demo.service,com.example.demo.mapper)等

全てcom.example.demoの配下にいるのに本エラーがでてしまうのはなぜでしょうか・・・

###補足

Answer 1

MyBatisのマッピング用インタフェースですので、
@Repositoryではなく、@Mapperを宣言してください。

※ org.apache.ibatis.annotations.Mapper

Comments

[yuu_info]

ご回答ありがとうございます！　ご指摘いただいた通り@Repositoryから@Mapperに修正しましたが同じエラーが発生し、解決には至りませんでした。

[A-pZ]

なるほど。他に考えられるものとして、質問文に

> ComponentScanでcom.example.demo.mapperを明示的に指定する事でエラーは出なくなりました

この設定は現在外されていますよね？（他にも、@SpringBootApplicationでComponentScanの設定ができるのですが、その設定も特に書かれていない状態でしょうか）

[yuu_info]

返信遅れてしまい申し訳ありません。
はい、その設定は外しています！　ComponentScanのアノテーションもつけておらずデフォルトの状態です。

[yuu_info]

@SpringBootApplication(scanBasePackages ={"demo"})でdemo配下のパッケージを明示的にスキャンするようにしたところ、エラーは発生しなくなりました。しかし@Controllerを付与したコントローラークラスが機能しません。（機能しないというのはURLのマッピングが行われず/helloにアクセスしても404が出てしまうということです）

[A-pZ]

ありがとうございます。
scanBasePackageが未定義のときは、@SpringBootApplicationが配置されているパッケージ（今回で言えば、com.example.demo でしょうか）と、そのサブパッケージがすべて対象になります。もし定義した場合には定義したパッケージとそのサブパッケージのみが対象になるはずですので、現在質問文に貼っていただいたControllerやMapperインタフェースのソースが正しいものでしたら、大丈夫なはずです。

なお、何らかのコンパイルエラーがあった場合などは最新の状態で反映されませんので（大丈夫だとは思いますが…）、念のため対象のApplicationクラスのパッケージやMapperのパッケージなども再確認してください。

[yuu_info]

###Application
```
package com.example.demo;

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

@SpringBootApplication(scanBasePackages = {"demo"})
public class Hk2ConvertApplication {

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

}

```

こちらApplicationのクラスです。
controllerクラスもdemo.controllerとdemoパッケージの配下内にありますので本来であれば機能するはずだと認識しているのですがほかに考えられる点などありますでしょうか・・・

[A-pZ]

ですね、demoパッケージ以下に配置されているものが対象にはなります。（ただしこの設定は、demo. 以下 の意味になり、 com.example.demo. 以下は対象になりません）

[yuu_info]

なるほど・・・com.example.demoの配下全てを対象にしたい為basePackageScanに「com.example.demo」と指定したのですが、その配下にあるはずのserviceパッケージのserviceクラスがmapperパッケージのmapperクラスを見つけることが出来ない(質問文で貼ったエラー)が発生してしまいます。パッケージ構成が間違っているとは思えないのですがもし間違ってないと仮定した場合他に考えられる事はありますでしょうか。

Answer 2

根本的解決にならないかもしれませんが、
@Import書いてみてはどうでしょう。

例：

@Service
@Import({ChargeCustomerMapper.class})
public class HK2ConvertService {

Comments

[yuu_info]

ご回答ありがとうございます！試してみたところ「Specified class is an interface」というエラーが発生し解決には至りませんでした。インタフェースはインポートできないようですね・・・