jhipster/jhipster-lite

JHipster Lite ⚡

镜像概述

https://www.jhipster.tech/是一个快速生成、开发和部署现代Web应用及微服务架构的开发平台。JHipster Lite旨在帮助您启动项目，通过逐步生成仅您所需的代码。

其生成的代码采用六边形架构，技术代码与业务代码分离，确保只生成所需代码而无额外未使用代码，并追求最佳质量：100%覆盖率、0代码异味、无重复。

核心功能和特性

• 六边形架构：生成的代码遵循六边形架构设计，确保业务逻辑与外部依赖解耦
• 代码分离：技术代码与业务代码明确分离，提高代码可维护性
• 按需生成：仅生成所需功能代码，避免冗余和未使用代码
• 高质量标准：追求100%测试覆盖率、零代码异味、无代码重复
• 多工具支持：集成多种代码检查和格式化工具，确保代码质量

使用场景和适用范围

适用于需要快速启动Web应用或微服务项目，且希望保持代码简洁、可维护性高的开发场景。特别适合以下用户：

• 需要定制化项目结构的开发者
• 希望避免生成冗余代码的团队
• 追求高质量代码标准的项目
• 采用微服务架构或现代Web应用开发的团队

前提条件

Java

需要安装Java 17：

• https://openjdk.java.net/projects/jdk/17/

Node.js 和 NPM

• https://nodejs.org/：用于运行开发Web服务器和构建项目。根据您的系统，可以从源代码或预打包 bundle 安装Node。

安装Node后，可运行以下命令安装开发工具：

npm ci

仅当package.json中的依赖项更改时需要运行此命令。

npm install

详细使用方法

快速开始

克隆项目：

git clone https://github.com/jhipster/jhipster-lite

进入项目文件夹：

cd jhipster-lite

运行项目：

./mvnw

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

测试项目

运行测试：

./mvnw clean test

运行测试和集成测试：

./mvnw clean verify

GraalVM Native 支持

该项目已配置为允许生成轻量级容器或原生可执行文件，也可以在原生镜像中运行测试。

使用Cloud Native Buildpacks的轻量级容器

如果您熟悉Spring Boot容器镜像支持，这是最简便的入门方式。创建镜像前需确保Docker已安装并配置。

创建镜像：

./mvnw spring-boot:build-image -Pnative

像运行其他容器一样运行应用：

docker run -p 7471:7471 --rm docker.xuanyuan.run/library/jhlite:<VERSION>

使用Native Build Tools的可执行文件

如果您想探索更多选项（如在原生镜像中运行测试），需安装并配置GraalVM native-image编译器。

注意：需要GraalVM 22.3+。

创建可执行文件：

./mvnw native:compile -Pnative -DskipTests

运行应用：

./target/jhlite

也可以在原生镜像中运行现有测试套件，这是验证应用兼容性的有效方法：

./mvnw test -PnativeTest

代码检查

项目使用多种代码检查工具：

• https://eslint.org/：用于JavaScript/TypeScript
• https://github.com/prettier/prettier：用于代码格式化
  • https://github.com/jhipster/prettier-java：用于Java
• https://stylelint.io/：用于样式检查
  • https://github.com/stylelint-scss：用于SCSS
• https://www.npmjs.com/package/pug-lint：用于Pug模板

检查代码：

npm run lint:ci

检查并修复代码：

npm run lint

Sonar分析

启动本地Sonar分析：

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

然后运行：

./mvnw clean verify sonar:sonar

在 http://localhost:9001 查看分析结果。

运行项目

使用Maven运行（spring-boot:run是默认目标）：

./mvnw

或先打包为jar：

./mvnw package

然后运行：

java -jar target/*.jar

在浏览器中访问 http://localhost:7471。

Docker/Podman快速启动

要启动本地JHipster Lite实例，进入您的应用文件夹并运行：

Docker:

docker run --rm --pull=always -p 7471:7471 -v $(pwd):/tmp/jhlite:Z -it docker.xuanyuan.run/jhipster/jhipster-lite:latest

Podman:

podman run --rm --pull=always -p 7471:7471 -v $(pwd):/tmp/jhlite:Z -u root -it jhipster/jhipster-lite:latest

然后访问 http://localhost:7471。

端到端测试

需先运行项目，然后执行端到端测试：

npm run e2e

或无头模式：

npm run e2e:headless

生成项目

启动后，访问 http://localhost:7471，选择所需选项，逐步生成所需代码。