spring boot 依赖环境和项目结构介绍

Posted 2021-02-09 pibaosi

1、环境介绍

使用 Spring Boot 开发项目需要有两个基础环境和一个开发工具，这两个环境是指 Java 编译环境和构建工具环境，一个开发工具是指 IDE 开发工具。

Spring Boot 2.0 要求 Java 8 作为最低版本，需要在本机安装 JDK 1.8 并进行环境变量配置，同时需要安装构建工具编译 Spring Boot 项目，最后准备个顺手的 IDE 开发工具即可。

 

1.1、构建工具

构建工具是一个把源代码生成可执行应用程序的自动化工具，Java 领域中主要有三大构建工具：Ant、Maven 和 Gradle。

Ant（AnotherNeatTool）的核心是由 Java 编写，采用 XML 作为构建脚本，这样就允许你在任何环境下运行构建。Ant 是 Java 领域最早的构建工具，不过因为操作复杂，慢慢的已经被淘汰了。
Maven，Maven 发布于 2004 年，目的是解决程序员使用 Ant 所带来的一些问题，它的好处在于可以将项目过程规范化、自动化、高效化以及强大的可扩展性。
Gradle，Gradle 是一个基于 Apache Ant 和 Apache Maven 概念的项目自动化建构工具。它使用一种基于 Groovy 的特定领域语言来声明项目设置，而不是传统的 XML。结合了前两者的优点，在此基础之上做了很多改进，它具有 Ant 的强大和灵活，又有 Maven 的生命周期管理且易于使用。

 

Spring Boot 官方支持 Maven 和 Gradle 作为项目构建工具。Gradle 虽然有更好的理念，但是相比 Maven 来讲其行业使用率偏低，并且 Spring Boot 官方默认使用 Maven，因此本系列课程选择使用 Maven 作为 Spring Boot 项目构建工具。
Java 领域最流行的 IDE 开发工具有 Eclipse 和 IDEA。Eclipse 是 Java 的集成开发环境（IDE），也是 Java 领域最流行的 IDE 开发工具之一，只是 Eclipse 这些年发展缓慢，慢慢的有些陈旧。IDEA（IntelliJ IDEA）是用于 Java 语言开发的集成环境，在业界被公认为是最好的 Java 开发工具之一，尤其在智能代码助手、代码自动提示、重构、J2EE 支持、创新的 GUI 设计等方面的功能可以说是超常的。因此强烈推荐大家使用 IntelliJ IDEA 开发 Spring Boot 项目。

2、开发工具安装

安装 JDK

下载安装

选择下载各系统对应的版本，这里以 Win10 64 位操作系统为例。

下载完成之后，双击鼠标进行安装，一直单击“下一步”按钮直至安装完毕。

环境变量配置

JDK 安装完毕后，接下来配置 JDK 环境变量，选择“我的电脑” | “属性” | “高级系统设置” | “环境变量” | “新建”命令：

在弹出的对话框中新建JAVA_HOME变量以及 Java 安装地址，如下图：

单击“确定”按钮后，回到环境变量界面，双击Path变量，添加两条 JDK 路径，如下：

以上，Java 环境变量配置完毕！

测试

配置完成之后，测试一下 JDK 是否配置正确，Win10 下使用快捷 window+r 输入 cmd 命令，进入运行窗口，执行命令java -version，若出现如下结果，则表示安装成功！

安装 Maven

安装 Maven 的前提是完成 Java 环境安装，Maven 依赖于 Java 环境。

下载安装

访问 Maven 官网下载 Maven 对应的压缩包，如下：

选择 Maven 的 zip 压缩包（apache-maven-3.5.4.zip），下载完成后解压到本机目录下。例如，路径：D:Common Filesapache-maven-3.5.4：

Maven 为绿色软件解压后即可使用。

环境变量配置

按照上面步骤打开环境变量设置页面，双击 Path 变量，将上一步解压的目录添加到 Path 中。

以上，Maven 环境配置完毕！

测试

Win10 下使用快捷 window+r 输入 cmd 命令，弹出“运行”对话框，执行命令 mvn -v，若出现如下结果，则表示安装成功！

settings.xml 设置

Maven 解压后目录下会有一个 settings.xml 文件，位置：${M2_HOME}/conf/settings.xml，用来配置 Maven 的仓库和本地 Jar 包存储地址。Maven 仓库地址代表从哪里去下载项目中的依赖包 Jar 包；Maven 会将所有的 Jar 包统一存储到一个地址下，方便各个项目复用。

localRepository 设置本地存放 Jar 包地址，可以根据自己的情况改动：

<localRepository>D:Common Filesmaven
epository</localRepository>

mirrors 为仓库列表配置的下载镜像列表：

<mirrors>
    <mirror>  
        <id>repo2</id>  
        <mirrorOf>central</mirrorOf>  
        <name>spring2.0 for this Mirror.</name>  
        <url>https://repo.spring.io/libs-milestone</url>  
    </mirror>
    ...
<mirrors>

为了方便大家使用，我已经配好了一份 settings.xml 模板，可下载后直接覆盖默认的 settings.xml 文件，覆盖完成后需要修改 localRepository 路径。

模板 settings.xml 文件地址，详见这里。

IntelliJ IDEA 安装

下载

打开 IntelliJ IDEA 2018 官方下载地址，IDEA 分为两种版本，即社区版和商业版，商业版是付费的，其功能多，社区版是免费的，功能相对较少。

安装

下载完成后，双击安装包开始安装，一直单击 Next 按钮：

安装过程中会选择安装路径，展示 32 或者 64 位的启动快捷键，最后单击 Finish 按钮，安装完成。

配置

安装完成后，第一次会提示选择配置设置，选择下面一个，单击 OK 按钮。

后面选择同意协议，输入“License server”激活软件，根据自己的习惯选择白色或者黑色的默认主题，然后选择 IntelliJ IDEA 支持的扩展功能，也可以使用默认选项，然后直接单击“下一步”按钮，最后单击 Start using IntelliJ IDEA 按钮完成配置。

以上，开发工具安装完毕！

 3、构建项目

使用 IDEA 构建

• 选择 File | New | Project... 命令，弹出新建项目的对话框。
• 选择 Spring Initializr，Next 也会出现上述类似的配置界面，IDEA 帮我们做了集成。

• 填写相关内容后，单击 Next 按钮，选择依赖的包再单击 Next 按钮，最后确定信息无误单击 Finish 按钮。

对上面的配置做如下解释。

• 第一个选择框选择创建以 Maven 构建项目，还是以 Gradle 构建项目，这是两种不同的构建方式，其中 Gradle 配置内容更简洁一些，并且包含了 maven 的使用，但我们日常使用 maven 居多。
• 第二个选择框选择编程语言，现在支持 Java、Kotlin 和 Groovy。
• 第三个选择框选择 Spring Boot 版本，可以看出 Spring Boot 2.0 的最新版本是 2.0.5。

下面就是项目的配置信息了。

• Group，一般填写公司域名，比如百度公司就会填：com.baidu，演示使用 com.neo。
• Artifact，可以理解为项目的名称了，可以根据实际情况来填，本次演示填 hello。
• Dependencies，在这块添加我们项目所依赖的 Spring Boot 组件，可以多选，本次选择 Web、Devtools 两个模块。

项目结构介绍

如上图所示，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.1.2.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 维护了体系内所有依赖包的版本信息。

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

<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 项目都会用到以上配置信息。