model添加字段注释

mall-mbg/src/main/java/com/macro/mall/CommentGenerator.java

+package com.macro.mall;
+
+import org.mybatis.generator.api.IntrospectedColumn;
+import org.mybatis.generator.api.IntrospectedTable;
+import org.mybatis.generator.api.dom.java.Field;
+import org.mybatis.generator.internal.DefaultCommentGenerator;
+import org.mybatis.generator.internal.util.StringUtility;
+
+import java.util.Properties;
+
+/**
+ * 自定义注释生成器
+ */
+public class CommentGenerator extends DefaultCommentGenerator {
+    private boolean addRemarkComments = false;
+
+    /**
+     * 设置用户配置的参数
+     */
+    @Override
+    public void addConfigurationProperties(Properties properties) {
+        super.addConfigurationProperties(properties);
+        this.addRemarkComments = StringUtility.isTrue(properties.getProperty("addRemarkComments"));
+    }
+
+    /**
+     * 给字段添加注释
+     */
+    @Override
+    public void addFieldComment(Field field, IntrospectedTable introspectedTable,
+                                IntrospectedColumn introspectedColumn) {
+        String remarks = introspectedColumn.getRemarks();
+        //根据参数和备注信息判断是否添加备注信息
+        if(addRemarkComments&&StringUtility.stringHasValue(remarks)){
+            //文档注释开始
+            field.addJavaDocLine("/**");
+            //获取数据库字段的备注信息
+            String[] remarkLines = remarks.split(System.getProperty("line.separator"));
+            for(String remarkLine:remarkLines){
+                field.addJavaDocLine(" * "+remarkLine);
+            }
+            addJavadocTag(field, false);
+            field.addJavaDocLine(" */");
+        }
+    }
+}

mall-mbg/src/main/java/com/macro/mall/model/CmsHelpCategory.java

