@ml-pkgs/ml-io-plan

ml-io-plan

目标是设计一个通用的IO 计划机制。为了避免在若网络环境下，网络请求异常导致的API请求失败。同时也为权限接口增加调度方案。

• 支持断网重试的封装.
• 支持等待认证的封装。
• 每个计划均可以独立使用，也可以按照自己的想法组合使用。

兼容

• 支持nodejs
• 支持主流游览器

安装

npm i @ml-pkgs/ml-io-plan

版本记录

点击查看

API

• IOPlanRetryAdapter IO重试适配器

/**
 * 通用适配器
 * @param ioRequestHandle  请求句柄 请实现接口 IORequestHandle
 * @param ioOptions 请求配置  {
    maxRetries?: number, //最大重试次数
    retryInterval?: number, //每次重试等待毫秒数ms
    retryCallback?: (time: number) => void | Prmise<void> //网络错误回调支持监听网络重试次数
  }
 */
constructor(
  public readonly ioRequestHandle: IORequestHandle<T, Args>,
  ioOptions?: IOPlanRetryOptions
)

• IOPlanAuthAdapter IO认证适配器

/**
 * 
 * @param ioRequestHandle 认证请求句柄auth权限, IORequestAuthHandle 实现接口
 * @param ioOptions 认证计划配置 {
    initialShouldRequestAuth?: boolean //启动时是否默认检查认证，默认为false 不自动检查
 * }
 */
constructor(
  ioRequestHandle: IORequestAuthHandle<T, Args>, 
  ioOptions?: IOPlanAuthOptions
)

• IOPlanNetworkError 定义网络异常

export class IOPlanNetworkError extends Error {
  name:string = 'IOPlanNetworkError';
  message: string = 'IOPlanNetworkError';
}

• IOPlanAuthError 定义认证异常

export class IOPlanAuthError extends Error {
  name = 'IOPlanAuthError';
  message: string = 'IOPlanAuthError';
}

Interface 接口

• IORequestHandle 自定义请求适配器

export interface IORequestHandle<T, Args extends any[] = any[]> {
    request(...args: Args): PromiseType<T>;
}

• IORequestAuthHandle 自定义认证对象接口

export interface IORequestAuthHandle<T, Args extends any[] = any[]> extends IORequestHandle<T, Args> {
    requestAuth(): PromiseType<void>;
}

如何使用

简单介绍API的使用方式

Browser 使用

浏览器上直接使用

<script src="./dist/index.umd.js"></script>
<scritp>

const {IOPlanNetworkError, IOPlanRetryAdapter, IOPlanAuthAdapter, IOPlanAuthError} = MLIoPlan;

/**
 * IO 重试机制
 */
class MockIORequestHandle  {
  async request(...args) {
    try {
      //mock request fetch
      return await fetch(...args)
    } catch(e) {
      if(/* IF is NetworkError */) {
        //模拟网络异常
        throw new IOPlanNetworkError()
      }
      throw e;
    }
  }
}
const ioRetryImpl = new IOPlanRetryAdapter(MockIORequestHandle, {
  maxRetries: 2, //最多重试2次
  retryInterval: 100, //每次重试间隔100ms
  //重试回调函数
  retryCallback: async (ts) => {
    console.log('time', ts)
  }
});

/**
 * IO 认证方案适配器, 建议组合`IORetryAdapter`一起使用，提高api稳定性
 */
class MockIORequestAuthHandle {
  async requestAuth() {
    // mock auth request fetch
    return await fetchAuth();
  }
  async request(...args) {
    try {
      //use ioRetryImpl for mock request fetch
      return await ioRetryImpl.request(...args);
    } catch(e) {
      if(/* IF is AuthError */) {
        //模拟认证异常
        throw new IOPlanAuthError()
      }
      throw e;
    }
  }
}

const ioAuthImpl = new IOPlanAuthAdapter(new MockIORequestAuthHandle(), {
  initialShouldRequestAuth: false, //启动时默认是否进行默认认证
});


</scritp>

IORetryAdapter

IO 重试机制

import {IOPlanRetryAdapter, IOPlanNetworkError, IORequestHandle} from '@ml-pkgs/ml-io-plan'

class MockIORequestHandle implements IORequestHandle<any> {
  async request(...args) {
    try {
      //mock request fetch
      return await fetch(...args)
    } catch(e) {
      if(/* IF is NetworkError */) {
        //模拟网络异常
        throw new IOPlanNetworkError()
      }
      throw e;
    }
  }
}
const ioRetryImpl = new IOPlanRetryAdapter(MockIORequestHandle, {
  maxRetries: 2, //最多重试2次
  retryInterval: 100, //每次重试间隔100ms
  //重试回调函数
  retryCallback: async (ts: number) => {
    console.log('time', ts)
  }
});


/**
 * Run Demo
 */
async function run() {
  const result = await ioRetryImpl.execute('test1', 'test2')
  console.log("result', result)
}

IOAuthPlanAdapter

IO 认证方案适配器, 建议组合IORetryAdapter一起使用，提高api稳定性

import { IOPlanAuthAdapter, IOPlanAuthError, IORequestAuthHandle} from '@ml-pkgs/ml-io-plan'

class MockIORequestAuthHandle implements IORequestAuthHandle<any> {
  async requestAuth() {
    // mock auth request fetch
    return await fetchAuth();
  }
  async request(...args) {
    try {
      //use ioRetryImpl for mock request fetch
      return await ioRetryImpl.request(...args);
    } catch(e) {
      if(/* IF is AuthError */) {
        //模拟认证异常
        throw new IOPlanAuthError()
      }
      throw e;
    }
  }
}

const ioAuthImpl = new IOPlanAuthAdapter(new MockIORequestAuthHandle(), {
  initialShouldRequestAuth: false, //启动时默认是否进行默认认证
});


/**
 * Run Demo
 */
 async function run() {
  const res = await Promise.all([
    io.execute(1),
    io.execute(2),
    io.execute(3),
    io.execute(4)
  ])
  console.log('result', JSON.stringify(res))
}