composables.js

文件信息

📄 原文件：02_composables.js
🔤 语言：javascript

Vue 3 Composables（组合式函数） Composables 是使用 Composition API 封装和复用有状态逻辑的函数。类似于 React 的自定义 Hooks。命名约定：以 "use" 开头，如 useCounter、useFetch

完整代码

javascript

/**
 * ============================================================
 *                Vue 3 Composables（组合式函数）
 * ============================================================
 * Composables 是使用 Composition API 封装和复用有状态逻辑的函数。
 * 类似于 React 的自定义 Hooks。
 *
 * 命名约定：以 "use" 开头，如 useCounter、useFetch
 * ============================================================
 */

import {
    ref,
    reactive,
    computed,
    watch,
    watchEffect,
    onMounted,
    onUnmounted,
    toValue,
    readonly,
} from 'vue';


// ============================================================
//                    1. useCounter - 计数器
// ============================================================

/**
 * 计数器 Composable
 *
 * 封装计数器的状态和逻辑
 *
 * @param {number} initialValue - 初始值，默认为 0
 * @returns {Object} 计数器状态和方法
 *
 * @example
 * ```vue
 * <script setup>
 * const { count, increment, decrement, reset } = useCounter(10);
 * </script>
 *
 * <template>
 *   <p>{{ count }}</p>
 *   <button @click="increment">+</button>
 *   <button @click="decrement">-</button>
 *   <button @click="reset">重置</button>
 * </template>
 * ```
 */
export function useCounter(initialValue = 0) {
    // 响应式状态
    const count = ref(initialValue);

    // 方法
    function increment() {
        count.value++;
    }

    function decrement() {
        count.value--;
    }

    function reset() {
        count.value = initialValue;
    }

    function set(value) {
        count.value = value;
    }

    // 计算属性
    const doubleCount = computed(() => count.value * 2);
    const isPositive = computed(() => count.value > 0);

    // 返回状态和方法
    return {
        count: readonly(count),  // 只读，防止外部直接修改
        doubleCount,
        isPositive,
        increment,
        decrement,
        reset,
        set,
    };
}


// ============================================================
//                    2. useFetch - 数据获取
// ============================================================

/**
 * 数据获取 Composable
 *
 * 封装异步数据获取逻辑，包括加载状态和错误处理
 *
 * @param {string | Ref<string> | () => string} url - 请求 URL
 * @param {Object} options - 请求选项
 * @returns {Object} 数据、加载状态、错误信息和方法
 *
 * @example
 * ```vue
 * <script setup>
 * const { data, loading, error, execute } = useFetch('/api/users');
 * </script>
 *
 * <template>
 *   <div v-if="loading">加载中...</div>
 *   <div v-else-if="error">{{ error }}</div>
 *   <div v-else>{{ data }}</div>
 * </template>
 * ```
 */
export function useFetch(url, options = {}) {
    const {
        immediate = true,      // 是否立即执行
        refetch = false,       // URL 变化时是否重新获取
        initialData = null,    // 初始数据
    } = options;

    // 状态
    const data = ref(initialData);
    const loading = ref(false);
    const error = ref(null);

    // 获取数据
    async function execute() {
        // 解析 URL（支持 ref 和函数）
        const resolvedUrl = toValue(url);

        if (!resolvedUrl) return;

        loading.value = true;
        error.value = null;

        try {
            const response = await fetch(resolvedUrl);

            if (!response.ok) {
                throw new Error(`HTTP error! status: ${response.status}`);
            }

            data.value = await response.json();
        } catch (err) {
            error.value = err.message || '请求失败';
        } finally {
            loading.value = false;
        }
    }

    // 立即执行
    if (immediate) {
        execute();
    }

    // URL 变化时重新获取
    if (refetch) {
        watch(
            () => toValue(url),
            () => execute(),
            { immediate: false }
        );
    }

    return {
        data,
        loading,
        error,
        execute,  // 手动重新获取
    };
}


// ============================================================
//                    3. useLocalStorage - 本地存储
// ============================================================

/**
 * 本地存储 Composable
 *
 * 将 ref 的值同步到 localStorage
 *
 * @param {string} key - 存储的键名
 * @param {any} defaultValue - 默认值
 * @returns {Ref} 响应式的值
 *
 * @example
 * ```vue
 * <script setup>
 * const theme = useLocalStorage('theme', 'light');
 * </script>
 *
 * <template>
 *   <select v-model="theme">
 *     <option value="light">浅色</option>
 *     <option value="dark">深色</option>
 *   </select>
 * </template>
 * ```
 */
