jhipster，中文释义： Java 热爱者!

JHipster is a development platform to quickly generate, develop, & deploy modern web applications & microservice architectures.

JHipster 可以通过代码生成，让你快速开发web应用和微服务。

安装

1. 安装java,Git Node.js
2. 安装 JHipster npm install -g generator-jhipster建议安装最新的7.0版本,
3. 创建应用目录 mkdir myApp && cd myApp
4. 运行jhipster命令，根据提示设置应用
5. 可以通过JDL Studio 来生成jhipster-jdl.jh文件
6. 然后通过jhipster jdl jhipster-jdl.jh来生成代码，JDL 后续会重点介绍

JDL 入门

JDL 是jhipster的数据模型定义文件，通过这个文件我们可以定义数据结构，然后jhipster基于这个JDL，就可以生成实体类、服务类以及前端页面。

例如，我们要开发投诉建议，假如设计的数据表如下：

使用jhipster,我们可以用jdl来定义：

/** * 反馈记录表 */entity FeedbackRecord { /** 反馈类型*/ feedbackType FeedbackType, /** 问题描述 */ title String, /** 反馈状态 */ feedbackStatus FeedbackStatus, /** 是否已完成 */ lastReplyTime Integer, /** 关闭类型 */ closeType FeedbackCloseType, /** 创建时间 */ createdDate Instant, /** 创建者 */ createdBy String}/** 反馈类型 */enum FeedbackType { ADVICE, COMPLAINTS}/** 反馈状态 */enum FeedbackStatus { TO_BE_SUBMIT, TO_BE_REPLY, TO_BE_CONFIRMED}/** 关闭类型 */enum FeedbackCloseType { NORMALLY, TIMEOUT}dto * with mapstructservice all with serviceImplpaginate all with pagination

详细讲解：

实体和字段

entity 表示一个实体，可以增加字段，注意，不用增加id

语法是：

[<entity javadoc>][<entity annotation>*]entity <entity name> [(<table name>)] { [<field javadoc>] [<field annotation>*] <field name> <field type> [<validation>*]}

例如：

entity A { name String required age Integer min(42) max(42)}

可以增加required、min、max等验证

字段的注释:

