avatar

认识一下 Spring Boot 项目工程目录

datas
发布时间
times2 min read
# Java

认识一下 Spring Boot 项目工程目录

Spring Boot工程目录

src/main/javaJava

主要的Java源代码目录，包含核心的应用程序代码。

com.example.project包名

项目包名

controller控制器

controller 文件夹通常用于存放控制器（Controller）类。控制器是 Spring MVC 框架中的一部分，它负责接收用户请求并调用相应的业务逻辑进行处理，然后返回响应给用户。

  • 位置：controller 文件夹通常位于项目的 src/main/java 目录下的包结构中，例如 com.example.project.controller。

  • 作用：controller 文件夹用于存放负责处理请求的控制器类。

  • 命名规范：一般而言，控制器类的命名应遵循约定，以 XxxController 的形式命名，其中 Xxx 表示控制器的名称或功能。

  • 类结构：每个控制器类通常包含一系列带有 @RequestMapping 或其他注解的方法，这些方法负责处理不同的请求路径，并调用相应的业务逻辑进行处理。控制器类还可以依赖注入其他组件、服务或工具类来完成其操作。

  • controller 文件夹通常具有以下结构：

    • dto/
      • DTO 是数据传输对象（Data Transfer Object）的缩写。它是一种设计模式，用于在不同层之间传输数据。DTO 主要用于解决在应用程序中不同层（如表示层、业务逻辑层、数据访问层）之间数据传输的问题。
      • DTO 的特点包括：
        1. 封装性：DTO 可以将多个相关的数据字段封装成一个对象，方便传输和处理。
        2. 可定制性：DTO 可以根据具体需求定义所需的数据字段和结构，避免传输过多或不必要的数据。
        3. 传输效率：通过 DTO 只传输需要的数据，可以减少网络传输的数据量，提高传输效率。
        4. 解耦性：DTO 可以将数据层和业务层解耦，使得它们可以独立地进行修改和演化，而不会相互影响。
    • vo/
      • VO 是值对象（Value Object）的缩写，也称为视图对象（View Object）。它是一种用于在应用程序的表示层中封装和展示数据的对象。
      • VO 的特点包括：
        1. 封装性：VO 可以将多个实体类或多个数据字段组合成一个对象，提供给视图使用，简化了数据传输和处理。
        2. 定制性：VO 根据特定的展示需求定义所需的数据字段和结构，方便视图按照其所需的方式展示数据。
        3. 瘦身模型：VO 通常只包含与视图相关的数据，不包含业务逻辑，使得模型变得“瘦身”，更加专注于核心业务处理。
        4. 视图解耦：VO 将业务数据转化为视图可用的数据结构，将视图与业务数据解耦，实现了业务逻辑和视图的分离。
domain表数据定义层

domain 文件夹通常用于存放实体类（Entity）或领域模型（Domain Model）。实体类是对业务对象进行建模的类，通常与数据库表或集合一一对应，并包含持久化逻辑和业务逻辑。

  • 位置：domain 文件夹通常位于项目的 src/main/java 目录下的包结构中，例如 com.example.project.domain。
  • 作用：domain 文件夹用于存放领域模型或实体类，这些类用于描述业务对象之间的关系和行为。
  • 命名规范：一般而言，实体类的命名应遵循约定，以 Xxx 的形式命名，其中 Xxx 表示实体对象的名称或功能。例如，一个订单实体类可以命名为 Order。
  • 属性定义：实体类通常包含一组属性，这些属性用于描述该对象的状态和行为。属性可以使用 JavaBean 规范进行定义，即使用私有成员变量，并提供公共的 get 和 set 方法。
  • ORM 映射：实体类通常与数据库表一一对应，因此需要使用对象关系映射（ORM）技术将实体类与数据库表进行映射。在 Spring Boot 中，可以使用 JPA、Hibernate 等框架来实现 ORM 映射。
  • 关联关系：实体类之间通常存在多种关联关系，例如一对多、多对多等。在实体类中，可以使用注解或其他方式来描述这些关联关系，并实现相应的业务逻辑。
  • 服务层调用：实体类通常作为服务层中的参数或返回值传递，它们通过服务层调用进行操作和持久化。
service数据操作层

service 文件夹通常用于存放服务类（Service）或业务逻辑处理类。服务类是负责处理业务逻辑、协调各个领域模型（实体类）之间的交互，并对外提供服务接口的类。

  • 位置：service 文件夹通常位于项目的 src/main/java 目录下的包结构中，例如 com.example.project.service。
  • 作用：service 文件夹用于存放服务类或业务逻辑处理类，这些类负责处理业务逻辑、协调多个实体类之间的交互。
  • 命名规范：一般而言，服务类的命名应遵循约定，以 XxxService 的形式命名，其中 Xxx 表示服务的名称或功能。例如，一个订单服务类可以命名为 OrderService。
  • 业务逻辑：服务类中包含与特定业务相关的方法和逻辑，例如创建订单、查询用户信息、计算总价等。服务类负责对输入参数进行验证、协调各个实体类的操作，并返回相应的结果。
