SpringアプリケーションでのCouchbaseの使用

投稿日: 2019-10-18 2022-10-30
タグ: Couchbase, NoSQL, Spring Persistence

1. 序章

このCouchbaseの紹介のフォローアップでは、Springデータを使用せずにSpringアプリケーションの基本的な永続層を作成するために一緒に使用できる一連のSpringサービスを作成します。

2. クラスターサービス

単一のCouchbaseEnvironmentのみがJVMでアクティブになる可能性があるという制約を満たすために、Couchbaseクラスターに接続し、を直接公開せずにデータバケットへのアクセスを提供するサービスを作成することから始めます。 ClusterまたはCouchbaseEnvironmentインスタンス。

2.1. インターフェース

ClusterServiceインターフェイスは次のとおりです。

public interface ClusterService {
    Bucket openBucket(String name, String password);
}

2.2. 実装

実装クラスはDefaultCouchbaseEnvironmentをインスタンス化し、Springコンテキストの初期化中の@PostConstructフェーズ中にクラスターに接続します。

これにより、クラスターがnullにならず、クラスが他のサービスクラスに挿入されたときにクラスターが接続され、1つ以上のデータバケットを開くことができるようになります。

@Service
public class ClusterServiceImpl implements ClusterService {
    private Cluster cluster;
    
    @PostConstruct
    private void init() {
        CouchbaseEnvironment env = DefaultCouchbaseEnvironment.create();
        cluster = CouchbaseCluster.create(env, "localhost");
    }
...
}

次に、 ConcurrentHashMap を提供して、開いているバケットを格納し、openBucketメソッドを実装します。

private Map<String, Bucket> buckets = new ConcurrentHashMap<>();

@Override
synchronized public Bucket openBucket(String name, String password) {
    if(!buckets.containsKey(name)) {
        Bucket bucket = cluster.openBucket(name, password);
        buckets.put(name, bucket);
    }
    return buckets.get(name);
}

3. バケットサービス

アプリケーションの設計方法によっては、複数のSpringサービスで同じデータバケットへのアクセスを提供する必要がある場合があります。

アプリケーションの起動中に2つ以上のサービスで同じバケットを開こうとしただけの場合、これを試みる2番目のサービスでConcurrentTimeoutExceptionが発生する可能性があります。

このシナリオを回避するために、BucketServiceインターフェイスとバケットごとの実装クラスを定義します。各実装クラスは、ClusterServiceと特定のBucketへの直接アクセスを必要とするクラスの間のブリッジとして機能します。

3.1. インターフェース

BucketServiceインターフェースは次のとおりです。

public interface BucketService {
    Bucket getBucket();
}

3.2. 実装

次のクラスは、「baeldung-tutorial」バケットへのアクセスを提供します。

@Service
@Qualifier("TutorialBucketService")
public class TutorialBucketService implements BucketService {

    @Autowired
    private ClusterService couchbase;
    
    private Bucket bucket;
    
    @PostConstruct
    private void init() {
        bucket = couchbase.openBucket("baeldung-tutorial", "");
    }

    @Override
    public Bucket getBucket() {
        return bucket;
    }
}

TutorialBucketService実装クラスにClusterServiceを挿入し、 @PostConstruct、で注釈が付けられたメソッドでバケットを開くことにより、バケットを使用できるようになります。 TutorialBucketServiceが他のサービスに注入されたとき。

4. 永続層

Bucket インスタンスを取得するためのサービスが整ったので、 Bucket インスタンスを公開せずに、エンティティクラスのCRUD操作を他のサービスに提供するリポジトリのような永続化レイヤーを作成します彼らへ。

4.1. 個人エンティティ

永続化するPersonエンティティクラスは次のとおりです。

public class Person {

    private String id;
    private String type;
    private String name;
    private String homeTown;

    // standard getters and setters
}

4.2. JSONとの間のエンティティクラスの変換

Couchbaseが永続化操作で使用するJsonDocumentオブジェクトとの間でエンティティクラスを変換するには、JsonDocumentConverterインターフェイスを定義します。

public interface JsonDocumentConverter<T> {
    JsonDocument toDocument(T t);
    T fromDocument(JsonDocument doc);
}

4.3. JSONコンバーターの実装

