Docs Menu
Docs Home
/ /

チュートリアル:Spring Data フレームワークの統合

このチュートリアルでは、 Javaドライバーと spring Data MongoDB を使用して、spring shellアプリケーションで高パフォーマンスの一括挿入を実行する方法を説明します。

spring Data MongoDB は、 MongoDBの公式spring Dataオブジェクトドキュメントマッパー(ODM)です。 POJO(Plain Old Java Object)とリポジトリの抽象化を使用してMongoDBとやり取りできます。動的クエリ、インデックス作成、ネストされたドキュメントマッピングなどのMongoDB固有の機能をサポートすると同時に、手動の find() 呼び出しや update() 呼び出しなどの 単調なコード を削減します。

上に構築されたフレームフレームワークです。自動構成、デフォルト、本番環境に対応する機能が追加され、spring Data MongoDBとの統合など、spring ベースのJavaアプリケーションの構築が簡素化されます。詳細については、書込み保証 (write concern) のドキュメントを参照してください。

依存関係インジェクション(DI)は、spring Framework の主要原則です。これにより、WiredTigerコンテナは操作を使用する他の操作を実行するために、以下の操作を実行します。これは、使用するオブジェクトを初期化と構築に担当する一般的なオブジェクト指向開発とは異なります。

依存関係インジェクションの詳細については、spring Framework ドキュメントの「 依存関係インジェクション 」ページを参照してください。

BulkOperations は、データベースに適用できる書込み (write) 操作のリストを含むspring Data MongoDBインターフェースです。同様のMongoDB Javaドライバー操作にマップされる次の操作の任意の組み合わせを処理できます。

  • insert

  • updateOne

  • updateMany

  • replaceOne

  • deleteOne

  • deleteMany

  • upsert

BulkOperation は順序付けまたは順序付けなしで使用できます。順序付き一括操作では操作が順番に実行され、エラーが検出された場合はエラー コードが返されます。順序付けられていない操作は並列で実行されるため、通常はより高速です。ただし、操作中にエラーが発生したかを手動で確認する必要があります。

一括操作の詳細については、次のリソースを参照してください。

  • spring Framework APIドキュメントの BulkOperations

  • このガイドの「 一括書込み操作 」

  • 一括書き込み操作 ( MongoDB Serverマニュアル)

このチュートリアルの完了したサンプルアプリは、springDataBulkInsertサンプルプロジェクトGitHubリポジトリにあります。

注意

指定されていないインポート

このページには、チュートリアル内のファイルに必要なインポート ステートメントは含まれていません。完全なファイルについては GitHubリポジトリを参照してください。

このチュートリアルを開始する前に、次のコンポーネントがインストールされ、設定されていることを確認してください。

使用しているMongoDB Javaドライバー およびJavaバージョンと互換性のあるspring Data MongoDBバージョンを使用していることを確認してください。互換性の仕様については、spring Data MongoDBドキュメントの「 要件 」ページとこのガイドの「 互換性 」ページを参照してください。

注意

shell を使用してサンプルをプロジェクトした場合は、バージョン管理の互換性はすでに考慮されており、spring-boot-starter-data-mongodb コンポーネントはすでにpom.xml ファイルに含まれています。

次の依存関係を pom.xmlファイルに追加します。

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-mongodb</artifactId>
<version>3.2.5 </version>
</dependency>
<dependency>
<groupId>net.datafaker</groupId>
<artifactId>datafaker</artifactId>
<version>2.4.3</version>
</dependency>

datafaker 依存関係は、 一括書込み操作で使用する大量の Product オブジェクトを生成するために使用されます。

MongoConfigMongoClientクラスには、spring DataフレームワークがMongoDB Serverとやりとりができるようにする オブジェクトの構成と、その他の構成オプションが設定されています。構成オプションの詳細については、このガイドの「 接続オプションの指定 」ページを参照してください。

