BJ_ZTEITS-Developers / parking-cloud-yudao

Commit f349fbf84a03c5926e9bd9ebeafef5699377836c

Authored by wangjingyi
1 parent 1a120cd0

邮件模块swagger注释修改

Inline Side-by-side
Showing 19 changed files with 166 additions and 37 deletions
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/MailAccountController.java
  View file @f349fbf
... ... @@ -7,7 +7,7 @@ import cn.iocoder.yudao.module.system.controller.admin.mail.vo.account.MailAccou
7 7 import cn.iocoder.yudao.module.system.controller.admin.mail.vo.account.MailAccountCreateReqVO;
8 8 import cn.iocoder.yudao.module.system.controller.admin.mail.vo.account.MailAccountPageReqVO;
9 9 import cn.iocoder.yudao.module.system.controller.admin.mail.vo.account.MailAccountUpdateReqVO;
10   -import cn.iocoder.yudao.module.system.controller.admin.mail.vo.send.MailSendVO;
  10 +import cn.iocoder.yudao.module.system.controller.admin.mail.vo.send.MailReqVO;
11 11 import cn.iocoder.yudao.module.system.convert.mail.MailAccountConvert;
12 12 import cn.iocoder.yudao.module.system.dal.dataobject.mail.MailAccountDO;
13 13 import cn.iocoder.yudao.module.system.service.mail.MailAccountService;
... ... @@ -29,8 +29,9 @@ import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
29 29 @RestController
30 30 @RequestMapping("/system/mail-account")
31 31 public class MailAccountController {
  32 +
32 33 @Resource
33   - private MailAccountService mailAccountService; // TODO @wangjingyi：属性和类名，中间要空一行
  34 + private MailAccountService mailAccountService;
34 35  
35 36 @PostMapping("/create")
36 37 @ApiOperation("创建邮箱账号")
... ... @@ -50,8 +51,9 @@ public class MailAccountController {
50 51  
51 52 @DeleteMapping("/delete")
52 53 @ApiOperation("删除邮箱账号")
53   - @PreAuthorize("@ss.hasPermission('system:mail-account:delete')") // TODO @wangjingyi：id 应该是 @RequestParam。另外，id 的 swagger 注解，要写下
54   - public CommonResult<Boolean> deleteMailAccount(@Valid @RequestBody Long id) {
  54 + @ApiImplicitParam(name = "id", value = "编号", required = true, dataTypeClass = Long.class)
  55 + @PreAuthorize("@ss.hasPermission('system:mail-account:delete')")
  56 + public CommonResult<Boolean> deleteMailAccount(@Valid @RequestParam Long id) {
55 57 mailAccountService.delete(id);
56 58 return success(true);
57 59 }
... ... @@ -63,8 +65,7 @@ public class MailAccountController {
63 65 public CommonResult<MailAccountBaseVO> getMailAccount(@RequestParam("id") Long id) {
64 66 MailAccountDO mailAccountDO = mailAccountService.getMailAccount(id);
65 67 return success(MailAccountConvert.INSTANCE.convert(mailAccountDO));
66   - } // TODO wangjingyi：方法与方法之间，只空一行
67   -
  68 + }
68 69  
69 70 @GetMapping("/page")
70 71 @ApiOperation("获得邮箱账号分页")
... ... @@ -82,11 +83,12 @@ public class MailAccountController {
82 83 list.sort(Comparator.comparing(MailAccountDO::getId));
83 84 return success(MailAccountConvert.INSTANCE.convertList02(list));
84 85 }
85   - @PostMapping("/send") // TODO wangjingyi：方法与方法之间，空一行
  86 +
  87 + @PostMapping("/send")
86 88 @ApiOperation("发送邮件")
87 89 @PreAuthorize("@ss.hasPermission('system:mail-account:send')")
88   - public CommonResult<Boolean> sendMail(MailSendVO mailSendVO){
89   - mailAccountService.sendMail(mailSendVO);
  90 + public CommonResult<Boolean> sendMail(MailReqVO mailReqVO){
  91 + mailAccountService.sendMail(mailReqVO);
90 92 return success(true);
91 93 }
92 94 }
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/account/MailAccountBaseVO.java
  View file @f349fbf
1 1 package cn.iocoder.yudao.module.system.controller.admin.mail.vo.account;
2 2  
  3 +import io.swagger.annotations.ApiModel;
3 4 import io.swagger.annotations.ApiModelProperty;
4 5 import lombok.Data;
5   -
  6 +@ApiModel("管理后台 - 邮箱账号基类 Base VO")
6 7 @Data
7 8 public class MailAccountBaseVO {
8 9  
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/account/MailAccountCreateReqVO.java
  View file @f349fbf
1 1 package cn.iocoder.yudao.module.system.controller.admin.mail.vo.account;
2 2  
  3 +import io.swagger.annotations.ApiModel;
3 4 import lombok.Data;
  5 +import lombok.EqualsAndHashCode;
  6 +import lombok.ToString;
4 7  
5   -@Data // TODO @wangjingyi：swagger 注解
6   -public class MailAccountCreateReqVO extends MailAccountBaseVO{ // TODO @wangjingyi：要空格再 {
  8 +@ApiModel("管理后台 - 邮箱账号创建 Request VO")
  9 +@Data
  10 +@EqualsAndHashCode(callSuper = true)
  11 +@ToString(callSuper = true)
  12 +public class MailAccountCreateReqVO extends MailAccountBaseVO {
7 13  
8 14 }
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/account/MailAccountPageReqVO.java
  View file @f349fbf
1 1 package cn.iocoder.yudao.module.system.controller.admin.mail.vo.account;
2 2  
3 3 import cn.iocoder.yudao.framework.common.pojo.PageParam;
  4 +import io.swagger.annotations.ApiModel;
4 5 import io.swagger.annotations.ApiModelProperty;
5 6 import lombok.Data;
  7 +import lombok.EqualsAndHashCode;
  8 +import lombok.ToString;
6 9  
  10 +@ApiModel("管理后台 - 邮箱账号分页 Request VO")
7 11 @Data
  12 +@EqualsAndHashCode(callSuper = true)
  13 +@ToString(callSuper = true)
8 14 public class MailAccountPageReqVO extends PageParam {
9 15 @ApiModelProperty(value = "邮箱" , required = true , example = "yudaoyuanma@123.com")
10 16 private String from;
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/account/MailAccountUpdateReqVO.java
  View file @f349fbf
1 1 package cn.iocoder.yudao.module.system.controller.admin.mail.vo.account;
2 2  
  3 +import io.swagger.annotations.ApiModel;
  4 +import io.swagger.annotations.ApiModelProperty;
3 5 import lombok.Data;
  6 +import lombok.EqualsAndHashCode;
  7 +import lombok.ToString;
4 8  
  9 +import javax.validation.constraints.NotNull;
  10 +
  11 +@ApiModel("管理后台 - 邮箱账号修改 Request VO")
5 12 @Data
6   -public class MailAccountUpdateReqVO extends MailAccountBaseVO{
  13 +@EqualsAndHashCode(callSuper = true)
  14 +@ToString(callSuper = true)
  15 +public class MailAccountUpdateReqVO extends MailAccountBaseVO {
7 16  
8   - // TODO @wangjingyi：更新的话，是不是要有个 id？？？
  17 + @ApiModelProperty(value = "编号", required = true, example = "1024")
  18 + @NotNull(message = "编号不能为空")
  19 + private Long id;
9 20  
10 21 }
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/log/MailLogBaseVO.java
  View file @f349fbf
... ... @@ -2,13 +2,17 @@ package cn.iocoder.yudao.module.system.controller.admin.mail.vo.log;
2 2  
3 3 import com.baomidou.mybatisplus.annotation.TableField;
4 4 import com.baomidou.mybatisplus.annotation.TableId;
  5 +import io.swagger.annotations.ApiModel;
5 6 import io.swagger.annotations.ApiModelProperty;
  7 +import lombok.Data;
6 8 import org.springframework.format.annotation.DateTimeFormat;
7 9  
8 10 import java.sql.Timestamp;
9 11  
10 12 import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
11 13  
  14 +@ApiModel("管理后台 - 邮箱日志基类 Base VO")
  15 +@Data
12 16 public class MailLogBaseVO {
13 17  
14 18 @ApiModelProperty(value = "邮箱" , required = false , example = "yudaoyuanma@123.com")
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/log/MailLogExcelVO.java
  View file @f349fbf
1 1 package cn.iocoder.yudao.module.system.controller.admin.mail.vo.log;
2 2  
3 3 import com.alibaba.excel.annotation.ExcelProperty;
  4 +import io.swagger.annotations.ApiModel;
4 5 import lombok.Data;
5 6 import org.springframework.format.annotation.DateTimeFormat;
6 7  
... ... @@ -8,6 +9,7 @@ import java.sql.Timestamp;
8 9  
9 10 import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
10 11  
  12 +@ApiModel("管理后台 - 邮箱日志导出 Request VO")
11 13 @Data
12 14 public class MailLogExcelVO {
13 15  
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/log/MailLogExportReqVO.java
  View file @f349fbf
1 1 package cn.iocoder.yudao.module.system.controller.admin.mail.vo.log;
2 2  
3   -public class MailLogExportReqVO extends MailLogPageReqVO{
  3 +import io.swagger.annotations.ApiModel;
  4 +import lombok.Data;
  5 +
  6 +@ApiModel("管理后台 - 邮箱日志导出 Request VO")
  7 +@Data
  8 +public class MailLogExportReqVO extends MailLogPageReqVO {
4 9 }
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/log/MailLogPageReqVO.java
  View file @f349fbf
1 1 package cn.iocoder.yudao.module.system.controller.admin.mail.vo.log;
2 2  
3 3 import cn.iocoder.yudao.framework.common.pojo.PageParam;
  4 +import io.swagger.annotations.ApiModel;
4 5 import io.swagger.annotations.ApiModelProperty;
5 6 import lombok.Data;
  7 +import lombok.EqualsAndHashCode;
  8 +import lombok.ToString;
6 9 import org.springframework.format.annotation.DateTimeFormat;
7 10  
8 11 import java.sql.Timestamp;
9 12  
10 13 import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
11 14  
  15 +@ApiModel("管理后台 - 邮箱日志分页 Request VO")
12 16 @Data
  17 +@EqualsAndHashCode(callSuper = true)
  18 +@ToString(callSuper = true)
13 19 public class MailLogPageReqVO extends PageParam {
14 20 @ApiModelProperty(value = "邮箱" , required = false , example = "yudaoyuanma@123.com")
15 21 private String from;
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/log/MailLogRespVO.java
  View file @f349fbf
1 1 package cn.iocoder.yudao.module.system.controller.admin.mail.vo.log;
2 2  
  3 +import io.swagger.annotations.ApiModel;
3 4 import io.swagger.annotations.ApiModelProperty;
4 5 import lombok.Data;
5 6 import org.springframework.format.annotation.DateTimeFormat;
... ... @@ -7,6 +8,8 @@ import org.springframework.format.annotation.DateTimeFormat;
7 8 import java.sql.Timestamp;
8 9  
9 10 import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND;
  11 +
  12 +@ApiModel("管理后台 - 邮箱日志返回 Request VO")
10 13 @Data
11 14 public class MailLogRespVO {
12 15  
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplateBaseVO.java
  View file @f349fbf
1 1 package cn.iocoder.yudao.module.system.controller.admin.mail.vo.template;
2 2  
  3 +import io.swagger.annotations.ApiModel;
3 4 import io.swagger.annotations.ApiModelProperty;
4 5 import lombok.Data;
5 6  
  7 +@ApiModel("管理后台 - 邮箱模版基类 Base VO")
6 8 @Data
7 9 public class MailTemplateBaseVO {
8 10 @ApiModelProperty("主键")
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplateCreateReqVO.java
  View file @f349fbf
1 1 package cn.iocoder.yudao.module.system.controller.admin.mail.vo.template;
2 2  
3   -import io.swagger.annotations.ApiModelProperty;
  3 +import io.swagger.annotations.ApiModel;
4 4 import lombok.Data;
  5 +import lombok.EqualsAndHashCode;
  6 +import lombok.ToString;
5 7  
  8 +@ApiModel("管理后台 - 邮箱模版创建 Request VO")
6 9 @Data
7   -public class MailTemplateCreateReqVO extends MailTemplateBaseVO{
  10 +@EqualsAndHashCode(callSuper = true)
  11 +@ToString(callSuper = true)
  12 +public class MailTemplateCreateReqVO extends MailTemplateBaseVO {
8 13  
9 14  
10 15 }
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplatePageReqVO.java
  View file @f349fbf
1 1 package cn.iocoder.yudao.module.system.controller.admin.mail.vo.template;
2 2  
3 3 import cn.iocoder.yudao.framework.common.pojo.PageParam;
  4 +import io.swagger.annotations.ApiModel;
4 5 import io.swagger.annotations.ApiModelProperty;
5 6 import lombok.Data;
  7 +import lombok.EqualsAndHashCode;
  8 +import lombok.ToString;
6 9  
  10 +@ApiModel("管理后台 - 邮箱模版分页 Request VO")
7 11 @Data
  12 +@EqualsAndHashCode(callSuper = true)
  13 +@ToString(callSuper = true)
8 14 public class MailTemplatePageReqVO extends PageParam {
9 15 @ApiModelProperty("主键")
10 16 private Long id;
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplateUpdateReqVO.java
  View file @f349fbf
1 1 package cn.iocoder.yudao.module.system.controller.admin.mail.vo.template;
2 2  
  3 +import io.swagger.annotations.ApiModel;
  4 +import io.swagger.annotations.ApiModelProperty;
3 5 import lombok.Data;
  6 +import lombok.EqualsAndHashCode;
  7 +import lombok.ToString;
4 8  
  9 +import javax.validation.constraints.NotNull;
  10 +
  11 +@ApiModel("管理后台 - 邮箱模版修改 Request VO")
5 12 @Data
6   -public class MailTemplateUpdateReqVO extends MailTemplateBaseVO{
  13 +@EqualsAndHashCode(callSuper = true)
  14 +@ToString(callSuper = true)
  15 +public class MailTemplateUpdateReqVO extends MailTemplateBaseVO {
  16 +
  17 + @ApiModelProperty(value = "编号", required = true, example = "1024")
  18 + @NotNull(message = "编号不能为空")
  19 + private Long id;
7 20 }
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/service/mail/MailAccountService.java
  View file @f349fbf
... ... @@ -4,33 +4,61 @@ import cn.iocoder.yudao.framework.common.pojo.PageResult;
4 4 import cn.iocoder.yudao.module.system.controller.admin.mail.vo.account.MailAccountCreateReqVO;
5 5 import cn.iocoder.yudao.module.system.controller.admin.mail.vo.account.MailAccountPageReqVO;
6 6 import cn.iocoder.yudao.module.system.controller.admin.mail.vo.account.MailAccountUpdateReqVO;
7   -import cn.iocoder.yudao.module.system.controller.admin.mail.vo.send.MailSendVO;
  7 +import cn.iocoder.yudao.module.system.controller.admin.mail.vo.send.MailReqVO;
8 8 import cn.iocoder.yudao.module.system.dal.dataobject.mail.MailAccountDO;
9 9  
10 10 import java.util.List;
11 11  
12 12  
13 13 /**
14   - * <p>
15 14 * 邮箱账号 Service 接口
16   - * </p> // TODO wangjingyi：不用 <p></p> 标签；
17 15 *
18 16 * @author wangjingyi
19 17 * @since 2022-03-21
20 18 */
21   -public interface MailAccountService { // TODO wangjingyi：方法的注释
22   -
  19 +public interface MailAccountService {
  20 + /**
  21 + * 创建邮箱账号
  22 + * @param createReqVO
  23 + * @return
  24 + */
23 25 Long create(MailAccountCreateReqVO createReqVO);
24 26  
  27 + /**
  28 + * 修改邮箱账号
  29 + * @param updateReqVO
  30 + */
25 31 void update(MailAccountUpdateReqVO updateReqVO);
26 32  
  33 + /**
  34 + * 删除邮箱账号
  35 + * @param id
  36 + */
27 37 void delete(Long id);
28 38  
  39 + /**
  40 + * 获取邮箱账号信息
  41 + * @param id
  42 + * @return
  43 + */
29 44 MailAccountDO getMailAccount(Long id);
30 45  
  46 + /**
  47 + * 获取邮箱账号分页信息
  48 + * @param pageReqVO
  49 + * @return
  50 + */
31 51 PageResult<MailAccountDO> getMailAccountPage(MailAccountPageReqVO pageReqVO);
32 52  
  53 + /**
  54 + * 获取邮箱数组信息
  55 + * @return
  56 + */
33 57 List<MailAccountDO> getMailAccountList();
34 58  
35   - void sendMail(MailSendVO mailSendVO);
  59 + /**
  60 + * 发送邮件
  61 + * @param mailReqVO
  62 + */
  63 + void sendMail(MailReqVO mailReqVO);
36 64 }
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/service/mail/MailLogService.java
  View file @f349fbf
... ... @@ -9,16 +9,23 @@ import cn.iocoder.yudao.module.system.dal.dataobject.mail.MailLogDO;
9 9 import java.util.List;
10 10  
11 11 /**
12   - * <p>
13   - * 服务类
14   - * </p>
  12 + * 邮箱日志服务类
15 13 *
16 14 * @author wangjingyi
17 15 * @since 2022-03-21
18 16 */
19 17 public interface MailLogService {
20   -
  18 + /**
  19 + * 邮箱日志分页
  20 + * @param pageVO
  21 + * @return
  22 + */
21 23 PageResult<MailLogDO> getMailLogPage(MailLogPageReqVO pageVO);
22 24  
  25 + /**
  26 + * 邮箱日志数组信息
  27 + * @param exportReqVO
  28 + * @return
  29 + */
23 30 List<MailLogDO> getMailLogList(MailLogExportReqVO exportReqVO);
24 31 }
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/service/mail/MailTemplateService.java
  View file @f349fbf
... ... @@ -4,30 +4,53 @@ import cn.iocoder.yudao.framework.common.pojo.PageResult;
4 4 import cn.iocoder.yudao.module.system.controller.admin.mail.vo.template.MailTemplateCreateReqVO;
5 5 import cn.iocoder.yudao.module.system.controller.admin.mail.vo.template.MailTemplatePageReqVO;
6 6 import cn.iocoder.yudao.module.system.controller.admin.mail.vo.template.MailTemplateUpdateReqVO;
7   -import cn.iocoder.yudao.module.system.dal.dataobject.mail.MailAccountDO;
8 7 import cn.iocoder.yudao.module.system.dal.dataobject.mail.MailTemplateDO;
9 8  
10 9 import java.util.List;
11 10  
12 11 /**
13   - * <p>
14   - * 服务类
15   - * </p>
  12 + * 邮箱模版服务类
16 13 *
17 14 * @author wangjingyi
18 15 * @since 2022-03-21
19 16 */
20 17 public interface MailTemplateService {
21   -
  18 + /**
  19 + * 邮箱模版创建
  20 + * @param createReqVO
  21 + * @return
  22 + */
22 23 Long create(MailTemplateCreateReqVO createReqVO);
23 24  
  25 + /**
  26 + * 邮箱模版修改
  27 + * @param updateReqVO
  28 + */
24 29 void update(MailTemplateUpdateReqVO updateReqVO);
25 30  
  31 + /**
  32 + * 邮箱模版删除
  33 + * @param id
  34 + */
26 35 void delete(Long id);
27 36  
  37 + /**
  38 + * 获取邮箱模版
  39 + * @param id
  40 + * @return
  41 + */
28 42 MailTemplateDO getMailTemplate(Long id);
29 43  
  44 + /**
  45 + * 获取邮箱模版分页
  46 + * @param pageReqVO
  47 + * @return
  48 + */
30 49 PageResult<MailTemplateDO> getMailTemplatePage(MailTemplatePageReqVO pageReqVO);
31 50  
  51 + /**
  52 + * 获取邮箱模板数组
  53 + * @return
  54 + */
32 55 List<MailTemplateDO> getMailTemplateList();
33 56 }
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/service/mail/impl/MailLogServiceImpl.java
  View file @f349fbf
... ... @@ -13,15 +13,14 @@ import org.springframework.stereotype.Service;
13 13 import java.util.List;
14 14  
15 15 /**
16   - * <p>
17 16 * 邮箱日志实现类
18   - * </p>
19 17 *
20 18 * @author wangjingyi
21 19 * @since 2022-03-21
22 20 */
23 21 @Service
24 22 public class MailLogServiceImpl implements MailLogService {
  23 +
25 24 @Autowired
26 25 MailLogMapper mailLogMapper;
27 26  
... ...
yudao-module-system/yudao-module-system-impl/src/main/java/cn/iocoder/yudao/module/system/service/mail/impl/MailTemplateServiceImpl.java
  View file @f349fbf
... ... @@ -22,15 +22,14 @@ import static cn.iocoder.yudao.framework.common.exception.util.ServiceExceptionU
22 22 import static cn.iocoder.yudao.module.system.enums.ErrorCodeConstants.*;
23 23  
24 24 /**
25   - * <p>
26 25 * 邮箱模版 服务实现类
27   - * </p>
28 26 *
29 27 * @author wangjingyi
30 28 * @since 2022-03-21
31 29 */
32 30 @Service
33 31 public class MailTemplateServiceImpl implements MailTemplateService {
  32 +
34 33 @Resource
35 34 private MailTemplateMapper mailTemplateMapper;
36 35  
... ... @@ -56,6 +55,7 @@ public class MailTemplateServiceImpl implements MailTemplateService {
56 55 this.validateMailTemplateExists(mailTemplateDO.getId());
57 56 mailTemplateMapper.updateById(mailTemplateDO);
58 57 }
  58 +
59 59 @Override
60 60 public void delete(Long id) {
61 61 // 校验是否存在
... ...