改善此页面

创建蓝图

JHipster蓝图是Yeoman生成器，它是由特定的JHipster子生成器composed 来扩展该子生成器的功能的。 蓝图可以覆盖子生成器的任何已定义的getter，并提供其自己的模板和功能。

JHipster蓝图在带有jhipster-blueprint标签的JHipster市场 上列出。

这允许创建可以覆盖JHipster特定部分（例如仅客户端模板）的第三方蓝图。

使用蓝图

要使用蓝图，请运行以下命令

jhipster --blueprint <blueprint name>

例子

JHipster Kotlin 蓝图用等效的Kotlin代码替换了大多数服务器端Java代码。

这是我们的官方蓝图，展示了如何创建自己的蓝图。

JHipster示例蓝图 显示了如何覆盖客户端子生成器。

或者，您可以使用JHipster蓝图生成器 来帮助您初始化蓝图。

要使用JHipster蓝图生成器，请运行以下命令

npm install -g generator-jhipster-blueprint

mkdir my-blueprint && cd my-blueprint

yo jhipster-blueprint

在回答问题时选择您要覆盖的子生成器。

JHipster蓝图的基本规则

JHipster蓝图：

  • 是NPM软件包，并且是Yeoman生成器。
  • 遵循http://yeoman.io/generators/ 上列出的Yeoman规则的扩展，并且可以使用yo命令进行安装，使用和更新。 它不是由generator-前缀，而是以generator-jhipster-前缀，并且不仅具有yeoman-generator关键字，还必须具有两个关键字，即yeoman-generator和jhipster-blueprint。
  • 蓝图只能扩展以下子生成器（在generators文件夹下）
    • common
    • client
    • server
    • entity
    • entity-client
    • entity-server
    • entity-i18n
    • languages
    • spring-controller
    • spring-service

导入generator-jhipster

JHipster蓝图必须具有generator-jhipster作为依赖项，并且应该导入适当的子生成器以覆盖它。

    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 variable is important

            const jhContext = this.jhipsterContext = this.options.jhipsterContext;

            if (!jhContext) {
                this.error(`This is a JHipster blueprint and should be used only like ${chalk.yellow('jhipster --blueprint helloworld')}`);
            }

            this.configOptions = jhContext.configOptions || {};
            // This sets up options for this sub generator and is being reused from JHipster
            jhContext.setupClientOptions(this, jhContext);
        }

        get initializing() {
            // Here we are not overriding this phase and hence its being handled by JHipster
            return super._initializing();
        }

        // other phases of the sub generator
    }

任何以_开头的方法通过super.的形式都可以在继承类中使用，例如上例中的ClientGenerator。

每个JHipster子生成器都由多个yeoman阶段组成，每个阶段都是一个getter，例如get initializing。 蓝图可以自定义其覆盖的子生成器的一个或多个阶段。

有多种方法可以从JHipster定制阶段。

1) 让JHipster处理一个阶段，蓝图不会覆盖任何内容。

    get initializing() {
        return super._initializing();
    }

2) 覆盖整个阶段，蓝图将控制这一阶段。

    get initializing() {
        return {
            myCustomInitPhaseStep() {
                // Do all your stuff here
            },
            myAnotherCustomInitPhaseStep(){
                // Do all your stuff here
            }
        };
    }

3) 部分覆盖阶段，蓝图从JHipster获取阶段并对其进行自定义。

    get initializing() {
        const phaseFromJHipster = super._initializing();
        const myCustomPhaseSteps = {
            displayLogo() {
                // 重写JHipster中_initializing阶段的displayLogo方法
            },
            myCustomInitPhaseStep() {
                // 你自己的业务逻辑
            },
        }
        return Object.assign(phaseFromJHipster, myCustomPhaseSteps);
    }

您还可以直接从蓝图访问JHipster的变量和函数。

可用的变量和功能

配置中的变量：

您可以访问.yo-rc.json中的配置，该配置将同时包含JHipster配置和您的蓝图配置。

全局变量：

您可以使用在 generator-constants中的常量:

    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(); // 获取Angular应用程序名称。
    this.printJHipsterLogo(); // 打印JHipster徽标

注意: generator-base.js 中的功能和 generator-constants.js 中的变量是公共API的一部分，因此将遵循semver版本控制。但是其他文件如generator-base-private.js、utils.js 等将不会遵循semver版本控制，并且可能会在次要版本中破坏方法签名。

开发中运行本地蓝图版本

在开发蓝图期间，请注意以下步骤。 他们非常重要。

  1. 全局链接您的蓝图

注意：如果您不想将蓝图（第3步）链接到正在创建的每个项目，请使用NPM而不是Yarn，因为yeoman似乎无法获取全局链接的Yarn模块。 另一方面，这意味着您还必须在以下所有步骤中使用NPM。

cd my-blueprint
npm link
  1. 将JHipster的开发版本链接到您的蓝图（可选：仅当您要使用未发布的JHipster版本（例如master分支或您自己的自定义fork）时才需要）
cd generator-jhipster
npm link

cd my-blueprint
npm link generator-jhipster
  1. 为要生成的应用程序创建一个新文件夹，并在其中链接JHipster和您的蓝图
mkdir my-app && cd my-app

npm link generator-jhipster-myblueprint
npm link generator-jhipster (可选：仅在使用未发布的JHipster版本时才需要)

jhipster -d --blueprint myblueprint

向JHipster市场注册蓝图

为了在JHipster市场中能够找到你的蓝图，您需要确保在已发布的npm包package.json中有两个关键字yeoman-generator和jhipster-blueprint。 如果您在市场上找到不是JHipster模块或蓝图的任何条目，则可以通过将其添加到modules-config.json文件的blacklistedModules部分中来将其列入黑名单，方法是对 [jhipster/jhipster.github.io项目] (https://github.com/jhipster/jhipster.github.io) 发出拉取请求

一旦您将蓝图发布到NPM，您的蓝图就会在我们的市场上出现。