Spring Bootでインターフェースをnewせずに使うDIの理解💻

はじめに (対象読者・この記事でわかること)

この記事は、JavaとSpring Bootの基礎を学んでいる方で、インターフェースをnewせずに使う方法が分からないという方を対象にしています。具体的には、DI（依存性注入）の概念が理解できていない、または実装方法がわからないといった悩みを持つ方を想定しています。

本記事を読むことで、Spring Bootにおける依存性注入の仕組みとインターフェースの実装方法が理解できるようになります。また、なぜインターフェースを直接newすべきでないのか、そのメリットについても理解し、より柔軟で保守性の高いコードを書くことができるようになります。

前提知識

この記事を読み進める上で、以下の知識があるとスムーズです。 - Javaの基本的な文法（クラス、インターフェースの理解） - Spring Bootの基本的なプロジェクト構造の理解 - MavenまたはGradleの基本的な知識

インターフェースとnew演算子の関係

Javaでは通常、クラスのインスタンスを生成するためにnew演算子を使用します。しかし、Spring Bootではインターフェースを直接newすることは一般的ではありません。これはなぜでしょうか？

インターフェースは実装を持たない抽象的な定義であり、具体的な処理内容は実装クラスに委ねられています。通常、new演算子を使って実装クラスのインスタンスを生成し、そのインスタンスを介してインターフェースのメソッドを呼び出します。しかし、この方法にはいくつかの問題点があります。

1. クラス間の結合度が高くなる
2. 単体テストが困難になる
3. 実装の切り替えが面倒になる

これらの問題を解決するために、Spring Bootでは依存性注入（DI）という仕組みを提供しています。DIは、インスタンスの生成と注入をフレームワークに任せることで、上記の問題を解決します。

Spring Bootにおける依存性注入の実装方法

ここでは、Spring Bootでインターフェースをnewせずに利用するための具体的な方法を解説します。主に2つの方法があります：コンストラクタインジェクションとフィールドインジェクションです。

コンストラクタインジェクション

コンストラクタインジェクションは、コンストラクタを介して依存関係を注入する方法です。Spring Bootでは、@Autowiredアノテーションを使ってコンストラクタに依存関係を注入します。

Java

@Service
public class MyService {
    private final MyRepository myRepository;

    @Autowired
    public MyService(MyRepository myRepository) {
        this.myRepository = myRepository;
    }
}

この方法のメリットは、依存関係が明示的になり、変更不可能（final）なフィールドとして定義できる点です。また、テスト時にはモックオブジェクトを簡単に注入できるという利点もあります。

フィールドインジェクション

フィールドインジェクションは、フィールドに直接依存関係を注入する方法です。

Java

@Service
public class MyService {
    @Autowired
    private MyRepository myRepository;
}

この方法は記述が簡潔ですが、依存関係が隠蔽され、変更不可能（final）なフィールドとして定義できないという欠点があります。また、テスト時にはリフレクションなどを利用する必要があり、少し複雑になります。

インターフェースの定義と実装クラスの作成

では、具体的なインターフェースとその実装クラスの例を見てみましょう。

Java

// インターフェースの定義
public interface UserRepository {
    User findById(Long id);
    void save(User user);
}

// 実装クラス1
@Repository
public class JpaUserRepository implements UserRepository {
    @Autowired
    private EntityManager entityManager;

    @Override
    public User findById(Long id) {
        return entityManager.find(User.class, id);
    }

    @Override
    public void save(User user) {
        if (user.getId() == null) {
            entityManager.persist(user);
        } else {
            entityManager.merge(user);
        }
    }
}

// 実装クラス2
@Repository
public class MemoryUserRepository implements UserRepository {
    private final Map<Long, User> store = new ConcurrentHashMap<>();
    private long sequence = 0L;

    @Override
    public User findById(Long id) {
        return store.get(id);
    }

    @Override
    public void save(User user) {
        if (user.getId() == null) {
            user.setId(++sequence);
        }
        store.put(user.getId(), user);
    }
}

上記の例では、UserRepositoryというインターフェースを定義し、その実装としてJpaUserRepositoryとMemoryUserRepositoryの2つのクラスを作成しています。

@ComponentScanとBeanの自動検出

