SpringBoot中使用AOP切面編程實現(xiàn)登錄攔截功能

更新時間：2024年12月24日 11:40:15 作者：自律的kkk

本文介紹了如何使用AOP切面編程實現(xiàn)Spring Boot中的登錄攔截,通過實例代碼給大家介紹的非常詳細,感興趣的朋友一起看看吧

使用AOP切面編程實現(xiàn)登錄攔截

1. 首先實現(xiàn)一個登錄注冊功能

以下代碼僅供參考

控制層

@RestController
@RequestMapping("/user")
public class UserController {
    @Autowired
    private UserService userService;
    @PostMapping("/register")
    public Result register(@RequestBody UserDto userDto) {
        userService.addUser(userDto);
        return Result.success("注冊成功");
    }
    @PostMapping("/login")
    public Result<UserLoginVo> login(@RequestBody UserDto userDto) {
        UserLoginVo userLoginVo = userService.login(userDto);
        return Result.success(userLoginVo);
    }
}

業(yè)務層

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private UserMapper userMapper;
    @Resource
    private RedisTemplate<String,String> redisTemplate;
    /**
     * 新增用戶/注冊
     * @param userDto
     */
    public void addUser(UserDto userDto) {
        User user = userMapper.selectByUserName(userDto.getUsername());
        if (user != null) {
            throw new BusinessException(ResponseCodeEnum.CODE_601);
        }
        user = new User();
        BeanUtils.copyProperties(userDto, user);
        user.setCreateTime(new Date());
        user.setLoginTime(new Date());
        userMapper.insert(user);
    }
    @Override
    public UserLoginVo login(UserDto userDto) {
        User user = userMapper.selectByUserNameAndPassword(userDto.getUsername(),userDto.getPassword());
        if (user == null) {
            throw new BusinessException("用戶名或密碼錯誤");
        }
        String token = UUID.randomUUID().toString();
        redisTemplate.opsForValue().set("loginDemo:user:token:" + token, user.getId().toString());
        UserLoginVo userLoginVo = new UserLoginVo();
        userLoginVo.setUser(user);
        userLoginVo.setToken(token);
        return userLoginVo;
    }
}

mapper層

@Mapper
public interface UserMapper extends BaseMapper<User>{
    void addUser(User user);
    @Select("select * from user where username = #{username}")
    User selectByUserName(String username);
    User selectByUserNameAndPassword(String username,String password);
}

UserMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.kkk.mapper.UserMapper">
    <insert id="addUser">
        INSERT INTO user (
            username,
            password,
            email
        ) VALUES (
                     #{username},
                     #{password},
                     #{email}
                 )
    </insert>
    <select id="selectByUserNameAndPassword" resultType="com.kkk.domain.entity.User">
        select * from user
        <where>
            <if test="username != null and username != ''">
                and user.username = #{username}
            </if>
            <if test="password != null and password != ''">
                and user.password = #{password}
            </if>
        </where>
    </select>
</mapper>

以上代碼僅供參考，具體邏輯可以根據(jù)自己的業(yè)務來實現(xiàn)

2. 補充介紹

以上提供的示例代碼邏輯大致為用戶登錄后根據(jù)UUID生成一個token，接著將token作為唯一標識鍵存入redis緩存中，值為用戶id，之后可以根據(jù)用戶請求頭中的token去redis中獲取用戶id，當然你也可以根據(jù)自己的實際需求來。

3.AOP切面編程實現(xiàn)登錄攔截校驗

首先目錄結構如圖所示

GlobalInterceptor類

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface GlobalInterceptor {
    /**
     * 校驗登錄
     *
     * @return
     */
    boolean checkLogin() default true;
    /**
     * 校驗管理員
     *
     * @return
     */
    boolean checkAdmin() default false;
}

GlobalOperationAspect類

@Component("operationAspect")
@Aspect
public class GlobalOperationAspect {
    @Resource
    private RedisTemplate<String,String> redisTemplate;
    @Resource
    private UserMapper userMapper;
    private static Logger logger = LoggerFactory.getLogger(GlobalOperationAspect.class);
    @Before("@annotation(com.kkk.annotation.GlobalInterceptor)")
    public void interceptorDo(JoinPoint point) {
        try {
            Method method = ((MethodSignature) point.getSignature()).getMethod();
            GlobalInterceptor interceptor = method.getAnnotation(GlobalInterceptor.class);
            if (null == interceptor) {
                return;
            }
            /**
             * 校驗登錄
             */
            if (interceptor.checkLogin() || interceptor.checkAdmin()) {
                checkLogin(interceptor.checkAdmin());
            }
        } catch (BusinessException e) {
            logger.error("全局攔截器異常", e);
            throw e;
        } catch (Exception e) {
            logger.error("全局攔截器異常", e);
            throw new BusinessException(ResponseCodeEnum.CODE_500);
        } catch (Throwable e) {
            logger.error("全局攔截器異常", e);
            throw new BusinessException(ResponseCodeEnum.CODE_500);
        }
    }
    //校驗登錄
    private void checkLogin(Boolean checkAdmin) {
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        String token = request.getHeader("token");
        String value = redisTemplate.opsForValue().get("loginDemo:user:token:"+token);
        if (value == null) {
            throw new BusinessException("登錄超時");
        }
        Long userId = Long.valueOf(value);
        User user = userMapper.selectById(userId);
        if (user == null) {
            throw new BusinessException("請求參數(shù)錯誤，請聯(lián)系管理員");
        }
        if (checkAdmin) {
            // 校驗是否為管理員操作權限
            // 后續(xù)處理
        }
    }
}

接下來只需要在需要攔截的接口處添加自定義注解就可以了

如：

@RestController
@RequestMapping("/test")
public class TestController {
    @GlobalInterceptor
    @GetMapping("/test")
    public String test() {
        return "ok";
    }
}