Ver código fonte

fix:补充自取地址管理功能的注释

kgy 5 meses atrás
pai
commit
c6b58321df

+ 36 - 1
ruoyi-modules/ruoyi-dataManagement/src/main/java/org/dromara/dataManagement/controller/SelfGetAddressController.java

@@ -21,32 +21,67 @@ import java.util.HashMap;
 /**
  * 自取地址管理接口
  */
-@SaIgnore
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/dataManagement/getAddress")
 public class SelfGetAddressController extends BaseController {
     private final SelfGetAddressService selfGetAddressService;
+
+    /**
+     * 查询自取地址管理列表
+     * @param selfGetAddressBo 地址Bo对象
+     * @param pageQuery 分页信息
+     * @return 查询结果
+     */
     @GetMapping("/PageList")
     public TableDataInfo<SelfGetAddressVo> selectPageSelfGetAddressList(SelfGetAddressBo selfGetAddressBo, PageQuery pageQuery){
         return selfGetAddressService.selectPageSelfGetAddressList(selfGetAddressBo,pageQuery);
     }
+
+    /**
+     * 新增地址
+     * @param selfGetAddressBo 地址Bo对象
+     * @return 新增结果
+     */
     @PostMapping()
     public R<Void> insertSelfGetAddress(@Validated @RequestBody SelfGetAddressBo selfGetAddressBo){
         return toAjax(selfGetAddressService.insertSelfGetAddress(selfGetAddressBo));
     }
+
+    /**
+     * 修改地址
+     * @param selfGetAddressBo 地址Bo对象
+     * @return 修改结果
+     */
     @PutMapping()
     public R<Void> updateSelfGetAddress(@Validated @RequestBody SelfGetAddressBo selfGetAddressBo){
         return toAjax(selfGetAddressService.updateSelfGetAddress(selfGetAddressBo));
     }
+
+    /**
+     * 批量删除地址
+     * @param selfGetAddressIds 地址Ids
+     * @return 删除结果
+     */
     @DeleteMapping("/{selfGetAddressIds}")
     public R<Void> deleteSelfGetAddressByIds(@PathVariable Long[] selfGetAddressIds){
         return toAjax(selfGetAddressService.deleteSelfGetAddressByIds(selfGetAddressIds));
     }
+
+    /**
+     * 通过Excel导出所有自取地址数据
+     * @param response 响应对象
+     */
     @GetMapping("/exportExcel")
     public void exportSelfGetAddressExcel(HttpServletResponse response){
         ExcelUtil.exportTemplate(CollUtil.newArrayList(new HashMap<>(),selfGetAddressService.selectList()),"自取地址列表.xlsx","excel/自取地址导出模板.xlsx",response);
     }
+
+    /**
+     * 根据职员Ids导出Excel
+     * @param selfGetAddressIds 职员Ids
+     * @param response 响应对象
+     */
     @GetMapping("/exportExcelByIds")
     public void exportSelfGetAddressExcelByIds(@RequestParam("ids") Long[] selfGetAddressIds, HttpServletResponse response){
         ExcelUtil.exportTemplate(CollUtil.newArrayList(new HashMap<>(),selfGetAddressService.selectSelfGetAddressByIds(selfGetAddressIds)),"自取地址列表.xlsx","excel/自取地址导出模板.xlsx",response);

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

@@ -5,6 +5,9 @@ import org.dromara.common.mybatis.core.mapper.BaseMapperPlus;
 import org.dromara.dataManagement.domain.SelfGetAddress;
 import org.dromara.dataManagement.domain.vo.SelfGetAddressVo;
 
+/**
+ * 自取地址管理Mapper
+ */
 @Mapper
 public interface SelfGetAddressMapper extends BaseMapperPlus<SelfGetAddress, SelfGetAddressVo> {
 }

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

@@ -8,16 +8,49 @@ import org.dromara.dataManagement.domain.vo.SelfGetAddressVo;
 
 import java.util.List;
 
+/**
+ * 自取地址Service接口
+ */
 public interface SelfGetAddressService {
+    /**
+     * 查询自取地址列表
+     * @param selfGetAddressBo 地址Bo对象
+     * @param pageQuery 分页信息
+     * @return 分页结果
+     */
     TableDataInfo<SelfGetAddressVo> selectPageSelfGetAddressList(SelfGetAddressBo selfGetAddressBo, PageQuery pageQuery);
 
+    /**
+     * 新增地址
+     * @param selfGetAddressBo 地址Bo对象
+     * @return 影响行数
+     */
     int insertSelfGetAddress(SelfGetAddressBo selfGetAddressBo);
 
+    /**
+     * 修改地址
+     * @param selfGetAddressBo 地址Bo对象
+     * @return 影响行数
+     */
     int updateSelfGetAddress(SelfGetAddressBo selfGetAddressBo);
 
+    /**
+     * 批量删除地址
+     * @param selfGetAddressIds 地址Ids
+     * @return 影响行数
+     */
     int deleteSelfGetAddressByIds(Long[] selfGetAddressIds);
 
+    /**
+     * 查询地址列表
+     * @return 地址列表
+     */
     List<SelfGetAddress> selectList();
 
+    /**
+     * 根据地址Ids查询地址列表
+     * @param selfGetAddressIds 地址Ids
+     * @return 地址列表
+     */
     List<SelfGetAddress> selectSelfGetAddressByIds(Long[] selfGetAddressIds);
 }

+ 28 - 0
ruoyi-modules/ruoyi-dataManagement/src/main/java/org/dromara/dataManagement/service/impl/SelfGetAddressServiceImpl.java

@@ -17,10 +17,20 @@ import org.springframework.stereotype.Service;
 import java.util.Arrays;
 import java.util.List;
 
+/**
+ * 自取地址管理业务实现
+ */
 @Service
 @RequiredArgsConstructor
 public class SelfGetAddressServiceImpl implements SelfGetAddressService {
     private final SelfGetAddressMapper selfGetAddressMapper;
+
+    /**
+     * 查询地址对象分页查询地址列表
+     * @param selfGetAddressBo 地址Bo对象
+     * @param pageQuery 查询条件
+     * @return 分页结果
+     */
     @Override
     public TableDataInfo<SelfGetAddressVo> selectPageSelfGetAddressList(SelfGetAddressBo selfGetAddressBo, PageQuery pageQuery) {
         QueryWrapper<SelfGetAddress> qw=new QueryWrapper<>();
@@ -30,11 +40,23 @@ public class SelfGetAddressServiceImpl implements SelfGetAddressService {
         Page<SelfGetAddressVo>page= selfGetAddressMapper.selectVoPage(pageQuery.build(),qw);
         return TableDataInfo.build(page);
     }
+
+    /**
+     * 新增地址
+     * @param selfGetAddressBo 地址Bo对象
+     * @return 新增结果
+     */
     @Override
     public int insertSelfGetAddress(SelfGetAddressBo selfGetAddressBo) {
         SelfGetAddress selfGetAddress= MapstructUtils.convert(selfGetAddressBo, SelfGetAddress.class);
         return selfGetAddressMapper.insert(selfGetAddress);
     }
+
+    /**
+     * 修改地址
+     * @param selfGetAddressBo 地址Bo对象
+     * @return 修改结果
+     */
     @Override
     public int updateSelfGetAddress(SelfGetAddressBo selfGetAddressBo) {
         SelfGetAddress selfGetAddress= MapstructUtils.convert(selfGetAddressBo, SelfGetAddress.class);
@@ -42,6 +64,12 @@ public class SelfGetAddressServiceImpl implements SelfGetAddressService {
         qw.eq("id",selfGetAddressBo.getId());
         return selfGetAddressMapper.updateById(selfGetAddress);
     }
+
+    /**
+     * 删除地址
+     * @param selfGetAddressIds 地址Ids
+     * @return 删除结果
+     */
     @Override
     public int deleteSelfGetAddressByIds(Long[] selfGetAddressIds) {
         return selfGetAddressMapper.deleteByIds(Arrays.asList(selfGetAddressIds));