提交

yami-shop-bean/src/main/java/com/yami/shop/bean/app/dto/IndexImgDto.java

@@ -0,0 +1,81 @@
+/*
+ * Copyright (c) 2018-2999 广州市蓝海创新科技有限公司 All rights reserved.
+ *
+ * https://www.mall4j.com/
+ *
+ * 未经允许，不可做商业用途！
+ *
+ * 版权所有，侵权必究！
+ */
+
+package com.yami.shop.bean.app.dto;
+
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.yami.shop.common.serializer.json.ImgJsonSerializer;
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Data;
+import java.util.Date;
+
+/**
+ * `IndexImgDto`类是一个数据传输对象（DTO），主要用于在电商系统应用层不同组件或模块之间传递首页图片相关的信息。
+ * 其作用是将首页图片的关键数据进行整合封装，使得在诸如首页图片展示配置、图片数据获取与传递等业务场景下，
+ * 数据的交互更加清晰、规范且符合业务需求，便于不同业务部分基于这些信息进行相应的操作，例如按照指定顺序展示图片、
+ * 根据类型筛选图片、依据关联ID查找相关联的其他业务对象等。
+
+ * @author lanhai
+ */
+@Schema(description = "首页图片对象")
+@Data
+public class IndexImgDto {
+
+    /**
+     * `imgUrl`属性用于存放首页图片的网络地址或者在系统中的存储路径等信息，具体取决于系统的图片存储和访问方式。
+     * 例如在使用云存储服务时，可能是该图片在云存储中的完整URL地址；若是本地存储，则可能是相对系统根目录的文件路径。
+     * 这个属性是展示首页图片的关键数据，前端页面通过获取该 `imgUrl` 来准确显示对应的图片内容。
+     * 同时，借助 `@JsonSerialize(using = ImgJsonSerializer.class)` 注解，在将该类对象转换为JSON格式数据（如接口返回数据给前端时），
+     * 会使用自定义的序列化器对这个属性进行特殊处理，可能是对图片路径进行格式调整、添加域名等操作，使其符合前端展示或者与其他系统交互的要求。
+     * 通过 `@Schema` 注解明确其描述为“图片Url”且标记为必填项（`required = true`），确保在数据传递过程中该图片地址信息的完整性，
+     * 以便顺利实现图片展示功能。
+     */
+    @JsonSerialize(using = ImgJsonSerializer.class)
+    @Schema(description = "图片Url", required = true)
+    private String imgUrl;
+
+    /**
+     * `seq`属性代表首页图片的展示顺序，通常为整数类型，用于确定在首页展示图片时各个图片的先后排列次序。
+     * 可以按照业务需求设定相应的排序规则，比如较小的数值在前、较大的数值在后等，通过调整不同图片的 `seq` 值，
+     * 能够灵活地改变首页图片的展示顺序，实现对首页展示效果的个性化定制和优化。
+     * 通过 `@Schema` 注解将其描述为“图片顺序”并设定为必填项，保证在传递首页图片相关数据时，展示顺序信息不会缺失，
+     * 便于前端或其他业务模块按照正确的顺序展示图片。
+     */
+    @Schema(description = "图片顺序", required = true)
+    private Integer seq;
+
+    /**
+     * `uploadTime`属性记录的是首页图片的上传时间，以 `Date` 类型存储，格式一般遵循系统默认的时间格式（例如 `yyyy-MM-dd HH:mm:ss`）。
+     * 它在业务中有多方面的作用，比如可以用于数据的溯源，方便查看不同时间段内首页图片的更新情况；也能用于统计分析，
+     * 了解图片的上传频率等信息。通过 `@Schema` 注解标记其描述为“上传时间”且设为必填项，确保在图片数据传递过程中，
+     * 上传时间信息能够准确传达，有助于进行相关的数据管理和业务操作。
+     */
+    @Schema(description = "上传时间", required = true)
+    private Date uploadTime;
+
+    /**
+     * `type`属性用于区分首页图片的类型，一般通过不同的整数值来对应不同的图片分类。
+     * 例如，可以设定 `1` 表示商品推荐图片，`2` 表示活动宣传图片，`3` 表示店铺形象展示图片等。
+     * 通过这种分类方式，在业务逻辑中能够针对不同类型的图片进行差异化的处理和展示，比如不同类型图片展示在首页的不同位置、
+     * 采用不同的展示样式等，也便于进行分类管理和统计分析等操作。
+     * 通过 `@Schema` 注解明确其描述为“类型”且设为必填项，保证传递图片数据时类型信息的完整性，便于后续根据类型进行相应的业务处理。
+     */
+    @Schema(description = "类型", required = true)
+    private int type;
+
+    /**
+     * `relation`属性用于存放与首页图片相关联的其他数据的唯一标识符，比如可能关联到某个商品的 `id`、某个活动的 `id` 等，
+     * 其具体含义取决于业务场景中图片与其他实体的关联关系设定。通过这个属性可以建立起图片与其他业务对象之间的联系，
+     * 在进行相关业务操作时，例如根据图片查找关联商品、获取关联活动详情等，就可以依据这个 `relation` 值来获取对应的关联数据。
+     * 通过 `@Schema` 注解将其描述为“关联id”并设为必填项，确保在传递图片信息时，关联ID信息准确无误，方便后续基于关联关系开展业务操作。
+     */
+    @Schema(description = "关联id", required = true)
+    private Long relation;
+}