このアプリケーションでは、クラスに @Configuration アノテーション、メソッドに @Bean アノテーション、パラメータ変換に @Value アノテーションを使用します。これらの注釈により、spring Inversion of Control(IOC)コンテナがオブジェクトを管理できるようになります。これらの注釈の詳細については、spring Dataフレームワークガイドの次のセクションを参照してください。

MongoDB接続を設定するには、MongoConfig.javaファイルを作成し、次の構成クラスとテンプレート クラスを追加します。

package com.mongodb.examples.springdatabulkinsert;
import com.mongodb.ConnectionString;
import com.mongodb.MongoClientSettings;
import com.mongodb.client.MongoClient;
import com.mongodb.client.MongoClients;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.mongodb.core.MongoTemplate;
@Configuration
public class MongoConfig {
@Value("${mongodb.uri}")
private String uri;
@Value("${mongodb.database}")
private String databaseName;
@Bean
public MongoClient mongoClient() {
ConnectionString connectionString = new ConnectionString(uri);
MongoClientSettings mongoClientSettings = MongoClientSettings.builder()
.applyConnectionString(connectionString)
.build();
return MongoClients.create(mongoClientSettings);
}
@Bean
public MongoTemplate mongoTemplate() throws Exception {
return new MongoTemplate(mongoClient(), databaseName);
}
}

注意

APIとインターフェース

この実装では、MongoRepository などのspring Dataリポジトリインターフェースを拡張するのではなく、MongoTemplate APIを使用して、一括操作をきめ細やかに制御できるようにします。

application.propertiesファイルに接続文字列(mongodb.uri)、データベース名(mongodb.database)、一括操作数(documentCount)の値を設定します。

mongodb.database=bulk
mongodb.uri=<connection string>
documentCount=25000

このチュートリアルでは、bulk 25000という名前のデータベースを使用し、保存するために<connection string> 、 ドキュメントを作成します。 プレースホルダーを Atlas 配置の接続文字列に置き換えます。詳細については、このガイドの「 java-get-started- connection-string 」セクションを参照してください。

クラスをコレクションにマッピングすると、spring IoCコンテナはオブジェクトをMongoDBドキュメントとして保存できます。クラスがマッピングされるコレクションを指定するには、@Document アノテーションを使用します。オブジェクトをMongoDBドキュメントにマッピングする方法の詳細については、spring Data MongoDBドキュメントの「 マッピング注釈の概要 」セクションを参照してください。

@Id次のコードの 注釈は、オブジェクトid フィールドがドキュメント_id フィールドにマップされることを示します。これはMongoDBドキュメントで一意の識別子として使用されます。配列を除く任意のタイプのフィールドを一意の識別子として選択できます。詳細については、spring Data MongoDBドキュメントの「 マッピングレイヤーセクションで _idフィールドがどのように処理されるか 」を参照してください。

次のコードを使用して Product.javaファイルを作成し、Productクラスを定義し、それを productsコレクションにマッピングします。

@Document("products")
public class Product {
private static final Logger LOG = LoggerFactory.getLogger(Product.class);
@Id
private String id;
private String name;
private int qty;
private double price;
private Date available;
private Date unavailable;
private String skuId;
public Product(String name, int qty, double price, Date available, Date unavailable, String skuId) {
this.name = name;
this.qty = qty;
this.price = price;
this.available = available;
this.unavailable = unavailable;
this.skuId = skuId;
}
public static List<Product> randomProducts(int count) {
Faker faker = new Faker();
Random rand = new Random();
List<Product> retProds = new ArrayList<>(count);
for (int i = 0; i < count; ++i) {
Product product = new Product(faker.animal().name(),
1 + rand.nextInt(998),
10.0 + rand.nextInt(9999),
new Date(), new Date(),
faker.idNumber().valid());
retProds.add(product);
}
return retProds;
}
// Getters and setters
}

Productクラスには、Product オブジェクトの配列を生成する静的メソッドが含まれています。フィールドの getter と setter を定義することもできます。

