springBoot整合Web开发
1.1 返回JSON数据
1.1.1 使用springBoot自带的JSON转换器jackson-databind
在引入web依赖的时候,会默认引入一个叫做jackson-databind的依赖
首先,创建一个实体类Book
public class Book {
private String name;
private String author;
@JsonIgnore
private Float price;
@JsonFormat(pattern = "yyyy-MM-dd")
private Date publicationDate;
}
其次,创建一个Controller
@RestController
public class HelloController {
@GetMapping("/book")
@ResponseBody
public Book book(){
Book book=new Book();
book.setName("三国演义");
book.setAuthor("罗贯中");
book.setPrice(23f);
book.setPublicationDate(new Date());
return book;
}
}
@ResponseBody这个注解可以帮助后端直接向前端输出数据,也就是直接将返回的数据输出在前端
其中如果多次使用@ResponseBody两个注解,可以将@Controller写成@RestController,这样,下面就不需要多次写@ResponseBody
这个实体类可以写成json格式的类型
1.1.2 自定义JSON转换器
我们可能不一定使用springBoot自带的转换器,比如Gson和fastjson,在使用时,需要下面两个步骤
-
删除jackson-databind转换器的依赖
<exclusion> <groupId>com.fasterxml.jackson.core</groupId> <artifactid>jackson-databind</artifactid> </exclusion>
-
引入对应转换器的依赖
<dependency> <groupId>com.google.code.gson</groupId> <artifactId>gson</artifactId> </dependency>
然后就可以按照对应转换器的格式写对应的返回的数据了
1.2 静态资源访问
1.2.1 默认静态资源的访问
springBoot对静态资源的配置是在WebMvcAutoConfiguration类中
其中定义了四个静态资源的存放路径
- classpath:/META-INF/resources/
- classpath:/resources/
- classpath:/static/
- classpath:/public/
优先级依次降低
在这些文件夹中的资源,直接使用localhost:8080/xxx.xxx即可访问
注意,这四个地方是可以直接访问的,不需要加上前面的包名
1.2.2 自定义静态资源的访问
- 在application.properties中配置
spring.mvc.static-path-pattern=/static/**
这个定义了访问路径是classpath:/static/
spring.resources.static-location=classpath:/static/
这个定义了访问的过滤规则
访问时,这里可以直接使用localhost:8080/xxx.xxx来访问静态资源
也就是说,如果过滤规则和对应的访问路径中的值是一样的时候,可以不加上包名而直接访问
初步理解是这样的,访问路径是指项目可以访问到的静态资源存放路径,访问的过滤规则是指访问静态资源时默认添加上对应的前缀。
- 使用java配置
定义一个类,实现WebMvcConfigurer接口
实现接口中的addResourceHandlers方法
代码如下
public class TheStatic implements WebMvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/aaa/**") .addResourceLocations("classpath:/aaa/");
}
}
1.3 文件上传
文件上传一般分为两种方式
- 使用commons-fileupload来处理,也就是CommonsMutipartResolver这个组件来处理,这种是最早的文件上传方式,需要jar的支持
- 使用servlet3.0之后推出的一个文件上传组件StandardServletMultipartResolver,这个组件可以实现文件上传,而不依赖别的jar,也就是servlet内置的文件上传方式
我们使用的springBoot2.0.4,使用的是tomcat8.5.32,这个版本有对应的文件上传功能
1.3.1 单文件上传
需要web依赖
前端代码固定写法
<form action="/upload" method="post" enctype="multipart/form-data">
<input type="file" name="uploadFile" value="请选择文件">
<input type="submit" value="上传">
</form>
上传接口是"/upload",请求方式是post请求,name是uploadFile
下面是一个固定的上传处理接口(待用)
package com.ymy.controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.http.HttpServletRequest;
import java.io.File;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.UUID;
@RestController
public class FileUploadController {
SimpleDateFormat sdf = new SimpleDateFormat("yyyy/MM/dd/");
@PostMapping("/upload")
public String upload(MultipartFile uploadFile, HttpServletRequest request) {
String realPath =
request.getSession()
.getServletContext().getRealPath("/uploadFile/");
String format = sdf.format(new Date());
File folder = new File(realPath + format);
if (!folder.isDirectory()) {
folder.mkdirs();
}
String oldName = uploadFile.getOriginalFilename();
String newName = UUID.randomUUID()
.toString() + oldName
.substring(oldName.lastIndexOf("."), oldName.length());
try {
uploadFile.transferTo(new File(folder, newName));
String filePath = request.getScheme() + "://" + request.getServerName()
+ ":" + request.getServerPort() + "/uploadFile" + format + newName;
return filePath;
} catch (IOException e) {
e.printStackTrace();
}
return "上传失败";
}
}
具体实现,再学习
关于上传配置,可以在properties中配置
spring.servlet.multipart.enable=true
是否开启上传功能,默认值是true
spring.servlet.multipart.file-size-threshold=0
写入磁盘的阀值,是为了区分两种上传方式
spring.servlet.multipart.location=E:\\temp
上传文件的临时保存位置
spring.servlet.multipart.max-file-size=1MB
单个文件的最大大小
spring.servlet.mutilpart.max-request-size=10MB
多个文件的上传总大小
spring.servlet.multipart.resolve-lazily=false
是否延迟解析,默认值是false
1.4 @ControllerAdvice
三个使用方法
- 全局异常处理,搭配@ExceptionHandler
比如上传文件失败,可以通过这个返回一段json做文件上传失败的提示 - 添加全局数据,搭配@ModelAttribute
将需要的数据添加到Model中,这样在任何一个Controller中都可以获取这个数据 - 请求参数预处理,搭配@InitBinder
就是对从前台获取的数据进行预处理,然后再封装给实体类
具体使用的时候再进行查看,使用场景不多
1.5 自定义错误页
针对一些容器级别的错误就不能使用删除的全局异常处理,所以这个时候就可以返回一个html页面或JSON格式的字符串(对于AJAX的请求,必定返回JSON格式字符串)
在BasicErrorController类中的两个方法errorHtml()返回一个html页面
error()返回一个JSON数据
错误处理机制是,error方法遇到错误时会到error目录下查找4xx,5xx的文件作为错误视图,如果找不到就返回到errorHtml()方法,然后使用error作为错误页面视图,如果这个视图也找不到,就会返回springBoot自定义的404和500的错误页
使用:
在resource->static->error建立两个文件404.html和500.html
然后再出现错误,就会自定义到这个页面
如果需要在错误页面显示一些错误信息,就需要使用到thymeleaf模板
实例如下
在classpath:templates目录下建立error目录,在该目录下创建两个html,404和500
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<table border="1">
<tr>
<td>timestamp</td>
<td th:text="${timestamp}"></td>
</tr>
<tr>
<td>status</td>
<td th:text="${status}"></td>
</tr>
<tr>
<td>error</td>
<td th:text="${error}"></td>
</tr>
<tr>
<td>message</td>
<td th:text="${meaage}"></td>
</tr>
<tr>
<td>path</td>
<td th:text="${path}"></td>
</tr>
</table>
</body>
</html>
至于一些复杂配置,可以需要的时候再学习
1.6 springBoot配置CORS实现跨域
- 需要web依赖
- 需要配置跨域请求,两种方式,一种是在配置类中配置,一种是在Controller中使用@CrossOrigin
在vue中,可以使用8081端口打开
后端的信息,使用8080端口打开
前端请求时,访问端口就是localhost:8080/xxx/xxx
后端配置的信息,允许8081的请求
例如:
前端,访问端口localhost:8081/index.html
$.ajax({
url:'http://localhost8080/book/99',
type:'delete',
success:function(msg){
alert(msg)
}
})
后端,端口8080
两种配置方式
@Configuration
public class MyWebMvcConfig implements WebMvcConfigurer {
@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping("/book/**")//请求信息
.allowedHeaders("*")//请求头
.allowedMethods("*")//请求方法
.maxAge(1800).allowedOrigins("http://localhost:8081");
//最大时间和允许哪些域的访问
}
}
@PostMapping("/")
@CrossOrigin(value = "http://localhost:8081", maxAge = 1800, allowedHeaders = "*")
public String addBook(String name) { return "receive:" + name;}
//CrossOrigin中的value是指允许访问的主机,最大时间数,允许的头部信息
1.7 配置类和XML配置
springBoot推荐使用配置类的方式进行配置,但是如果需要使用XML配置,可以使用如下方式
- 在resource下创建xml文件
- 在配置类中使用@ImportResource引入对应的xml文件(@ImportResource("classpath:xxx.xml"))
1.8 配置注册拦截器
分为两个部分
- 创建拦截器
- 配置拦截器
第一步:
创建拦截器:
创建一个类,实现HandlerInterceptor接口
实现其中的三个方法
第一个preHandle,最初执行的
第二个postHandle,这个方法要求所有的拦截器的preHandle执行成功之后才会执行。
第三个afterCompletion,这个要求preHandle执行返回true才会执行
执行流程,有a拦截器和b拦截器
两个都在拦截链中,则执行顺序,a.pre->a.after->b.pre->a.post->b.post->b.after
第二步:
配置拦截器,即拦截哪些,哪些不拦截
在配置类中实现WebMvcConfigurer接口,实现addInterceptors方法
在方法中使用registry.addInterceptor(拦截器对象).addPathPatterns("/").excludePathPatterns("/hello");
addPathPatterns是指拦截哪些请求,这里/指的是,所有包下的所有请求
excludePathPatterns,指的是排除哪些请求
高级用法,在配置拦截器的时候,可以使用内部类的形式,直接将该拦截器需要实现的方法在注册拦截器中写上,这个难度有点高
1.9 启动系统任务
待续,,,
1.10 整合Servlet,Filter,Listener
springBoot的web依赖中有这些,可以直接使用注解的方式开发
具体实施步骤不再论述
1.11 路径映射
针对的是那些不需要数据显示的页面,直接使用路径跳转,也就是说,不允许用户直接访问某个页面,使用url的情况下,在配置类中配置信息,使能够完成非数据的页面跳转,减少Controller的使用,从而提升速度
registry.addViewController("/xxx").setViewName("xxx");
前面的参数是请求参数,后面的参数是重定向参数
1.12 配置AOP
AOP(面向切面编程),这个是个大东西,以后需要再自主学习
1.13 其他
1.13.1 自定义欢迎页
springBoot项目启动之后
会去静态文件夹(是个静态资源访问路径)下找index.html
如果找不到,就到动态文件夹下找(templates)index.html
找到之后会自动创建一个Controller,直接(“/”)定向到对应的页面
这样就不需要写上对应的页面名,就可以直接访问
1.13.2 自定义favicon
所谓facivon,就是网页的左上角显示的那个图标
图标可以在下面的地址创建
favicon
将创建好的后缀名为".ico"的文件(名称需要是favicon.ico)放在静态资源文件夹(四个)下即可
不再实验
1.13.3 去除某个自动配置
在启动类上面加上@EnableAutoConfiguration(exclude={xxx.class})
这样就可以取消名为xxx.class的自动配置类
注:学习自松哥的springBoot+Vue