深入解析Spring Boot项目目录结构:从新手到规范实践

一、标准项目结构全景图

典型的Spring Boot项目(Maven构建)目录结构如下:

my-spring-project/
├── src/
│   ├── main/
│   │   ├── java/              # 核心代码
│   │   │   └── com/
│   │   │       └── example/
│   │   │           └── myapp/
│   │   ├── resources/         # 资源配置
│   │   │   ├── static/        # 静态资源
│   │   │   ├── templates/     # 模板文件
│   │   │   └── application.yml # 主配置
│   │   └── webapp/            # Web资源(可选)
│   └── test/                  # 测试代码
├── target/                    # 构建输出
├── pom.xml                    # Maven配置
└── .gitignore                 # 版本控制排除
二、核心代码分层架构
  1. 控制器层(Controller)

    • 路径示例:com.example.myapp.controller
    • 职责:处理HTTP请求,参数校验,响应返回
    • 最佳实践:保持简洁,避免业务逻辑
    @RestController
    @RequestMapping("/api/users")
    public class UserController {@Autowiredprivate UserService userService;@GetMapping("/{id}")public ResponseEntity<UserDTO> getUser(@PathVariable Long id) {return ResponseEntity.ok(userService.getUserById(id));}
    }
    
  2. 服务层(Service)

    • 路径:com.example.myapp.service
    • 核心业务逻辑实现
    • 接口与实现分离模式:
    public interface UserService {UserDTO getUserById(Long id);
    }@Service
    public class UserServiceImpl implements UserService {// 业务逻辑实现
    }
    
  3. 持久层(Repository)

    • 路径:com.example.myapp.repository
    • 数据库交互抽象层
    • Spring Data JPA示例:
    @Repository
    public interface UserRepository extends JpaRepository<User, Long> {Optional<User> findByEmail(String email);
    }
    
  4. 领域模型(Model)

    • 路径:com.example.myapp.model
    • 包含:实体类(Entity)、DTO、VO等
    • 实体类示例:
    @Entity
    @Table(name = "users")
    public class User {@Id@GeneratedValue(strategy = GenerationType.IDENTITY)private Long id;private String username;// 其他字段及关联关系
    }
    
三、资源文件深度解析
  1. 应用配置

    • application.yml优先级高于.properties
    • 多环境配置方案:
    application-dev.yml
    application-prod.yml
    
    • 自定义配置项管理:
    app:security:jwt-secret: "mySecretKey"token-expiration: 86400
    
  2. 静态资源管理

    • /static目录存放:
    • CSS/JS文件
    • 图片资源
    • 图标文件(favicon.ico)
    • 访问路径:http://localhost:8080/static/style.css
  3. 模板引擎集成

    • Thymeleaf模板存放路径:/templates
    • 安全渲染示例:
    <div th:text="${#strings.escapeXml(user.name)}"></div>
    
