Vue 项目中 Cron 表达式的集成与自定义实现
一、 快速集成 Vue-Cron 插件
在 Vue 项目中,如果需要快速实现一个图形化的 Cron 表达式选择器,vue-cron 是一个常见的选择。它能够生成符合标准 Cron 规范的字符串。
1. 安装与全局配置
首先,通过 npm 安装依赖:
npm install vue-cron --save
在 main.js 中进行全局注册,以便在任何页面直接使用:
import Vue from 'vue';
import ElementUI from 'element-ui';
import 'element-ui/lib/theme-chalk/index.css';
import VueCron from 'vue-cron';
Vue.use(ElementUI);
Vue.use(VueCron);
2. 业务场景中的应用
通常我们会将 Cron 选择器嵌入到 el-popover 中,点击输入框时弹出选择面板。以下是一个结合 Element UI 的实现示例:
<template>
<div class="cron-container">
<el-form-item label="执行策略">
<el-popover v-model="isSelectorVisible" placement="bottom" width="400">
<!-- 使用插件组件 -->
<cron @change="handleCronChange" @close="isSelectorVisible = false"></cron>
<el-input
slot="reference"
v-model="cronValue"
placeholder="点击选择定时策略"
readonly
@click.native="isSelectorVisible = true"
></el-input>
</el-popover>
</el-form-item>
</div>
</template>
<script>
export default {
data() {
return {
isSelectorVisible: false,
cronValue: ''
};
},
methods: {
handleCronChange(val) {
this.cronValue = val;
}
}
};
</script>
二、 使用 cronstrue 解析表达式
为了提高用户体验,通常需要将复杂的 Cron 表达式(如 0 0/5 * * * ?)转化为人类可读的文字(如"每隔 5 分钟")。cronstrue 插件可以完美解决这个问题。
1. 基础用法
安装插件:
npm install cronstrue --save
2. 处理周索引差异
需要注意,vue-cron 默认周日为 1,而 cronstrue 默认周一为 1。我们可以通过配置参数来对齐逻辑:
import cronstrue from "cronstrue/i18n";
export default {
computed: {
readableCron() {
if (!this.cronValue) return "";
try {
return cronstrue.toString(this.cronValue, {
locale: "zh_CN",
// 设置为 false,使其与 vue-cron 保持一致:周日为每周的第一天
dayOfWeekStartIndexZero: false
});
} catch (e) {
return "表达式格式错误";
}
}
}
};
三、 自定义 Cron 核心逻辑实现
在某些定制化需求中,我们需要自己编写 UI 组件。核心逻辑在于如何将各时间单位(秒、分、时、日、月、周、年)的状态拼接成字符串,以及反向解析。
1. 核心 Mixin 逻辑
我们可以抽离出一个通用的逻辑处理脚本 cronLogic.js,负责不同类型的转换:
export default {
methods: {
// 将界面操作的状态转化为 cron 片段
generateSegment(type, config) {
let segment = '*';
switch (type) {
case 'period': // 周期:从 A 到 B
segment = `${config.start}-${config.end}`;
break;
case 'interval': // 间隔:从 A 开始,每隔 B 执行
segment = `${config.start}/${config.interval}`;
break;
case 'specific': // 指定多个值
segment = config.values.length ? config.values.join(',') : '*';
break;
case 'lastDay': // 本月最后一天
segment = 'L';
break;
default:
segment = '*';
}
return segment;
},
// 反向解析:将 cron 字符串片段解析回界面状态
parseSegment(segment) {
if (segment.includes('-')) {
const [start, end] = segment.split('-').map(Number);
return { type: 'period', start, end };
} else if (segment.includes('/')) {
const [start, interval] = segment.split('/').map(Number);
return { type: 'interval', start, interval };
} else if (segment === 'L') {
return { type: 'lastDay' };
}
// 更多逻辑待扩展...
}
}
};
2. 时间单位组件示例(以"秒"为例)
针对不同的维度,可以封装独立的子组件:
<template>
<div class="unit-box">
<el-radio-group v-model="selectionType">
<div class="row">
<el-radio label="every">每秒</el-radio>
</div>
<div class="row">
<el-radio label="cycle">周期 (秒)</el-radio>
<el-input-number v-model="cycleStart" :min="0" :max="59"></el-input-number>
<span>-</span>
<el-input-number v-model="cycleEnd" :min="0" :max="59"></el-input-number>
</div>
<div class="row">
<el-radio label="specific">指定</el-radio>
<el-checkbox-group v-model="selectedValues">
<el-checkbox v-for="i in 60" :key="i-1" :label="i-1">{{ i-1 }}</el-checkbox>
</el-checkbox-group>
</div>
</el-radio-group>
</div>
</template>
<script>
export default {
data() {
return {
selectionType: 'every',
cycleStart: 1,
cycleEnd: 2,
selectedValues: []
};
},
watch: {
// 监听变化并向父组件提交生成的片段
currentSegment(newVal) {
this.$emit('update', newVal);
}
},
computed: {
currentSegment() {
if (this.selectionType === 'every') return '*';
if (this.selectionType === 'cycle') return `${this.cycleStart}-${this.cycleEnd}`;
if (this.selectionType === 'specific') return this.selectedValues.join(',');
return '*';
}
}
};
</script>
3. 组合与校验
在父组件中,通过 Tabs 切换不同的单位组件,并在"确定"按钮触发时进行合法性校验,例如:
- 日(Day)和周(Week)不能同时被指定,其中一方必须为
?。 - 年份跨度校验。
- 使用正则表达式
/^(\?|\*|L|[0-9]{1,2}(\/|-)[0-9]{1,2}|[0-9]{1,2}([,]{1}[0-9]{1,2})*)$/验证各片段的合法性。