提交

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

@@ -0,0 +1,191 @@
+/*
+ * Copyright (c) 2018-2999 广州市蓝海创新科技有限公司 All rights reserved.
+ *
+ * https://www.mall4j.com/
+ *
+ * 未经允许，不可做商业用途！
+ *
+ * 版权所有，侵权必究！
+ */
+
+package com.yami.shop.bean.app.param;
+
+// 引入用于在Swagger中对API模型属性进行描述的注解相关类，通过该注解可以为类中的属性添加详细的说明信息，方便在API文档中展示
+import io.swagger.v3.oas.annotations.media.Schema;
+// 引入Jakarta Bean Validation规范中用于标记属性不能为空的注解类，用于对类中的属性进行非空校验约束
+import jakarta.validation.constraints.NotNull;
+
+/**
+ * AddrParam类用于封装与地址相关的参数信息，在应用层（app）作为传递地址相关数据的载体。
+ * 例如，在涉及地址新增、修改等操作时，可通过此类接收前端传入的各种地址相关参数，方便后续进行业务逻辑处理以及数据验证等操作。
+ *
+ * @author lanhai
+ */
+// 使用 @Schema 注解描述该类在Swagger API文档中的相关信息，此处说明该类整体代表“地址参数”
+@Schema(description = "地址参数")
+public class AddrParam {
+
+	// 使用 @Schema 注解描述 addrId 属性在Swagger API文档中的信息，说明它代表“地址ID”，并且通过 required = true 设置该属性为必填项
+	@Schema(description = "地址ID", required = true)
+	// 声明一个Long类型的变量 addrId，用于存储地址的唯一标识符，它在数据库操作等场景中可用于定位具体的地址记录
+	private Long addrId;
+
+	// 使用 @NotNull 注解对 receiver 属性进行非空约束，当该属性值为空时，会根据注解中设置的消息提示“收货人不能为空”抛出相应的验证异常
+	// 同时使用 @Schema 注解描述该属性在Swagger API文档中的信息，说明它代表“收货人”且为必填项
+	@NotNull(message = "收货人不能为空")
+	@Schema(description = "收货人", required = true)
+	// 声明一个String类型的变量 receiver，用于存储收货人的姓名，方便在物流配送等业务场景中明确包裹的接收人是谁
+	private String receiver;
+
+	// 使用 @NotNull 注解对 addr 属性进行非空约束，当该属性值为空时，会根据注解中设置的消息提示“地址不能为空”抛出相应的验证异常
+	// 同时使用 @Schema 注解描述该属性在Swagger API文档中的信息，说明它代表“地址”且为必填项
+	@NotNull(message = "地址不能为空")
+	@Schema(description = "地址", required = true)
+	// 声明一个String类型的变量 addr，用于存储详细的收货地址信息，比如街道名称、门牌号等，确保快递等能准确送达包裹
+	private String addr;
+
+	// 使用 @Schema 注解描述 postCode 属性在Swagger API文档中的信息，说明它代表“邮编”，并通过 required = false 设置该属性为非必填项
+	@Schema(description = "邮编", required = false)
+	// 声明一个String类型的变量 postCode，用于存储收货地址所在地的邮政编码，在一些邮政业务场景中可能会用到
+	private String postCode;
+
+	// 使用 @NotNull 注解对 mobile 属性进行非空约束，当该属性值为空时，会根据注解中设置的消息提示“手机不能为空”抛出相应的验证异常
+	// 同时使用 @Schema 注解描述该属性在Swagger API文档中的信息，说明它代表“手机”且为必填项
+	@NotNull(message = "手机不能为空")
+	@Schema(description = "手机", required = true)
+	// 声明一个String类型的变量 mobile，用于存储收货人的手机号码，方便快递员在配送过程中联系收货人
+	private String mobile;
+
+	// 使用 @NotNull 注解对 provinceId 属性进行非空约束，当该属性值为空时，会根据注解中设置的消息提示“省ID不能为空”抛出相应的验证异常
+	// 同时使用 @Schema 注解描述该属性在Swagger API文档中的信息，说明它代表“省ID”且为必填项
+	@NotNull(message = "省ID不能为空")
+	@Schema(description = "省ID", required = true)
+	// 声明一个Long类型的变量 provinceId，用于存储收货地址所属省份的唯一标识符，通常关联到省份数据字典表中的主键值
+	private Long provinceId;
+
+	// 使用 @NotNull 注解对 cityId 属性进行非空约束，当该属性值为空时，会根据注解中设置的消息提示“城市ID不能为空”抛出相应的验证异常
+	// 同时使用 @Schema 注解描述该属性在Swagger API文档中的信息，说明它代表“城市ID”且为必填项
+	@NotNull(message = "城市ID不能为空")
+	@Schema(description = "城市ID", required = true)
+	// 声明一个Long类型的变量 cityId，用于存储收货地址所属城市的唯一标识符，可关联城市相关数据表的主键值
+	private Long cityId;
+
+	// 使用 @NotNull 注解对 areaId 属性进行非空约束，当该属性值为空时，会根据注解中设置的消息提示“区ID不能为空”抛出相应的验证异常
+	// 同时使用 @Schema 注解描述该属性在Swagger API文档中的信息，说明它代表“区ID”且为必填项
+	@NotNull(message = "区ID不能为空")
+	@Schema(description = "区ID", required = true)
+	// 声明一个Long类型的变量 areaId，用于存储收货地址所属区（县）的唯一标识符，关联区（县）相关数据存储
+	private Long areaId;
+
+	// 使用 @NotNull 注解对 province 属性进行非空约束，当该属性值为空时，会根据注解中设置的消息提示“省不能为空”抛出相应的验证异常
+	// 同时使用 @Schema 注解描述该属性在Swagger API文档中的信息，说明它代表“省”且为必填项
+	@NotNull(message = "省不能为空")
+	@Schema(description = "省", required = true)
+	// 声明一个String类型的变量 province，用于存储收货地址所属省份的名称，便于直观展示省份信息
+	private String province;
+
+	// 使用 @NotNull 注解对 city 属性进行非空约束，当该属性值为空时，会根据注解中设置的消息提示“城市不能为空”抛出相应的验证异常
+	// 同时使用 @Schema 注解描述该属性在Swagger API文档中的信息，说明它代表“城市”且为必填项
+	@NotNull(message = "城市不能为空")
+	@Schema(description = "城市", required = true)
+	// 声明一个String类型的变量 city，用于存储收货地址所属城市的名称，辅助明确地址的具体位置
+	private String city;
+
+	// 使用 @NotNull 注解对 area 属性进行非空约束，当该属性值为空时，会根据注解中设置的消息提示“区不能为空”抛出相应的验证异常
+	// 同时使用 @Schema 注解描述该属性在Swagger API文档中的信息，说明它代表“区”且为必填项
+	@NotNull(message = "区不能为空")
+	@Schema(description = "区", required = true)
+	// 声明一个String类型的变量 area，用于存储收货地址所属区（县）的名称，进一步细化地址范围
+	private String area;
+
+
+	// 以下是各个属性的Getter方法，用于获取类中私有属性的值，遵循JavaBean规范，方便外部类访问这些私有属性
+	public Long getAddrId() {
+		return addrId;
+	}
+
+	// 以下是 addrId 属性的Setter方法，用于设置该属性的值，遵循JavaBean规范，方便外部类对私有属性进行赋值操作
+	public void setAddrId(Long addrId) {
+		this.addrId = addrId;
+	}
+
+	public String getReceiver() {
+		return receiver;
+	}
+
+	public void setReceiver(String receiver) {
+		this.receiver = receiver;
+	}
+
+	public String getAddr() {
+		return addr;
+	}
+
+	public void setAddr(String addr) {
+		this.addr = addr;
+	}
+
+	public String getPostCode() {
+		return postCode;
+	}
+
+	public void setPostCode(String postCode) {
+		this.postCode = postCode;
+	}
+
+	public String getMobile() {
+		return mobile;
+	}
+
+	public void setMobile(String mobile) {
+		this.mobile = mobile;
+	}
+
+	public Long getProvinceId() {
+		return provinceId;
+	}
+
+	public void setProvinceId(Long provinceId) {
+		this.provinceId = provinceId;
+	}
+
+	public Long getCityId() {
+		return cityId;
+	}
+
+	public void setCityId(Long cityId) {
+		this.cityId = cityId;
+	}
+
+	public Long getAreaId() {
+		return areaId;
+	}
+
+	public void setAreaId(Long areaId) {
+		this.areaId = areaId;
+	}
+
+	public String getProvince() {
+		return province;
+	}
+
+	public void setProvince(String province) {
+		this.province = province;
+	}
+
+	public String getCity() {
+		return city;
+	}
+
+	public void setCity(String city) {
+		this.city = city;
+	}
+
+	public String getArea() {
+		return area;
+	}
+
+	public void setArea(String area) {
+		this.area = area;
+	}
+}