@@ -7,8 +7,18 @@ public class CmsHelpCategory implements Serializable {
 
     private String name;
 
+    /**
+     * 分类图标
+     *
+     * @mbggenerated
+     */
     private String icon;
 
+    /**
+     * 专题数量
+     *
+     * @mbggenerated
+     */
     private Integer helpCount;
 
     private Integer showStatus;

mall-mbg/src/main/java/com/macro/mall/model/CmsMemberReport.java

@@ -6,16 +6,36 @@ import java.util.Date;
 public class CmsMemberReport implements Serializable {
     private Long id;
 
+    /**
+     * 举报类型：0->商品评价；1->话题内容；2->用户评论
+     *
+     * @mbggenerated
+     */
     private Integer reportType;
 
+    /**
+     * 举报人
+     *
+     * @mbggenerated
+     */
     private String reportMemberName;
 
     private Date createTime;
 
     private String reportObject;
 
+    /**
+     * 举报状态：0->未处理；1->已处理
+     *
+     * @mbggenerated
+     */
     private Integer reportStatus;
 
+    /**
+     * 处理结果：0->无效；1->有效；2->恶意
+     *
+     * @mbggenerated
+     */
     private Integer handleStatus;
 
     private String note;

mall-mbg/src/main/java/com/macro/mall/model/CmsPrefrenceArea.java

@@ -13,6 +13,11 @@ public class CmsPrefrenceArea implements Serializable {
 
     private Integer showStatus;
 
+    /**
+     * 展示图片
+     *
+     * @mbggenerated
+     */
     private byte[] pic;
 
     private static final long serialVersionUID = 1L;

mall-mbg/src/main/java/com/macro/mall/model/CmsSubject.java

@@ -10,8 +10,18 @@ public class CmsSubject implements Serializable {
 
     private String title;
 
+    /**
+     * 专题主图
+     *
+     * @mbggenerated
+     */
     private String pic;
 
+    /**
+     * 关联产品数量
+     *
+     * @mbggenerated
+     */
     private Integer productCount;
 
     private Integer recommendStatus;
@@ -24,12 +34,27 @@ public class CmsSubject implements Serializable {
 
     private Integer commentCount;
 
+    /**
+     * 画册图片用逗号分割
+     *
+     * @mbggenerated
+     */
     private String albumPics;
 
     private String description;
 
+    /**
+     * 显示状态：0->不显示；1->显示
+     *
+     * @mbggenerated
+     */
     private Integer showStatus;
 
+    /**
+     * 转发数
+     *
+     * @mbggenerated
+     */
     private Integer forwardCount;
 
     private String content;

mall-mbg/src/main/java/com/macro/mall/model/CmsSubjectCategory.java

@@ -7,8 +7,18 @@ public class CmsSubjectCategory implements Serializable {
 
     private String name;
 
+    /**
+     * 分类图标
+     *
+     * @mbggenerated
+     */
     private String icon;
 
+    /**
+     * 专题数量
+     *
+     * @mbggenerated
+     */
     private Integer subjectCount;
 
     private Integer showStatus;

mall-mbg/src/main/java/com/macro/mall/model/CmsTopic.java

@@ -16,16 +16,41 @@ public class CmsTopic implements Serializable {
 
     private Date endTime;
 
+    /**
+     * 参与人数
+     *
+     * @mbggenerated
+     */
     private Integer attendCount;
 
+    /**
+     * 关注人数
+     *
+     * @mbggenerated
+     */
     private Integer attentionCount;
 
     private Integer readCount;
 
+    /**
+     * 奖品名称
+     *
+     * @mbggenerated
+     */
     private String awardName;
 
+    /**
+     * 参与方式
+     *
+     * @mbggenerated
+     */
     private String attendType;
 
+    /**
+     * 话题内容
+     *
+     * @mbggenerated
+     */
     private String content;
 
     private static final long serialVersionUID = 1L;

mall-mbg/src/main/java/com/macro/mall/model/CmsTopicCategory.java

@@ -7,8 +7,18 @@ public class CmsTopicCategory implements Serializable {
 
     private String name;
 
+    /**
+     * 分类图标
+     *
+     * @mbggenerated
+     */
     private String icon;
 
+    /**
+     * 专题数量
+     *
+     * @mbggenerated
+     */
     private Integer subjectCount;
 
     private Integer showStatus;

mall-mbg/src/main/java/com/macro/mall/model/OmsCompanyAddress.java

@@ -5,14 +5,39 @@ import java.io.Serializable;
 public class OmsCompanyAddress implements Serializable {
     private Long id;
 
+    /**
+     * 地址名称
+     *
+     * @mbggenerated
+     */
     private String addressName;
 
+    /**
+     * 默认发货地址：0->否；1->是
+     *
+     * @mbggenerated
+     */
     private Integer sendStatus;
 
+    /**
+     * 是否默认收货地址：0->否；1->是
+     *
+     * @mbggenerated
+     */
     private Integer receiveStatus;
 
+    /**
+     * 收发货人姓名
+     *
+     * @mbggenerated
+     */
     private String name;
 
+    /**
+     * 收货人电话
+     *
+     * @mbggenerated
+     */
     private String phone;
 
     private String province;

mall-mbg/src/main/java/com/macro/mall/model/OmsOrder.java

@@ -5,76 +5,246 @@ import java.math.BigDecimal;
 import java.util.Date;
 
 public class OmsOrder implements Serializable {
+    /**
+     * 订单id
+     *
+     * @mbggenerated
+     */
     private Long id;
 
     private Long memberId;
 
     private Long couponId;
 
+    /**
+     * 订单编号
+     *
+     * @mbggenerated
+     */
     private String orderSn;
 
+    /**
+     * 提交时间
+     *
+     * @mbggenerated
+     */
     private Date createTime;
 
+    /**
+     * 用户帐号
+     *
+     * @mbggenerated
+     */
     private String memberUsername;
 
+    /**
+     * 订单总金额
+     *
+     * @mbggenerated
+     */
     private BigDecimal totalAmount;
 
+    /**
+     * 运费金额
+     *
+     * @mbggenerated
+     */
     private BigDecimal freightAmount;
 
+    /**
+     * 促销优化金额（促销价、满减、阶梯价）
+     *
+     * @mbggenerated
+     */
     private BigDecimal promotionAmount;
 
+    /**
+     * 积分抵扣金额
+     *
+     * @mbggenerated
+     */
     private BigDecimal integrationAmount;
 
+    /**
+     * 优惠券抵扣金额
+     *
+     * @mbggenerated
+     */
     private BigDecimal couponAmount;
 
+    /**
+     * 管理员后台调整订单使用的折扣金额
+     *
+     * @mbggenerated
+     */
     private BigDecimal discountAmount;
 
+    /**
+     * 支付方式：0->未支付；1->支付宝；2->微信
+     *
+     * @mbggenerated
+     */
     private Integer payType;
 
+    /**
+     * 订单来源：0->PC订单；1->app订单
+     *
+     * @mbggenerated
+     */
     private Integer sourceType;
 
+    /**
+     * 订单状态：0->待付款；1->待发货；2->已发货；3->已完成；4->已关闭；5->无效订单
+     *
+     * @mbggenerated
+     */
     private Integer status;
 
+    /**
+     * 订单类型：0->正常订单；1->秒杀订单
+     *
+     * @mbggenerated
+     */
     private Integer orderType;
 
+    /**
+     * 物流公司(配送方式)
+     *
+     * @mbggenerated
+     */
     private String deliveryCompany;
 
+    /**
+     * 物流单号
+     *
+     * @mbggenerated
+     */
     private String deliverySn;
 
+    /**
+     * 自动确认时间（天）
+     *
+     * @mbggenerated
+     */
     private Integer autoConfirmDay;
 
+    /**
+     * 可以获得的积分
+     *
+     * @mbggenerated
+     */
     private Integer integration;
 
+    /**
+     * 可以活动的成长值
+     *
+     * @mbggenerated
+     */
     private Integer growth;
 
+    /**
+     * 活动信息
+     *
+     * @mbggenerated
+     */
     private String promotionInfo;
 
+    /**
+     * 发票类型：0->不开发票；1->电子发票；2->纸质发票
+     *
+     * @mbggenerated
+     */
     private Integer billType;
 
+    /**
+     * 发票抬头
+     *
+     * @mbggenerated
+     */
     private String billHeader;
 
+    /**
+     * 发票内容
+     *
+     * @mbggenerated
+     */
     private String billContent;
 
+    /**
+     * 收票人电话
+     *
+     * @mbggenerated
+     */
     private String billReceiverPhone;
 
+    /**
+     * 收票人邮箱
+     *
+     * @mbggenerated
+     */
     private String billReceiverEmail;
 
+    /**
+     * 收货人姓名
+     *
+     * @mbggenerated
+     */
     private String receiverName;
 
+    /**
+     * 收货人电话
+     *
+     * @mbggenerated
+     */
     private String receiverPhone;
 
+    /**
+     * 收货人邮编
+     *
+     * @mbggenerated
+     */
     private String receiverPostCode;
 
+    /**
+     * 省份/直辖市
+     *
+     * @mbggenerated
+     */
     private String receiverProvince;
 
+    /**
+     * 城市
+     *
+     * @mbggenerated
+     */
     private String receiverCity;
 
+    /**
+     * 区
+     *
+     * @mbggenerated
+     */
     private String receiverRegion;
 
+    /**
+     * 详细地址
+     *
+     * @mbggenerated
+     */
     private String receiverDetailAddress;
 
+    /**
+     * 订单备注
+     *
+     * @mbggenerated
+     */
     private String note;
 
+    /**
+     * 确认收货状态：0->未确认；1->已确认
+     *
+     * @mbggenerated
+     */
     private Integer confirmStatus;
 
     private static final long serialVersionUID = 1L;

mall-mbg/src/main/java/com/macro/mall/model/OmsOrderItem.java

@@ -6,8 +6,18 @@ import java.math.BigDecimal;
 public class OmsOrderItem implements Serializable {
     private Long id;
 
+    /**
+     * 订单id
+     *
+     * @mbggenerated
+     */
     private Long orderId;
 
+    /**
+     * 订单编号
+     *
+     * @mbggenerated
+     */
     private String orderSn;
 
     private Long productId;
@@ -22,10 +32,25 @@ public class OmsOrderItem implements Serializable {
 
     private BigDecimal productAmount;
 
+    /**
+     * 购买数量
+     *
+     * @mbggenerated
+     */
     private Integer productCount;
 
+    /**
+     * 该商品经过优惠后的分解金额
+     *
+     * @mbggenerated
+     */
     private BigDecimal productRealAmount;
 
+    /**
+     * 商品的销售属性
+     *
+     * @mbggenerated
+     */
     private String sp1;
 
     private String sp2;

mall-mbg/src/main/java/com/macro/mall/model/OmsOrderOperateHistory.java

@@ -6,14 +6,39 @@ import java.util.Date;
 public class OmsOrderOperateHistory implements Serializable {
     private Long id;
 
+    /**
+     * 订单id
+     *
+     * @mbggenerated
+     */
     private Long orderId;
 
+    /**
+     * 操作人：用户；系统；后台管理员
+     *
+     * @mbggenerated
+     */
     private String operateMan;
 
+    /**
+     * 操作时间
+     *
+     * @mbggenerated
+     */
     private Date createTime;
 
+    /**
+     * 订单状态：0->待付款；1->待发货；2->已发货；3->已完成；4->已关闭；5->无效订单
+     *
+     * @mbggenerated
+     */
     private Integer orderStatus;
 
+    /**
+     * 备注
+     *
+     * @mbggenerated
+     */
     private String note;
 
     private static final long serialVersionUID = 1L;

mall-mbg/src/main/java/com/macro/mall/model/OmsOrderReturnApply.java

@@ -7,24 +7,54 @@ import java.util.Date;
 public class OmsOrderReturnApply implements Serializable {
     private Long id;
 
+    /**
+     * 订单id
+     *
+     * @mbggenerated
+     */
     private Long orderId;
 
     private Long companyAddressId;
 
+    /**
+     * 订单编号
+     *
+     * @mbggenerated
+     */
     private String orderSn;
 
     private Date createTime;
 
     private String memberUsername;
 
+    /**
+     * 退款金额
+     *
+     * @mbggenerated
+     */
     private BigDecimal returnAmount;
 
     private String returnName;
 
+    /**
+     * 退货人电话
+     *
+     * @mbggenerated
+     */
     private String returnPhone;
 
+    /**
+     * 申请状态：0->待处理；1->退货中；2->已完成；3->已拒绝
+     *
+     * @mbggenerated
+     */
     private Integer status;
 
+    /**
+     * 处理时间
+     *
+     * @mbggenerated
+     */
     private Date handleTime;
 
     private String productPic;
@@ -33,26 +63,81 @@ public class OmsOrderReturnApply implements Serializable {
 
     private String brandName;
 
+    /**
+     * 商品销售属性：颜色：红色；尺码：xl;
+     *
+     * @mbggenerated
+     */
     private String productAttr;
 
+    /**
+     * 退货数量
+     *
+     * @mbggenerated
+     */
     private Integer productCount;
 
+    /**
+     * 原因
+     *
+     * @mbggenerated
+     */
     private String reason;
 
+    /**
+     * 描述
+     *
+     * @mbggenerated
+     */
     private String description;
 
+    /**
+     * 凭证图片，以逗号隔开
+     *
+     * @mbggenerated
+     */
     private String proofPics;
 
+    /**
+     * 要退的邮费
+     *
+     * @mbggenerated
+     */
     private BigDecimal returnPostAmount;
 
+    /**
+     * 是否退邮费：0->不退；1->退
+     *
+     * @mbggenerated
+     */
     private Integer returnPostStatus;
 
+    /**
+     * 确认退款总金额
+     *
+     * @mbggenerated
+     */
     private BigDecimal confirmReturnAmount;
 
+    /**
+     * 处理备注
+     *
+     * @mbggenerated
+     */
     private String handleNote;
 
+    /**
+     * 处理人员
+     *
+     * @mbggenerated
+     */
     private String handleMan;
 
+    /**
+     * 收货人
+     *
+     * @mbggenerated
+     */
     private String receiveMan;
 
     private Date receiveTime;

mall-mbg/src/main/java/com/macro/mall/model/OmsOrderReturnReason.java

@@ -5,10 +5,20 @@ import java.io.Serializable;
 public class OmsOrderReturnReason implements Serializable {
     private Long id;
 
+    /**
+     * 退货类型
+     *
+     * @mbggenerated
+     */
     private String name;
 
     private Integer sort;
 
+    /**
+     * 状态：0->不启用；1->启用
+     *
+     * @mbggenerated
+     */
     private Integer status;
 
     private static final long serialVersionUID = 1L;

mall-mbg/src/main/java/com/macro/mall/model/OmsOrderSetting.java

@@ -5,14 +5,39 @@ import java.io.Serializable;
 public class OmsOrderSetting implements Serializable {
     private Long id;
 
+    /**
+     * 秒杀订单超时关闭时间(分)
+     *
+     * @mbggenerated
+     */
     private Integer flashOrderOvertime;
 
+    /**
+     * 正常订单超时时间(分)
+     *
+     * @mbggenerated
+     */
     private Integer normalOrderOvertime;
 
+    /**
+     * 发货后自动确认收货时间（天）
+     *
+     * @mbggenerated
+     */
     private Integer confirmOvertime;
 
+    /**
+     * 自动完成交易时间，不能申请售后（天）
+     *
+     * @mbggenerated
+     */
     private Integer finishOvertime;
 
+    /**
+     * 订单完成后自动好评时间（天）
+     *
+     * @mbggenerated
+     */
     private Integer commentOvertime;
 
     private static final long serialVersionUID = 1L;

mall-mbg/src/main/java/com/macro/mall/model/PmsBrand.java

@@ -7,22 +7,57 @@ public class PmsBrand implements Serializable {
 
     private String name;
 
+    /**
+     * 首字母
+     *
+     * @mbggenerated
+     */
     private String firstLetter;
 
     private Integer sort;
 
+    /**
+     * 是否为品牌制造商：0->不是；1->是
+     *
+     * @mbggenerated
+     */
     private Integer factoryStatus;
 
     private Integer showStatus;
 
+    /**
+     * 产品数量
+     *
+     * @mbggenerated
+     */
     private Integer productCount;
 
+    /**
+     * 产品评论数量
+     *
+     * @mbggenerated
+     */
     private Integer productCommentCount;
 
+    /**
+     * 品牌logo
+     *
+     * @mbggenerated
+     */
     private String logo;
 
+    /**
+     * 专区大图
+     *
+     * @mbggenerated
+     */
     private String bigPic;
 
+    /**
+     * 品牌故事
+     *
+     * @mbggenerated
+     */
     private String brandStory;
 
     private static final long serialVersionUID = 1L;

mall-mbg/src/main/java/com/macro/mall/model/PmsComment.java

@@ -12,22 +12,47 @@ public class PmsComment implements Serializable {
 
     private String productName;
 
+    /**
+     * 评价星数：0->5
+     *
+     * @mbggenerated
+     */
     private Integer star;
 
+    /**
+     * 评价的ip
+     *
+     * @mbggenerated
+     */
     private String memberIp;
 
     private Date createTime;
 
     private Integer showStatus;
 
+    /**
+     * 购买时的商品属性
+     *
+     * @mbggenerated
+     */
     private String productAttribute;
 
     private Integer collectCouont;
 
     private Integer readCount;
 
+    /**
+     * 上传图片地址，以逗号隔开
+     *
+     * @mbggenerated
+     */
     private String pics;
 
+    /**
+     * 评论用户头像
+     *
+     * @mbggenerated
+     */
     private String memberIcon;
 
     private Integer replayCount;

mall-mbg/src/main/java/com/macro/mall/model/PmsCommentReplay.java

@@ -16,6 +16,11 @@ public class PmsCommentReplay implements Serializable {
 
     private Date createTime;
 
+    /**
+     * 评论人员类型；0->会员；1->管理员
+     *
+     * @mbggenerated
+     */
     private Integer type;
 
     private static final long serialVersionUID = 1L;

mall-mbg/src/main/java/com/macro/mall/model/PmsFeightTemplate.java

@@ -8,16 +8,36 @@ public class PmsFeightTemplate implements Serializable {
 
     private String name;
 
+    /**
+     * 计费类型:0->按重量；1->按件数
+     *
+     * @mbggenerated
+     */
     private Integer chargeType;
 
+    /**
+     * 首重kg
+     *
+     * @mbggenerated
+     */
     private BigDecimal firstWeight;
 
+    /**
+     * 首费（元）
+     *
+     * @mbggenerated
+     */
     private BigDecimal firstFee;
 
     private BigDecimal continueWeight;
 
     private BigDecimal continmeFee;
 
+    /**
+     * 目的地（省、市）
+     *
+     * @mbggenerated
+     */
     private String dest;
 
     private static final long serialVersionUID = 1L;

mall-mbg/src/main/java/com/macro/mall/model/PmsMemberPrice.java

@@ -10,6 +10,11 @@ public class PmsMemberPrice implements Serializable {
 
     private Long memberLevelId;
 
+    /**
+     * 会员价格
+     *
+     * @mbggenerated
+     */
     private BigDecimal memberPrice;
 
     private static final long serialVersionUID = 1L;