jhipster/jhipster-control-center

jhipsterControlCenter

此应用程序使用JHipster 7.0.0-beta.1生成，相关文档和帮助可在[***]

JHipster Control Center

特定Spring配置文件

为确保正常工作，Control Center必须使用与Spring Cloud服务发现后端对应的Spring配置文件启动：

• eureka：连接到Eureka服务器并获取其注册实例，配置在application-eureka.yml中
• consul：连接到Consul服务器并获取其注册实例，配置在application-consul.yml中
• static：使用属性提供的静态实例列表，配置在application-static.yml中
• kubernetes：开发中

Control Center API

• localhost:7419/api/services/instances：获取注册实例
• localhost:7419/management/gateway/routes：获取Spring Cloud Gateway路由
• localhost:7419/gateway/<serviceName>/<instanceName>/<urlPath>：代理请求到instanceName的urlPath。例如，使用Eureka时，格式可能为：localhost:7419/gateway/eurekaservice1/eurekaservice1:3d38fb89771e502111b495064d739ef8/management/info

本地运行

步骤1：运行Spring Cloud服务发现后端服务器

src/main/docker目录下提供了Eureka和Consul的docker-compose文件，方便测试项目：

• 对于Consul：运行docker-compose -f src/main/docker/consul.yml up -d
• 对于Eureka：运行docker-compose -f src/main/docker/jhipster-registry.yml up -d
• 若使用静态实例列表，可直接进入下一步

步骤2：选择认证配置文件

有两种认证类型：

• JWT：默认认证方式，无需额外操作
• OAuth2：使用OAuth2认证需启动Keycloak，运行docker-compose -f src/main/docker/keycloak.yml up -d

步骤3：运行克隆的项目

根据所需的Spring配置文件运行Control Center，示例如下：

• 使用JWT和Consul开发：./mvnw -Dspring.profiles.active=consul,dev
• 使用JWT和Eureka开发：./mvnw -Dspring.profiles.active=eureka,dev
• 使用JWT和静态实例列表开发：./mvnw -Dspring.profiles.active=static,dev
• 使用OAuth2和Consul开发：./mvnw -Dspring.profiles.active=consul,dev,oauth2
• 使用OAuth2和Eureka开发：./mvnw -Dspring.profiles.active=eureka,dev,oauth2
• 仅启动开发环境：运行./mvnw，并在另一个终端运行npm start以实现客户端代码热重载

从Docker运行

Docker Hub上提供了容器镜像。使用时，运行以下命令拉取并启动：

bash
docker pull jhipster/jhipster-control-center
docker run -d --name jhcc -p 7419:7419 jhipster/jhipster-control-center:latest

开发

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

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

安装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可列出所有可用脚本。

PWA支持

JHipster内置PWA（渐进式Web应用）支持，默认关闭。PWA的主要组件之一是服务工作线程。

服务工作线程初始化代码默认已注释。要启用，取消src/main/webapp/index.html中以下代码的注释：

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

注意：Workbox为JHipster的服务工作线程提供支持，动态生成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/识别。注意：Leaflet的使用还需其他配置，此处不详细说明。

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

生产构建

打包为jar

要构建最终jar并优化jhipsterControlCenter应用以用于生产，运行：

bash
./mvnw -Pprod clean verify

这将连接并压缩客户端CSS和JavaScript文件，修改index.html以引用这些新文件。验证是否正常工作：

bash
java -jar target/*.jar

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

更多详情参见Using JHipster in production。

打包为war

要将应用打包为war以部署到应用服务器，运行：

bash
./mvnw -Pprod,war clean verify

测试

要启动应用测试，运行：

bash
./mvnw verify

客户端测试

单元测试由https://***.github.io/jest/运行，位于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

注意：为方便试用SonarQube，src/main/docker/sonar.yml中已关闭认证，实际使用时应重新启用。

可使用sonar-scanner或maven插件运行Sonar分析：

bash
./mvnw -Pprod clean verify sonar:sonar

如需重新运行Sonar阶段，确保至少指定initialize阶段，因为Sonar属性从sonar-project.properties文件加载：

bash
./mvnw initialize sonar:sonar

更多信息参见Code quality page。

使用Docker简化开发（可选）

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

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

bash
./mvnw -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了解更多信息。