yami-shop-bean/src/main/java/com/yami/shop/bean/app/param/LoginParam.java

@@ -0,0 +1,104 @@
+/*
+ * Copyright (c) 2018-2999 广州市蓝海创新科技有限公司 All rights reserved.
+ *
+ * https://www.mall4j.com/
+ *
+ * 未经允许，不可做商业用途！
+ *
+ * 版权所有，侵权必究！
+ */
+
+package com.yami.shop.bean.app.param;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+/**
+ * `LoginParam`类是一个用于接收用户登录相关操作参数的数据对象，在电商系统用户登录的业务逻辑处理中起着关键作用。
+ * 它主要用于在前端与后端进行交互时，承载用户发起登录操作时所需的各项必要数据信息，以便后端能够依据这些参数准确地执行相应的业务逻辑，
+ * 比如验证登录信息的合法性、根据不同的登录方式（小程序登录或账号密码登录）进行对应的身份验证等操作。
+
+ * @author lanhai
+ */
+@Schema(description = "登陆参数")
+public class LoginParam {
+
+	/**
+	 * `code`属性用于存储小程序登录时返回的 `code` 值。在小程序登录的流程中，用户授权登录后，小程序会向微信等平台获取一个临时的 `code`，
+	 * 这个 `code` 会被传递到后端服务器，后端再凭借该 `code` 向对应的平台（如微信开放平台）发起请求，换取用户的相关信息（如唯一标识等），
+	 * 进而完成登录验证操作。通过 `@Schema` 注解明确其描述为“小程序登陆时返回的 `code`（使用 `code` 登陆必填）”，
+	 * 并标记为必填项（`required = true`），以此确保在用户选择小程序登录方式时，前端必须传递这个关键的 `code` 参数给后端，
+	 * 保证登录流程能够顺利进行，避免因缺少必要参数而导致登录失败。
+	 */
+	@Schema(description = "小程序登陆时返回的code(使用code登陆必填)", required = true)
+	private String code;
+
+	/**
+	 * `mobile`属性用于存放用户登录时的用户名信息，在采用账号密码登录方式时，这里通常指的是用户的手机号码。
+	 * 手机号码作为常见的账号形式，方便用户记忆且具有唯一性，后端系统会依据这个手机号码去数据库等存储介质中查找对应的用户记录，
+	 * 并与后续传入的密码进行匹配验证，以确认用户身份的合法性。通过 `@Schema` 注解将其描述为“登陆时的用户名（账号密码登陆必填）”，
+	 * 同时设为必填项，告知接口调用者在使用账号密码登录时必须提供有效的手机号码作为用户名，保障登录验证过程有准确的账号依据。
+	 */
+	@Schema(description = "登陆时的用户名(账号密码登陆必填)", required = true)
+	private String mobile;
+
+	/**
+	 * `password`属性用于存储用户登录时输入的密码信息，在账号密码登录模式下，它与前面的 `mobile` 属性一同作为验证用户身份的关键要素。
+	 * 用户输入的密码会与后端存储的已加密的密码（出于安全考虑，通常会对密码进行加密存储）进行比对，只有两者匹配时，
+	 * 才会认定用户登录成功。借助 `@Schema` 注解明确其描述为“登陆时的密码（账号密码登陆必填）”，并标记为必填项，
+	 * 强制要求接口调用者在使用账号密码登录方式时必须提供正确的密码，确保登录操作的安全性和准确性。
+	 */
+	@Schema(description = "登陆时的密码(账号密码登陆必填)", required = true)
+	private String password;
+
+	/**
+	 * `getCode`方法是一个标准的JavaBean风格的访问器方法（Getter方法），用于获取 `code` 属性的值。
+	 * 在其他类需要访问本类中存储的小程序登录 `code` 参数信息时，可以通过调用这个方法来获取相应的值，遵循了面向对象编程中封装的原则，
+	 * 对属性的访问进行了一定的控制，保证数据获取的规范性和安全性。
+	 */
+	public String getCode() {
+		return code;
+	}
+
+	/**
+	 * `setCode`方法是与 `getCode` 对应的修改器方法（Setter方法），用于设置 `code` 属性的值。
+	 * 当外部需要更新本类中存储的小程序登录 `code` 信息时，可以通过调用这个方法并传入新的字符串值来实现属性值的修改，
+	 * 同样也是遵循JavaBean规范，方便对属性进行赋值操作，同时在方法内部可以添加一些额外的逻辑（如数据验证等）来保障数据的合法性。
+	 */
+	public void setCode(String code) {
+		this.code = code;
+	}
+
+	/**
+	 * `getMobile`方法是用于获取 `mobile` 属性值的Getter方法，其作用与 `getCode` 类似，
+	 * 为外部类提供了获取用户名（手机号码）信息的途径，使得其他部分的代码可以按照规范的方式获取该属性存储的内容，便于后续基于用户名进行相关操作。
+	 */
+	public String getMobile() {
+		return mobile;
+	}
+
+	/**
+	 * `setMobile`方法是对应 `getMobile` 的Setter方法，用于设置 `mobile` 属性的值，
+	 * 当需要更新用户名（手机号码）信息时，外部代码可以调用这个方法传入新的字符串值来改变属性的存储内容，
+	 * 并且可以在方法内部根据业务需求添加必要的数据校验等逻辑，确保设置的手机号码符合要求。
+	 */
+	public void setMobile(String mobile) {
+		this.mobile = mobile;
+	}
+
+	/**
+	 * `getPassword`方法是获取 `password` 属性值的Getter方法，通过调用它，
+	 * 其他类能够获取到本类中存储的密码信息，方便在后续的业务逻辑中，例如密码验证等操作中使用该密码作为关键的比对依据，
+	 * 确保业务操作围绕准确的登录密码展开。
+	 */
+	public String getPassword() {
+		return password;
+	}
+
+	/**
+	 * `setPassword`方法是用于设置 `password` 属性值的Setter方法，当需要更新密码信息时（例如用户修改密码等情况），
+	 * 外部代码可以调用这个方法传入新的字符串值来改变其存储内容，同样也可以在方法内部添加适当的数据验证逻辑，保障密码的合法性和安全性。
+	 */
+	public void setPassword(String password) {
+		this.password = password;
+	}
+}

