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

写在前面

本篇博文介绍了基于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

在这里插入图片描述

  • 31
    点赞
  • 147
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
SpringBoot项目结构命名规范如下所示: 1. 最开始生成的目录: - .idea:存放项目的配置信息。 - .mvn:存放与mvnw相关文件,用于统一Maven版本管理。 - src:存放项目的源码和资源文件。 - target:存放项目构建后的文件和目录、jar包、war包、编译的class文件。 - .gitignore:git忽略规则。 - blog.iml:IntelliJ IDEA的工程配置文件。 - HELP.md:帮助文档。 - mvnw:与Linux执行mvnw命令有关。 - mvnw.cmd:与Windows执行mvnw命令有关。 - pom.xml:项目对象模型(核心重要)。 2. 标准开发级目录: - src/main:主目录。 - src/test:测试目录。 3. src/main目录下的子目录: - src/main/java:存放源代码文件。 - src/main/resources:存放各类静态资源文件、配置文件、页面文件等。 - src/main/resources/static:用于存放各类静态资源(css,js等)。 - src/main/resources/templates:用于存放模板文件(mappers等)。 - src/main/resources/application.properties:用于存放程序的各种依赖模块的配置信息。 4. src/test目录下的子目录: - src/test/java:存放测试代码文件。 5. MVC三层结构的文件夹描述: - dao(mapper):Dao层,负责与数据库打交道,具体到对某个表、某个实体的增删改查。 - service:服务层,封装Dao层的操作,使一个方法对外表现为实现一种功能。 - controller:业务控制层,负责接收数据和请求,并且调用Service层实现业务逻辑。 - service/Impl:服务层实现,service装的是接口,Impl装的是实现接口。 6. 必要层: - pojo:实体层。 7. 重要层: - utils:工具类。 - constant:常量接口类。 - config:配置信息类。 - vo:数据传输类。 综上所述,SpringBoot项目结构命名规范包括最开始生成的目录、标准开发级目录、MVC三层结构以及其他必要层和重要层的命名规范。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *2* *3* [springboot项目结构命名规范](https://blog.csdn.net/qq_51184516/article/details/126681931)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 100%"] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

cloneme01

谢谢您的支持与鼓励!

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值