首页手记请求动作封装教程：新手必看指南

请求动作封装教程：新手必看指南

标签：

数据结构 API

概述

本文介绍了请求动作封装的概念和必要性，通过封装可以简化代码并提高复用性。文章详细讲解了封装请求动作的基础知识、步骤和实用示例，提供了Python和JavaScript两种语言的实现方法。文章还涵盖了如何处理并发请求和优化性能的进阶技巧，内容全面详实。请求动作封装教程将帮助开发者更好地管理和复用HTTP请求代码。

什么是请求动作封装

解释请求和动作的概念

在计算机网络中，请求是指客户端向服务器发送的数据包，以获取或修改服务器上的资源。动作是指客户端希望服务器执行的特定操作，例如获取网页内容、提交表单数据等。请求和动作的结合通常以HTTP协议的形式进行通信，其中HTTP定义了多种方法，如GET、POST、PUT、DELETE等，分别对应不同的操作。

介绍为什么需要封装请求动作

封装请求动作的主要目的是为了提高代码的可维护性和复用性。通过封装，可以将复杂的HTTP请求操作抽象为简单的函数调用，使得在不同的模块或项目中都可以方便地重复使用这些封装好的函数。例如，封装GET请求时，可以将URL、请求头等参数作为输入，返回响应数据。这种方式不仅简化了代码，而且提高了代码的可读性和可维护性。

封装请求动作的基础知识

介绍常见的请求动作类型

HTTP请求动作主要有以下几种类型：

GET：用于从服务器获取资源，不包含请求体。
POST：用于向服务器提交数据，通常包含请求体。
PUT：用于更新或替换服务器上的资源。
DELETE：用于删除服务器上的资源。

这些类型对应不同的HTTP方法，每种方法有其特定的用途和行为。

简单介绍封装请求动作的几种方式

封装请求动作可以通过多种方式实现，这里介绍两种常见的方法：

使用HTTP库：如Python中的requests库，或JavaScript中的fetch API，这些库提供了简洁的API来封装HTTP请求。

import requests

class RequestHandler:
  def __init__(self, base_url):
      self.base_url = base_url

  def get(self, endpoint, params=None):
      url = f"{self.base_url}/{endpoint}"
      response = requests.get(url, params=params)
      return response.json()

  def post(self, endpoint, data=None, json=None):
      url = f"{self.base_url}/{endpoint}"
      response = requests.post(url, data=data, json=json)
      return response.json()

const axios = require('axios');

class RequestHandler {
  constructor(baseUrl) {
      this.baseUrl = baseUrl;
  }

  async get(endpoint, params) {
      const url = `${this.baseUrl}${endpoint}`;
      const response = await axios.get(url, { params });
      return response.data;
  }

  async post(endpoint, data) {
      const url = `${this.baseUrl}${endpoint}`;
      const response = await axios.post(url, data, { headers: { 'Content-Type': 'application/json' } });
      return response.data;
  }
}

自定义函数：通过定义一系列函数来封装请求动作，每个函数对应一种请求类型，处理特定的请求逻辑。

import requests

class RequestHandler:
  def __init__(self, base_url):
      self.base_url = base_url

  def get(self, endpoint, params=None):
      url = f"{self.base_url}/{endpoint}"
      response = requests.get(url, params=params)
      return response.json()

  def post(self, endpoint, data=None, json=None):
      url = f"{self.base_url}/{endpoint}"
      response = requests.post(url, data=data, json=json)
      return response.json()

const axios = require('axios');

class RequestHandler {
  constructor(baseUrl) {
      this.baseUrl = baseUrl;
  }

  async get(endpoint, params) {
      const url = `${this.baseUrl}${endpoint}`;
      const response = await axios.get(url, { params });
      return response.data;
  }

  async post(endpoint, data) {
      const url = `${this.baseUrl}${endpoint}`;
      const response = await axios.post(url, data, { headers: { 'Content-Type': 'application/json' } });
      return response.data;
  }
}

这两种方式各有优势。使用HTTP库可以快速实现封装，但可能缺乏灵活性；自定义函数则可以提供更细致的控制和扩展功能。

封装请求动作的步骤详解

准备必要的开发环境

在开始封装请求动作之前，需要确保开发环境的准备。对于Python开发环境，需要安装Python和一个合适的HTTP库，如requests。以下是安装requests库的步骤：

打开终端或命令行工具。
运行以下命令安装requests库：

pip install requests

对于JavaScript开发环境，需要确保Node.js和axios库已安装。以下是安装axios的步骤：

打开终端或命令行工具。
运行以下命令安装axios库：

npm install axios

创建封装请求动作的代码框架

在开始编写具体的请求逻辑之前，需要首先创建一个基本的封装框架。这个框架将定义每个请求动作的结构和公共部分。

Python示例框架

import requests