Spring Bootでは、@ComponentScanアノテーションを使って、コンポーネント（@Component、@Service、@Repository、@Controllerなどのアノテーションが付与されたクラス）を自動的に検出し、Beanとして登録します。

Java

@SpringBootApplication
@ComponentScan(basePackages = "com.example.demo")
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

この設定により、Spring Bootは起動時に指定されたパッ配下のクラスをスキャンし、アノテーションが付与されているクラスをBeanとして登録します。

Beanの定義と注入

では、実際にBeanを定義し、他のクラスに注入する方法を見てみましょう。

Java

@Service
public class UserService {
    private final UserRepository userRepository;

    @Autowired
    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    public User getUser(Long id) {
        return userRepository.findById(id);
    }

    public void createUser(User user) {
        userRepository.save(user);
    }
}

この例では、UserServiceクラスがUserRepositoryに依存しています。コンストラクタインジェクションを使ってUserRepositoryを注入しています。

Spring Bootは起動時にUserRepositoryの実装クラス（JpaUserRepositoryまたはMemoryUserRepository）を探し、見つかったものをBeanとして登録します。そして、UserServiceのコンストラクタにそのBeanを注入します。

プロファイルによる実装の切り替え

Spring Bootでは、プロファイルを使って、どの実装クラスを使用するかを切り替えることができます。

Java

@Repository
@Profile("dev")
public class MemoryUserRepository implements UserRepository {
    // 実装内容
}

@Repository
@Profile("prod")
public class JpaUserRepository implements UserRepository {
    // 実装内容
}

このように、@Profileアノテーションを使って、どのプロファイルでどの実装クラスを使用するかを指定できます。application.propertiesファイルでspring.profiles.activeプロパティを設定することで、使用するプロファイルを切り替えることができます。

Properties

# 開発環境
spring.profiles.active=dev

# 本番環境
spring.profiles.active=prod

ハマった点やエラー解決

依存性注入を実装する際によく遭遇する問題とその解決方法を以下に示します。

エラー1：No qualifying bean of type 'xxx' available

このエラーは、Spring Bootが指定された型のBeanを見つけられない場合に発生します。原因としては、以下のようなものが考えられます。

• 実装クラスに@Component、@Service、@Repositoryなどのアノテーションが付与されていない
• @ComponentScanの設定が正しくない（スキャン対象のパッケージに実装クラスが含まれていない）

解決策としては、実装クラスに適切なアノテーションを付与し、@ComponentScanの設定が正しいことを確認します。

エラー2：Circular dependency detected

このエラーは、クラス間に循環参照がある場合に発生します。例えば、クラスAがクラスBに依存し、クラスBがクラスAに依存している場合などです。

解決策としては、以下のような方法があります。

• 片方の依存関係を遅延注入にする（@Lazyアノテーションを使用）
• 依存関係の一部を別のサービスに切り出す

エラー3：Field injection is not recommended

この警告は、フィールドインジェクションを使用した場合に表示されることがあります。Spring Bootでは、コンストラクタインジェクションが推奨されています。

解決策としては、フィールドインジェクションをコンストラクタインジェクションに変更します。

解決策

インターフェースをnewせずに利用するための具体的な手順は以下の通りです。

1. インターフェースを定義する
2. インターフェースを実装したクラスを作成し、適切なアノテーション（@Component、@Service、@Repositoryなど）を付与する
3. 依存関係を注入したいクラスで、コンストラクタまたはフィールドに@Autowiredアノテーションを付与する
4. 必要に応じて、プロファイルを使って実装クラスを切り替える

まとめ

本記事では、Spring Bootでインターフェースをnewせずに利用するための依存性注入（DI）の仕組みについて解説しました。

• インターフェースを直接newするとクラス間の結合度が高くなる
• 依存性注入（DI）を使うことで、クラス間の結合度を下げることができる
• コンストラクタインジェクションが推奨される
• プロファイルを使って実装を切り替えることができる

この記事を通して、Spring Bootにおける依存性注入の基本的な使い方が理解できたことと思います。これにより、より柔軟でテストしやすいコードを書くことができるようになります。

今後は、より高度なDIの活用法や、Spring Bootの他の機能についても記事にする予定です。

参考資料

• Spring Framework Documentation
• Spring Boot Reference Documentation
• Effective Java (第3版)