소스 검색

优化:代码注释

云殇忆 1 년 전
부모
커밋
2101d6848a

+ 28 - 14
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/PlanController.java

@@ -29,7 +29,7 @@ public class PlanController {
     @Autowired
     ISysUserService sysUserService;
 
-    // 广告管理
+//    广告管理
     /**
      * 上下架广告计划
      * @param planId
@@ -79,7 +79,7 @@ public class PlanController {
         return R.ok(planService.getPlanPushByCode(equipmentCode));
     }
 
-    // 广告计划管理
+//    广告计划管理
     /**
      * 审核广告计划
      * @param bo
@@ -125,13 +125,13 @@ public class PlanController {
         return R.ok(planService.getPlanManageDetail(planId));
     }
 
-    // 广告推送
+//     广告推送
     /**
      * 获取sign——用于测试
      * @param bo
      * @return
      */
-//    @SaCheckPermission("szzs:plan:test")
+    // @SaCheckPermission("szzs:plan:test")
     @PostMapping("/getSign")
     public R getSign(@RequestBody PlanAddBo bo){
         if (bo.getPlanStartTime() != null && bo.getPlanEndTime() != null)
@@ -166,7 +166,7 @@ public class PlanController {
      * @param planId
      * @return
      */
-//    @SaCheckPermission("szzs:plan:delete")
+    // @SaCheckPermission("szzs:plan:delete")
     @DeleteMapping("/{planId}")
     public R deletePlan(@PathVariable String planId){
         int i = planService.deletePlan(planId);
@@ -179,7 +179,7 @@ public class PlanController {
      * @param bo
      * @return
      */
-//    @SaCheckPermission("szzs:plan:list")
+    // @SaCheckPermission("szzs:plan:list")
     @PostMapping("/push/list")
     public R pushList(@RequestBody PlanBo bo){
         if (bo.getStartTime() != null && bo.getEndTime() != null)
@@ -189,8 +189,7 @@ public class PlanController {
         return R.ok(list);
     }
 
-
-    // 广告投放
+//     广告投放
     /**
      * 广告投放列表
      * @param bo
@@ -205,27 +204,42 @@ public class PlanController {
         PageInfo<List<PlanPushStatisticsListVo>> list = planService.getPlanPushStatisticsList(bo);
         return R.ok(list);
     }
-    // 立刻进行一次统计——用于测试
+    /**
+     * 立刻进行一次统计——用于测试
+     * @return
+     */
     @GetMapping("/statistics/start")
     public R statisticsStart(){
         planService.planPushStatisticsStart();
         return R.ok("更新完成");
     }
 
-    // 首页
-    // 获取总广告数
+//     首页
+    /**
+     * 获取总广告数
+     * @return
+     */
     @GetMapping("/total")
     public R total(){
         return R.ok(planService.getPlanTotal());
     }
 
-    // 其他
-    // 获取设备信息
+//     其他
+    /**
+     * 获取设备信息
+     * @param bo
+     * @return
+     */
     @PostMapping("/getEquipments")
     public R getEquipments(@RequestBody PlanBo bo){
         return R.ok(planService.getEquipments(bo));
     }
-    // 下拉框——获取省市区地区码
+    /**
+     * 下拉框——获取省市区地区码
+     * @param code
+     * @param level
+     * @return
+     */
     @GetMapping("/getAddrCategory")
     public R getAddrCategory(String code,String level){
         return R.ok(planService.getAddrCategoryLevel(code,level));

+ 19 - 4
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/StatisticsController.java

@@ -17,13 +17,21 @@ public class StatisticsController {
     @Autowired
     StatisticsService statisticsService;
 
-    // 扫码时间分布
+    /**
+     * 扫码时间分布
+     * @param option
+     * @return
+     */
     @GetMapping("/timeDis")
     public R timeDis(String option){
         return R.ok(statisticsService.getTimeDisToVo(option));
     }
 
-    // 获取扫描日志
+    /**
+     * 获取扫码日志
+     * @param bo
+     * @return
+     */
     @PostMapping("/scanList")
     public R scanList(@RequestBody PlanBo bo){
         if (bo.getStartTime() != null && bo.getEndTime() != null)
@@ -32,7 +40,10 @@ public class StatisticsController {
         return R.ok(statisticsService.getScanList(bo));
     }
 
-    // 获取总扫描次数
+    /**
+     * 获取总扫码次数
+     * @return
+     */
     @GetMapping("/total")
     public R scanTotal(){
         return R.ok(statisticsService.getScanTotal());
@@ -52,7 +63,11 @@ public class StatisticsController {
         return R.ok(sign);
     }
 
-    // 添加扫码行为记录
+    /**
+     * 添加扫码行为记录
+     * @param bo
+     * @return
+     */
     @PostMapping()
     public R add(@RequestBody @Validated(value = {AddGroup.class}) StatisticsAddBo bo){
         int i = statisticsService.add(bo);

+ 9 - 0
ruoyi-demo/src/main/java/com/ruoyi/demo/controller/SystemSetterController.java

@@ -15,6 +15,10 @@ public class SystemSetterController {
     @Autowired
     SystemSetterService systemSetterService;
 
+    /**
+     * 获取系统间隔配置信息
+     * @return
+     */
     @GetMapping("/getSystemSetter")
     public R getSystemSetter(){
         SystemSetter systemSetter = systemSetterService.getSystemSetter();
@@ -22,6 +26,11 @@ public class SystemSetterController {
         return R.ok(systemSetter);
     }
 
+    /**
+     * 修改系统间隔配置信息
+     * @param systemSetterVo
+     * @return
+     */
     @PutMapping("/updateSystemSetter")
     public R updateSystemSetter(@RequestBody @Validated(value = {EditGroup.class}) SystemSetterVo systemSetterVo){
         systemSetterService.updateSystemSetter(systemSetterVo);

+ 1 - 1
ruoyi-demo/src/main/java/com/ruoyi/demo/mapper/StatisticsMapper.java

@@ -20,7 +20,7 @@ public interface StatisticsMapper extends BaseMapper<Statistics> {
     // 累计收入
     Float selectTotalPriceByEquipmentCode(@Param("equipmentCode") String equipmentCode);
 
-    // 扫码记录
+//     扫码记录
     // 按月分析
     Integer selectTimeDisByMonth(@Param("month") String month);
     // 按日分析

+ 3 - 3
ruoyi-demo/src/main/java/com/ruoyi/demo/service/impl/StatisticsServiceImpl.java

@@ -126,17 +126,17 @@ public class StatisticsServiceImpl implements StatisticsService {
     @Override
     public Map<String, Integer> getTimeDis(String option) {
         Map<String, Integer> map = new LinkedHashMap<>();
-        if (option.equals("day")){
+        if (option.equals("day")){ // 时间粒度:天
             for (int i=0;i<30;i++){
                 String day = LocalDateTime.now(ZoneId.of("Asia/Shanghai")).plusDays(-i).format(DateTimeFormatter.ofPattern("yyyy-MM-dd"));
                 map.put(day,statisticsMapper.selectTimeDisByDay(day));
             }
-        } else if (option.equals("year")){
+        } else if (option.equals("year")){ // 时间粒度:年
             for (int i=0;i<12;i++){
                 String year = LocalDateTime.now(ZoneId.of("Asia/Shanghai")).plusYears(-i).format(DateTimeFormatter.ofPattern("yyyy"));
                 map.put(year,statisticsMapper.selectTimeDisByYear(year));
             }
-        } else {
+        } else { // 时间粒度:月
             for (int i=0;i<12;i++){
                 String month = LocalDateTime.now(ZoneId.of("Asia/Shanghai")).plusMonths(-i).format(DateTimeFormatter.ofPattern("yyyy-MM"));
                 map.put(month,statisticsMapper.selectTimeDisByMonth(month));