Spring Boot框架基础概览

2022-09-07 16:49:34 浏览数 (1)

基本概述

Spring Boot是所有基于Spring开发的项目的起点,Spring Boot的设计是为了让你尽可能快的跑起来Spring应用程序并且尽可能减少你的配置文件,它采用了"习惯优于配置"的理念,就像Maven整合了所有的JAR包一样,Spring boot整合了所有框架

框架特色

Spring Boot开发项目只需要非常少的几个配置就可以搭建起来一个WEB项目,并且利用IDEA可以自动生成,它主要有以下特点:

  • 简单、快速、方便地搭建项目
  • 对主流开发框架的无配置集成
  • 极大提高了开发、部署效率

项目构建

第一步:新建项目

使用IDEA创建SpringBoot项目,选择左侧Spring Initializr ,然后填写项目信息:

勾选上Web模板后点击Finsh:

第一次配置Spring Boot时IDEA会自动下载相应的依赖包,默认创建好的项目结构如下:

默认生成的文件夹以及文件如下:

  • SpringTestApplication:一个带有main()方法的类,用于启动应用程序
  • SpringTestApplicationTests:一个空的Junit测试,加载使用Spring Boot字典配置功能的Spring应用程序上下文
  • application.properties:一个空的properties文件,可以根据需要添加配置属性
  • pom.xml:Maven构建说明文件

第二步:HelloController

在com.al1ex.springtest包下新建一个HelloController:

代码语言:javascript复制
package com.al1ex.springtest;
 
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
public class HelloController {
 
    @RequestMapping("/hello")
    public String hello() {
        return "Hello Spring Boot!";
    }
}

这里的@RestController注解是@Controller和@ResponseBody注解的合体版

第三步:IDEA启动项目

运行SpringbootApplication

我们之所以没有手动的去配置Tomcat服务器是因为Spring Boot内置了Tomcat,等待一会儿就会看到下方的成功运行的提示信息:

之后在浏览器中访问8080端口来进行一个简单的测试:

项目结构

POM文件

下面我们一起来看一下默认生成的pom.xml文件中到底有那些东西

代码语言:javascript复制
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.6</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.al1ex</groupId>
    <artifactId>SpringTest</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>SpringTest</name>
    <description>SpringTest</description>
    <properties>
        <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-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>

我们可以看到一个比较陌生一些的标签<parent> ,这个标签主要用于配置Spring Boot的父级依赖:

代码语言:javascript复制
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.6</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

有了这个父级依赖当前的项目才是一个Spring Boot项目,spring-boot-starter-parent是一个特殊的starter ,它用来提供相关的Maven默认依赖,使用它之后常用的包依赖就可以省去version标签,关于Spring Boot具体提供了哪些JAR包的依赖,我们可以查看本地Maven仓库下进行查看

应用入口 Spring Boot项目通常有一个名为*Application的入口类,入口类里有一个main方法, 这个main方法其实就是一个标准的Java应用的入口方法

代码语言:javascript复制
package com.al1ex.springtest;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
@SpringBootApplication
public class SpringTestApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(SpringTestApplication.class, args);
    }
}

@SpringBootApplication是Spring Boot的核心注解,该注解组合了@Configuration、@EnableAutoConfiguration、@ComponentScan,如果不使用@SpringBootApplication注解也可以使用这三个注解代替,其中@EnableAutoConfiguratio使得SpringBoot根据类路径中的jar包依赖为当前项目进行自动配置,例如:添加了spring-boot-starter-web依赖,自动添加Tomcat和Spring MVC的依赖,Spring Boot会对Tomcat和Spring MVC进行自动配置,同时还会自动扫描@SpringBootApplication所在类的同级包以及下级包里的Bean ,所以入口类建议就配置在grounpID arctifactID组合的包名下

配置文件

