Browse Source

站内信模块:完善注释

YunaiV 2 years ago
parent
commit
1943e71e3f

+ 2 - 6
yudao-module-system/yudao-module-system-api/src/main/java/cn/iocoder/yudao/module/system/api/notify/NotifyMessageSendApi.java

@@ -13,21 +13,17 @@ public interface NotifyMessageSendApi {
 
     /**
      * 发送单条站内信给 Admin 用户
-     * <p>
-     * 在 mobile 为空时,使用 userId 加载对应 Admin 的手机号
      *
      * @param reqDTO 发送请求
-     * @return 发送消息ID
+     * @return 发送消息 ID
      */
     Long sendSingleMessageToAdmin(@Valid NotifySendSingleToUserReqDTO reqDTO);
 
     /**
      * 发送单条站内信给 Member 用户
-     * <p>
-     * 在 mobile 为空时,使用 userId 加载对应 Member 的手机号
      *
      * @param reqDTO 发送请求
-     * @return 发送消息ID
+     * @return 发送消息 ID
      */
     Long sendSingleMessageToMember(@Valid NotifySendSingleToUserReqDTO reqDTO);
 

+ 13 - 19
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/api/notify/NotifyMessageSendApiImpl.java

@@ -1,39 +1,33 @@
 package cn.iocoder.yudao.module.system.api.notify;
 
 import cn.iocoder.yudao.module.system.api.notify.dto.NotifySendSingleToUserReqDTO;
+import cn.iocoder.yudao.module.system.service.notify.NotifyMessageService;
+import cn.iocoder.yudao.module.system.service.notify.NotifySendService;
 import org.springframework.stereotype.Service;
 
+import javax.annotation.Resource;
+
 /**
- * 站内信发送 API 接口
+ * 站内信发送 API 实现类
  *
  * @author xrcoder
  */
 @Service
 public class NotifyMessageSendApiImpl implements NotifyMessageSendApi {
 
-    /**
-     * 发送单条站内信给 Admin 用户
-     * <p>
-     * 在 mobile 为空时,使用 userId 加载对应 Admin 的手机号
-     *
-     * @param reqDTO 发送请求
-     * @return 发送消息ID
-     */
+    @Resource
+    private NotifySendService notifySendService;
+
     @Override
     public Long sendSingleMessageToAdmin(NotifySendSingleToUserReqDTO reqDTO) {
-        return null;
+        return notifySendService.sendSingleNotifyToAdmin(reqDTO.getUserId(),
+                reqDTO.getTemplateCode(), reqDTO.getTemplateParams());
     }
 
-    /**
-     * 发送单条站内信给 Member 用户
-     * <p>
-     * 在 mobile 为空时,使用 userId 加载对应 Member 的手机号
-     *
-     * @param reqDTO 发送请求
-     * @return 发送消息ID
-     */
     @Override
     public Long sendSingleMessageToMember(NotifySendSingleToUserReqDTO reqDTO) {
-        return null;
+        return notifySendService.sendSingleNotifyToMember(reqDTO.getUserId(),
+                reqDTO.getTemplateCode(), reqDTO.getTemplateParams());
     }
+
 }

+ 1 - 1
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/dal/mysql/notify/NotifyMessageMapper.java

@@ -28,7 +28,7 @@ public interface NotifyMessageMapper extends BaseMapperX<NotifyMessageDO> {
 
     default PageResult<NotifyMessageDO> selectPage(NotifyMessageMyPageReqVO reqVO, Long userId, Integer userType) {
         return selectPage(reqVO, new LambdaQueryWrapperX<NotifyMessageDO>()
-                .eq(NotifyMessageDO::getReadStatus, reqVO.getReadStatus())
+                .eqIfPresent(NotifyMessageDO::getReadStatus, reqVO.getReadStatus())
                 .betweenIfPresent(NotifyMessageDO::getCreateTime, reqVO.getCreateTime())
                 .eq(NotifyMessageDO::getUserId, userId)
                 .eq(NotifyMessageDO::getUserType, userType)

+ 1 - 1
yudao-ui-admin/src/layout/components/Message/index.vue

@@ -8,7 +8,7 @@
 
       <!-- 弹出列表 -->
       <el-table v-loading="loading" :data="list">
-        <el-table-column width="120" property="templateNickname" label="日期" />
+        <el-table-column width="120" property="templateNickname" label="发送人" />
         <el-table-column width="180" property="title" label="发送时间">
           <template slot-scope="scope">
             <span>{{ parseTime(scope.row.createTime) }}</span>

+ 1 - 1
yudao-ui-admin/src/views/system/notify/message/index.vue

@@ -1,6 +1,6 @@
 <template>
   <div class="app-container">
-
+    <doc-alert title="站内信配置" url="https://doc.iocoder.cn/notify/" />
     <!-- 搜索工作栏 -->
     <el-form :model="queryParams" ref="queryForm" size="small" :inline="true" v-show="showSearch" label-width="68px">
       <el-form-item label="用户编号" prop="userId">

+ 2 - 0
yudao-ui-admin/src/views/system/notify/my/index.vue

@@ -1,5 +1,7 @@
 <template>
   <div class="app-container">
+    <doc-alert title="站内信配置" url="https://doc.iocoder.cn/notify/" />
+
     <!-- 搜索工作栏 -->
     <el-form :model="queryParams" ref="queryForm" size="small" :inline="true" v-show="showSearch" label-width="68px">
       <el-form-item label="是否已读" prop="readStatus">

+ 6 - 4
yudao-ui-admin/src/views/system/notify/template/index.vue

@@ -1,5 +1,7 @@
 <template>
   <div class="app-container">
+    <doc-alert title="站内信配置" url="https://doc.iocoder.cn/notify/" />
+
     <!-- 搜索工作栏 -->
     <el-form :model="queryParams" ref="queryForm" size="small" :inline="true" v-show="showSearch" label-width="68px">
       <el-form-item label="模板名称" prop="name">
@@ -58,7 +60,7 @@
       <el-table-column label="操作" align="center" class-name="small-padding fixed-width" width="150">
         <template slot-scope="scope">
           <el-button size="mini" type="text" icon="el-icon-share" @click="handleSendNotify(scope.row)"
-                     v-hasPermi="['system:notify-template:send-notify']">发送</el-button>
+                     v-hasPermi="['system:notify-template:send-notify']">测试</el-button>
           <el-button size="mini" type="text" icon="el-icon-edit" @click="handleUpdate(scope.row)"
                      v-hasPermi="['system:notify-template:update']">修改</el-button>
           <el-button size="mini" type="text" icon="el-icon-delete" @click="handleDelete(scope.row)"
@@ -73,8 +75,8 @@
     <!-- 对话框(添加 / 修改) -->
     <el-dialog :title="title" :visible.sync="open" width="500px" append-to-body>
       <el-form ref="form" :model="form" :rules="rules" label-width="140px">
-        <el-form-item label="模板编号" prop="code">
-          <el-input v-model="form.code" placeholder="请输入模板编号" />
+        <el-form-item label="模版编码" prop="code">
+          <el-input v-model="form.code" placeholder="请输入模版编码" />
         </el-form-item>
         <el-form-item label="模板名称" prop="name">
           <el-input v-model="form.name" placeholder="请输入模版名称" />
@@ -182,7 +184,7 @@ export default {
       },
       sendNotifyRules: {
         userId: [{ required: true, message: "接收人不能为空", trigger: "blur" }],
-        templateCode: [{ required: true, message: "模版编不能为空", trigger: "blur" }],
+        templateCode: [{ required: true, message: "模版编不能为空", trigger: "blur" }],
         templateParams: { }
       }
     };

+ 1 - 0
yudao-ui-admin/src/views/system/oauth2/client/index.vue

@@ -1,5 +1,6 @@
 <template>
   <div class="app-container">
+    <doc-alert title="OAuth 2.0(SSO 单点登录)" url="https://doc.iocoder.cn/oauth2/" />
 
     <!-- 搜索工作栏 -->
     <el-form :model="queryParams" ref="queryForm" size="small" :inline="true" v-show="showSearch" label-width="68px">

+ 2 - 0
yudao-ui-admin/src/views/system/oauth2/token/index.vue

@@ -1,6 +1,8 @@
 <template>
   <div class="app-container">
+    <doc-alert title="OAuth 2.0(SSO 单点登录)" url="https://doc.iocoder.cn/oauth2/" />
     <doc-alert title="用户体系" url="https://doc.iocoder.cn/user-center/" />
+
     <!-- 搜索工作栏 -->
     <el-form :model="queryParams" ref="queryForm" size="small" :inline="true" label-width="68px">
       <el-form-item label="用户编号" prop="userId">