SpringBoot入门教程(四):登录认证(案例)

8. 案例-登录认证

8.1 登录功能

接口文档

  • 基本信息

    请求路径:/login
    请求方式:POST
    接口描述:该接口用于员工登录,登录完毕后,系统下发JWT令牌
  • 请求参数

    参数格式:application/json

    参数说明:

    名称 类型 是否必须 备注
    username string 必须 用户名
    password string 必须 密码

    请求数据样例:

    {
    "username": "jinyong",
      "password": "123456"
    }
  • 响应数据

    参数格式:application/json

    参数说明:

    名称 类型 是否必须 默认值 备注 其他信息
    code number 必须 响应码, 1 成功 ; 0 失败
    msg string 非必须 提示信息
    data string 必须 返回的数据 , jwt令牌

    响应数据样例:

    {
    "code": 1,
    "msg": "success",
    "data": "eyJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoi6YeR5bq4IiwiaWQiOjEsInVzZXJuYW1lIjoiamlueW9uZyIsImV4cCI6MTY2MjIwNzA0OH0.KkUc_CXJZJ8Dd063eImx4H9Ojfrr6XMJ-yVzaWCVZCo"
    }

功能开发

LoginController

@Slf4j
@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) {
        Emp loginEmp = empMapper.getByUsernameAndPassword(emp);
        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);
    // 省略...
}

功能测试

login1.png

前后端联调

login2.png

8.2 登录校验

8.2.1 问题分析

正常流程是用户根据用户名密码登录网站,然后进入到后台管理系统中进行数据的操作。但是,上述代码存在一个问题,用户在不登录的情况下可以直接根据url进入到后端管理系统。很显然,这是不合理的。

而真正的登录功能应该是:登录后才能访问后端系统页面,不登录则跳转到登录页面进行登录

为什么会出现这个问题?其实原因很简单,就是因为针对于我们当前所开发的部门管理、员工管理以及文件上传等相关接口来说,我们在服务器端并没有做任何的判断,没有去判断用户是否登录了。所以无论用户是否登录,都可以访问部门管理以及员工管理的相关数据。所以我们目前所开发的登录功能,它只是徒有其表。而我们要想解决这个问题,我们就需要完成一步非常重要的操作:登录校验

所谓登录校验,指的是我们在服务器端接收到浏览器发送过来的请求之后,首先我们要对请求进行校验。先要校验一下用户登录了没有,如果用户已经登录了,就直接执行对应的业务操作就可以了;如果用户没有登录,此时就不允许他执行相关的业务操作,直接给前端响应一个错误的结果,最终跳转到登录页面,要求他登录成功之后,再来访问对应的数据。

我们知道HTTP协议是无状态协议, 所谓无状态协议,指的是每一次请求是独立的,下一次请求不会携带上一次请求的数据。而浏览器与服务器之间进行交互,基于HTTP协议也就意味着现在我们通过浏览器来访问了登录这个接口,实现了登录操作,接下来我们在执行业务操作时,服务器并不知道这个员工到底登录了没有。因为HTTP协议时无状态的,两次请求之间是独立的,所以无法判断这个员工到底登录了没有。

那应该怎么来实现登录校验的操作呢?具体的实现思路可以分为两部分:

  1. 在员工登录成功后,需要将用户登录成功的信息存起来,记录该用户已经登录成功的标记。
  2. 在浏览器发起请求时,需要在服务器端进行统一拦截,拦截后进行登录校验。

login3.png

我们要完成以上操作,会涉及到web开发中的两个技术:

  1. 会话技术
  2. 统一拦截技术

而统一拦截技术实现方案也有两种:

  1. Servlet规范中的Filter过滤器
  2. Spring提供的interceptor拦截器

8.2.2 会话技术

8.2.2.1 会话技术介绍

在web开发当中,会话指的就是浏览器与服务器之间的一次连接,我们就称为一次会话。在用户打开浏览器第一次访问服务器的时候,这个会话就建立了,直到有任何一方断开连接,此时会话就结束了。在一次会话当中,是可以包含多次请求和响应的。用户可以在一次会话中完成登录、查询、修改等操作。

需要注意的是:会话是和浏览器关联的,当有三个浏览器客户端和服务器建立了连接时,就会有三个会话。同一个浏览器在未关闭之前请求了多次服务器,这多次请求属于同一个会话。

知道了会话的概念了,接下来我们再来了解下会话跟踪。会话跟踪:一种维护浏览器状态的方法,服务器需要识别多次请求是否来自于同一浏览器,以便在同一次会话的多次请求间共享数据

会话跟踪技术有两种:

  1. Cookie(客户端会话跟踪技术)
    • 数据存储在客户端浏览器中
  2. Session(服务端会话跟踪技术)
    • 数据存储在服务端
  3. 令牌技术

8.2.2.2 会话跟踪方案

方案一-Cookie

cookie是客户端会话跟踪技术,它是存储在客户端浏览器的,我们使用cookie来跟踪会话,我们就可以在浏览器第一次发起请求来请求服务器的时候,我们在服务器端来设置一个cookie。

比如第一次请求了登录接口,登录接口执行完成之后,我们就可以设置一个cookie,在cookie当中我们就可以来存储用户相关的一些数据信息。比如我可以在cookie当中存储当前登录用户的用户名,用户ID。

