JHIPSTERのBLUEPRINTを作る のバックアップ(No.2)
- バックアップ一覧
- 差分 を表示
- 現在との差分 を表示
- ソース を表示
- JHIPSTERのBLUEPRINTを作る へ行く。
- 1 (2019-08-01 (木) 16:46:03)
- 2 (2019-08-01 (木) 18:29:19)
- 3 (2019-08-02 (金) 18:15:06)
- 4 (2019-08-05 (月) 16:37:01)
目次 †
blueprintとは †
直訳すると、青写真なんだけど、yeomanでいうところの、generator-generator
で、JHIPSTER5までは、moduleという概念だったんだけど、次の点が改善されていると思う。
- webアプリケーションのレイヤーごとに、テンプレートを切り替えれるようにした。
レイヤーとは、たとえば、サーバとか、クライアントとか、エンティティ等である。
JHIPSTER6ぐらいから使われだした、JHIPSTER用のテンプレート生成テンプレート
翻訳元のサイト †
https://www.jhipster.tech/modules/creating-a-blueprint/
いっておきますが、英語は得意ではありません。そして、意訳が多分にふくまれております。あしからず。
blueprintを作成する †
JHipsterブループリントは、
yeomanのジェネレータの合成機能
https://yeoman.io/authoring/composability.html
をつかっています。
特定のJHipsterサブジェネレータから構成され、そのサブジェネレータの機能を拡張するYeomanジェネレータです。ブループリントは、サブジェネレータの定義済みゲッタをオーバーライドし、独自のテンプレートと機能を提供することができます。
JHipsterの青写真は、JHipsterのマーケットプレイス
https://www.jhipster.tech/modules/marketplace/#/list
にjhipster-blueprintラベルとともに記載されています。
これにより、JHipsterの特定の部分、たとえばクライアント側のテンプレートのみをオーバーライドできるサードパーティ製のブループリントを作成できます。
blueprintの使い方 †
ブループリントを使用するには、下記のコマンドを実行してください。
jhipster --blueprint <blueprint name>
Kotolinコードを生成するblueprint †
JHipster Kotlinのblueprintは、同等のKotlinコードとサーバーサイドJavaコードのほとんどを置き換えます。
https://github.com/jhipster/jhipster-kotlin
JHIPSTERのBLUEPRINT使用例 †
クライアントのサブジェネレータであるbuleプリントを上書きする例 †
https://github.com/hipster-labs/generator-jhipster-sample-blueprint
blueprintの初期スケルトンの作成方法 †
JHipsterブループリントジェネレータを使用してブループリントを初期化できます。
JHipsterブループリントジェネレータを使用するには、以下のコマンドを実行します。
npm install -g generator-jhipster-blueprint mkdir my-blueprint && cd my-blueprint yo jhipster-blueprint
質問に答えながら上書きしたいサブジェネレータを選択してください。
JHipsterブループリントの基本事項 †
JHipsterのblueprintは:
- NPMのパッケージです。そして、Yeoman のgeneratorです。
下記に上げるような他のジェネレータ同様に、Yeomanのルールに従っています。
なので、yoコマンドをつかってインストールしたり、更新したりできます。
. 先頭は generator-jhipster-で始めてください。
yeoman-generator と jhipster-blueprint の２つのキーワードをもっている必要があります。
ブループリントは、次のサブジェネレーター（ジェネレーターフォルダーの下）のみを拡張できます。
- common
- client
- server
- entity
- entity-client
- entity-server
- entity-i18n
- languages
- spring-controller
- spring-service
generator-jhipsterをインポートする †
JHipsterブループリントは、依存関係としてgenerator-jhipsterを持っている必要があり、それをオーバーライドするために適切なsubジェネレータをインポートする必要があります。
const chalk = require('chalk');
const ClientGenerator = require('generator-jhipster/generators/client');
...
module.exports = class extends ClientGenerator {
constructor(args, opts) {
super(args, Object.assign({ fromBlueprint: true }, opts)); // 変数fromBlueprintは重要です
const jhContext = this.jhipsterContext = this.options.jhipsterContext;
if (!jhContext) {
this.error(`これは、JHIPSTERのblueprintです。 利用方法は、右記のような書式です。 ${chalk.yellow('jhipster --blueprint helloworld')}`);
}
this.configOptions = jhContext.configOptions || {};
// このサブジェネレータ用のセットアップオプションはJHipsterで再利用してます。
jhContext.setupClientOptions(this, jhContext);
}
get initializing() {
// 親クラスのメソッドを直接よびだすことで何もyeomanのフェースを上書きしません。
return super._initializing();
}
// other phases of the sub generator
}
上記の例の ClientGenerator? のように、 アンダーバーで始まるメソッドは、親クラスで、再利用できます。
JHipsterのblueprintなどのサブジェネレータは、yeomanのフェーズで、どうするかの記述をします。
それぞれのyeomanのフェーズは、getterメソッドになっています。(get ではじまるやつ)
たとえば、get initializing を例にとってみます。
blueprintはフェーズでの処理を、オーバーライドすることで、カスタマイズすることができるのです。
yeomanのフェーズのカスタマイズ方法 †
1) なにもしない場合は、こちら
get initializing() { return super._initializing(); }
親クラスの初期化メソッドを呼び出しています。アンダーバーがついていますね。
2) フェーズを全部上書きする例, 自前の制御オンリーですね。
get initializing() { return { myCustomInitPhaseStep() { // Do all your stuff here }, myAnotherCustomInitPhaseStep(){ // Do all your stuff here } }; }3) フェーズを部分的に上書きする方法です.既存のメソッドの上書きや、新しく初期化メソッドを追加する例get initializing() { const phaseFromJHipster = super._initializing(); const myCustomPhaseSteps = { displayLogo() { // JHIPSTERのdisplayLogoメソッドを上書き }, myCustomInitPhaseStep() { // あなたのオリジナルの処理 }, } return Object.assign(phaseFromJHipster, myCustomPhaseSteps); }
ブループリントから直接JHipsterの変数や関数にアクセスすることもできます。
利用可能な変数と関数 †
設定ファイル .yo-rc.json からの変数: †
あなたはJHipster設定.yo-rc.jsonとあなたのblueprint設定の両方からなる設定にアクセスすることができます
グローバル変数 (ジェネレータ定数): †
ジェネレータ定数で定数を使うことができます。
const javaDir = `${jhipsterConstants.SERVER_MAIN_SRC_DIR + this.packageFolder}/`;
const resourceDir = jhipsterConstants.SERVER_MAIN_RES_DIR;
const webappDir = jhipsterConstants.CLIENT_MAIN_SRC_DIR;
関数: †
あなたはgenerator-baseですべての関数を使うことができます：
this.angularAppName = this.getAngularAppName(); // get the Angular application name. this.printJHipsterLogo(); // to print the JHipster logo
注意： generator-base.jsと内の変数generator-constants.jsはパブリックAPIの一部なので、semverのバージョン管理に従います。
しかしgenerator-base-private.js、utils.jsなどのような他のファイルはsemverのバージョン管理に従わず、マイナーバージョン間でメソッドシグネチャを壊すかもしれません。
blueprintの開発のお作法 †
blueprintの開発中に、以下の手順に注意してください。それらはとても重要です
- ブループリントをグローバルにリンク
注意: ブループリント（ステップ3）を作成中の各プロジェクトにリンクしたくない場合は、yeomanはグローバルにリンクされたYarnモジュールをフェッチしていないようなので、Yarnの代わりにNPMを使用してください。一方、これは以下のすべてのステップでもNPMを使用する必要があることを意味します。
cd my-blueprint npm link
- JHipsterの開発版をあなたの設計図にリンクしてください（オプション：マスターブランチやあなた自身のカスタムフォークのように、リリースされていないJHipster版を使いたい場合にのみ必要です）
cd generator-jhipster npm link cd my-blueprint npm link generator-jhipster
- 生成するアプリの新しいフォルダを作成し、そこにJHipsterとあなたの設計図をリンクします。
mkdir my-app && cd my-app npm link generator-jhipster-myblueprint npm link generator-jhipster (Optional: Needed only if you are using a non-released JHipster version) jhipster -d --blueprint myblueprint
JHipsterマーケットプレイスにblueprintを登録する †
blueprintをJHipsterマーケットプレイスで入手できるようにするには、2つのキーワードが登録されてる必要があります。
- yeoman-generator
- jhipster-blueprint
公開されているnpm にあることを確認する必要がありますpackage.json。
しくったのを見つけた場合 †
JHipsterモジュールでもブループリントでもないエントリがマーケットプレイスに見つかった場合は、jhipster/jhipster.github に Pull Requestを送るという手段で、
modules-config.jsonファイルのblacklistedModulesセクションに追加することで、ブラックリストに追加できます。
