jhipster/jhipster-sample-app-gateway

jhipsterSampleGateway

镜像概述和主要用途

本应用使用JHipster 5.8.1生成，相关文档和帮助可查阅JHipster 5.8.1文档存档。

这是一个"网关"应用，旨在作为微服务架构的一部分，更多信息请参考文档中的使用JHipster构建微服务页面。

应用已配置JHipster-Registry进行服务发现和配置。启动时，若无法连接到http://localhost:8761的JHipster-Registry，应用将拒绝启动。详细信息请阅读使用JHipster-Registry进行服务发现和配置文档。

核心功能和特性

• 微服务架构中的网关组件，处理服务路由
• 集成JHipster-Registry实现服务注册与配置管理
• 支持前端开发热重载，提升开发效率
• 提供完整的构建、测试和部署流程
• 支持Docker容器化部署

开发

在构建项目前，需在机器上安装并配置以下依赖：

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

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

bash
npm install

项目使用npm脚本和https://webpack.github.io/%E4%BD%9C%E4%B8%BA%E6%9E%84%E5%BB%BA%E7%B3%BB%E7%BB%9F%E3%80%82

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

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/%E8%83%BD%E5%A4%9F%E8%AF%86%E5%88%AB%E5%AE%83%E4%BB%AC%EF%BC%9A

编辑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开发的更多说明，请参阅JHipster开发指南。

使用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

构建生产环境

要优化jhipsterSampleGateway应用的生产环境配置，运行：

bash
./mvnw -Pprod clean package

此命令将合并并压缩客户端CSS和JavaScript文件，同时修改index.html以引用这些新文件。

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

bash
java -jar target/*.war

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

更多详情请参考JHipster生产环境使用指南。

测试

要启动应用测试，运行：

bash
./mvnw clean test

客户端测试

单元测试由https://***.github.io/jest/运行，使用http://jasmine.github.io/2.0/introduction.html%E7%BC%96%E5%86%99%E3%80%82%E6%B5%8B%E8%AF%95%E6%96%87%E4%BB%B6%E4%BD%8D%E4%BA%8Esrc/test/javascript/%EF%BC%8C%E5%8F%AF%E9%80%9A%E8%BF%87%E4%BB%A5%E4%B8%8B%E5%91%BD%E4%BB%A4%E8%BF%90%E8%A1%8C%EF%BC%9A

bash
npm test

更多信息请参考测试运行页面。

代码质量

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

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

然后运行Sonar分析：

bash
./mvnw -Pprod clean test sonar:sonar

更多信息请参考代码质量页面。

使用Docker简化开发（可选）

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

例如，要在Docker容器中启动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

更多信息请参考使用Docker和Docker-Compose，该页面还包含docker-compose子生成器（jhipster docker-compose）的信息，可用于为一个或多个JHipster应用生成Docker配置。

持续集成（可选）

要为项目配置CI，运行ci-cd子生成器（jhipster ci-cd），这将生成多个持续集成系统的配置文件。更多信息请查阅设置持续集成页面。