yami-shop-bean/src/main/java/com/yami/shop/bean/model/IndexImg.java

@@ -0,0 +1,129 @@
+/*
+ * Copyright (c) 2018-2999 广州市蓝海创新科技有限公司 All rights reserved.
+ *
+ * https://www.mall4j.com/
+ *
+ * 未经允许，不可做商业用途！
+ *
+ * 版权所有，侵权必究！
+ */
+
+package com.yami.shop.bean.model;
+
+import com.baomidou.mybatisplus.annotation.TableField;
+import com.baomidou.mybatisplus.annotation.TableId;
+import com.baomidou.mybatisplus.annotation.TableName;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.yami.shop.common.serializer.json.ImgJsonSerializer;
+import lombok.Data;
+import java.io.Serializable;
+import java.util.Date;
+
+/**
+ * `IndexImg`类是一个实体类，用于表示电商系统首页图片相关的信息，在首页展示、图片管理等业务场景中有着重要作用，
+ * 它主要负责在数据库层面记录首页图片的各项关键数据，方便后续进行诸如图片展示顺序调整、图片关联商品设置、
+ * 图片状态管理等操作。
+
+ * @author lanhai
+ */
+@Data
+@TableName("tz_index_img")
+public class IndexImg implements Serializable {
+    private static final long serialVersionUID = -3468251351681518798L;
+
+    /**
+     * `imgId`属性作为该类的主键，是每条首页图片记录在数据库中的唯一标识符。
+     * 它具有唯一性，通过这个 `imgId`，系统能够在数据库中精准地定位、操作某一条具体的首页图片相关记录，
+     * 比如在更新、删除特定首页图片信息或者根据该ID查询其详细属性时，都要依赖这个唯一标识来确保操作的准确性和针对性，
+     * 是整个首页图片数据管理中的关键标识字段。
+     */
+    @TableId
+    private Long imgId;
+
+    /**
+     * `shopId`属性用于标识该图片所属的店铺ID，在多店铺的电商平台模式下，不同店铺可能有各自独立的首页图片展示需求，
+     * 通过这个属性可以明确图片是与哪个店铺相关联，进而在展示首页图片时能够按照店铺进行区分和筛选，
+     * 同时在涉及店铺相关的图片管理操作（如店铺自行上传、修改、删除自己的首页图片等）时，也依靠这个ID来确定操作对象。
+     */
+    private Long shopId;
+
+    /**
+     * `imgUrl`属性存放的是图片的网络地址或者在系统中的存储路径等信息，具体取决于系统的图片存储和访问方式。
+     * 例如在使用云存储服务时，可能是该图片在云存储中的完整URL地址；若是本地存储，则可能是相对系统根目录的文件路径，
+     * 这个属性用于在前端页面展示首页图片时，准确获取并显示对应的图片内容，是实现图片展示功能的关键数据之一。
+     */
+    private String imgUrl;
+
+    /**
+     * `des`属性用于存储图片的说明文字或者描述信息，它可以对图片展示的内容、目的等进行简要介绍，
+     * 比如对于一张展示某款商品的图片，这里的描述可能是“新款夏季连衣裙，时尚优雅”之类的文字，帮助用户更好地理解图片所传达的信息，
+     * 同时在一些图片管理操作或者页面排版时，也可以参考这些描述来进行合理的布局和安排。
+     */
+    private String des;
+
+    /**
+     * `title`属性代表图片的标题，通常是一个简洁且能概括图片核心内容的字符串，
+     * 例如“热门商品推荐”“限时优惠活动”等，在前端展示图片时，标题可能会以一定的样式显示在图片上方或附近位置，
+     * 起到突出主题、吸引用户关注的作用，也是图片相关信息展示的重要组成部分。
+     */
+    private String title;
+
+    /**
+     * `link`属性存放的是图片所关联的链接地址，当用户点击首页图片时，会跳转到这个链接指向的页面，
+     * 链接的目标页面可以是商品详情页、活动专题页、店铺主页等不同类型的页面，具体根据业务需求和图片的用途来设定，
+     * 以此实现通过图片引导用户进行相应的浏览和操作，提升用户在平台内的交互体验。
+     */
+    private String link;
+
+    /**
+     * `status`属性用于表示图片的状态，一般用整数类型来表示不同的状态值，例如可以设定 `0` 表示图片未启用（暂不展示），
+     * `1` 表示图片已启用（正常展示）等状态定义，通过这个属性可以方便地对首页图片进行展示与否的控制，
+     * 比如在后台管理系统中，管理员可以根据业务情况随时更改图片的状态，从而调整首页图片的展示效果。
+     */
+    private Integer status;
+
+    /**
+     * `seq`属性代表图片的展示顺序，同样是整数类型，用于确定在首页展示图片时各个图片的先后排列次序，
+     * 可以按照业务需求设定较小的数值在前、较大的数值在后等排序规则，通过调整不同图片的 `seq` 值，
+     * 能够灵活地改变首页图片的展示顺序，实现对首页展示效果的个性化定制和优化。
+     */
+    private Integer seq;
+
+    /**
+     * `uploadTime`属性记录的是图片的上传时间，以 `Date` 类型存储，格式一般遵循系统默认的时间格式（例如 `yyyy-MM-dd HH:mm:ss`），
+     * 它可以用于数据的溯源、统计分析等操作，比如查看不同时间段内店铺上传了哪些首页图片、了解图片的更新频率等业务场景中会用到该时间信息。
+     */
+    private Date uploadTime;
+
+    /**
+     * `type`属性用于区分图片的类型，不同的整数值可以对应不同的图片分类，例如 `1` 表示商品推荐图片，`2` 表示活动宣传图片，
+     * `3` 表示店铺形象展示图片等，通过这种分类方式，可以在业务逻辑中针对不同类型的图片进行差异化的处理和展示，
+     * 也便于进行分类管理和统计分析等操作。
+     */
+    private int type;
+
+    /**
+     * `relation`属性用于存放与图片相关联的其他数据的唯一标识符，比如可能关联到某个商品的 `id`、某个活动的 `id` 等，
+     * 其具体含义取决于业务场景中图片与其他实体的关联关系设定，通过这个属性可以建立起图片与其他业务对象之间的联系，
+     * 方便在进行相关业务操作时（如根据图片查找关联商品、获取关联活动详情等）获取对应的关联数据。
+     */
+    private Long relation;
+
+    /**
+     * `pic`属性用于存放商品图片相关信息，它与数据库表字段的映射有所不同，通过 `@TableField(exist = false)` 注解表明该属性
+     * 在数据库表中并不实际存在对应的字段，但在业务逻辑处理或者数据传输过程中可能会用到。同时使用 `@JsonSerialize(using = ImgJsonSerializer.class)`
+     * 注解意味着在将该类对象转换为JSON格式（例如在接口返回数据给前端时）会使用自定义的序列化器对这个属性进行特殊处理，
+     * 可能是对图片路径进行格式调整、添加域名等操作，使其符合前端展示或者与其他系统交互的要求，便于展示商品图片的相关信息。
+     */
+    @TableField(exist = false)
+    @JsonSerialize(using = ImgJsonSerializer.class)
+    private String pic;
+
+    /**
+     * `prodName`属性用于存储商品名称，同样是通过 `@TableField(exist = false)` 注解表示其在数据库表中无对应字段，
+     * 但在涉及与商品相关的业务逻辑以及数据展示时会用到该属性，比如在首页图片关联商品展示时，除了显示图片本身，
+     * 还可以同时展示对应的商品名称，让用户更直观地了解图片所涉及的商品信息，提升用户体验。
+     */
+    @TableField(exist = false)
+    private String prodName;
+}