服务器端在给客户端响应数据的时候,会自动地将cookie响应给浏览器,浏览器接收到响应回来的cookie之后,会自动地将cookie的值存储在浏览器本地。接下来在后续的每一次请求当中,都会将浏览器本地所存储的cookie自动地携带到服务器端。

login4.png

接下来在服务器端我们就可以获取到cookie值。我们可以去判断一下这个cookie的值是否存在,如果不存在这个cookie,就说明客户端之前是没有访问登录接口的;如果存在cookie值,就说明客户端之前已经登录完成了。我们就可以基于cookie在同一次会话的不同请求之间来共享数据。

才在介绍流程的时候,用了 3 个自动:

  • 服务器会 自动 的将 cookie 响应给浏览器。

  • 浏览器接收到响应回来的数据之后,会 自动 的将 cookie 存储在浏览器本地。

  • 在后续的请求当中,浏览器会 自动 的将 cookie 携带到服务器端。

为什么这一切都是自动化进行的?

是因为 cookie 它是 HTTP 协议当中所支持的技术,而各大浏览器厂商都支持了这一标准。在 HTTP 协议官方给我们提供了一个响应头和请求头:

  • 响应头 Set-Cookie :设置Cookie数据的

  • 请求头 Cookie:携带Cookie数据的

login5.png

代码测试

@Slf4j
@RestController
public class SessionController {
    // 设置Cookie
    @GetMapping("/c1")
    public Result cookie1(HttpServletResponse response){
        response.addCookie(new Cookie("login_username", "ayanokouji"));
        return Result.success();
    }

    @GetMapping("/c2")
    public Result cookie2(HttpServletRequest request){
        Cookie[] cookies = request.getCookies();
        for (Cookie cookie : cookies) {
            if(cookie.getName().equals("login_username")){
                System.out.println("login_username: " + cookie.getValue());
            }
        }
        return Result.success();
    }
}

访问c1接口,设置Cookie,http://localhost:8080/c1

login6.png

我们可以看到,设置的cookie,通过响应头Set-Cookie响应给浏览器,并且浏览器会将Cookie,存储在浏览器端。

login7.png

访问c2接口 http://localhost:8080/c2,此时浏览器会自动的将Cookie携带到服务端,是通过**请求头Cookie**,携带的

login8.png

优缺点

  • 优点:HTTP协议中支持的技术,无需我们手动操作
  • 缺点:
    • 移动端APP(Android、IOS)中无法使用Cookie
    • 不安全,用户可以自己禁用Cookie
    • Cookie不能跨域

跨域介绍

  • 现在的项目,大部分都是前后端分离的,前后端最终也会分开部署,前端部署在服务器 192.168.150.200 上,端口 80,后端部署在 192.168.150.100上,端口 8080
  • 我们打开浏览器直接访问前端工程,访问url:http://192.168.150.200/login.html
  • 然后在该页面发起请求到服务端,而服务端所在地址不再是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 。而每一个会话对象Session ,它都有一个ID(示意图中Session后面括号中的1,就表示ID),我们称之为 Session 的ID。

    login9.png

  • 响应Cookie

    接下来,服务器端在给浏览器响应数据的时候,它会将 Session 的 ID 通过 Cookie 响应给浏览器。其实在响应头当中增加了一个 Set-Cookie 响应头。这个 Set-Cookie 响应头对应的值是不是cookie? cookie 的名字是固定的 JSESSIONID 代表的服务器端会话对象 Session 的 ID。浏览器会自动识别这个响应头,然后自动将Cookie存储在浏览器本地。

    login10.png

  • 查找Session

    接下来,在后续的每一次请求当中,都会将 Cookie 的数据获取出来,并且携带到服务端。接下来服务器拿到JSESSIONID这个 Cookie 的值,也就是 Session 的ID。拿到 ID 之后,就会从众多的 Session 当中来找到当前请求对应的会话对象Session。

    login11.png

    代码测试

    @Slf4j
    @RestController
    public class SessionController {
      @GetMapping("/s1")
      public Result session1(HttpSession session){
          log.info("HttpSession-s1:{}", session.hashCode());
          session.setAttribute("loginUser", "ayanokouji");
          return Result.success();
      }
    
      @GetMapping("/s2")
      public Result session2(HttpServletRequest request){
          HttpSession session = request.getSession();
          log.info("HttpSession-s1:{}", session.hashCode());
    
          Object loginUser = session.getAttribute("loginUser");
          log.info("loginUser:{}", loginUser);
          return Result.success(loginUser);
      }
    
      // 省略...
    }

    访问 s1 接口,http://localhost:8080/s1

    login12.png

请求完成之后,在响应头中,就会看到有一个Set-Cookie的响应头,里面响应回来了一个Cookie,就是JSESSIONID,这个就是服务端会话对象 Session 的ID。

访问 s2 接口,http://localhost:8080/s2

login13.png

接下来,在后续的每次请求时,都会将Cookie的值,携带到服务端,那服务端呢,接收到Cookie之后,会自动的根据JSESSIONID的值,找到对应的会话对象Session。

那经过这两步测试,大家也会看到,在控制台中输出如下日志:

