|
|
|
@ -1,218 +0,0 @@
|
|
|
|
|
/*
|
|
|
|
|
* 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;
|
|
|
|
|
import jakarta.validation.constraints.NotNull;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @author lanhai
|
|
|
|
|
*
|
|
|
|
|
* 此类用于封装地址相关的参数信息,在电商系统或者其他涉及地址使用的业务场景中,
|
|
|
|
|
* 作为传递地址数据的载体,比如在新增、编辑收货地址,或者下单选择收货地址等操作时,
|
|
|
|
|
* 会使用这个类的对象来承载具体的地址各方面的详细内容,方便进行数据的传递、验证以及后续的业务处理。
|
|
|
|
|
*/
|
|
|
|
|
@Schema(description = "地址参数")
|
|
|
|
|
// 通过 @Schema 注解描述了这个类整体代表的是地址参数相关信息,方便在 API 文档生成(如基于 Swagger 相关技术)时能够清晰展示类的作用。
|
|
|
|
|
public class AddrParam {
|
|
|
|
|
|
|
|
|
|
// 以下是类的各个成员变量及对应的注释说明
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 地址ID
|
|
|
|
|
* 用于唯一标识一个具体的地址记录,在数据库存储、地址查询、修改以及删除等操作中,
|
|
|
|
|
* 可以通过这个 ID 来精准定位到对应的地址信息,例如在更新某个地址时,需要先根据地址 ID 查找出对应的地址记录后再进行修改。
|
|
|
|
|
*/
|
|
|
|
|
@Schema(description = "地址ID",required=true)
|
|
|
|
|
private Long addrId;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 收货人
|
|
|
|
|
* 记录了接收货物的人员姓名,是地址信息中很关键的一部分,确保货物能够准确送达给指定的人员,
|
|
|
|
|
* 并且通过 @NotNull 注解进行了非空验证约束,表明在使用这个类传递地址参数时,收货人字段不能为空,
|
|
|
|
|
* 否则会触发相应的验证错误提示(如在基于 Spring 框架的参数校验机制下会返回相应的错误信息给前端等)。
|
|
|
|
|
*/
|
|
|
|
|
@NotNull(message = "收货人不能为空")
|
|
|
|
|
@Schema(description = "收货人",required=true)
|
|
|
|
|
private String receiver;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 地址
|
|
|
|
|
* 具体描述了收货地址的详细内容,比如街道名称、门牌号等详细的地理位置信息,
|
|
|
|
|
* 同样受到 @NotNull 注解约束,意味着该字段必须有值,以保证收货地址的完整性,便于物流配送等相关业务的准确执行。
|
|
|
|
|
*/
|
|
|
|
|
@NotNull(message = "地址不能为空")
|
|
|
|
|
@Schema(description = "地址",required=true)
|
|
|
|
|
private String addr;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 邮编
|
|
|
|
|
* 邮政编码,虽然在现代物流配送中使用频率相对没那么高,但在一些传统邮寄场景或者部分系统数据完整性要求下会使用到,
|
|
|
|
|
* 该字段通过 @Schema 注解设置为非必需(required=false),说明在传递地址参数时,邮编可以为空。
|
|
|
|
|
*/
|
|
|
|
|
@Schema(description = "邮编",required=false)
|
|
|
|
|
private String postCode;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 手机
|
|
|
|
|
* 收货人用于接收快递通知等信息的手机号码,非常重要,通过 @NotNull 注解确保其不能为空,
|
|
|
|
|
* 方便快递员等相关人员在配送过程中能及时与收货人取得联系。
|
|
|
|
|
*/
|
|
|
|
|
@NotNull(message = "手机不能为空")
|
|
|
|
|
@Schema(description = "手机",required=true)
|
|
|
|
|
private String mobile;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 省ID
|
|
|
|
|
* 用于唯一标识所在省份的一个编号,在关联省份相关的数据库表、查询省份详细信息或者涉及多省份业务逻辑区分等场景中会用到,
|
|
|
|
|
* 并且设置为必填项,保证地址信息中省份相关标识的完整性。
|
|
|
|
|
*/
|
|
|
|
|
@NotNull(message = "省ID不能为空")
|
|
|
|
|
@Schema(description = "省ID",required=true)
|
|
|
|
|
private Long provinceId;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 城市ID
|
|
|
|
|
* 类似省ID,是用来唯一确定所在城市的编号,对于准确描述收货地址的具体位置以及后续可能涉及的同城业务处理等有重要作用,
|
|
|
|
|
* 同样是必填字段,确保地址信息中城市相关标识准确无误。
|
|
|
|
|
*/
|
|
|
|
|
@NotNull(message = "城市ID不能为空")
|
|
|
|
|
@Schema(description = "城市ID",required=true)
|
|
|
|
|
private Long cityId;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 区ID
|
|
|
|
|
* 用于标识所在的区(县、县级市等类似行政区域)的编号,进一步细化收货地址的具体位置,
|
|
|
|
|
* 也是必填字段,与省ID、城市ID一起构成完整的地址区域标识体系,方便进行地址相关的精准业务操作。
|
|
|
|
|
*/
|
|
|
|
|
@NotNull(message = "区ID不能为空")
|
|
|
|
|
@Schema(description = "区ID",required=true)
|
|
|
|
|
private Long areaId;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 省
|
|
|
|
|
* 以文字形式记录的省份名称,与省ID相对应,方便在界面展示等场景下直观呈现地址中的省份信息,
|
|
|
|
|
* 并且要求不能为空,确保地址中省份相关内容的完整性。
|
|
|
|
|
*/
|
|
|
|
|
@NotNull(message = "省不能为空")
|
|
|
|
|
@Schema(description = "省",required=true)
|
|
|
|
|
private String province;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 城市
|
|
|
|
|
* 文字描述的城市名称,对应城市ID,用于在用户界面等地方更直观地展示地址中的城市信息,
|
|
|
|
|
* 也是必填项,保证城市相关内容在地址参数中准确体现。
|
|
|
|
|
*/
|
|
|
|
|
@NotNull(message = "城市不能为空")
|
|
|
|
|
@Schema(description = "城市",required=true)
|
|
|
|
|
private String city;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* 区
|
|
|
|
|
* 表示所在区(县、县级市等)的名称,和区ID相配合,使地址的具体位置信息更加清晰明确,
|
|
|
|
|
* 同样不能为空,确保地址中区域相关内容完整准确,便于物流等业务按地址准确配送。
|
|
|
|
|
*/
|
|
|
|
|
@NotNull(message = "区不能为空")
|
|
|
|
|
@Schema(description = "区",required=true)
|
|
|
|
|
private String area;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// 以下是各个成员变量的Getter和Setter方法,用于获取和设置类中的属性值,遵循JavaBean的规范。
|
|
|
|
|
|
|
|
|
|
public Long getAddrId() {
|
|
|
|
|
return addrId;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
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 getProvince() {
|
|
|
|
|
return province;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public void setProvince(String province) {
|
|
|
|
|
this.province = province;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public Long getCityId() {
|
|
|
|
|
return cityId;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public void setCityId(Long cityId) {
|
|
|
|
|
this.cityId = cityId;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public String getCity() {
|
|
|
|
|
return city;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public void setCity(String city) {
|
|
|
|
|
this.city = city;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public Long getAreaId() {
|
|
|
|
|
return areaId;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public void setAreaId(Long areaId) {
|
|
|
|
|
this.areaId = areaId;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public String getArea() {
|
|
|
|
|
return area;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public void setArea(String area) {
|
|
|
|
|
this.area = area;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
}
|