crm：code review 联系人

yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/controller/admin/contact/ContactController.java

@@ -2,42 +2,41 @@ package cn.iocoder.yudao.module.crm.controller.admin.contact;
 
 import cn.hutool.core.collection.CollUtil;
 import cn.hutool.core.util.NumberUtil;
+import cn.iocoder.yudao.framework.common.pojo.CommonResult;
+import cn.iocoder.yudao.framework.common.pojo.PageResult;
+import cn.iocoder.yudao.framework.excel.core.util.ExcelUtils;
+import cn.iocoder.yudao.framework.operatelog.core.annotations.OperateLog;
+import cn.iocoder.yudao.module.crm.controller.admin.contact.vo.*;
 import cn.iocoder.yudao.module.crm.controller.admin.customer.vo.CrmCustomerExportReqVO;
+import cn.iocoder.yudao.module.crm.convert.contact.ContactConvert;
+import cn.iocoder.yudao.module.crm.dal.dataobject.contact.ContactDO;
 import cn.iocoder.yudao.module.crm.dal.dataobject.customer.CrmCustomerDO;
+import cn.iocoder.yudao.module.crm.service.contact.ContactService;
 import cn.iocoder.yudao.module.crm.service.customer.CrmCustomerService;
 import cn.iocoder.yudao.module.system.api.user.AdminUserApi;
 import cn.iocoder.yudao.module.system.api.user.dto.AdminUserRespDTO;
 import com.google.common.collect.Lists;
-import org.springframework.web.bind.annotation.*;
-import javax.annotation.Resource;
-import org.springframework.validation.annotation.Validated;
-import org.springframework.security.access.prepost.PreAuthorize;
-import io.swagger.v3.oas.annotations.tags.Tag;
-import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import org.springframework.security.access.prepost.PreAuthorize;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.*;
 
-import javax.validation.constraints.*;
-import javax.validation.*;
-import javax.servlet.http.*;
-import java.util.*;
+import javax.annotation.Resource;
+import javax.servlet.http.HttpServletResponse;
+import javax.validation.Valid;
 import java.io.IOException;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
 import java.util.stream.Collectors;
 
-import cn.iocoder.yudao.framework.common.pojo.PageResult;
-import cn.iocoder.yudao.framework.common.pojo.CommonResult;
 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
+import static cn.iocoder.yudao.framework.operatelog.core.enums.OperateTypeEnum.EXPORT;
 
-import cn.iocoder.yudao.framework.excel.core.util.ExcelUtils;
-
-import cn.iocoder.yudao.framework.operatelog.core.annotations.OperateLog;
-import static cn.iocoder.yudao.framework.operatelog.core.enums.OperateTypeEnum.*;
-
-import cn.iocoder.yudao.module.crm.controller.admin.contact.vo.*;
-import cn.iocoder.yudao.module.crm.dal.dataobject.contact.ContactDO;
-import cn.iocoder.yudao.module.crm.convert.contact.ContactConvert;
-import cn.iocoder.yudao.module.crm.service.contact.ContactService;
-
-@Tag(name = "管理后台 - crm联系人")
+// TODO @zya：crm 所有的类，dou带 Crm 前缀，因为它的名字太通用了，可能和后续的 erp 之类的冲突
+@Tag(name = "管理后台 - CRM 联系人")
 @RestController
 @RequestMapping("/crm/contact")
 @Validated