export function useLocalStorage(key, defaultValue) {
    // 从 localStorage 读取初始值
    const storedValue = localStorage.getItem(key);
    const initialValue = storedValue ? JSON.parse(storedValue) : defaultValue;

    // 创建响应式引用
    const data = ref(initialValue);

    // 监听变化，同步到 localStorage
    watch(
        data,
        (newValue) => {
            if (newValue === null || newValue === undefined) {
                localStorage.removeItem(key);
            } else {
                localStorage.setItem(key, JSON.stringify(newValue));
            }
        },
        { deep: true }
    );

    return data;
}


// ============================================================
//                    4. useEventListener - 事件监听
// ============================================================

/**
 * 事件监听 Composable
 *
 * 自动在组件卸载时移除事件监听
 *
 * @param {EventTarget} target - 目标元素
 * @param {string} event - 事件名
 * @param {Function} handler - 事件处理函数
 * @param {Object} options - addEventListener 选项
 *
 * @example
 * ```vue
 * <script setup>
 * useEventListener(window, 'resize', () => {
 *   console.log('窗口大小变化');
 * });
 * </script>
 * ```
 */
export function useEventListener(target, event, handler, options = {}) {
    // 支持 ref 作为 target
    const targetElement = toValue(target);

    onMounted(() => {
        targetElement?.addEventListener(event, handler, options);
    });

    onUnmounted(() => {
        targetElement?.removeEventListener(event, handler, options);
    });
}


// ============================================================
//                    5. useWindowSize - 窗口尺寸
// ============================================================

/**
 * 窗口尺寸 Composable
 *
 * 响应式获取窗口尺寸
 *
 * @returns {Object} 窗口宽度和高度
 *
 * @example
 * ```vue
 * <script setup>
 * const { width, height } = useWindowSize();
 * </script>
 *
 * <template>
 *   <p>窗口: {{ width }} x {{ height }}</p>
 * </template>
 * ```
 */
export function useWindowSize() {
    const width = ref(window.innerWidth);
    const height = ref(window.innerHeight);

    function update() {
        width.value = window.innerWidth;
        height.value = window.innerHeight;
    }

    onMounted(() => {
        window.addEventListener('resize', update);
    });

    onUnmounted(() => {
        window.removeEventListener('resize', update);
    });

    return {
        width: readonly(width),
        height: readonly(height),
    };
}


// ============================================================
//                    6. useMouse - 鼠标位置
// ============================================================

/**
 * 鼠标位置 Composable
 *
 * 响应式追踪鼠标位置
 *
 * @returns {Object} 鼠标 x, y 坐标
 *
 * @example
 * ```vue
 * <script setup>
 * const { x, y } = useMouse();
 * </script>
 *
 * <template>
 *   <p>鼠标位置: ({{ x }}, {{ y }})</p>
 * </template>
 * ```
 */
export function useMouse() {
    const x = ref(0);
    const y = ref(0);

    function update(event) {
        x.value = event.clientX;
        y.value = event.clientY;
    }

    onMounted(() => {
        window.addEventListener('mousemove', update);
    });

    onUnmounted(() => {
        window.removeEventListener('mousemove', update);
    });

    return { x: readonly(x), y: readonly(y) };
}


// ============================================================
//                    7. useDebounce - 防抖
// ============================================================

/**
 * 防抖 Composable
 *
 * 创建一个防抖的 ref
 *
 * @param {any} value - 初始值
 * @param {number} delay - 延迟时间（毫秒）
 * @returns {Object} 原始值和防抖后的值
 *
 * @example
 * ```vue
 * <script setup>
 * const { value, debouncedValue } = useDebounce('', 300);
 * </script>
 *
 * <template>
 *   <input v-model="value" />
 *   <p>防抖值: {{ debouncedValue }}</p>
 * </template>
 * ```
 */
export function useDebounce(initialValue, delay = 300) {
    const value = ref(initialValue);
    const debouncedValue = ref(initialValue);

    let timeoutId = null;

    watch(value, (newValue) => {
        // 清除之前的定时器
        if (timeoutId) {
            clearTimeout(timeoutId);
        }

        // 设置新的定时器
        timeoutId = setTimeout(() => {
            debouncedValue.value = newValue;
        }, delay);
    });

    // 清理定时器
    onUnmounted(() => {
        if (timeoutId) {
            clearTimeout(timeoutId);
        }
    });

    return {
        value,
        debouncedValue: readonly(debouncedValue),
    };
}


