perf:增加自定义登录异常类，统一监测返回所有异常登录信息

Author: insistence

dash-fastapi-backend/app.py

@@ -22,7 +22,7 @@
 from config.get_redis import RedisUtil
 from config.get_db import init_create_table
 from config.get_scheduler import SchedulerUtil
-from utils.response_util import response_401, AuthException
+from utils.response_util import *
 from utils.log_util import logger
 from utils.common_util import worship
 
@@ -71,6 +71,12 @@ async def auth_exception_handler(request: Request, exc: AuthException):
     return response_401(data=exc.data, message=exc.message)
 
 
+# 自定义登录检验异常
+@app.exception_handler(LoginException)
+async def login_exception_handler(request: Request, exc: LoginException):
+    return response_400(data=exc.data, message=exc.message)
+
+
 @app.exception_handler(HTTPException)
 async def http_exception_handler(request: Request, exc: HTTPException):
     return JSONResponse(

dash-fastapi-backend/module_admin/controller/log_controller.py

@@ -134,7 +134,7 @@ async def clear_system_login_log(request: Request, clear_login_log: ClearLoginLo
         return response_500(data="", message=str(e))
 
 
-@logController.post("/login/unlock", response_model=CrudLogResponse, dependencies=[Depends(CheckUserInterfaceAuth('monitor:logininfor:remove'))])
+@logController.post("/login/unlock", response_model=CrudLogResponse, dependencies=[Depends(CheckUserInterfaceAuth('monitor:logininfor:unlock'))])
 @log_decorator(title='登录日志管理', business_type=9)
 async def clear_system_login_log(request: Request, unlock_user: UnlockUser, query_db: Session = Depends(get_db)):
     try:

dash-fastapi-backend/module_admin/controller/login_controller.py

@@ -17,38 +17,29 @@
 @loginController.post("/loginByAccount", response_model=Token)
 @log_decorator(title='用户登录', business_type=0, log_type='login')
 async def login(request: Request, user: UserLogin, query_db: Session = Depends(get_db)):
+    result = await authenticate_user(request, query_db, user)
     try:
-        result = await authenticate_user(request, query_db, user)
-        if result in ['用户不存在', '密码错误', '用户已停用', '验证码已失效', '验证码错误', '账号已锁定，请稍后再试', '10分钟内密码已输错超过5次，账号已锁定，请10分钟后再试']:
-            logger.warning(result)
-            return response_400(data="", message=result)
-
-        else:
-            access_token_expires = timedelta(minutes=JwtConfig.ACCESS_TOKEN_EXPIRE_MINUTES)
-            try:
-                session_id = str(uuid.uuid4())
-                access_token = create_access_token(
-                    data={
-                        "user_id": str(result[0].user_id),
-                        "user_name": result[0].user_name,
-                        "dept_name": result[1].dept_name,
-                        "session_id": session_id,
-                        "login_info": user.login_info
-                    },
-                    expires_delta=access_token_expires
-                )
-                await request.app.state.redis.set(f'access_token:{session_id}', access_token, ex=timedelta(minutes=30))
-                # 此方法可实现同一账号同一时间只能登录一次
-                # await request.app.state.redis.set(f'{result.user_id}_access_token', access_token, ex=timedelta(minutes=30))
-                # await request.app.state.redis.set(f'{result.user_id}_session_id', session_id, ex=timedelta(minutes=30))
-                logger.info('登录成功')
-                return response_200(
-                    data={'token': access_token},
-                    message='登录成功'
-                )
-            except Exception as e:
-                logger.exception(e)
-                return response_500(data="", message="生成token失败")
+        access_token_expires = timedelta(minutes=JwtConfig.ACCESS_TOKEN_EXPIRE_MINUTES)
+        session_id = str(uuid.uuid4())
+        access_token = create_access_token(
+            data={
+                "user_id": str(result[0].user_id),
+                "user_name": result[0].user_name,
+                "dept_name": result[1].dept_name,
+                "session_id": session_id,
+                "login_info": user.login_info
+            },
+            expires_delta=access_token_expires
+        )
+        await request.app.state.redis.set(f'access_token:{session_id}', access_token, ex=timedelta(minutes=30))
+        # 此方法可实现同一账号同一时间只能登录一次
+        # await request.app.state.redis.set(f'{result.user_id}_access_token', access_token, ex=timedelta(minutes=30))
+        # await request.app.state.redis.set(f'{result.user_id}_session_id', session_id, ex=timedelta(minutes=30))
+        logger.info('登录成功')
+        return response_200(
+            data={'token': access_token},
+            message='登录成功'
+        )
     except Exception as e:
         logger.exception(e)
         return response_500(data="", message=str(e))

dash-fastapi-backend/module_admin/service/login_service.py

@@ -109,15 +109,19 @@ async def authenticate_user(request: Request, query_db: Session, login_user: Use
     """
     account_lock = await request.app.state.redis.get(f"account_lock:{login_user.user_name}")
     if login_user.user_name == account_lock:
-        return '账号已锁定，请稍后再试'
+        logger.warning("账号已锁定，请稍后再试")
+        raise LoginException(data="", message="账号已锁定，请稍后再试")
     captcha_value = await request.app.state.redis.get(f'captcha_codes:{login_user.session_id}')
     if not captcha_value:
-        return '验证码已失效'
+        logger.warning("验证码已失效")
+        raise LoginException(data="", message="验证码已失效")
     if login_user.captcha != str(captcha_value):
-        return '验证码错误'
+        logger.warning("验证码错误")
+        raise LoginException(data="", message="验证码错误")
     user = login_by_account(query_db, login_user.user_name)
     if not user[0]:
-        return '用户不存在'
+        logger.warning("用户不存在")
+        raise LoginException(data="", message="用户不存在")
     if not verify_password(login_user.password, user[0].password):
         cache_password_error_count = await request.app.state.redis.get(f"password_error_count:{login_user.user_name}")
         password_error_counted = 0
@@ -128,10 +132,13 @@ async def authenticate_user(request: Request, query_db: Session, login_user: Use
         if password_error_count > 5:
             await request.app.state.redis.delete(f"password_error_count:{login_user.user_name}")
             await request.app.state.redis.set(f"account_lock:{login_user.user_name}", login_user.user_name, ex=timedelta(minutes=10))
-            return '10分钟内密码已输错超过5次，账号已锁定，请10分钟后再试'
-        return '密码错误'
+            logger.warning("10分钟内密码已输错超过5次，账号已锁定，请10分钟后再试")
+            raise LoginException(data="", message="10分钟内密码已输错超过5次，账号已锁定，请10分钟后再试")
+        logger.warning("密码错误")
+        raise LoginException(data="", message="密码错误")
     if user[0].status == '1':
-        return '用户已停用'
+        logger.warning("用户已停用")
+        raise LoginException(data="", message="用户已停用")
     await request.app.state.redis.delete(f"password_error_count:{login_user.user_name}")
     return user
 

dash-fastapi-backend/utils/response_util.py

@@ -79,3 +79,12 @@ class AuthException(Exception):
     def __init__(self, data: str = None, message: str = None):
         self.data = data
         self.message = message
+
+
+class LoginException(Exception):
+    """
+    自定义登录异常LoginException
+    """
+    def __init__(self, data: str = None, message: str = None):
+        self.data = data
+        self.message = message