0

0

使用async/await封装fetch实现全面的错误捕获与响应处理

碧海醫心

碧海醫心

发布时间:2025-09-24 21:43:02

|

257人浏览过

|

来源于php中文网

原创

使用async/await封装fetch实现全面的错误捕获与响应处理

本文将深入探讨如何使用JavaScript的fetch API构建一个健壮的API调用封装函数。我们将利用async/await语法简化异步代码,详细阐述如何有效捕获并处理各类错误,包括网络故障和非HTTP 200响应。文章将提供处理文本和JSON响应的示例,并介绍两种主要的错误处理策略:始终解决并返回状态对象,或在失败时拒绝Promise,以帮助开发者创建更可靠、易于维护的网络请求模块。

fetch API封装的必要性

前端开发中,与后端api进行交互是常见任务。fetch api是现代浏览器提供的强大网络请求工具,但其默认行为在错误处理方面可能不够直观。例如,fetch在接收到http 4xx或5xx状态码时并不会抛出错误,而是将其视为成功的响应,需要开发者手动检查response.ok属性。此外,网络故障、请求配置错误等情况则会直接导致promise被拒绝。为了提升代码的可读性、可维护性和健壮性,通常需要对fetch进行一层封装,统一处理各种成功与失败场景,并提供清晰的返回值或错误信息。

利用async/await简化异步操作

async/await语法是处理Promise的强大工具,它允许我们以同步的方式编写异步代码,极大地提高了代码的可读性。在封装fetch时,async/await能帮助我们更优雅地处理Promise链,避免回调地狱,并方便地使用try...catch结构捕获错误。

一个基本的fetch调用通常如下:

async function myFetch(url, options) {
    // 假设这是对fetch的直接调用或一个更底层的封装
    return fetch(url, options);
}

我们的目标是创建一个callApi函数,它能封装myFetch的调用,并根据业务需求返回特定格式的数据或错误。

处理文本响应的封装策略

当API预期返回纯文本内容时,我们需要使用response.text()方法来获取响应体。值得注意的是,response.text()本身也返回一个Promise,因此需要await等待其解析。

我们将探讨两种主要的错误处理策略:

策略一:始终解决(Resolve),通过返回值指示状态

这种策略的优点是调用者总是会收到一个Promise的解决结果,无需在调用链中使用catch。但缺点是调用者必须检查返回对象中的ok或error字段来判断请求是否成功。

/**
 * 封装API调用,处理文本响应。
 * 总是解决Promise,通过返回对象中的属性指示成功或失败。
 * @param {string} url - 请求URL
 * @param {object} options - fetch请求选项
 * @returns {Promise} 包含ok, status, body/error信息的对象
 */
async function callApiForTextAlwaysResolve(url, options) {
    let ok = false;
    let status = null;
    let body = null;
    let error = null;

    try {
        const response = await myFetch(url, options); // 假设myFetch是fetch的直接封装
        ok = response.ok;
        status = response.status;
        body = await response.text(); // 等待文本内容解析

        if (!ok) {
            // HTTP状态码非2xx,但fetch本身成功
            error = `${status}: ${body}`;
        }
    } catch (e) {
        // 网络错误、请求配置错误等导致fetch失败
        error = e.message || "网络请求失败";
        body = e; // 将原始错误对象也附带上
    }

    return { ok, status, body, error };
}

// 示例调用
async function fetchData() {
    const result = await callApiForTextAlwaysResolve('/api/data', { method: 'GET' });
    if (result.ok) {
        console.log('数据获取成功:', result.body);
    } else {
        console.error('数据获取失败:', result.error);
        // 可以根据result.status做进一步处理
    }
}

策略二:失败时拒绝(Reject)Promise

这种策略更符合Promise的惯用模式,即成功时解决,失败时拒绝。调用者可以使用try...catch或.catch()来捕获错误。

图星人
图星人

好用的AI生图工具,百万免费商用图库

