简易Springboot搭建从零搭建springboot

转载

云端筑梦工匠 2024-03-31 10:27:17

文章标签 简易Springboot搭建 spring boot java bc Source 文章分类 架构后端开发

从零搭建一个SpringBoot项目

前言
Step 1：选择一个合适的SpringBoot版本
Step 2：建立一个普通的Maven工程
Step 3：引入一些必要的依赖
Step 4：写一个HelloController
Step 5：添加一个引导类
Step 6：测试it！
扩展1：如何覆盖默认配置？
扩展2：如何进行属性注入？

1) 新建JdbcProperties，用来进行属性注入
2) 在JdbcConfiguration中使用这个属性
3) 更优雅的写法

前言

SpringBoot是Spring项目中的一个子工程，与我们所熟知的Spring-framework同属于Spring的产品。

那么SpringBoot能帮助我们解决什么问题呢？

简化依赖管理。只需在POM.xml文件中定义好启动器，SpringBoot会自动导入相关依赖，并处理依赖冲突。
进行自动配置。根据导入的依赖，自动进行bean的默认配置(这是通过Spring4.x的条件注解来实现的)。
内嵌servlet容器。可以打包成jar文件独立运行。
提供安全指标、运行状况监测和外部化配置等功能。

总之，SpringBoot为所有 Spring 的开发者提供一个开箱即用的、非常快速的、广泛接受的入门体验。

SpringBoot基于约定优于配置的思想，可以让开发人员不必在配置与逻辑业务之间进行思维的切换，全身心的投入到逻辑业务的代码编写中，从而大大提高了开发的效率，一定程度上缩短了项目周期。

Step 1：选择一个合适的SpringBoot版本

