メインコンテンツまでスキップ

生成コードとカスタム・コードの結合

このTipは@tcharlによって提出されました

目標: Jhipsterは、その強力なドメイン固有言語のおかげで、モデルエンティティの管理に非常に適しています。 しかし、カスタムコードとジェネレーティブな世界の両方で最高のものを得ることは、常に困難な作業です。 ここでは、それを実現するために採用できるさまざまなパターンを紹介します。

パターン1 - 初回のみ生成​

このアプローチは最も単純であり、ほとんどのユース・ケースで使用されます。 これは、エンティティを一度モデリングし、最初のモデルを生成し、この最初のショットの後に必要なものをオーバーライドすることで構成されます。 ある日再同期したい場合は、いつでも別のブランチで再生成でき、IDEで両方のコードを比較できます。 しかし、その後のプロセスは常に苦痛であり、大規模なアップグレードには何日もかかる可能性があります。

長所​

  • 好きなようにできます。

短所​

  • JHipsterの新機能の恩恵を受けられないことになります。

パターン2 - 生成コードとカスタムコードの分割​

これは、生成されたクラスを変更するのを避け、カスタム・コードを専用のものとして立てるようにします。 ここでは、--with-generated-flagのjhipster cliオプションを使用して、生成されたクラスとカスタムクラスを簡単に区別できます。 最後に、生成されたホームページではなくカスタムホームページにルーティングするために、フロントエンド部分のメインルーターを変更するだけです。

ルータファイルが世代ごとに上書きされるのを避けるために、プロジェクトのルートに.yo-resolveファイルを作成して、yeomanに期待される動作を伝えることができます。

例：

src/main/resources/swagger/api.yml skip
src/main/webapp/app/modules/home/home.tsx skip

長所​

  • 生成とカスタムコードを簡単に組み合わせることができます。

短所​

  • デッドコードが存在します。
  • モデルとは異なる名前やパッケージを持つカスタムクラスが存在することになります（DDDのベストプラクティスと考えることができますが、それでも）。

パターン3 - サイド・バイ・サイド​

ここでの目標は、クラス拡張とBeanの優先順位を使用して、生成されたコードの代わりにカスタム・コードを注入することです。

Customerjhipsterエンティティの例を見てみましょう。

リポジトリ​

リポジトリレベルでは、jhipsterが生成したリポジトリにNoRepositoryBeanアノテーションを使用してアノテーションを付け、検出を無効にします。 次に、カスタムリポジトリクラスを作成します。

@Repository
@Primary
MemberRepositoryPrimary extends MemberRepository

サービス​

ここでは、ControllerにカスタムBeanを注入できるように、serviceImplオプションを使用します。 次に、生成されたサービスを単純に拡張し、優先順位を得るためにBeanに@Primaryというアノテーションを付けることができます。

コントローラ​

カスタム・エンドポイントには別のAPIプレフィックスを使用します（例えば/api/v2）。

Angular​

同じ拡張機能をフロントエンド側にも適用します。その後、app.module.tsファイルでBeanの優先順位を設定します。

providers: [
// 別のエントリをキープする
{ provide: MemberDomainService, useExisting: MemberDomainServicePrimary },
]

長所​

  • 生成されたコードの動作をオーバーライドできます。
  • カスタムコードの検索が容易です。
  • カスタムコードに対してもJhipsterのベストレイアウトを維持できます。

短所​

  • ファイルの重複が発生します。

代替のサイドバイサイド・アプローチ​

このアプローチは、既存のJHipsterアプリケーションに、生成されたコードへの変更を最小限に抑えながら機能を追加することを目的としています。

リポジトリ層​

すべてのカスタムメソッドを含むリポジトリインターフェースを、別のカスタムパッケージ内に作成します。このアプローチにより、生成されたリポジトリコードは変更されずに保たれ、カスタムロジックは整理され、保守しやすくなります。

サービス層​

この層にカスタムコードを追加するための主なアプローチは3つあります。

アスペクト指向プログラミング (AOP):

AOPを使用すると、コアビジネスロジックを変更することなく、ロギング、セキュリティ、トランザクション管理などの横断的関心事を導入できます。この関心事の分離により、よりクリーンでモジュール化されたコードの維持に役立ちます。

イベントリスナー:

新しい機能がアプリケーション内の特定のイベント（例：Fooエンティティの保存後）によってトリガーされる場合、Springのイベントリスナーメカニズムを使用できます。これにより、コアロジックはクリーンに保たれますが、実行フローの追跡が難しくなる可能性があります。

デコレーターパターン:

新しいメソッドを追加したり、既存の動作を制御された方法で変更したりするには、デコレーターパターンが強く推奨されます。このパターンは、元のクラスを、追加機能を提供するデコレーターでラップすることを含みます。クリーンでテスト可能であり、元のクライアントクラスへの変更を最小限に抑えるため、保守性が向上します。

ステップ1: サービス・クラスがどのように生成されるかに応じて、既存のインターフェースを作成または拡張します

interface IFooService {
    void newFeature();
    //Existing method declarations
   ...
}

ステップ2: コンポジションによる拡張

@Service
@Qualifier("entended")
public class ExtendedFooService implements FooService{
    private final FooService existingFooService;
    private final ExtendedFooRepository extendedFooRepository; // For new repository functionality
   ...
}

ステップ3: 既存のサービス・クラスに@Primaryを追加し、ステップ1で既存のサービス・クラスをインターフェースの実装としてマークします。

ステップ4: 元のサービス・クライアントの属性型を、ステップ1で作成したインターフェースに変更します。

サービス・メソッドの複数の実装を持つ可能性が低い場合、またはサービス・メソッドの頻繁な変更を期待しない場合は、ステップ1を省略し、このアプローチの簡略化された実装のために、以下のステップで関連する変更を調整できます。

Web層​

新しいエンドポイント・コントローラーを作成します。

@RestController
@RequestMapping("/api/extended/foo")
public class ExtendedFooController {
    private final ExtendedFooService extendedFooService;

    public ExtendedFooController(ExtendedFooService extendedFooService) {
        this.extendedFooService = extendedFooService;
    }

    // New endpoints
    @GetMapping("/new-feature")
    public ResponseEntity<?> newFeature() {
        // Implementation
    }
}

Antonio Goncalves氏によるヒストリーはこちら: https://www.youtube.com/watch?v=9WVpwIUEty0 詳細なYouTubeビデオはこちら: https://youtu.be/aKvK-QpwaZA サイドバイサイドのサンプルを含むサンプルリポジトリはこちらで入手できます: https://github.com/OsgiliathEnterprise/jhipster-side-by-side-sample