优化：代码注释，代码结构

ruoyi-demo/src/main/java/com/ruoyi/demo/service/PlanService.java

@@ -15,13 +15,18 @@ public interface PlanService {
     int addPlan(PlanAddBo bo);
     int deletePlan(String id);
     int deletePlans(List<String> ids);
+
+    // 审核广告
     int checkPlan(PlanBo bo,Long userId,String userName);
+
     PageInfo<List<PlanListVo>> getPlanList(PlanBo bo);
     PlanDetailVo getPlanDetail(String planId);
     List<PlanPushVo> getPlanPush(String equipmentId);
     List<PlanPushVo> getPlanPushByCode(String equipmentCode);
 
+    // 上下架广告计划
     int planUpDown(String planId);
+
     PageInfo<List<PlanManageListVo>> getPlanManageList(PlanBo bo);
     PlanManageDetailVo getPlanManageDetail(String planId);
     PageInfo<List<PlanPushListVo>> getPlanPushList(PlanBo bo);

ruoyi-demo/src/main/java/com/ruoyi/demo/service/impl/DlUserServiceImpl.java

@@ -33,9 +33,9 @@ public class DlUserServiceImpl implements DlUserService {
                     .or()
                     .like("user_telephone",bo.getText());
             });
-        if (bo.getStartTime() != null)
+        if (bo.getStartTime() != null) // 搜索开始时间小于等于最后接入时间
             queryWrapper.apply("end_time >= STR_TO_DATE({0},'%Y-%m-%d %H:%i:%s')",bo.getStartTime());
-        if (bo.getEndTime() != null)
+        if (bo.getEndTime() != null) // 搜索结束时间大于等于最后接入时间
             queryWrapper.apply("end_time <= STR_TO_DATE({0},'%Y-%m-%d %H:%i:%s')",bo.getEndTime());
         queryWrapper.eq("deleted","0");
         List<DlUser> dlUsers = dlUserMapper.selectList(queryWrapper);

ruoyi-demo/src/main/java/com/ruoyi/demo/service/impl/GoodsServiceImpl.java

@@ -66,9 +66,9 @@ public class GoodsServiceImpl implements GoodsService {
                     .or()
                     .like("goods_classify",bo.getText());
             });
-        if (bo.getStartTime() != null)
+        if (bo.getStartTime() != null) // 搜索开始时间小于等于商品创建时间
             queryWrapper.apply("create_time >= STR_TO_DATE({0},'%Y-%m-%d %H:%i:%s')",bo.getStartTime());
-        if (bo.getEndTime() != null)
+        if (bo.getEndTime() != null) // 搜索结束时间大于等于商品创建时间
             queryWrapper.apply("create_time <= STR_TO_DATE({0},'%Y-%m-%d %H:%i:%s')",bo.getEndTime());
         queryWrapper.eq("deleted","0");
         List<GoodsListVo> vos = new ArrayList<>();

ruoyi-demo/src/main/java/com/ruoyi/demo/service/impl/OrderServiceImpl.java

@@ -134,9 +134,9 @@ public class OrderServiceImpl implements OrderService {
                     .or()
                     .like("vendor_name",bo.getText());
             });
-        if (bo.getStartTime() != null)
+        if (bo.getStartTime() != null) // 搜索开始时间小于等于订单创建时间
             queryWrapper.apply("create_time >= STR_TO_DATE({0},'%Y-%m-%d %H:%i:%s')",bo.getStartTime());
-        if (bo.getEndTime() != null)
+        if (bo.getEndTime() != null) // 搜索结束时间大于等于订单创建时间
             queryWrapper.apply("create_time <= STR_TO_DATE({0},'%Y-%m-%d %H:%i:%s')",bo.getEndTime());
         List<Order> orders = orderMapper.selectList(queryWrapper);
         List<OrderVo> vos = new ArrayList<>();

ruoyi-demo/src/main/java/com/ruoyi/demo/service/impl/PlanServiceImpl.java

@@ -209,9 +209,9 @@ public class PlanServiceImpl implements PlanService {
                     .or()
                     .like("principal_telephone",bo.getText());
             });
-        if (bo.getStartTime() != null)
+        if (bo.getStartTime() != null) // 搜索开始时间小于等于广告计划创建时间
             planQueryWrapper.apply("plan_create_time >= STR_TO_DATE({0},'%Y-%m-%d %H:%i:%s')",bo.getStartTime());