次に、PersonエンティティにJsonConverterを実装する必要があります。

@Service
public class PersonDocumentConverter
  implements JsonDocumentConverter<Person> {
    ...
}

JacksonライブラリをJsonObjectクラスのtoJsonおよびfromJsonメソッドと組み合わせて使用して、をシリアル化および逆シリアル化できます。 ]エンティティ、ただし、そうすることで追加のオーバーヘッドがあります。

代わりに、 toDocument メソッドの場合、 JsonObject クラスの流暢なメソッドを使用して、 JsonObject を作成してデータを入力してから、JsonDocumentをラップします。 ：

@Override
public JsonDocument toDocument(Person p) {
    JsonObject content = JsonObject.empty()
            .put("type", "Person")
            .put("name", p.getName())
            .put("homeTown", p.getHomeTown());
    return JsonDocument.create(p.getId(), content);
}

また、 fromDocument メソッドでは、JsonObjectクラスのgetStringメソッドを、Personクラスのセッターとともに使用します。 X168X] fromDocument メソッド：

@Override
public Person fromDocument(JsonDocument doc) {
    JsonObject content = doc.content();
    Person p = new Person();
    p.setId(doc.id());
    p.setType("Person");
    p.setName(content.getString("name"));
    p.setHomeTown(content.getString("homeTown"));
    return p;
}

4.4. CRUDインターフェース

ここで、エンティティクラスの永続化操作を定義する汎用CrudServiceインターフェイスを作成します。

public interface CrudService<T> {
    void create(T t);
    T read(String id);
    T readFromReplica(String id);
    void update(T t);
    void delete(String id);
    boolean exists(String id);
}

4.5. CRUDサービスの実装

エンティティクラスとコンバータークラスを配置したら、PersonエンティティにCrudServiceを実装し、上記のバケットサービスとドキュメントコンバーターを挿入し、初期化中にバケットを取得します。

@Service
public class PersonCrudService implements CrudService<Person> {
    
    @Autowired
    private TutorialBucketService bucketService;
    
    @Autowired
    private PersonDocumentConverter converter;
    
    private Bucket bucket;
    
    @PostConstruct
    private void init() {
        bucket = bucketService.getBucket();
    }

    @Override
    public void create(Person person) {
        if(person.getId() == null) {
            person.setId(UUID.randomUUID().toString());
        }
        JsonDocument document = converter.toDocument(person);
        bucket.insert(document);
    }

    @Override
    public Person read(String id) {
        JsonDocument doc = bucket.get(id);
        return (doc != null ? converter.fromDocument(doc) : null);
    }

    @Override
    public Person readFromReplica(String id) {
        List<JsonDocument> docs = bucket.getFromReplica(id, ReplicaMode.FIRST);
        return (docs.isEmpty() ? null : converter.fromDocument(docs.get(0)));
    }

    @Override
    public void update(Person person) {
        JsonDocument document = converter.toDocument(person);
        bucket.upsert(document);
    }

    @Override
    public void delete(String id) {
        bucket.remove(id);
    }

    @Override
    public boolean exists(String id) {
        return bucket.exists(id);
    }
}

5. すべてを一緒に入れて

永続化レイヤーのすべての部分が配置されたので、PersonCrudServiceを使用して登録者を永続化および取得する登録サービスの簡単な例を次に示します。

@Service
public class RegistrationService {

    @Autowired
    private PersonCrudService crud;
    
    public void registerNewPerson(String name, String homeTown) {
        Person person = new Person();
        person.setName(name);
        person.setHomeTown(homeTown);
        crud.create(person);
    }
    
    public Person findRegistrant(String id) {
        try{
            return crud.read(id);
        }
        catch(CouchbaseException e) {
            return crud.readFromReplica(id);
        }
    }
}

6. 結論

いくつかの基本的なSpringサービスでは、CouchbaseをSpringアプリケーションに組み込み、SpringDataを使用せずに基本的な永続層を実装するのは非常に簡単であることを示しました。

このチュートリアルに示されているソースコードは、GitHubプロジェクトで入手できます。

Couchbase Java SDKの詳細については、公式のCouchbase開発者向けドキュメントサイトをご覧ください。

getdocs

13036