黑马程序员Javaweb重点笔记（四）（2023版）
文章目录
- 前言
- 登录功能
- 会话技术
- JWT令牌
-
- 生成和校验
- 登录下发令牌
- 过滤器Filter
-
- 使用Filter过滤器完成登录校验
- 拦截器Interceptor
-
- 使用Interceptor完成登录校验
- 异常处理
前言
我个人有一个学习习惯就是把学过的内容整理出来一份重点笔记，笔记往往只会包括我认为比较重要的部分或者容易忘记的部分，以便于我快速复习，如果有错误欢迎大家批评指正。
另外：本篇笔记参考了JavaWeb这个专栏的文章，相当于是这个专栏的压缩版，特此鸣谢作者「_Matthew」
版权声明：本文为CSDN博主「_Matthew」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/weixin_46225503/article/details/131730131
登录功能
登录服务端的核心逻辑：接收前端请求传递的用户名和密码，然后再根据用户名和密码查询用户信息，如果用户信息存在，则说明用户输入的用户名和密码正确。如果查询的用户不存在则说明输入的用户名和密码错误。
LoginController
@RestController
public class LoginController {
@Autowired
private EmpService empService;
@PostMapping("/login")
public Result login(@RequestBody Emp emp){
Emp e = empService.login(emp);
return e != null ? Result.success():Result.error("用户名或密码错误");
}
}
EmpService
public interface EmpService {
/**
* 用户登录
* @param emp
* @return
*/
public Emp login(Emp emp);
//省略其他代码...
}
EmpServiceImpl
@Slf4j
@Service
public class EmpServiceImpl implements EmpService {
@Autowired
private EmpMapper empMapper;
@Override
public Emp login(Emp emp) {
//调用dao层功能：登录
Emp loginEmp = empMapper.getByUsernameAndPassword(emp);
//返回查询结果给Controller
return loginEmp;
}
//省略其他代码...
}
EmpMapper
@Mapper
public interface EmpMapper {
@Select("select id, username, password, name, gender, image, job, entrydate, dept_id, create_time, update_time " +
"from emp " +
"where username=#{username} and password =#{password}")
public Emp getByUsernameAndPassword(Emp emp);
//省略其他代码...
}
存在的问题：如果我们不是直接输入登录界面的网址而是输入其他界面的网址，比如：http://localhost:9528/#/system/dept，那么就可以直接进入对应的界面.
所以要实现登录校验，无论你输入哪个界面的网址都需要校验你的身份，如果未登录则直接跳到登录界面。
会涉及到web开发中的两个技术：
会话技术
只要浏览器和服务器没有关闭，多次请求算是一次会话
多个浏览器客户端和服务器建立连接时，就会有多个会话
会话跟踪：一种维护浏览器状态的方法，服务器需要识别多次请求是否来自于同一浏览器，以便在同一次会话的多次请求间共享数据
为什么要共享数据呢？
由于HTTP是无状态协议，在后面的请求中怎么拿到前一次请求的数据呢？此时就需要在一次会话的多次请求之间进行数据共享
会话跟踪的三种技术：
1、Cookie（客户端会话跟踪技术）：数据存储在客户端浏览器当中
2、Session（服务端会话跟踪技术）：数据存储在服务端
3、令牌技术（当前企业最为主流）
Cookie优缺点：
优点：
HTTP协议中支持的技术（像Set-Cookie响应头的解析以及Cookie请求头数据的携带，都是浏览器自动进行的，是无需我们手动操作的）
缺点：
移动端APP中无法使用Cookie
不安全，用户可以自己禁用Cookie
Cookie不能跨域
Session优缺点：
优点：
Session是存储在服务端的，安全
缺点：
服务器集群环境下无法直接使用Session
移动端APP中无法使用Cookie
用户可以自己禁用Cookie
Cookie不能跨域
Session底层是基于Cookie实现的会话跟踪，如果Cookie不可用，则该方案也就失效了
令牌技术：
令牌技术使用比较多，这里详细介绍一下
令牌是一个用户身份的标识，其本质就是一个字符串。
如果通过令牌技术跟踪会话，我们可以在浏览器发起请求。在请求登录接口的时候，如果登录成功，就可以生成一个令牌，令牌是用户的合法身份凭证。接下来在响应数据的时候，就可以直接将令牌响应给前端
在前端程序中接收到令牌之后就需要将这个令牌存储起来，可以存储到Cookie中或者存储到其他地方
在后续的每一次请求当中，都需要将令牌携带到服务端。携带到服务端之后，接下来我们就需要检验令牌的有效性。如果令牌是有效的，就说明用户已经执行了登录操作，如果令牌是无效的，就说明用户之前并未执行登录操作
此时，如果是在同一次会话的多次请求之间，我们想共享数据，我们就可以将共享的数据存储到令牌当中
优缺点：
优点：
支持PC端、移动端
解决集群环境下的认证问题
减轻服务器的存储压力（无需在服务器端存储）
缺点：
需要自己实现（令牌的生成、令牌的传递、令牌的校验）
JWT令牌
JWT全称：JSON Web Token（官网：https://jwt.io/）
JWT的组成：
第一部分：Header（头），记录令牌类型、签名算法等。例如：{“alg”:“HS256”,“type”:“JWT”}
第二部分：Payload（有效载荷），携带一些自定义信息、默认信息等。例如：{“id”:“1”,“username”:“Tom”}
第三部分：Signature（签名），防止Token被篡改、确保安全性。将header、payload和指定的密钥，通过指定签名算法计算出来。（不是base64）
签名的目的是防止JWT令牌被篡改，正是因为最后数字签名的存在，整个jwt令牌是非常安全可靠的。一旦jwt令牌当中的任何一部分、任何一个字符被篡改了，整个令牌在校验的时候都会失败，所以是非常安全的
生成和校验
引入JWT依赖
<!-- JWT依赖-->
<dependency>
<groupId>io.jsonwebtoken</groupId>
<artifactId>jjwt</artifactId>
<version>0.9.1</version>
</dependency>
在引入完JWT依赖后，可以调用工具包中提供的API来完成JWT令牌的生成和校验
生成JWT代码实现：
@Test
public void genJwt(){
Map<String,Object> claims = new HashMap<>();
claims.put("id",1);
claims.put("username","Tom");
String jwt = Jwts.builder()
.setClaims(claims) //自定义内容(载荷)
.signWith(SignatureAlgorithm.HS256, "itheima") //签名算法
.setExpiration(new Date(System.currentTimeMillis() + 24*3600*1000)) //有效期
.compact();
System.out.println(jwt);
}
解析生成的令牌：
@Test
public void parseJwt(){
Claims claims = Jwts.parser()
.setSigningKey("itheima")//指定签名密钥（必须保证和生成令牌时使用相同的签名密钥）
.parseClaimsJws("eyJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjcyNzI5NzMwfQ.fHi0Ub8npbyt71UqLXDdLyipptLgxBUg_mSuGJtXtBk")
.getBody();
System.out.println(claims);
}
使用JWT令牌需要注意：
JWT校验时使用的签名密钥，必须和生成JWT令牌时使用的密钥是配套的。
如果JWT令牌解析校验时报错，则说明JWT令牌被篡改或失效了，令牌非法。
登录下发令牌
步骤：
1、引入jwt的pom
2、实现或引入JWT工具类
3、登录完成后，调用工具类生成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(Map<String, 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;
}
}
登录成功，生成JWT令牌并返回
@RestController
@Slf4j
public class LoginController {
//依赖业务层对象
@Autowired
private EmpService empService;
@PostMapping("/login")
public Result login(@RequestBody Emp emp) {
//调用业务层：登录功能
Emp loginEmp = empService.login(emp);
//判断：登录用户是否存在
if(loginEmp !=null ){
//自定义信息
Map<String , 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("用户名或密码错误");
}
}
前端获取令牌之后可以存储在浏览器的本地存储空间local storage中（local storage是浏览器的本地存储，在移动端也是支持的）。然后再发起请求的时候，可以看到在请求头中包含一个token（JWT令牌），后续的每一次请求当中都会将这个令牌携带到服务器端。
过滤器Filter
服务端要统一拦截所有请求，从而判断是否携带的有合法的JWT令牌
有两种解决方案：
1、Filier过滤器
2、Interceptor拦截器
什么是Filter？
- Filter表示过滤器，是Javaweb三大组件（Servlet、Filter、Listener（监听器））之一
- 过滤器可以把对资源的请求拦截下来，从而实现一些特殊的功能
- 过滤器一般完成一些通用的操作，比如：登录校验、统一编码处理、敏感字符处理等
过滤器的基本使用的简单案例：
1、定义过滤器：定义一个类，实现Filter接口，并重写其所有方法
2、配置过滤器：Filter类上加@WebFilter注解，配置拦截资源的路径。引导类上加@ServletComponentScan开启Servlet组件支持
定义过滤器
//定义一个类，实现一个标准的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实现类上加一个注解：@WebFilter并指定属性urlPatterns，通过这个属性指定过滤器要拦截哪些属性
@WebFilter(urlPatterns = "/*") //配置过滤器要拦截的请求路径（ /* 表示拦截浏览器的所有请求 ）
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 销毁方法执行了");
}
}
当我们在Filter实现类上面加了WebFilter注解之后，接下来我们需要在启动类上面加一个注解@ServletComponentScan，通过这个注解来开启SpringBoot项目对于Servlet组件的支持
@ServletComponentScan
@SpringBootApplication
public class TliasWebManagementApplication {
public static void main(String[] args) {
SpringApplication.run(TliasWebManagementApplication.class, args);
}
}
过滤器链：一个web应用程序当中，可以配置多个过滤器，多个过滤器就形成了一个过滤器链。
多个过滤器执行的优先级是按照过滤器类型的自动排序确定的，类名排序越靠前，优先级越高。
使用Filter过滤器完成登录校验
具体的操作步骤：
1、获取请求url
2、判断请求url中是否包含login，如果包含，说明是登录操作，放行
3、获取请求头中的令牌（token）
4、判断令牌是否存在，如果不存在，返回错误结果（未登录）
5、解析token，如果解析失败，返回错误结果（未登录）
6、放行
登录校验过滤器：
@Slf4j
@WebFilter(urlPatterns = "/*") //拦截所有请求
public class LoginCheckFilter implements Filter {
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain chain) throws IOException, ServletException {
//前置：强制转换为http协议的请求对象、响应对象 （转换原因：要使用子类中特有方法）
HttpServletRequest request = (HttpServletRequest) servletRequest;
HttpServletResponse response = (HttpServletResponse) servletResponse;
//1.获取请求url
String url = request.getRequestURL().toString();
log.info("请求路径：{}", url); //请求路径：http://localhost:8080/login
//2.判断请求url中是否包含login，如果包含，说明是登录操作，放行
if(url.contains("/login")){
chain.doFilter(request, response);//放行请求
return;//结束当前方法的执行
}
//3.获取请求头中的令牌（token）
String 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;charset=utf-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;charset=utf-8");
//响应
response.getWriter().write(json);
return;
}
//6.放行
chain.doFilter(request, response);
}
}
拦截器Interceptor
拦截器是一种动态拦截方法调用的机制，类似于过滤器。拦截器是Spring框架中提供的，用来动态拦截控制器方法的执行。
拦截器的使用步骤和过滤器类似，也分为两步：
1、定义拦截器
2、注册配置拦截器
自定义拦截器：实现HandleInterceptor接口，并重写其所有方法（重写的方法的快捷键是Ctrl+o）
//自定义拦截器
@Component
public class LoginCheckInterceptor implements HandlerInterceptor {
//目标资源方法执行前执行。 返回true：放行 返回false：不放行
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("preHandle .... ");
return true; //true表示放行
}
//目标资源方法执行后执行
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("postHandle ... ");
}
//视图渲染完毕后执行，最后执行
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("afterCompletion .... ");
}
}
注意：
preHandle方法：目标资源方法执行前执行。 返回true：放行 返回false：不放行
postHandle方法：目标资源方法执行后执行
afterCompletion方法：视图渲染完毕后执行，最后执行
注册配置拦截器：实现WebMvcConfigurer接口，并重写addInterceptors方法
@Configuration
public class WebConfig implements WebMvcConfigurer {
//自定义的拦截器对象
@Autowired
private LoginCheckInterceptor loginCheckInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
//注册自定义拦截器对象
registry.addInterceptor(loginCheckInterceptor).addPathPatterns("/**");//设置拦截器拦截的请求路径（ /** 表示拦截所有请求）
}
}
在入门程序中我们配置的是/**，表示拦截所有资源，而在配置拦截器时，不仅可以指定要拦截哪些资源，还可以指定不拦截哪些资源，只需要调用excludePathPatterns(“不拦截路径”)方法，指定哪些资源不需要拦截。
执行流程：
Filter和Interceptor之间的区别：
1、接口规范不同：过滤器需要实现Filter接口，而拦截器需要实现HandlerInterceptor接口
2、拦截范围不同：过滤器Filter会拦截所有的资源，而Interceptor只会拦截Spring环境中的资源
使用Interceptor完成登录校验
登录校验拦截器
//自定义拦截器
@Component //当前拦截器对象由Spring创建和管理
@Slf4j
public class LoginCheckInterceptor implements HandlerInterceptor {
//前置方式
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("preHandle .... ");
//1.获取请求url
//2.判断请求url中是否包含login，如果包含，说明是登录操作，放行
//3.获取请求头中的令牌（token）
String 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-8）
response.setContentType("application/json;charset=utf-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;charset=utf-8");
//响应
response.getWriter().write(json);
return false;
}
//6.放行
return true;
}
注册配置拦截器
@Configuration
public class WebConfig implements WebMvcConfigurer {
//拦截器对象
@Autowired
private LoginCheckInterceptor loginCheckInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
//注册自定义拦截器对象
registry.addInterceptor(loginCheckInterceptor)
.addPathPatterns("/**")
.excludePathPatterns("/login");
}
}
异常处理
我们的代码没有做异常处理，所以出现异常之后会逐渐往上抛出，这样就会导致返回的数据不符合开发规范，所以前端并不能解析出响应的JSON数据。
在三层架构项目中，出现了异常，该如何处理？
方案一：在所有Controller的所有方法中进行try…catch处理
缺点：代码臃肿
方案二：
全局异常处理器
优点：简单、优雅
怎么定义一个全局异常处理器？
- 定义一个类，在这个类上加一个注解
@RestControllerAdvice，加上这个注解就代表定义了一个全局异常处理器 - 在全局异常处理器中我们需要定义一个方法来捕获异常，在这个方法上需要加注解
@ExceptionHandler。通过@ExceptionHandler注解当中的value属性来指定我们要捕获的是哪一类异常
@RestControllerAdvice
public class GlobalExceptionHandler {
//处理异常
@ExceptionHandler(Exception.class) //指定能够处理的异常类型，这里是捕获所有异常
public Result ex(Exception e){
e.printStackTrace();//打印堆栈中的异常信息
//捕获到异常之后，响应一个标准的Result
return Result.error("对不起,操作失败,请联系管理员");
}
}
@RestControllerAdvice = @ControllerAdvice + @ResponseBody
处理异常的方法返回值会转换为json后再响应给前端