login14.png

两次请求,获取到的Session会话对象的hashcode是一样的,就说明是同一个会话对象。而且,第一次请求时,往Session会话对象中存储的值,第二次请求时,也获取到了。 那这样,我们就可以通过Session会话对象,在同一个会话的多次请求之间来进行数据共享了。

优缺点

  • 优点:Session是存储在服务端的,安全
  • 缺点:
    • 服务器集群环境下无法直接使用Session
    • 移动端APP(Android、IOS)中无法使用Cookie
    • 用户可以自己禁用Cookie
    • Cookie不能跨域
方案三-令牌技术

大家会看到上面这两种传统的会话技术,在现在的企业开发当中是不是会存在很多的问题。 为了解决这些问题,在现在的企业开发当中,基本上都会采用第三种方案,通过令牌技术来进行会话跟踪。接下来我们就来介绍一下令牌技术,来看一下令牌技术又是如何跟踪会话的。

在请求登录接口的时候,如果登录成功,我们就可以生成一个令牌,令牌就是用户的合法身份凭证。接下来我们在响应数据的时候,就可以直接将令牌响应给前端。

在前端程序当中接收到令牌之后,就需要将这个令牌存储起来。这个存储可以是cookie也可以是其他的存储空间。接下来,在后续的每一次请求当中,都需要将令牌携带到服务端。携带到服务端之后,我们需要来校验令牌的有效性。如果令牌是有效的,就说明用户已经执行了登录操作,如果令牌是无效的,就说明用户之前并未执行登录操作。

如果是在同一次会话的多次请求之间我们想共享数据,可以将共享的数据存储在令牌当中。

优缺点

  • 优点:
    • 支持PC端、移动端
    • 解决集群环境下的认证问题
    • 减轻服务器的存储压力(无需在服务器端存储)
  • 缺点:需要自己实现(包括令牌的生成、令牌的传递、令牌的校验)

8.2.3 JWT令牌

8.2.3.1 介绍

前面我们介绍了基于令牌技术来实现会话追踪。这里所提到的令牌就是用户身份的标识,其本质就是一个字符串。令牌的形式有很多,我们使用的是功能强大的JWT令牌。

JWT全称:JSON Web Token (官网:https://jwt.io/

定义了一种简洁的、自包含的格式,用于在通信双方以json数据格式安全的传输信息。由于数字签名的存在,这些信息是可靠的。

  • 简洁:是指jwt就是一个简单的字符串。可以在请求参数或者是请求头当中直接传递。
  • 自包含:指的是jwt令牌,看似是一个随机的字符串,但是我们是可以根据自身的需求在jwt令牌中存储自定义的数据内容。如:可以直接在jwt令牌中存储用户的相关信息。
  • 简单来讲,jwt就是将原始的json数据格式进行了安全的封装,这样就可以直接基于jwt在通信双方安全的进行信息传输了。

JWT组成(JWT令牌由三个部分组成,三个部分之间使用英文的点来分割):

  • Header(头):记录令牌类型、签名算法等。例如:{"alg":"HS256","type":"JWT"}
  • Payload(有效载荷):携带一些自定义信息、默认信息等。例如:{"id":"1","username":"Tom"}
  • Signature(签名):防止Token被篡改、确保安全性。将header、payload加入指定秘钥,通过指定签名算法计算而来。

login15.png

JWT令牌最典型的应用场景就是登录认证:

  1. 在浏览器发起请求来执行登录操作,此时会访问登录的接口,如果登录成功之后,我们需要生成一个jwt令牌,将生成的 jwt令牌返回给前端。
  2. 前端拿到jwt令牌之后,会将jwt令牌存储起来。在后续的每一次请求中都会将jwt令牌携带到服务端。
  3. 服务端统一拦截请求之后,先来判断一下这次请求有没有把令牌带过来,如果没有带过来,直接拒绝访问,如果带过来了,还要校验一下令牌是否是有效。如果有效,就直接放行进行请求的处理。

在JWT登录认证的场景中我们发现,整个流程当中涉及到两步操作:

  1. 在登录成功之后,要生成令牌。
  2. 每一次请求当中,要接收令牌并对令牌进行校验。

稍后我们再来学习如何来生成jwt令牌,以及如何来校验jwt令牌。

8.2.3.2 生成和校验

引入JWT依赖:

<dependency>
      <groupId>io.jsonwebtoken</groupId>
      <artifactId>jjwt</artifactId>
      <version>0.9.1</version>
</dependency>

生成JWT代码实现:

@SpringBootTest
class TilasManagementApplicationTests {
    @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, "ayanokouji")
                .setExpiration(new Date(System.currentTimeMillis() + 24 * 3600 * 1000))
                .compact();
        System.out.println(jwt);
    }
}

运行测试方法:

eyJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjg2NzU0MzExLCJ1c2VybmFtZSI6IlRvbSJ9.XnqNNGSVGXGw-eHELL4rWtpq_pq21rUxqRo1m7DVk2c

输出的结果就是生成的JWT令牌,,通过英文的点分割对三个部分进行分割,我们可以将生成的令牌复制一下,然后打开JWT的官网,将生成的令牌直接放在Encoded位置,此时就会自动的将令牌解析出来。

