新人と先輩の会話形式で理解しよう

新人

「Spring Bootでよく出てくるアノテーションって何ですか？」

先輩

「アノテーションは、Javaのプログラムの中で特別な意味を持つマークのようなものです。Spring Bootでは設定を簡単にするために多く使われていますよ。」

新人

「なるほど、具体的にどんな役割があるんですか？」

先輩

「じゃあ、まずはアノテーションの基本から説明していきますね！」

1. アノテーションとは？

アノテーション（Annotation）とは、Javaのコードに特定の情報を付加するための仕組みです。プログラムの実行時やコンパイル時に、特定の処理を適用したり、メタデータを提供したりする役割を持ちます。

アノテーションの例として、以下のようなものがあります。


@Override
public String toString() {
    return "このメソッドはオーバーライドされています";
}

@Override は、メソッドが親クラスのメソッドをオーバーライドしていることを示すアノテーションです。

2. Javaにおけるアノテーションの役割

アノテーションは、以下のような用途で使用されます。

コンパイラへの指示（例：@Override, @SuppressWarnings）
コードの情報を提供（例：@Deprecated, @FunctionalInterface）
フレームワークとの連携（例：Spring Bootのアノテーション）

例えば、@Deprecated を使うと、古いメソッドであることを示すことができます。


@Deprecated
public void oldMethod() {
    System.out.println("このメソッドは非推奨です。");
}

3. Spring Bootでアノテーションが重要な理由

Spring Bootでは、設定ファイルを減らし、簡単に開発できるようにアノテーションが活用されています。例えば、@SpringBootApplication はSpring Bootのメインクラスを示すために使用されます。


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

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

@SpringBootApplication を使うことで、Spring Bootの設定が自動的に行われ、簡単にアプリケーションを起動できます。

4. Spring Bootでよく使われる基本アノテーション

Spring Bootには、多くの便利なアノテーションがあります。その中でも基本的なものをいくつか紹介します。

@Component - Springのコンポーネントとして管理
@Service - ビジネスロジックを持つクラスに付与
@Repository - データベース操作を行うクラスに付与
@Autowired - 依存性注入（DI）を行う
@Controller - Webリクエストを処理するクラスに付与

これらのアノテーションを適切に使うことで、Spring Bootのアプリケーションを効率的に開発できます。

5. @Component、@Service、@Repositoryの違いと使い方

Spring Bootでは、特定のクラスをSpringの管理下に置くために、@Component、@Service、@Repository というアノテーションを使用します。

@Component

Springの管理対象のクラスを定義するための汎用的なアノテーションです。


import org.springframework.stereotype.Component;

@Component
public class SampleComponent {
    public String getMessage() {
        return "これは @Component の例です";
    }
}

@Service

ビジネスロジックを担当するクラスに付与するアノテーションです。


import org.springframework.stereotype.Service;

@Service
public class SampleService {
    public String process() {
        return "これは @Service の例です";
    }
}

@Repository

データベースにアクセスするクラスに付与するアノテーションです。


import org.springframework.stereotype.Repository;

@Repository
public class SampleRepository {
    public String fetchData() {
        return "これは @Repository の例です";
    }
}

6. @AutowiredとDI（依存性注入）の仕組み

Spring Bootでは、依存性注入（Dependency Injection, DI）を利用して、オブジェクトの管理を行います。

@Autowired の基本

@Autowired を使うと、Springが自動的にオブジェクトを注入してくれます。


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

@Component
public class SampleController {
    private final SampleService sampleService;

    @Autowired
    public SampleController(SampleService sampleService) {
        this.sampleService = sampleService;
    }

    public void execute() {
        System.out.println(sampleService.process());
    }
}

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

Spring Bootでは、コンストラクタを使った依存性注入を推奨しています。

コンストラクタを使用することで、テストがしやすくなり、フィールドが必ず初期化されるという利点があります。

フィールドインジェクションとの違い

フィールドに直接@Autowired を付与する方法もありますが、テストが難しくなるため、コンストラクタインジェクションの方が推奨されます。


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

@Component
public class SampleFieldInjection {
    @Autowired
    private SampleService sampleService;

    public void execute() {
        System.out.println(sampleService.process());
    }
}

フィールドインジェクションでは、Springの管理外でオブジェクトを作成する際に依存関係が注入されず、テストが難しくなる点に注意が必要です。

7. @Configurationと@Beanを使った設定クラスの作成

Spring Bootでは、@Configuration と @Bean を使用して、アプリケーションの設定を行うことができます。

@Configuration とは？

@Configuration は、設定クラスを示すアノテーションです。このクラス内で@Bean を使ってSpringの管理するオブジェクトを定義できます。


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {

    @Bean
    public SampleService sampleService() {
        return new SampleService();
    }
}

@Bean とは？

@Bean は、Springの管理対象のオブジェクト（Bean）を作成するためのアノテーションです。通常、@Configuration クラスの中で使用します。

@Bean を使ったコンポーネントの管理

例えば、SampleService を Spring に登録するには、以下のように @Bean を使用します。


import org.springframework.stereotype.Service;

public class SampleService {
    public String process() {
        return "これは @Bean を使って登録されたサービスです";
    }
}

@Autowired を使った利用方法

作成した @Bean を他のクラスで利用するには、@Autowired を使用します。


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

@Controller
public class SampleController {
    private final SampleService sampleService;

    @Autowired
    public SampleController(SampleService sampleService) {
        this.sampleService = sampleService;
    }

    public void execute() {
        System.out.println(sampleService.process());
    }
}

8. カスタムアノテーションの作成方法

Spring Bootでは、独自のアノテーションを作成することができます。これにより、コードの再利用性を高めたり、特定のルールを統一することができます。

カスタムアノテーションの作成

カスタムアノテーションは、@Retention と @Target を指定して作成します。


import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface LogExecutionTime {
}

カスタムアノテーションの利用

作成したカスタムアノテーションをメソッドに適用できます。


import org.springframework.stereotype.Service;

@Service
public class SampleService {

    @LogExecutionTime
    public void execute() {
        System.out.println("メソッドの実行時間を計測します");
    }
}

カスタムアノテーションの処理を実装

アノテーションを処理するために、SpringのAOP（Aspect-Oriented Programming）を利用します。


import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class LogAspect {

    @Around("@annotation(LogExecutionTime)")
    public Object logExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable {
        long start = System.currentTimeMillis();
        Object proceed = joinPoint.proceed();
        long executionTime = System.currentTimeMillis() - start;
        System.out.println(joinPoint.getSignature() + " 実行時間: " + executionTime + "ms");
        return proceed;
    }
}

このコードにより、@LogExecutionTime を付与したメソッドの実行時間を計測できるようになります。