文章目录
- 一、springboot过滤器基础入门&实战
- 1.1、过滤器
- 1.2、创建项目
- 1.3、Filter 快速入门
- 1.3.1、@WebFilter 实现
- 1.3.2、FilterRegistrationBean 实现
- 1.4、过滤校验用户是否登录
- 二、SpringBoot 拦截器基础入门&实战
- 2.1、拦截器
- 2.2、拦截器快速入门
- 2.3、拦截校验用户是否登录实战
- 三、Spring Boot 静态资源访问
- 四、Spring Boot 整合 Jsp
- 五、Spring Boot 整合 Thymeleaf
- 六、Spring Boot 整合 Freemarker
一、springboot过滤器基础入门&实战
1.1、过滤器
什么是过滤器
它是基于Servlet 技术实现的, 简单的来说,过滤器就是起到过滤的作用,在web项目开发中帮我们过滤一些指定的 url做一些特殊的处理
代码语言:javascript复制过滤器主要实现什么
1.过滤掉一些不需要的东西,例如一些错误的请求。
2.也可以修改请求和相应的内容。
3.也可以拿来过滤未登录用户
过滤器代码实现
过滤器(filter)有三个方法,其中初始化(init)和摧毁(destroy)方法一般不会用到,主要用到的是doFilter这个方法。
过滤器实现流程
如果过滤通过,则在doFilter执行filterChain.doFilter(request,response); 。
1.2、创建项目
1.3、Filter 快速入门
如何在springBoot中如何使用过滤器?
自定义Filter有两种实现方式,第一种是使用**@WebFilter**注解方式,第二种是使用 FilterRegistrationBean(配置类方式)
1.3.1、@WebFilter 实现
@WebFilter 用于将一个类声明为过滤器,该注解将会在部署时被容器处理,容器将根据具体的属性配置将相应的类部署为过滤器。
属性名 | 类型 | 描述 |
---|---|---|
filterName | String | 指定该Filter的名称 |
urlPatterns | String | 指定该Filter所拦截的URL |
value | String | 与urlPatterns一致 |
- 创建一个MyFilter.java实现Filter接口
package com;
import org.springframework.stereotype.Component;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
@WebFilter(urlPatterns = "/api/*",filterName = "myFilter")
@Order(1)//指定过滤器的执行顺序,值越大越靠后执行
public class MyFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("初始化过滤器");
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse,
FilterChain filterChain) throws IOException, ServletException {
HttpServletRequest request= (HttpServletRequest) servletRequest;
String uri=request.getRequestURI();
String method=request.getMethod();
System.out.println(uri " " method "哈哈我进入了 MyFilter 过滤器了");
filterChain.doFilter(servletRequest,servletResponse);
}
}
- 启动类上加 **@ServletComponentScan **注解
- 创建一个 FilterController 接口
package com.controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/api")
public class HelloController {
@GetMapping("/user/filter")
public String hello(){
return "哈哈我通过了过滤器";
}
}
- 测试
1.3.2、FilterRegistrationBean 实现
- 创建 FilterConfig
package com.config;
import com.MyFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class FilterConfig {
@Bean
public MyFilter myFilter(){
return new MyFilter();
}
@Bean
public FilterRegistrationBean getFilterRegistrationBean(MyFilter myFilter){
FilterRegistrationBean filterRegistrationBean=new FilterRegistrationBean();
/**
* 设置过滤器
*/
filterRegistrationBean.setFilter(MyFilter());
/**
* 拦截路径
*/
filterRegistrationBean.addUrlPatterns("/api/*");
/**
* 设置拦截资源名称
*/
filterRegistrationBean.setName("myFilter");
/**
* 设置访问优先级 值越小越高
*/
filterRegistrationBean.setOrder(1);
return filterRegistrationBean;
}
}
- 去掉MyFilter类中的注解
//@WebFilter(urlPatterns ={"/api/*"},filterName = "myFilter")
- 去掉启动类的注解
//@ServletComponentScan
- 测试
1.4、过滤校验用户是否登录
- 修改 application.properties 加入开发接口通配地址
#配置开放资源,凡是请求地址层级带有 open 都放行
open.url=/**/open/**
- 修改MyFilter
//@WebFilter(urlPatterns ={"/*"},filterName = "myFilter")
public class MyFilter implements Filter {
@Value("${open.url}")//拿到配置类的开放资源的路径
private String openUrl;
@Override
public void init(FilterConfig filterConfig) {
System.out.println("初始化 myFilter 过滤器");
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse,
FilterChain filterChain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) servletRequest;
String requestUrl = request.getRequestURI();
System.out.println("过滤器MyFilter拦截了请求为" requestUrl);
//首先校验是否是开放 api
//是直接放行,否再校验token
PathMatcher matcher = new AntPathMatcher();
if(matcher.match(openUrl,requestUrl)){
filterChain.doFilter(servletRequest,servletResponse);
}else {
String token=request.getHeader("token");
if(StringUtils.isEmpty(token)){
servletRequest.getRequestDispatcher("/api/open/unLogin").forward(servletRequest,
servletResponse);
}else {
filterChain.doFilter(servletRequest,servletResponse);
}
}
}
}
- 编写Controller
@GetMapping("/open/home/info")
public Map<String,String> getHome(){
Map<String,String> map=new HashMap<>();
map.put("游客","欢迎访问首页");
return map;
}
@GetMapping("/open/unLogin")
public String getUnauthorized(){
return "登录失效,请重新登录";
}
- 测试
二、SpringBoot 拦截器基础入门&实战
2.1、拦截器
拦截器是什么
简单的来说,就是一道阀门,在某个方法被访问之前,进行拦截,然后在之前或之后加入某些操作,拦截器是AOP 的一种实现策略。
拦截器的作用
对正在运行的流程进行干预
拦截器的实现
拦截器也主要有三个方法: 其中preHandle是在请求之前就进行调用,如果该请求需要被拦截,则返回false,否则true; postHandle是在请求之后进行调用,无返回值; afterCompletion是在请求结束的时候进行调用,无返回值。
2.2、拦截器快速入门
总体步骤
创建一个类实现 HandlerInterceptor 接口,再创建一个配置类实现 WebMvcConfigurer接口 ,重写 addInterceptors 方法
- 创建拦截器并并实现 HandlerInterceptor 接口
package com.interceptor;
import org.springframework.beans.factory.annotation
import org.springframework.util.AntPathMatcher;
import org.springframework.util.PathMatcher;
import org.springframework.web.servlet.HandlerInterceptor
import org.springframework.web.servlet.ModelAndView
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class MyInterceptor implements HandlerInterceptor {
@Value("${open.url}")
private String openUrl;
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object
handler) throws Exception {
System.out.println("MyInterceptor....在请求处理之前进行调用(Controller方法调用之前)");
String requestUrl=request.getRequestURI();
System.out.println("过滤器MyFilter拦截了请求为" requestUrl);
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object
handler, ModelAndView modelAndView) throws Exception {
System.out.println("MyInterceptor...请求处理之后进行调用,但是在视图被渲染之前(Controller方法调用之
后)");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object
handler, Exception ex) throws Exception {
System.out.println("MyInterceptor....在整个请求结束之后被调用,也就是在DispatcherServlet 渲染了对
应的视图之后执行(主要是用于进行资源清理工作)");
}
}
- 修改 application.properties 加入开放资源
#凡是请求地址层级带有 open 都放行
open.url=/**/open/**
- 创建一个 Java 实现 WebMvcConfigurer ,并重写 addInterceptors 方法
package com.config;
import com.interceptor.MyInterceptor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class WebAppConfig implements WebMvcConfigurer {
@Value("${open.url}")
private String openUrl;
@Bean
public MyInterceptor getMyInterceptor(){
return new MyInterceptor();
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(getMyInterceptor()).addPathPatterns("/api/**").excludePathPatterns(openUrl);//增加拦截和不拦截路径
}
}
- 编写Controller
package com.controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.HashMap;
import java.util.Map;
@RestController
@RequestMapping("/api")
public class InterceptorController {
@GetMapping("/home/open/info")
public String home(){
return "欢迎来到首页";
}
@GetMapping("/user/interceptor")
public String interceptor(){
return "我被拦截了并通过了拦截器";
}
}
- 测试
带有open的(http://localhost:8080/api/open/home/info) 不拦截
2.3、拦截校验用户是否登录实战
- 编写Controller
@GetMapping("/user/filter")
public String testFilter(){
return "已经通过了拦截器";
}
@GetMapping("/open/unLogin")
public String getUnauthorized(){
return "登录失效,请重新登录";
}
- 编写拦截器校验逻辑
public class MyInterceptor implements HandlerInterceptor {
@Value("${open.url}")
private String openUrl;
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object
handler) throws Exception {
System.out.println("MyInterceptor....在请求处理之前进行调用(Controller方法调用之前)");
System.out.println("MyInterceptor 拦截了请求为" requestUrl);
String requestUrl=request.getRequestURI();
System.out.println(requestUrl "被 MyInterceptor 拦截了");
//判断是否携带凭证就可以了
String token = request.getHeader("token");
if(StringUtils.isEmpty(token)){
request.getRequestDispatcher("/api/open/unLogin").forward(request,response);
return false;
}
return true;
}
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object
handler, ModelAndView modelAndView) throws Exception {
System.out.println("MyInterceptor...请求处理之后进行调用,但是在视图被渲染之前(Controller方法调用之
后)");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object
handler, Exception ex) throws Exception {
System.out.println("MyInterceptor....在整个请求结束之后被调用,也就是在DispatcherServlet 渲染了对
应的视图之后执行(主要是用于进行资源清理工作)");
}
}
- 测试
三、Spring Boot 静态资源访问
- 源码分析
我们打开 ResourceProperties 资源配置类,发现默认的静态资源路径为以下几个,只要静态资源放在这些目录中任何一个,SpringMVC都会帮我们处理。 我们习惯会把静态资源放在classpath:/static/ 目录下
- classpath:/META-INF/resources/
- classpath:/resources/
- classpath:/static/
- classpath:/public
- 测试
把图片放到static目录下重启即可
四、Spring Boot 整合 Jsp
提起 Java 不得不说的一个开发场景就是 Web 开发,说到 Web 开发绕不开的一个技术就是 JSP,因为目前市面上仍有很多的公司在使 用 SSM JSP,然后又想升级 Spring Boot。这节课程主要讲如何在 SpringBoot 项目使用 JSP
- 新建项目,并创建webapp
- 引入jsp相关依赖
javax.servlet
jstl
org.apache.tomcat.embed
tomcat-embed-jasper
- web 配置
编辑 project Structure
配置根路径
**点击apply **
- Spring Mvc 视图解析器配置
spring.mvc.view.prefix=/WEB-INF/jsp/
spring.mvc.view.suffix=.jsp
server.port=8080
- 测试
- 结语
所以我们在以后遇到,老旧的项目升级成Spring Boot 项目时候,首先得配置好 webapp 这个跟路径、配置好 web、再配置 ORM 所 需的一些配置,最后记得配置视图解析器。所需的配置配置好后就可以直接把代码拷入新的项目了。
五、Spring Boot 整合 Thymeleaf
Thymeleaf是一款用于渲染XML/XHTML/HTML5内容的模板引擎。类似JSP,FreeMaker等, 它也可以轻易的与 Web 框架进行集成作 为 Web 应用的模板引擎。与其它模板引擎相比, Thymeleaf 最大的特点是能够直接在浏览器中打开并正确显示模板页面,而不需要 启动整个Web应用。thymeLeaf支持Spring Expression Language语言作为方言,也就是SpEL,SpEL是可以用于Spring中的一种EL表达式。它与我们使用 过的JSP不同,thymeleaf是使用html的标签来完成逻辑和数据的传入进行渲染。可以说用 thymeleaf 完全替代 jsp 是可行的。
- 创建一个springboot项目
- Thymeleaf 配置
#thymeleaf
# 前缀 默认读取classpath:/templates/
#无需配置
#spring.thymeleaf.prefix=classpath:/templates/
# 后缀
spring.thymeleaf.suffix=.html
spring.thymeleaf.charset=UTF-8
spring.thymeleaf.servlet.content-type=text/html
- 测试
创建 hello.html,在templates下创建一个hello.html 必须加入xmlns:th=“http://www.thymeleaf.org” Thymeleaf声明空间
代码语言:javascript复制<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Titletitle>
head>
<body>
<p th:text="'hello:' ${username}">p>
body>
html>
创建 HelloController
代码语言:javascript复制package com.controller;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class HelloController {
@GetMapping("/hello")
public String hello(Model model){
model.addAttribute("username","zhangsan");
return "hello";
}
}
- 测试
六、Spring Boot 整合 Freemarker
- 创建项目
- Freemarker 配置
#freemarker
spring.freemarker.template-loader-path=classpath:/templates/
# 后缀
spring.freemarker.suffix=.html
spring.freemarker.charset=UTF-8
spring.freemarker.content-type=text/html
- 测试
创建 hello.html
代码语言:javascript复制<html lang="en">
<head>
<meta charset="UTF-8">
<title>Titletitle>
head>
<body>
<h1>${username}h1>欢迎使用Freemarker模板
body>
html>
创建 HelloController
代码语言:javascript复制package com.controller;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class HelloController {
@GetMapping("/hello")
public String hello(Model model){
model.addAttribute("username","张三");
return "hello";
}
}
- 测试
浏览器输入: http://localhost:8080/hello