refactor: 公告管理 Announcement => Notice

continew-org · Apr 27, 2024 · dbe93df · dbe93df
1 parent abf1e65
commit dbe93df
Show file tree

Hide file tree

Showing 22 changed files with 97 additions and 99 deletions.
diff --git a/.../system/enums/AnnouncementStatusEnum.java → .../admin/system/enums/NoticeStatusEnum.java b/.../system/enums/AnnouncementStatusEnum.java → .../admin/system/enums/NoticeStatusEnum.java
@@ -29,7 +29,7 @@
  */
 @Getter
 @RequiredArgsConstructor
-public enum AnnouncementStatusEnum implements IBaseEnum<Integer> {
+public enum NoticeStatusEnum implements IBaseEnum<Integer> {
 
  /**
  * 待发布

diff --git a/...min/system/mapper/AnnouncementMapper.java → ...new/admin/system/mapper/NoticeMapper.java b/...min/system/mapper/AnnouncementMapper.java → ...new/admin/system/mapper/NoticeMapper.java
@@ -16,8 +16,8 @@
 
 package top.continew.admin.system.mapper;
 
-import top.continew.admin.system.model.entity.AnnouncementDO;
-import top.continew.admin.system.model.resp.DashboardAnnouncementResp;
+import top.continew.admin.system.model.entity.NoticeDO;
+import top.continew.admin.system.model.resp.DashboardNoticeResp;
 import top.continew.starter.data.mybatis.plus.base.BaseMapper;
 
 import java.util.List;
@@ -28,12 +28,12 @@
  * @author Charles7c
  * @since 2023/8/20 10:55
  */
-public interface AnnouncementMapper extends BaseMapper<AnnouncementDO> {
+public interface NoticeMapper extends BaseMapper<NoticeDO> {
 
  /**
  * 查询仪表盘公告列表
  *
  * @return 仪表盘公告列表
  */
- List<DashboardAnnouncementResp> selectDashboardList();
+ List<DashboardNoticeResp> selectDashboardList();
 }
diff --git a/...n/system/model/entity/AnnouncementDO.java → ...w/admin/system/model/entity/NoticeDO.java b/...n/system/model/entity/AnnouncementDO.java → ...w/admin/system/model/entity/NoticeDO.java
@@ -30,8 +30,8 @@
  * @since 2023/8/20 10:55
  */
 @Data
-@TableName("sys_announcement")
-public class AnnouncementDO extends BaseDO {
+@TableName("sys_notice")
+public class NoticeDO extends BaseDO {
 
  @Serial
  private static final long serialVersionUID = 1L;

diff --git a/...system/model/query/AnnouncementQuery.java → ...admin/system/model/query/NoticeQuery.java b/...system/model/query/AnnouncementQuery.java → ...admin/system/model/query/NoticeQuery.java
@@ -32,7 +32,7 @@
  */
 @Data
 @Schema(description = "公告查询条件")
-public class AnnouncementQuery implements Serializable {
+public class NoticeQuery implements Serializable {
 
  @Serial
  private static final long serialVersionUID = 1L;

diff --git a/continew-admin-system/src/main/java/top/continew/admin/system/model/req/DictReq.java b/continew-admin-system/src/main/java/top/continew/admin/system/model/req/DictReq.java
@@ -50,7 +50,7 @@ public class DictReq extends BaseReq {
  /**
  * 编码
  */
- @Schema(description = "编码", example = "announcement_type")
+ @Schema(description = "编码", example = "notice_type")
  @NotBlank(message = "编码不能为空")
  @Pattern(regexp = RegexConstants.GENERAL_CODE, message = "编码长度为 2 到 30 位，可以包含字母、数字，下划线，以字母开头")
  private String code;

diff --git a/...min/system/model/req/AnnouncementReq.java → ...new/admin/system/model/req/NoticeReq.java b/...min/system/model/req/AnnouncementReq.java → ...new/admin/system/model/req/NoticeReq.java
@@ -34,7 +34,7 @@
  */
 @Data
 @Schema(description = "创建或修改公告信息")
-public class AnnouncementReq extends BaseReq {
+public class NoticeReq extends BaseReq {
 
  @Serial
  private static final long serialVersionUID = 1L;
@@ -55,9 +55,9 @@ public class AnnouncementReq extends BaseReq {
  private String content;
 
  /**
- * 类型（取值于字典 announcement_type）
+ * 类型（取值于字典 notice_type）
  */
- @Schema(description = "类型（取值于字典 announcement_type）", example = "1")
+ @Schema(description = "类型（取值于字典 notice_type）", example = "1")
  @NotBlank(message = "类型不能为空")
  @Length(max = 30, message = "类型长度不能超过 {max} 个字符")
  private String type;

diff --git a/...model/resp/DashboardAnnouncementResp.java → ...ystem/model/resp/DashboardNoticeResp.java b/...model/resp/DashboardAnnouncementResp.java → ...ystem/model/resp/DashboardNoticeResp.java
@@ -30,7 +30,7 @@
  */
 @Data
 @Schema(description = "仪表盘-公告信息")
-public class DashboardAnnouncementResp implements Serializable {
+public class DashboardNoticeResp implements Serializable {
 
  @Serial
  private static final long serialVersionUID = 1L;
@@ -48,8 +48,8 @@ public class DashboardAnnouncementResp implements Serializable {
  private String title;
 
  /**
- * 类型（取值于字典 announcement_type）
+ * 类型（取值于字典 notice_type）
  */
- @Schema(description = "类型（取值于字典 announcement_type）", example = "1")
+ @Schema(description = "类型（取值于字典 notice_type）", example = "1")
  private String type;
 }
diff --git a/continew-admin-system/src/main/java/top/continew/admin/system/model/resp/DictResp.java b/continew-admin-system/src/main/java/top/continew/admin/system/model/resp/DictResp.java
@@ -44,7 +44,7 @@ public class DictResp extends BaseDetailResp {
  /**
  * 编码
  */
- @Schema(description = "编码", example = "announcement_type")
+ @Schema(description = "编码", example = "notice_type")
  private String code;
 
  /**

diff --git a/...em/model/resp/AnnouncementDetailResp.java → ...n/system/model/resp/NoticeDetailResp.java b/...em/model/resp/AnnouncementDetailResp.java → ...n/system/model/resp/NoticeDetailResp.java
@@ -34,7 +34,7 @@
 @Data
 @ExcelIgnoreUnannotated
 @Schema(description = "公告详情信息")
-public class AnnouncementDetailResp extends BaseDetailResp {
+public class NoticeDetailResp extends BaseDetailResp {
 
  @Serial
  private static final long serialVersionUID = 1L;
@@ -54,9 +54,9 @@ public class AnnouncementDetailResp extends BaseDetailResp {
  private String content;
 
  /**
- * 类型（取值于字典 announcement_type）
+ * 类型（取值于字典 notice_type）
  */
- @Schema(description = "类型（取值于字典 announcement_type）", example = "1")
+ @Schema(description = "类型（取值于字典 notice_type）", example = "1")
  @ExcelProperty(value = "类型")
  private String type;
 

diff --git a/...n/system/model/resp/AnnouncementResp.java → ...w/admin/system/model/resp/NoticeResp.java b/...n/system/model/resp/AnnouncementResp.java → ...w/admin/system/model/resp/NoticeResp.java
@@ -18,7 +18,7 @@
 
 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Data;
-import top.continew.admin.system.enums.AnnouncementStatusEnum;
+import top.continew.admin.system.enums.NoticeStatusEnum;
 import top.continew.starter.extension.crud.model.resp.BaseResp;
 
 import java.io.Serial;
@@ -32,7 +32,7 @@
  */
 @Data
 @Schema(description = "公告信息")
-public class AnnouncementResp extends BaseResp {
+public class NoticeResp extends BaseResp {
 
  @Serial
  private static final long serialVersionUID = 1L;
@@ -44,9 +44,9 @@ public class AnnouncementResp extends BaseResp {
  private String title;
 
  /**
- * 类型（取值于字典 announcement_type）
+ * 类型（取值于字典 notice_type）
  */
- @Schema(description = "类型（取值于字典 announcement_type）", example = "1")
+ @Schema(description = "类型（取值于字典 notice_type）", example = "1")
  private String type;
 
  /**
@@ -67,13 +67,13 @@ public class AnnouncementResp extends BaseResp {
  * @return 公告状态
  */
  @Schema(description = "状态（1：待发布；2：已发布；3：已过期）", type = "Integer", allowableValues = {"1", "2", "3"}, example = "1")
- public AnnouncementStatusEnum getStatus() {
+ public NoticeStatusEnum getStatus() {
  if (null != this.effectiveTime && this.effectiveTime.isAfter(LocalDateTime.now())) {
- return AnnouncementStatusEnum.PENDING_RELEASE;
+ return NoticeStatusEnum.PENDING_RELEASE;
  }
  if (null != this.terminateTime && this.terminateTime.isBefore(LocalDateTime.now())) {
- return AnnouncementStatusEnum.EXPIRED;
+ return NoticeStatusEnum.EXPIRED;
  }
- return AnnouncementStatusEnum.PUBLISHED;
+ return NoticeStatusEnum.PUBLISHED;
  }
 }
diff --git a/continew-admin-system/src/main/java/top/continew/admin/system/service/DashboardService.java b/continew-admin-system/src/main/java/top/continew/admin/system/service/DashboardService.java
@@ -62,5 +62,5 @@ public interface DashboardService {
  *
  * @return 公告列表
  */
- List<DashboardAnnouncementResp> listAnnouncement();
+ List<DashboardNoticeResp> listNotice();
 }
diff --git a/...n/system/service/AnnouncementService.java → ...w/admin/system/service/NoticeService.java b/...n/system/service/AnnouncementService.java → ...w/admin/system/service/NoticeService.java
@@ -16,12 +16,12 @@
 
 package top.continew.admin.system.service;
 
-import top.continew.admin.system.model.entity.AnnouncementDO;
-import top.continew.admin.system.model.query.AnnouncementQuery;
-import top.continew.admin.system.model.req.AnnouncementReq;
-import top.continew.admin.system.model.resp.AnnouncementDetailResp;
-import top.continew.admin.system.model.resp.AnnouncementResp;
-import top.continew.admin.system.model.resp.DashboardAnnouncementResp;
+import top.continew.admin.system.model.entity.NoticeDO;
+import top.continew.admin.system.model.query.NoticeQuery;
+import top.continew.admin.system.model.req.NoticeReq;
+import top.continew.admin.system.model.resp.NoticeDetailResp;
+import top.continew.admin.system.model.resp.NoticeResp;
+import top.continew.admin.system.model.resp.DashboardNoticeResp;
 import top.continew.starter.extension.crud.service.BaseService;
 import top.continew.starter.data.mybatis.plus.service.IService;
 
@@ -33,12 +33,12 @@
  * @author Charles7c
  * @since 2023/8/20 10:55
  */
-public interface AnnouncementService extends BaseService<AnnouncementResp, AnnouncementDetailResp, AnnouncementQuery, AnnouncementReq>, IService<AnnouncementDO> {
+public interface NoticeService extends BaseService<NoticeResp, NoticeDetailResp, NoticeQuery, NoticeReq>, IService<NoticeDO> {
 
  /**
  * 查询仪表盘公告列表
  *
  * @return 仪表盘公告列表
  */
- List<DashboardAnnouncementResp> listDashboard();
+ List<DashboardNoticeResp> listDashboard();
 }
diff --git a/...min-system/src/main/java/top/continew/admin/system/service/impl/DashboardServiceImpl.java b/...min-system/src/main/java/top/continew/admin/system/service/impl/DashboardServiceImpl.java
@@ -20,7 +20,7 @@
 import cn.hutool.core.util.NumberUtil;
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Service;
-import top.continew.admin.system.service.AnnouncementService;
+import top.continew.admin.system.service.NoticeService;
 import top.continew.admin.system.service.DashboardService;
 import top.continew.admin.system.service.LogService;
 import top.continew.admin.system.model.resp.*;
@@ -40,7 +40,7 @@
 public class DashboardServiceImpl implements DashboardService {
 
  private final LogService logService;
- private final AnnouncementService announcementService;
+ private final NoticeService noticeService;
 
  @Override
  public DashboardTotalResp getTotal() {
@@ -85,7 +85,7 @@ public DashboardGeoDistributionResp getGeoDistribution() {
  }
 
  @Override
- public List<DashboardAnnouncementResp> listAnnouncement() {
- return announcementService.listDashboard();
+ public List<DashboardNoticeResp> listNotice() {
+ return noticeService.listDashboard();
  }
 }
diff --git a/...service/impl/AnnouncementServiceImpl.java → ...ystem/service/impl/NoticeServiceImpl.java b/...service/impl/AnnouncementServiceImpl.java → ...ystem/service/impl/NoticeServiceImpl.java
@@ -16,22 +16,20 @@
 
 package top.continew.admin.system.service.impl;
 
-import java.util.List;
-
 import lombok.RequiredArgsConstructor;
-
 import org.springframework.stereotype.Service;
-
-import top.continew.admin.system.mapper.AnnouncementMapper;
-import top.continew.admin.system.model.entity.AnnouncementDO;
-import top.continew.admin.system.model.query.AnnouncementQuery;
-import top.continew.admin.system.model.req.AnnouncementReq;
-import top.continew.admin.system.model.resp.AnnouncementDetailResp;
-import top.continew.admin.system.model.resp.AnnouncementResp;
-import top.continew.admin.system.model.resp.DashboardAnnouncementResp;
-import top.continew.admin.system.service.AnnouncementService;
+import top.continew.admin.system.mapper.NoticeMapper;
+import top.continew.admin.system.model.entity.NoticeDO;
+import top.continew.admin.system.model.query.NoticeQuery;
+import top.continew.admin.system.model.req.NoticeReq;
+import top.continew.admin.system.model.resp.DashboardNoticeResp;
+import top.continew.admin.system.model.resp.NoticeDetailResp;
+import top.continew.admin.system.model.resp.NoticeResp;
+import top.continew.admin.system.service.NoticeService;
 import top.continew.starter.extension.crud.service.impl.BaseServiceImpl;
 
+import java.util.List;
+
 /**
  * 公告业务实现
  *
@@ -40,10 +38,10 @@
  */
 @Service
 @RequiredArgsConstructor
-public class AnnouncementServiceImpl extends BaseServiceImpl<AnnouncementMapper, AnnouncementDO, AnnouncementResp, AnnouncementDetailResp, AnnouncementQuery, AnnouncementReq> implements AnnouncementService {
+public class NoticeServiceImpl extends BaseServiceImpl<NoticeMapper, NoticeDO, NoticeResp, NoticeDetailResp, NoticeQuery, NoticeReq> implements NoticeService {
 
  @Override
- public List<DashboardAnnouncementResp> listDashboard() {
+ public List<DashboardNoticeResp> listDashboard() {
  return baseMapper.selectDashboardList();
  }
 }
diff --git a/...n/resources/mapper/AnnouncementMapper.xml → ...rc/main/resources/mapper/NoticeMapper.xml b/...n/resources/mapper/AnnouncementMapper.xml → ...rc/main/resources/mapper/NoticeMapper.xml
@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http:https://mybatis.org/dtd/mybatis-3-mapper.dtd" >
-<mapper namespace="top.continew.admin.system.mapper.AnnouncementMapper">
+<mapper namespace="top.continew.admin.system.mapper.NoticeMapper">
 
  <select id="selectDashboardList"
- resultType="top.continew.admin.system.model.resp.DashboardAnnouncementResp">
+ resultType="top.continew.admin.system.model.resp.DashboardNoticeResp">
  SELECT
  id, title, type
- FROM sys_announcement
+ FROM sys_notice
  WHERE (effective_time IS NULL OR NOW() > effective_time)
  AND (terminate_time IS NULL OR terminate_time > NOW())
  ORDER BY sort ASC, effective_time DESC

diff --git a/continew-admin-webapi/src/main/java/top/continew/admin/webapi/common/CommonController.java b/continew-admin-webapi/src/main/java/top/continew/admin/webapi/common/CommonController.java
@@ -102,7 +102,7 @@ public R<List<LabelValueResp<Long>>> listRoleDict(RoleQuery query, SortQuery sor
  }
 
  @Operation(summary = "查询字典", description = "查询字典列表")
- @Parameter(name = "code", description = "字典编码", example = "announcement_type", in = ParameterIn.PATH)
+ @Parameter(name = "code", description = "字典编码", example = "notice_type", in = ParameterIn.PATH)
  @GetMapping("/dict/{code}")
  public R<List<LabelValueResp<Serializable>>> listDict(@PathVariable String code) {
  Optional<Class<?>> enumClassOptional = this.getEnumClassByName(code);

diff --git a/...inew-admin-webapi/src/main/java/top/continew/admin/webapi/common/DashboardController.java b/...inew-admin-webapi/src/main/java/top/continew/admin/webapi/common/DashboardController.java
@@ -36,7 +36,7 @@
 import top.continew.admin.system.model.resp.DashboardPopularModuleResp;
 import top.continew.admin.system.model.resp.DashboardTotalResp;
 import top.continew.admin.system.service.DashboardService;
-import top.continew.admin.system.model.resp.DashboardAnnouncementResp;
+import top.continew.admin.system.model.resp.DashboardNoticeResp;
 import top.continew.starter.core.util.validate.ValidationUtils;
 import top.continew.starter.web.model.R;
 import top.continew.starter.log.core.annotation.Log;
@@ -89,8 +89,8 @@ public R<DashboardGeoDistributionResp> getGeoDistribution() {
  }
 
  @Operation(summary = "查询公告列表", description = "查询公告列表")
- @GetMapping("/announcement")
- public R<List<DashboardAnnouncementResp>> listAnnouncement() {
- return R.ok(dashboardService.listAnnouncement());
+ @GetMapping("/notice")
+ public R<List<DashboardNoticeResp>> listNotice() {
+ return R.ok(dashboardService.listNotice());
  }
 }