login16.png

实现了JWT令牌的生成,下面我们接着使用Java代码来校验JWT令牌(解析生成的令牌):

@SpringBootTest
class TilasManagementApplicationTests {

    @Test
    public void parseJwt(){
        Claims claims = Jwts.parser()
                .setSigningKey("ayanokouji")
                .parseClaimsJws("eyJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZXhwIjoxNjg2NzU0MzExLCJ1c2VybmFtZSI6IlRvbSJ9.XnqNNGSVGXGw-eHELL4rWtpq_pq21rUxqRo1m7DVk2c")
                .getBody();
        System.out.println(claims);
    }
    // 省略...
}

login17.png

篡改令牌中的任何一个字符,在对令牌进行解析时都会报错,所以JWT令牌是非常安全可靠的。

JWT令牌过期后,令牌就失效了,解析的为非法令牌。

通过以上测试,我们在使用JWT令牌时需要注意:

  • JWT校验时使用的签名秘钥,必须和生成JWT令牌时使用的秘钥是配套的。

  • 如果JWT令牌解析校验时报错,则说明 JWT令牌被篡改 或 失效了,令牌非法。

8.2.3.3 登录下发令牌

我们知道JWT令牌技术来跟踪会话主要分为两步:生成令牌校验令牌

JWT令牌怎么返回给前端呢?

  • 响应数据

    参数格式:application/json

    参数说明:

    名称 类型 是否必须 默认值 备注 其他信息
    code number 必须 响应码, 1 成功 ; 0 失败
    msg string 非必须 提示信息
    data string 必须 返回的数据 , jwt令牌

    响应数据样例:

    {
    "code": 1,
    "msg": "success",
    "data": "eyJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoi6YeR5bq4IiwiaWQiOjEsInVzZXJuYW1lIjoiamlueW9uZyIsImV4cCI6MTY2MjIwNzA0OH0.KkUc_CXJZJ8Dd063eImx4H9Ojfrr6XMJ-yVzaWCVZCo"
    }
  • 备注说明

    用户登陆成功后,系统会自动下发令牌,然后在后续的每次请求中,都需要在请求头中携带到服务端,请求头的名称为token,值为登录时下发的JWT令牌。

    如果检测到用户未登录,则会返回如下固定的错误信息:

    {
    "code": 0,
    "msg": "NOT_LOGIN",
    "data": null
    }

实现步骤

  1. 引入JWT工具类
    • 在项目工程下创建com.itheima.utils包,并把提供JWT工具类复制到该包下
  2. 登录完成后,调用工具类生成JWT令牌并返回

JWT工具类

public class JwtUtils {
    private static String signKey = "ayanokouji";//签名密钥
    private static Long expire = 43200000L; //有效时间

