feat&perf: 菜单管理模块vo层优化，新增字段校验

ruoyi-fastapi-backend/module_admin/entity/vo/menu_vo.py

@@ -1,8 +1,9 @@
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, ConfigDict, Field
 from pydantic.alias_generators import to_camel
 from datetime import datetime
-from typing import Union, Optional, List
+from typing import Union, Optional, List, Literal
 from module_admin.annotation.pydantic_annotation import as_query
+from module_admin.annotation.validate_annotation import NotBlank, Size
 
 
 class MenuModel(BaseModel):
@@ -11,25 +12,58 @@ class MenuModel(BaseModel):
     """
     model_config = ConfigDict(alias_generator=to_camel, from_attributes=True)
 
-    menu_id: Optional[int] = None
-    menu_name: Optional[str] = None
-    parent_id: Optional[int] = None
-    order_num: Optional[int] = None
-    path: Optional[str] = None
-    component: Optional[str] = None
-    query: Optional[str] = None
-    is_frame: Optional[int] = None
-    is_cache: Optional[int] = None
-    menu_type: Optional[str] = None
-    visible: Optional[str] = None
-    status: Optional[str] = None
-    perms: Optional[str] = None
-    icon: Optional[str] = None
-    create_by: Optional[str] = None
-    create_time: Optional[datetime] = None
-    update_by: Optional[str] = None
-    update_time: Optional[datetime] = None
-    remark: Optional[str] = None
+    menu_id: Optional[int] = Field(default=None, description='菜单ID')
+    menu_name: Optional[str] = Field(default=None, description='菜单名称')
+    parent_id: Optional[int] = Field(default=None, description='父菜单ID')
+    order_num: Optional[int] = Field(default=None, description='显示顺序')
+    path: Optional[str] = Field(default=None, description='路由地址')
+    component: Optional[str] = Field(default=None, description='组件路径')
+    query: Optional[str] = Field(default=None, description='路由参数')
+    is_frame: Optional[Literal[0, 1]] = Field(default=None, description='是否为外链（0是 1否）')
+    is_cache: Optional[Literal[0, 1]] = Field(default=None, description='是否缓存（0缓存 1不缓存）')
+    menu_type: Optional[Literal['M', 'C', 'F']] = Field(default=None, description='菜单类型（M目录 C菜单 F按钮）')
+    visible: Optional[Literal['0', '1']] = Field(default=None, description='菜单状态（0显示 1隐藏）')
+    status: Optional[Literal['0', '1']] = Field(default=None, description='菜单状态（0正常 1停用）')
+    perms: Optional[str] = Field(default=None, description='权限标识')
+    icon: Optional[str] = Field(default=None, description='菜单图标')
+    create_by: Optional[str] = Field(default=None, description='创建者')
+    create_time: Optional[datetime] = Field(default=None, description='创建时间')
+    update_by: Optional[str] = Field(default=None, description='更新者')
+    update_time: Optional[datetime] = Field(default=None, description='更新时间')
+    remark: Optional[str] = Field(default=None, description='备注')
+
+    @NotBlank(field_name='menu_name', message='菜单名称不能为空')
+    @Size(field_name='menu_name', min_length=0, max_length=50, message='菜单名称长度不能超过50个字符')
+    def get_menu_name(self):
+        return self.menu_name
+
+    @NotBlank(field_name='order_num', message='显示顺序不能为空')
+    def get_order_num(self):
+        return self.order_num
+
+    @Size(field_name='path', min_length=0, max_length=200, message='路由地址长度不能超过200个字符')
+    def get_path(self):
+        return self.path
+
+    @Size(field_name='component', min_length=0, max_length=255, message='组件路径长度不能超过255个字符')
+    def get_component(self):
+        return self.component
+
+    @NotBlank(field_name='menu_type', message='菜单类型不能为空')
+    def get_menu_type(self):
+        return self.menu_type
+
+    @Size(field_name='perms', min_length=0, max_length=100, message='权限标识长度不能超过100个字符')
+    def get_perms(self):
+        return self.perms
+
+    def validate_fields(self):
+        self.get_menu_name()
+        self.get_order_num()
+        self.get_path()
+        self.get_component()
+        self.get_menu_type()
+        self.get_perms()
 
 
 @as_query
@@ -37,8 +71,8 @@ class MenuQueryModel(MenuModel):
     """
     菜单管理不分页查询模型
     """
-    begin_time: Optional[str] = None
-    end_time: Optional[str] = None
+    begin_time: Optional[str] = Field(default=None, description='开始时间')
+    end_time: Optional[str] = Field(default=None, description='结束时间')
 
 
 class DeleteMenuModel(BaseModel):
@@ -47,4 +81,4 @@ class DeleteMenuModel(BaseModel):
     """
     model_config = ConfigDict(alias_generator=to_camel)
 
-    menu_ids: str
+    menu_ids: str = Field(description='需要删除的菜单ID')