SpringBoot项目的目录结构及名规范

桃扇骨 2023-10-08 14:52 24阅读 0赞

## 写在前面 ##

> 本篇博文介绍了基于SpringBoot开发时的目录结构及命名规范，通过介绍能够为你解决，在实际项目中如何规划目录结构？如何命名目录更规范？各个目录分别代表什么含义？等三个问题。

## 目录说明 ##

servicex                 // 项目名
        |- admin-ui          // 管理服务前端代码(一般将UI和SERVICE放到一个工程中，便于管理)
        |- servicex-auth     // 模块1
        |- servicex-common   // 模块2
        |- servicex-gateway  // 模块3
        |- servicex-system   // 模块4
            |- src
                |- main                  // 业务逻辑
                    |- assembly          // 基于maven assembly插件的服务化打包方案
                        |- bin           // 模块脚本(启动、停止、重启)
                        |- sbin          // 管理员角色使用的脚本(环境检查、系统检测等等)
                        |- assembly.xml  // 配置文件
                    |- java              // 源码
                        |- com
                            |- hadoopx
                                |- servicex
                                    |- system
                                        |- annotation     // 注解
                                        |- aspect         // 面向切面编程
                                        |- config         // 配置文件POJO
                                        |- filter         // 过滤器
                                        |- constant       // 存放常量
                                        |- utils          // 工具
                                        |- exception      // 异常
                                        |- controller     // 控制层(将请求通过URL匹配，分配到不同的接收器/方法进行处理，然后返回结果)
                                        |- service        // 服务层接口
                                            |- impl       // 服务层实现
                                        |- mapper/repository // 数据访问层，与数据库交互为service提供接口
                                        |- entity/domain     // 实体对象
                                            |- dto // 持久层需要的实体对象(用于服务层与持久层之间的数据传输对象)
                                            |- vo // 视图层需要的实体对象(用于服务层与视图层之间的数据传输对象)
                                        |- *Application.java  // 入口启动类
                    |- resources         // 资源
                        |- static        // 静态资源(html、css、js、图片等)
                        |- templates     // 视图模板(jsp、thymeleaf等)
                        |- mapper        // 存放数据访问层对应的XML配置
                            |- *Mapper.xml
                            |- ...
                        |- application.yml        // 公共配置
                        |- application-dev.yml    // 开发环境配置
                        |- application-prod.yml   // 生产环境配置
                        |- banner.txt    
                        |- logback.xml            // 日志配置
                |- test                  // 测试源码
                   |- java               
                        |- com
                            |- hadoopx
                                |- servicex
                                    |- system
                                        |- 根据具体情况按源码目录结构存放编写的测试用例
            |- target     // 编译打包输出目录(自动生成，不需要创建)
            |- pom.xml    // 该模块的POM文件
        |- sql            // 项目需要的SQL脚本
        |- doc            // 精简版的开发、运维手册
        |- .gitignore     // 哪些文件不用传到版本管控工具中
        |- pom.xml        // 工程总POM文件
        |- README.md      // 注意事项
    External Libraries    // 相关JAR包依赖

## 注意事项 ##

(1). mapper/repository，数据访问层，与数据库交互为service提供接口(对某个表进行增删改查，一个’\*Mapper.java’和一个’\*Mapper.xml’对应一张表(存在关联查询的情况)；Mybatis使用的是mapper，JPA使用的是repository)  
(2). entity/domain，数据实体类(Mybatis使用的是entity，JPA使用的是domain)  
(3). POJO，VO，DTO，DO，PO，BO的含义：

