简明了解常规SpringBoot项目结构

一个典型的 Java Spring Boot 项目的结构通常遵循一定的约定,以便于组织代码和资源。

以下是一个基本的项目结构示例,它包含了常见的目录和文件:

my-spring-boot-project/
│
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── example/
│   │   │           └── myproject/
│   │   │               ├── Application.java
│   │   │               ├── config/
│   │   │               │   ├── AppConfig.java
│   │   │               │   └── ...
│   │   │               ├── controller/
│   │   │               │   ├── MyController.java
│   │   │               │   └── ...
│   │   │               ├── service/
│   │   │               │   ├── MyService.java
│   │   │               │   └── ...
│   │   │               ├── repository/
│   │   │               │   ├── MyRepository.java
│   │   │               │   └── ...
│   │   │               ├── entity/
│   │   │               │   ├── MyEntity.java
│   │   │               │   └── ...
│   │   │               ├── dto/
│   │   │               │   ├── MyDto.java
│   │   │               │   └── ...
│   │   │               ├── exception/
│   │   │               │   ├── MyException.java
│   │   │               │   └── ...
│   │   │               ├── util/
│   │   │               │   └── MyUtil.java
│   │   │               └── ...
│   │   │
│   │   ├── resources/
│   │   │   ├── application.properties
│   │   │   ├── static/
│   │   │   │   ├── css/
│   │   │   │   ├── js/
│   │   │   │   └── images/
│   │   │   ├── templates/
│   │   │   │   └── index.html
│   │   │   └── ...
│   │   │
│   │   └── test/
│   │       ├── java/
│   │       │   └── com/
│   │       │       └── example/
│   │       │           └── myproject/
│   │       │               ├── MyProjectApplicationTests.java
│   │       │               ├── controller/
│   │       │               │   └── ...
│   │       │               ├── service/
│   │       │               │   └── ...
│   │       │               ├── repository/
│   │       │               │   └── ...
│   │       │               └── ...
│   │       │
│   │       └── resources/
│   │           └── ...
│   │
│   └── test/
│       └── java/
│           └── com/
│               └── example/
│                   └── myproject/
│                       └── ...
│
├── .gitignore
├── mvnw
├── mvnw.cmd
├── pom.xml
└── README.md

这个结构包括以下部分:

  • src/main/java/:存放 Java 源代码。
  • src/main/resources/:存放配置文件(如 application.properties)、静态资源(如 CSS、JavaScript、图片)、模板文件(如 Thymeleaf 模板)等。
  • src/main/test/:存放测试代码。
  • src/test/java/:存放测试用的 Java 源代码。
  • src/test/resources/:存放测试用的配置文件和资源。
  • src/main/java/com/example/myproject/:一个包结构示例,通常按照公司或项目的命名空间来组织。
  • src/main/java/com/example/myproject/Application.java:Spring Boot 应用的入口点。
  • src/main/java/com/example/myproject/config/:存放配置类。
  • src/main/java/com/example/myproject/controller/:存放控制器类。
  • src/main/java/com/example/myproject/service/:存放服务层类。
  • src/main/java/com/example/myproject/repository/:存放数据访问对象(DAO)或仓库接口。
  • src/main/java/com/example/myproject/entity/:存放实体类。
  • src/main/java/com/example/myproject/dto/:存放数据传输对象(DTO)。
  • src/main/java/com/example/myproject/exception/:存放自定义异常类。
  • src/main/java/com/example/myproject/util/:存放工具类。
  • src/main/resources/static/:存放静态资源文件,如 CSS、JavaScript、图片等。
  • src/main/resources/templates/:存放模板文件,如 Thymeleaf 模板。
  • src/test/java/:存放测试用的 Java 源代码。
  • .gitignore:Git 忽略文件,指定不需要提交到版本控制的文件和目录。
  • mvnwmvnw.cmd:Maven Wrapper 脚本,用于在没有安装 Maven 的环境中运行 Maven 命令。
  • pom.xml:Maven 项目对象模型(POM)文件,定义了项目的依赖、构建配置等。
  • README.md:项目的 README 文件,通常包含项目介绍、安装指南、使用说明等。

这个结构是根据 Spring Boot 的最佳实践和约定来组织的,但你可以根据项目的具体需求进行调整。例如,你可能需要添加更多的包来组织不同的功能模块,或者添加额外的配置文件来满足特定的配置需求。

  • 10
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 2
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

哒不溜-w

别给我打手续费太贵

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

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

打赏作者

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

抵扣说明:

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

余额充值