Spring Boot使用一个全局的配置文件application.properties或application.yml,放置在src/main/resources目录或者类路径的/config下,Spring Boot不仅支持常规的properties配置文件,还支持yaml语言的配置文件 Spring Boot的全局配置文件的作用是对一些默认配置的配置值进行修改,下面我们同样的将Tomcat默认端口设置为8080并将默认的访问路径从/修改为/hello,下面是使用properties文件和yml文件实现时的区别:

注意:YML需要在":"后加一个空格,幸好IDEA很好地支持了YML文件的格式有良好的代码提示

在这里我们也可以直接把.properties后缀的文件删掉,然后使用.yml文件来进行简单的配置

之后再通过使用@Value来获取配置属性:

代码语言:javascript复制
package com.al1ex.springtest;
 
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
public class HelloController {
    @Value("${name}")
    private String name;
 
    @Value("${age}")
    private Integer age;
 
    @RequestMapping("/hello")
    public String hello() {
        return name   age;
    }
}

重启Spring Boot然后访问WEB即可看到正确的结果:

在这里我们并没有在yml文件中注明属性的类型,而是在使用的时候定义的,当然你也可以在配置文件中使用当前配置:

代码语言:javascript复制
package com.al1ex.springtest;
 
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
public class HelloController {
    @Value("${context}")
    private String content;
    
    @RequestMapping("/hello")
    public String hello() {
        return content;
    }
}

之后重新部署后依旧可以得到正确的结果:

虽然通过上面的这种方式我们可以获取到具体的信息,但是这种写法不但繁琐而且可能会造成类的臃肿,因为会有许许多多的@Value注解,于是关于配置信息的封装方法诞生了,我们可以把配置信息封装成一个类,首先在我们的name和age前加一个student前缀,然后新建一个StudentProperties的类用来封装这些信息,并用上两个注解:

  • @Component:表明当前类是一个Java Bean
  • @ConfigurationProperties(prefix = "student"):表示获取前缀为sutdent的配置信息
代码语言:javascript复制
package com.al1ex.springtest;
 
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
 
@Component
@ConfigurationProperties(prefix = "studnet")
public class StudentProperties {
    private String name;
 
    private  Integer age;
 
    public String getName() {
        return name;
    }
 
    public void setName(String name) {
        this.name = name;
    }
 
    public Integer getAge() {
        return age;
    }
 
    public void setAge(Integer age) {
        this.age = age;
    }
}
代码语言:javascript复制
package com.al1ex.springtest;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
public class HelloController {
    @Autowired
    private StudentProperties studentProperties;
 
    @RequestMapping("/hello")
    public String hello() {
        return studentProperties.getName()   studentProperties.getAge();
    }
}

这样我们就可以在控制器中使用,重启后得到正确信息:

项目部署

Springboot和我们之前学习的WEB应用程序不一样,其本质上是一个Java应用程序,Springboot部署主要有两种方式:

  • 全部打包成一个JAR
  • 全部打包成一个WAR

JAR部署方式

ProjectDir

进入SpringBoot项目所在目录:

代码语言:javascript复制
D:EnvironmentJAVAProjectSpringTest

打包成JAR

切换到SpringBoot目录下,之后打包:

代码语言:javascript复制
cd D:EnvironmentJAVAProjectSpringTest
mvn install

之后会在C:WindowsSystem32cmd.exe目录下生成一个jar文件

运行该JAR

接着输入以下命令之后就可以启动这个JAR了

代码语言:javascript复制
java -jar target/SpringTest-0.0.1-SNAPSHOT.jar

通过这种方式我们可以把此jar上传到服务器并运行从而达到部署的效果

WAR部署方式

ProjectDir

进入SpringBoot项目所在目录:

代码语言:javascript复制
D:EnvironmentJAVAProjectSpringTest
代码语言:javascript复制
package com.al1ex.springtest;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
@SpringBootApplication
public class SpringTestApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(SpringTestApplication.class, args);
    }
 
}

Application

修改Application为如下代码,新加@ServletComponentScan注解,并且继承SpringBootServletInitializer

代码语言:javascript复制
package com.al1ex.springtest;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.ServletComponentScan;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
 
