SpringアプリケーションでCouchbaseを使う

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

1. 前書き

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

2. クラスターサービス

JVMでアクティブなCouchbaseEnvironmentは1つだけであるという制約を満たすために、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 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. 実装

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

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

    @Autowired
    private ClusterService couchbase;

    private Bucket bucket;

    @PostConstruct
    private void init() {
        bucket = couchbase.openBucket("example-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 {
    JsonDocument toDocument(T t);
    T fromDocument(JsonDocument doc);
}

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

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

@Service
public class PersonDocumentConverter
  implements JsonDocumentConverter {
    ...
}

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

代わりに、toDocumentメソッドの場合、JsonObjectクラスの流暢なメソッドを使用して、JsonDocumentをラップする前に、JsonObjectを作成してデータを設定します。

@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メソッドの場合、fromDocumentメソッドのPersonクラスのセッターとともにJsonObjectクラスのgetStringメソッドを使用します。

@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 {
    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 {

    @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 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アプリケーションに組み込み、Spring Dataを使用せずに基本的な永続化レイヤーを実装することはかなり簡単であることを示しました。

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

Couchbase Java SDKの詳細については、公式のCouchbase developer documentation site.をご覧ください。

TOC