目录
以可维护的方式进行修改的技巧
方法一:删除代码。编写代码。
方法二:重构代码,做适配!
步骤2
首页 web前端 js教程 调整JavaScript抽象的迭代方案

调整JavaScript抽象的迭代方案

Dec 08, 2017 pm 02:03 PM
javascript js 方案

本文我们和大家介绍调整JavaScript抽象的迭代方案,希望能帮助到大家。为了更加清楚的说明,我们假设在 JavaScript 中抽象是一个模块。

一个模块的最初实现只是它们漫长(也许是持久的)的生命周期过程的开始。我将一个模块的生命周期分成 3 个重要阶段。

  1. 引入模块。在项目中编写该模块或复用该模块;

  2. 调整模块。随时调整模块;

  3. 移除模块。

在我先前的文章中,重心放在了第一点上。而在这篇文章中,我将把重点放在第二点上。

模块更改是我经常碰到的一个难题。与引入模块相比,开发者维护和更改模块的方式对保证项目的可维护性和可拓展性是同等重要甚至是更加重要。我看过一个写得很好、抽象得很好的模块随着时间推移历经多次更改后被彻底毁了。我自己也经常是造成那种破坏性更改的其中一个。

当我说破坏性,我指的是对可维护性和可扩展性方面的破坏。我也明白,当面临项目最后交付期限的压力时,放慢速度以进行更好的修改设计并不是优先选择。

开发者做出非最优修改的原因可能有很多种,我在这里想特别强调一个:

以可维护的方式进行修改的技巧

这种方法让你的修改显得更专业。

让我们从一个 API 模块的代码示例开始。之所以选择这个示例,是因为与外部 API 通信是我在开始项目时定义的最基本的抽象之一。这里的想法是将所有与 API 相关的配置和设置(如基本 URL,错误处理逻辑等)存储在这个模块中.

我将编写一个设置 API.url、一个私有方法 API._handleError() 和一个公共方法  API.get():

class API {
  constructor() {
    this.url = 'http://whatever.api/v1/';
  }

  /**
   * API 数据获取的特有方法
   * 检查一个 HTTP 返回的状态码是否在成功的范围内
   */
  _handleError(_res) {
    return _res.ok ? _res : Promise.reject(_res.statusText);
  }

  /**
   * 获取数据
   * @return {Promise}
   */
  get(_endpoint) {
    return window.fetch(this.url + _endpoint, { method: 'GET' })
      .then(this._handleError)
      .then( res => res.json())
      .catch( error => {
        alert('So sad. There was an error.');
        throw new Error(error);
      });
  }
};
登录后复制

在这个模块中,公共方法 API.get() 返回一个 Promise。我们使用我们抽象出来的 API模块,而不是通过 window.fetch() 直接调用 Fetch API 。例如,获取用户信息 API.get('user')或当前天气预报 API.get('weather')。实现这个功能的重要意义在于Fetch API与我们的代码没有紧密耦合。

现在,我们面临一个修改!技术主管要求我们把获取远程数据的方式切换到Axios上。我们该如何应对呢?