mapper数据访问层

Mapper文件夹是在使用MyBatis框架进行数据库访问时常见的一个文件夹。它主要用于存放与数据访问层相关的Mapper接口和对应的XML映射文件。

  • 在 MyBatis 中，Mapper 接口定义了数据访问层的操作方法，通过这些方法可以方便地进行数据库的 CRUD 操作。Mapper 接口通常包含与数据库表相关的方法，如插入、更新、查询等。这些方法的命名和参数与具体的业务需求相关。

  • XML 映射文件（或称为 Mapper 文件）则用于将 Mapper 接口的方法与具体的 SQL 语句进行映射关联。它提供了一种声明式的方式来配置 SQL 语句，包括 SQL 语句的编写、参数映射、结果映射等。XML 映射文件中可以定义多个 SQL 语句，并且可以使用 MyBatis 提供的强大功能，如动态 SQL、参数映射、结果集映射等。

  • Mapper 文件夹通常具有以下结构：

    • mapper/
      • SomeEntityMapper.java：Mapper 接口文件，定义了与某个实体类相关的数据库访问方法。
      • SomeEntityMapper.xml：Mapper XML 映射文件，与 Mapper 接口文件相对应，配置了具体的 SQL 语句和映射规则。
      • 其他 Mapper 接口和对应的 XML 映射文件。
ProjectApplication启动类

主程序入口 ProjectApplication，可以通过直接运行该类来启动 Spring Boot 应用

  • 启动应用程序：ProjectApplication 包含了 main 方法，通过运行该方法，可以启动整个 Spring Boot 应用程序。它会加载 Spring Boot 的自动配置、依赖项和其他必要的组件，并启动内嵌的 Web 服务器（如 Tomcat 或 Jetty）。
  • 配置应用程序：Spring Boot 主要通过注解和配置来设置应用程序的各种配置信息。ProjectApplication 类通常带有 @SpringBootApplication 注解，该注解表示这是一个 Spring Boot 应用程序的入口类，它默认扫描同级目录及其子包下所有的组件。
  • 组织项目结构：通常，ProjectApplication 类位于基础包路径下（例如 com.example.application），并且作为其他包和组件的根目录。它可以帮助组织项目的结构，并提供一种层次化的架构，使得不同的模块和组件能够更好地协同工作。

src/main/resources资源文件

resources目录用于存放项目的资源文件。这些资源文件包括静态文件、配置文件、模板文件等。

以下是 resources 目录常见的用途：

  1. 静态文件：resources 目录可以存放静态文件，如 CSS 样式表、JavaScript 脚本、图片等。这些文件通常被用于前端界面的展示和交互。
  2. 配置文件：resources 目录中经常包含应用程序的配置文件，例如 application.properties 或 application.yml。这些文件用于配置 Spring Boot 应用程序的各种属性和行为，例如数据库连接信息、日志配置、国际化配置等。
  3. 模板文件：如果应用程序使用模板引擎来生成动态内容，resources 目录可以存放模板文件。模板文件可以包含静态部分和动态变量，通过模板引擎进行解析和渲染后生成最终的输出。
  4. 数据文件：有时候，项目需要加载一些初始化数据，例如数据库脚本、配置文件等。这些数据文件可以放置在 resources 目录下，并在应用程序启动时进行加载和初始化。
  5. i18n 文件：如果应用程序需要支持国际化和多语言功能，resources 目录可以存放国际化资源文件。这些文件包含了不同语言的文本翻译，通过读取相应的资源文件，应用程序可以在运行时根据用户的语言环境提供正确的翻译文本。

总之，resources 目录是 Spring Boot 项目中存放资源文件的标准目录，它提供了一个统一的位置来管理项目所需的各种资源。这些资源对于应用程序的配置、展示和功能实现都起到重要的作用。

pom.xml项目配置文件

pom.xml 是 Apache Maven 项目的配置文件。它用于定义 Maven 项目的结构、依赖关系、插件配置等。

在 Java 开发中，Apache Maven 是一种构建工具，它可以自动化地管理和构建 Java 项目。而 pom.xml 文件是 Maven 项目必不可少的配置文件之一，它遵循 XML 格式，用于描述项目的元数据和配置信息。

在 pom.xml 文件中，您可以指定项目的名称、版本号、组织信息等基本信息。同时，您还可以配置项目依赖项，包括第三方库、框架以及其他模块之间的依赖关系。此外，pom.xml 还允许您配置项目的构建过程，包括编译选项、测试、打包等。

通过编辑 pom.xml 文件，您可以定义项目的各种属性、构建规则以及所需的依赖库，Maven 会根据这些配置信息自动下载相关依赖、执行构建过程，并生成所需的输出（例如 JAR 文件、WAR 文件等）。因此，pom.xml 对于管理和构建 Maven 项目非常重要。