自定义注解

1. 自定义注解

当用户在查询的时候，要求用户必须是登录状态。就应该让用户登录，所以在此我们自定义一个注解来表示访问此功能时必须要登录。

注解作用：哪些需要登录才能访问必须要添加，那些需要获取到用户Id控制层方法也必须加这个注解.


import java.lang.annotation.*;

/**
 * 自定义注解：该注解被使用到web层controller方法上，用与验证用户认证状态
 * 元注解：
 * @Target：注解使用位置，可选：类/接口/注解、方法、属性、方法参数、构造等
 * @Retention：注解声明周期（注解会保留到什么阶段）可选：SOURCE、CLASS、RUNNTIME 选择CLASS该注解在运行时没了
 * @Inherited：该注解是否可以被继承
 * @Documented：通过JDK提供javadoc命令产生文档，是否会生成该注解文档
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Login {

    /**
     * 是否必须登录，默认为：必须登录
     * @return
     */
    boolean required() default true;


}

1.1 切面类

RequestContextHolder类持有上下文的Request容器。

RequestContextHolder是Spring框架提供的一个用于管理请求上下文的工具类。它允许在应用程序的任何地方访问当前的HTTP请求和响应信息，而不需要将这些对象显式地传递给每个需要它们的方法或对象

request和response等是什么时候设置进去的?

springMVC 核心类DispatcherServlet 继承关系

自定义切面类

import com.atguigu.tingshu.common.constant.RedisConstant;
import com.atguigu.tingshu.common.execption.GuiguException;
import com.atguigu.tingshu.common.result.ResultCodeEnum;
import com.atguigu.tingshu.common.util.AuthContextHolder;
import com.atguigu.tingshu.vo.user.UserInfoVo;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;


@Slf4j
@Aspect //声明切面类
@Component //将切面类对象注册到IOC容器
public class LoginAspect {

    @Autowired
    private RedisTemplate redisTemplate;

    /**
     * 验证登录状态、获取用户ID通知逻辑
     *
     * @param joinPoint  切点方法对象
     * @param Login 自定义登录注解
     * @return
     * execution(* com.包名.包名.*.api.*.*(..)) && @annotation(Login)
     *  这是一个AOP（面向切面编程）的注解，用于定义一个环绕通知。它表示在执行com.包名.包名 包下的所有类      *    中，所有带有@Login注解的方法时，都会触发这个环绕通知。
     */
    @SneakyThrows //动态生成try catch(Throwable)
    @Around("execution(* com.atguigu.tingshu.*.api.*.*(..)) && @annotation(guiGuLogin)")
    public Object loginAspect(ProceedingJoinPoint joinPoint, GuiGuLogin guiGuLogin) {
        Object resultObject = new Object();
        log.info("前置通知...");

        //1.获取小程序端（客户端）提交令牌Token
        //1.1 通过请求上下文对象RequestContextHolder获取请求属性对象 - 普通类中获取到请求对象
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        //1.2 将RequestAttributes（接口）转为ServletRequestAttributes（实现类）
        ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) requestAttributes;
        //1.3 获取请求对象
        HttpServletRequest request = servletRequestAttributes.getRequest();
        //HttpServletResponse response = servletRequestAttributes.getResponse();

        //1.4 基于请求对象获取请求头：token
        String token = request.getHeader("token");

        //2.查询存放在Redis中用户信息（何时存入：登录成功后）
        //2.1 构建用户登录信息key
        String loginKey = RedisConstant.USER_LOGIN_KEY_PREFIX + token;
        //2.2 查询存入Redis中用户信息
        UserInfoVo UserInfoVo = (UserInfoVo) redisTemplate.opsForValue().get(loginKey);

        //3.判断注解是否要求必须登录，如果要求登录且用户信息为空，抛出异常业务状态：208引导用户登录
        if (Login.required() && UserInfoVo == null) {
            //抛异常
        }

        //4.如果用户信息存在，将用户ID存入ThreadLocal
        if (UserInfoVo != null) {
            AuthContextHolder.setUserId(UserInfoVo.getId());
        }
        //二、执行目标方法
        resultObject = joinPoint.proceed();

        //5.将ThreaLocal中数据手动清理避免OOM出现
        AuthContextHolder.removeUserId();
        log.info("后置通知...");
        return resultObject;
    }
}

在查看专辑列表的时候，添加注解。在点击查看专辑列表的时候，就会提示我们需要进行登录！

1.2 使用认证校验注解

在所有业务微服务中，com.包名.包名.*.api.XXXXController类中下所有需要登录才可以访问方法上加注解@Login 以下接口测试需要完成登录代码后才进行测试

1. 自定义注解

1.1 切面类

1.2 使用认证校验注解

xiaoyouyu

叨叨几句...