فهرست منبع

fix:新增职员管理注释,修改车间服务注释

kgy 5 ماه پیش
والد
کامیت
b4de0c7cb6

+ 51 - 0
ruoyi-modules/ruoyi-dataManagement/src/main/java/org/dromara/dataManagement/controller/StaffController.java

@@ -21,42 +21,93 @@ import org.springframework.web.multipart.MultipartFile;
 import java.util.ArrayList;
 import java.util.HashMap;
 
+/**
+ * 职员管理接口
+ */
 @SaIgnore
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/dataManagement/staff")
 public class StaffController extends BaseController {
     private final StaffService staffService;
+
+    /**
+     * 查询职员管理列表
+     * @param staffBo 职员Bo对象
+     * @param pageQuery 分页信息
+     * @return 查询结果
+     */
     @GetMapping("/PageList")
     public TableDataInfo<StaffVo> selectPageStaffList(StaffBo staffBo, PageQuery pageQuery) {
         return staffService.selectPageStaffList(staffBo, pageQuery);
     }
+
+    /**
+     * 新增职员
+     * @param staffBo 职员Bo对象
+     * @return 新增结果
+     */
     @PostMapping()
     public R<Void> insertStaff(@Validated @RequestBody StaffBo staffBo) {
         return toAjax(staffService.insertStaff(staffBo));
     }
+
+    /**
+     * 修改职员
+     * @param staffBo 职员Bo对象
+     * @return 修改结果
+     */
     @PutMapping()
     public R<Void> updateStaff(@Validated @RequestBody StaffBo staffBo) {
         return toAjax(staffService.updateStaff(staffBo));
     }
+
+    /**
+     * 删除职员
+     * @param staffIds 职员ids
+     * @return 删除结果
+     */
     @DeleteMapping("/{staffIds}")
     public R<Void> deleteStaffByIds(@PathVariable Long[] staffIds) {
         return toAjax(staffService.deleteStaffByIds(staffIds));
     }
+
+    /**
+     * 下载职员导入模板
+     * @param response 响应对象
+     */
     @GetMapping("/downloadTemplate")
     public void getExampleExcel(HttpServletResponse response) {
         ExcelUtil.exportExcel(new ArrayList<>(),"职员导入模板", StaffExcelVo.class, response);
     }
+
+    /**
+     * 导入职员Excel
+     * @param file 文件对象
+     * @return 是否解析成功
+     * @throws Exception 运行错误
+     */
     @PostMapping("/importExcel")
     public R<Void> importExcel(@RequestPart("file") MultipartFile file) throws Exception {
         ExcelResult<StaffExcelVo> result = ExcelUtil.importExcel(file.getInputStream(), StaffExcelVo.class,false);
         staffService.insertImportExcel(result);
         return R.ok(result.getAnalysis());
     }
+
+    /**
+     * 通过Excel导出所有职员数据
+     * @param response 响应对象
+     */
     @GetMapping("/exportExcel")
     public void exportStaffExcel(HttpServletResponse response) {
         ExcelUtil.exportTemplate(CollUtil.newArrayList(new HashMap<>(),staffService.selectList()),"职员列表.xlsx","excel/职员导出模板.xlsx",response);
     }
+
+    /**
+     * 根据职员Ids导出Excel
+     * @param staffIds 职员Ids
+     * @param response 响应对象
+     */
     @GetMapping("/exportExcelByIds")
     public void exportStaffExcel(@RequestParam("ids") Long[] staffIds, HttpServletResponse response) {
         ExcelUtil.exportTemplate(CollUtil.newArrayList(new HashMap<>(),staffService.selectStaffListByIds(staffIds)),"职员列表.xlsx","excel/职员导出模板.xlsx",response);

+ 3 - 0
ruoyi-modules/ruoyi-dataManagement/src/main/java/org/dromara/dataManagement/domain/Staff.java

@@ -3,6 +3,9 @@ package org.dromara.dataManagement.domain;
 import com.baomidou.mybatisplus.annotation.TableName;
 import lombok.Data;
 
+/**
+ * 职员管理基类
+ */
 @Data
 @TableName("fa_kuyou_staff_member")
 public class Staff {

+ 3 - 0
ruoyi-modules/ruoyi-dataManagement/src/main/java/org/dromara/dataManagement/domain/bo/StaffBo.java

@@ -3,6 +3,9 @@ import io.github.linpeilie.annotations.AutoMapper;
 import lombok.Data;
 import org.dromara.dataManagement.domain.Staff;
 
+/**
+ * 职员管理业务对象
+ */
 @Data
 @AutoMapper(target = Staff.class, reverseConvertGenerate = false)
 public class StaffBo {

+ 3 - 0
ruoyi-modules/ruoyi-dataManagement/src/main/java/org/dromara/dataManagement/domain/vo/StaffExcelVo.java

@@ -7,6 +7,9 @@ import org.dromara.dataManagement.domain.Staff;
 
 import java.io.Serializable;
 
+/**
+ * 职员管理视图对象
+ */
 @Data
 @AutoMapper(target = Staff.class)
 public class StaffExcelVo implements Serializable {

+ 3 - 0
ruoyi-modules/ruoyi-dataManagement/src/main/java/org/dromara/dataManagement/domain/vo/StaffVo.java

@@ -4,6 +4,9 @@ import io.github.linpeilie.annotations.AutoMapper;
 import lombok.Data;
 import org.dromara.dataManagement.domain.Staff;
 
+/**
+ * 职员值对象
+ */
 @Data
 @AutoMapper(target = Staff.class)
 public class StaffVo {

+ 3 - 0
ruoyi-modules/ruoyi-dataManagement/src/main/java/org/dromara/dataManagement/mapper/StaffMapper.java

@@ -5,6 +5,9 @@ import org.dromara.common.mybatis.core.mapper.BaseMapperPlus;
 import org.dromara.dataManagement.domain.Staff;
 import org.dromara.dataManagement.domain.vo.StaffVo;
 
+/**
+ * 职员管理Mapper
+ */
 @Mapper
 public interface StaffMapper extends BaseMapperPlus<Staff, StaffVo> {
 }

+ 37 - 0
ruoyi-modules/ruoyi-dataManagement/src/main/java/org/dromara/dataManagement/service/StaffService.java

@@ -10,18 +10,55 @@ import org.dromara.dataManagement.domain.vo.StaffVo;
 
 import java.util.List;
 
+/**
+ * 职员Service接口
+ */
 public interface StaffService {
+    /**
+     * 查询职员列表
+     * @param staffBo 职员Bo对象
+     * @param pageQuery 分页信息
+     * @return 分页结果
+     */
     TableDataInfo<StaffVo> selectPageStaffList(StaffBo staffBo, PageQuery pageQuery);
 
+    /**
+     * 新增职员
+     * @param staffBo 职员Bo对象
+     * @return 影响行数
+     */
     int insertStaff(StaffBo staffBo);
 
+    /**
+     * 修改职员
+     * @param staffBo 职员Bo对象
+     * @return 影响行数
+     */
     int updateStaff(StaffBo staffBo);
 
+    /**
+     * 删除职员
+     * @param staffIds 职员Ids
+     * @return 影响行数
+     */
     int deleteStaffByIds(Long[] staffIds);
 
+    /**
+     * 导入职员Excel
+     * @param result 导入结果
+     */
     void insertImportExcel(ExcelResult<StaffExcelVo> result);
 
+    /**
+     * 查询职员列表
+     * @return 职员列表
+     */
     List<Staff> selectList();
 
+    /**
+     * 根据职员Ids查询职员列表
+     * @param staffIds 职员Ids
+     * @return
+     */
     List<Staff> selectStaffListByIds(Long[] staffIds);
 }

+ 3 - 3
ruoyi-modules/ruoyi-dataManagement/src/main/java/org/dromara/dataManagement/service/WorkShopService.java

@@ -28,7 +28,7 @@ public interface WorkShopService {
     int insertWorkShop(WorkShopBo workshopBo);
 
     /**
-     * 更新车间
+     * 修改车间
      * @param workshopBo 车间Bo对象
      * @return 影响行数
      */
@@ -36,7 +36,7 @@ public interface WorkShopService {
 
     /**
      * 删除车间
-     * @param workshopIds 车间id数组
+     * @param workshopIds 车间ids
      * @return 影响行数
      */
     int deleteWorkShopByIds(Long[] workshopIds);
@@ -49,7 +49,7 @@ public interface WorkShopService {
 
     /**
      * 根据车间Ids查询车间列表
-     * @param workshopIds 车间id数组
+     * @param workshopIds 车间ids
      * @return 车间列表
      */
     List<WorkShop> selectWorkshopListByIds(Long[] workshopIds);

+ 33 - 0
ruoyi-modules/ruoyi-dataManagement/src/main/java/org/dromara/dataManagement/service/impl/StaffServiceImpl.java

@@ -19,10 +19,20 @@ import org.springframework.stereotype.Service;
 import java.util.Arrays;
 import java.util.List;
 
+/**
+ * 职员管理业务实现
+ */
 @Service
 @RequiredArgsConstructor
 public class StaffServiceImpl implements StaffService {
     private final StaffMapper staffMapper;
+
+    /**
+     * 查询职员对象分页查询职员数据
+     * @param staffBo 职员Bo对象
+     * @param pageQuery 查询条件
+     * @return 分页结果
+     */
     @Override
     public TableDataInfo<StaffVo> selectPageStaffList(StaffBo staffBo, PageQuery pageQuery) {
         QueryWrapper<Staff> qw=new QueryWrapper<>();
@@ -33,11 +43,23 @@ public class StaffServiceImpl implements StaffService {
         Page<StaffVo> page =staffMapper.selectVoPage(pageQuery.build(),qw);
         return TableDataInfo.build(page);
     }
+
+    /**
+     * 新增职员
+     * @param staffBo 职员Bo对象
+     * @return 新增结果
+     */
     @Override
     public int insertStaff(StaffBo staffBo) {
         Staff staff= MapstructUtils.convert(staffBo, Staff.class);
         return staffMapper.insert(staff);
     }
+
+    /**
+     * 修改职员
+     * @param staffBo 职员Bo对象
+     * @return 修改结果
+     */
     @Override
     public int updateStaff(StaffBo staffBo) {
         Staff staff= MapstructUtils.convert(staffBo, Staff.class);
@@ -45,10 +67,21 @@ public class StaffServiceImpl implements StaffService {
         qw.eq("id",staffBo.getId());
         return staffMapper.updateById(staff);
     }
+
+    /**
+     * 删除职员
+     * @param staffIds 职员ids
+     * @return 删除结果
+     */
     @Override
     public int deleteStaffByIds(Long[] staffIds) {
         return staffMapper.deleteByIds(Arrays.asList(staffIds));
     }
+
+    /**
+     * 处理导入的Excel数据
+     * @param result Excel数据
+     */
     @Override
     public void insertImportExcel(ExcelResult<StaffExcelVo> result){
         for(StaffExcelVo staffExcelVo:result.getList()){