@@ -45,20 +44,22 @@ public class ContactController {
 
     @Resource
     private ContactService contactService;
-    @Resource
-    private AdminUserApi adminUserApi;
+    // TODO @zyna：模块内，注入的变量，不用带 crm 前缀哈
     @Resource
     private CrmCustomerService crmCustomerService;
 
+    @Resource
+    private AdminUserApi adminUserApi;
+
     @PostMapping("/create")
-    @Operation(summary = "创建crm联系人")
+    @Operation(summary = "创建联系人")
     @PreAuthorize("@ss.hasPermission('crm:contact:create')")
     public CommonResult<Long> createContact(@Valid @RequestBody ContactCreateReqVO createReqVO) {
         return success(contactService.createContact(createReqVO));
     }
 
     @PutMapping("/update")
-    @Operation(summary = "更新crm联系人")
+    @Operation(summary = "更新联系人")
     @PreAuthorize("@ss.hasPermission('crm:contact:update')")
     public CommonResult<Boolean> updateContact(@Valid @RequestBody ContactUpdateReqVO updateReqVO) {
         contactService.updateContact(updateReqVO);
@@ -66,7 +67,7 @@ public class ContactController {
     }
 
     @DeleteMapping("/delete")
-    @Operation(summary = "删除crm联系人")
+    @Operation(summary = "删除联系人")
     @Parameter(name = "id", description = "编号", required = true)
     @PreAuthorize("@ss.hasPermission('crm:contact:delete')")
     public CommonResult<Boolean> deleteContact(@RequestParam("id") Long id) {
@@ -75,12 +76,14 @@ public class ContactController {
     }
 
     @GetMapping("/get")
-    @Operation(summary = "获得crm联系人")
+    @Operation(summary = "获得联系人")
     @Parameter(name = "id", description = "编号", required = true, example = "1024")
     @PreAuthorize("@ss.hasPermission('crm:contact:query')")
     public CommonResult<ContactRespVO> getContact(@RequestParam("id") Long id) {
         ContactDO contact = contactService.getContact(id);
+        // TODO @zyna：需要考虑 null 的情况；
         ContactRespVO contactRespVO  = ContactConvert.INSTANCE.convert(contact);
+        // TODO @zyna：可以把数据读完后，convert 统一交给 ContactConvert，让 controller 更简洁；而 convert 专门去做一些转换逻辑
         Map<Long, AdminUserRespDTO> userMap = adminUserApi.getUserMap(CollUtil.removeNull(Lists.newArrayList(
                 NumberUtil.parseLong(contact.getCreator()))));
         contactRespVO.setCreatorName(Optional.ofNullable(userMap.get(NumberUtil.parseLong(contact.getCreator()))).map(AdminUserRespDTO::getNickname).orElse(null));
@@ -88,27 +91,24 @@ public class ContactController {
         return success(contactRespVO);
     }
 
-    @GetMapping("/list")
-    @Operation(summary = "获得crm联系人列表")
-    @Parameter(name = "ids", description = "编号列表", required = true, example = "1024,2048")
-    @PreAuthorize("@ss.hasPermission('crm:contact:query')")
-    public CommonResult<List<ContactRespVO>> getContactList(@RequestParam("ids") Collection<Long> ids) {
-        List<ContactDO> list = contactService.getContactList(ids);
-        return success(ContactConvert.INSTANCE.convertList(list));
-    }
+    // TODO @zyna：url 使用中划线噢；然后，单词的拼写也要注意呀，AllList 是不是更好呀；
     @GetMapping("/simpleAlllist")
-    @Operation(summary = "获得crm联系人列表")
+    @Operation(summary = "获得联系人列表")
     @PreAuthorize("@ss.hasPermission('crm:contact:query')")
     public CommonResult<List<ContactSimpleRespVO>> simpleAlllist() {
+        // TODO @zyna：方法名改成，getContactList；方法命名，要动名词，get 动词；all 可以去掉，因为没条件，自然是全部
         List<ContactDO> list = contactService.allContactList();
         return success(ContactConvert.INSTANCE.convertAllList(list));
     }
+
     @GetMapping("/page")
-    @Operation(summary = "获得crm联系人分页")
+    @Operation(summary = "获得联系人分页")
     @PreAuthorize("@ss.hasPermission('crm:contact:query')")
     public CommonResult<PageResult<ContactRespVO>> getContactPage(@Valid ContactPageReqVO pageVO) {
         PageResult<ContactDO> pageData = contactService.getContactPage(pageVO);
         PageResult<ContactRespVO> pageResult =ContactConvert.INSTANCE.convertPage(pageData);
+        // TODO @zyna：需要考虑 null 的情况；
+        // TODO @zyna：可以把数据读完后，convert 统一交给 ContactConvert，让 controller 更简洁；而 convert 专门去做一些转换逻辑
         //待接口实现后修改
         List<CrmCustomerDO> crmCustomerDOList = crmCustomerService.getCustomerList(new CrmCustomerExportReqVO());
         Map<Long,CrmCustomerDO> crmCustomerDOMap = crmCustomerDOList.stream().collect(Collectors.toMap(CrmCustomerDO::getId,v->v));
@@ -118,8 +118,9 @@ public class ContactController {
         return success(pageResult);
     }
 
+    // TODO @zyna：可以看下新的导出写法，这里调整下
     @GetMapping("/export-excel")
-    @Operation(summary = "导出crm联系人 Excel")
+    @Operation(summary = "导出联系人 Excel")
     @PreAuthorize("@ss.hasPermission('crm:contact:export')")
     @OperateLog(type = EXPORT)
     public void exportContactExcel(@Valid ContactExportReqVO exportReqVO,

yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/controller/admin/contact/vo/ContactBaseVO.java

@@ -1,26 +1,25 @@
 package cn.iocoder.yudao.module.crm.controller.admin.contact.vo;
 
 import io.swagger.v3.oas.annotations.media.Schema;
-import lombok.*;
-
-import java.time.LocalDate;
-import java.util.*;
-import java.time.LocalDateTime;
-import java.time.LocalDateTime;
-import java.time.LocalDateTime;
-import javax.validation.constraints.*;
+import lombok.Data;
 import org.springframework.format.annotation.DateTimeFormat;
 
+import java.time.LocalDateTime;
+
 import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY;
 import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
 
+// TODO zyna：参考新的 vo，重新拆分下 VO
 /**
- * crm联系人 Base VO，提供给添加、修改、详细的子 VO 使用
+ * CRM 联系人 Base VO，提供给添加、修改、详细的子 VO 使用
  * 如果子 VO 存在差异的字段，请不要添加到这里，影响 Swagger 文档生成
  */
 @Data
 public class ContactBaseVO {
 
+    // TODO @zyna：example 最好都写下
+    // TODO @zyna：必要的字段校验，例如说 @Mobile，@Emal 等等
+
     @Schema(description = "下次联系时间")
     @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY)
     private LocalDateTime nextTime;

yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/controller/admin/contact/vo/ContactCreateReqVO.java

@@ -1,11 +1,11 @@
 package cn.iocoder.yudao.module.crm.controller.admin.contact.vo;
 
-import lombok.*;
-import java.util.*;
 import io.swagger.v3.oas.annotations.media.Schema;
-import javax.validation.constraints.*;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
 
-@Schema(description = "管理后台 - crm联系人创建 Request VO")
+@Schema(description = "管理后台 - CRM 联系人创建 Request VO")
 @Data
 @EqualsAndHashCode(callSuper = true)
 @ToString(callSuper = true)

yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/controller/admin/contact/vo/ContactExcelVO.java

@@ -1,22 +1,18 @@
 package cn.iocoder.yudao.module.crm.controller.admin.contact.vo;
 
-import io.swagger.v3.oas.annotations.media.Schema;
-import lombok.*;
-
-import java.time.LocalDate;
-import java.util.*;
-import java.time.LocalDateTime;
-import java.time.LocalDateTime;
-import java.time.LocalDateTime;
-
 import com.alibaba.excel.annotation.ExcelProperty;
+import lombok.Data;
 
+import java.time.LocalDateTime;
+
+// TODO @zyna：参考新的 VO 结构，把 ContactExcelVO 融合到 ContactRespVO 中
 /**
  * crm联系人 Excel VO
  *
  * @author 芋道源码
  */
 @Data
+@Deprecated
 public class ContactExcelVO {
 
     @ExcelProperty("下次联系时间")

yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/controller/admin/contact/vo/ContactExportReqVO.java

@@ -1,18 +1,17 @@
 package cn.iocoder.yudao.module.crm.controller.admin.contact.vo;
 
-import lombok.*;
-
-import java.time.LocalDate;
-import java.util.*;
 import io.swagger.v3.oas.annotations.media.Schema;
-import cn.iocoder.yudao.framework.common.pojo.PageParam;
-import java.time.LocalDateTime;
+import lombok.Data;
 import org.springframework.format.annotation.DateTimeFormat;
 
+import java.time.LocalDateTime;
+
 import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
 
+// TODO @zyna：参考新的 VO 结构，使用 ContactPageReqVO 查询导出的数据
 @Schema(description = "管理后台 - crm联系人 Excel 导出 Request VO，参数和 ContactPageReqVO 是一致的")
 @Data
+@Deprecated
 public class ContactExportReqVO {
 
     @Schema(description = "下次联系时间")

yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/controller/admin/contact/vo/ContactPageReqVO.java

@@ -1,12 +1,12 @@
 package cn.iocoder.yudao.module.crm.controller.admin.contact.vo;
 
-import lombok.*;
-
-import java.time.LocalDate;
-import java.util.*;
-import io.swagger.v3.oas.annotations.media.Schema;
 import cn.iocoder.yudao.framework.common.pojo.PageParam;
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
 import org.springframework.format.annotation.DateTimeFormat;
+
 import java.time.LocalDateTime;
 
 import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
@@ -17,6 +17,11 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_
 @ToString(callSuper = true)
 public class ContactPageReqVO extends PageParam {
 
+    // TODO @zyna：筛选条件
+    // ●客户：
+    // ●姓名：
+    // ●手机、电话、座机、QQ、微信、邮箱
+
     @Schema(description = "下次联系时间")
     @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)
     private LocalDateTime[] nextTime;

yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/controller/admin/contact/vo/ContactRespVO.java

@@ -4,19 +4,24 @@ import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.*;
 import java.time.LocalDateTime;
 
-@Schema(description = "管理后台 - crm联系人 Response VO")
+@Schema(description = "管理后台 - CRM 联系人 Response VO")
 @Data
 @EqualsAndHashCode(callSuper = true)
 @ToString(callSuper = true)
 public class ContactRespVO extends ContactBaseVO {
 
-    @Schema(description = "创建时间")
-    private LocalDateTime createTime;
-    @Schema(description = "创建人")
-    private String creatorName;
-    @Schema(description = "客户")
-    private String customerName;
     @Schema(description = "主键", requiredMode = Schema.RequiredMode.REQUIRED, example = "3167")
     private Long id;
 
+    @Schema(description = "创建时间")
+    private LocalDateTime createTime;
+
+    // TODO  @zyna：example 最好写下；
+
+    @Schema(description = "创建人")
+    private String creatorName;
+
+    @Schema(description = "客户名字")
+    private String customerName;
+
 }

yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/controller/admin/contact/vo/ContactSimpleRespVO.java

@@ -2,16 +2,13 @@ package cn.iocoder.yudao.module.crm.controller.admin.contact.vo;
 
 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
-import lombok.EqualsAndHashCode;
 import lombok.ToString;
 
-import java.time.LocalDateTime;
-
-@Schema(description = "管理后台 - crm联系人 Response VO")
+@Schema(description = "管理后台 - CRM 联系人 Response VO")
 @Data
 @ToString(callSuper = true)
 public class ContactSimpleRespVO {
-    @Schema(description = "姓名", example = "芋艿")
+    @Schema(description = "姓名", example = "芋艿") // TODO @zyna：requiredMode = Schema.RequiredMode.REQUIRED；需要空一行；字段的顺序改下，id 在 name 前面，会更干净
     private String name;
 
     @Schema(description = "主键", requiredMode = Schema.RequiredMode.REQUIRED, example = "3167")

yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/controller/admin/contact/vo/ContactUpdateReqVO.java

@@ -1,11 +1,13 @@
 package cn.iocoder.yudao.module.crm.controller.admin.contact.vo;
 
 import io.swagger.v3.oas.annotations.media.Schema;
-import lombok.*;
-import java.util.*;
-import javax.validation.constraints.*;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
 
-@Schema(description = "管理后台 - crm联系人更新 Request VO")
+import javax.validation.constraints.NotNull;
+
+@Schema(description = "管理后台 - CRM 联系人更新 Request VO")
 @Data
 @EqualsAndHashCode(callSuper = true)
 @ToString(callSuper = true)

yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/dal/dataobject/contact/ContactDO.java

@@ -1,17 +1,15 @@
 package cn.iocoder.yudao.module.crm.dal.dataobject.contact;
 
+import cn.iocoder.yudao.framework.mybatis.core.dataobject.BaseDO;
+import com.baomidou.mybatisplus.annotation.KeySequence;
+import com.baomidou.mybatisplus.annotation.TableId;
+import com.baomidou.mybatisplus.annotation.TableName;
 import lombok.*;
 
-import java.time.LocalDate;
-import java.util.*;
 import java.time.LocalDateTime;
-import java.time.LocalDateTime;
-import java.time.LocalDateTime;
-import com.baomidou.mybatisplus.annotation.*;
-import cn.iocoder.yudao.framework.mybatis.core.dataobject.BaseDO;
 
 /**
- * crm联系人 DO
+ * CRM 联系人 DO
  *
  * @author 芋道源码
  */
@@ -25,6 +23,7 @@ import cn.iocoder.yudao.framework.mybatis.core.dataobject.BaseDO;
 @AllArgsConstructor
 public class ContactDO extends BaseDO {
 
+    // TODO @zyna：这个字段的顺序，是不是整理下；
     /**
      * 下次联系时间
      */
@@ -57,11 +56,13 @@ public class ContactDO extends BaseDO {
      * 最后跟进时间
      */
     private LocalDateTime lastTime;
+    // TODO @zyna：这个放在最前面吧
     /**
      * 主键
      */
     @TableId
     private Long id;
+    // TODO @zyna：直接上级，最好写下它关联的字段，例如说这个，应该关联 ContactDO 的 id 字段
     /**
      * 直属上级
      */
@@ -78,18 +79,22 @@ public class ContactDO extends BaseDO {
      * QQ
      */
     private Long qq;
+    // TODO @zyna：wechat
     /**
      * 微信
      */
     private String webchat;
+    // TODO @zyna：关联的枚举
     /**
      * 性别
      */
     private Integer sex;
+    // TODO @zyna：这个字段改成 master 哈；
     /**
      * 是否关键决策人
      */
     private Boolean policyMakers;
+    // TODO @zyna：应该是 Long
     /**
      * 负责人用户编号
      */

yudao-module-crm/yudao-module-crm-biz/src/main/java/cn/iocoder/yudao/module/crm/service/contact/ContactServiceImpl.java

@@ -1,22 +1,24 @@
 package cn.iocoder.yudao.module.crm.service.contact;
 
-import org.springframework.stereotype.Service;
-import javax.annotation.Resource;
-import org.springframework.validation.annotation.Validated;
-
-import java.util.*;
-import cn.iocoder.yudao.module.crm.controller.admin.contact.vo.*;
-import cn.iocoder.yudao.module.crm.dal.dataobject.contact.ContactDO;
-import cn.iocoder.yudao.framework.common.pojo.PageResult;
-
-import cn.iocoder.yudao.module.crm.convert.contact.ContactConvert;
-import cn.iocoder.yudao.module.crm.dal.mysql.contact.ContactMapper;
-
-import static cn.iocoder.yudao.framework.common.exception.util.ServiceExceptionUtil.exception;
-import static cn.iocoder.yudao.module.crm.enums.ErrorCodeConstants.*;
-
 import cn.hutool.core.collection.CollUtil;
 import cn.hutool.core.collection.ListUtil;
+import cn.iocoder.yudao.framework.common.pojo.PageResult;
+import cn.iocoder.yudao.module.crm.controller.admin.contact.vo.ContactCreateReqVO;
+import cn.iocoder.yudao.module.crm.controller.admin.contact.vo.ContactExportReqVO;
+import cn.iocoder.yudao.module.crm.controller.admin.contact.vo.ContactPageReqVO;
+import cn.iocoder.yudao.module.crm.controller.admin.contact.vo.ContactUpdateReqVO;
+import cn.iocoder.yudao.module.crm.convert.contact.ContactConvert;
+import cn.iocoder.yudao.module.crm.dal.dataobject.contact.ContactDO;
+import cn.iocoder.yudao.module.crm.dal.mysql.contact.ContactMapper;
+import org.springframework.stereotype.Service;
+import org.springframework.validation.annotation.Validated;
+
+import javax.annotation.Resource;
+import java.util.Collection;
+import java.util.List;
+
+import static cn.iocoder.yudao.framework.common.exception.util.ServiceExceptionUtil.exception;
+import static cn.iocoder.yudao.module.crm.enums.ErrorCodeConstants.CONTACT_NOT_EXISTS;
 
 /**
  * crm联系人 Service 实现类
@@ -30,7 +32,7 @@ public class ContactServiceImpl implements ContactService {
     @Resource
     private ContactMapper contactMapper;
 
-    @Override
+    @Override // TODO @zyna：新增和修改时，关联字段要校验，例如说 直属上级，是不是真的存在；
     public Long createContact(ContactCreateReqVO createReqVO) {
         // 插入
         ContactDO contact = ContactConvert.INSTANCE.convert(createReqVO);