jhipster/jhipster-sample-app-elasticsearch

jhipsterElasticsearchSampleApplication

本应用使用JHipster 5.8.1生成，相关文档和帮助可访问 [***]

镜像概述和主要用途

jhipsterElasticsearchSampleApplication是一个基于JHipster 5.8.1构建的示例应用，集成了ElasticSearch。该镜像展示了JHipster框架的完整开发流程，包括前端构建、后端开发、测试、生产打包及Docker部署等功能，适用于学习JHipster应用开发和ElasticSearch集成的开发者。

核心功能和特性

• 基于JHipster 5.8.1开发框架，整合Spring Boot后端与Angular前端
• 使用npm和Webpack进行前端构建和依赖管理
• 支持Angular CLI生成客户端代码
• 集成Jest和Jasmine进行前端单元测试
• 支持Sonar进行代码质量分析
• 提供Docker化部署配置，支持第三方服务（如MySQL）的容器化运行
• 支持生产环境优化构建

开发指南

环境依赖

在构建项目前，需在本地安装并配置以下依赖：

1. Node.js: 用于运行开发Web服务器和构建项目。根据系统环境，可从源码或预打包版本安装。

安装Node后，运行以下命令安装开发工具（仅在package.json中依赖变更时需要执行）：

bash
npm install

构建系统

项目使用npm脚本和https://webpack.github.io/作为构建系统。

在两个独立终端中运行以下命令，实现文件变更时浏览器自动刷新的开发体验：

bash
./mvnw
npm start

npm还用于管理应用的CSS和JavaScript依赖。可通过在package.json中指定新版本、运行npm update或npm install来升级依赖。在任何命令后添加help标志可查看使用帮助，例如npm help update。

运行npm run可列出项目所有可用脚本。

服务工作线程

服务工作线程默认处于注释状态，如需启用，请取消以下代码注释：

• index.html中的服务工作线程注册脚本

html
<script>
    if ('serviceWorker' in navigator) {
        navigator.serviceWorker
        .register('./service-worker.js')
        .then(function() { console.log('Service Worker Registered'); });
    }
</script>

注意：workbox会创建相应的服务工作线程并动态生成service-worker.js。

依赖管理

例如，要添加Leaflet库作为应用的运行时依赖，执行以下命令：

bash
npm install --save --save-exact leaflet

如需在开发中使用DefinitelyTyped仓库的TypeScript类型定义，执行：

bash
npm install --save-dev --save-exact @types/leaflet

然后按库的安装说明导入JS和CSS文件，使https://webpack.github.io/识别它们：

编辑src/main/webapp/app/vendor.ts文件：

typescript
import 'leaflet/dist/leaflet.js';

编辑src/main/webapp/content/css/vendor.css文件：

css
@import '~leaflet/dist/leaflet.css';

注意：Leaflet的集成还需其他配置，此处不详细展开。

有关JHipster开发的更多说明，请参考Using JHipster in development。

使用angular-cli

可使用Angular CLI生成自定义客户端代码。

例如，执行以下命令：

bash
ng generate component my-component

将生成以下文件：

create src/main/webapp/app/my-component/my-component.component.html
create src/main/webapp/app/my-component/my-component.component.ts
update src/main/webapp/app/app.module.ts

生产构建

要优化jhipsterElasticsearchSampleApplication应用以用于生产环境，运行：

bash
./mvnw -Pprod clean package

此命令将 concatenate 和 minify 客户端CSS与JavaScript文件，并修改index.html以引用这些新文件。

验证构建是否成功，运行：

bash
java -jar target/*.war

然后在浏览器中访问http://localhost:8080。

更多详情请参考Using JHipster in production。

测试

应用测试

要运行应用测试，执行：

bash
./mvnw clean test

客户端测试

单元测试由https://***.github.io/jest/运行，使用http://jasmine.github.io/2.0/introduction.html编写。测试文件位于src/test/javascript/，可通过以下命令运行：

bash
npm test

更多信息请参考Running tests page。

代码质量

使用Sonar进行代码质量分析。启动本地Sonar服务器（可通过http://localhost:9001访问）：

bash
docker-compose -f src/main/docker/sonar.yml up -d

然后运行Sonar分析：

bash
./mvnw -Pprod clean test sonar:sonar

更多信息请参考Code quality page。

使用Docker简化开发（可选）

可使用Docker提升JHipster开发体验。src/main/docker文件夹中提供了多个docker-compose配置，用于启动所需的第三方服务。

例如，启动MySQL数据库容器：

bash
docker-compose -f src/main/docker/mysql.yml up -d

停止并移除容器：

bash
docker-compose -f src/main/docker/mysql.yml down

也可将应用及所有依赖服务完全容器化。首先构建应用的Docker镜像：

bash
./mvnw package -Pprod verify jib:dockerBuild

然后运行：

bash
docker-compose -f src/main/docker/app.yml up -d

更多信息请参考Using Docker and Docker-Compose，该页面还包含docker-compose子生成器（jhipster docker-compose）的相关说明，可生成一个或多个JHipster应用的Docker配置。

持续集成（可选）

要为项目配置CI，运行ci-cd子生成器（jhipster ci-cd），该生成器可生成多个持续集成系统的配置文件。更多信息请参考Setting up Continuous Integration。