【代码评审】IOT：物模型

YunaiV
1 parent 64fefaa6
Showing 19 changed files with 108 additions and 48 deletions
yudao-module-iot/yudao-module-iot-biz/src/main/java/cn/iocoder/yudao/module/iot/controller/admin/thinkmodelfunction/thingModel/ThingModelArraySpecs.java
yudao-module-iot/yudao-module-iot-biz/src/main/java/cn/iocoder/yudao/module/iot/controller/admin/thinkmodelfunction/thingModel/ThingModelEvent.java
yudao-module-iot/yudao-module-iot-biz/src/main/java/cn/iocoder/yudao/module/iot/controller/admin/thinkmodelfunction/thingModel/ThingModelProperty.java
yudao-module-iot/yudao-module-iot-biz/src/main/java/cn/iocoder/yudao/module/iot/controller/admin/thinkmodelfunction/thingModel/ThingModelService.java
yudao-module-iot/yudao-module-iot-biz/src/main/java/cn/iocoder/yudao/module/iot/controller/admin/thinkmodelfunction/thingModel/dataType/ThingModelArraySpecs.java
yudao-module-iot/yudao-module-iot-biz/src/main/java/cn/iocoder/yudao/module/iot/dal/dataobject/thinkmodelfunction/IotThinkModelFunctionDO.java
yudao-module-iot/yudao-module-iot-biz/src/main/java/cn/iocoder/yudao/module/iot/service/thinkmodelfunction/IotThinkModelFunctionServiceImpl.java
-package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel;
-
-import lombok.Data;
-
-@Data
-public class ThingModelArraySpecs {
-    private int size; // 数组长度
-    private ThingModelDataType item; // 数组元素的类型
-}
 package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel;
  
+import cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType.ThingModelArgument;
 import lombok.Data;
 import java.util.List;
  
 @Data
 public class ThingModelEvent {
+
     private String identifier;
     private String name;
-    private String type; // "info"、"alert"、"error"
+    /**
+     * 事件类型
+     *
+     * "info"、"alert"、"error"
+     */
+    private String type;
     private List<ThingModelArgument> outputData;
     private String description;
     private String method;
+
 }
 package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel;
  
+import cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType.ThingModelDataType;
 import lombok.Data;
  
 @Data
 public class ThingModelProperty {
+
     private String identifier;
     private String name;
     private String accessMode; // "rw"、"r"、"w"
-    private boolean required;
+    private Boolean required;
     private ThingModelDataType dataType;
     private String description;
+
 }
 package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel;
  
+import cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType.ThingModelArgument;
 import lombok.Data;
 import java.util.List;
  
 @Data
 public class ThingModelService {
+
     private String identifier;
     private String name;
-    private String callType; // "sync"、"async"
+    /**
+     * 调用类型
+     *
+     * "sync"、"async"
+     */
+    private String callType;
     private List<ThingModelArgument> inputData;
     private List<ThingModelArgument> outputData;
     private String description;
     private String method;
+
 }
-package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel;
+package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType;
  
 import lombok.Data;
  
 @Data
 public class ThingModelArgument {
+
     private String identifier;
     private String name;
     private ThingModelDataType dataType;
-    private String direction; // 用于区分输入或输出参数，"input" 或 "output"
+    /**
+     * 用于区分输入或输出参数，"input" 或 "output"
+     */
+    private String direction;
     private String description;
+
 }
+package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType;
+
+import lombok.Data;
+
+@Data
+public class ThingModelArraySpecs {
+
+    /**
+     * 数组长度
+     */
+    private int size;
+    /**
+     * 数组元素的类型
+     */
+    private ThingModelDataType item;
+
+}
-package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel;
+package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType;
  
 import lombok.Data;
-import lombok.EqualsAndHashCode;
  
+// TODO @haohao：这个是不是和别的类，不太统一哈
 @Data
-@EqualsAndHashCode(callSuper = true)
 public class ThingModelArrayType extends ThingModelDataType {
+
     private ThingModelArraySpecs specs;
+
 }
  
-package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel;
+package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType;
  
 import lombok.Data;
 import lombok.EqualsAndHashCode;
@@ -6,5 +6,7 @@ import lombok.EqualsAndHashCode;
 @Data
 @EqualsAndHashCode(callSuper = true)
 public class ThingModelBoolType extends ThingModelDataType {
+
     // Bool 类型一般不需要额外的 specs
+
 }
-package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel;
+package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType;
  
 import com.fasterxml.jackson.annotation.JsonSubTypes;
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
@@ -18,5 +18,7 @@ import lombok.Data;
         @JsonSubTypes.Type(value = ThingModelArrayType.class, name = "array")
 })
 public abstract class ThingModelDataType {
+
     private String type;
+
 }
-package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel;
+package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType;
  
 import lombok.Data;
-import lombok.EqualsAndHashCode;
  
 @Data
-@EqualsAndHashCode(callSuper = true)
 public class ThingModelDateType extends ThingModelDataType {
+
     // Date 类型一般不需要额外的 specs
+
 }
-package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel;
+package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType;
  
 import lombok.Data;
-import lombok.EqualsAndHashCode;
  
 @Data
