SpringBoot基础：一步步创建SpringBoot工程

摘要

本文介绍了，从零开始创建SpringBoot工程，且在每一步给出分析和原因。创建maven – 转Springboot – 引入jdbc – 引入数据库操作框架，最后给出了不同场景指定不同配置文件的方案。

背景

为什么要使用SpringBoot工程？

使用Spring Boot可以简化开发过程，提高开发效率，并提供了良好的支持和扩展能力，使得开发人员可以更专注于业务逻辑的实现。

• 简化Spring应用程序开发：Spring Boot通过自动配置和约定优于配置的原则，大大减少了开发人员的配置工作量。它提供了一个可执行的JAR文件，使得应用程序可以快速启动，并提供了内嵌的Servlet容器，无需部署到外部服务器上。
• 支持微服务架构：Spring Boot为构建微服务架构提供了良好的支持。它可以与Spring Cloud等工具集成，提供服务发现、负载均衡、断路器等功能，使得构建分布式系统更加简单。
• 集成第三方库和工具：Spring Boot提供了许多插件和扩展，可以方便地集成第三方库和工具，如数据库、消息队列、缓存等，大大提高了开发效率。
• 简化部署和监控：Spring Boot使部署变得简单，一键启动，解压jar，运行jar。它还使监控变得简单，可以看到进程的运行期性能参数。
• 强大的生态基础：Spring Boot是在强大的Spring帝国生态基础上面发展而来，继承了Spring的优点并新增了一些新功能和特性。

创建maven工程

• 方法一：可以通过spring.io官网直接创建SpringBoot工程，下载后Idea导入
• 方法二：Idea下载Spring插件，通过插件创建SpringBoot工程
• 方法三（本文介绍）：创建maven工程转SpringBoot工程

为什么不直接使用插件或spring.io下载SpringBoot工程？

（1）网络或平台限制，例如工作环境可能不允许访问外网
（2）可以清楚了解Springboot工程内部包含哪些主要依赖以及不同依赖之间的区别
（2）一步步创建Springboot工程，后续出现问题，心中大概有数可以及时定位问题

创建maven工程

idea或eclips开发工具，新建maven工程，填入groupId和artifactId，点击创建。例如我创建的groupId和artifactId分别是：com.azi，stocks

maven工程目录主要文件

（1）pom.xml文件

配置maven工程的基础属性，管理工程依赖等。maven强大的包自动管理功能就在该文件中体现。例如配置该工程的版本号，工程名，工程打包插件，工程外部包依赖等。

（2）src/main/java目录

存放开发的所有代码，包含业务代码类和启动类。

（3）src/main/resources目录

存放资源文件，例如初始化sql脚本，配置文件，图片，国际化翻译文件等

（4）src/test/java目录

看名知意。该目录存放工程代码的单元测试类。

maven工程转SpringBoot工程

导入SpringBoot父级依赖

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.5.2</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

加入SpringBoot启动器依赖

• dexcloud-springboot-starter：是一个基础SpringBoot启动器。包含了Spring Boot框架的核心组件和功能，如Spring框架、Spring MVC框架、Spring Boot自动配置和Spring Boot命令行工具等。这个启动器适用于构建基本的Spring Boot应用程序，可以方便地添加其他特定功能的启动器。
• dexcloud-springboot-starter-web：是一个用于构建Web应用程序的SpringBoot启动器。它包含了dexcloud-springboot-starter的所有功能，同时还包含了Spring MVC框架和Tomcat容器等Web相关组件。这个启动器可以快速搭建基于Spring MVC的Web应用，并且可以通过自动配置来减少开发人员的配置工作。

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

引入SpringBoot工程打包插件依赖

spring-boot-maven-plugin是SpringBoot工程简单的打包插件。同样，maven也存在打包依赖，例如：org.apache.maven.plugins。

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

创建启动类

• 在src/main/java目录下创建com.azi.stocks包
• 在com.azi.stocks包下创建启动类Main.class，并在Main.class类中加入以下代码