    /**
     * 生成JWT令牌
     * @param claims JWT第二部分负载 pauload中存储的内容
     * @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)
                .getBody();
        return  claims;
    }
}

登录成功,生成JWT令牌并返回

@Slf4j
@RestController
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("用户名或密码错误");
    }
}

使用postman测试:

login18.png

前后端联调:

login19.png

服务器响应的JWT令牌存储在本地浏览器哪里了呢?

login20.png

我们在发起一个查询部门数据的请求,此时我们可以看到在请求头中包含一个token(JWT令牌),后续的每一次请求当中,都会将这个令牌携带到服务端。

login21.png

8.2.4 过滤器Filter

刚才通过浏览器的开发者工具可以看到在后续的请求中都会在请求头中携带JWT令牌到服务端,而服务端需要统一拦截所有的请求,从而判断是否携带有合法的令牌。

那么怎么样来统一拦截到所有的请求校验令牌的有效性呢:

  1. Filter过滤器
  2. Interceptor拦截器

8.2.4.1 快速入门

什么是Filter?

  • Filter表示过滤器,是 JavaWeb三大组件(Servlet、Filter、Listener)之一。
  • 过滤器可以把对资源的请求拦截下来,从而实现一些特殊的功能
    • 使用了过滤器之后,要想访问web服务器上的资源,必须先经过滤器,过滤器处理完毕之后,才可以访问对应的资源。
  • 过滤器一般完成一些通用的操作,比如:登录校验、统一编码处理、敏感字符处理等。

login22.png

下面我们通过Filter快速入门程序掌握过滤器的基本使用操作:

  • 第一步,定义过滤器,定义一个类,实现Filter接口,并重写其所有方法。
  • 第二步,配置过滤器,Filter类上加@WebFilter注解,配置拦截资源的路径。引导类上加@ServletComponentScan开启Servlet组件支持。

定义过滤器:定义一个filter的包,新建一个DemoFilter的类

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

@WebFilter(urlPatterns = "/*") // 配置过滤器要拦截的请求路径,/*表示拦截浏览器的所有请求
public class DemoFilter implements Filter {
    @Override // 初始化方法只调用一次
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("init 初始化方法执行了");
    }

    @Override // 拦截到请求后调用,调用多次
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("Demo 拦截到了请求...放行前逻辑");
        //放行
        filterChain.doFilter(servletRequest, servletResponse);

    }

    @Override // 销毁方法,只调用一次
    public void destroy() {
        System.out.println("destroy 销毁方法执行了");
    }
}
  • init方法:过滤器初始化方法。在web服务器启动的时候会自动地创建Filter过滤器对象,在创建过滤器对象的时候会自动调用init初始化方法,这个方法只会被调用一次
  • doFilter方法:这个方法是在每一次拦截到请求之后都会被调用,所以这个方法会被调用多次的,每次拦截到一次请求就会调用doFilter()方法。
  • destroy方法:是销毁的方法。当我们关闭服务器的时候,它会自动地调用销毁方法,而这个方法也只会被调用一次

在定义完Filter之后,Filter其实并不会生效,还需要完成Filter的配置,Filter的配置非常简单,只需要在Filter类上添加一个注解:@WebFilter,并指定属性urlPatterns,通过这个属性指定过滤器要拦截哪些请求。

当我们在Filter类上面加了:@WebFilter注解之后,接下来我们还需要在启动类上面加上一个注解:@ServletComponentScan,通过这个:@ServletComponentScan注解来开启SpringBoot项目对于Servlet组件的支持。

@ServletComponentScan
@SpringBootApplication
public class TilasManagementApplication {

    public static void main(String[] args) {
        SpringApplication.run(TilasManagementApplication.class, args);
    }

}

login23.png

8.2.4.2 Filter详解

Filter过滤器的快速入门程序我们已经完成了,接下来我们就要详细的介绍一下过滤器Filter在使用中的一些细节。主要介绍以下3个方面的细节:

  1. 过滤器的执行流程
  2. 过滤器的拦截路径配置
  3. 过滤器链
执行流程

login24.png

过滤器当中我们拦截到了请求之后,如果希望继续访问后面的web资源,就要执行放行操作,放行就是调用 FilterChain对象当中的doFilter()方法,在调用doFilter()这个方法之前所编写的代码属于放行之前的逻辑。

在放行后访问完 web 资源之后还会回到过滤器当中,回到过滤器之后如有需求还可以执行放行之后的逻辑,放行之后的逻辑我们写在doFilter()这行代码之后。

@WebFilter(urlPatterns = "/*") // 配置过滤器要拦截的请求路径,/*表示拦截浏览器的所有请求
public class DemoFilter implements Filter {
    @Override // 初始化方法只调用一次
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("init 初始化方法执行了");
    }

    @Override // 拦截到请求后调用,调用多次
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("Demo 拦截到了请求...放行前逻辑");
        //放行
        filterChain.doFilter(servletRequest, servletResponse);
        System.out.println("放行后逻辑");

    }

    @Override // 销毁方法,只调用一次
    public void destroy() {
        System.out.println("destroy 销毁方法执行了");
    }
}

login25.png

拦截路径

执行流程我们搞清楚之后,接下来再来介绍一下过滤器的拦截路径,Filter可以根据需求,配置不同的拦截资源路径:

拦截路径 urlPatterns值 含义
拦截具体路径 /login 只有访问 /login 路径时,才会被拦截
目录拦截 /emps/* 访问/emps下的所有资源,都会被拦截
拦截所有 /* 访问所有资源,都会被拦截
过滤器链

什么是过滤器链呢?所谓过滤器链指的是在一个web应用程序当中,可以配置多个过滤器,多个过滤器就形成了一个过滤器链。

login26.png

比如:在我们web服务器当中,定义了两个过滤器,这两个过滤器就形成了一个过滤器链。

而这个链上的过滤器在执行的时候会一个一个的执行,会先执行第一个Filter,放行之后再来执行第二个Filter,如果执行到了最后一个过滤器放行之后,才会访问对应的web资源。

访问完web资源之后,按照我们刚才所介绍的过滤器的执行流程,还会回到过滤器当中来执行过滤器放行后的逻辑,而在执行放行后的逻辑的时候,顺序是反着的。

先要执行过滤器2放行之后的逻辑,再来执行过滤器1放行之后的逻辑,最后在给浏览器响应数据。

验证步骤:

  1. 在filter包下再来新建一个Filter过滤器类:AbcFilter
  2. 在AbcFilter过滤器中编写放行前和放行后逻辑
  3. 配置AbcFilter过滤器拦截请求路径为:/*
  4. 重启SpringBoot服务,查看DemoFilter、AbcFilter的执行日志

AbcFilter过滤器

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

@WebFilter(urlPatterns = "/*")
public class AbcFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        Filter.super.init(filterConfig);
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("Abc拦截到了请求,放行前逻辑...");
        filterChain.doFilter(servletRequest, servletResponse);
        System.out.println("Abc拦截到了请求,放行后逻辑");

    }

    @Override
    public void destroy() {
        Filter.super.destroy();
    }
}

DemoFilter过滤器

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

@WebFilter(urlPatterns = "/*") // 配置过滤器要拦截的请求路径,/*表示拦截浏览器的所有请求
public class DemoFilter implements Filter {
    @Override // 初始化方法只调用一次
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("init 初始化方法执行了");
    }

    @Override // 拦截到请求后调用,调用多次
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("Demo 拦截到了请求...放行前逻辑");
        //放行
        filterChain.doFilter(servletRequest, servletResponse);
        System.out.println("放行后逻辑");

    }

    @Override // 销毁方法,只调用一次
    public void destroy() {
        System.out.println("destroy 销毁方法执行了");
    }
}

执行登录请求后:

login27.png

通过控制台日志的输出,大家发现AbcFilter先执行DemoFilter后执行,这是为什么呢?

其实是和过滤器的类名有关系。以注解方式配置的Filter过滤器,它的执行优先级是按时过滤器类名的自动排序确定的,类名排名越靠前,优先级越高。

8.2.4.3 登录校验-Filter

分析

我们先来回顾一下前面分析的登录校验的基本流程:

  • 要进入到后台管理系统,我们必须先完成登录操作,此时就需要访问登录接口login
  • 登录成功之后,我们会在服务端生成一个JWT令牌,并且把JWT令牌返回给前端,前端会将JWT令牌存储下来。
  • 在后续的每一次请求中,都会将JWT令牌携带到服务器端,请求到达服务器后,要想访问对应的业务功能,此时我们必须要先校验令牌的有效性
  • 对于校验令牌的这一块操作,我们使用登录校验的过滤器,在过滤器中来校验令牌的有效性。如果令牌是无效的,就响应一个错误的信息,也不会再去放行访问对应的资源了。如果令牌存在,并且它是有效的,此时就会放行去访问对应的web资源,执行相应的业务操作。
具体流程
  1. 获取请求url
  2. 判断请求url中是否包含login,如果包含,说明是登录操作,放行
  3. 获取请求头中的令牌(token)
  4. 判断令牌是否存在,如果不存在,返回错误结果(未登录)
  5. 解析token,如果解析失败,返回错误结果(未登录)
  6. 放行
代码实现
  • 基本信息

    请求路径:/login
    请求方式:POST
    接口描述:该接口用于员工登录系统,登录完毕后,系统下发JWT令牌
  • 请求参数

    参数格式:application/json

    参数说明:

    名称 类型 是否必须 备注
    username string 必须 用户名
    password string 必须 密码

    请求数据样例:

    {
    "username": "jinyong",
      "password": "123456"
    }
  • 响应数据

    参数格式:application/json

    参数说明:

    名称 类型 是否必须 默认值 备注 其他信息
    code number 必须 响应码, 1 成功 ; 0 失败
    msg string 非必须 提示信息
    data string 必须 返回的数据 , jwt令牌

    响应数据样例:

    {
    "code": 1,
    "msg": "success",
    "data": "eyJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoi6YeR5bq4IiwiaWQiOjEsInVzZXJuYW1lIjoiamlueW9uZyIsImV4cCI6MTY2MjIwNzA0OH0.KkUc_CXJZJ8Dd063eImx4H9Ojfrr6XMJ-yVzaWCVZCo"
    }
  • 备注说明

    用户登录成功后,系统会自动下发JWT令牌,然后在后续的每一次请求中都需要在请求头header中携带到服务端,请求头的名称为token,值为登录时下发JWT令牌。如果检测到用户未登录,则会返回如下固定的错误信息:

    {
    "code": 0,
    "msg": "NOT_LOGIN",
    "data": null
    }

    登录校验过滤器:LoginCheckFilter

    @Slf4j
    @WebFilter(urlPatterns = "/*")
    public class LoginCheckFilter implements Filter {
      @Override
      public void init(FilterConfig filterConfig) throws ServletException {
          Filter.super.init(filterConfig);
      }
    
      @Override
      public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
          // 前置:强制转换为http协议的请求对象和响应对象(转换原因:要使用子类中特有方法)
          HttpServletRequest request = (HttpServletRequest) servletRequest;
          HttpServletResponse response = (HttpServletResponse) servletResponse;
    
          //1.获取请求url
          String url = request.getRequestURL().toString();
          log.info("请求路径:{}", url);
    
          //2.判断请求url中是否包含login,如果包含说明是登录操作,直接放行
          if (url.contains("/login")){
              filterChain.doFilter(request, response);
              return;
          }
    
          //3. 获取请求头中的令牌
          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.放行
          filterChain.doFilter(request, response);
    
      }
    
      @Override
      public void destroy() {
          Filter.super.destroy();
      }
    }

    在上述过滤器的功能实现中,我们使用到了一个第三方json处理的工具包fastjson。我们要想使用,需要引入如下依赖:

    
      com.alibaba
      fastjson
      1.2.76
    

    测试1:未登录时访问:http://localhost:90/#/system/dept

    由于用户没有登录,登录校验过滤器返回错误信息,前端页面根据返回的错误信息结果,自动跳转到登录页面了

    login28.png

    测试2:先进行登录操作,再访问部门管理页面

    login29.png

8.2.5 拦截器Interceptor

拦截器主要分为三个部分:

  1. 介绍拦截器,并通过快速入门程序上手拦截器
  2. 拦截器的细节
  3. 通过拦截器完成登录校验功能

8.2.5.1 快速入门

什么是拦截器?

  • 是一种动态拦截方法的调用机制,类似于过滤器。
  • 拦截器是Spring框架提供的,用来动态拦截控制器方法的执行。

拦截器的作用:

  • 拦截请求,在指定方法调用前后,根据业务需要执行预先设定的代码。

在拦截器当中,我们通常也是做一些通用性的操作,比如:我们可以通过拦截器来拦截前端发起的请求,将登录校验的逻辑全部编写在拦截器当中。在校验的过程当中,如发现用户登录了(携带JWT令牌且是合法令牌),就可以直接放行,去访问spring当中的资源。如果校验时发现并没有登录或是非法令牌,就可以直接给前端响应未登录的错误信息。

拦截器的使用步骤和过滤器类似,也分为两步:

  1. 定义拦截器
  2. 配置拦截器

自定义拦截器:实现HandlerInterceptor接口,并重写其所有方法。

login30.png

@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;
    }
    //目标资源方法执行后执行
    @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接口,并重写addInterceptor方法。

@Configuration
public class WebConfig implements WebMvcConfigurer {
    // 自定义拦截对象
    @Autowired
    private LoginCheckInterceptor loginCheckInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginCheckInterceptor).addPathPatterns("/**"); //设置拦截器拦截的请求路径(/** 表示拦截所有请求)
    }
}

login31.png

postman测试:

login32.png

login33.png

接下来我们再来做一个测试:将拦截器中返回值改为false;

login34.png

8.2.5.2 Interceptor详解

拦截器的入门程序完成之后,接下来我们来介绍拦截器的使用细节。拦截器的使用细节我们主要介绍两个部分:

  1. 拦截器的拦截路径配置
  2. 拦截器的执行流程
拦截路径

首先我们先来看拦截器的拦截路径的配置,在注册配置拦截器的时候,我们要指定拦截器的拦截路径,通过addPathPatterns方法就可以指定要拦截哪些资源。

在配置拦截器时,不仅可以指定要拦截哪些资源,还可以指定不拦截哪些资源,只需要调用excludePathPatterns方法,指定哪些资源不需要拦截。

@Configuration  
public class WebConfig implements WebMvcConfigurer {

    //拦截器对象
    @Autowired
    private LoginCheckInterceptor loginCheckInterceptor;

    @Override
    public 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
执行流程

login35.png

  • 当我们打开浏览器来访问部署在web服务器中的web应用时,此时我们所定义的过滤器会拦截到这次请求。拦截到这次请求之后,它会先执行放行前的逻辑,然后再执行放行操作。而由于我们当前是基于springboot开发的,所以放行之后是进入到了sprint环境中,也就是要来访问我们所定义的controller当中的接口方法。
  • Tomcat并不识别所编写的Controller程序,但是它识别Servlet程序,所以在Spring的Web环境中提供了一个非常核心的Servlet:DispatcherServlet(前端控制器),所有请求都会先进行到DispatcherServlet,再将请求转给Controller。
  • 当我们定义了拦截器后,会在执行Controller的方法之前,请求被拦截器拦截住。执行preHandle方法,这个方法执行后需要返回一个布尔类型的值,如果返回true,就表示放行本次操作,才会继续访问controller中的方法;如果返回false,则不会放行。
  • 在controller当中的执行完毕之后,再回过来执行postHandle方法和afterCompletion方法,然后再返回给DispatcherServlet,最终再来执行过滤器中放行后的这一部分逻辑。执行完毕后,最终给浏览器响应数据。

其实它们之间的区别主要是两点:

  • 接口规范不同:过滤器需要实现Filter接口,而拦截器需要实现HandlerInterceptor接口。
  • 拦截范围不同:过滤器Filter会拦截所有的资源,而Interceptor只会拦截Spring环境中的资源。

8.2.5.3 登录校验-Interceptor

登录校验拦截器

@Slf4j
@Component
public class LoginCheckInterceptor implements HandlerInterceptor {
    //目标资源方法执行前执行。 返回true:放行    返回false:不放行
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle ......");
        // 1. 获取请求url
        String url = request.getRequestURL().toString();

        // 2.判断请求url中是否包含login,如果包含说明是登录操作,放行
        if (url.contains("/login")){
            return true;
        }

        //3. 获取请求头中的令牌
        String token = request.getHeader("token");
        log.info("从请求头中获取的令牌:{}", token);

        // 4. 判断令牌是否存在,如果不存在,返回错误结果
        if (!StringUtils.hasLength(token)){
            log.info("Token不存在");

            // 创建响应结果对象
            Result responseResult = Result.error("NOT_LOGIN");
            // 把Result对象转换为JSON格式字符串
            String json = JSONObject.toJSONString(responseResult);
            // 设置响应头
            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格式字符串
            String json = JSONObject.toJSONString(responseResult);
            // 设置响应头
            response.setContentType("application/json;charset=utf-8");
            // 响应
            response.getWriter().write(json);
            return false;
        }
        return 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......");
    }
}

注册配置拦截器

@Configuration  
public class WebConfig implements WebMvcConfigurer {
    //拦截器对象
    @Autowired
    private LoginCheckInterceptor loginCheckInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
       //注册自定义拦截器对象
        registry.addInterceptor(loginCheckInterceptor)
                .addPathPatterns("/**")
                .excludePathPatterns("/login");
    }
}

关闭Filter过滤器

测试1:推出系统后直接访问http://localhost:90/#/system/dept

由于用户没有登录,校验机制返回错误信息,前端页面根据返回的错误信息结果,自动跳转到登录页面了

login28.png

测试2:先进行登录操作,再访问部门管理页面

login29.png

8.3 异常处理

8.3.1 当前问题

当我们访问系统中的新增部门操作,系统中已经有“就业部”这个部门,当我们再来增加一个就业部时,看看会发生什么现象。

login36.png

点击确定之后,窗口关闭了,页面没有任何反应,就业部也没有添加上。而此时,网络请求报错了。

login37.png

状态码为500,表示服务器端异常,我们打开idea,来看一下,服务器端出了什么问题。

login38.png

上述错误信息的含义是,dept部门表的name字段的值 就业部 重复了,因为在数据库表dept中已经有了就业部,我们之前设计这张表时,为name字段建议了唯一约束,所以该字段的值是不能重复的。而当我们再添加就业部,这个部门时,就违反了唯一约束,此时就会报错。

login39.png

响应回来的数据是一个JSON格式的数据。但这种JSON格式的数据还是我们开发规范当中所提到的统一响应结果Result吗?显然并不是。由于返回的数据不符合开发规范,所以前端并不能解析出响应的JSON数据。

当我们没有做任何异常处理时,我们三层架构处理异常的方案:

  • Mapper接口在操作数据库的时候出错了,此时异常会往上抛,会抛给Service。
  • Service中也存在异常了会抛给Controller
  • 而在Controller当中,我们也没有做任何的异常处理,所以最终异常会再往上抛。最终抛给框架之后,框架就会返回一个JSON格式数据,里面封装的就是错误的信息,但是框架返回的JSON格式的数据并不符合我们的开发规范。

8.3.2 解决方案

那么在三层架构项目中出现了异常该如何处理?

  • 方案一:在所有Controller的所有方法中进行try...catch处理
    • 缺点:代码臃肿(不推荐)
  • 方案二:全局异常处理器
    • 好处:简单、优雅(推荐)

8.3.3 全局异常处理器

我们该怎样定义一个全局异常处理器:

  • 定义全局异常处理器非常简单,就是定义一个类,在类上加上一个注解@RestControllerAdvice,加上这个注解就代表我们定义了一个全局异常处理器。
  • 在全局异常处理器中,需要定义一个方法来捕获异常,在这个方法上需要加上注解@ExceptionHandler。通过@ExceptionHanlder注解当中的value属性来指定我们要捕获哪一类型的异常。

login40.png

@RestControllerAdvice
public class GlobalExceptionHandler {
    // 处理异常
    @ExceptionHandler(Exception.class) // 指定能够处理的异常类型
    public Result ex(Exception e){
        e.printStackTrace();
        // 捕获到异常之后,响应一个标准的Result
        return Result.error("对不起操作失败,请联系管理员");
    }
}

@RestControllerAdvice = @ControllerAdvice + @ResponseBody

重新启动SpringBoot服务,打开浏览器,再来测试一下添加部门这个操作,我们依然添加已存在的 "就业部" 这个部门:

login41.png

login42.png

以上就是全局异常处理器的使用,主要涉及到两个注解:

  • @RestControllerAdvice //表示当前类为全局异常处理器
  • @ExceptionHandler //指定可以捕获哪种类型的异常进行处理

评论

  1. Anna1021
    4天前
    2024-2-22 21:59:16

    Modern Talking был немецким дуэтом, сформированным в 1984 году. Он стал одним из самых ярких представителей евродиско и популярен благодаря своему неповторимому звучанию. Лучшие песни включают “You’re My Heart, You’re My Soul”, “Brother Louie”, “Cheri, Cheri Lady” и “Geronimo’s Cadillac”. Их музыка оставила неизгладимый след в истории поп-музыки, захватывая слушателей своими заразительными мелодиями и запоминающимися текстами. Modern Talking продолжает быть популярным и в наши дни, оставаясь одним из символов эпохи диско. Музыка 2024 года слушать онлайн и скачать бесплатно mp3.

发送评论 编辑评论


				
|´・ω・)ノ
ヾ(≧∇≦*)ゝ
(☆ω☆)
(╯‵□′)╯︵┴─┴
 ̄﹃ ̄
(/ω\)
∠( ᐛ 」∠)_
(๑•̀ㅁ•́ฅ)
→_→
୧(๑•̀⌄•́๑)૭
٩(ˊᗜˋ*)و
(ノ°ο°)ノ
(´இ皿இ`)
⌇●﹏●⌇
(ฅ´ω`ฅ)
(╯°A°)╯︵○○○
φ( ̄∇ ̄o)
ヾ(´・ ・`。)ノ"
( ง ᵒ̌皿ᵒ̌)ง⁼³₌₃
(ó﹏ò。)
Σ(っ °Д °;)っ
( ,,´・ω・)ノ"(´っω・`。)
╮(╯▽╰)╭
o(*////▽////*)q
>﹏<
( ๑´•ω•) "(ㆆᴗㆆ)
😂
😀
😅
😊
🙂
🙃
😌
😍
😘
😜
😝
😏
😒
🙄
😳
😡
😔
😫
😱
😭
💩
👻
🙌
🖕
👍
👫
👬
👭
🌚
🌝
🙈
💊
😶
🙏
🍦
🍉
😣
Source: github.com/k4yt3x/flowerhd
颜文字
Emoji
小恐龙
花!
上一篇