OA 通知公告 - 前端联调方案

涉及页面

API

| GET | /bpm/oa/notice/my-unread-count | - | 我的未读数量 |

请求参数

POST /bpm/oa/notice/create & PUT /bpm/oa/notice/update：

GET /bpm/oa/notice/page：

GET /bpm/oa/notice/get：

DELETE /bpm/oa/notice/delete：

响应格式

分页列表 GET /bpm/oa/notice/page 响应：

{
  "code": 0,
  "data": {
    "list": [
      {
        "id": 1,
        "title": "关于放假的通知",
        "content": "根据国家规定...",
        "type": 1,
        "status": 1,
        "sendScope": 1,
        "isTop": 0,
        "publishUserId": 1,
        "publishTime": "2025-01-01 10:00:00",
        "createTime": "2025-01-01 10:00:00"
      }
    ],
    "total": 100
  }
}

详情 GET /bpm/oa/notice/get 响应：

与列表项相同结构，额外返回：

我的未读数量 GET /bpm/oa/notice/my-unread-count 响应：

{
  "code": 0,
  "data": 5
}

字段展示规则

| publishUserId | - | ✅ | 发布人姓名（需关联用户表展示） |
| publishTime | ✅ | ✅ | 发布时间 |
| createTime | ✅ | ✅ | 创建时间 |
| content | - | ✅ | 富文本内容 |
| userIds | - | ✅ | 仅 sendScope=2 时展示指定人员列表 |

业务规则说明

API 封装参考

新建 src/api/bpm/oa/notice/index.ts，参照 src/api/bpm/oa/leave/index.ts 模式：

import { requestClient } from '#/api/request';

export namespace OaNoticeApi {
  export interface NoticeVO {
    id: number;
    title: string;
    content: string;
    type: number;
    status: number;
    sendScope: number;
    isTop: number;
    publishUserId: number;
    publishTime: string;
    createTime: string;
    userIds?: number[];
  }

  export interface NoticeSaveReqVO {
    id?: number;
    title: string;
    content: string;
    type: number;
    status: number;
    sendScope: number;
    isTop?: number;
    userIds?: number[];
  }
}

const BASE = '/bpm/oa/notice';

export function getNoticePage(params: any) {
  return requestClient.get(`${BASE}/page`, { params });
}

export function getNotice(id: number) {
  return requestClient.get(`${BASE}/get`, { params: { id } });
}

export function createNotice(data: OaNoticeApi.NoticeSaveReqVO) {
  return requestClient.post(`${BASE}/create`, data);
}

export function updateNotice(data: OaNoticeApi.NoticeSaveReqVO) {
  return requestClient.put(`${BASE}/update`, data);
}

export function deleteNotice(id: number) {
  return requestClient.delete(`${BASE}/delete`, { params: { id } });
}

export function getMyUnreadNoticeCount() {
  return requestClient.get(`${BASE}/my-unread-count`);
}

页面文件建议

注意事项

• 列表页的可见数据由后端按 sendScope + 当前用户自动过滤，前端无需额外处理
• 创建/编辑表单中，「指定人」选择器仅在 sendScope=2 时显示
• 表单提交时 status 可直接选择「已发布」，此时会立即触发通知发送
• 已读状态由后端在调用 get 接口时自动标记，前端无需调用标记已读接口
• 头部铃铛的未读数如果能获取 getUnreadNotifyMessageCount，可以叠加 getMyUnreadNoticeCount 的结果展示
• 后端菜单需要配置 component 字段为 bpm/oa/notice/index，权限标识分别为 bpm:oa-notice:create/update/delete/query
• 参考现有页面：列表页参照 src/views/system/notice/index.vue，表单弹窗参照 src/views/bpm/oa/leave/create.vue