@SpringBootApplication
public class Main {
    public static void main(String[] args) {
        SpringApplication.run(Main.class,args);
    }
}

创建并配置资源文件

（1）指定资源文件目录位置

在pom文件中指定资源文件位置。包含.yml和.properties等文件结尾的资源文件。如果不指定资源文件目录位置，SpringBoot工程可能无法读取到配置文件，导致后续其他依赖例如jdbc无法加载。

<build>
<!-- （3）中的插件 -->
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <includes>
                <include>**/*.yml</include>
                <include>**/*.properties</include>
            </includes>
            <filtering>false</filtering>
        </resource>
    </resources>
</build>

（2）创建SprinBoot配置文件

在src/main/resources目录下创建yml文件。例如，创建application.yml文件，添加服务端口号。注意：yml文件名为application.yml，如果自定义其他名字，需要在：File – ProjectStructure – Facets – Spring – Configuration Files – Customize Spring Boot(左下角绿色叶子) – Add custom configuration files(+号) 添加配置文件。否则SpringBoot无法识别配置文件，可能导致启动失败。

server:
  port: 8081

启动程序查看日志

日志中包含：Tomcat started on port(s): 8081

SpringBoot工程配置数据源

软件产品一定离不开数据库持久化数据，而java代码访问数据库需要加入jdbc(java database connect)依赖，以及不同类型数据库访问依赖（例如postgresql，mysql等）

导入jdbc和数据库依赖

加入jdbc依赖，以及postgresql数据库访问依赖（如果是mysql数据库，需要更换为mysql数据库访问依赖）

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

配置数据库访问参数

加入数据库访问依赖后，必须配置数据库访问参数，否则程序会因找不到数据源参数配置而无法启动。

Failed to configure a DataSource: 'url' attribute is not specified and no embedded datasource could be configured.

在yml文件中加入datasource参数

spring:
  datasource:
    url: jdbc:postgresql://127.0.0.1:5432/pgdb  #配置数据库驱动，地址，端口，数据库名等。
    username: user#用户名
    password: password#密码
    driver-class-name: org.postgresql.Driver #配置pg类型数据库驱动名，如果是mysql则配置mysql驱动名

pg安装

注意：Failed to configure a DataSource: **异常解决

pom中引入了jdbc依赖，就必须在yml文件中配置DataSource数据源，否则会启动报错。如果不再需要jdbc依赖，需要删除pom依赖，并检查（External Libraries）已下载的jdbc外部依赖是否已经删除，如果未删除需要手动删除(File – Project Structure – Project Settings – Modules – Dependencies)，否则启动报错。

配置SpringBoot启动执行的sql脚本

程序启动时执行sql脚本，可以创建业务所需的数据库表结构。在实际软件开发中，这是一种比较简单的数据库结构创建方式。随着软件版本迭代，数据表结构也会变更，后续会引入flyway工具管理不同版本的sql脚本。

（1）在resources目录下创建db/stocks_V1.sql

create table  if not exists funds(
    id int,
    investmentId varchar (63),
    investmentName varchar (32),
    PRIMARY KEY (id)
) ;

（2）在yml中配置启动执行sql参数

spring:
  datasource:
    schema:
       - classpath:db/stocks_V1.sql. #sql脚本位置，classpath表示：src/main/java以及src/main/resources
    initialization-mode: always #执行方式，always表示每次启动都执行，此外还有其他方式：embedded，never

classpath位置
classpath路径为src/main/java 、 src/main/resources 以及第三方jar包的根路径

• classpath：用该名字表示一个相对路径（主目录），便于定位类或文件所在目录。
• classpath目录来源分析：mvn install后，与src同级别目录下存在打包好的工程目录：target/classes。该目录存储编译好的class文件，依赖的资源文件例如yml、sql文件等，存储文件信息的META-INF目录等。
• 由上一条可以看出，资源文件和class文件上层目录即为classpath。反推出classpath路径为src/main/java 以及 src/main/resources。

SpringBoot工程访问数据库

