注释规范

src/main/java/com/mokamrp/privates/controller/FileContorller.java

@@ -21,6 +21,11 @@ public class FileContorller {
     @Autowired
     public FileService fileService;
 
+    /**
+     * 上传文件到oss
+     * @param zipFile
+     * @return
+     */
     @PostMapping("/upload")
     public Object upload(@RequestParam("file") MultipartFile zipFile){
         String url = fileService.uploadToOss(zipFile);

src/main/java/com/mokamrp/privates/controller/GroupController.java

@@ -33,7 +33,9 @@ public class GroupController extends BaseController<Group> {
      */
 
     /**
-     * 账号总揽
+     * 获取分组内的客服详细信息
+     * @param handle
+     * @param bindingResult
      * @return
      */
     @PostMapping("/list")
@@ -43,9 +45,7 @@ public class GroupController extends BaseController<Group> {
         if (bindingResult.hasErrors()) {
             return AjaxResult.error(HttpStatus.ERROR, bindingResult.getFieldError().getDefaultMessage());
         }
-
         Object res = groupService.selectGroupData(handle);
-
         return AjaxResult.success("success", res);
     }
 

src/main/java/com/mokamrp/privates/controller/GroupCorpController.java

@@ -41,12 +41,21 @@ public class GroupCorpController extends BaseController<GroupCorp> {
      * 如果需要定制化，需要将BaseController中对应的方法复制到当前控制器,然后进行修改
      */
 
+    /**
+     * 获取各企业分组内企业信息
+     * @return
+     */
     @GetMapping("/getGroupCorp")
     public Object getGroupCorp() {
         List<Map<String, Object>> res = groupCorpService.selectGroupCorp();
         return AjaxResult.success("success", res);
     }
 
+    /**
+     * 获取指定分组内企业信息
+     * @param groupId
+     * @return
+     */
     @GetMapping("/getCorpsByGroupId")
     public Object getCorpsByGroupId(@RequestParam String groupId) {
         if (groupId == null || groupId.isEmpty()) {

src/main/java/com/mokamrp/privates/controller/HealthyController.java

@@ -21,6 +21,10 @@ public class HealthyController {
     @Autowired
     public StringRedisTemplate stringRedisTemplate;
 
+    /**
+     * 健康监测接口
+     * @return
+     */
     @GetMapping("/healthy")
     public Object Healthy(){
         Map<String,Object> res = new HashMap<String,Object>();

src/main/java/com/mokamrp/privates/controller/LoginController.java

@@ -28,6 +28,12 @@ public class LoginController {
     @Autowired
     public UserService userService;
 
+    /**
+     * 执行登录
+     * @param loginHandle
+     * @param bindingResult
+     * @return
+     */
     @PostMapping("/dologin")
     public Object login(@Valid @RequestBody LoginHandle loginHandle, BindingResult bindingResult) {
         if (bindingResult.hasErrors()) {

src/main/java/com/mokamrp/privates/controller/WorkEmployeeController.java

@@ -58,23 +58,30 @@ public class WorkEmployeeController extends BaseController<WorkEmployee> {
      * 默认生成的控制器所继承的父类中有index/add/edit/del四个基础方法,均为post json请求
      * 如果需要定制化，需要将BaseController中对应的方法复制到当前控制器,然后进行修改
      */
-    @PostMapping("/getWorkEmployeeList")
-    public Object getWorkEmployeeList(@Valid @RequestBody WorkEmployeeHandle workEmployee, @AuthUser User authUser,
-                                      BindingResult bindingResult, HttpServletRequest request) {
 
+    /**
+     * 获取客服列表 旧版
+     *
+     * @param workEmployee
+     * @param authUser
+     * @param bindingResult
+     * @param request
+     * @return
+     */
+    @PostMapping("/getWorkEmployeeList")
+    public Object getWorkEmployeeList(@Valid @RequestBody WorkEmployeeHandle workEmployee, @AuthUser User authUser, BindingResult bindingResult, HttpServletRequest request) {
         XxlSsoUser user = (XxlSsoUser) request.getAttribute(Conf.SSO_USER);
-
         if (bindingResult.hasErrors()) {
             return AjaxResult.error(HttpStatus.LOGIN_ERROR, bindingResult.getFieldError().getDefaultMessage());
         }
-
         List<Integer> userCorpIds = userCorpService.getAuthUserCorpIds(authUser.getId().toString());
         Object res = workEmployeeService.selectWorkEmployeeList(authUser.getId().toString(), workEmployee);
         return AjaxResult.success(res);
     }
 
     /**
-     * 客服列表查询接口
+     * 客服列表查询接口 新版
+     *
      * @param authUser
      * @param handle
      * @param bindingResult
@@ -86,9 +93,9 @@ public class WorkEmployeeController extends BaseController<WorkEmployee> {
             return AjaxResult.error(HttpStatus.ERROR, bindingResult.getFieldError().getDefaultMessage());
         }
         List<Integer> corpIds = new ArrayList<Integer>();
-        if(authUser.getIsSuperAdmin() == 1){
+        if (authUser.getIsSuperAdmin() == 1) {
             corpIds = userCorpService.getAllCorpIds();
-        }else{
+        } else {
             corpIds = userCorpService.getAuthUserCorpIds(authUser.getId().toString());
         }
         if (corpIds.size() <= 0) {
@@ -117,11 +124,12 @@ public class WorkEmployeeController extends BaseController<WorkEmployee> {
 
     /**
      * 设置封禁时间和状态
+     *
      * @param setForbbidenHandle
      * @return
      */
     @PostMapping("/setForbidden")
-    public Object setForbidden(@RequestBody SetForbbidenHandle setForbbidenHandle, BindingResult bindingResult){
+    public Object setForbidden(@RequestBody SetForbbidenHandle setForbbidenHandle, BindingResult bindingResult) {
         if (bindingResult.hasErrors()) {
             return AjaxResult.error(HttpStatus.ERROR, bindingResult.getFieldError().getDefaultMessage());
         }
@@ -131,6 +139,7 @@ public class WorkEmployeeController extends BaseController<WorkEmployee> {
 
     /**
      * 导出客服列表
+     *
      * @param authUser
      * @param handle
      * @param bindingResult

src/main/java/com/mokamrp/privates/service/CorpService.java

@@ -16,13 +16,9 @@ import java.util.Map;
  * @since 2021-04-19
  */
 public interface CorpService extends IService<Corp> {
-    /**
-     * 通过企业Id获取企业信息
-     * @param corps
-     * @return
-     */
+    //.通过企业Id获取企业信息
     public List<Corp> getCorpInfoByCorpIds(List<Integer> corps);
 
-
-    public Map<String,Object> selectCorpList(CorpIndexHandle corpIndexHandle);
+    //.查询企业列表 支持分页 指定字段查询
+    public Map<String, Object> selectCorpList(CorpIndexHandle corpIndexHandle);
 }

src/main/java/com/mokamrp/privates/service/GroupCorpService.java

@@ -15,10 +15,10 @@ import java.util.Map;
  * @since 2021-04-20
  */
 public interface GroupCorpService extends IService<GroupCorp> {
-
+    //.获取各企业分组内企业信息
     public List<Map<String, Object>> selectGroupCorp();
-
+    //.绑定分组和企业
     public Boolean setGroupCorp(Integer groupId,List<Integer> corpIds);
-
+    //.解绑分组和企业
     public Boolean unSetGroupCorp(Integer groupId,Integer corpId);
 }

src/main/java/com/mokamrp/privates/service/GroupService.java

@@ -15,5 +15,6 @@ import java.util.Map;
  * @since 2021-04-20
  */
 public interface GroupService extends IService<Group> {
+    //.获取分组内的客服详细信息
     public Map<String, Object> selectGroupData(PostBasePageHandle handle);
 }

src/main/java/com/mokamrp/privates/service/UserService.java

@@ -14,6 +14,8 @@ import java.util.Map;
  * @since 2021-04-17
  */
 public interface UserService extends IService<User> {
+    //.执行登录
     public Map<String, Object> doLogin(String phone, String password);
+
     public void Insert(Map<String,String> info,String name);
 }

src/main/java/com/mokamrp/privates/service/WorkEmployeeService.java

@@ -19,15 +19,16 @@ import java.util.Map;
  * @since 2021-04-20
  */
 public interface WorkEmployeeService extends IService<WorkEmployee> {
+    //.获取客服列表 旧版
     public Object selectWorkEmployeeList(String authUserId, WorkEmployeeHandle workEmployee);
-
+    //.企业客服列表 支持分页
     public Map<String, Object> getPageList(PostWorkEmployee handle);
-
-    public Boolean updateForbiddenStatus();
-
+    //.定时任务 更新客服封禁状态
+    public Boolean updateForbbidenStatus();
+    //.设置封禁状态和时间
     public boolean setForbbiden(SetForbbidenHandle setForbbidenHandle);
-
+    //.导出
     public void export(Downfile downFile, PostWorkEmployee handle);
-
+    //.设置客服标签
     public boolean setTag(Integer tagId,List<Integer> employeeIds);
 }

src/main/java/com/mokamrp/privates/service/impl/CorpServiceImpl.java

@@ -39,6 +39,11 @@ public class CorpServiceImpl extends ServiceImpl<CorpMapper, Corp> implements Co
         return res;
     }
 
+    /**
+     * 查询企业列表 支持分页 指定字段查询
+     * @param corpIndexHandle
+     * @return
+     */
     public Map<String,Object> selectCorpList(CorpIndexHandle corpIndexHandle){
         Integer page = corpIndexHandle.getPage();
         Integer pagesize = corpIndexHandle.getPageSize();

src/main/java/com/mokamrp/privates/service/impl/GroupCorpServiceImpl.java

@@ -29,7 +29,6 @@ public class GroupCorpServiceImpl extends ServiceImpl<GroupCorpMapper, GroupCorp
 
     /**
      * 查询企业分组绑定关系
-     *
      * @return
      */
     @Override
@@ -40,6 +39,8 @@ public class GroupCorpServiceImpl extends ServiceImpl<GroupCorpMapper, GroupCorp
 
     /**
      * 企业绑定分组
+     * @param groupId
+     * @param corpIds
      * @return
      */
     public Boolean setGroupCorp(Integer groupId,List<Integer> corpIds){

src/main/java/com/mokamrp/privates/service/impl/GroupServiceImpl.java

@@ -35,6 +35,11 @@ public class GroupServiceImpl extends ServiceImpl<GroupMapper, Group> implements
     @Autowired
     public WorkRoomMapper workRoomMapper;
 
+    /**
+     * 获取分组内的客服详细信息
+     * @param handle
+     * @return
+     */
     @Override
     public Map<String, Object> selectGroupData(PostBasePageHandle handle) {
 

src/main/java/com/mokamrp/privates/service/impl/WorkEmployeeServiceImpl.java

@@ -86,7 +86,7 @@ public class WorkEmployeeServiceImpl extends ServiceImpl<WorkEmployeeMapper, Wor
      *
      * @return
      */
-    public Boolean updateForbiddenStatus() {
+    public Boolean updateForbbidenStatus() {
         List<WorkEmployee> workEmployeeList = this.list();
         long nowTime = new Date().getTime();
         for (WorkEmployee workEmployee : workEmployeeList) {
@@ -113,7 +113,7 @@ public class WorkEmployeeServiceImpl extends ServiceImpl<WorkEmployeeMapper, Wor
     }
 
     /**
-     * 企业客服列表
+     * 企业客服列表 支持分页
      *
      * @param handle
      * @return

src/main/java/com/mokamrp/privates/tast/WorkEmployeeForbiddenTask.java

@@ -15,6 +15,6 @@ public class WorkEmployeeForbiddenTask {
     @Scheduled(fixedDelay = 300 * 1000) //.间隔 半小时
     public void execute() {
         System.out.println("[cronjob]:客服封禁状态更新任务开始执行");
-        workEmployeeService.updateForbiddenStatus();
+        workEmployeeService.updateForbbidenStatus();
     }
 }