Spring Boot Starter Skill
概述
本 Skill 提供标准化的 Spring Boot 项目模板和开发指南，帮助你快速创建和开发 Spring Boot Web 应用。
快速开始
1. 使用项目模板
项目模板位于 assets/springboot-template/，包含完整的 Spring Boot Web 项目结构：
springboot-template/
├── pom.xml # Maven 配置文件
├── src/
│ ├── main/
│ │ ├── java/com/example/demo/
│ │ │ ├── DemoApplication.java # 启动类
│ │ │ ├── controller/ # 控制层
│ │ │ │ └── UserController.java # 用户REST接口
│ │ │ ├── service/ # 服务层
│ │ │ │ └── UserService.java # 用户业务逻辑
│ │ │ └── model/ # 模型层
│ │ │ └── User.java # 用户实体类
│ │ └── resources/
│ │ └── application.properties # 配置文件
│ └── test/ # 测试目录
2. 项目初始化
使用初始化脚本创建新项目：
bash scripts/init_springboot_project.sh <项目名> <包名> <输出目录>
示例：
bash scripts/init_springboot_project.sh myapp com.mycompany.app ./
3. 手动创建项目
如果需要手动搭建，按照以下步骤：
- 复制
assets/springboot-template/到目标位置 - 修改
pom.xml中的 groupId、artifactId、name - 修改包名（将 com.example.demo 改为你的包名）
- 修改
application.properties中的应用名称和端口
核心功能说明
RESTful API 接口
模板内置了完整的用户管理 REST API：
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /api/hello | 问候接口 |
| GET | /api/users | 获取所有用户 |
| GET | /api/users/{id} | 根据ID获取用户 |
| POST | /api/users | 创建新用户 |
| PUT | /api/users/{id} | 更新用户信息 |
| DELETE | /api/users/{id} | 删除用户 |
三层架构
模板遵循标准的三层架构模式：
- Controller 层：接收 HTTP 请求，参数校验，返回响应
- Service 层：业务逻辑处理
- Model 层：数据实体定义
开发指南
详细开发指南请参考 references/springboot-dev-guide.md，包含：
- 环境配置要求
- 项目启动方式
- 常用注解说明
- 扩展开发建议
- 常见问题解答
扩展开发建议
添加新的业务模块
- 在
model包下创建实体类 - 在
service包下创建服务类（添加 @Service 注解） - 在
controller包下创建控制器类（添加 @RestController 注解） - 使用 @Autowired 注入 Service
添加数据库支持
在 pom.xml 中添加对应依赖：
- MySQL: mysql-connector-java + spring-boot-starter-data-jpa
- MyBatis: mybatis-spring-boot-starter
添加接口文档
添加 SpringDoc OpenAPI 依赖：
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.2.0</version>
</dependency>
运行项目
前置要求
- JDK 17+
- Maven 3.6+
启动命令
# 进入项目目录
cd springboot-template
# 编译项目
mvn clean package
# 运行项目
mvn spring-boot:run
# 或者运行打包后的jar
java -jar target/springboot-demo-0.0.1-SNAPSHOT.jar
验证启动
访问 http://localhost:8080/api/hello 应该返回问候信息。
