feat: 完善流程监听器功能

pull/91/head
ziye 2025-05-06 23:23:40 +08:00
parent 64ee81c327
commit 34eebc14cf
4 changed files with 508 additions and 21 deletions

View File

@ -0,0 +1,50 @@
import type { PageParam, PageResult } from '@vben/request';
import { requestClient } from '#/api/request';
export namespace BpmProcessListenerApi {
/** BPM 流程监听器 VO */
export interface ProcessListenerVO {
id: number; // 编号
name: string; // 监听器名字
type: string; // 监听器类型
status: number; // 监听器状态
event: string; // 监听事件
valueType: string; // 监听器值类型
value: string; // 监听器值
}
}
/** 查询流程监听器分页 */
export async function getProcessListenerPage(params: PageParam) {
return requestClient.get<PageResult<BpmProcessListenerApi.ProcessListenerVO>>(
'/bpm/process-listener/page',
{ params },
);
}
/** 查询流程监听器详情 */
export async function getProcessListener(id: number) {
return requestClient.get<BpmProcessListenerApi.ProcessListenerVO>(
`/bpm/process-listener/get?id=${id}`,
);
}
/** 新增流程监听器 */
export async function createProcessListener(
data: BpmProcessListenerApi.ProcessListenerVO,
) {
return requestClient.post<number>('/bpm/process-listener/create', data);
}
/** 修改流程监听器 */
export async function updateProcessListener(
data: BpmProcessListenerApi.ProcessListenerVO,
) {
return requestClient.put<boolean>('/bpm/process-listener/update', data);
}
/** 删除流程监听器 */
export async function deleteProcessListener(id: number) {
return requestClient.delete<boolean>(`/bpm/process-listener/delete?id=${id}`);
}

View File

@ -0,0 +1,207 @@
import type { VbenFormSchema } from '#/adapter/form';
import type { OnActionClickFn, VxeTableGridOptions } from '#/adapter/vxe-table';
import type { BpmCategoryApi } from '#/api/bpm/category';
import { useAccess } from '@vben/access';
import { z } from '#/adapter/form';
import { CommonStatusEnum } from '#/utils/constants';
import { DICT_TYPE, getDictOptions } from '#/utils/dict';
export const EVENT_EXECUTION_OPTIONS = [
{
label: 'start',
value: 'start',
},
{
label: 'end',
value: 'end',
},
];
export const EVENT_OPTIONS = [
{ label: 'create', value: 'create' },
{ label: 'assignment', value: 'assignment' },
{ label: 'complete', value: 'complete' },
{ label: 'delete', value: 'delete' },
{ label: 'update', value: 'update' },
{ label: 'timeout', value: 'timeout' },
];
const { hasAccessByCodes } = useAccess();
/** 新增/修改的表单 */
export function useFormSchema(): VbenFormSchema[] {
return [
{
fieldName: 'id',
component: 'Input',
dependencies: {
triggerFields: [''],
show: () => false,
},
},
{
fieldName: 'name',
label: '名字',
component: 'Input',
componentProps: {
placeholder: '请输入名字',
},
rules: 'required',
},
{
fieldName: 'status',
label: '状态',
component: 'RadioGroup',
componentProps: {
options: getDictOptions(DICT_TYPE.COMMON_STATUS, 'number'),
placeholder: '请选择状态',
buttonStyle: 'solid',
optionType: 'button',
},
rules: z.number().default(CommonStatusEnum.ENABLE),
},
{
fieldName: 'type',
label: '类型',
component: 'Select',
componentProps: {
options: getDictOptions(DICT_TYPE.BPM_PROCESS_LISTENER_TYPE, 'string'),
allowClear: true,
},
rules: 'required',
},
{
fieldName: 'event',
label: '事件',
component: 'Select',
componentProps: {
options: EVENT_OPTIONS,
allowClear: true,
},
rules: 'required',
},
{
fieldName: 'valueType',
label: '值类型',
component: 'Select',
componentProps: {
options: getDictOptions(
DICT_TYPE.BPM_PROCESS_LISTENER_VALUE_TYPE,
'string',
),
allowClear: true,
},
rules: 'required',
},
{
fieldName: 'value',
label: '表达式',
component: 'Input',
rules: 'required',
},
];
}
/** 列表的搜索表单 */
export function useGridFormSchema(): VbenFormSchema[] {
return [
{
fieldName: 'name',
label: '名字',
component: 'Input',
componentProps: {
placeholder: '请输入名字',
allowClear: true,
},
},
{
fieldName: 'type',
label: '类型',
component: 'Select',
componentProps: {
placeholder: '请选择类型',
options: getDictOptions(DICT_TYPE.BPM_PROCESS_LISTENER_TYPE, 'string'),
allowClear: true,
},
},
];
}
/** 列表的字段 */
export function useGridColumns<T = BpmCategoryApi.CategoryVO>(
onActionClick: OnActionClickFn<T>,
): VxeTableGridOptions['columns'] {
return [
{
field: 'id',
title: '编号',
minWidth: 100,
},
{
field: 'name',
title: '名字',
minWidth: 200,
},
{
field: 'type',
title: '类型',
minWidth: 200,
cellRender: {
name: 'CellDict',
props: { type: DICT_TYPE.BPM_PROCESS_LISTENER_TYPE },
},
},
{
field: 'event',
title: '事件',
minWidth: 200,
},
{
field: 'valueType',
title: '值类型',
minWidth: 200,
cellRender: {
name: 'CellDict',
props: { type: DICT_TYPE.BPM_PROCESS_LISTENER_VALUE_TYPE },
},
},
{
field: 'value',
title: '值',
minWidth: 200,
},
{
field: 'createTime',
title: '创建时间',
minWidth: 180,
formatter: 'formatDateTime',
},
{
field: 'operation',
title: '操作',
minWidth: 180,
align: 'center',
fixed: 'right',
cellRender: {
attrs: {
nameField: 'name',
nameTitle: '流程监听器',
onClick: onActionClick,
},
name: 'CellOperation',
options: [
{
code: 'edit',
show: hasAccessByCodes(['bpm:process-listener:update']),
},
{
code: 'delete',
show: hasAccessByCodes(['bpm:process-listener:delete']),
},
],
},
},
];
}