SpringBoot对JDK和Spring的版本有一定要求，我们从SpringBoot的官网(https://spring.io/projects/spring-boot#learn)选择一个合适的版本，并在 Reference Doc. 中查看基本要求。

例如，我选择的是SpringBoot 2.0.6.RELEASE版本，它要求是 JDK8 或 JDK9 的环境，并且Spring版本在5.0.10.RELEASE或以上。同时，如果你习惯用 Maven 或 Gradle 构建项目，也应该满足其要求。

简易Springboot搭建从零搭建springboot_java

同时可以看到，在System Requirements下面，写明了内置serverlet容器的版本，我们也可以留意下，以备不时之需。

Step 2：建立一个普通的Maven工程

这里我们使用 maven 来构建项目，并且选用JDK8版本。
依次填写下面信息，确认无误后点击【finish】开始工程创建。
初次创建你可能会等待几分钟，创建完成后目录结构如下。

Step 3：引入一些必要的依赖

目前为止，我们的项目与springboot没有任何关联，那怎么把springboot加入我们的项目呢？

很简单，只需要在POM文件中加入下面几行配置，将 spring-boot-starter-parent 作为我们项目的父工程即可。

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.6.RELEASE</version>
    </parent>

要注意 spring-boot-starter-parent 的 version 标签要填写在 Step1 中选择好的版本号哦！

spring-boot-starter-parent 工程到底干了些什么？
对一些依赖进行了版本控制。
定义了一些插件以及其它一些配置，我们可以在POM中按住ctrl后点击查看。

我们需要搭建的是一个web项目，因此还需要web的启动器：spring-boot-starter-web

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

我们把它加入到POM文件中后，POM文件看起来应该像下面这样，同时在右侧的maven窗口，可以看到引入了一些依赖。

简易Springboot搭建从零搭建springboot_spring boot_02

这里的启动器是什么？
简言之，这是springboot管理复杂依赖关系的一种手段，你可以把它理解为一些用于某项功能所需要依赖的集合。例如，spring-boot-starter-web启动器就包含了上图右侧一些依赖，这些依赖web开发中可能经常被用到。

Step 4：写一个HelloController

简易Springboot搭建从零搭建springboot_spring boot_03

@RestController
public class HelloController {

    @GetMapping("hello")
    public String testHello(){
        return "My is spring-boot!";
    }

}

Step 5：添加一个引导类

引导类用于启动一个SpringBoot项目，在任意一个包含 main 方法的类上添加**@SpringBootApplication**注解即可！

但是必须要注意：引导类的作用范围为同级或下级目录！因此引导类一般单独建立一个类放在模块代码的最外层目录。

简易Springboot搭建从零搭建springboot_Source_04

@SpringBootApplication
public class HelloApplication {

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

}

@SpringBootApplication注解是下面三个注解的组合
@SpringBootConfiguration：@Configuration注解的包装类，声明当前类是一个配置类。
@EnableAutoConfiguration：开启自动配置，SpringBoot基于你所添加的依赖和你自己定义的bean，试图去猜测并配置你想要的配置。例如：我们引入了spring-boot-starter-web，而这个启动器中帮我们添加了tomcat、SpringMVC的依赖。此时自动配置就知道你是要开发一个web应用，所以就帮你完成了web及SpringMVC的默认配置了！
@ComponentScan：Spring框架提供的注解方式的注解扫描，等同于**<context:component-scan />**。

Step 6：测试it！

只需要点击左侧的运行按钮，即可一键编译和部署，十分的方便。

简易Springboot搭建从零搭建springboot_简易Springboot搭建_05

从***[4.Run]***窗口信息可以看到，我们的web项目已经成功部署在tomcat的8080端口。我们在浏览器输入网址(127.0.0.1:8080/hello)即可成功访问HelloController。

简易Springboot搭建从零搭建springboot_spring boot_06

扩展1：如何覆盖默认配置？

通过刚才的学习，我们知道@EnableAutoConfiguration会开启SpringBoot的自动配置，并且根据你引入的依赖来生效对应的默认配置。那么问题来了：

这些默认配置是怎么配置的，在哪里配置的呢？
为何依赖引入就会触发配置呢？
这些默认配置的属性来自哪里呢？

其实在我们的项目中，已经引入了一个依赖：spring-boot-autoconfigure，其中定义了大量自动配置类：

简易Springboot搭建从零搭建springboot_简易Springboot搭建_07

非常多，几乎涵盖了现在主流的开源框架，例如：redis、 jms、amqp、jdbc、jackson、mongodb、jpa、solr、elasticsearch… 等等，只要我们引入了相关依赖，对应的默认配置就会生效！

但如果默认配置不满足我们的要求呢，例如想把上面web应用部署在8090端口，怎么办？

同样非常简单，你只需要在类目录下建议一个名为application.properties或application.yml的文件，然后覆盖掉默认配置即可。如：

简易Springboot搭建从零搭建springboot_java_08

我们重启web应用，可以看到已经被部署在了8090端口，你也可以通过127.0.0.1:8090/hello来进行访问。

简易Springboot搭建从零搭建springboot_spring boot_09

诸如此类的key非常至多，在此不一一列举，在实际应用时可以根据需要进行修改！

扩展2：如何进行属性注入？

在Spring1.0时代，属性注入只能通过XML配置进行，例如要注入一个连接池，需要在XML中配置如下：

<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"
      init-method="init" destroy-method="close">
    <property name="url" value="${jdbc.url}" />
    <property name="username" value="${jdbc.username}" />
    <property name="password" value="${jdbc.password}" />
</bean>

在Spring2.0时代，引入了注解开发，但是因为并不完善，因此并未完全替代xml，此时的程序员往往是把xml与注解进行结合。
在Spring3.0及以后，Spring的注解逐渐完善，人们逐渐认识到使用纯注解配置的优雅，同样的，SpringBoot也推荐使用此种方式。

SpringBoot中属性注入一般分为两步：

1) 新建JdbcProperties，用来进行属性注入

在config包下新建一个JdbcProperties类，成员变量为要读取的外部属性，并为其添加getter/setter。
在类上添加@ConfigurationProperties(prefix = "jdbc")注解，声明其为属性读取类。

简易Springboot搭建从零搭建springboot_Source_10

@ConfigurationProperties(prefix = "jdbc")
public class JdbcProperties {
    private String url;
    private String driverClassName;
    private String username;
    private String password;
    // ... 略
    // getters 和 setters
}

