jhipster/jhipster-sample-app-cassandra

jhipsterCassandraSampleApplication

镜像概述和主要用途

该应用是使用JHipster 5.8.1生成的Cassandra示例应用，提供完整的开发、构建、测试流程及Docker集成方案。相关文档和帮助可参考JHipster 5.8.1文档归档。

核心功能和特性

• 基于JHipster 5.8.1构建，集成Cassandra数据库
• 完整开发工作流：包含依赖管理、自动刷新、Angular CLI支持
• 生产环境优化：代码压缩、资源整合及HTML引用更新
• 全面测试支持：单元测试（Jest/Jasmine）、集成测试
• Docker化部署：提供docker-compose配置用于启动依赖服务及应用本身
• 代码质量分析：集成Sonar进行代码质量检测
• 持续集成：支持通过ci-cd子生成器配置CI系统

使用场景和适用范围

• 开发者学习JHipster框架与Cassandra数据库集成
• 作为JHipster项目的基础模板
• 演示现代化Java应用的开发、构建和部署流程

详细使用方法和配置说明

开发环境设置

依赖安装

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

安装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%E5%9C%A8%E4%B8%A4%E4%B8%AA%E7%8B%AC%E7%AB%8B%E7%BB%88%E7%AB%AF%E4%B8%AD%E8%BF%90%E8%A1%8C%E4%BB%A5%E4%B8%8B%E5%91%BD%E4%BB%A4%EF%BC%8C%E5%AE%9E%E7%8E%B0%E6%96%87%E4%BB%B6%E5%8F%98%E6%9B%B4%E6%97%B6%E6%B5%8F%E8%A7%88%E5%99%A8%E8%87%AA%E5%8A%A8%E5%88%B7%E6%96%B0%EF%BC%9A

bash
./mvnw
npm start

npm用于管理应用的CSS和JavaScript依赖，可通过在package.json中指定新版本或运行npm update和npm install来升级依赖。使用npm 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库为例：

1. 添加运行时依赖：

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

2. 添加开发阶段TypeScript类型定义（来自DefinitelyTyped）：

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

3. 导入JS和CSS文件：

编辑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。

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

构建生产版本

优化应用以用于生产环境：

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%EF%BC%8C%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分析代码质量：

1. 启动本地Sonar服务器（访问http://localhost:9001）：

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

2. 运行Sonar分析：

bash
./mvnw -Pprod clean test sonar:sonar

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

使用Docker简化开发（可选）

src/main/docker文件夹提供多个docker-compose配置，用于启动所需第三方服务。

启动Cassandra数据库

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

停止并移除容器：

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

完全容器化应用

1. 构建应用Docker镜像：

bash
./mvnw package -Pprod verify jib:dockerBuild

2. 启动应用及依赖服务：

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

更多信息参见使用Docker和Docker-Compose。

持续集成（可选）

运行ci-cd子生成器配置CI：

bash
jhipster ci-cd

可生成多个持续集成系统的配置文件。更多信息参见设置持续集成。