在我们开始讨论方法之前,我们先来总结一下什么是不变的,什么是需要修改的:

  1. 更改:在公共 API.get() 方法中

  • 需要修改 axios()window.fetch()调用;需要再次返回一个 Promise, 以保持接口的一致, 好在 Axios 是基于 Promise 的,太棒了!

  • 服务器的响应的是 JSON。通过 Fetch API 并通过链式调用 .then( res => res.json()) 语句来解析响应的数据。使用 Axios,服务器响应是在 data 属性中,我们不需要解析它。因此,我们需要将.then语句改为.then(res => res.data)

  • 更改:在私有 API._handleError 方法中:

    • 在响应对象中缺少 ok 布尔标志,但是,还有 statusText 属性。我们可以通过它来串起来,如果它的值是 OK,那么一切将没什么问题(附注:在 Fetch APIOKtrue 与在 Axios 中的 statusTextOK 是不一样的。但为了便于理解,为了不过于宽泛,不再引入任何高级错误处理。)

  • 不变之处:API.url 保持不变,我们会发现错误并以愉快的方式提醒他们。

  • 讲解完毕!现在让我们深入应用这些修改的实际方法。

    方法一:删除代码。编写代码。

    class API {
      constructor() {
        this.url = 'http://whatever.api/v1/'; // 一模一样的
      }
    
      _handleError(_res) {
          // DELETE: return _res.ok ? _res : Promise.reject(_res.statusText);
          return _res.statusText === 'OK' ? _res : Promise.reject(_res.statusText);
      }
    
      get(_endpoint) {
          // DELETE: return window.fetch(this.url + _endpoint, { method: 'GET' })
          return axios.get(this.url + _endpoint)
              .then(this._handleError)
              // DELETE: .then( res => res.json())
              .then( res => res.data)
              .catch( error => {
                  alert('So sad. There was an error.');
                  throw new Error(error);
              });
      }
    };
    登录后复制

    听起来很合理。 提交、上传、合并、完成。

    不过,在某些情况下,这可能不是一个好主意。想象以下情景:在切换到 Axios 之后,你会发现有一个功能并不适用于 XMLHttpRequests( Axios 的获取数据的方法),但之前使用 Fetch API 的新型浏览器工作得很好。我们现在该怎么办?

    我们的技术负责人说,让我们使用旧的 API 实现这个特定的用例,并继续在其他地方使用 Axios 。你该做什么?在源代码管理历史记录中找到旧的 API 模块。还原。在这里和那里添加 if 语句。这样听起来并不太友好。

    必须有一个更容易,更易于维护和可扩展的方式来进行更改!那么,下面的就是。

    方法二:重构代码,做适配!

    重构的需求马上来了!让我们重新开始,我们不再删除代码,而是让我们在另一个抽象中移动 Fetch 的特定逻辑,这将作为所有 Fetch 特定的适配器(或包装器)。

    HEY!???对于那些熟悉适配器模式(也被称为包装模式)的人来说,是的,那正是我们前进的方向!如果您对所有的细节感兴趣,请参阅这里我的介绍。

    如下所示:
    调整JavaScript抽象的迭代方案

    步骤1

    将跟 Fetch 相关的几行代码拿出来,单独抽象为一个新的方法 FetchAdapter

    class FetchAdapter {
      _handleError(_res) {
        return _res.ok ? _res : Promise.reject(_res.statusText);
      }
    
      get(_endpoint) {
        return window.fetch(_endpoint, { method: 'GET' })
          .then(this._handleError)
          .then( res => res.json());
      }
    };
    登录后复制

    步骤2

    重构API模块,删除 Fetch 相关代码,其余代码保持不变。添加 FetchAdapter 作为依赖(以某种方式):

    class API {
      constructor(_adapter = new FetchAdapter()) {
        this.adapter = _adapter;
    
        this.url = 'http://whatever.api/v1/';
      }
    
      get(_endpoint) {
        return this.adapter.get(_endpoint)
          .catch( error => {
            alert('So sad. There was an error.');
            throw new Error(error);
          });
      }
    };
    登录后复制

    现在情况不一样了!这种结构能让你处理各种不同的获取数据的场景(适配器)改。最后一步,你猜对了!写一个 AxiosAdapter

    const AxiosAdapter = {
      _handleError(_res) {
        return _res.statusText === 'OK' ? _res : Promise.reject(_res.statusText);
      },
    
      get(_endpoint) {
        return axios.get(_endpoint)
          then(this._handleError)
          .then( res => res.data);
      }
    };
    登录后复制

    API 模块中,将默认适配器改为 AxiosAdapter

    class API {
      constructor(_adapter = new /*FetchAdapter()*/ AxiosAdapter()) {
        this.adapter = _adapter;
    
        /* ... */
      }
      /* ... */
    };
    登录后复制

    真棒!如果我们需要在这个特定的用例中使用旧的 API 实现,并且在其他地方继续使用Axios?没问题!

    //不管你喜欢与否,将其导入你的模块,因为这只是一个例子。
    import API from './API';
    import FetchAdapter from './FetchAdapter';
    
    //使用 AxiosAdapter(默认的)
    const API = new API();
    API.get('user');
    
    
    // 使用FetchAdapter
    const legacyAPI = new API(new FetchAdapter());
    legacyAPI.get('user');
    登录后复制

    所以下次你需要改变你的项目时,评估下面哪种方法更有意义:

    • 删除代码,编写代码。

    • 重构代码,写适配器。

    总结请根据你的场景选择性使用。如果你的代码库滥用适配器和引入太多的抽象可能会导致复杂性增加,这也是不好的。愉快的去使用适配器吧!

    相关推荐:

    JavaScript工作体系中不可或缺的函数

    JavaScript中filter函数的详细介绍

    JS实现的计数排序与基数排序算法示例_javascript技巧

    以上是调整JavaScript抽象的迭代方案的详细内容。更多信息请关注PHP中文网其他相关文章!

    本站声明
    本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

    热AI工具

    Undresser.AI Undress

    Undresser.AI Undress

    人工智能驱动的应用程序,用于创建逼真的裸体照片

    AI Clothes Remover

    AI Clothes Remover

    用于从照片中去除衣服的在线人工智能工具。

    Undress AI Tool

    Undress AI Tool

    免费脱衣服图片

    Clothoff.io

    Clothoff.io

    AI脱衣机

    Video Face Swap

    Video Face Swap

    使用我们完全免费的人工智能换脸工具轻松在任何视频中换脸!

    热工具

    记事本++7.3.1

    记事本++7.3.1

    好用且免费的代码编辑器

    SublimeText3汉化版

    SublimeText3汉化版

    中文版,非常好用

    禅工作室 13.0.1

    禅工作室 13.0.1

    功能强大的PHP集成开发环境

    Dreamweaver CS6

    Dreamweaver CS6

    视觉化网页开发工具

    SublimeText3 Mac版

    SublimeText3 Mac版

    神级代码编辑软件(SublimeText3)

    如何使用WebSocket和JavaScript实现在线语音识别系统 如何使用WebSocket和JavaScript实现在线语音识别系统 Dec 17, 2023 pm 02:54 PM

    如何使用WebSocket和JavaScript实现在线语音识别系统引言:随着科技的不断发展,语音识别技术已经成为了人工智能领域的重要组成部分。而基于WebSocket和JavaScript实现的在线语音识别系统,具备了低延迟、实时性和跨平台的特点,成为了一种被广泛应用的解决方案。本文将介绍如何使用WebSocket和JavaScript来实现在线语音识别系

    推荐:优秀JS开源人脸检测识别项目 推荐:优秀JS开源人脸检测识别项目 Apr 03, 2024 am 11:55 AM

    人脸检测识别技术已经是一个比较成熟且应用广泛的技术。而目前最为广泛的互联网应用语言非JS莫属,在Web前端实现人脸检测识别相比后端的人脸识别有优势也有弱势。优势包括减少网络交互、实时识别,大大缩短了用户等待时间,提高了用户体验;弱势是:受到模型大小限制,其中准确率也有限。如何在web端使用js实现人脸检测呢?为了实现Web端人脸识别,需要熟悉相关的编程语言和技术,如JavaScript、HTML、CSS、WebRTC等。同时还需要掌握相关的计算机视觉和人工智能技术。值得注意的是,由于Web端的计

    WebSocket与JavaScript:实现实时监控系统的关键技术 WebSocket与JavaScript:实现实时监控系统的关键技术 Dec 17, 2023 pm 05:30 PM

    WebSocket与JavaScript:实现实时监控系统的关键技术引言:随着互联网技术的快速发展,实时监控系统在各个领域中得到了广泛的应用。而实现实时监控的关键技术之一就是WebSocket与JavaScript的结合使用。本文将介绍WebSocket与JavaScript在实时监控系统中的应用,并给出代码示例,详细解释其实现原理。一、WebSocket技

    股票分析必备工具:学习PHP和JS绘制蜡烛图的步骤 股票分析必备工具:学习PHP和JS绘制蜡烛图的步骤 Dec 17, 2023 pm 06:55 PM

    股票分析必备工具:学习PHP和JS绘制蜡烛图的步骤,需要具体代码示例随着互联网和科技的快速发展,股票交易已经成为许多投资者的重要途径之一。而股票分析是投资者决策的重要一环,其中蜡烛图被广泛应用于技术分析中。学习如何使用PHP和JS绘制蜡烛图将为投资者提供更多直观的信息,帮助他们更好地做出决策。蜡烛图是一种以蜡烛形状来展示股票价格的技术图表。它展示了股票价格的

    如何利用JavaScript和WebSocket实现实时在线点餐系统 如何利用JavaScript和WebSocket实现实时在线点餐系统 Dec 17, 2023 pm 12:09 PM

    如何利用JavaScript和WebSocket实现实时在线点餐系统介绍:随着互联网的普及和技术的进步,越来越多的餐厅开始提供在线点餐服务。为了实现实时在线点餐系统,我们可以利用JavaScript和WebSocket技术。WebSocket是一种基于TCP协议的全双工通信协议,可以实现客户端与服务器的实时双向通信。在实时在线点餐系统中,当用户选择菜品并下单

    如何使用WebSocket和JavaScript实现在线预约系统 如何使用WebSocket和JavaScript实现在线预约系统 Dec 17, 2023 am 09:39 AM

    如何使用WebSocket和JavaScript实现在线预约系统在当今数字化的时代,越来越多的业务和服务都需要提供在线预约功能。而实现一个高效、实时的在线预约系统是至关重要的。本文将介绍如何使用WebSocket和JavaScript来实现一个在线预约系统,并提供具体的代码示例。一、什么是WebSocketWebSocket是一种在单个TCP连接上进行全双工

    JavaScript和WebSocket:打造高效的实时天气预报系统 JavaScript和WebSocket:打造高效的实时天气预报系统 Dec 17, 2023 pm 05:13 PM

    JavaScript和WebSocket:打造高效的实时天气预报系统引言:如今,天气预报的准确性对于日常生活以及决策制定具有重要意义。随着技术的发展,我们可以通过实时获取天气数据来提供更准确可靠的天气预报。在本文中,我们将学习如何使用JavaScript和WebSocket技术,来构建一个高效的实时天气预报系统。本文将通过具体的代码示例来展示实现的过程。We

    简易JavaScript教程:获取HTTP状态码的方法 简易JavaScript教程:获取HTTP状态码的方法 Jan 05, 2024 pm 06:08 PM

    JavaScript教程:如何获取HTTP状态码,需要具体代码示例前言:在Web开发中,经常会涉及到与服务器进行数据交互的场景。在与服务器进行通信时,我们经常需要获取返回的HTTP状态码来判断操作是否成功,根据不同的状态码来进行相应的处理。本篇文章将教你如何使用JavaScript获取HTTP状态码,并提供一些实用的代码示例。使用XMLHttpRequest

    See all articles