class RequestHandler:
    def __init__(self, base_url):
        self.base_url = base_url

    def get(self, endpoint, params=None):
        pass

    def post(self, endpoint, data=None, json=None):
        pass

    def put(self, endpoint, data=None, json=None):
        pass

    def delete(self, endpoint):
        pass

JavaScript示例框架

const axios = require('axios');

class RequestHandler {
    constructor(baseUrl) {
        this.baseUrl = baseUrl;
    }

    get(endpoint, params) {
        return axios.get(`${this.baseUrl}${endpoint}`, { params });
    }

    post(endpoint, data, json) {
        return axios.post(`${this.baseUrl}${endpoint}`, data, { headers: { 'Content-Type': 'application/json' } });
    }

    put(endpoint, data, json) {
        return axios.put(`${this.baseUrl}${endpoint}`, data, { headers: { 'Content-Type': 'application/json' } });
    }

    delete(endpoint) {
        return axios.delete(`${this.baseUrl}${endpoint}`);
    }
}

添加请求逻辑

在框架的基础上，需要为每个请求动作添加具体的请求逻辑。这些逻辑包括构造请求URL、传递参数、处理响应等。

Python示例逻辑

import requests

class RequestHandler:
    def __init__(self, base_url):
        self.base_url = base_url

    def get(self, endpoint, params=None):
        response = requests.get(f"{self.base_url}/{endpoint}", params=params)
        return response.json()

    def post(self, endpoint, data=None, json=None):
        response = requests.post(f"{self.base_url}/{endpoint}", data=data, json=json)
        return response.json()

    def put(self, endpoint, data=None, json=None):
        response = requests.put(f"{self.base_url}/{endpoint}", data=data, json=json)
        return response.json()

    def delete(self, endpoint):
        response = requests.delete(f"{self.base_url}/{endpoint}")
        return response.json()

JavaScript示例逻辑

const axios = require('axios');

class RequestHandler {
    constructor(baseUrl) {
        this.baseUrl = baseUrl;
    }

    get(endpoint, params) {
        return axios.get(`${this.baseUrl}${endpoint}`, { params }).then(response => response.data);
    }

    post(endpoint, data, json) {
        return axios.post(`${this.baseUrl}${endpoint}`, data, { headers: { 'Content-Type': 'application/json' } }).then(response => response.data);
    }

    put(endpoint, data, json) {
        return axios.put(`${this.baseUrl}${endpoint}`, data, { headers: { 'Content-Type': 'application/json' } }).then(response => response.data);
    }

    delete(endpoint) {
        return axios.delete(`${this.baseUrl}${endpoint}`).then(response => response.data);
    }
}

测试封装效果

在完成封装后，需要进行测试以确保封装的效果符合预期。可以通过编写测试用例来验证每个封装函数的行为。

Python测试示例

import unittest
from request_handler import RequestHandler

class TestRequestHandler(unittest.TestCase):
    def setUp(self):
        self.handler = RequestHandler("https://api.example.com")

    def test_get(self):
        response = self.handler.get("users", params={"id": 1})
        self.assertEqual(response["id"], 1)

    def test_post(self):
        response = self.handler.post("users", json={"name": "Alice", "age": 25})
        self.assertEqual(response["name"], "Alice")
        self.assertEqual(response["age"], 25)

    def test_put(self):
        response = self.handler.put("users/1", json={"name": "Bob"})
        self.assertEqual(response["name"], "Bob")

    def test_delete(self):
        response = self.handler.delete("users/1")
        self.assertTrue(response["status"] == "deleted")

if __name__ == '__main__':
    unittest.main()

JavaScript测试示例

const assert = require('assert');
const requestHandler = new RequestHandler('https://api.example.com');

describe('RequestHandler', () => {
    it('should get a user', async () => {
        const response = await requestHandler.get('/users', { id: 1 });
        assert.strictEqual(response.id, 1);
    });

    it('should post a new user', async () => {
        const response = await requestHandler.post('/users', { name: 'Alice', age: 25 });
        assert.strictEqual(response.name, 'Alice');
        assert.strictEqual(response.age, 25);
    });

    it('should update a user', async () => {
        const response = await requestHandler.put('/users/1', { name: 'Bob' });
        assert.strictEqual(response.name, 'Bob');
    });

    it('should delete a user', async () => {
        const response = await requestHandler.delete('/users/1');
        assert.strictEqual(response.status, 'deleted');
    });
});

封装请求动作的实用示例

如何封装GET请求

封装GET请求是封装请求动作中最基础的部分。以下是如何封装一个GET请求的具体示例：

Python示例

import requests

class RequestHandler:
    def __init__(self, base_url):
        self.base_url = base_url

    def get(self, endpoint, params=None):
        url = f"{self.base_url}/{endpoint}"
        response = requests.get(url, params=params)
        return response.json()

