提交

yami-shop-security/yami-shop-security-common/src/main/java/com/yami/shop/security/common/dto/AuthenticationDTO.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2018-2999 广州市蓝海创新科技有限公司 All rights reserved.
+ *
+ * https://www.mall4j.com/
+ *
+ * 未经允许，不可做商业用途！
+ *
+ * 版权所有，侵权必究！
+ */
+
+package com.yami.shop.security.common.dto;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Data;
+import jakarta.validation.constraints.NotBlank;
+
+/**
+ * 这个类是数据传输对象（DTO），主要用于在登录操作时传递账号和密码相关的信息。
+ * 它在系统的安全模块中扮演着重要角色，作为客户端与服务端之间传递登录凭证的载体，方便对登录信息进行统一的校验、处理和传递。
+ *
+ * @author 菠萝凤梨
+ * @date 2022/3/25 17:33
+ */
+@Data
+public class AuthenticationDTO {
+
+    /**
+     * 用于存储用户登录时输入的用户名信息。
+     * 这里的用户名可以是实际的用户名，也可以是用户注册时关联的邮箱地址或者手机号等能够唯一标识用户身份的信息，具体取决于系统的业务逻辑和认证规则。
+     * 并且通过 @NotBlank 注解进行了校验约束，要求该字段不能为空，若为空则会根据注解中配置的提示信息（"userName不能为空"）给出相应的错误提示。
+     * 同时使用 @Schema 注解在 API 文档相关的生成（如 Swagger 等工具生成 API 文档时）中描述该字段，表明它代表用户名/邮箱/手机号，且是必填项。
+     */
+    @NotBlank(message = "userName不能为空")
+    @Schema(description = "用户名/邮箱/手机号", required = true)
+    protected String userName;
+
+    /**
+     * 用于存储用户登录时输入的密码信息。
+     * 此密码是用户在注册账号或者设置安全凭证时设定的，用于验证用户身份合法性的关键信息之一。
+     * 同样受到 @NotBlank 注解的约束，不能为空，若为空会提示 "passWord不能为空" 的错误信息。
+     * @Schema 注解用于在 API 文档生成时描述该字段，表示一般用作密码，且是必填项。
+     */
+    @NotBlank(message = "passWord不能为空")
+    @Schema(description = "一般用作密码", required = true)
+    protected String passWord;
+
+}