商业类网站,wordpress博客怎么写,wordpress站点切换为中文,沧州有没有做网站的前一节已经实现了部门管理、员工管理的基本功能。但并没有登录#xff0c;就直接访问到了Tlias智能学习辅助系统的后台#xff0c;这节来实现登录认证。 目录 登录功能登录校验(重点)会话技术会话跟踪方案一 Cookie#xff08;客户端会话跟踪技术#xff09;会话跟踪方案二…前一节已经实现了部门管理、员工管理的基本功能。但并没有登录就直接访问到了Tlias智能学习辅助系统的后台这节来实现登录认证。 目录 登录功能登录校验(重点)会话技术会话跟踪方案一 Cookie客户端会话跟踪技术会话跟踪方案二 Session服务端会话跟踪技术会话跟踪方案三 令牌技术推荐 JWT令牌生成和校验案例集成JWT 过滤器FilterFilter详解案例集成Filter 拦截器Interceptor拦截器Interceptor详解案例集成拦截器Interceptor 异常处理全局异常处理器 登录功能
基本信息
请求路径/login
请求方式POST
接口描述该接口用于员工登录Tlias智能学习辅助系统。请求参数样例
{username: jinyong,password: 123456
}LoginController
RestController
public class LoginController {Autowiredprivate EmpService empService;PostMapping(/login)public Result login(RequestBody Emp emp){Emp e empService.login(emp);return e ! null ? Result.success():Result.error(用户名或密码错误);}
}EmpServiceImpl Overridepublic Emp login(Emp emp) {//调用dao层功能登录Emp loginEmp empMapper.getByUsernameAndPassword(emp);//返回查询结果给Controllerreturn loginEmp;}EmpMapper //用户登录账号密码查询Select(select * from emp where username#{username} and password#{password})Emp getByUsernameAndPassword(Emp emp);postman测试 前端测试先退出登录进入到登录界面输入正确账号密码成功进入后台输入错误提示账号或密码错误。 登录校验(重点)
但是当我们在浏览器中新的页面上输入地址localhost:90/#/system/dept发现没有登录仍然可以进入到后端管理系统页面。 我们在服务器端并没有做任何的判断没有去判断用户是否登录了。所以无论用户是否登录都可以访问部门管理以及员工管理的相关数据。
真正的登录功能应该是登陆后才能访问后端系统页面不登陆则跳转登陆页面进行登陆。我们需要完成一步非常重要的操作登录校验。
前面在讲解HTTP协议的时候我们提到HTTP协议是无状态协议。无状态指的是每一次请求都是独立的下一次请求并不会携带上一次请求的数据。
而浏览器与服务器之间进行交互基于HTTP协议也就意味着现在我们通过浏览器来访问了登陆这个接口实现了登陆的操作接下来我们在执行其他业务操作时服务器也并不知道这个员工到底登陆了没有。因为HTTP协议是无状态的两次请求之间是独立的所以是无法判断这个员工到底登陆了没有。
具体登录校验的实现思路可以分为两部分
1. 在员工登录成功后需要将用户登录成功的信息存起来记录用户已经登录成功的标记。
2. 在浏览器发起请求时需要在服务端进行统一拦截拦截后进行登录校验。我们要完成以上操作会涉及到web开发中的两个技术
1. 会话技术
2. 统一拦截技术而统一拦截技术现实方案也有两种
1. Servlet规范中的Filter过滤器
2. Spring提供的interceptor拦截器会话技术
在web开发当中会话指的就是浏览器与服务器之间的一次连接我们就称为一次会话。
比如打开了浏览器来访问web服务器上的资源浏览器不能关闭、服务器不能断开 第1次访问的是登录的接口完成登录操作 第2次访问的是部门管理接口查询所有部门数据 第3次访问的是员工管理接口查询员工数据 只要浏览器和服务器都没有关闭以上3次请求都属于一次会话当中完成的。
当有三个浏览器客户端和服务器建立了连接时就会有三个会话。同一个浏览器在未关闭之前请求了多次服务器这多次请求是属于同一个会话。
会话跟踪一种维护浏览器状态的方法服务器需要识别多次请求是否来自于同一浏览器以便在同一次会话的多次请求间共享数据。
我们使用会话跟踪技术就是要完成在同一个会话中多个请求之间进行共享数据。 为什么要共享数据呢 由于HTTP是无状态协议在后面请求中怎么拿到前一次请求生成的数据呢此时就需要在一次会话的多次请求之间进行数据共享
会话跟踪技术有三种
Cookie客户端会话跟踪技术 数据存储在客户端浏览器当中Session服务端会话跟踪技术 数据存储在储在服务端令牌技术 会话跟踪方案一 Cookie客户端会话跟踪技术
我们使用 cookie 来跟踪会话数据存储在客户端浏览器当中。可以在浏览器第一次发起请求来请求服务器的时候我们在服务器端来设置一个cookie。
比如第一次请求了登录接口在服务端登录接口执行完成之后可以设置一个cookie在 cookie 当中就可以来存储用户相关的一些数据信息。比如可以在 cookie 当中来存储当前登录用户的用户名用户的ID。然后服务器端在给客户端在响应数据的时候会自动的将 cookie 响应给浏览器浏览器接收到响应回来的 cookie 之后会自动的将 cookie 的值存储在浏览器本地。接下来在后续的每一次请求当中都会自动的将浏览器本地所存储的 cookie 自动地携带到服务端。服务端获取到 cookie 的值后便可以去判断一下这个 cookie 的值是否存在如果不存在这个cookie就说明客户端之前是没有访问登录接口的如果存在 cookie 的值就说明客户端之前已经登录完成了。这样我们就可以基于 cookie 在同一次会话的不同请求之间来共享数据。
上面三个有自动为什么为什么这一切都是自动化进行的是因为 cookie 是 HTTP 协议当中所支持的技术HTTP协议给我们提供了一个响应头和请求头
响应头 Set-Cookie 设置Cookie数据的被用于从服务器向浏览器发送Cookie请求头 Cookie携带Cookie数据的存储先前从服务器发送来的Cookie 代码测试
public class SessionController {//设置Cookie,即服务器给浏览器响应的CookieGetMapping(/c1)public Result cookie1(HttpServletResponse response){//直接在形参里获取到响应对象responseresponse.addCookie(new Cookie(login_username,itheima));//设置Cookie/响应Cookie//俩个参数 一个是cookie的名字 另一个是其参数valuereturn Result.success();}//获取Cookie,获取浏览器在请求头中给服务端携带的Cookie数据GetMapping(/c2)public Result cookie2(HttpServletRequest request){//直接在形参里获取到请求对象requestCookie[] cookies request.getCookies();//获取所有的Cookiefor (Cookie cookie : cookies) {if(cookie.getName().equals(login_username)){//我们只想获取名为login_username的cookieSystem.out.println(login_username: cookie.getValue()); //输出name为login_username的cookie}}return Result.success();}
}A.浏览器访问c1接口设置Cookie 可以看到设置的cookie通过响应头Set-Cookie响应给浏览器并且浏览器拿到响应数据后 会自动的解析响应头如果有Set-Cookie就会自动将其存储在浏览器端 B. 浏览器访问c2接口此时浏览器会自动的将刚刚接收并保存的Cookie携带到服务端是通过请求头Cookie携带的 Cookie优缺点
优点HTTP协议中支持的技术像Set-Cookie 响应头的解析以及 Cookie 请求头数据的携
带都是浏览器自动进行的是无需我们手动操作的缺点
移动端APP(Android、IOS)中无法使用Cookie
存储在浏览器不安全且用户可以自己禁用Cookie禁用后则无法使用
Cookie不能跨域跨域介绍 现在的项目大部分都是前后端分离的前后端最终也会分开部署假如前端部署在服务器 192.168.150.200 上端口 80后端部署在 192.168.150.100上端口 8080我们打开浏览器直接访问前端工程访问urlhttp://192.168.150.200/login.html(http默认访问80端口所以不用指定端口)然后在该页面发起请求到服务端而服务端所在地址不再是localhost而是服务器的IP地址192.168.150.100假设访问接口地址为http://192.168.150.100:8080/login那此时就存在跨域操作了因为我们是在 http://192.168.150.200/login.html 这个页面上访问了http://192.168.150.100:8080/login 接口此时如果服务器设置了一个Cookie这个Cookie是不能使用的因为Cookie无法跨域 区分跨域的维度 协议IP/协议端口 只要上述的三个维度有任何一个维度不同那就是跨域操作 会话跟踪方案二 Session服务端会话跟踪技术
我们使用 Session 来跟踪会话数据存储在服务器端当中。Session 的底层其实就是基于 Cookie 来实现的。 获取Session 浏览器在第一次请求服务器的时候可以直接在服务器当中来获取到会话对象Session。如果是第一次请求Session 会话对象是不存在的这个时候服务器会自动的创建一个会话对象Session 。而每一个会话对象Session 它都有一个ID示意图中Session后面括号中的1。 响应Cookie (JSESSIONID) 服务器端在给浏览器响应数据的时候它会将 Session 的 ID 通过 Cookie 响应给 浏览器。JSESSIONID 代表的服务器端会话对象Session 的 ID。浏览器会自动识别这个响应头然后自动将Cookie存储在浏览器本地。 查找Session 在后续的每一次请求当中浏览器都会将 Cookie 的数据获取出来并且携带到服务端。接下来服务器拿到JSESSIONID这个 Cookie 的值也就是 Session 的ID。拿到 ID 之后就会从众多的 Session 当中来找到当前请求对应的会话对象Session。这样就可以通过 Session 会话对象在同一次会话的多次请求之间来共享数据了。
代码测试 GetMapping(/s1)public Result session1(HttpSession session){//直接在形参里获取到会话对象session//服务器会判断这次请求对应的会话对象session是否存在 不存在则会新创建一个session 存在则获取当前这一次请求对应的sessionlog.info(HttpSession-s1: {}, session.hashCode());session.setAttribute(loginUser, tom); //往session中存储数据return Result.success();}GetMapping(/s2)public Result session2(HttpServletRequest request){//也可以通过request获取当前对话sessionHttpSession session request.getSession();log.info(HttpSession-s2: {}, session.hashCode());Object loginUser session.getAttribute(loginUser); //从session中获取数据log.info(loginUser: {}, loginUser);return Result.success(loginUser);}A.访问s1接口localhost:8080/s1 请求完成之后在响应头中就会看到有一个Set-Cookie的响应头里面响应回来了一个Cookie就是JSESSIONID这个就是服务端会话对象 Session 的ID。 并且浏览器拿到响应数据后 会自动的将Cookie存储在浏览器端 B.访问 s2 接口 localhost:8080/s2 在后续的每次请求时都会将Cookie的值携带到服务端那服务端呢接收到Cookie之后会自动的根据JSESSIONID的值找到对应的会话对象Session。
经过这两步测试在控制台中输出如下日志 两次请求获取到的Session会话对象的hashcode是一样的就说明是同一个会话对象。且在同一个会话的多次请求之间来进行数据共享了。
Session优缺点
- 优点Session是存储在服务端的安全
- 缺点- 服务器集群环境下无法直接使用Session- 移动端APP(Android、IOS)中无法使用Cookie- 用户可以自己禁用Cookie- Cookie不能跨域因为Session 底层是基于Cookie实现的会话跟踪如果Cookie不可用则该方案也就失效了。 服务器集群环境为何无法使用Session 现在所开发的项目一般都不会只部署在一台服务器上因为一台服务器会单点故障问题。所谓单点故障指的就是一旦这台服务器挂了整个应用都没法访问了。 所以在现在的企业项目开发当中最终部署的时候都是以集群的形式来进行部署也就是同一个项目它会部署多份。 而用户在访问的时候先会访问一台前置的服务器叫负载均衡服务器它的作用就是将前端发起的请求均匀的分发给后面的这三台服务器。 此时假如通过 session 来进行会话跟踪可能就会存在这样一个问题。前后分配的服务器不一致导致会话不一致Session方案就无法使用了。 会话跟踪方案三 令牌技术推荐
上面这两种传统的会话技术在现在的企业开发当中会存在很多的问题。在现在的企业开发当中基本上都会采用第三种方案通过令牌技术来进行会话跟踪。 这里的令牌其实就是一个用户身份的标识本质就是一个字符串。
通过令牌技术来跟踪会话可以在浏览器请求登录接口登录成功的时候生成一个令牌其是用户的合法身份凭证。在响应数据的时候将令牌响应给前端。前端接收到令牌后将这个令牌存储在cookie 当中也可以存储在其他的存储空间(比如localStorage)当中。在后续的每一次请求当中都需要将令牌携带到服务端。然后服务端就需要校验令牌的有效性。若有效说明用户已执行登录操作如无效说明用户之前并未执行登录操作。
若在同一次会话的多次请求之间想共享数据将共享的数据存储在令牌当中就可以了。
令牌技术优缺点
优点
支持PC端、移动端
解决集群环境下的认证问题
减轻服务器的存储压力无需在服务器端存储缺点需要自己实现包括令牌的生成、令牌的传递、令牌的校验JWT令牌
我们采用令牌技术来解决案例项目当中的会话跟踪问题。令牌的形式有很多我们使用功能强大的 JWT令牌全称JSON Web Token官网。
JWT定义了一种简洁的、自包含的格式用于在通信双方以json数据格式安全的传输信息。由于数字签名的存在这些信息是可靠的。
自包含指的是jwt令牌看似是一个随机的字符串但是我们是可以根据自身的需求在jwt令牌中存储自定义的数据内容。如可以直接在jwt令牌中存储用户的相关信息。
JWT是如何将原始的JSON格式数据转变为字符串的呢在生成JWT令牌时会对JSON格式的数据进行一次编码进行base64编码Base64是编码方式而不是加密方式。
JWT的组成 三个部分之间使用英文的点来分割
- 第一部分Header(头 记录令牌类型、签名算法等。 例如{alg:HS256,type:JWT}
- 第二部分Payload(有效载荷携带一些自定义信息、默认信息等。 例如{id:1,username:Tom}
- 第三部分Signature(签名防止Token被篡改、确保安全性。融合header、payload并加入指定秘钥通过指定签名算法计算而来签名的目的就是为了防jwt令牌被篡改而正是因为jwt令牌最后一个部分数字签名的存在所以整个jwt 令牌是非常安全可靠的。一旦jwt令牌当中任何一个部分、任何一个字符被篡改了整个令牌在校验的时候都会失败。 JWT令牌最典型的应用场景就是登录认证
1. 在浏览器发起请求来执行登录操作此时会访问登录的接口如果登录成功之后我们需要生成一个jwt令牌将生成的 jwt令牌返回给前端。
2. 前端拿到jwt令牌之后会将jwt令牌存储起来。在后续的每一次请求中都会将jwt令牌携带到服
务端。
3. 服务端统一拦截请求后先判断这次请求是否携带令牌若无拒绝访问若有则校验令牌是否是有效。若有效就直接放行进行请求的处理。生成和校验
首先我们先来实现JWT令牌的生成工具类Jwts。要想使用JWT令牌需要先引入JWT的依赖
!-- JWT依赖--
dependencygroupIdio.jsonwebtoken/groupIdartifactIdjjwt/artifactIdversion0.9.1/version
/dependency生成JWT代码实现测试
Test
public void genJwt(){MapString,Object claims new HashMap();claims.put(id,1);claims.put(username,Tom);String jwt Jwts.builder().setClaims(claims) //自定义内容(即JWT的第二部分 载荷部分).signWith(SignatureAlgorithm.HS256, itheima) //指定: 1.数字签名算法 2.数字签名密钥.setExpiration(new Date(System.currentTimeMillis() 24*3600*1000)) //设置有效期 单位毫秒 这里是24小时的有效期.compact();//拿到字符串类型的返回值 即JWT令牌System.out.println(jwt);
}其中数字签名算法种类我们可以在官网上查看 运行测试方法
eyJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjk5NjA1MjY0LCJ1c2VybmFtZSI6IlRvbSJ9._fTZ5DBIeGAZjFf4aQriOpvZMG8cjSAqlSeeIsZ9fvI我们可以将生成的令牌复制一下然后打开JWT的官网将生成的令牌直接放在Encoded位置此时就会自动的将令牌解析出来。 第一部分解析出来看到JSON格式的原始数据所使用的签名算法为HS256。 第二个部分是我们自定义的数据还有一个exp代表的是我们所设置的过期时间。 由于前两个部分是base64编码可以直接解码出来。但最后一个部分并不是base64编码是经过签名算法计算出来的所以最后一个部分是不会解析的。 下面我们接着使用Java代码来校验JWT令牌(解析生成的令牌)
Test
public void parseJwt() {Claims claims Jwts.parser().setSigningKey(itheima)//指定签名密钥必须保证和生成令牌时使用 相同的签名密钥.parseClaimsJws(eyJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjk5NjA1MjY0LCJ1c2VybmFtZSI6IlRvbSJ9._fTZ5DBIeGAZjFf4aQriOpvZMG8cjSAqlSeeIsZ9fvI).getBody();System.out.println(claims);
}运行测试方法
{id1, exp1699605264, usernameTom}令牌解析后我们可以看到自定义数据和过期时间做一个测试把令牌header中的数字9变为8运行测试方法后发现报错。结论篡改令牌中的任何一个字符在对令牌进行解析时都会报错所以JWT令牌是非常安全可靠的。
继续测试修改生成令牌的时指定的过期时间修改为1分钟。等待1分钟之后运行测试方法发现也报错了说明JWT令牌过期后令牌就失效了解析的为非法令 牌。 案例集成JWT
主要就是两步操作1.在登录成功之后来生成一个JWT令牌并且把这个令牌直接返回给前端2.拦截前端请求从请求中获取到令牌对令牌进行解析校验
我们首先来完成登录成功之后生成JWT令牌并且把令牌返回给前端。
JWT令牌怎么返回给前端呢此时我们就需要再来看一下接口文档当中关于登录接口的描述主要看响应数据
参数格式application/json 响应数据样例
{code: 1,msg: success,data:eyJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoi6YeR5bq4IiwiaWQiOjEsInVzZXJuYW1lIjoiamlueW9uZyIsImV4cCI6MTY2MjIwNzA0OH0.KkUc_CXJZJ8Dd063eImx4H9Ojfrr6XMJ-yVzaWCVZCo
}//用户登录成功后系统自动下发JWT令牌在后续的每次请求中都需要在请求头header中携带到服务端。
//请求头的名称为 token 值为登录时下发的JWT令牌。
//如果检测到用户未登录则会返回如下固定错误信息
/*
{code: 0,msg: NOT_LOGIN,data: null
}
*/实现书写JWT工具类登录完成后调用工具类生成JWT令牌并返回
JWT工具类
public class JwtUtils {private static String signKey itheima;//签名密钥private static Long expire 43200000L; //有效时间/*** 生成JWT令牌** param claims JWT第二部分负载 payload 中存储的内容* return*/public static String generateJwt(MapString, Object claims) {String jwt Jwts.builder().addClaims(claims)//自定义信息有效载荷.signWith(SignatureAlgorithm.HS256, signKey)//签名算 法头部.setExpiration(new Date(System.currentTimeMillis() expire))//过期时间.compact();return jwt;}/*** 解析JWT令牌** param jwt JWT令牌* return JWT第二部分负载 payload 中存储的内容*/public static Claims parseJWT(String jwt) {Claims claims Jwts.parser().setSigningKey(signKey)//指定签名密钥.parseClaimsJws(jwt)//指定令牌Token.getBody();return claims;}}LoginController
登录成功生成JWT令牌并返回
RestController
public class LoginController {Autowiredprivate EmpService empService;PostMapping(/login)public Result login(RequestBody Emp emp){Emp loginEmp empService.login(emp);//判断登录用户是否存在if(loginEmp !null ){//自定义信息MapString , Object claims new HashMap();claims.put(id, loginEmp.getId());claims.put(username,loginEmp.getUsername());claims.put(name,loginEmp.getName());//使用JWT工具类生成身份令牌String token JwtUtils.generateJwt(claims);return Result.success(token);}return Result.error(用户名或密码错误);}
}postman测试登录接口 打开浏览器完成前后端联调操作利用开发者工具抓取一下网络请求 服务器响应的JWT令牌存储在本地浏览器哪里了呢在当前案例中JWT令牌存储在浏览器的本地存储空间local storage中了。 local storage是浏览器的本地存储在移动端也是支持的。 再发起一个查询部门数据的请求此时我们可以看到在请求头中包含一个token(JWT令牌)后续的每一次请求当中都会将这个令牌携带到服务端。 过滤器Filter
在后续的请求当中都会在请求头中携带JWT令牌到服务端而服务端需要统一拦截所有的请求从而判断是否携带的有合法的JWT令牌。那怎么样来统一拦截到所有的请求校验令牌的有效性呢这里我们会学习两种解决方案
Filter过滤器Interceptor拦截器
首先学习Filter过滤器。 Filter表示过滤器是 JavaWeb三大组件(Servlet、Filter、Listener)之一。过滤器可以把对资源的请求拦截下来从而实现一些特殊的功能 使用了过滤器之后要想访问web服务器上的资源必须先经过滤器处理完毕之后才可以访问对应资源。 过滤器一般完成一些通用的操作比如登录校验、统一编码处理、敏感字符处理等。
下面我们通过Filter快速入门程序掌握过滤器的基本使用
第1步定义过滤器 定义一个类实现 Filter 接口并重写其所有方法。第2步配置过滤器Filter类上加 WebFilter 注解配置拦截资源的路径。引导类上加 ServletComponentScan 开启Servlet组件支持。
定义过滤器
package com.itheima.filter;
//定义一个类实现一个标准的Filter过滤器的接口
public class DemoFilter implements Filter {Override //初始化方法, 只调用一次public void init(FilterConfig filterConfig) throws ServletException {System.out.println(init 初始化方法执行了);}Override //拦截到请求之后调用, 调用多次public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {System.out.println(Demo 拦截到了请求...放行前逻辑);//放行操作 不执行放行操作将无法访问后面的资源。chain.doFilter(request,response);}Override //销毁方法, 只调用一次public void destroy() {System.out.println(destroy 销毁方法执行了);}
}init方法过滤器的初始化方法。在web服务器启动的时候会自动的创建Filter过滤器对象在创建过滤器对象的时候会自动调用init初始化方法这个方法只会被调用一次。 doFilter方法这个方法是在每一次拦截到请求之后都会被调用所以这个方法是会被调用多次的每拦截到一次请求就会调用一次doFilter()方法。 destroy方法 是销毁的方法。当我们关闭服务器的时候它会自动的调用销毁方法destroy而这个销毁方法也只会被调用一次。 在定义完Filter之后Filter其实并不会生效还需要完成Filter的配置Filter的配置非常简单只需要在Filter类上添加一个注解WebFilter并指定属性urlPatterns通过这个属性指定过滤器要拦截哪些请求
WebFilter(urlPatterns /*) //配置过滤器要拦截的请求路径 /* 表示拦截浏览器的所有请求
public class DemoFilter implements Filter {...
}当我们在Filter类上面加了WebFilter注解之后接下来我们还需要在启动类上面加上一个注解ServletComponentScan通过这个ServletComponentScan注解来开启SpringBoot项目对于Servlet组件的支持。
ServletComponentScan
SpringBootApplication
public class TliasWebManagementApplication {public static void main(String[] args) {SpringApplication.run(TliasWebManagementApplication.class, args);}}重新启动服务打开浏览器执行部门管理的请求可以看到控制台输出了过滤器中的内容 Filter详解
快速入门程序我们已经完成了现在介绍Filter以下3个方面的细节
1. 过滤器的执行流程 2. 过滤器的拦截路径配置 3. 过滤器链过滤器的执行流程 过滤器拦截到了请求后若希望继续访问后面的web资源就要执行放行操作放行就是调用 FilterChain对象当中的doFilter()方法在调用doFilter()这个方法之前所编写的代码属于放行之前的逻辑。 在放行后访问完 web 资源之后还会回到过滤器当中回到过滤器之后如有需求还可以执行放行之后的逻辑放行之后的逻辑我们写在doFilter()这行代码之后。 过滤器的拦截路径配置
Filter可以根据需求配置不同的拦截资源路径
拦截路径urlPatterns值含义拦截具体路径/login只有访问 /login 路径时才会被拦截目录拦截/emps/*访问/emps下的所有资源都会被拦截拦截所有/*访问所有资源都会被拦截 过滤器链
所谓过滤器链指的是在一个web应用程序当中可以配置多个过滤器多个过滤器就形成了一个过滤器链,执行到了最后一个过滤器放行之后才会访问对应的web资源。访问完web资源之后还会回到过滤器当中来执行过滤器放行后的逻辑而在执行放行后的逻辑的时候顺序是反着的。 下面来验证下过滤器链:
在filter包下再来新建一个Filter过滤器类AbcFilter在AbcFilter过滤器中编写放行前和放行后逻辑配置AbcFilter过滤器拦截请求路径为/*重启SpringBoot服务查看DemoFilter、AbcFilter的执行日志
AbcFilter过滤器
WebFilter(urlPatterns /*)
public class AbcFilter implements Filter {Overridepublic void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {System.out.println(Abc 拦截到了请求... 放行前逻辑);//放行chain.doFilter(request,response);System.out.println(Abc 拦截到了请求... 放行后逻辑);}
}DemoFilter过滤器
WebFilter(urlPatterns /*)
public class DemoFilter implements Filter {Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {System.out.println(DemoFilter 放行前逻辑.....);//放行请求filterChain.doFilter(servletRequest,servletResponse);System.out.println(DemoFilter 放行后逻辑.....);}
}打开浏览器访问登录接口 AbcFilter先执行DemoFilter后执行这是为什么呢因为以注解方式配置的Filter过滤器它的执行优先级是按时过滤器类名的自动排序确定的。测试修改AbcFilter类名为XbcFilter运行程序查看控制台日志 案例集成Filter
回顾一下登录校验的基本流程
1.要进入到后台管理系统必须先完成登录操作就需要访问登录接口login。
2.登录成功之后我们会在服务端生成一个JWT令牌并且把JWT令牌返回给前端前端会将JWT令牌存储下来。
3.在后续的每一次请求当中都会将JWT令牌携带到服务端请求到达服务端之后要想去访问对应的业务功能此时我们必须先要校验令牌的有效性。
4.对于校验令牌的这一块操作我们使用登录校验的过滤器在过滤器当中来校验令牌的有效性。PS:所有的请求拦截到了之后都需要校验令牌吗
登录请求例外PS:拦截到请求后什么情况下才可以放行执行业务操作
有令牌且令牌校验通过(合法)否则都返回未登录错误结果基于上面的业务流程我们分析出具体的操作步骤
1. 获取请求url
2. 判断请求url中是否包含login如果包含说明是登录操作放行
3. 获取请求头中的令牌token
4. 判断令牌是否存在如果不存在返回错误结果未登录
5. 解析token如果解析失败返回错误结果未登录
6. 放行分析清楚了以上的问题后我们就参照接口文档来开发登录功能了登录接口描述如下
基本信息
请求路径/login
请求方式POST
接口描述该接口用于员工登录Tlias智能学习辅助系统登录完毕后系统下发JWT令牌。请求参数样例
{username: jinyong,password: 123456
}响应数据样例
{code: 1,msg: success,data:eyJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoi6YeR5bq4IiwiaWQiOjEsInVzZXJuYW1lIjoiamlueW9uZyIsImV4cCI6MTY2MjIwNzA0OH0.KkUc_CXJZJ8Dd063eImx4H9Ojfrr6XMJ-yVzaWCVZCo
}登录校验过滤器LoginCheckFilter
Slf4j
WebFilter(urlPatterns /*) //拦截所有请求
public class LoginCheckFilter implements Filter {/*没有重写init()和destroy()这两个方法那么Servlet容器会调用Filter接口中的默认实现 这两个方法的默认实现是空的不需要进行特殊的初始化或清理操作 你可以选择不重写这两个方法反之 可能需要在init()方法中打开数据库连接 在destroy()方法中关闭数据库连接*/Overridepublic void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain chain) throws IOException, ServletException {//前置强制转换为http协议的请求对象、响应对象 转换原因要使用子类中特有方法HttpServletRequest request (HttpServletRequest) servletRequest;HttpServletResponse response (HttpServletResponse) servletResponse;//1.获取请求urlString url request.getRequestURL().toString();log.info(请求路径{}, url); //请求路径http://localhost:8080/login//2.判断请求url中是否包含login如果包含说明是登录操作放行if(url.contains(/login)){chain.doFilter(request, response);//放行请求return;//结束当前方法的执行}//3.获取请求头中的令牌tokenString token request.getHeader(token);log.info(从请求头中获取的令牌{},token);//4.判断令牌是否存在如果不存在返回错误结果未登录if(!StringUtils.hasLength(token)){//通过字符串长度判断log.info(Token不存在);Result responseResult Result.error(NOT_LOGIN);//把Result对象转换为JSON格式字符串 (fastjson是阿里巴巴提供的用于实现对象和json的转换工具类)String json JSONObject.toJSONString(responseResult);response.setContentType(application/json;charsetutf-8);//响应response.getWriter().write(json);return;}//5.解析token如果解析失败返回错误结果未登录try {JwtUtils.parseJWT(token);}catch (Exception e){log.info(令牌解析失败!);Result responseResult Result.error(NOT_LOGIN);//把Result对象转换为JSON格式字符串 (fastjson是阿里巴巴提供的用于实现对象和json的转换工具类)String json JSONObject.toJSONString(responseResult);response.setContentType(application/json;charsetutf-8);//响应response.getWriter().write(json);return;}//6.放行chain.doFilter(request, response);}
}使用到了一个第三方json处理的工具包fastjson。需要引入如下依赖
dependencygroupIdcom.alibaba/groupIdartifactIdfastjson/artifactIdversion1.2.76/version
/dependency登录校验的过滤器我们编写完成了接下来我们就可以重新启动服务来做一个测试测试前先把之前所编写的测试使用的过滤器暂时注释掉。直接将WebFilter注解给注释掉即可。 测试1未登录是否可以访问部门管理页面 首先关闭浏览器重新打开浏览器在地址栏中输入localhost:8080/#/system/dept 由于用户没有登录登录校验过滤器返回错误信息前端页面根据返回的错误信息结果自动跳转到登录页面了 测试2先进行登录操作再访问部门管理页面 登录校验成功之后可以正常访问相关业务操作页面 拦截器Interceptor
什么是拦截器
是一种动态拦截方法调用的机制类似于过滤器。拦截器是Spring框架中提供的用来动态拦截控制器方法的执行。
下面我们通过快速入门程序来学习下拦截器的基本使用。拦截器的使用步骤和过滤器类似也分为两步1. 定义拦截器 2. 注册配置拦截器
自定义拦截器实现HandlerInterceptor接口并重写其所有方法
package com.itheima.interceptor;//自定义拦截器
Component
public class LoginCheckInterceptor implements HandlerInterceptor {//目标资源方法执行前执行。 返回true放行 返回false不放行Overridepublic boolean preHandle(HttpServletRequest request,HttpServletResponse response, Object handler) throws Exception {System.out.println(preHandle .... );return true; //true表示放行}//目标资源方法执行后执行Overridepublic void postHandle(HttpServletRequest request,HttpServletResponse response, Object handler, ModelAndViewmodelAndView) throws Exception {System.out.println(postHandle ... );}//视图渲染完毕后执行最后执行Overridepublic void afterCompletion(HttpServletRequest request,HttpServletResponse response, Object handler, Exception ex) throwsException {System.out.println(afterCompletion .... );}
}注册配置拦截器实现WebMvcConfigurer接口并重写addInterceptors方法
package com.itheima.config;Configuration //代表其是配置类 还记得之前用过的ConfigurationProperties吗
public class WebConfig implements WebMvcConfigurer {//自定义的拦截器对象Autowiredprivate LoginCheckInterceptor loginCheckInterceptor;Overridepublic void addInterceptors(InterceptorRegistry registry) {//注册自定义拦截器对象registry.addInterceptor(loginCheckInterceptor).addPathPatterns(/**);//指定拦截器 设置拦截器拦截的请求路径 /** 表示拦截所有请求}
}postman测试 再来做一个测试将拦截器中返回值改为false使用postman再次点击send发送请求后没有响应数据说明请求被拦截了没有放行。 拦截器Interceptor详解
拦截路径
在注册配置拦截器的时候我们要指定拦截器的拦截路径通过addPathPatterns(要拦截的路径)方法就可以指定要拦截哪些资源。
在入门程序中我们配置的是/**表示拦截所有资源。还可以指定不拦截哪些资源只需要调用excludePathPatterns(不拦截的路径)方法指定哪些资源不需要拦截。
Configuration
public class WebConfig implements WebMvcConfigurer {//拦截器对象Autowiredprivate LoginCheckInterceptor loginCheckInterceptor;Overridepublic void addInterceptors(InterceptorRegistry registry) {//注册自定义拦截器对象registry.addInterceptor(loginCheckInterceptor).addPathPatterns(/**)//设置拦截器拦截的请求路径 /** 表示拦截所有请求.excludePathPatterns(/login);//设置不拦截的请求路径}
}在拦截器中除了可以设置/**拦截所有资源外还有一些常见拦截路径设置
拦截路径含义举例/*一级路径能匹配/depts/emps/login不能匹配 /depts/1/**任意级路径能匹配/depts/depts/1/depts/1/2/depts/*/depts下的一级路径能匹配/depts/1不能匹配/depts/1/2/depts/depts/**/depts下的任意级路径能匹配/depts/depts/1/depts/1/2不能匹配/emps/1 执行流程 当浏览器来访问部署在web服务器当中的web应用时定义的过滤器会拦截到这次请求。拦截后先执行放行前逻辑然后再执行放行操作。而由于我们当前是基于springboot开发的所以放行之后是进入到了spring的环境当中也就是要来访问我们所定义的controller当中的接口方法。Tomcat并不识别所编写的Controller程序但是它识别Servlet程序所以在Spring的Web环境中提供了一个非常核心的ServletDispatcherServlet前端控制器所有请求都会先行到DispatcherServlet再将请求转给Controller。在controller当中的方法执行完毕之后再回过来执行postHandle() 这个方法以及afterCompletion() 方法然后再返回给DispatcherServlet最终再来执行过滤器当中放行后的这一部分逻辑的逻辑。执行完毕之后最终给浏览器响应数据。演示下过滤器和拦截器同时存在的执行流程开启LoginCheckInterceptor拦截器和DemoFilter过滤器。 重启SpringBoot服务后清空日志打开Postman测试查询部门 所以过滤器和拦截器之间的区别主要是两点
接口规范不同过滤器需要实现Filter接口而拦截器需要实现HandlerInterceptor接口。 拦截范围不同过滤器Filter会拦截所有的资源而Interceptor只会拦截Spring环境中的资源。 案例集成拦截器Interceptor
登录校验的业务逻辑以及操作步骤和登录校验Filter过滤器当中的逻辑是完全 一致的。
登录校验拦截器
//自定义拦截器
Component //当前拦截器对象由Spring创建和管理
Slf4j
public class LoginCheckInterceptor implements HandlerInterceptor {//前置方式Overridepublic boolean preHandle(HttpServletRequest request,HttpServletResponse response, Object handler) throws Exception{//1.获取请求urlString url request.getRequestURL().toString();log.info(请求路径{}, url); //请求路径http://localhost:8080/login//2.判断请求url中是否包含login如果包含说明是登录操作放行if(url.contains(/login)) return true;//3.获取请求头中的令牌tokenString token request.getHeader(token);log.info(从请求头中获取的令牌{},token);//4.判断令牌是否存在如果不存在返回错误结果未登录if(!StringUtils.hasLength(token)){log.info(Token不存在);//创建响应结果对象Result responseResult Result.error(NOT_LOGIN);//把Result对象转换为JSON格式字符串 (fastjson是阿里巴巴提供的用于实现对象和json的转换工具类)String json JSONObject.toJSONString(responseResult);//设置响应头告知浏览器响应的数据类型为json、响应的数据编码表为utf-8response.setContentType(application/json;charsetutf-8);//响应response.getWriter().write(json);return false;//不放行}//5.解析token如果解析失败返回错误结果未登录try {JwtUtils.parseJWT(token);}catch (Exception e){log.info(令牌解析失败!);//创建响应结果对象Result responseResult Result.error(NOT_LOGIN);//把Result对象转换为JSON格式字符串 (fastjson是阿里巴巴提供的用于实现对象和json的转换工具类)String json JSONObject.toJSONString(responseResult);//设置响应头response.setContentType(application/json;charsetutf-8);//响应response.getWriter().write(json);return false;}//6.放行return true;}
}注册配置拦截器
Configuration //代表其是配置类 还记得在上一节用过的ConfigurationProperties吗
public class WebConfig implements WebMvcConfigurer {//自定义的拦截器对象Autowiredprivate LoginCheckInterceptor loginCheckInterceptor;Overridepublic void addInterceptors(InterceptorRegistry registry) {//注册自定义拦截器对象registry.addInterceptor(loginCheckInterceptor).addPathPatterns(/**).excludePathPatterns(/login);//登录请求不拦截}
}登录校验的拦截器编写完成后接下来我们就可以重新启动服务来做一个测试 关闭登录校验Filter过滤器
测试1未登录是否可以访问部门管理页面。由于用户没有登录校验机制返回错误信息前端页面根据返回的错误信息结果自动跳转到登录页面了。
测试2先进行登录操作再访问部门管理页面。登录校验成功之后可以正常访问相关业务操作页面。
到此我们也就验证了所开发的登录校验的拦截器也是没问题的。登录校验的过滤器和拦截器我们只需要使用其中的一种就可以了。 异常处理
看一下系统出现异常之后会发生什么现象再来介绍异常处理的方案。
访问新增部门操作且系统已经有了 “就业部” 部门再增加一个就业部后窗口关闭了页面没有任何反应就业部也没有添加上。 而此时发现网络请求报错了。 状态码为500表示服务器端异常打开idea看一下服务器端出了什么问题。报错添加就业部这个部门时违反了唯一约束。 出现异常之后响应回来的数据是一个JSON格式的数据。但这种JSON格式的数据不是我们开发规范当中所提到的统一响应结果Result所以前端并不能解析出响应的JSON数据。
因为对于当前案例项目的异常没有做任何的异常处理异常从Mapper一直往上抛最终抛给框架之后返回了一个json的数据封装着错误信息。 那么在三层构架项目中出现了异常该如何处理?
方案一在所有Controller的所有方法中进行try…catch处理
缺点代码臃肿不推荐方案二全局异常处理器
好处简单、优雅推荐全局异常处理器
定义全局异常处理器非常简单就是定义一个类在类上加上一个注解RestControllerAdvice加上这个注解就代表我们定义了一个全局异常处理器。在全局异常处理器当中需要定义一个方法来捕获异常在这个方法上需要加上注解ExceptionHandler。通过ExceptionHandler注解当中的value属性来指定我们要捕获的是哪一类型的异常。
package com.itheima.exception;RestControllerAdvice
public class GlobalExceptionHandler {//处理异常ExceptionHandler(Exception.class) //指定能够处理的异常类型public Result ex(Exception e) {e.printStackTrace();//打印堆栈中的异常信息//捕获到异常之后响应一个标准的Resultreturn Result.error(对不起,操作失败,请联系管理员);}
}处理异常的方法返回值会转换为json后再响应给前端
因为其注解里含有ResponseBody注解
RestControllerAdvice ControllerAdvice ResponseBody重新启动SpringBoot服务打开浏览器再来测试一下添加已存在的就业部 这个操作 可以看到出现异常之后异常已经被全局异常处理器捕获了。然后返回的错误信息被前端程序正常解析然后提示出了对应的错误提示信息。