下载
/**
 * 封装API调用,处理文本响应。
 * 成功时解决Promise并返回响应体,失败时拒绝Promise并抛出错误信息。
 * @param {string} url - 请求URL
 * @param {object} options - fetch请求选项
 * @returns {Promise} 成功时返回响应文本,失败时拒绝Promise
 * @throws {string|Error} 失败时抛出错误信息
 */
async function callApiForTextRejectOnFailure(url, options) {
    try {
        const response = await myFetch(url, options);
        const body = await response.text(); // 等待文本内容解析

        if (!response.ok) {
            // HTTP状态码非2xx,抛出错误
            throw `${response.status}: ${body}`;
        }
        return body; // 成功时返回文本内容
    } catch (e) {
        // 网络错误、请求配置错误或上一步抛出的HTTP错误
        // 如果是自定义的HTTP错误字符串,直接抛出;否则包装为Error对象
        if (typeof e === 'string') {
            throw e;
        }
        throw e.message || "网络请求失败";
    }
}

// 示例调用
async function fetchDataWithReject() {
    try {
        const data = await callApiForTextRejectOnFailure('/api/data', { method: 'GET' });
        console.log('数据获取成功:', data);
    } catch (error) {
        console.error('数据获取失败:', error);
        // 根据错误类型做进一步处理
    }
}

处理JSON响应的封装策略

当API预期返回JSON格式的数据时,我们需要使用response.json()方法。与response.text()类似,response.json()也返回一个Promise,需要await等待其解析。

策略一:始终解决,返回结构化数据

此策略与文本响应的“始终解决”类似,但body字段将包含解析后的JSON对象。

/**
 * 封装API调用,处理JSON响应。
 * 总是解决Promise,通过返回对象中的属性指示成功或失败。
 * @param {string} url - 请求URL
 * @param {object} options - fetch请求选项
 * @returns {Promise} 包含ok, status, body/error信息的对象
 */
async function callApiForJsonAlwaysResolve(url, options) {
    let ok = false;
    let status = null;
    let body = null; // 默认为null,成功时为JSON对象,失败时为错误信息或对象
    let error = null;

    try {
        const response = await myFetch(url, options);
        ok = response.ok;
        status = response.status;

        // 尝试解析JSON,即使非2xx响应也可能返回JSON格式的错误信息
        try {
            body = await response.json();
        } catch (jsonParseError) {
            // 如果响应不是有效的JSON,则尝试解析为文本
            body = await response.text();
            console.warn("JSON解析失败,尝试解析为文本:", body);
        }

        if (!ok) {
            // HTTP状态码非2xx
            error = {
                message: `HTTP ${status} 错误`,
                status: status,
                details: body // 可能是JSON错误对象或文本
            };
        }
    } catch (e) {
        // 网络错误或请求配置错误
        error = {
            message: e.message || "网络请求失败",
            details: e
        };
        body = null; // 确保body在网络错误时为null
    }

    return { ok, status, body, error };
}

// 示例调用
async function fetchJsonData() {
    const result = await callApiForJsonAlwaysResolve('/api/json-data', { method: 'GET' });
    if (result.ok) {
        console.log('JSON数据获取成功:', result.body);
    } else {
        console.error('JSON数据获取失败:', result.error.message, result.error.details);
    }
}

策略二:失败时拒绝Promise,抛出结构化错误

此策略在失败时拒绝Promise,并抛出一个包含status、body和error信息的结构化错误对象,以便调用者能更细致地处理不同类型的错误。

/**
 * 封装API调用,处理JSON响应。
 * 成功时解决Promise并返回JSON对象,失败时拒绝Promise并抛出结构化错误对象。
 * @param {string} url - 请求URL
 * @param {object} options - fetch请求选项
 * @returns {Promise} 成功时返回JSON对象,失败时拒绝Promise
 * @throws {object} 失败时抛出包含error, status, body的结构化错误对象
 */