-        if (bo.getEndTime() != null)
+        if (bo.getEndTime() != null) // 搜索结束时间大于等于广告计划创建时间
             planQueryWrapper.apply("plan_create_time <= STR_TO_DATE({0},'%Y-%m-%d %H:%i:%s')",bo.getEndTime());
         planQueryWrapper.eq("state", StateUtil.APPROVED);
         planQueryWrapper.eq("deleted","0");
@@ -254,8 +254,11 @@ public class PlanServiceImpl implements PlanService {
         List<PlanItem> items = planItemMapper.selectList(itemQueryWrapper);
         for (PlanItem item : items){
             QueryWrapper<Plan> planQueryWrapper = new QueryWrapper<>();
+
+            // 广告计划开始时间 <= 当前时间 < 广告计划结束时间
             planQueryWrapper.apply("plan_start_time <= STR_TO_DATE({0},'%Y-%m-%d %H:%i:%s')",LocalDateTime.now(ZoneId.of("Asia/Shanghai")));
             planQueryWrapper.apply("plan_end_time > STR_TO_DATE({0},'%Y-%m-%d %H:%i:%s')",LocalDateTime.now(ZoneId.of("Asia/Shanghai")));
+
             planQueryWrapper.eq("plan_id",item.getPlanId());
             planQueryWrapper.eq("state",StateUtil.APPROVED);
             planQueryWrapper.eq("deleted","0");
@@ -279,8 +282,11 @@ public class PlanServiceImpl implements PlanService {
         for (PlanItem item : items){ // 根据计划子项查询计划，并补齐返回信息
             QueryWrapper<Plan> planQueryWrapper = new QueryWrapper<>();
             planQueryWrapper.eq("plan_id",item.getPlanId());
+
+            // 广告计划开始时间 <= 当前时间 < 广告计划结束时间
             planQueryWrapper.apply("plan_start_time <= STR_TO_DATE({0},'%Y-%m-%d %H:%i:%s')",LocalDateTime.now(ZoneId.of("Asia/Shanghai")));
             planQueryWrapper.apply("plan_end_time > STR_TO_DATE({0},'%Y-%m-%d %H:%i:%s')",LocalDateTime.now(ZoneId.of("Asia/Shanghai")));
+
             planQueryWrapper.eq("state",StateUtil.APPROVED);
             planQueryWrapper.eq("on_state", OnStateUtil.UP);
             planQueryWrapper.eq("deleted","0");
@@ -350,7 +356,7 @@ public class PlanServiceImpl implements PlanService {
         itemQueryWrapper.eq("deleted","0");
         List<PlanItem> items = planItemMapper.selectList(itemQueryWrapper);
         List<PlanManageItemVo> itemVos = new ArrayList<>();
-        for (PlanItem item : items){
+        for (PlanItem item : items){ // 补齐店铺信息
             PlanManageItemVo itemVo = new PlanManageItemVo(item);
             if (item.getStoreId() != null){
                 Store store = storeMapper.selectById(item.getStoreId());
@@ -388,6 +394,7 @@ public class PlanServiceImpl implements PlanService {
         List<PlanPushListVo> vos = new ArrayList<>();
         for (Plan plan : plans){
             PlanPushListVo vo = new PlanPushListVo(plan);
+            // 根据计划id获取设备数量
             Integer count = planItemMapper.selectEquipmentCountByPlanId(plan.getPlanId());
             vo.setEquipmentCount(count);
             vos.add(vo);
@@ -443,14 +450,8 @@ public class PlanServiceImpl implements PlanService {
             planPushStatistics.setCarouselCount(carousalCount);
             planPushStatistics.setScanCodeCount(scanCount);
             planPushStatistics.setTradeCount(tradeCount);
-            if (users == null)
-                planPushStatistics.setTotalUserCount(0);
-            else
-                planPushStatistics.setTotalUserCount(users.size());
-            if (totalPrice == null)
-                planPushStatistics.setTotalPrice(Float.valueOf(0));
-            else
-                planPushStatistics.setTotalPrice(totalPrice);
+            planPushStatistics.setTotalUserCount(users == null ? 0 : users.size());
+            planPushStatistics.setTotalPrice(totalPrice == null ? Float.valueOf(0) : totalPrice);
             planPushStatistics.setLasterTime(LocalDateTime.now(ZoneId.of("Asia/Shanghai")));
             planPushStatisticsMapper.insert(planPushStatistics);
         }
@@ -509,9 +510,11 @@ public class PlanServiceImpl implements PlanService {
             });
         if (bo.getAddrCodes() != null){
             for (String addrCode : bo.getAddrCodes()){
+                // 拆分地址码
                 String province = String.valueOf(addrCode.charAt(0))+String.valueOf(addrCode.charAt(1));
                 String city = String.valueOf(addrCode.charAt(2))+String.valueOf(addrCode.charAt(3));
                 String district = String.valueOf(addrCode.charAt(4))+String.valueOf(addrCode.charAt(5));
+
                 if (district.equals("00")){
                     if (city.equals("00"))
                         equipmentQueryWrapper.or().likeRight("addr_code",province);

ruoyi-demo/src/main/java/com/ruoyi/demo/utils/MtStarUtil.java

@@ -56,6 +56,7 @@ public class MtStarUtil {
         return "error";
     }
 
+    // 唤醒与休眠，0：休眠，1：唤醒
     public String wakeUpAndDormancy(String equipmentCode, int onoff){
         StringBuffer callBack = new StringBuffer();
         callBack.append(mtStarProperties.getUrl()).append("sendClientParams");
@@ -121,9 +122,9 @@ public class MtStarUtil {
 
         map.put("state", state);
         map.put("select_name", selectName);
-//        log.info("满天星获取设备列表 请求参数 = {}", map);
+        // log.info("满天星获取设备列表 请求参数 = {}", map);
         String post = HttpUtil.post(mtStarProperties.getUrl() + "dev_get_devs_cmarks", map);
-//        log.info("post返回 {}", post);
+        // log.info("post返回 {}", post);
         JSONObject jsonObject = JSONUtil.parseObj(post);
         if ("0".equals(jsonObject.getStr("retCode"))) {
             return jsonObject.getStr("cMarkList");

ruoyi-demo/src/main/java/com/ruoyi/demo/utils/OnStateUtil.java

@@ -9,6 +9,7 @@ public class OnStateUtil {
     public static int DOWN = 0;
     public static String DOWN_CHAR = "下架";
 
+    // 根据code获取对应的字符串
     public static String getOnStateChar(int onState){
         if (onState == UP)
             return UP_CHAR;

ruoyi-demo/src/main/java/com/ruoyi/demo/utils/SendCallBackUtil.java

@@ -6,6 +6,7 @@ import org.springframework.web.client.RestTemplate;
 import java.time.LocalDateTime;
 
 public class SendCallBackUtil {
+    // 例子
     public static void testCallBack(String callBack){
         RestTemplate restTemplate = new RestTemplate();
         CallBackBean callBackBean = new CallBackBean();
@@ -17,6 +18,7 @@ public class SendCallBackUtil {
         restTemplate.postForObject(callBack,callBackBean,String.class);
     }
 
+    // 实际使用
     public static void sendCallBack(String callBack,CallBackBean callBackBean){
         RestTemplate restTemplate = new RestTemplate();
         restTemplate.postForObject(callBack,callBackBean,String.class);

ruoyi-demo/src/main/java/com/ruoyi/demo/utils/SignUtil.java

@@ -21,6 +21,7 @@ public class SignUtil {
         return sign.equals(signed);
     }
 
+    // 项目中实际使用的
     public static String sign(Map<String, Object> params, String appSecret) {
         params.remove("sign");
         String data = MapUtil.sortJoin(params, "", "", true);
@@ -29,6 +30,7 @@ public class SignUtil {
         return md5.toUpperCase();
     }
 
+    // 项目中实际使用的
     public static boolean verify(Map<String, Object> params, String appSecret) {
         String signed = (String) params.remove("sign");
         String sign = sign(params, appSecret);

ruoyi-demo/src/main/java/com/ruoyi/demo/utils/StateUtil.java

@@ -11,6 +11,7 @@ public class StateUtil {
     public static int NOT_APPROVED = 2;
     public static String NOT_APPROVED_CHAR = "审核未通过";
 
+    // 根据code获取对应的字符串
     public static String getStateName(int state){
         if (state == NOT_AUDITED)
             return NOT_AUDITED_CHAR;