# 使用示例
handler = RequestHandler("https://api.example.com")
response = handler.get("users", params={"id": 1})
print(response)

JavaScript示例

const axios = require('axios');

class RequestHandler {
    constructor(baseUrl) {
        this.baseUrl = baseUrl;
    }

    async get(endpoint, params) {
        const url = `${this.baseUrl}${endpoint}`;
        const response = await axios.get(url, { params });
        return response.data;
    }
}

// 使用示例
const handler = new RequestHandler('https://api.example.com');
handler.get('/users', { id: 1 }).then(response => console.log(response));

如何封装POST请求

封装POST请求时，需要考虑请求体的构造和处理。以下是如何封装一个POST请求的具体示例：

Python示例

import requests

class RequestHandler:
    def __init__(self, base_url):
        self.base_url = base_url

    def post(self, endpoint, data=None, json=None):
        url = f"{self.base_url}/{endpoint}"
        response = requests.post(url, data=data, json=json)
        return response.json()

# 使用示例
handler = RequestHandler("https://api.example.com")
response = handler.post("users", json={"name": "Alice", "age": 25})
print(response)

JavaScript示例

const axios = require('axios');

class RequestHandler {
    constructor(baseUrl) {
        this.baseUrl = baseUrl;
    }

    async post(endpoint, data) {
        const url = `${this.baseUrl}${endpoint}`;
        const response = await axios.post(url, data, { headers: { 'Content-Type': 'application/json' } });
        return response.data;
    }
}

// 使用示例
const handler = new RequestHandler('https://api.example.com');
handler.post('/users', { name: 'Alice', age: 25 }).then(response => console.log(response));

常见问题及解决方法

解释常见的错误及其原因

封装请求动作时可能会遇到多种错误，以下是一些常见的错误及其原因：

请求超时：请求时间过长，可能是网络问题或服务器响应慢。
请求失败：服务器返回非200状态码，可能是请求参数错误或服务器端问题。
JSON解析错误：返回的数据格式不正确，可能是服务器端返回的数据格式错误或请求体格式不正确。

提供解决这些问题的建议和方法

解决这些问题的方法如下：

请求超时：增加超时时间设置，检查网络连接，确认服务器状态。
请求失败：检查请求参数和URL，确保服务器端正确响应。
JSON解析错误：验证返回的数据格式，确保数据格式正确。

Python示例

import requests

class RequestHandler:
    def __init__(self, base_url):
        self.base_url = base_url

    def get(self, endpoint, params=None):
        url = f"{self.base_url}/{endpoint}"
        try:
            response = requests.get(url, params=params, timeout=10)
            return response.json()
        except requests.exceptions.Timeout:
            print("Request timed out, please check network or server status.")
        except requests.exceptions.RequestException as e:
            print(f"Request failed with error: {e}")

# 使用示例
handler = RequestHandler("https://api.example.com")
response = handler.get("users", params={"id": 1})
print(response)

JavaScript示例

const axios = require('axios');

class RequestHandler {
    constructor(baseUrl) {
        this.baseUrl = baseUrl;
    }

    async get(endpoint, params) {
        const url = `${this.baseUrl}${endpoint}`;
        try {
            const response = await axios.get(url, { params, timeout: 10000 });
            return response.data;
        } catch (error) {
            if (error.code === 'ECONNABORTED') {
                console.log("Request timed out, please check network or server status.");
            } else {
                console.error(`Request failed with error: ${error}`);
            }
        }
    }
}

// 使用示例
const handler = new RequestHandler('https://api.example.com');
handler.get('/users', { id: 1 }).then(response => console.log(response));

封装请求动作的进阶技巧

如何处理并发请求

处理并发请求可以提高应用的响应速度和用户体验，尤其是在需要同时处理多个请求时。以下是如何处理并发请求的具体示例：

Python示例

import requests
import asyncio

class RequestHandler:
    def __init__(self, base_url):
        self.base_url = base_url

    async def get(self, endpoint, params=None):
        url = f"{self.base_url}/{endpoint}"
        loop = asyncio.get_event_loop()
        response = await loop.run_in_executor(None, requests.get, url, params)
        return response.json()

    async def post(self, endpoint, data=None, json=None):
        url = f"{self.base_url}/{endpoint}"
        loop = asyncio.get_event_loop()
        response = await loop.run_in_executor(None, requests.post, url, data=data, json=json)
        return response.json()

async def run():
    handler = RequestHandler("https://api.example.com")
    tasks = [
        handler.get("users", params={"id": 1}),
        handler.post("users", json={"name": "Alice", "age": 25})
    ]
    responses = await asyncio.gather(*tasks)
    print(responses)

# 使用示例
asyncio.run(run())

JavaScript示例

const axios = require('axios');
const { promisify } = require('util');

const getPromisified = promisify(axios.get);
const postPromisified = promisify(axios.post);