View File

@ -1,34 +1,129 @@
<script lang="ts" setup>
import { Page } from '@vben/common-ui';
import type {
OnActionClickParams,
VxeTableGridOptions,
} from '#/adapter/vxe-table';
import type { BpmProcessListenerApi } from '#/api/bpm/processListener';
import { Button } from 'ant-design-vue';
import { Page, useVbenModal } from '@vben/common-ui';
import { Plus } from '@vben/icons';
import { Button, message } from 'ant-design-vue';
import { useVbenVxeGrid } from '#/adapter/vxe-table';
import {
deleteProcessListener,
getProcessListenerPage,
} from '#/api/bpm/processListener';
import { DocAlert } from '#/components/doc-alert';
import { $t } from '#/locales';
import { useGridColumns, useGridFormSchema } from './data';
import Form from './modules/form.vue';
const [FormModal, formModalApi] = useVbenModal({
connectedComponent: Form,
destroyOnClose: true,
});
const [Grid, gridApi] = useVbenVxeGrid({
formOptions: {
schema: useGridFormSchema(),
},
gridOptions: {
columns: useGridColumns(onActionClick),
height: 'auto',
keepSource: true,
proxyConfig: {
ajax: {
query: async ({ page }, formValues) => {
return await getProcessListenerPage({
pageNo: page.currentPage,
pageSize: page.pageSize,
...formValues,
});
},
},
},
rowConfig: {
keyField: 'id',
},
toolbarConfig: {
refresh: { code: 'query' },
search: true,
},
} as VxeTableGridOptions<BpmProcessListenerApi.ProcessListenerVO>,
});
/** 表格操作按钮的回调函数 */
function onActionClick({
code,
row,
}: OnActionClickParams<BpmProcessListenerApi.ProcessListenerVO>) {
switch (code) {
case 'delete': {
onDelete(row);
break;
}
case 'edit': {
onEdit(row);
break;
}
}
}
/** 刷新表格 */
function onRefresh() {
gridApi.query();
}
/** 创建流程监听器 */
function onCreate() {
formModalApi.setData(null).open();
}
/** 编辑流程监听器 */
function onEdit(row: BpmProcessListenerApi.ProcessListenerVO) {
formModalApi.setData(row).open();
}
/** 删除流程监听器 */
async function onDelete(row: BpmProcessListenerApi.ProcessListenerVO) {
const hideLoading = message.loading({
content: $t('ui.actionMessage.deleting', [row.name]),
duration: 0,
key: 'action_process_msg',
});
try {
await deleteProcessListener(row.id as number);
message.success({
content: $t('ui.actionMessage.deleteSuccess', [row.name]),
key: 'action_process_msg',
});
onRefresh();
} catch {
hideLoading();
}
}
</script>
<template>
<Page>
<Page auto-content-height>
<DocAlert
title="执行监听器、任务监听器"
url="https://doc.iocoder.cn/bpm/listener/"
/>
<Button
danger
type="link"
target="_blank"
href="https://github.com/yudaocode/yudao-ui-admin-vue3"
>
该功能支持 Vue3 + element-plus 版本
</Button>
<br />
<Button
type="link"
target="_blank"
href="https://github.com/yudaocode/yudao-ui-admin-vue3/blob/master/src/views/bpm/processListener/index"
>
可参考
https://github.com/yudaocode/yudao-ui-admin-vue3/blob/master/src/views/bpm/processListener/index
代码pull request 贡献给我们
</Button>
<FormModal @success="onRefresh" />
<Grid table-title="">
<template #toolbar-tools>
<Button
type="primary"
@click="onCreate"
v-access:code="['bpm:process-listener:create']"
>
<Plus class="size-5" />
{{ $t('ui.actionTitle.create', ['流程监听器']) }}
</Button>
</template>
</Grid>
</Page>
</template>