@SpringBootApplication
@ServletComponentScan
public class Application extends SpringBootServletInitializer {
 
    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(Application.class);
    }
 
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

改POM文件

pom.xml修改为如下代码,主要两个改动

a、新加打包成war的声明:

代码语言:javascript复制
<packaging>war</packaging>

b、spring-boot-starter-tomcat修改为provided方式以避免和独立tomcat容器的冲突,表示provided只在编译和测试的时候使用,打包的时候就没它了

具体代码如下所示:

代码语言:javascript复制
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.6</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.al1ex</groupId>
    <artifactId>SpringTest</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>SpringTest</name>
    <description>SpringTest</description>
    <packaging>war</packaging>
    <properties>
        <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-starter-tomcat</artifactId>
            <scope>provided</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>

创建WAR包

代码语言:javascript复制
cd D:EnvironmentJAVAProjectSpringTest
mvn clean package

这样就在target目录下 生成了一个springboot-0.0.1-SNAPSHOT.war 文件

WAR包改名

如果用SpringTest-0.0.1-SNAPSHOT.war这个文件名部署,那么访问的时候就要在路径上加上SpringTest-0.0.1-SNAPSHOT,所以需要把这个文件重命名为ROOT.war然后把它放进tomcat的webapps目录下

启动并测试

运行tomcat下的bin目录里的startup.bat然后就可以启动了,启动后访问如下地址测试:

热部署类

在目前的Spring Boot项目中,当发生了任何修改之后我们都需要重新启动才能够正确的得到效果,这样会略显麻烦,Spring Boot提供了热部署的方式,当发现任何类发生了改变,就会通过JVM类加载的方式,加载最新的类到虚拟机中,这样就不需要重新启动也能看到修改后的效果了,实现方法也很简单,只需要修改pom.xml即可:

Step 1:添加spring-boot-devtools依赖并加上true

代码语言:javascript复制
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-devtools</artifactId>
    <optional>true</optional> <!-- 这个需要为 true 热部署才有效 -->
</dependency>

Step 2:修改spring-boot-maven-plugin插件

代码语言:javascript复制
<plugin>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-maven-plugin</artifactId>
   <configuration>
       <fork>true</fork>
   </configuration>
</plugin>

Step 3:重新启动Spring Boot ,然后修改任意代码,就能观察到控制台的自动重启现象

视图文件

下面我们介绍如何在Spring Boot项目中使用JSP来作为视图文件

第一步:修改pom.xml增加对JSP文件的支持

代码语言:javascript复制
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.6.6</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>
  <groupId>com.al1ex</groupId>
  <artifactId>SpringTest</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>SpringTest</name>
  <description>SpringTest</description>
  <properties>
    <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-starter-test</artifactId>
      <scope>test</scope>
    </dependency>
    <!-- servlet依赖. -->
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
    </dependency>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>jstl</artifactId>
    </dependency>
    <!-- tomcat的支持.-->
    <dependency>
      <groupId>org.apache.tomcat.embed</groupId>
      <artifactId>tomcat-embed-jasper</artifactId>
    </dependency>
  </dependencies>
 
  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
        <configuration>
          <fork>true</fork>
        </configuration>
      </plugin>
    </plugins>
  </build>
 
</project>

第二步:配置试图重定向JSP文件的位置

修改application.yml文件,将我们的JSP文件重定向到/WEB-INF/views/目录下:

第三步:修改HelloController

修改@RestController注解为@Controller ,然后将hello方法修改为:

代码语言:javascript复制
package com.al1ex.springtest;
 
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
 
import java.text.DateFormat;
import java.util.Date;
 
@Controller
public class HelloController {
    @RequestMapping("/hello")
    public String hello(Model m){
        m.addAttribute("now", DateFormat.getDateTimeInstance().format(new Date()));
        return "hello";
    }
}

第四步:新建hello.jsp文件

在src/main目录下依次创建webapp、WEB-INF、views目录,并创建一个hello.jsp文件:

第五步:刷新网页

部署项目并刷新网页可以看到正确效果了:

0 人点赞