request.io v0.0.0-alpha.9

request.io

更全面的前端容器，支持axios/fly.io/fetch/uni.request等请求库。

Use

Use npm/yarn/pnpm

pnpm add request.io

Example

Use request.io

• request.io.config

// Request.io
import { AxiosAdapter, defineConfig, RequestIoError } from 'request.io';
// Axios
import axios, { AxiosResponse } from 'axios';
// Router
import router from '@/router';
// Message
import { Message } from 'x-next';

export default defineConfig<AxiosResponse>({
  /**
   * Http Client Adapter
   * 请求库适配器，默认提供AxiosAdapter
   */
  ADAPTER: AxiosAdapter,
  /**
   * Http库
   * 例如 axios/fly.io/uni.request...
   */
  HTTP_CLIENT: axios,
  /**
   * 接口映射
   * @description 绑定key-val, 在使用request('app.login')即可发起请求，有助于接口关系管理
   */
  API_MAP: {
    'app.login': ['/api/account/login', ['post', 'JSON']],
    'app.logout': ['/api/account/logout', ['post', 'JSON']],
  },
  /**
   * Http BASE_URL 对于允许跨域访问的接口，可以配置指定host，例如'https://dev..com'。
   * 对于有Nginx代理访问的接口，可以留空字符串或者为window.origin
   */
  BASE_URL: window.origin,
  /**
   * 采用RESTFul模式
   * 使用后对路由中使用
   * 默认使用RESTFul模式
   * 例如request(['v1/api/resource/<type=doc>/<id>', 'get'], { __type:'image', __id:8888 })，该资源地址会被自动转化为：
   * 'v1/api/resource/image/8888'，如果只传入{ __id: 8888 }则转化为'v1/api/resource/doc/8888'
   */
  USE_REST: true,
  /**
   * Content-Type
   * 可选值为 JSON/ FORM_DATA/ BLOB/ ARRAY_BUFFER等， Get为 Query String Parameters
   * 改配置项为全局默认请求Content-Type方式
   */
  CONTENT_TYPE: 'JSON',
  /**
   * 请求自动携带数据
   * Get为Query String Parameters
   * 可选项：通过Headers携带、通过REQUEST_PAYLOAD 和 FORM_DATA（body）进行数据携带
   * 配置为函数时，您可以自由操作
   */
  DATA_PERSISTENCE: {
    // Headers数据携带
    HEADERS: {
      // 自动携带token
      Authorization: () => `Bearer ${sessionStorage.getItem('token')}`,
      // 自动携带租户ID
      TenantId: () => sessionStorage.getItem('tenantId'),
    },
    // Data(body、query)数据携带
    DATA: {},
  },
  /**
   * 权限检测
   * @function
   * @param context
   * @description 检测用户是否登录，未登录跳转登录页
   */
  AUTH_CHECK: (context) => {
    console.log('AUTH_CHECK', context);
    return false;
  },
  /**
   * 分页配置
   * @description 配置分页参数，默认为page、pageSize，当请求参数为page、pageSize，可省略配置
   */
  PAGINATION: {
    page: 'page',
    pageSize: 'pagesize',
    defaultValue: {
      page: 1,
      pageSize: 10,
    },
  },
  /**
   * 失败响应数据格式
   * @param msg 异常消息
   * @param code 异常编码
   * @constructor
   */
  FAILED_RESPONSE_DATA: (msg, code) => ({
    code: code,
    msg: msg,
    data: null,
  }),
  /**
   * 请求中间件
   * 自定义请求中间件并处理业务
   */
  REQUEST_MIDDLEWARE: (context, next) => {
    if (context.request.apiMap[0] !== '/api/1') {
      // 当执行next方法时就会放行
      return next(context);
    }
    throw new RequestIoError('请求中间件报错', 16000);
  },

  /**
   * 响应中间件
   * 自定义响应中间件并处理业务
   */
  RESPONSE_MIDDLEWARE: (context, next) => {
    try {
      console.log('context-response', context, next);
      if (context?.response?.data && context?.response?.data?.code === 401) {
        localStorage.clear();
        router
          .push({
            name: 'login',
          })
          .then(() => {
            console.log('TOKEN_ERROR', '令牌失效跳转登录页');
            Message.error('令牌失效，请重新登录');
          });
        return next(context);
      } else if (context?.response?.data && context.response?.data?.code !== 0) {
        Message.error(context.response.data.msg);
        return next(context);
      } else {
        return next(context);
      }
    } catch (e) {
      console.log('响应中间件报错', (e as Error).message);
    }
  },
});

• Run

// request.io
import { bootstrap } from 'request.io';
import requestIoConfig from '~file path~/request.io.config';

// 启动应用
bootstrap(requestIoConfig);

• Request

// request.io
// request 请求函数
// transformer 转换器
// pagination 分页构造器，再配置文件中可设置默认值和对应的page、pageSize的key
import { request, transformer, pagination } from 'request.io';

// 发起请求
// request<response data type>(apiMap, data, headers, extra)
// response data type - response.data类型
// apiMap - api映射 - ['接口', 请求方法|[请求方法，content-type], 是否返回为respone<默认返回response.data>, 是否自动携带数据<默认自动携带>]
// data - 请求的数据（若使用REST方式则自动替换插入值）
// 例如request(['v1/api/resource/<type=doc>/<id>', 'get'], { __type:'image', __id:8888 })，该资源地址会被自动转化为：
// 'v1/api/resource/image/8888'，如果只传入{ __id: 8888 }则转化为'v1/api/resource/doc/8888'
// headers - 请求附加头
// extra - 额外插入的数据，例如：如果使用axios，则可包含其额外插入的数据，例如：{ withCredentials: true, timeout: 8000 }
const query = await request<{ status: boolean; data: any }>(['/api/i18n', 'get']);
// pagination(5, 20) 插入分页对象，默认为page=1, pageSize=10，参考配置文件可设置所需值
const post = await request<{ status: boolean; data: any }>(['/api/i18n'], {...pagination(5, 20), name: 'tiktok'}, { swsse: md5(hash) }, { timeout: 8000 });
// 转换器，将对象、数组转换成需要的数据再返回
const data = transformer<any>([{ a: 123 }], (data) => {
		return {
			a: data.a * 1,
			b: data.b * 2,
			c: data.c * 3,
			d: data.d * 4,
			f: data.a * 5,
		};
	});