/** * This is a comment * about a class * @author Someone */entity A { /** 名称 */ name String age Integer // this is yet another comment}

JHipster支持许多字段类型。这种支持取决于您的数据库后端，因此我们使用Java类型来描述它们：JavaString将以不同的方式存储在Oracle或Cassandra中，这是JHipster的优势之一，可以为您生成正确的数据库访问代码。

• String: Java字符串。它的默认大小取决于基础后端（如果使用JPA，默认情况下为255），但是您可以使用校验规则进行更改（例如，修改 max大小为1024）。
• Integer: Java整数。
• Long: Java长整数。
• Float: Java浮点数.
• Double: Java双精度浮点数.
• BigDecimal: java.math.BigDecimal对象, 当您需要精确的数学计算时使用（通常用于财务操作）。
• LocalDate: java.time.LocalDate对象, 用于正确管理Java中的日期。
• Instant: java.time.Instant对象, 用于表示时间戳，即时间线上的瞬时点。
• ZonedDateTime: java.time.ZonedDateTime对象, 用于表示给定时区（通常是日历中会议、约定）中的本地日期时间。请注意，rest和持久层都不支持时区，因此您很可能应该使用Instant。
• Duration: java.time.Duration对象, 用于表示时间量。
• UUID: java.util.UUID对象.
• Boolean: Java布尔型.
• Enumeration:Java枚举对象。选择此类型后，子生成器将询问您要在枚举中使用哪些值，并将创建一个特定的enum类来存储它们。
• Blob: Blob对象，用于存储一些二进制数据。选择此类型时，子生成器将询问您是否要存储通用二进制数据，图像对象或CLOB（长文本）。图像将专门在Angular侧进行优化处理，因此可以将其正常显示给最终用户。

字段的数据类型及数据库支持：

枚举

对于可枚举的状态，建议采用枚举值：

enum [<enum name>] { <ENUM KEY> ([<enum value>])}

例如：

/** 反馈类型 */enum FeedbackType { ADVICE, COMPLAINTS}

关系

SQL数据库支持表和表的关联：

• OneToOne
• OneToMany
• ManyToOne
• ManyToMany

如何定义关系呢？

relationship (OneToMany | ManyToOne | OneToOne | ManyToMany) { <from entity>[{<relationship name>[(<display field>)]}] to <to entity>[{<relationship name>[(<display field>)]}] }

例如, 下面的例子里，我们定义两个对象，file和Chunk，1个Chunk属于一个File：

/** * 文件 */entity File { /** 文件名 */ name String, /** 文件大小 */ size Long, /** 文件路径 */ path String, /** 分片数 */ chunks Integer, /** 是否已完成 */ complete Integer}/** * 文件分片 */entity Chunk { /** md5值 */ md5 String, /** 分片序号 */ number Integer, /** 分片名称 */ name String}relationship ManyToOne { /** 所属文件 */ Chunk{file} to File}

生成代码配置

JHipster提供了丰富的配置，可以用来指定生成代码时的策略，例如是否要生成DTO对象，是否需要支持分页，是否需要生成service类，如果生成service，是使用serviceClass还是serviceImpl。

示例如下：

entity A { name String required}entity Bentity C// 筛选实体filter *// 生成dtodto A, B with mapstruct// 分页paginate A with infinite-scrollpaginate B with paginationpaginate C with pager // pager is only available in AngularJS// 生成serviceservice A with serviceClassservice C with serviceImpl

生成代码

首先定义jdl文件：

/** * 反馈记录表 */entity FeedbackRecord { /** 反馈类型*/ feedbackType FeedbackType, /** 问题描述 */ title String, /** 反馈状态 */ feedbackStatus FeedbackStatus, /** 是否已完成 */ lastReplyTime Integer, /** 关闭类型 */ closeType FeedbackCloseType, /** 创建时间 */ createdDate Instant, /** 创建者 */ createdBy String}/** 反馈类型 */enum FeedbackType { ADVICE, COMPLAINTS}/** 反馈状态 */enum FeedbackStatus { TO_BE_SUBMIT, TO_BE_REPLY, TO_BE_CONFIRMED}/** 关闭类型 */enum FeedbackCloseType { NORMALLY, TIMEOUT}// 筛选实体filter *// 生成DTOdto * with mapstruct// 生成带接口和实现的serviceservice all with serviceImpl// 支持分页paginate all with pagination

然后生成代码：

jhipster jdl feedback.jh --force

可以看到类似下面的输出

D:Projectjhipster-7>jhipster jdl feedback.jh --forceINFO! Using JHipster version installed locally in current project's node_modulesINFO! Executing import-jdl feedback.jhINFO! The JDL is being parsed.info: The dto option is set for FeedbackRecord, the 'serviceClass' value for the 'service' is gonna be set for this entity if no other value has been set.INFO! Found entities: FeedbackRecord.INFO! The JDL has been successfully parsedINFO! Generating 0 applications.INFO! Generating 1 entity.INFO! Generating entities for application undefined in a new parallel processFound the D:Projectjhipster-7.jhipsterFile.json configuration file, entity can be automatically generated!Found the D:Projectjhipster-7.jhipsterChunk.json configuration file, entity can be automatically generated!Found the D:Projectjhipster-7.jhipsterFeedbackRecord.json configuration file, entity can be automatically generated! info Creating changelog for entities File,Chunk,FeedbackRecord force .yo-rc.json force .jhipsterFeedbackRecord.json force .jhipsterFile.json force .jhipsterChunk.json force srcmainjavacomcompanydatahubdomainFile.java force srcmainjavacomcompanydatahubwebrestFileResource.java force srcmainjavacomcompanydatahubrepositoryFileRepository.java force srcmainjavacomcompanydatahubserviceFileService.java force srcmainjavacomcompanydatahubserviceimplFileServiceImpl.java force srcmainjavacomcompanydatahubservicedtoFileDTO.java force srcmainjavacomcompanydatahubservicemapperEntityMapper.java force srcmainjavacomcompanydatahubservicemapperFileMapper.java force srctestjavacomcompanydatahubwebrestFileResourceIT.java force srctestjavacomcompanydatahubdomainFileTest.java force srctestjavacomcompanydatahubservicedtoFileDTOTest.java force srctestjavacomcompanydatahubservicemapperFileMapperTest.java force srcmainwebappappsharedmodelfile.model.ts force srcmainwebappappentitiesfilefile-details.vue force srcmainwebappappentitiesfilefile-details.component.ts force srcmainwebappappentitiesfilefile.vue force srcmainwebappappentitiesfilefile.component.ts force srcmainwebappappentitiesfilefile.service.ts force srcmainwebappappentitiesfilefile-update.vue force srcmainwebappappentitiesfilefile-update.component.ts force srctestjavascriptspecappentitiesfilefile.component.spec.ts force srctestjavascriptspecappentitiesfilefile-details.component.spec.ts force srctestjavascriptspecappentitiesfilefile.service.spec.ts force srctestjavascriptspecappentitiesfilefile-update.component.spec.ts force srcmainwebappapprouterentities.ts force srcmainwebappappmain.ts force srcmainwebappappcorejhi-navbarjhi-navbar.vue force srcmainwebappi18nzh-cnfile.json force srcmainwebappi18nzh-cnglobal.json force srcmainwebappi18nenfile.json force srcmainwebappi18nenglobal.json force srcmainjavacomcompanydatahubdomainChunk.java force srcmainjavacomcompanydatahubwebrestChunkResource.java force srcmainjavacomcompanydatahubrepositoryChunkRepository.java force srcmainjavacomcompanydatahubserviceChunkService.java force srcmainjavacomcompanydatahubserviceimplChunkServiceImpl.java force srcmainjavacomcompanydatahubservicedtoChunkDTO.java force srcmainjavacomcompanydatahubservicemapperChunkMapper.java force srctestjavacomcompanydatahubwebrestChunkResourceIT.java force srctestjavacomcompanydatahubdomainChunkTest.java force srctestjavacomcompanydatahubservicedtoChunkDTOTest.java force srctestjavacomcompanydatahubservicemapperChunkMapperTest.java force srcmainwebappappsharedmodelchunk.model.ts force srcmainwebappappentitieschunkchunk-details.vue force srcmainwebappappentitieschunkchunk-details.component.ts force srcmainwebappappentitieschunkchunk.vue force srcmainwebappappentitieschunkchunk.component.ts force srcmainwebappappentitieschunkchunk.service.ts force srcmainwebappappentitieschunkchunk-update.vue force srcmainwebappappentitieschunkchunk-update.component.ts force srctestjavascriptspecappentitieschunkchunk.component.spec.ts force srctestjavascriptspecappentitieschunkchunk-details.component.spec.ts force srctestjavascriptspecappentitieschunkchunk.service.spec.ts force srctestjavascriptspecappentitieschunkchunk-update.component.spec.ts force srcmainwebappi18nzh-cnchunk.json force srcmainwebappi18nenchunk.json create srcmainjavacomcompanydatahubdomainFeedbackRecord.java create srcmainjavacomcompanydatahubwebrestFeedbackRecordResource.java create srcmainjavacomcompanydatahubrepositoryFeedbackRecordRepository.java create srcmainjavacomcompanydatahubserviceFeedbackRecordService.java create srcmainjavacomcompanydatahubserviceimplFeedbackRecordServiceImpl.java create srcmainjavacomcompanydatahubservicedtoFeedbackRecordDTO.java create srcmainjavacomcompanydatahubservicemapperFeedbackRecordMapper.java create srctestjavacomcompanydatahubwebrestFeedbackRecordResourceIT.java create srctestjavacomcompanydatahubdomainFeedbackRecordTest.java create srctestjavacomcompanydatahubservicedtoFeedbackRecordDTOTest.java create srctestjavacomcompanydatahubservicemapperFeedbackRecordMapperTest.java create srcmainjavacomcompanydatahubdomainenumerationFeedbackType.java create srcmainjavacomcompanydatahubdomainenumerationFeedbackStatus.java create srcmainjavacomcompanydatahubdomainenumerationFeedbackCloseType.java create srcmainwebappappsharedmodelfeedback-record.model.ts create srcmainwebappappentitiesfeedback-recordfeedback-record-details.vue create srcmainwebappappentitiesfeedback-recordfeedback-record-details.component.ts create srcmainwebappappentitiesfeedback-recordfeedback-record.vue create srcmainwebappappentitiesfeedback-recordfeedback-record.component.ts create srcmainwebappappentitiesfeedback-recordfeedback-record.service.ts force srcmainresourcesconfigliquibasechangelog20210312045459_added_entity_File.xml force srcmainresourcesconfigliquibasefake-datafile.csv create srcmainwebappappentitiesfeedback-recordfeedback-record-update.vue force srcmainresourcesconfigliquibasemaster.xml force srcmainresourcesconfigliquibasechangelog20210312045500_added_entity_Chunk.xml force srcmainresourcesconfigliquibasechangelog20210312045500_added_entity_constraints_Chunk.xml force srcmainresourcesconfigliquibasefake-datachunk.csv create srcmainresourcesconfigliquibasechangelog20210312072243_added_entity_FeedbackRecord.xml create srcmainresourcesconfigliquibasefake-datafeedback_record.csv create srcmainwebappappentitiesfeedback-recordfeedback-record-update.component.ts create srctestjavascriptspecappentitiesfeedback-recordfeedback-record.component.spec.ts create srctestjavascriptspecappentitiesfeedback-recordfeedback-record-details.component.spec.ts create srctestjavascriptspecappentitiesfeedback-recordfeedback-record.service.spec.ts create srctestjavascriptspecappentitiesfeedback-recordfeedback-record-update.component.spec.ts create srcmainwebappappsharedmodelenumerationsfeedback-type.model.ts create srcmainwebappappsharedmodelenumerationsfeedback-status.model.ts create srcmainwebappappsharedmodelenumerationsfeedback-close-type.model.ts create srcmainwebappi18nzh-cnfeedbackType.json create srcmainwebappi18nenfeedbackType.json create srcmainwebappi18nzh-cnfeedbackStatus.json create srcmainwebappi18nenfeedbackStatus.json create srcmainwebappi18nzh-cnfeedbackCloseType.json create srcmainwebappi18nenfeedbackCloseType.json create srcmainwebappi18nzh-cnfeedbackRecord.json create srcmainwebappi18nenfeedbackRecord.jsonEntity File generated successfully.Entity Chunk generated successfully.Entity FeedbackRecord generated successfully.Running `webapp:build` to update client app

包含domain、service、controller等都有生成：

生成代码介绍

Domain

package com.company.datahub.domain;import com.company.datahub.domain.enumeration.FeedbackCloseType;import com.company.datahub.domain.enumeration.FeedbackStatus;import com.company.datahub.domain.enumeration.FeedbackType;import java.io.Serializable;import java.time.Instant;import javax.persistence.*;/** * 反馈记录表 */@Entity@Table(name = "feedback_record")public class FeedbackRecord implements Serializable { private static final long serialVersionUID = 1L; @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id; /** * 反馈类型 */ @Enumerated(EnumType.STRING) @Column(name = "feedback_type") private FeedbackType feedbackType; /** * 问题描述 */ @Column(name = "title") private String title; /** * 反馈状态 */ @Enumerated(EnumType.STRING) @Column(name = "feedback_status") private FeedbackStatus feedbackStatus; /** * 是否已完成 */ @Column(name = "last_reply_time") private Integer lastReplyTime; /** * 关闭类型 */ @Enumerated(EnumType.STRING) @Column(name = "close_type") private FeedbackCloseType closeType; /** * 创建时间 */ @Column(name = "created_date") private Instant createdDate; /** * 创建者 */ @Column(name = "created_by") private String createdBy; // jhipster-needle-entity-add-field - JHipster will add fields here public Long getId() { return id; } public void setId(Long id) { this.id = id; } public FeedbackRecord id(Long id) { this.id = id; return this; } public FeedbackType getFeedbackType() { return this.feedbackType; } public FeedbackRecord feedbackType(FeedbackType feedbackType) { this.feedbackType = feedbackType; return this; } public void setFeedbackType(FeedbackType feedbackType) { this.feedbackType = feedbackType; } public String getTitle() { return this.title; } public FeedbackRecord title(String title) { this.title = title; return this; } public void setTitle(String title) { this.title = title; } public FeedbackStatus getFeedbackStatus() { return this.feedbackStatus; } public FeedbackRecord feedbackStatus(FeedbackStatus feedbackStatus) { this.feedbackStatus = feedbackStatus; return this; } public void setFeedbackStatus(FeedbackStatus feedbackStatus) { this.feedbackStatus = feedbackStatus; } public Integer getLastReplyTime() { return this.lastReplyTime; } public FeedbackRecord lastReplyTime(Integer lastReplyTime) { this.lastReplyTime = lastReplyTime; return this; } public void setLastReplyTime(Integer lastReplyTime) { this.lastReplyTime = lastReplyTime; } public FeedbackCloseType getCloseType() { return this.closeType; } public FeedbackRecord closeType(FeedbackCloseType closeType) { this.closeType = closeType; return this; } public void setCloseType(FeedbackCloseType closeType) { this.closeType = closeType; } public Instant getCreatedDate() { return this.createdDate; } public FeedbackRecord createdDate(Instant createdDate) { this.createdDate = createdDate; return this; } public void setCreatedDate(Instant createdDate) { this.createdDate = createdDate; } public String getCreatedBy() { return this.createdBy; } public FeedbackRecord createdBy(String createdBy) { this.createdBy = createdBy; return this; } public void setCreatedBy(String createdBy) { this.createdBy = createdBy; } // jhipster-needle-entity-add-getters-setters - JHipster will add getters and setters here @Override public boolean equals(Object o) { if (this == o) { return true; } if (!(o instanceof FeedbackRecord)) { return false; } return id != null && id.equals(((FeedbackRecord) o).id); } @Override public int hashCode() { // see https://vladmihalcea.com/how-to-implement-equals-and-hashcode-using-the-jpa-entity-identifier/ return getClass().hashCode(); } // prettier-ignore @Override public String toString() { return "FeedbackRecord{" "id=" getId() ", feedbackType='" getFeedbackType() "'" ", title='" getTitle() "'" ", feedbackStatus='" getFeedbackStatus() "'" ", lastReplyTime=" getLastReplyTime() ", closeType='" getCloseType() "'" ", createdDate='" getCreatedDate() "'" ", createdBy='" getCreatedBy() "'" "}"; }}

Repository

@SuppressWarnings("unused")@Repositorypublic interface FeedbackRecordRepository extends JpaRepository<FeedbackRecord, Long>, JpaSpecificationExecutor<FeedbackRecord> {}

Service

/** * Service Interface for managing {@link com.company.datahub.domain.FeedbackRecord}. */public interface FeedbackRecordService { /** * Save a feedbackRecord. * * @param feedbackRecordDTO the entity to save. * @return the persisted entity. */ FeedbackRecordDTO save(FeedbackRecordDTO feedbackRecordDTO); /** * Partially updates a feedbackRecord. * * @param feedbackRecordDTO the entity to update partially. * @return the persisted entity. */ Optional<FeedbackRecordDTO> partialUpdate(FeedbackRecordDTO feedbackRecordDTO); /** * Get all the feedbackRecords. * * @param pageable the pagination information. * @return the list of entities. */ Page<FeedbackRecordDTO> findAll(Pageable pageable); /** * Get the "id" feedbackRecord. * * @param id the id of the entity. * @return the entity. */ Optional<FeedbackRecordDTO> findOne(Long id); /** * Delete the "id" feedbackRecord. * * @param id the id of the entity. */ void delete(Long id);}

Controller

/** * REST controller for managing {@link com.company.datahub.domain.FeedbackRecord}. */@RestController@RequestMapping("/api")public class FeedbackRecordResource { private final Logger log = LoggerFactory.getLogger(FeedbackRecordResource.class); private static final String ENTITY_NAME = "feedbackRecord"; @Value("${jhipster.clientApp.name}") private String applicationName; private final FeedbackRecordService feedbackRecordService; private final FeedbackRecordQueryService feedbackRecordQueryService; public FeedbackRecordResource(FeedbackRecordService feedbackRecordService, FeedbackRecordQueryService feedbackRecordQueryService) { this.feedbackRecordService = feedbackRecordService; this.feedbackRecordQueryService = feedbackRecordQueryService; } /** * {@code POST /feedback-records} : Create a new feedbackRecord. * * @param feedbackRecordDTO the feedbackRecordDTO to create. * @return the {@link ResponseEntity} with status {@code 201 (Created)} and with body the new feedbackRecordDTO, or with status {@code 400 (Bad Request)} if the feedbackRecord has already an ID. * @throws URISyntaxException if the Location URI syntax is incorrect. */ @PostMapping("/feedback-records") public ResponseEntity<FeedbackRecordDTO> createFeedbackRecord(@RequestBody FeedbackRecordDTO feedbackRecordDTO) throws URISyntaxException { log.debug("REST request to save FeedbackRecord : {}", feedbackRecordDTO); if (feedbackRecordDTO.getId() != null) { throw new BadRequestAlertException("A new feedbackRecord cannot already have an ID", ENTITY_NAME, "idexists"); } FeedbackRecordDTO result = feedbackRecordService.save(feedbackRecordDTO); return ResponseEntity .created(new URI("/api/feedback-records/" result.getId())) .headers(HeaderUtil.createEntityCreationAlert(applicationName, true, ENTITY_NAME, result.getId().toString())) .body(result); } /** * {@code PUT /feedback-records} : Updates an existing feedbackRecord. * * @param feedbackRecordDTO the feedbackRecordDTO to update. * @return the {@link ResponseEntity} with status {@code 200 (OK)} and with body the updated feedbackRecordDTO, * or with status {@code 400 (Bad Request)} if the feedbackRecordDTO is not valid, * or with status {@code 500 (Internal Server Error)} if the feedbackRecordDTO couldn't be updated. * @throws URISyntaxException if the Location URI syntax is incorrect. */ @PutMapping("/feedback-records") public ResponseEntity<FeedbackRecordDTO> updateFeedbackRecord(@RequestBody FeedbackRecordDTO feedbackRecordDTO) throws URISyntaxException { log.debug("REST request to update FeedbackRecord : {}", feedbackRecordDTO); if (feedbackRecordDTO.getId() == null) { throw new BadRequestAlertException("Invalid id", ENTITY_NAME, "idnull"); } FeedbackRecordDTO result = feedbackRecordService.save(feedbackRecordDTO); return ResponseEntity .ok() .headers(HeaderUtil.createEntityUpdateAlert(applicationName, true, ENTITY_NAME, feedbackRecordDTO.getId().toString())) .body(result); } /** * {@code PATCH /feedback-records} : Updates given fields of an existing feedbackRecord. * * @param feedbackRecordDTO the feedbackRecordDTO to update. * @return the {@link ResponseEntity} with status {@code 200 (OK)} and with body the updated feedbackRecordDTO, * or with status {@code 400 (Bad Request)} if the feedbackRecordDTO is not valid, * or with status {@code 404 (Not Found)} if the feedbackRecordDTO is not found, * or with status {@code 500 (Internal Server Error)} if the feedbackRecordDTO couldn't be updated. * @throws URISyntaxException if the Location URI syntax is incorrect. */ @PatchMapping(value = "/feedback-records", consumes = "application/merge-patch json") public ResponseEntity<FeedbackRecordDTO> partialUpdateFeedbackRecord(@RequestBody FeedbackRecordDTO feedbackRecordDTO) throws URISyntaxException { log.debug("REST request to update FeedbackRecord partially : {}", feedbackRecordDTO); if (feedbackRecordDTO.getId() == null) { throw new BadRequestAlertException("Invalid id", ENTITY_NAME, "idnull"); } Optional<FeedbackRecordDTO> result = feedbackRecordService.partialUpdate(feedbackRecordDTO); return ResponseUtil.wrapOrNotFound( result, HeaderUtil.createEntityUpdateAlert(applicationName, true, ENTITY_NAME, feedbackRecordDTO.getId().toString()) ); } /** * {@code GET /feedback-records} : get all the feedbackRecords. * * @param pageable the pagination information. * @param criteria the criteria which the requested entities should match. * @return the {@link ResponseEntity} with status {@code 200 (OK)} and the list of feedbackRecords in body. */ @GetMapping("/feedback-records") public ResponseEntity<List<FeedbackRecordDTO>> getAllFeedbackRecords(FeedbackRecordCriteria criteria, Pageable pageable) { log.debug("REST request to get FeedbackRecords by criteria: {}", criteria); Page<FeedbackRecordDTO> page = feedbackRecordQueryService.findByCriteria(criteria, pageable); HttpHeaders headers = PaginationUtil.generatePaginationHttpHeaders(ServletUriComponentsBuilder.fromCurrentRequest(), page); return ResponseEntity.ok().headers(headers).body(page.getContent()); } /** * {@code GET /feedback-records/count} : count all the feedbackRecords. * * @param criteria the criteria which the requested entities should match. * @return the {@link ResponseEntity} with status {@code 200 (OK)} and the count in body. */ @GetMapping("/feedback-records/count") public ResponseEntity<Long> countFeedbackRecords(FeedbackRecordCriteria criteria) { log.debug("REST request to count FeedbackRecords by criteria: {}", criteria); return ResponseEntity.ok().body(feedbackRecordQueryService.countByCriteria(criteria)); } /** * {@code GET /feedback-records/:id} : get the "id" feedbackRecord. * * @param id the id of the feedbackRecordDTO to retrieve. * @return the {@link ResponseEntity} with status {@code 200 (OK)} and with body the feedbackRecordDTO, or with status {@code 404 (Not Found)}. */ @GetMapping("/feedback-records/{id}") public ResponseEntity<FeedbackRecordDTO> getFeedbackRecord(@PathVariable Long id) { log.debug("REST request to get FeedbackRecord : {}", id); Optional<FeedbackRecordDTO> feedbackRecordDTO = feedbackRecordService.findOne(id); return ResponseUtil.wrapOrNotFound(feedbackRecordDTO); } /** * {@code DELETE /feedback-records/:id} : delete the "id" feedbackRecord. * * @param id the id of the feedbackRecordDTO to delete. * @return the {@link ResponseEntity} with status {@code 204 (NO_CONTENT)}. */ @DeleteMapping("/feedback-records/{id}") public ResponseEntity<Void> deleteFeedbackRecord(@PathVariable Long id) { log.debug("REST request to delete FeedbackRecord : {}", id); feedbackRecordService.delete(id); return ResponseEntity .noContent() .headers(HeaderUtil.createEntityDeletionAlert(applicationName, true, ENTITY_NAME, id.toString())) .build(); }}

测试接口

获取数据

@GetMapping("/feedback-records") public ResponseEntity<List<FeedbackRecordDTO>> getAllFeedbackRecords(FeedbackRecordCriteria criteria, Pageable pageable) { log.debug("REST request to get FeedbackRecords by criteria: {}", criteria); Page<FeedbackRecordDTO> page = feedbackRecordQueryService.findByCriteria(criteria, pageable); HttpHeaders headers = PaginationUtil.generatePaginationHttpHeaders(ServletUriComponentsBuilder.fromCurrentRequest(), page); return ResponseEntity.ok().headers(headers).body(page.getContent()); }

这里有意思的是FeedbackRecordCriteria，可以针对实体中的每个字段进行过滤，不用单独写业务代码去过滤：

比如feedbackStatus是一个枚举，那么可以使用equals，in 等过过滤器。

关于过滤器：

我们测试下，比如查询feedbackStatus 为 TO_BE_REPLY的，那么可以使用feedbackStatus.equals=TO_BE_REPLY

GET http://localhost:8080/api/feedback-records?sort=id,asc&page=0&size=20&feedbackStatus.equals=TO_BE_REPLY

[ { "id": 1, "feedbackType": "COMPLAINTS", "title": "SMTP lavender Table", "feedbackStatus": "TO_BE_REPLY", "lastReplyTime": 9391, "closeType": "NORMALLY", "createdDate": "2021-03-11T21:38:31Z", "createdBy": "新疆 Central Soft" }, { "id": 2, "feedbackType": "ADVICE", "title": "上海市 haptic", "feedbackStatus": "TO_BE_REPLY", "lastReplyTime": 53521, "closeType": "NORMALLY", "createdDate": "2021-03-11T18:04:14Z", "createdBy": "Rubber connect 桥" }, { "id": 4, "feedbackType": "ADVICE", "title": "Senior index", "feedbackStatus": "TO_BE_REPLY", "lastReplyTime": 67874, "closeType": "TIMEOUT", "createdDate": "2021-03-11T14:53:15Z", "createdBy": "Uganda" }, { "id": 6, "feedbackType": "ADVICE", "title": "Expanded Sports compelling", "feedbackStatus": "TO_BE_REPLY", "lastReplyTime": 8032, "closeType": "TIMEOUT", "createdDate": "2021-03-12T03:53:46Z", "createdBy": "deposit Chicken mesh" }, { "id": 7, "feedbackType": "ADVICE", "title": "Division overriding", "feedbackStatus": "TO_BE_REPLY", "lastReplyTime": 38000, "closeType": "NORMALLY", "createdDate": "2021-03-11T07:57:51Z", "createdBy": "Account stable" }, { "id": 9, "feedbackType": "ADVICE", "title": "Loan", "feedbackStatus": "TO_BE_REPLY", "lastReplyTime": 99908, "closeType": "TIMEOUT", "createdDate": "2021-03-11T09:47:44Z", "createdBy": "Re-engineered" }]

开发实践

更新实体增加字段

在项目的工程目录下，有一个.jhipster文件夹，里面包含了已有的实体。

要为实体增加字段，可以打开json文件，在fields里新增即可，比如我们增加一个content字段。

{ "name": "FeedbackRecord", "fields": [ { "fieldName": "feedbackType", "fieldType": "FeedbackType", "javadoc": "反馈类型", "fieldValues": "ADVICE,COMPLAINTS" }, { "fieldName": "title", "fieldType": "String", "javadoc": "问题描述" }, { "fieldName": "content", "fieldType": "String", "javadoc": "问题详情" }, { "fieldName": "feedbackStatus", "fieldType": "FeedbackStatus", "javadoc": "反馈状态", "fieldValues": "TO_BE_SUBMIT,TO_BE_REPLY,TO_BE_CONFIRMED" }, { "fieldName": "lastReplyTime", "fieldType": "Integer", "javadoc": "是否已完成" }, { "fieldName": "closeType", "fieldType": "FeedbackCloseType", "javadoc": "关闭类型", "fieldValues": "NORMALLY,TIMEOUT" }, { "fieldName": "createdDate", "fieldType": "Instant", "javadoc": "创建时间" }, { "fieldName": "createdBy", "fieldType": "String", "javadoc": "创建者" } ], "relationships": [], "javadoc": "反馈记录表", "entityTableName": "feedback_record", "dto": "mapstruct", "pagination": "pagination", "service": "serviceImpl", "jpaMetamodelFiltering": true, "fluentMethods": true, "readOnly": false, "embedded": false, "applications": "*", "changelogDate": "20210312072243"}

再次运行实体生成器：

jhipster entity FeedbackRecord

当您为现有实体运行实体子生成器时，系统会询问您“Do you want to update the entity? This will replace the existing files for this entity, all your custom code will be overwritten”(您确定需要更新实体吗？这将替换该实体的现有文件，所有自定义代码将被覆盖)，并具有以下选项：

• Yes, re generate the entity – 这将重新生成您的实体。提示：这可以通过在运行子生成器时传递–regenerate标志来强制执行
• Yes, add more fields and relationships – 这将需要您回答一些问题，以添加更多字段和关系
• Yes, remove fields and relationships – 这将需要您回答一些问题，以便从实体中删除现有字段和关系
• No, exit – 这将存在子生成器而无需更改任何内容

您可能由于以下原因而要更新您的实体：

提示：要立即重新生成所有实体，可以使用以下命令（不提供–force标识会在文件更改时询问覆盖选项）。

• Linux & Mac: for f inls .jhipster; do jhipster entity ${f%.*} –force ; done
• Windows: for %f in (.jhipster/*) do jhipster entity %~nf –force

代码示例