サービスメソッドの実装

ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、こちらまでご連絡ください。

サービスメソッドの実装
- 生成されたクラスのアップデート

バックエンドの生成

手順3/3

Service Builderを使用する場合は、サービスモジュールを利用してサービスを実装します。アプリケーションのプロジェクトはコンポーネントであるため、Webモジュールからサービスレイヤーを参照できます。

guestbook-serviceモジュールのGuestbookLocalServiceImplおよび EntryLocalServiceImplで、それぞれゲストブックおよびエントリのサービスを実装します。

GuestbookLocalServiceImplでゲストブックのサービスを実装するには、次の手順に従います。

com.liferay.docs.guestbook.service.implパッケージで、GuestbookLocalServiceImplを開きます。次に、このaddGuestbookメソッドを追加します。

public Guestbook addGuestbook(
    long userId, String name, ServiceContext serviceContext)
    throws PortalException {

    long groupId = serviceContext.getScopeGroupId();

    User user = userLocalService.getUserById(userId);

    Date now = new Date();

    validate(name);

    long guestbookId = counterLocalService.increment();

    Guestbook guestbook = guestbookPersistence.create(guestbookId);

    guestbook.setUuid(serviceContext.getUuid());
    guestbook.setUserId(userId);
    guestbook.setGroupId(groupId);
    guestbook.setCompanyId(user.getCompanyId());
    guestbook.setUserName(user.getFullName());
    guestbook.setCreateDate(serviceContext.getCreateDate(now));
    guestbook.setModifiedDate(serviceContext.getModifiedDate(now));
    guestbook.setName(name);
    guestbook.setExpandoBridgeAttributes(serviceContext);

    guestbookPersistence.update(guestbook);

    return guestbook;

}

このメソッドは、データベースにゲストブックを追加します。ユーザーから渡されたデータとともに、環境からメタデータ（現在のユーザーID、グループIDなど）を取得します。このデータを検証し、それを使用してGuestbookオブジェクトを構築します。このメソッドはこのオブジェクトをデータベースに保持し、オブジェクトを返します。 Service Builderはすでにモデルを生成しており、そのモデルをデータベースにマップするすべてのコードが生成されているため、ここではビジネスロジックのみを実装します。

Guestbookオブジェクトを取得するためのメソッドを追加します。

public List<Guestbook> getGuestbooks(long groupId) {

    return guestbookPersistence.findByGroupId(groupId);
}

public List<Guestbook> getGuestbooks(long groupId, int start, int end, 
    OrderByComparator<Guestbook> obc) {

    return guestbookPersistence.findByGroupId(groupId, start, end, obc);
}

public List<Guestbook> getGuestbooks(long groupId, int start, int end) {

    return guestbookPersistence.findByGroupId(groupId, start, end);
}

public int getGuestbooksCount(long groupId) {

    return guestbookPersistence.countByGroupId(groupId);
}

これらは、Service Builderで生成したFinderを呼び出します。最初のメソッドは groupIdで指定されたサイトから、ゲストブックのリストを取得します。次の2つのメソッドは、オプションで特定の順序でページ番号を付けられたリストを取得します。最後の方法では、特定のサイトのゲストブックの総数を取得できます。

最後に、ゲストブックの認証メソッドを追加します。
```
protected void validate(String name) throws PortalException {
    if (Validator.isNull(name)) {
        throw new GuestbookNameException();
    }
}
```
このメソッドはLiferay DXPのValidatorを使用して、ユーザーがゲストブック名のテキストを入力したことを確認します。
[CTRL]+[SHIFT]+O を押してインポートを整理し、プロンプトが表示されたら次のクラスを選択します。
- java.util.Date
- com.liferay.portal.kernel.service.ServiceContext
- com.liferay.docs.guestbook.model.Entry
- com.liferay.portal.kernel.util.Validator

EntryLocalServiceImplエントリにサービスを実装する準備ができました。次の手順を実行してください。

com.liferay.docs.guestbook.service.implパッケージで、 EntryLocalServiceImplを開きます。このaddEntryメソッドを追加します。

public Entry addEntry(
    long userId, long guestbookId, String name, String email,
    String message, ServiceContext serviceContext)
    throws PortalException {

    long groupId = serviceContext.getScopeGroupId();

    User user = userLocalService.getUserById(userId);

    Date now = new Date();

    validate(name, email, message);

    long entryId = counterLocalService.increment();

    Entry entry = entryPersistence.create(entryId);

    entry.setUuid(serviceContext.getUuid());
    entry.setUserId(userId);
    entry.setGroupId(groupId);
    entry.setCompanyId(user.getCompanyId());
    entry.setUserName(user.getFullName());
    entry.setCreateDate(serviceContext.getCreateDate(now));
    entry.setModifiedDate(serviceContext.getModifiedDate(now));
    entry.setExpandoBridgeAttributes(serviceContext);
    entry.setGuestbookId(guestbookId);
    entry.setName(name);
    entry.setEmail(email);
    entry.setMessage(message);

    entryPersistence.update(entry);

    return entry;
}

