JHipster 领域语言 (JDL) - 选项

概要

在JHipster中，您可以为实体指定选项，例如分页或DTO。 您可以使用JDL进行相同的操作，或者使用实体上的注解，或者使用以下语法：

entity A {
  name String required
}
entity B
entity C

dto A, B with mapstruct

paginate A with infinite-scroll
paginate B with pagination
paginate C with pager  // pager is only available in AngularJS

service A with serviceClass
service C with serviceImpl

可用选项的完整列表可查看 选项列表.

1. 怎么做
2. 语法
3. 使用use XYZ选项
4. 示例
   1. 基本一元示例
   2. 基本二元示例
   3. all和*关键字示例
   4. all和 * 带有排除项的示例（一元）
   5. all和 * 带有排除项的示例（二元）
   6. 具有自定义值的选项
   7. 混合例子
5. 关于service
6. 微服务相关的选项
7. 自定义注解
8. 可用选项
9. 更多

怎么做

有两种选择：

• 一元（无选项值）
• 二元（带值）

有三种将选项应用于实体的方法：

• 使用选项名称 (dto、readOnly等)，可查看示例
• 使用注解
• 使用use XYZ形式

不建议将它们混合使用，因为这会降低可读性。

语法

对于常规形式：

<option name> <option entity list>

or

<option name> <option entity list> with <option value>

or

<option name> <option entity list> with <option value> except <option excluded entity list>

or 

<option name> <option entity list> except <option excluded entity list>

• 对于一元选项：
  • 选项名称和列表是必需的
  • 排除的实体是可选的，带有except关键字（有关更多详细信息，请参见下文）
• 对于二元选项：
  • 实体列表位于关键字with和选项值之前
  • 同样，被排除的实体最后带有except关键字

对于注解：

@<option name>
entity <entity name>

or

@<option name>(<option value>)

• 与Java类似，注解可以将值放在括号中
  • 根据选项的不同，值可以是或可以不是可选的

使用use XYZ选项

使用use 选项形式，您可以在实体上指定一些选项。 它是在JHipster Code 2020期间创建的，其创建原因是：

• 解决禁用选项的问题（在JHipster中有不止一种”否”的用法：no, false, none）
• 提出一种按实体对选项进行分组的方法

entity A
entity B
entity C

use serviceClass for * except C
use mapstruct, serviceImpl, infinite-scroll for A, B
use pagination for C

示例

每个示例将具有三种形式：

• 常规的
• 基于注解的
• use 形式（如适用）

基本一元示例

常规的：

entity A

readOnly A

基于注解的：

@readOnly
entity A

基本二元示例

常规的：

entity A

dto A with mapstruct

基于注解的

@dto(mapstruct)
entity A

使用 use 关键字：

entity A

use mapstruct, serviceImpl, pagination for A

all和 * 关键字示例

all 和 * 是相同的

常规的：

entity A
entity B

dto all with mapstruct

基于注解的：

@dto(mapstruct)
entity A

@dto(mapstruct)
entity B

使用 use 关键字：

entity A
entity B

use mapstruct, serviceImpl, pagination for *

all和 * 带有排除项的示例（一元）

常规的：

entity A
entity B

skipClient * except A

基于注解的：

entity A

@skipClient
entity B

使用 use 关键字：

entity A
entity B

use mapstruct, serviceImpl, pagination for * except A

all和 * 带有排除项的示例（二元）

常规的：

entity A
entity B

dto all with mapstruct except A

基于注解的：

entity A

@dto(mapstruct)
entity B

使用 use 关键字：

entity A
entity B

use mapstruct, serviceImpl, pagination for all except A

具有自定义值的选项

entity A
entity B

microservice all with mySuperMS

混合例子

常规的：

entity A
entity B
entity C

readOnly B, C
dto * with mapstruct except C
service * with serviceClass except C
search A with elasticsearch

基于注解的：

@dto(mapstruct)
@search(elastisearch)
@service(serviceClass)
entity A

@readOnly
@dto(mapstruct)
@service(serviceClass)
entity B

@readOnly
entity C

关于service

指定的service都不会创建将直接调用repository接口的resource类。 这是默认和最简单的选项，请参阅A。

service with serviceClass（请参见B）将使resource调用service类，后者将调用repository接口。 service with serviceImpl （请参阅C）将创建一个service接口，该接口将由resource类使用。

该接口由将调用repository接口的具体类实现。

除非确定，否则不使用任何service，这对CRUD来说是最简单的选择。 如果您将有很多业务逻辑，这些业务逻辑将使用多个repository，因此非常适合用于service类。 JHipster不是使用service接口的粉丝，但是如果您喜欢它们，请使用service的实现类。

entity A
entity B
entity C

// no service for A
service B with serviceClass
service C with serviceImpl

微服务相关的选项

从JHipster v3开始，可以创建微服务。 您可以指定一些选项以在JDL中生成您的实体： 微服务的名称和搜索引擎。

您可以通过以下方法指定微服务的名称（JHipster应用程序的名称）：

entity A
entity B
entity C
microservice * with mysuperjhipsterapp except C
microservice C with myotherjhipsterapp
search * with elasticsearch except C

第一个选项用于告诉JHipster您希望微服务处理您的实体，而第二个选项指定您如何以及是否希望搜索实体。

自定义注解

自定义注解在JDL中是可以的，例如：

@customAnnotation(customValue)
entity A

这样做的主要目的是用于方案（blueprint）：有时，您需要为实体甚至字段提供自定义选项。 对于常规选项（dto、pagination等)，这些选项将像在CLI中一样在JSON中生成。 但是，对于自定义选项，它们将在转储的JSON中的options键下生成。

可用选项

以下是JDL支持的实体选项：

不是您要找的？ 查看 应用程序选项.

更多

应用程序选项 在这儿