class RequestHandler {
    constructor(baseUrl) {
        this.baseUrl = baseUrl;
    }

    async get(endpoint, params) {
        const url = `${this.baseUrl}${endpoint}`;
        const response = await getPromisified(url, { params });
        return response.data;
    }

    async post(endpoint, data) {
        const url = `${this.baseUrl}${endpoint}`;
        const response = await postPromisified(url, data, { headers: { 'Content-Type': 'application/json' } });
        return response.data;
    }
}

async function run() {
    const handler = new RequestHandler('https://api.example.com');
    const tasks = [
        handler.get('/users', { id: 1 }),
        handler.post('/users', { name: 'Alice', age: 25 })
    ];
    const responses = await Promise.all(tasks);
    console.log(responses);
}

// 使用示例
run();

如何优化请求封装的性能

优化请求封装的性能可以通过多种方法实现，以下是一些常见的方法：

使用缓存：对于不经常改变的数据，可以使用缓存来减少请求次数。
压缩数据：通过压缩数据可以减少传输时间，提高效率。
优化请求参数：减少不必要的参数和请求体，提高请求的效率。

Python示例

import requests
import functools

def cached(func):
    cache = {}
    @functools.wraps(func)
    def wrapper(*args, **kwargs):
        key = tuple(args) + tuple(kwargs.items())
        if key not in cache:
            cache[key] = func(*args, **kwargs)
        return cache[key]
    return wrapper

class RequestHandler:
    @cached
    def get(self, endpoint, params=None):
        url = f"https://api.example.com/{endpoint}"
        response = requests.get(url, params=params)
        return response.json()

# 使用示例
handler = RequestHandler()
response1 = handler.get("users", params={"id": 1})
response2 = handler.get("users", params={"id": 1})  # 从缓存中获取
print(response1)
print(response2)

JavaScript示例

const axios = require('axios');
const { promisify } = require('util');
const cache = new Map();

const getPromisified = promisify(axios.get);

class RequestHandler {
    async get(endpoint, params) {
        const key = JSON.stringify(params);
        let cachedResponse = cache.get(key);
        if (cachedResponse) {
            return cachedResponse;
        }
        const url = `https://api.example.com${endpoint}`;
        const response = await getPromisified(url, { params });
        cache.set(key, response.data);
        return response.data;
    }
}

async function run() {
    const handler = new RequestHandler();
    const response1 = await handler.get('/users', { id: 1 });
    const response2 = await handler.get('/users', { id: 1 });  // 从缓存中获取
    console.log(response1);
    console.log(response2);
}

// 使用示例
run();

通过这些示例和方法，你可以将请求动作封装得更加高效和可靠。

点击查看更多内容

为 TA 点赞

若觉得本文不错，就分享一下吧！

评论

评论

共同学习，写下你的评论

评论加载中...

展开查看更多评论

作者其他优质文章

正在加载中

慕仙森

手记
篇

粉丝

37

获赞与收藏

103

关注作者，订阅最新文章

阅读免费教程

数据结构入门教程

7个小节 23686 615

后端通用面试教程

41个小节 30936 346

ES6-10 入门教程

61个小节 93882 733

推荐

评论

收藏

共同学习，写下你的评论



感谢您的支持，我会继续努力的～

扫码打赏，你说多少就多少

赞赏金额会直接到老师账户

支付方式

打开微信扫一扫，即可进行扫码打赏哦

今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与放弃机会

点击
抽奖

慕课手记新用户专享福利

恭喜你，你的运气太好了，居然抽中了 100个积分！

恭喜你，抽中了价值元的专栏！

太棒了，直接落到你账户里！

积分商城里的罗技鼠标、机械键盘、
Kindle 阅读器、小米平衡车
Apple iPad （10.2英寸）、大额优惠券
在等着你去兑换了噢

作者：

免费赠送

兑换码：1111222211 复制

优惠券可用于购买实战课、体系课
无门槛使用

先去看看，有什么好东西马上兑换我爱学习，选课去


热搜

最近搜索清空

请求动作封装教程：新手必看指南

解释请求和动作的概念

介绍为什么需要封装请求动作

介绍常见的请求动作类型

简单介绍封装请求动作的几种方式

准备必要的开发环境

创建封装请求动作的代码框架

Python示例框架

JavaScript示例框架

添加请求逻辑

Python示例逻辑

JavaScript示例逻辑

测试封装效果

Python测试示例

JavaScript测试示例

如何封装GET请求

Python示例

JavaScript示例

如何封装POST请求

Python示例

JavaScript示例

解释常见的错误及其原因

提供解决这些问题的建议和方法

Python示例

JavaScript示例

如何处理并发请求

Python示例

JavaScript示例

如何优化请求封装的性能

Python示例

JavaScript示例

阅读免费教程