界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
部署与运维 · SKILL.md

spring-boot-skill

spring-boot-skill

【部署与运维】Build Spring Boot 4.x applications following the best practices. Use this skill: * When developing Spring Boot applications using Spring MVC, Spring Data JPA, Spring Modulith, Spring Security * To create recommended Spring Boot package structure * To implement REST APIs, entities/repositories, service layer, modular monoliths * To use Thymel…

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

name: spring-boot-skill description: > Build Spring Boot 4.x applications following the best practices. Use this skill: * When developing Spring Boot applications using Spring MVC, Spring Data JPA, Spring Modulith, Spring Security * To create recommended Spring Boot package structure * To implement REST APIs, entities/repositories, service layer, modular monoliths * To use Thymeleaf view templates for building web applications * To write tests for REST APIs and Web applications * To write ArchUnit tests for testing architecture * To configure the recommended plugins and configurations to improve code quality, and testing while using Maven. * To use Spring Boot's Docker Compose support for local development * To create Taskfile for easier execution of common tasks while working with a Spring Boot application

Spring Boot Skill

Apply the practices below when developing Spring Boot applications. Read the linked reference only when working on that area.

Maven pom.xml Configuration

Read references/spring-boot-maven-config.md for Maven pom.xml configuration with supporting plugins and configurations to improve code quality, and testing.

Package structure

Read references/code-organization.md for domain-driven, module-based package layout and naming conventions.

Spring Data JPA

Implement the repository and entity layer using references/spring-data-jpa.md.

Service layer

Implement business logic in the service layer using references/spring-service-layer.md.

Spring MVC REST APIs

Implement REST APIs with Spring MVC using references/spring-webmvc-rest-api.md.

Spring Modulith

Build a modular monolith with Spring Modulith using references/spring-modulith.md.

Thymeleaf

If Thymeleaf is used for view templates, refer references/thymeleaf.md

Testing

Write tests at complementary levels — unit, sliced Spring tests, and at least one end-to-end/smoke test; the levels are not either/or. Most framework-touching tests belong at the fast sliced level (@SpringBootTest(classes = …) or a slice annotation); keep full-context @SpringBootTest for a smoke test plus a request-level end-to-end. For why the levels are complementary and how to keep a large suite fast (context caching, one container for the suite), read references/testing-strategy.md.

What you're testingLevelReference
Business/domain logic, no frameworkUnit (no Spring context)testing-unit-mocking.md
JPA / JDBC / JdbcClient / Spring Data JDBC / jOOQ queriesPersistence slice + Testcontainerstesting-slices-persistence.md
Controller, JSON serialization, or a REST clientWeb slice (@WebMvcTest/@JsonTest/@RestClientTest)testing-slices-web.md
A few components together, external HTTP (WireMock), or a startup/request-level smoke testSliced @SpringBootTest(classes = …) or smoke testtesting-integration.md
Full REST API over a real port, full BaseIT suite (RestTestClient)End-to-endspring-boot-rest-api-testing.md
A view-rendering controller (MockMvcTester)Web slicespring-boot-webapp-testing-with-mockmvctester.md
Wiring a container (@ServiceConnection / dynamic properties)—testcontainers-wiring.md

All persistence and integration tests use Testcontainers with a real database (never in-memory H2); see references/testcontainers-wiring.md for @ServiceConnection vs dynamic-property wiring.

Test Data Setup

Prefer SQL fixtures with @Sql("classpath:/test-data.sql") before every test method. When setting up data programmatically, prefer exposed Services or ModuleAPI classes over Repositories, JdbcTemplate, or JdbcClient. Unless absolutely necessary, avoid using JdbcTemplate, JdbcClient, or TransactionTemplate to execute SQL for test data setup, which couples tests to internal implementation details. Read references/test-data-setup.md when creating or changing test fixtures.

Write ArchUnit Tests

To write tests for testing the architecture using ArchUnit, refer references/archunit.md

Spring Boot Docker Compose Support

To use Docker Compose support for local development, refer references/spring-boot-docker-compose.md.

Taskfile

Use references/taskfile.md for easier commands execution.

我的收藏