Joifup Blog

Spring Bootで使用する主要なアノテーション：紹介と解説

2023-04-20

Spring BootJavaアノテーション

こんにちは！今回は、本業でSpring Bootを使って1年経ったので、Spring Bootで使用する主要なアノテーションについて紹介していきます。Spring Bootは、JavaでWebアプリケーション開発を効率的に行うためのフレームワークであり、多くのアノテーションが利用されています。今回の記事では、Spring Bootでよく使用される主要なアノテーションについて解説します。これらのアノテーションを理解し、活用することで、アプリケーション開発がスムーズに進むことでしょう。

1. @SpringBootApplication

@SpringBootApplicationは、Spring Bootアプリケーションのエントリーポイントを指定するアノテーションです。通常、このアノテーションは、アプリケーションのメインクラスに付与されます。このアノテーションが付与されたクラスは、以下の３つのアノテーションを自動的に設定します。

  • @SpringBootConfiguration：アプリケーションの設定クラスを指定します。
  • @EnableAutoConfiguration：Spring Bootが自動設定を行うことを指示します。
  • @ComponentScan：コンポーネントスキャンを行うパッケージを指定します。
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

2. @RestController

@RestControllerは、コントローラクラスを指定するアノテーションです。これにより、Spring Bootはクラス内のメソッドをHTTPエンドポイントとして認識し、要求に応じて対応するメソッドを呼び出します。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {
    @GetMapping("/hello")
    public String hello() {
        return "Hello, World!";
    }
}

3. @Autowired

@Autowiredは、Spring BootがDI（Dependency Injection）を行うことを指示するアノテーションです。これにより、指定されたクラスやインターフェイスのインスタンスが自動的に生成され、利用できるようになります。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.example.myapp.repository.MyRepository;

@Service
public class MyService {
    private final MyRepository myRepository;

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

4. @RequestMapping

@RequestMappingは、コントローラのメソッドに付与することで、特定のHTTP要求に対応するエンドポイントを指定するアノテーションです。HTTPメソッド（GET, POST, PUT, DELETEなど）やURLパスを指定することができます。

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {
    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    public String hello() {
        return "Hello, World!";
    }
}

5. @GetMapping, @PostMapping, @PutMapping, @DeleteMapping

これらのアノテーションは、それぞれHTTPメソッド（GET, POST, PUT, DELETE）に対応するリクエストをハンドルするメソッドを指定するために使用されます。これらは、@RequestMappingの短縮形として機能します。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {
    @GetMapping("/getMappingExample")
    public String getMappingExample() {
        return "This is a GET request.";
    }

    @PostMapping("/postMappingExample")
    public String postMappingExample() {
        return "This is a POST request.";
    }

    @PutMapping("/putMappingExample")
    public String putMappingExample() {
        return "This is a PUT request.";
    }

    @DeleteMapping("/deleteMappingExample")
    public String deleteMappingExample() {
        return "This is a DELETE request.";
    }
}

6. @Service

@Serviceは、ビジネスロジックを実装するクラスを指定するアノテーションです。このアノテーションにより、Spring Bootは指定されたクラスをサービスクラスとして認識し、DI（Dependency Injection）の対象となります。

import org.springframework.stereotype.Service;

@Service
public class MyService {
    // ビジネスロジックの実装
}

7. @Repository

@Repositoryは、データアクセスオブジェクト（DAO）を実装するクラスを指定するアノテーションです。このアノテーションにより、Spring Bootは指定されたクラスをリポジトリクラスとして認識し、DI（Dependency Injection）の対象となります。

import org.springframework.stereotype.Repository;

@Repository
public class MyRepository {
    // データアクセスロジックの実装
}

8. @Transactional

@Transactionalは、トランザクションの境界を指定するアノテーションです。このアノテーションを付与したメソッドは、トランザクションの開始と終了が自動的に制御されます。データベースの操作が複数のメソッドにまたがる場合や、一連の操作がアトミックに実行されることが必要な場合に使用されます。

import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

@Service
public class MyService {
    // ...

    @Transactional
    public void performTransaction() {
        // トランザクションを必要とする処理の実装
    }
}

まとめ

これらのアノテーションを適切に使用することで、アプリケーションの構造が整理され、コードの可読性や保守性が向上します。また、DIやトランザクション管理などの機能を活用することで、効率的に開発を行うことができます。今回紹介したアノテーションを理解し、活用してアプリケーション開発に役立ててください！