在类上定义各个属性，名称必须与属性文件中 jdbc. 后面部分一致，并且必须具有getter和setter方法。

默认读取文件为application.yml，我们在文件中填写需要的外部属性，然后就可以通过对象的方式使用了，并且可以在类中对一些参数进行预处理。

jdbc:
  driverClassName: com.mysql.jdbc.Driver
  url: jdbc:mysql://127.0.0.1:3306/leyou
  username: root
  password: root

2) 在JdbcConfiguration中使用这个属性

通过@EnableConfigurationProperties(JdbcProperties.class)来声明要使用JdbcProperties这个类的对象。
然后你可以通过以下方式在JdbcConfiguration类中注入JdbcProperties。

@Autowired注入

@Configuration
@EnableConfigurationProperties(JdbcProperties.class)
public class JdbcConfiguration {

    @Autowired
    private JdbcProperties jdbcProperties;

    @Bean
    public DataSource dataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setUrl(jdbcProperties.getUrl());
        dataSource.setDriverClassName(jdbcProperties.getDriverClassName());
        dataSource.setUsername(jdbcProperties.getUsername());
        dataSource.setPassword(jdbcProperties.getPassword());
        return dataSource;
    }

}

构造函数注入

@Configuration
@EnableConfigurationProperties(JdbcProperties.class)
public class JdbcConfiguration {

    private JdbcProperties jdbcProperties;

    public JdbcConfiguration(JdbcProperties jdbcProperties){
        this.jdbcProperties = jdbcProperties;
    }

    @Bean
    public DataSource dataSource() {
        // 略
    }

}

@Bean方法的参数注入

@Configuration
@EnableConfigurationProperties(JdbcProperties.class)
public class JdbcConfiguration {

    @Bean
    public DataSource dataSource(JdbcProperties jdbcProperties) {
        // ...
    }
}

一般来说，使用第一种方式居多

简易Springboot搭建从零搭建springboot_简易Springboot搭建_11

@Configuration
@EnableConfigurationProperties(JdbcProperties.class)
public class JdbcConfiguration {

    @Autowired
    private JdbcProperties jdbcProperties;

    @Bean
    public DataSource dataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setUrl(jdbcProperties.getUrl());
        dataSource.setDriverClassName(jdbcProperties.getDriverClassName());
        dataSource.setUsername(jdbcProperties.getUsername());
        dataSource.setPassword(jdbcProperties.getPassword());
        return dataSource;
    }

}

注意，在POMX.xml中引入连接池的依赖。

<dependency>
    <groupId>com.github.drtrang</groupId>
    <artifactId>druid-spring-boot2-starter</artifactId>
    <version>1.1.10</version>
</dependency>

我们可以通过在HelloController中定义一个数据源，然后通过断点调试的方法来进行测试。

简易Springboot搭建从零搭建springboot_java_12

3) 更优雅的写法

事实上，如果一段属性只有一个Bean需要使用，我们无需将其注入到一个类（JdbcProperties）中。而是直接在需要的地方声明即可：

@Configuration
public class JdbcConfiguration {
    
    @Bean
    // 声明要注入的属性前缀，SpringBoot会自动把相关属性通过set方法注入到DataSource中
    @ConfigurationProperties(prefix = "jdbc")
    public DataSource dataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        return dataSource;
    }
}

我们直接把@ConfigurationProperties(prefix = "jdbc")声明在需要使用的@Bean的方法上，然后SpringBoot就会自动调用这个Bean（此处是DataSource）的set方法，然后完成注入。使用的前提是：该类必须有对应属性的set方法！

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。

上一篇：微信小程序session_key到底能干什么微信小程序的sessionkey

下一篇：pymysql查询结果获取字段 pymysql条件查询

提问和评论都可以，用心的回复会被更多人看到评论

发布评论

相关文章

官方博客	全部文章	热门标签	班级博客
了解我们	网站地图	意见反馈

鸿蒙开发者社区	51CTO学堂
51CTO	软考资讯