四、测试体系架构
  1. 单元测试层

    • 路径:src/test/java
    • 分层对应测试:
    • Controller → @WebMvcTest
    • Service → @MockBean
    • Repository → @DataJpaTest
  2. 集成测试策略

    • 完整应用启动测试:
    @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
    public class IntegrationTest {@LocalServerPortprivate int port;@Testpublic void testApiEndpoint() {// 使用TestRestTemplate发起请求}
    }
    
五、进阶结构设计
  1. 自定义包结构方案

    com.example.myapp
    ├── config/        // 配置类集中管理
    ├── exception/     // 自定义异常处理
    ├── aspect/        // AOP切面编程
    ├── utils/         // 工具类集合
    └── security/      // 安全相关组件
    
  2. 多模块项目结构

    parent-project/
    ├── common-module/    // 通用工具
    ├── domain-module/    // 领域模型
    ├── service-module/   // 业务逻辑
    └── web-module/       // Web接口
    
  3. 配置类最佳实践

    @Configuration
    @EnableAsync
    @EnableScheduling
    public class AppConfig {@Beanpublic PasswordEncoder passwordEncoder() {return new BCryptPasswordEncoder();}
    }
    
六、构建文件解析

Maven核心配置项:

<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!-- 开发环境专用依赖 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-devtools</artifactId><scope>runtime</scope><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>
七、常见问题解决方案
  1. 包扫描失效处理

    • 确保主类位于根包路径
    • 显式指定扫描路径:
    @SpringBootApplication(scanBasePackages = "com.example")
    
  2. 配置加载优先级

    1. 命令行参数
    2. JNDI属性
    3. 应用外部配置文件
    4. 打包内部的配置文件
    5. @Configuration类上的@PropertySource
  3. 多环境构建策略

    mvn clean package -Pprod
    

    对应pom配置:

    <profiles><profile><id>prod</id><properties><activatedProperties>prod</activatedProperties></properties></profile>
    </profiles>
    
结语

规范的目录结构是项目可维护性的基石。建议根据团队规模制定适当的规范:小型项目可采用标准结构,中大型项目推荐模块化设计。关键是要保持一致性,并通过持续集成确保结构规范得以贯彻。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.pswp.cn/bicheng/80882.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【C语言】宏经典练习题,交换奇偶位

交换奇偶位 写一个宏&#xff0c;可以将一个整数的二进制位的奇数位和偶数位交换。 #define Swap(x) x(((x&0x55555555)<<1)((x&0xaaaaaaaa)>>1)) int main() {int a 10;Swap(a);printf("%d\n", a);return 0; } 写宏的思路&#xff1a; 假设…

VSCode-插件:codegeex:ai coding assistant / 清华智普 AI 插件

一、官网 https://codegeex.cn/ 二、vscode 安装插件 点击安装即可&#xff0c;无需复杂操作&#xff0c;国内软件&#xff0c;无需科学上网&#xff0c;非常友好 三、智能注释 输入 // 或者 空格---后边自动出现注释信息&#xff0c;&#xff0c;按下 Tab 键&#xff0c;进…

FFmpeg 与 C++ 构建音视频处理全链路实战(三)—— FFmpeg 内存模型

经过前面文章的 FFmpeg 编程实践&#xff0c;相信你已经对AVPacket和AVFrame这两个核心结构体不再陌生。当我们编写代码时&#xff0c;频繁调用unref系列 API 释放内存的操作&#xff0c;或许让你心生疑惑&#xff1a;这些函数究竟是如何实现内存释放的&#xff1f;又该在何时准…

c 中的哈希表

哈希是一种可以接受各种类型、大小的输入&#xff0c;输出一个固定长度整数的过程。你可以将哈希理解成一种特殊的映射&#xff0c;哈希映射&#xff0c;将一个理论无限的集合A映射到有限整数集合B上。 哈希函数&#xff1a;哈希函数是哈希过程的核心&#xff0c;它决定了哈希映…

【一次成功!】Ubuntu22.04安装cartographer

之前在ubuntu20.04上成功安装cartographer&#xff0c;但是翻遍全网都没找到官方的22.04安装教程&#xff0c;然后找到小鱼的&#xff0c;试了一下&#xff0c;一次成功&#xff0c;连接如下&#xff1a; gd2l-ros2/docs/humble/chapt10/get_started/2.Carto介绍及安装.md at …

【WPF】Opacity 属性的使用

在WPF&#xff08;Windows Presentation Foundation&#xff09;中&#xff0c;Opacity 属性是定义一个元素透明度的属性&#xff0c;其值范围是从 0.0&#xff08;完全透明&#xff09;到 1.0&#xff08;完全不透明&#xff09;。由于 Opacity 是在 UIElement 类中定义的&…

8天Python从入门到精通【itheima】-6~10

目录 7节-开发出第一个Python程序: 1.在cmd窗口写下第一个最简单的程序:Hello World!!! 9节: 1.如何卸载python: 2.报错:不是可运行的程序 ​编辑 3.报错:无法初始化设备PRN: 4.报错:语法错误——非法的字符 10节-python解释器: 1.python解释器的原理: 2.解…

Mac 3大好用的复制粘贴管理工具对比

剪贴板管理器是查看复制粘贴历史记录的工具&#xff0c;几乎是每个苹果电脑用户必备工具。市面上的工具很多&#xff0c;我结合了功能丰富、设计简洁、交互便利整理了目前3款头部剪贴板应用 Paste、PasteNow、PasteMe。 Paste 优势&#xff1a;老牌剪切板应用&#xff0c;功能…

2025年全国青少年信息素养大赛初赛模拟测试网站崩了的原因及应对比赛流程

2025年全国青少年信息素养大赛初赛模拟测试昨天开始&#xff0c;由于同一时间涌入太多的人&#xff0c;导致网站的服务器奔了&#xff0c;出现了各种状况&#xff0c;导致很多人没有模拟上&#xff0c;大家今天可以刷新或者提前打开网页。 有的是一直“转圈圈”&#xff0c;有的…

02 | 大模型微调 | 从0学习到实战微调 | 从数学概率到千亿参数大模型

一、导读 作为非AI专业技术开发者&#xff08;我是小小爬虫开发工程师&#x1f60b;&#xff09; 本系列文章将围绕《大模型微调》进行学习&#xff08;也是我个人学习的笔记&#xff0c;所以会持续更新&#xff09;&#xff0c;最后以上手实操模型微调的目的。 &#xff08;…

十四、继承与组合(Inheritance Composition)

十四、继承与组合&#xff08;Inheritance & Composition&#xff09; 引言 C最引人注目的特性之一是代码复用。组合&#xff1a;在新类中创建已有类的对象。继承&#xff1a;将新类作为已有类的一个类型来创建。 14.1 组合的语法 Useful.h //C14:Useful.h #ifndef US…

2025年5月-信息系统项目管理师高级-软考高项一般计算题

决策树和期望货币值 加权算法 自制和外购分析 沟通渠道 三点估算PERT 当其他条件一样时&#xff0c;npv越大越好

OpenJDK 17 中线程启动的完整流程用C++ 源码详解

1. 线程创建入口&#xff08;JNI 层&#xff09; 当 Java 层调用 Thread.start() 时&#xff0c;JVM 通过 JNI 进入 JVM_StartThread 函数&#xff1a; JVM_ENTRY(void, JVM_StartThread(JNIEnv* env, jobject jthread))// 1. 检查线程状态&#xff0c;防止重复启动if (java_…

Spring MVC参数传递

本内容采用最新SpringBoot3框架版本,视频观看地址:B站视频播放 1. Postman基础 Postman是一个接口测试工具,Postman相当于一个客户端,可以模拟用户发起的各类HTTP请求,将请求数据发送至服务端,获取对应的响应结果。 2. Spring MVC相关注解 3. Spring MVC参数传递 Spri…

Python面向对象编程(OOP)深度解析:从封装到继承的多维度实践

引言 面向对象编程(Object-Oriented Programming, OOP)是Python开发中的核心范式&#xff0c;其三大特性——​​封装、继承、多态​​——为构建模块化、可维护的代码提供了坚实基础。本文将通过代码实例与理论结合的方式&#xff0c;系统解析Python OOP的实现机制与高级特性…

0.66kV0.69kV接地电阻柜常规配置单

0.66kV/0.69kV接地电阻柜是变压器中性点接地电阻柜中的特殊存在&#xff0c;主要应用于低压柴油发电机组220V、火力发电厂380V、煤炭企业660V/690V等电力系统或电力用户1000V的低压系统中。 我们来看看0.66kV0.69kV接地电阻柜配置单&#xff1a; 配置特点如下&#xff1a; 1…

矩阵短剧系统:如何用1个后台管理100+小程序?深度解析多端绑定技术

短剧行业效率革命&#xff01;一套系统实现多平台内容分发、数据统管与流量聚合 在短剧行业爆发式增长的今天&#xff0c;内容方和运营者面临两大核心痛点&#xff1a;多平台运营成本高与流量分散难聚合。传统模式下&#xff0c;每个小程序需独立开发后台&#xff0c;导致人力…

CSS可以继承的样式汇总

CSS可以继承的样式汇总 在CSS中&#xff0c;以下是一些常见的可继承样式属性&#xff1a; 字体属性&#xff1a;包括 font-family &#xff08;字体系列&#xff09;、 font-size &#xff08;字体大小&#xff09;、 font-weight &#xff08;字体粗细&#xff09;、 font-sty…

BFS算法篇——打开智慧之门,BFS算法在拓扑排序中的诗意探索(上)

文章目录 引言一、拓扑排序的背景二、BFS算法解决拓扑排序三、应用场景四、代码实现五、代码解释六、总结 引言 在这浩瀚如海的算法世界中&#xff0c;有一扇门&#xff0c;开启后通向了有序的领域。它便是拓扑排序&#xff0c;这个问题的解决方法犹如一场深刻的哲学思考&#…

【Qt开发】信号与槽

目录 1&#xff0c;信号与槽的介绍 2&#xff0c;信号与槽的运用 3&#xff0c;自定义信号 1&#xff0c;信号与槽的介绍 在Qt框架中&#xff0c;信号与槽机制是一种用于对象间通信的强大工具。它是在Qt中实现事件处理和回调函数的主要方法。 信号&#xff1a;窗口中&#x…