mcpField
C
create-spring-boot-java-project

create-spring-boot-java-project

github.com/github开发40.5k9.5k 次安装今天更新
代码仓库

关于 create-spring-boot-java-project

用于按步骤创建 Spring Boot Java 项目的开发技能,面向需要搭建带数据库与缓存配置的服务端项目的开发者。它通过 Spring Initializr 生成模板,并补充依赖、配置、Docker Compose 服务及测试流程。

主要功能

  1. 01下载并解压 Spring Boot 模板
  2. 02配置 SpringDoc、Redis、JPA 和 MongoDB
  3. 03添加 Redis、PostgreSQL 和 MongoDB 容器
  4. 04更新 .gitignore 并运行 Maven 测试

适用场景

  1. 01从模板初始化 Java 服务端项目
  2. 02为本地开发配置数据库与缓存
  3. 03验证新项目能否通过测试

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/github/awesome-copilot --skill create-spring-boot-java-project

安装后在 Claude Code 中输入/create-spring-boot-java-project确认已加载。

详细介绍

创建 Spring Boot Java 项目提示词

检查 Java 版本

  • 在终端中运行以下命令并检查 Java 版本
java -version

下载 Spring Boot 项目模板

  • 在终端中运行以下命令以下载 Spring Boot 项目模板
curl https://start.spring.io/starter.zip \
  -d artifactId=${input:projectName:demo-java} \
  -d bootVersion=3.4.5 \
  -d dependencies=lombok,configuration-processor,web,data-jpa,postgresql,data-redis,data-mongodb,validation,cache,testcontainers \
  -d javaVersion=21 \
  -d packageName=com.example \
  -d packaging=jar \
  -d type=maven-project \
  -o starter.zip

解压下载的文件

  • 在终端中运行以下命令以解压下载的文件
unzip starter.zip -d ./${input:projectName:demo-java}

删除下载的 zip 文件

  • 在终端中运行以下命令以删除下载的 zip 文件
rm -f starter.zip

切换目录到项目根目录

  • 在终端中运行以下命令以切换目录到项目根目录
cd ${input:projectName:demo-java}

添加额外依赖

  • 将 springdoc-openapi-starter-webmvc-ui 和 archunit-junit5 依赖插入 pom.xml 文件
<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
  <version>2.8.6</version>
</dependency>
<dependency>
  <groupId>com.tngtech.archunit</groupId>
  <artifactId>archunit-junit5</artifactId>
  <version>1.2.1</version>
  <scope>test</scope>
</dependency>

添加 SpringDoc、Redis、JPA 和 MongoDB 配置

  • 将 SpringDoc 配置插入 application.properties 文件
# SpringDoc configurations
springdoc.swagger-ui.doc-expansion=none
springdoc.swagger-ui.operations-sorter=alpha
springdoc.swagger-ui.tags-sorter=alpha
  • 将 Redis 配置插入 application.properties 文件
# Redis configurations
spring.data.redis.host=localhost
spring.data.redis.port=6379
spring.data.redis.password=rootroot
  • 将 JPA 配置插入 application.properties 文件
# JPA configurations
spring.datasource.driver-class-name=org.postgresql.Driver
spring.datasource.url=jdbc:postgresql://localhost:5432/postgres
spring.datasource.username=postgres
spring.datasource.password=rootroot
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.format_sql=true
  • 将 MongoDB 配置插入 application.properties 文件
# MongoDB configurations
spring.data.mongodb.host=localhost
spring.data.mongodb.port=27017
spring.data.mongodb.authentication-database=admin
spring.data.mongodb.username=root
spring.data.mongodb.password=rootroot
spring.data.mongodb.database=test

添加包含 Redis、PostgreSQL 和 MongoDB 服务的 docker-compose.yaml

  • 在项目根目录创建 docker-compose.yaml 并添加以下服务:redis:6、postgresql:17 和 mongo:8。

    • redis 服务应具有
      • 密码 rootroot
      • 将端口 6379 映射到 6379
      • 将卷 ./redis_data 挂载到 /data
    • postgresql 服务应具有
      • 密码 rootroot
      • 将端口 5432 映射到 5432
      • 将卷 ./postgres_data 挂载到 /var/lib/postgresql/data
    • mongo 服务应具有
      • initdb root 用户名 root
      • initdb root 密码 rootroot
      • 将端口 27017 映射到 27017
      • 将卷 ./mongo_data 挂载到 /data/db

添加 .gitignore 文件

  • 在 .gitignore 文件中插入 redis_data、postgres_data 和 mongo_data 目录

运行 Maven 测试命令

  • 运行 maven clean test 命令以检查项目是否正常工作
./mvnw clean test

运行 Maven 运行命令(可选)

  • (可选)docker-compose up -d 启动服务,./mvnw spring-boot:run 运行 Spring Boot 项目,docker-compose rm -sf 停止服务。

让我们一步步来做

评论

支持 Markdown