async function callApiForJsonRejectOnFailure(url, options) {
    let ok = false;
    let status = null;
    let body = null;

    try {
        const response = await myFetch(url, options);
        ok = response.ok;
        status = response.status;

        // 尝试解析JSON
        try {
            body = await response.json();
        } catch (jsonParseError) {
            // 如果不是有效的JSON,仍将其作为body返回,但可能导致后续处理问题
            // 或者可以抛出一个特定的解析错误
            body = await response.text(); // 尝试获取文本内容
            throw {
                error: true,
                status: status,
                body: `JSON解析失败: ${body}` // 将非JSON内容作为错误信息
            };
        }

        if (!ok) {
            // HTTP状态码非2xx,抛出结构化错误
            throw { error: true, status: status, body: body };
        }
        return body; // 成功时返回解析后的JSON对象
    } catch (e) {
        // 捕获网络错误、请求配置错误或上一步抛出的HTTP/JSON解析错误
        if (e && typeof e === 'object' && e.error === true) {
            // 已经是我们定义的结构化错误
            throw e;
        }
        // 对于其他类型的错误(如网络错误),包装成统一的结构化错误
        throw {
            error: true,
            status: null, // 网络错误没有HTTP状态码
            body: e.message || "网络请求失败"
        };
    }
}

// 示例调用
async function fetchJsonDataWithReject() {
    try {
        const data = await callApiForJsonRejectOnFailure('/api/json-data', { method: 'GET' });
        console.log('JSON数据获取成功:', data);
    } catch (error) {
        console.error('JSON数据获取失败。');
        if (error.status) {
            console.error(`HTTP状态码: ${error.status}`);
            console.error('响应体:', error.body);
        } else {
            console.error('错误信息:', error.body); // 网络错误
        }
    }
}

错误类型与信息构建

在上述封装中,我们处理了两种主要类型的错误:

  1. 网络错误或请求配置错误:这通常发生在fetch请求发送之前或传输过程中,例如断网、URL错误、CORS策略阻断等。这些错误会被try...catch块直接捕获。在这种情况下,response对象将不会被创建。
  2. HTTP非2xx状态码:fetch成功接收到服务器响应,但响应的HTTP状态码(如404 Not Found, 500 Internal Server Error)表示业务逻辑上的失败。这种情况下,response对象是存在的,我们需要检查response.ok属性(response.ok为true表示状态码在200-299之间)来判断。

在构建错误信息时,建议提供足够的信息,如HTTP状态码、服务器返回的错误体(无论是JSON对象还是文本),以及一个清晰的错误描述。对于需要拒绝Promise的策略,抛出结构化错误对象比抛出简单的字符串更有利于调用者进行精细的错误处理。

总结与最佳实践

  1. 避免冗余的new Promise:fetch本身就返回一个Promise。不应再用new Promise去包裹一个已经返回Promise的函数,这会增加不必要的复杂性。
  2. 充分利用async/await:它能极大地简化异步代码的编写,使错误处理更加直观。
  3. 正确处理response.text()和response.json():它们都返回Promise,务必使用await等待其解析。
  4. 明确错误处理策略:根据项目需求选择“始终解决并返回状态对象”或“失败时拒绝Promise”。前者适用于需要统一处理所有结果的场景,后者更符合Promise的错误传播机制。
  5. 提供详细的错误信息:无论是通过返回对象还是拒绝Promise,都应包含足够的信息(如HTTP状态码、响应体、错误消息)以便于调试和用户反馈。
  6. 考虑自定义错误类:对于更复杂的应用,可以定义自定义错误类(例如HttpError, NetworkError),以便在catch块中通过instanceof进行类型判断,实现更精细的错误处理。
  7. 配置请求头和认证:在实际应用中,callApi函数还需要处理请求头(如Content-Type, Authorization)和认证逻辑。

通过上述封装,我们可以构建一个既健壮又易于使用的fetch API调用模块,从而提高整个应用的网络请求可靠性。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

558

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

416

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

756

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

479

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

514

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

1091

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

659

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

554

2023.09.20

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

25

2026.01.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 4.1万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 2.4万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号