// ============================================================
//                    8. useToggle - 切换状态
// ============================================================

/**
 * 切换状态 Composable
 *
 * @param {boolean} initialValue - 初始值
 * @returns {Array} [状态, 切换函数, 设置函数]
 *
 * @example
 * ```vue
 * <script setup>
 * const [isOpen, toggle, setOpen] = useToggle(false);
 * </script>
 *
 * <template>
 *   <button @click="toggle">切换</button>
 *   <div v-if="isOpen">内容</div>
 * </template>
 * ```
 */
export function useToggle(initialValue = false) {
    const state = ref(initialValue);

    function toggle() {
        state.value = !state.value;
    }

    function set(value) {
        state.value = value;
    }

    return [readonly(state), toggle, set];
}


// ============================================================
//                    9. useAsync - 异步状态
// ============================================================

/**
 * 异步状态 Composable
 *
 * 管理异步操作的状态
 *
 * @param {Function} asyncFn - 异步函数
 * @param {Object} options - 选项
 * @returns {Object} 状态和执行函数
 *
 * @example
 * ```vue
 * <script setup>
 * const { execute, loading, error, data } = useAsync(async () => {
 *   const response = await fetch('/api/data');
 *   return response.json();
 * });
 * </script>
 * ```
 */
export function useAsync(asyncFn, options = {}) {
    const { immediate = false, initialData = null } = options;

    const data = ref(initialData);
    const loading = ref(false);
    const error = ref(null);

    async function execute(...args) {
        loading.value = true;
        error.value = null;

        try {
            data.value = await asyncFn(...args);
            return data.value;
        } catch (err) {
            error.value = err;
            throw err;
        } finally {
            loading.value = false;
        }
    }

    if (immediate) {
        execute();
    }

    return {
        data,
        loading,
        error,
        execute,
    };
}


// ============================================================
//                    10. useForm - 表单处理
// ============================================================

/**
 * 表单处理 Composable
 *
 * @param {Object} initialValues - 初始表单值
 * @param {Object} validationRules - 验证规则
 * @returns {Object} 表单状态和方法
 *
 * @example
 * ```vue
 * <script setup>
 * const { values, errors, handleSubmit, resetForm } = useForm(
 *   { email: '', password: '' },
 *   {
 *     email: (v) => /.+@.+/.test(v) || '邮箱格式不正确',
 *     password: (v) => v.length >= 6 || '密码至少6位',
 *   }
 * );
 *
 * const onSubmit = handleSubmit((values) => {
 *   console.log('提交:', values);
 * });
 * </script>
 * ```
 */
export function useForm(initialValues, validationRules = {}) {
    // 表单值
    const values = reactive({ ...initialValues });

    // 错误信息
    const errors = reactive({});

    // 是否被修改
    const isDirty = ref(false);

    // 是否正在提交
    const isSubmitting = ref(false);

    // 验证单个字段
    function validateField(field) {
        const rule = validationRules[field];
        if (!rule) return true;

        const result = rule(values[field]);
        if (result === true) {
            delete errors[field];
            return true;
        } else {
            errors[field] = result;
            return false;
        }
    }

    // 验证所有字段
    function validate() {
        let isValid = true;
        for (const field in validationRules) {
            if (!validateField(field)) {
                isValid = false;
            }
        }
        return isValid;
    }

    // 处理提交
    function handleSubmit(onSubmit) {
        return async (event) => {
            event?.preventDefault();

            if (!validate()) return;

            isSubmitting.value = true;
            try {
                await onSubmit(values);
            } finally {
                isSubmitting.value = false;
            }
        };
    }

    // 重置表单
    function resetForm() {
        Object.assign(values, initialValues);
        Object.keys(errors).forEach((key) => delete errors[key]);
        isDirty.value = false;
    }

    // 设置字段值
    function setFieldValue(field, value) {
        values[field] = value;
        isDirty.value = true;
    }

    // 监听值变化，标记为已修改
    watch(
        () => values,
        () => {
            isDirty.value = true;
        },
        { deep: true }
    );

    return {
        values,
        errors,
        isDirty,
        isSubmitting,
        validateField,
        validate,
        handleSubmit,
        resetForm,
        setFieldValue,
    };
}


// ============================================================
//                    导出所有 Composables
// ============================================================

export default {
    useCounter,
    useFetch,
    useLocalStorage,
    useEventListener,
    useWindowSize,
    useMouse,
    useDebounce,
    useToggle,
    useAsync,
    useForm,
};

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639

composables.js ​

完整代码 ​

💬 讨论

composables.js

完整代码