ProductRepositoryオブジェクトはProduct オブジェクトのコレクションを管理します。 オブジェクトには、ProductRepository MongoTemplateMongoConfigクラスで生成された beans を使用する必要があります。@Autowired mongoTemplateを引数として含むコンストラクタで アノテーションを使用することで、springコンテナはコンストラクタ インジェクションを使用してmongoTemplate 依存関係を挿入します。コンストラクターインジェクションの詳細については、spring Framework ドキュメントの「コンストラクターベースの依存関係インジェクション」セクションを参照してください。

次のコードを使用して ProductRepository.javaファイルを作成し、Product オブジェクトのコレクションを管理するための ProductRepositoryクラスを定義します。

@Repository
public class ProductRepository {
private static final Logger LOG = LoggerFactory
.getLogger(ProductRepository.class);
private final MongoTemplate mongoTemplate;
@Autowired
public ProductRepository(MongoTemplate mongoTemplate){
this.mongoTemplate = mongoTemplate;
}
public void updateProductQuantity(String name, int newQuantity) {
Query query = new Query(Criteria.where("name").is(name));
Update update = new Update();
update.set("quantity", newQuantity);
UpdateResult result = mongoTemplate.updateFirst(query, update, Product.class);
if (result == null)
LOG.error("No documents updated");
else
LOG.info(result.getModifiedCount() + " document(s) updated..");
}
public int bulkInsertProducts(int count) {
LOG.info("Dropping collection...");
mongoTemplate.dropCollection(Product.class);
LOG.info("Dropped!");
Instant start = Instant.now();
mongoTemplate.setWriteConcern(WriteConcern.W1.withJournal(true));
List<Product> productList = Product.randomProducts(count);
BulkOperations bulkInsertion = mongoTemplate.bulkOps(BulkOperations.BulkMode.UNORDERED, Product.class);
bulkInsertion.insert(productList);
BulkWriteResult bulkWriteResult = bulkInsertion.execute();
LOG.info("Bulk insert of " + bulkWriteResult.getInsertedCount() + " documents completed in " + Duration.between(start, Instant.now()).toMillis() + " milliseconds");
return bulkWriteResult.getInsertedCount();
}
}

bulkInsertProducts() メソッドは順序なしの一括挿入を使用するため、操作の順序が保証されないことでパフォーマンスを向上させることができます。

メインのアプリケーションクラスは、 ProductRepository をトリガーして指定された数の Product オブジェクトを生成し、それらをMongoDBデータベースに保存します。 @Autowired アノテーションを使用して ProductRepository を挿入し、ロギングを実装します。

アプリケーションを実行するには、メインクラスに次のコードを追加します。

@SpringBootApplication
public class SpringDataBulkInsertApplication implements CommandLineRunner {
@Value("${documentCount}")
private int count;
private static final Logger LOG = LoggerFactory
.getLogger(SpringDataBulkInsertApplication.class);
@Autowired
private ProductRepository repository;
public static void main(String[] args) {
SpringApplication.run(SpringDataBulkInsertApplication.class, args);
}
@Override
public void run(String... args) throws Exception {
repository.bulkInsertProducts(count);
LOG.info("End run");
System.exit(0);
}
}

spring Data MongoDB は、 MongoDBを操作するための高レベルの抽象化を提供します。自動依存関係インジェクションをサポートすることでアプリケーションアーキテクチャを簡素化し、手動のクライアント構成と複雑なクエリ処理が不要になります。かためのコードの分離を減らし、 オブジェクト指向のデータアクセス をサポートすることで、データアクセスを効率化し、懸念事項を明確に認識できるようになります。

MongoDB のスケーリングと書込み (write) の詳細については、次のリソースを参照してください。

MongoDB Community のサポートや貢献については、MongoDB Developer Community を参照してください。

戻る

サードパーティ統合

項目一覧