Spring Boot 项目结构介绍

∥☆過路亽.° 提交于 2019-11-29 02:00:53

项目结构介绍

如上图所示,Spring Boot 的基础结构共三个文件,具体如下:

  • src/main/java:程序开发以及主程序入口;
  • src/main/resources:配置文件;
  • src/test/java:测试程序。

另外,Spring Boot 建议的目录结构如下。

com.example.myproject 目录下:

myproject   +-src      +- main           +- java                +- com.example.myproject                      +- comm                      +- model                      +- repository                      +- service                      +- web                      +- Application.java           +- resources                +- static                +- templates                +- application.properties      +- test   +-pom.xml

com.example.myproject 目录下:

  • Application.java,建议放到根目录下面,是项目的启动类,Spring Boot 项目只能有一个 main() 方法;
  • comm 目录建议放置公共的类,如全局的配置文件、工具类等;
  • model 目录主要用于实体(Entity)与数据访问层(Repository);
  • repository 层主要是数据库访问层代码;
  • service 层主要是业务类代码;
  • web 层负责页面访问控制。

resources 目录下:

  • static 目录存放 web 访问的静态资源,如 js、css、图片等;
  • templates 目录存放页面模板;
  • application.properties 存放项目的配置信息。

test 目录存放单元测试的代码;pom.xml 用于配置项目依赖包,以及其他配置。

采用默认配置可以省去很多设置,也可以根据公司的规范进行修改,至此一个 Java 项目搭建好了!

Pom 包介绍

pom.xml 文件主要描述了项目包的依赖和项目构建时的配置,在默认的 pom.xml 包中分为四大块。

第一部分为项目的描述信息:

<groupId>com.neo</groupId>  <artifactId>hello</artifactId>  <version>2.0.5.RELEASE</version>  <packaging>jar</packaging>    <name>hello</name>  <description>Demo project for Spring Boot</description>
  • groupId,项目的包路径;
  • artifactId,项目名称;
  • version,项目版本号;
  • packaging,一般有两个值:jar、war,表示使用 Maven 打包时构建成 Jar 包还是 War 包;
  • name,项目名称;
  • description,项目描述。

第二部分为项目的依赖配置信息:

<parent>    <groupId>org.springframework.boot</groupId>    <artifactId>spring-boot-starter-parent</artifactId>    <version>2.0.5.RELEASE</version>    <relativePath/> <!-- lookup parent from repository -->  </parent>    <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>    </dependency>    <dependency>      <groupId>org.springframework.boot</groupId>      <artifactId>spring-boot-starter-test</artifactId>      <scope>test</scope>    </dependency>  </dependencies>
  • parent,标签内配置 Spring Boot 父级版本 spring-boot-starter-parent,Maven 支持项目的父子结构,引入父级后会默认继承父级的配置;
  • dependencies,标签内配置项目所需要的依赖包,Spring Boot 体系内的依赖组件不需要填写具体版本号,spring-boot-starter-parent 维护了体系内所有依赖包的版本信息。
  • <scope>test</scope>,表示依赖的组件仅仅参与测试相关的工作,包括测试代码的编译和执行,不会被打包包含进去;
  • spring-boot-starter-test 是 Spring Boot 提供项目测试的工具包,内置了多种测试工具,方便我们在项目中做单元测试、集成测试。

第三部分为构建时需要的公共变量:

<properties>    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>    <java.version>1.8</java.version>  </properties>

上面配置了项目构建时所使用的编码,输出所使用的编码,最后指定了项目使用的 JDK 版本。

第四部分为构建配置:

<build>    <plugins>      <plugin>        <groupId>org.springframework.boot</groupId>        <artifactId>spring-boot-maven-plugin</artifactId>      </plugin>    </plugins>  </build>

使用 Maven 构建 Spring Boot 项目必须依赖于 spring-boot-maven-plugin 组件,spring-boot-maven-plugin 能够以 Maven 的方式为应用提供 Spring Boot 的支持,即为 Spring Boot 应用提供了执行 Maven 操作的可能。spring-boot-maven-plugin 能够将 Spring Boot 应用打包为可执行的 jar 或 war 文件,然后以简单的方式运行 Spring Boot 应用。

以上即为 pom.xml 文件基础内容,几乎所有的 Spring Boot 项目都会用到以上配置信息。

标签
易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!