【Java项目脚手架系列】第四篇：Spring Boot基础项目脚手架

工一木子

于 2025-05-08 07:34:19 发布

阅读量668

点赞数 8

分类专栏： Java项目脚手架指南文章标签： java spring boot 开发语言

本文链接：https://blog.csdn.net/Prince140678/article/details/147778784

版权

Java项目脚手架指南专栏收录该内容

4 篇文章

订阅专栏

【Java项目脚手架系列】第四篇：Spring Boot基础项目脚手架

前言

在前面的文章中，我们介绍了Maven基础项目脚手架、JavaWeb基础项目脚手架和Spring MVC项目脚手架。今天，我们将介绍Spring Boot项目脚手架，这是一个用于快速搭建企业级应用的框架。

什么是Spring Boot？

Spring Boot是一个快速开发框架，它简化了Spring应用的初始搭建和开发过程。它提供了：

自动配置机制
内嵌服务器支持
丰富的starter依赖
完善的监控功能

技术栈

Spring Boot 2.7.0：核心框架
Spring Web：Web应用支持
Spring Boot Test：测试框架
Lombok：简化代码
Maven：项目构建工具

Spring Boot项目脚手架

1. 项目结构

springboot-scaffold/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── example/
│   │   │           ├── Application.java
│   │   │           ├── controller/
│   │   │           │   └── HelloController.java
│   │   │           └── service/
│   │   │               └── HelloService.java
│   │   └── resources/
│   │       └── application.properties
│   └── test/
│       └── java/
│           └── com/
│               └── example/
│                   └── service/
│                       └── HelloServiceTest.java
├── docs/
│   └── 04-springboot-scaffold.md
├── pom.xml
└── README.md

2. 核心文件内容

2.1 pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>springboot-scaffold</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.0</version>
        <relativePath/>
    </parent>

    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    </properties>

    <dependencies>
        <!-- Spring Boot Web -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- Spring Boot Test -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!-- Spring Boot DevTools -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>

        <!-- Lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

2.2 Application.java

package com.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

2.3 HelloController.java

package com.example.controller;

import com.example.service.HelloService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
    private final HelloService helloService;

    @Autowired
    public HelloController(HelloService helloService) {
        this.helloService = helloService;
    }

    @GetMapping("/hello")
    public String hello(@RequestParam(value = "name", defaultValue = "World") String name) {
        return helloService.getGreeting(name);
    }

    @GetMapping("/health")
    public String health() {
        return "Service is up and running!";
    }
}

2.4 HelloService.java

package com.example.service;

import org.springframework.stereotype.Service;

@Service
public class HelloService {
    public String getGreeting(String name) {
        return String.format("Hello, %s!", name);
    }
}

2.5 application.properties

# Server Configuration
server.port=8080
server.servlet.context-path=/api

# Application Name
spring.application.name=springboot-scaffold

# Logging Configuration
logging.level.root=INFO
logging.level.com.example=DEBUG

# Jackson Configuration
spring.jackson.serialization.write-dates-as-timestamps=false
spring.jackson.time-zone=GMT+8

3. 使用说明

克隆项目

git clone git@gitee.com:zengqiang_wang/leecode-inteview-questions-journal.git

导入IDE
- 推荐使用IntelliJ IDEA
- 选择"Open as Maven Project"
运行项目
```
mvn spring-boot:run
```
访问接口
- http://localhost:8080/api/hello
- http://localhost:8080/api/health

4. 单元测试

项目包含了完整的单元测试示例，展示了如何测试Spring Boot应用的不同组件：

服务层测试
- 使用JUnit 5进行基础单元测试
- 测试正常和边界情况
- 示例：HelloServiceTest.java
运行测试
```
mvn test
```

5. 最佳实践

控制器设计
- 使用RESTful风格
- 合理使用请求方法
- 统一响应格式
服务层设计
- 业务逻辑封装
- 事务管理
- 异常处理
配置管理
- 使用配置文件
- 环境隔离
- 敏感信息保护
安全性
- 输入验证
- 防止XSS攻击
- 控制文件上传

6. 常见问题

端口冲突
- 检查端口占用
- 修改配置文件
- 使用随机端口
依赖冲突
- 检查依赖树
- 排除冲突依赖
- 使用兼容版本
热重载失效
- 检查DevTools配置
- IDE设置
- 项目结构

总结

Spring Boot脚手架提供了一个完整的企业级应用开发基础，包含了必要的配置和示例代码。通过这个项目，你可以：

快速搭建Web应用
实现RESTful API
进行单元测试
使用开发工具

明日预告

明天我们将介绍Spring Boot + MyBatis项目脚手架，主要内容包括：

MyBatis与Spring Boot的集成
数据库配置和连接池
实体类和数据访问层
事务管理
分页查询实现
单元测试示例

敬请期待！