搭建 SpringBoot 项目

Siona

搭建 SpringBoot 项目

一、创建项目

1. 创建父模块

（1）新建项目，父模块使用 Spring Initializr 创建。新建项目-父模块使用 Spring Initializr 创建.png

（2）选择 SpringBoot 版本、Lombok 等依赖。选择 SpringBoot 版本、Lombok 等依赖.png

GraalVM Native Support → 编译慢、体积小、启动快 → 适合运行在 Docker 中
Lombok → 不用自己写 get、set 等方法

（3）删掉 src、.mvn 相关文件。删掉 src、.mvn 相关文件.png

若要使用模块化，需要把 src 删掉 → Spring Cloud

（4）修改 Maven 修改 Maven.png

（5）在 .gitignore 文件中加入常见的日志文件等

logs/
tmp/

2. 创建子模块

（1）右键父模块，新建子模块。右键父模块-新建子模块.png

（2）创建一个空项目，直接使用 New Module 创建，去掉勾选 “Add sample code”，此方式仅需删除 test 文件夹即可。直接使用 New Module 创建，去掉勾选 “添加简单代码”.png

二、配置 pom.xml

1. 父模块 pom.xml


<properties>
    <java.version>17</java.version>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>17</maven.compiler.source>
    <maven.compiler.target>17</maven.compiler.target>
    <spring-boot.version>2.7.18</spring-boot.version>

    <mapstruct.version>1.5.0.RC1</mapstruct.version>
    <org.projectlombok.version>1.18.20</org.projectlombok.version>
    <lombok-mapstruct-binding.version>0.2.0</lombok-mapstruct-binding.version>
</properties>

<dependencyManagement>
<dependencies>
    <!-- SpringBoot 依赖配置 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-dependencies</artifactId>
        <version>${spring-boot.version}</version>
        <type>pom</type>
        <scope>import</scope>
    </dependency>
</dependencies>
</dependencyManagement>

<dependencies>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
</dependencies>

        <!--  配置阿里源  -->
<repositories>
<repository>
    <id>aliyun-repos</id>
    <url>https://maven.aliyun.com/nexus/content/groups/public/</url>
    <snapshots>
        <enabled>false</enabled>
    </snapshots>
</repository>
</repositories>

<pluginRepositories>
<pluginRepository>
    <id>aliyun-plugin</id>
    <url>https://maven.aliyun.com/nexus/content/groups/public/</url>
    <snapshots>
        <enabled>false</enabled>
    </snapshots>
</pluginRepository>
</pluginRepositories>

2. dao 模块 pom.xml


<dependencies>

    <dependency>
        <groupId>com.siona</groupId>
        <artifactId>bf-common</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>

    <!-- spring jdbc -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-jdbc</artifactId>
    </dependency>

    <!-- MySQL -->
    <dependency>
        <groupId>com.mysql</groupId>
        <artifactId>mysql-connector-j</artifactId>
        <version>8.1.0</version>
    </dependency>

    <!-- Mybatis -->
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.3.2</version>
    </dependency>
</dependencies>

<build>
<finalName>${project.artifactId}</finalName>
<plugins>
    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.11.0</version> <!-- or newer version -->
        <configuration>
            <annotationProcessorPaths>
                <path>
                    <groupId>org.mapstruct</groupId>
                    <artifactId>mapstruct-processor</artifactId>
                    <version>${mapstruct.version}</version>
                </path>
                <path>
                    <groupId>org.projectlombok</groupId>
                    <artifactId>lombok</artifactId>
                    <version>${org.projectlombok.version}</version>
                </path>
                <path>
                    <groupId>org.projectlombok</groupId>
                    <artifactId>lombok-mapstruct-binding</artifactId>
                    <version>${lombok-mapstruct-binding.version}</version>
                </path>
                <!-- other annotation processors -->
            </annotationProcessorPaths>
        </configuration>
    </plugin>
</plugins>
</build>

3. common 模块 pom.xml

（1）首先引入上面 dao module 的 <build> 标签。其次就是各种常用的依赖。


<dependencies>
    <!--    LocalDateTime 工具类需要    -->
    <dependency>
        <groupId>com.fasterxml.jackson.datatype</groupId>
        <artifactId>jackson-datatype-jsr310</artifactId>
    </dependency>

    <!-- fastJson -->
    <!-- https://mvnrepository.com/artifact/com.alibaba/fastjson -->
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>2.0.42</version>
    </dependency>

    <!-- HuTool 工具类 -->
    <dependency>
        <groupId>cn.hutool</groupId>
        <artifactId>hutool-all</artifactId>
        <version>5.8.22</version>
    </dependency>
</dependencies>

（2）在 src/main/resources/ 下加入 logback-spring.xml 日志文件，SpringBoot 框架会自动识别并输出日志文件。

这样在运行 jar 包时，会直接在根目录创建 logs/ 文件夹，日志文件会输出到该文件夹下。
日志保存时间 5 天（可手动修改）
logback-spring.xml 日志文件见框架项目的 git 仓库

# 不再输出 nohup.out 日志
nohup java -jar xxx.jar > /dev/null &

（3）common 模块中加入 cross 跨域、LocalDateTime 转换、异常等配置类

common 模块中加入 cross 跨域、LocalDateTime 转换、异常等配置类.png

4. api 模块 pom.xml

（1）api 模块的 build，与 common、dao 模块的不一样。common、dao 的是一样的，因为最终是为 api 模块服务。


<dependencies>
    <dependency>
        <groupId>com.siona</groupId>
        <artifactId>bf-common</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>

    <dependency>
        <groupId>com.siona</groupId>
        <artifactId>bf-dao</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>

</dependencies>

<build>
<finalName>${project.artifactId}</finalName>
<plugins>
    <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
        <executions>
            <execution>
                <goals>
                    <goal>repackage</goal>
                </goals>
            </execution>
        </executions>
    </plugin>
</plugins>
</build>

（2）在 src/main/resources/ 下创建测试环境、生产环境配置文件 application.yml、 application-dev.yml、application-prod.yml

（3）创建 package、xxxApplication.java 启动类

注意 api 模块不是 com.siona.api 而是 com.siona

package com.siona;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * 启动类
 * @Description TODO
 * @Version 1.0.0
 * @Date 2023/10/16 22:53
 * @Created by Siona
 */
@SpringBootApplication
@MapperScan("com.*.dao.mapper")
public class BFApiApplication {
    public static void main(String[] args) {
        SpringApplication.run(BFApiApplication.class, args);
    }
}

搭建 SpringBoot 项目

目录