addGuestbookメソッドと同様に、addEntryは、ユーザーが入力したデータとともに現在のコンテキストからデータを取得し、検証して、モデルオブジェクトを作成します。そのオブジェクトはデータベースに保持され、返されます。

このupdateEntryメソッドを追加します。

public Entry updateEntry (
    long userId, long guestbookId, long entryId, String name, String email,
    String message, ServiceContext serviceContext)
    throws PortalException, SystemException {

    Date now = new Date();

    validate(name, email, message);

    Entry entry = getEntry(entryId);

    User user = userLocalService.getUserById(userId);

    entry.setUserId(userId);
    entry.setUserName(user.getFullName());
    entry.setModifiedDate(serviceContext.getModifiedDate(now));
    entry.setName(name);
    entry.setEmail(email);
    entry.setMessage(message);
    entry.setExpandoBridgeAttributes(serviceContext);

    entryPersistence.update(entry);

    return entry;
}

このメソッドは、最初にエントリを取得しそのデータをアップデートします。変更された日付も含めて、ユーザーが送信した内容を反映します。

このdeleteEntryメソッドを追加します。
```
public Entry deleteEntry (long entryId, ServiceContext serviceContext)
    throws PortalException {

    Entry entry = getEntry(entryId);

    entry = deleteEntry(entryId);

    return entry;
}
```
このメソッドは、entryIdで定義されたentryオブジェクトを取得し、データベースから削除してから、削除されたオブジェクトを返します。
Entryオブジェクトを取得するためのメソッドを追加します。
```
public List<Entry> getEntries(long groupId, long guestbookId) {
    return entryPersistence.findByG_G(groupId, guestbookId);
}

public List<Entry> getEntries(long groupId, long guestbookId, int start, int end)
    throws SystemException {

    return entryPersistence.findByG_G(groupId, guestbookId, start, end);
}

public List<Entry> getEntries(
    long groupId, long guestbookId, int start, int end, OrderByComparator<Entry> obc) {

    return entryPersistence.findByG_G(groupId, guestbookId, start, end, obc);
}

public int getEntriesCount(long groupId, long guestbookId) {
    return entryPersistence.countByG_G(groupId, guestbookId);
}
```
GuestbookLocalServiceImplのgetterのようなこれらのメソッドは、Service Builderで生成したFinderを呼び出します。ただし、これらのgetEntries *メソッドは、指定されたゲストブックとサイトからエントリを取得します。最初のメソッドはエントリのリストを取得します。次のメソッドはページ番号を付けられたリストを取得します。 3番目の方法では、ページ番号を付けられたリストがソートされ、最後のメソッドではエントリの総数が整数として取得されます。

validateメソッドを追加します。

protected void validate(String name, String email, String entry)
    throws PortalException {

    if (Validator.isNull(name)) {
        throw new EntryNameException();
    }

    if (!Validator.isEmailAddress(email)) {
        throw new EntryEmailException();
    }

    if (Validator.isNull(entry)) {
        throw new EntryMessageException();
    }
}

このメソッドは、エントリの作成時にユーザーが関連するデータを入力したことを確認します。

[CTRL]+[SHIFT]+O を押してインポートを整理し、プロンプトが表示されたら次のクラスを選択します。
- java.util.Date
- com.liferay.portal.kernel.service.ServiceContext
- com.liferay.docs.guestbook.model.Entry
- com.liferay.portal.kernel.util.Validator

これでローカルサービスメソッドは、ポートレットクラスで参照されるサービスを実装します。

生成されたクラスのアップデート

サービスメソッドを実装したので、アプリケーションの残りの部分で利用できるようにする必要があります。これを行うには、buildServiceを再度実行します。

Gradle Tasks → guestbook-service → buildと進んだらbuildServiceで右クリックし、 Run Gradle Tasksを選択します。ユーティリティクラスでは、Service Builderによって、新しく作成されたサービスメソッドへの呼び出しが設定されます。
Project Explorerで、guestbook-serviceモジュールを右クリックし、Refreshを選択します。 guestbook-apiモジュールに対してこの手順を繰り返します。これにより、Service Builderによる変更がLiferay Dev Studio DXPに表示されます。
Project Explorerで、guestbook-serviceモジュールを右クリックして、Gradle → Refresh Gradle Projectを選択します。 guestbook-apiモジュールに対してこの手順を繰り返します。これにより、モジュールのGradle依存関係が最新のものになります。

これで、新しいバックエンドが生成されました。それでは、プロトタイプをリファクタリングして使用します。

« モデル、サービス、永続レイヤーの生成プロトタイプのリファクタリング »

ヘルプセンター

製品

リソース

セキュリティ

サポート

ドキュメンテーション

サービスメソッドの実装

サービスメソッドの実装

生成されたクラスのアップデート