001SpringBoot构建项目

╰+攻爆jí腚メ 2022-05-10 11:10 215阅读 0赞

有两种方式来构建 Spring Boot 项目基础框架，第一种是使用 Spring 官方提供的构建页面；第二种是使用 IntelliJ IDEA 中的 Spring 插件来创建。

**第一种、使用 Spring 官方提供页面构建**

*  访问 http://start.spring.io/ 网址。
 *  选择构建工具 Maven Project，编程语言选择 Java、Spring Boot 版本 2.0.5 以及一些工程基本信息，具体可参考下图。

![sb_start.png][]

**第二种、使用 IDEA 构建**

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

![idea4.png][]

*  填写相关内容后，单击 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 两个模块。**

### 项目结构介绍 ###

![avatar][]

如上图所示，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/> 
    </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 提供项目测试的工具包，内置了多种测试工具，方便我们在项目中做单元测试、集成测试。

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

上面配置了项目构建时所使用的编码，输出所使用的编码，最后指定了项目使用的 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 项目都会用到以上配置信息。

完整的pomp文件

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.mystudy</groupId>
        <artifactId>demo</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
    
        <name>demo</name>
        <description>Demo project for Spring Boot</description>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.0.5.RELEASE</version>
            <relativePath/> 
        </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>
    
        <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>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    
    </project>

[sb_start.png]: http://www.ityouknow.com/assets/images/2018/springboot/sb_start.png
[idea4.png]: http://www.ityouknow.com/assets/images/2018/it/idea4.png
[avatar]: /images/20220510/8a61980db73a45cda24a0d08ab02be63.png