前面已经配置了SpringBoot程序启动，数据库连接驱动，此时已经可以通过DataSource访问数据库。但是，为了更加便捷地操作数据库，引入Mybatis持久层框架。

在pom文件中引入Mybatis依赖

<!-- Spring Boot MyBatis Starter -->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.2.0</version>
</dependency>

配置Mybatis文件映射参数

• resources下创建mapper目录
• 在yml文件中配置mybatis参数

mybatis:
  mapper-locations: classpath:mapper/*.xml#需要和实际的mapper文件位置保持一致
  # 开启驼峰uName自动映射到u_name
  map-underscore-to-camel-case: true

tips

MyBatis支持定制化SQL、存储过程以及高级映射。避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和原始类型、接口和 Java POJOs（Plain Old Java Objects，普通老式 Java 对象）映射为数据库中的记录。

创建实体类

创建Investment实体类

public class Investment {
    private String investmentId;
    private String investmentName;
    //getter and setter...
}

创建Mapper接口

创建InvestmentMapper接口

@Mapper
public interface InvestmentMapper {
    int getInvestmentCount();//对应mapper.xml文件
}

创建Mapper XML文件

在resources/mapper/目录下为Mapper接口创建对应的InvestmentMapper.xml文件，包含需要的SQL语句。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.azi.stocks.dao.InvestmentMapper">
    <select id="getInvestmentCount" resultType="int">
        SELECT count(*) FROM funds;
    </select>
</mapper>

注册Mapper接口到Spring容器

启动类加入@MapperScan注解指定Mapper接口所在的包路径

@SpringBootApplication
@MapperScan("com.azi.stocks.dao")
public class StocksApp {
    public static void main(String[] args) {
        SpringApplication.run(StocksApp.class,args);
    }
}

pom加入扫描资源文件类型

如果不加入资源文件扫描类型，SpringBoot运行时，在路径下找不到mapper.xml文件，执行抛出BindingException异常。

<resource>
     <directory>src/main/resources</directory>
     <includes>
         <include>**/*.xml</include>
     </includes>
     <filtering>false</filtering>
 </resource>

测试数据库访问

新建启动类Init，调用数据库访问接口，打印查询结果。自此，可访问数据库的Springboot基础工程已经完成。

@Component
public class Init implements ApplicationRunner {
    @Autowired
    InvestmentMapper investmentMapper;
    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println(investmentMapper.getInvestmentCount());
    }
}
//数据库中有1条数据，打印结果为：1

SpringBoot配置不同的yml文件

实际软件至少包含了开发、测试、上线生产过程。各阶段使用的配置必然不同，而SpringBoot也支持不同场景的配置文件。即：可以创建多个配置文件，根据不同场景使用不同的配置文件。

方式1

思路：创建一个主配置文件application.yml ，创建不同场景的子配置文件application-dev.yml（开发配置）、application-prod.yml（生产环境配置）、application-test.yml （测试环境配置）等，在主配置文件中指定所需的子配置文件，子配置文件会覆盖主配置文件中字段值。

spring:
 profiles:
   active: dev #配置开发环境，可配置prod，test

方式2

思路：一个yml文件中配置不同场景的配置，同时指定场景。

#使用dev环境
spring:
  profiles.active: dev
# 开发环境dev
spring:
  profiles: dev
server:
  port: 8080
# 测试环境test
spring:
  profiles: test
server:
  port: 8081
# 生产环境prod
spring:
  profiles: prod
 server:
  port: 9100

方式3

思路：打jar包时指定配置文件，命令参考如下：

java -jar your-application.jar --spring.config.name=your-configuration-file --spring.config.location=/path/to/your-configuration-file.properties

your-application.jar是要运行的Spring Boot应用程序的JAR包名称。–spring.config.name参数用于指定配置文件的基本名称（不需要后缀），而–spring.config.location参数则用于指定配置文件所在的路径。

觉得不错，点个👍吧，(^▽)，❤️

关注我，不定时分享工作中总结的干货😄