feat:新增用户管理批量导入功能

Author: insistence

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

@@ -153,7 +153,7 @@ async def change_system_user_profile_info(request: Request, edit_user: AddUserMo
 
 @userController.patch("/user/profile/resetPwd", response_model=CrudUserResponse, dependencies=[Depends(CheckUserInterfaceAuth('common'))])
 @log_decorator(title='个人信息', business_type=2)
-async def reset_system_user_password(request: Request, reset_user: ResetUserModel,  query_db: Session = Depends(get_db), current_user: CurrentUserInfoServiceResponse = Depends(get_current_user)):
+async def reset_system_user_password(request: Request, reset_user: ResetUserModel, query_db: Session = Depends(get_db), current_user: CurrentUserInfoServiceResponse = Depends(get_current_user)):
     try:
         if not reset_user.user_id and reset_user.old_password:
             reset_user.user_id = current_user.user.user_id
@@ -172,6 +172,33 @@ async def reset_system_user_password(request: Request, reset_user: ResetUserMode
         return response_500(data="", message=str(e))
 
 
+@userController.post("/user/importData", dependencies=[Depends(CheckUserInterfaceAuth('system:user:import'))])
+@log_decorator(title='用户管理', business_type=6)
+async def batch_import_system_user(request: Request, user_import: ImportUserModel, query_db: Session = Depends(get_db), current_user: CurrentUserInfoServiceResponse = Depends(get_current_user)):
+    try:
+        batch_import_result = UserService.batch_import_user_services(query_db, user_import, current_user)
+        if batch_import_result.is_success:
+            logger.info(batch_import_result.message)
+            return response_200(data=batch_import_result, message=batch_import_result.message)
+        else:
+            logger.warning(batch_import_result.message)
+            return response_400(data="", message=batch_import_result.message)
+    except Exception as e:
+        logger.exception(e)
+        return response_500(data="", message=str(e))
+
+
+@userController.post("/user/importTemplate", dependencies=[Depends(CheckUserInterfaceAuth('system:user:import'))])
+async def export_system_user_template(request: Request, query_db: Session = Depends(get_db)):
+    try:
+        user_import_template_result = UserService.get_user_import_template_services()
+        logger.info('获取成功')
+        return streaming_response_200(data=bytes2file_response(user_import_template_result))
+    except Exception as e:
+        logger.exception(e)
+        return response_500(data="", message=str(e))
+
+
 @userController.post("/user/export", dependencies=[Depends(CheckUserInterfaceAuth('system:user:export'))])
 @log_decorator(title='用户管理', business_type=5)
 async def export_system_user_list(request: Request, user_query: UserQueryModel, query_db: Session = Depends(get_db)):

dash-fastapi-backend/module_admin/entity/vo/user_vo.py

@@ -213,6 +213,14 @@ class DeleteUserModel(BaseModel):
     update_time: Optional[str]
 
 
+class ImportUserModel(BaseModel):
+    """
+    批量导入用户模型
+    """
+    url: str
+    is_update: bool
+
+
 class CrudUserResponse(BaseModel):
     """
     操作用户响应模型

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

@@ -1,7 +1,7 @@
 from module_admin.entity.vo.user_vo import *
 from module_admin.dao.user_dao import *
 from utils.pwd_util import *
-from utils.common_util import export_list2excel
+from utils.common_util import *
 
 
 class UserService:
@@ -173,6 +173,98 @@ def reset_user_services(cls, result_db: Session, page_object: ResetUserModel):
 
         return CrudUserResponse(**result)
 
+    @classmethod
+    def batch_import_user_services(cls, result_db: Session, user_import: ImportUserModel, current_user: CurrentUserInfoServiceResponse):
+        """
+        批量导入用户service
+        :param user_import: 用户导入参数对象
+        :param result_db: orm对象
+        :param current_user: 当前用户对象
+        :return: 批量导入用户结果
+        """
+        header_dict = {
+            "部门编号": "dept_id",
+            "登录名称": "user_name",
+            "用户名称": "nick_name",
+            "用户邮箱": "email",
+            "手机号码": "phonenumber",
+            "用户性别": "sex",
+            "帐号状态": "status"
+        }
+        filepath = get_filepath_from_url(user_import.url)
+        df = pd.read_excel(filepath)
+        df.rename(columns=header_dict, inplace=True)
+        add_error_result = []
+        count = 0
+        try:
+            for index, row in df.iterrows():
+                count = count + 1
+                if row['sex'] == '男':
+                    row['sex'] = '0'
+                if row['sex'] == '女':
+                    row['sex'] = '1'
+                if row['sex'] == '未知':
+                    row['sex'] = '2'
+                if row['status'] == '正常':
+                    row['status'] = '0'
+                if row['status'] == '停用':
+                    row['status'] = '1'
+                add_user = UserModel(
+                    **dict(
+                        dept_id=row['dept_id'],
+                        user_name=row['user_name'],
+                        password=PwdUtil.get_password_hash('123456'),
+                        nick_name=row['nick_name'],
+                        email=row['email'],
+                        phonenumber=row['phonenumber'],
+                        sex=row['sex'],
+                        status=row['status'],
+                        create_by=current_user.user.user_name,
+                        update_by=current_user.user.user_name
+                    )
+                )
+                user_info = UserDao.get_user_by_info(result_db, UserModel(**dict(user_name=row['user_name'])))
+                if user_info:
+                    if user_import.is_update:
+                        edit_user = UserModel(
+                            **dict(
+                                user_id=user_info.user_id,
+                                dept_id=row['dept_id'],
+                                user_name=row['user_name'],
+                                nick_name=row['nick_name'],
+                                email=row['email'],
+                                phonenumber=row['phonenumber'],
+                                sex=row['sex'],
+                                status=row['status'],
+                                update_by=current_user.user.user_name
+                            )
+                        ).dict(exclude_unset=True)
+                        UserDao.edit_user_dao(result_db, edit_user)
+                    else:
+                        add_error_result.append(f"{count}.用户账号{row['user_name']}已存在")
+                else:
+                    UserDao.add_user_dao(result_db, add_user)
+            result_db.commit()
+            result = dict(is_success=True, message='\n'.join(add_error_result))
+        except Exception as e:
+            result_db.rollback()
+            result = dict(is_success=False, message=str(e))
+
+        return CrudUserResponse(**result)
+
+    @staticmethod
+    def get_user_import_template_services():
+        """
+        获取用户导入模板service
+        :return: 用户导入模板excel的二进制数据
+        """
+        header_list = ["部门编号", "登录名称", "用户名称", "用户邮箱", "手机号码", "用户性别", "帐号状态"]
+        selector_header_list = ["用户性别", "帐号状态"]
+        option_list = [{"用户性别": ["男", "女", "未知"]}, {"帐号状态": ["正常", "停用"]}]
+        binary_data = get_excel_template(header_list=header_list, selector_header_list=selector_header_list, option_list=option_list)
+
+        return binary_data
+
     @staticmethod
     def export_user_list_services(user_list: List):
         """

dash-fastapi-backend/utils/common_util.py

@@ -1,5 +1,11 @@
 import pandas as pd
 import io
+import os
+from openpyxl import Workbook
+from openpyxl.styles import Alignment, PatternFill
+from openpyxl.utils import get_column_letter
+from openpyxl.worksheet.datavalidation import DataValidation
+from config.env import CachePathConfig
 
 
 def worship():
@@ -65,3 +71,76 @@ def export_list2excel(list_data: list):
     binary_data = binary_data.getvalue()
 
     return binary_data
+
+
+def get_excel_template(header_list: list, selector_header_list: list, option_list: list[dict]):
+    """
+    工具方法：将需要导出的list数据转化为对应excel的二进制数据
+    :param header_list: 表头数据列表
+    :param selector_header_list: 需要设置为选择器格式的表头数据列表
+    :param option_list: 选择器格式的表头预设的选项列表
+    :return: 模板excel的二进制数据
+    """
+    # 创建Excel工作簿
+    wb = Workbook()
+    # 选择默认的活动工作表
+    ws = wb.active
+
+    # 设置表头文字
+    headers = header_list
+
+    # 设置表头背景样式为灰色，前景色为白色
+    header_fill = PatternFill(start_color="ababab", end_color="ababab", fill_type="solid")
+
+    # 将表头写入第一行
+    for col_num, header in enumerate(headers, 1):
+        cell = ws.cell(row=1, column=col_num)
+        cell.value = header
+        cell.fill = header_fill
+        # 设置列宽度为16
+        ws.column_dimensions[chr(64 + col_num)].width = 12
+        # 设置水平居中对齐
+        cell.alignment = Alignment(horizontal='center')
+
+    # 设置选择器的预设选项
+    options = option_list
+
+    # 获取selector_header的字母索引
+    for selector_header in selector_header_list:
+        column_selector_header_index = headers.index(selector_header) + 1
+
+        # 创建数据有效性规则
+        header_option = []
+        for option in options:
+            if option.get(selector_header):
+                header_option = option.get(selector_header)
+        dv = DataValidation(type="list", formula1=f'"{",".join(header_option)}"')
+        # 设置数据有效性规则的起始单元格和结束单元格
+        dv.add(
+            f'{get_column_letter(column_selector_header_index)}2:{get_column_letter(column_selector_header_index)}1048576')
+        # 添加数据有效性规则到工作表
+        ws.add_data_validation(dv)
+
+    # 保存Excel文件为字节类型的数据
+    file = io.BytesIO()
+    wb.save(file)
+    file.seek(0)
+
+    # 读取字节数据
+    excel_data = file.getvalue()
+
+    return excel_data
+
+
+def get_filepath_from_url(url: str):
+    """
+    工具方法：根据请求参数获取文件路径
+    :param url: 请求参数中的url参数
+    :return: 文件路径
+    """
+    file_info = url.split("?")[1].split("&")
+    task_id = file_info[0].split("=")[1]
+    file_name = file_info[1].split("=")[1]
+    filepath = os.path.join(CachePathConfig.PATH, task_id, file_name)
+
+    return filepath

dash-fastapi-frontend/api/user.py

@@ -46,6 +46,16 @@ def reset_user_password_api(page_obj: dict):
     return api_request(method='patch', url='/system/user/profile/resetPwd', is_headers=True, json=page_obj)
 
 
+def batch_import_user_api(page_obj: dict):
+
+    return api_request(method='post', url='/system/user/importData', is_headers=True, json=page_obj)
+
+
+def download_user_import_template_api():
+
+    return api_request(method='post', url='/system/user/importTemplate', is_headers=True, stream=True)
+
+
 def export_user_list_api(page_obj: dict):
 
     return api_request(method='post', url='/system/user/export', is_headers=True, json=page_obj, stream=True)

dash-fastapi-frontend/callbacks/login_c.py

@@ -52,7 +52,7 @@ def login_auth(nClicks, username, password, input_captcha, session_id, image_cli
                         None,
                         None,
                         dash.no_update,
-                        True,
+                        False,
                         token,
                         dcc.Location(
                             pathname='/',