View File

@ -0,0 +1,135 @@
<script lang="ts" setup>
import type { BpmProcessListenerApi } from '#/api/bpm/processListener';
import { computed, ref } from 'vue';
import { useVbenModal } from '@vben/common-ui';
import { message } from 'ant-design-vue';
import { useVbenForm } from '#/adapter/form';
import {
createProcessListener,
getProcessListener,
updateProcessListener,
} from '#/api/bpm/processListener';
import { $t } from '#/locales';
import { EVENT_EXECUTION_OPTIONS, EVENT_OPTIONS, useFormSchema } from '../data';
const emit = defineEmits(['success']);
const formData = ref<BpmProcessListenerApi.ProcessListenerVO>();
const getTitle = computed(() => {
return formData.value?.id
? $t('ui.actionTitle.edit', ['流程监听器'])
: $t('ui.actionTitle.create', ['流程监听器']);
});
const [Form, formApi] = useVbenForm({
commonConfig: {
componentProps: {
class: 'w-full',
},
formItemClass: 'col-span-2',
labelWidth: 110,
},
layout: 'horizontal',
schema: useFormSchema(),
showDefaultActions: false,
});
const [Modal, modalApi] = useVbenModal({
async onConfirm() {
const { valid } = await formApi.validate();
if (!valid) {
return;
}
modalApi.lock();
//
const data =
(await formApi.getValues()) as BpmProcessListenerApi.ProcessListenerVO;
try {
await (formData.value?.id
? updateProcessListener(data)
: createProcessListener(data));
//
await modalApi.close();
emit('success');
message.success({
content: $t('ui.actionMessage.operationSuccess'),
});
} finally {
modalApi.unlock();
}
},
async onOpenChange(isOpen: boolean) {
if (!isOpen) {
formData.value = undefined;
return;
}
//
formApi.updateSchema([
{
fieldName: 'type',
componentProps: {
onChange: (value: string) => {
formApi.setFieldValue('event', undefined);
formApi.updateSchema([
{
fieldName: 'event',
componentProps: {
options:
value === 'execution'
? EVENT_EXECUTION_OPTIONS
: EVENT_OPTIONS,
},
},
]);
},
},
},
{
fieldName: 'valueType',
componentProps: {
onChange: (value: string) => {
formApi.setFieldValue('value', undefined);
formApi.updateSchema([
{
fieldName: 'value',
label: value === 'class' ? '类路径' : '表达式',
componentProps: {
placeholder:
value === 'class' ? '请输入类路径' : '请输入表达式',
},
},
]);
},
},
},
]);
//
const data = modalApi.getData<BpmProcessListenerApi.ProcessListenerVO>();
if (!data || !data.id) {
return;
}
modalApi.lock();
try {
formData.value = await getProcessListener(data.id as number);
// values
await formApi.setValues(formData.value);
} finally {
modalApi.unlock();
}
},
});
</script>
<template>
<Modal :title="getTitle" class="w-[600px]">
<Form class="mx-4" />
</Modal>
</template>