*  POJO：是一个简单的、普通的JAVA对象，它包含业务逻辑处理或持久化逻辑等。但不是JavaBean、EntityBean等，不具有任何特殊角色，不继承或不实现任何其它JAVA框架的类或接口。可以包含类似与JavaBean属性和对属性访问的setter和getter方法的对象。
 *  VO(View Object)：视图对象，用于展示层显示，代表展示层需要显示的数据。它的作用是把某个指定页面/组件需要的所有数据封装起来。
 *  DTO(Data Transfer Object)：数据传输对象，用于服务层与持久层之间的数据传输对象，代表服务层需要接收/返回的数据。
 *  DO(Domain Object)： 领域对象，就是从现实世界中抽象出来的有形或无形的实体对象。
 *  PO(Persistent Object)：持久化对象，它跟持久层(通常是关系型数据库)的数据结构形成一一对应的映射关系，数据表中的每个字段(或若干个)就对应PO的一个(或若干个)属性。
 *  BO(Business Object)： 业务对象，用于把业务逻辑封装为一个对象，这个对象可以包括一个或多个其它的对象。
 *  POJO持久化之后 -> PO；POJO传输过程中 -> DTO；POJO用作表示层 -> VO

![在这里插入图片描述][269f6a04c62f4da8a5d176567acfe06c.png]

[269f6a04c62f4da8a5d176567acfe06c.png]: https://img-blog.csdnimg.cn/269f6a04c62f4da8a5d176567acfe06c.png

发表评论取消回复

表情：

评论列表（有 0 条评论，24人围观）

还没有评论，来说两句吧...

相关阅读

相关 SpringBoot项目的目录结构及名规范

写在前面 > 本篇博文介绍了基于SpringBoot开发时的目录结构及命名规范，通过介绍能够为你解决，在实际项目中如何规划目录结构？如何命名目录更规范？各个目录分别代表什

桃扇骨/ 2023年10月08日 14:52/ 0 赞/ 25 阅读

相关 SpringBoot项目目录结构

SpringBoot项目基础结构示例 JAP和Mybatis混合项目目录结构 catelog ├─.gitignore ├─pom.xml

柔情只为你懂/ 2023年10月06日 12:19/ 0 赞/ 14 阅读

相关 SpringBoot项目搭建及目录介绍

目录一、废话 1.1.前言 1.2.所用工具介绍 1.3.不同版本区别二、项目搭建三、项目结构及模块意义 --------------------

向右看齐/ 2023年10月04日 13:57/ 0 赞/ 11 阅读

相关 JavaWeb项目的目录结构

![这里写图片描述][20160515195241832] 其中jsp文件存放在dhywebDemo目录下 [20160515195241832]: /images/2

谁践踏了优雅/ 2022年07月24日 06:14/ 0 赞/ 255 阅读

相关 rails项目的目录结构

appName/ app/ 用于存放模型、视图和控制器的文件 conifig/用于存放配置和数据库连接的参数 config.ru-Rack服务器配置 d

向右看齐/ 2022年07月15日 12:55/ 0 赞/ 253 阅读

相关软件目录结构规范

软件目录结构规范 @(学习)\[python\] 声明：此文是根据[Alex][]教学中整理而来。软件目录结构规范为什么要设计好目录结构

红太狼/ 2022年07月13日 03:50/ 0 赞/ 153 阅读

相关项目的目录结构

项目中常见的目录结构有两种： 1.主目录按照业务分类，内容目录按照模块分类（即主目录按照MVC架构分类，内部根据项目模块分类）优点：相对比较快定位对应的业务；

分手后的思念是犯贱/ 2022年06月16日 23:42/ 0 赞/ 345 阅读

相关 python3_软件目录结构规范

1.为什么要设计好目录结构 > "项目目录结构"其实也是属于"可读性和可维护性"的范畴，我们设计一个层次清晰的目录结构，就是为了达到以下两点: > >

深碍√TFBOYSˉ_/ 2022年05月14日 02:48/ 0 赞/ 162 阅读

相关 Java项目的目录结构

一、Common包 Common用来封装一些常用的公共方法。二、Dao包 Dao主要用来封装对数据库的新增，删除，查询，修改。叫做数据访问层。三、Serv

末蓝、/ 2022年01月23日 14:27/ 0 赞/ 591 阅读

相关 Springboot项目，MAVEN打包后的目录结构

一、原项目结构 ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG

超、凢脫俗/ 2021年11月17日 09:24/ 0 赞/ 756 阅读