-@EqualsAndHashCode(callSuper = true)
 public class ThingModelDoubleType extends ThingModelDataType {
     private ThingModelDoubleSpecs specs;
 }
  
 @Data
 class ThingModelDoubleSpecs {
+
     private Double min;
     private Double max;
     private Double step;
     private String unit;
+
 }
-package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel;
+package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType;
  
 import lombok.Data;
-import lombok.EqualsAndHashCode;
+
 import java.util.Map;
  
 @Data
-@EqualsAndHashCode(callSuper = true)
 public class ThingModelEnumType extends ThingModelDataType {
-    private Map<String, String> specs; // 枚举值和描述的键值对
+
+    /**
+     * 枚举值和描述的键值对
+     */
+    private Map<String, String> specs;
+
 }
-package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel;
+package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType;
  
 import lombok.Data;
 import lombok.EqualsAndHashCode;
@@ -11,8 +11,10 @@ public class ThingModelFloatType extends ThingModelDataType {
  
 @Data
 class ThingModelFloatSpecs {
+
     private Float min;
     private Float max;
     private Float step;
     private String unit;
+
 }
-package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel;
+package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType;
  
 import lombok.Data;
-import lombok.EqualsAndHashCode;
  
 @Data
-@EqualsAndHashCode(callSuper = true)
 public class ThingModelIntType extends ThingModelDataType {
     private ThingModelIntSpecs specs;
 }
  
 @Data
 class ThingModelIntSpecs {
+
     private Integer min;
     private Integer max;
     private Integer step;
     private String unit;
+
 }
-package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel;
+package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType;
  
 import lombok.Data;
  
 @Data
 public class ThingModelStructField {
+
     private String identifier;
     private String name;
     private ThingModelDataType dataType;
     private String description;
+
 }
 \ No newline at end of file
-package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel;
+package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType;
  
 import lombok.Data;
-import lombok.EqualsAndHashCode;
+
 import java.util.List;
  
 @Data
-@EqualsAndHashCode(callSuper = true)
 public class ThingModelStructType extends ThingModelDataType {
+
     private List<ThingModelStructField> specs;
+
 }
  
  
-package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel;
+package cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType;
  
 import lombok.Data;
-import lombok.EqualsAndHashCode;
  
 @Data
-@EqualsAndHashCode(callSuper = true)
 public class ThingModelTextType extends ThingModelDataType {
+
     private ThingModelTextSpecs specs;
+
 }
  
 @Data
 class ThingModelTextSpecs {
-    private Integer length; // 最大长度
+
+    /**
+     * 最大长度
+     */
+    private Integer length;
+
 }
 package cn.iocoder.yudao.module.iot.dal.dataobject.thinkmodelfunction;
  
 import cn.iocoder.yudao.framework.mybatis.core.dataobject.BaseDO;
+import cn.iocoder.yudao.module.iot.dal.dataobject.product.IotProductDO;
 import com.baomidou.mybatisplus.annotation.KeySequence;
 import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
 import lombok.*;
  
 /**
- * IoT 产品物模型 DO
+ * IoT 产品物模型功能 DO
+ *
+ * 每个 {@link IotProductDO} 和 {@link IotThinkModelFunctionDO} 是“一对多”的关系，它的每个属性、事件、服务都对应一条记录
  *
  * @author 芋道源码
  */
 @TableName("iot_think_model_function")
 @KeySequence("iot_think_model_function_seq") // 用于 Oracle、PostgreSQL、Kingbase、DB2、H2 数据库的主键自增。如果是 MySQL 等数据库，可不写。
 @Data
-@EqualsAndHashCode(callSuper = true)
-@ToString(callSuper = true)
 @Builder
 @NoArgsConstructor
 @AllArgsConstructor
 public class IotThinkModelFunctionDO extends BaseDO {
  
     /**
-     * 产品ID
+     * 物模型功能编号
      */
     @TableId
     private Long id;
-
+    // TODO @haohao：是不是有一个 identifier，需要要有哈
+    // TODO @haohao：name、description 属性，还有个类型
     /**
      * 产品标识
+     *
+     * 关联 {@link IotProductDO#getId()}
      */
     private Long productId;
-
     /**
      * 产品标识
+     *
+     * 关联 {@link IotProductDO#getProductKey()}
      */
     private String productKey;
  
+    // TODO @haohao：是不是可以搞成 ThingModelProperty、ThingModelEvent、ThingModelService 进行存储
     /**
      * 属性列表
      */
 package cn.iocoder.yudao.module.iot.service.thinkmodelfunction;
  
-import cn.hutool.json.JSONUtil;
 import cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.*;
+import cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType.ThingModelArgument;
+import cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType.ThingModelArraySpecs;
+import cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType.ThingModelArrayType;
+import cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.thingModel.dataType.ThingModelTextType;
 import cn.iocoder.yudao.module.iot.controller.admin.thinkmodelfunction.vo.IotThinkModelFunctionSaveReqVO;
 import cn.iocoder.yudao.module.iot.convert.thinkmodelfunction.IotThinkModelFunctionConvert;
 import cn.iocoder.yudao.module.iot.dal.dataobject.thinkmodelfunction.IotThinkModelFunctionDO;