SpringBoot一站式开发
官网:https://spring.io/projects/spring-boot
Spring Boot可以轻松创建独立的、基于Spring的生产级应用程序,它可以让你“运行即可”。大多数Spring Boot应用程序只需要少量的Spring配置。
SpringBoot功能:
- 创建独立的Spring应用程序
- 直接嵌入Tomcat、Jetty或Undertow(无需部署WAR包,打包成Jar本身就是一个可以运行的应用程序)
- 提供一站式的“starter”依赖项,以简化Maven配置(需要整合什么框架,直接导对应框架的starter依赖)
- 尽可能自动配置Spring和第三方库(除非特殊情况,否则几乎不需要你进行什么配置)
- 提供生产就绪功能,如指标、运行状况检查和外部化配置
- 没有代码生成,也没有XML配置的要求(XML是什么,好吃吗)
SpringBoot是现在最主流的开发框架,它提供了一站式的开发体验,大幅度提高了我们的开发效率。
走进SpringBoot
在SSM阶段,当我们需要搭建一个基于Spring全家桶的Web应用程序时,我们不得不做大量的依赖导入和框架整合相关的Bean定义,光是整合框架就花费了我们大量的时间,但是实际上我们发现,整合框架其实基本都是一些固定流程,我们每创建一个新的Web应用程序,基本都会使用同样的方式去整合框架,我们完全可以将一些重复的配置作为约定,只要框架遵守这个约定,为我们提供默认的配置就好,这样就不用我们再去配置了,约定优于配置!
而SpringBoot正是将这些过程大幅度进行了简化,它可以自动进行配置,我们只需要导入对应的启动器(starter)依赖即可。
完成本阶段的学习,基本能够胜任部分网站系统的后端开发工作,也建议学习完SpringBoot之后寻找合适的队友去参加计算机项目相关的高校竞赛。
我们可以通过IDEA来演示如何快速创建一个SpringBoot项目,并且无需任何配置,就可以实现Bean注册。
SpringBoot项目文件结构
我们在创建SpringBoot项目之后,首先会自动生成一个主类,而主类中的main 方法中调用了SpringApplication 类的静态方法来启动整个SpringBoot项目,并且我们可以看到主类的上方有一个@SpringBootApplication 注解:
@SpringBootApplication
public class SpringBootTestApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootTestApplication.class, args);
}
}
同时还自带了一个测试类,测试类的上方仅添加了一个@SpringBootTest 注解:
@SpringBootTest
class SpringBootTestApplicationTests {
@Test
void contextLoads() {
}
}
我们接着来看Maven中写了哪些内容:
<?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.2</version>
<relativePath/>
</parent>
<groupId>com.example</groupId>
<artifactId>springboot-study</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>SpringBootTest</name>
<description>SpringBootTest</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</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>
除了以上这些文件以外,我们的项目目录下还有:
- .gitignore - Git忽略名单,后面会专门讲解Git版本控制。
- application.properties - SpringBoot的配置文件,所有依赖的配置都在这里编写,但是一般情况下只需要配置必要项即可。
整合Web相关框架
我们来看一下,既然我们前面提到SpringBoot会内嵌一个Tomcat服务器,也就是说我们的Jar打包后,相当于就是一个可以直接运行的应用程序,我们来看一下如何创建一个SpringBootWeb项目。
这里我们演示使用IDEA来创建一个基于SpringBoot的Web应用程序。
它是真的快
创建完成后,直接开启项目,我们就可以直接访问:http://localhost:8080/,我们可以看到,但是由于我们没有编写任何的请求映射,所以没有数据。我们可以来看看日志:
2022-06-21 17:14:30.471 INFO 157144 --- [ main] c.example.SpringBootWebTestApplication : Starting SpringBootWebTestApplication using Java 1.8.0_291 on Harrison的联想小新pro13 with PID 157144 (D:\workspace\SpringBootDemo\SpringBootWebTest\target\classes started by Harrison in D:\workspace\SpringBootDemo\SpringBootWebTest)
2022-06-21 17:14:30.475 INFO 157144 --- [ main] c.example.SpringBootWebTestApplication : No active profile set, falling back to 1 default profile: "default"
2022-06-21 17:14:31.366 INFO 157144 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 8080 (http)
2022-06-21 17:14:31.367 INFO 157144 --- [ main] o.a.catalina.core.AprLifecycleListener : Loaded Apache Tomcat Native library [1.2.31] using APR version [1.7.0].
2022-06-21 17:14:31.367 INFO 157144 --- [ main] o.a.catalina.core.AprLifecycleListener : APR capabilities: IPv6 [true], sendfile [true], accept filters [false], random [true], UDS [true].
2022-06-21 17:14:31.367 INFO 157144 --- [ main] o.a.catalina.core.AprLifecycleListener : APR/OpenSSL configuration: useAprConnector [false], useOpenSSL [true]
2022-06-21 17:14:31.370 INFO 157144 --- [ main] o.a.catalina.core.AprLifecycleListener : OpenSSL successfully initialized [OpenSSL 1.1.1l 24 Aug 2021]
2022-06-21 17:14:31.377 INFO 157144 --- [ main] o.apache.catalina.core.StandardService : Starting service [Tomcat]
2022-06-21 17:14:31.377 INFO 157144 --- [ main] org.apache.catalina.core.StandardEngine : Starting Servlet engine: [Apache Tomcat/9.0.63]
2022-06-21 17:14:31.503 INFO 157144 --- [ main] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring embedded WebApplicationContext
2022-06-21 17:14:31.503 INFO 157144 --- [ main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 984 ms
2022-06-21 17:14:31.762 INFO 157144 --- [ main] o.s.b.a.w.s.WelcomePageHandlerMapping : Adding welcome page template: index
2022-06-21 17:14:32.072 INFO 157144 --- [ main] o.s.s.web.DefaultSecurityFilterChain : Will secure any request with [org.springframework.security.web.session.DisableEncodeUrlFilter@24e83d19, org.springframework.security.web.context.request.async.WebAsyncManagerIntegrationFilter@5c080ef3, org.springframework.security.web.context.SecurityContextPersistenceFilter@49ede9c7, org.springframework.security.web.header.HeaderWriterFilter@25d2f66, org.springframework.security.web.authentication.logout.LogoutFilter@a2ddf26, org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter@7979b8b7, org.springframework.security.web.savedrequest.RequestCacheAwareFilter@3dd4a6fa, org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestFilter@29138d3a, org.springframework.security.web.authentication.rememberme.RememberMeAuthenticationFilter@7b6e5c12, org.springframework.security.web.authentication.AnonymousAuthenticationFilter@188cbcde, org.springframework.security.web.session.SessionManagementFilter@71945bc0, org.springframework.security.web.access.ExceptionTranslationFilter@78c1372d, org.springframework.security.web.access.intercept.FilterSecurityInterceptor@49c675f0]
2022-06-21 17:14:32.124 INFO 157144 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ''
2022-06-21 17:14:32.134 INFO 157144 --- [ main] c.example.SpringBootWebTestApplication : Started SpringBootWebTestApplication in 2.053 seconds (JVM running for 3.078)
2022-06-21 17:15:15.891 INFO 157144 --- [nio-8080-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring DispatcherServlet 'dispatcherServlet'
2022-06-21 17:15:15.891 INFO 157144 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet : Initializing Servlet 'dispatcherServlet'
2022-06-21 17:15:15.892 INFO 157144 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet : Completed initialization in 0 ms
我们可以看到,日志中除了最基本的SpringBoot启动日志以外,还新增了内嵌Web服务器(Tomcat)的启动日志,并且显示了当前Web服务器所开放的端口,并且自动帮助我们初始化了DispatcherServlet,但是我们只是创建了项目,导入了web相关的starter依赖,没有进行任何的配置,实际上它使用的是starter提供的默认配置进行初始化的。
由于SpringBoot是自动扫描的,因此我们直接创建一个Controller即可被加载:
@Controller
public class MainController {
@RequestMapping("/index")
@ResponseBody
public String index(){
return "你好,欢迎访问主页!";
}
}
我们几乎没有做任何配置,但是可以直接开始配置Controller,SpringBoot创建一个Web项目的速度就是这么快!
它还可以自动识别类型,如果我们返回的是一个对象类型的数据,那么它会自动转换为JSON数据格式,无需配置:
@Data
public class Student {
int sid;
String name;
String sex;
}
@RequestMapping("/student")
@ResponseBody
public Student student(){
Student student = new Student();
student.setName("小明");
student.setSex("男");
student.setSid(10);
return student;
}
最后浏览器能够直接得到application/json 的响应数据,就是这么方便。
修改Web相关配置
如果我们需要修改Web服务器的端口或是一些其他的内容,我们可以直接在application.properties 中进行修改,它是整个SpringBoot的配置文件:
# 修改端口为8081
server.port=8081
我们还可以编写自定义的配置项,并在我们的项目中通过@Value 直接注入:
test.data=100
@Controller
public class MainController {
@Value("${test.data}")
int data;
通过这种方式,我们就可以更好地将一些需要频繁修改的配置项写在配置文件中,并通过注解方式去获取值。
配置文件除了使用properties 格式以外,还有一种叫做yaml 格式,它的语法如下:
一级目录:
二级目录:
三级目录1: 值
三级目录2: 值
三级目录List:
- 元素1
- 元素2
- 元素3
我们可以看到,每一级目录都是通过缩进(不能使用Tab,只能使用空格)区分,并且键和值之间需要添加冒号+空格来表示。
SpringBoot也支持这种格式的配置文件,我们可以将application.properties 修改为application.yml 或是application.yaml 来使用YAML语法编写配置:
server:
port: 8081
整合SpringSecurity依赖
我们接着来整合一下SpringSecurity依赖,继续感受SpringBoot带来的光速开发体验,只需要导入SpringSecurity的Starter依赖即可:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
</dependency>
导入依赖后,我们直接启动SpringBoot应用程序,可以发现SpringSecurity已经生效了。
并且SpringSecurity会自动为我们生成一个默认用户user ,它的密码会出现在日志中:
2022-06-21 17:20:32.221 INFO 147252 --- [ main] o.apache.catalina.core.StandardService : Starting service [Tomcat]
2022-06-21 17:20:32.221 INFO 147252 --- [ main] org.apache.catalina.core.StandardEngine : Starting Servlet engine: [Apache Tomcat/9.0.56]
2022-06-21 17:20:32.221 INFO 147252 --- [ main] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring embedded WebApplicationContext
2022-06-21 17:20:32.221 INFO 147252 --- [ main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 341 ms
2022-06-21 17:20:32.221 INFO 147252 --- [ main] .s.s.UserDetailsServiceAutoConfiguration :
Using generated security password: ff24bee3-e1b7-4309-9609-d32618baf5cb
其中ff24bee3-e1b7-4309-9609-d32618baf5cb 就是随机生成的一个密码,我们可以使用此用户登录。
我们也可以在配置文件中直接配置:
spring:
security:
user:
name: Harrison
password: 123456
roles:
- user
- admin
实际上这样的配置方式就是一个inMemoryAuthentication ,只是我们可以直接配置而已。
当然,页面的控制和数据库验证我们还是需要提供WebSecurityConfigurerAdapter 的实现类去完成:
@Configuration
public class SecurityConfiguration extends WebSecurityConfigurerAdapter {
@Override
protected void configure(HttpSecurity http) throws Exception {
http
.authorizeRequests()
.antMatchers("/login").permitAll()
.anyRequest().hasRole("user")
.and()
.formLogin();
}
}
注意这里不需要再添加@EnableWebSecurity 了,因为starter依赖已经帮我们添加了。
使用了SpringBoot之后,我们发现,需要什么功能,只需要导入对应的starter依赖即可,甚至都不需要你去进行额外的配置,你只需要关注依赖本身的必要设置即可,大大提高了我们的开发效率。
整合Mybatis框架
我们接着来看如何整合Mybatis框架,同样的,我们只需要导入对应的starter依赖即可:(这里mybatis导入的版本是2.2.0)
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
导入依赖后,直接启动会报错,是因为有必要的配置我们没有去编写,我们需要指定数据源的相关信息:
spring:
datasource:
url: jdbc:mysql://localhost:3306
username: root
password: admin
driver-class-name: com.mysql.cj.jdbc.Driver
再次启动,成功。
我们发现日志中会出现这样一句话:
2022-06-21 17:23:13.234 INFO 156552 --- [ main] o.m.s.mapper.ClassPathMapperScanner : No MyBatis mapper was found in '[com.example]' package. Please check your configuration.
这是Mybatis自动扫描输出的语句,导入依赖后,我们不需要再去设置Mybatis的相关Bean了,也不需要添加任何@MapperSacn 注解,因为starter已经帮助我们做了,它会自动扫描项目中添加了@Mapper 注解的接口,直接将其注册为Bean,不需要进行任何配置。
@Mapper
public interface MainMapper {
@Select("select * from users where username = #{username}")
UserData findUserByName(String username);
}
当然,如果你觉得每个接口都去加一个@Mapper 比较麻烦的话也可以用回之前的方式,直接@MapperScan 使用包扫描。
添加Mapper之后,使用方法和SSM阶段是一样的,我们可以将其与SpringSecurity结合使用:
@Service
public class UserAuthService implements UserDetailsService {
@Resource
MainMapper mapper;
@Override
public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {
UserData data = mapper.findUserByName(username);
if(data == null) throw new UsernameNotFoundException("用户 "+username+" 登录失败,用户名不存在!");
return User
.withUsername(data.getUsername())
.password(data.getPassword())
.roles(data.getRole())
.build();
}
}
最后配置一下自定义验证即可,注意这样之前配置文件里面配置的用户就失效了:
@Override
protected void configure(AuthenticationManagerBuilder auth) throws Exception {
auth
.userDetailsService(service)
.passwordEncoder(new BCryptPasswordEncoder());
}
但是会出现问题:Encoded password does not look like BCrypt 解决办法:在service中修改成这个格式 .password(new BCryptPasswordEncoder().encode(data.getPassword())),原因应该是保持统一格式才能解析比对。
在首次使用时,我们发现日志中输出以以下语句:
2022-06-21 17:27:01.100 INFO 162768 --- [nio-8080-exec-3] com.zaxxer.hikari.HikariDataSource : HikariPool-1 - Starting...
2022-06-21 17:27:01.100 INFO 162768 --- [nio-8080-exec-3] com.zaxxer.hikari.HikariDataSource : HikariPool-1 - Start completed.
实际上,SpringBoot会自动为Mybatis配置数据源,默认使用的就是HikariCP 数据源。
整合Thymeleaf框架
整合Thymeleaf也只需导入对应的starter即可:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
接着我们只需要直接使用即可:
@RequestMapping("/index")
public String index(){
return "index";
}
但是注意,这样只能正常解析HTML页面,但是js、css等静态资源我们需要进行路径指定,不然无法访问,我们在配文件中配置一下静态资源的访问前缀:
spring:
mvc:
static-path-pattern: /static/**
接着我们像之前一样,把登陆页面实现一下吧。
<html lang="en" xmlns:th=http://www.thymeleaf.org
xmlns:sec=http://www.thymeleaf.org/extras/spring-security>
|