Daima-standard-api NPM

袋马网络通信协议-标准版

介绍

Node.js 袋马网络通信协议

软件架构

软件架构说明

安装教程

npm install daima-standard-api --save

使用说明

Node中使用

// 自定义接口配置
import config from './config/index';
// 自定义Cache实例
import cache from './config/cache';
// 引入袋马网络通信包
import App from 'daima-standard-api/dist';

// 定义应用实例
const DM = App(config, cache);

// 定义全局通用Request方法
const request = function (url, options, callback) {
  // 回调方法
  callback = Object.assign({
    success: e => console.log('success', e),  // 成功
    fail: e => console.log('fail', e),        // 失败
    complete: e => console.log('complete', e) // 完成
  }, callback);
  // 请求选项
  options = Object.assign({
    method: 'GET', // 请求方式，支持GET、POST、PUT、HEAD、PATCH、DELETE
    body: {}, // 请求的 body 信息，支持Object、FormData、URLSearchParams
    beforeRequest: e => { // 请求前事件
      // console.log('beforeRequest', e);
      return e; // 强制返回e，否则引起fetch异常
    },
    afterRequest: e => { // 请求后事件
      // console.log('afterRequest', e);
      return e;// 强制返回e，否则引起后续的链式方法异常
    },
    exception: e => console.warn(e), // 异常处理
  }, options);
  return ( new ( DM.Request ) ).sendRaytheonRequest(url, options, callback);
};

try {
  request('/app.v1.user/login', {
    method: 'POST',
    body: {username: 'admin', password: 'admin'},
    headers: {"Content-Type": "application/x-www-form-urlencoded"}
  }, {
    success(e) {
      DM.Helper.token = e.data;
    }
  });
} catch ( e ) {
  console.log(e.name + ": " + e.message);
} finally {
  console.log('网络请求测试结束')
}                                                                                                           } );

Html中使用

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <title>DaiMa-Standard-API</title>
    <link rel="shortcut icon" href="../public/favicon.ico" type="image/x-icon">
    <link type="text/css" rel="stylesheet" href="../public/style.css">
</head>
<body>
<div class="demo">
    <ul>
        <li>
            <button data-id="1"><span>POST</span><small>app.v1.user/login</small><label>登陆</label></button>
        </li>
        <li>
            <button data-id="2"><span>DELETE</span><small>app.v1.user/logout</small><label>退出</label></button>
        </li>
        <li>
            <button data-id="3"><span>HEAD</span><small>app.v1.demo/head</small></button>
        </li>
        <li>
            <button data-id="4"><span>GET</span><small>app.v1.demo/get</small></button>
        </li>
        <li>
            <button data-id="5"><span>POST</span><small>app.v1.demo/post</small></button>
        </li>
        <li>
            <button data-id="6"><span>PUT</span><small>app.v1.demo/put</small></button>
        </li>
        <li>
            <button data-id="7"><span>PATCH</span><small>app.v1.demo/patch</small></button>
        </li>
        <li>
            <button data-id="8"><span>DELETE</span><small>app.v1.demo/delete</small></button>
        </li>
        <li>
            <label>单文件上传
                <input data-id="9" type="file" data-url="app.v1.demo/fileUpload">
            </label>
        </li>
        <li>
            <label>多文件上传
                <input data-id="10" type="file" data-url="app.v1.demo/multiFileUpload" multiple="multiple">
            </label>
        </li>
    </ul>
</div>
<script type="text/javascript" src="../public/jquery.js"></script>
<script type="text/javascript">
  ( function (window, $) {
    $(function () {
      // 接口配置
      const config = window.DaimaStandardApi.__config;
      // 缓存类实例
      const cache = window.DaimaStandardApi.__cache;
      // 袋码SDK方法
      const DM = window.DaimaStandardApi.default(config, cache);
      // 定义全局通用Request方法
      const request = function (url, options, callback) {
        // 回调方法
        callback = Object.assign({
          success: e => console.log('success', e),  // 成功
          fail: e => console.log('fail', e),        // 失败
          complete: e => console.log('complete', e) // 完成
        }, callback);
        // 请求选项
        options = Object.assign({
          method: 'GET', // 请求方式，支持GET、POST、PUT、HEAD、PATCH、DELETE
          body: {}, // 请求的 body 信息，支持Object、FormData、URLSearchParams
          beforeRequest: e => { // 请求前事件
            console.log('beforeRequest', e);
            return e; // 强制返回e，否则引起fetch异常
          },
          afterRequest: e => { // 请求后事件
            console.log('afterRequest', e);
            return e;// 强制返回e，否则引起后续的链式方法异常
          },
          exception: e => console.warn(e), // 异常处理
        }, options);
        return ( new ( DM.Request ) ).sendRaytheonRequest(url, options, callback);
      };

      // Demo按钮点击事件
      $('button:button').click(function () {
        let data = {}, headers = {"Content-Type": "application/x-www-form-urlencoded"};
        const id = $(this).data('id'), method = $(this).find('span').text(), url = $(this).find('small').text(), callback = {};
        switch ( id ) {
          case 1: // 登录
            data = {username: 'admin', password: 'admin'};
            callback.success = e => DM.Helper.token = e.data;
            break;
          case 2: // 退出
            headers = {"Content-Type": "application/json"};
            break;
          case 3:
            data = {notice: 'HelloKitty'};
            break;
          case 4:
            break;
          case 5:
            headers = {"Content-Type": "application/json"};
            data = {name: '大黑'};
            break;
          case 6:
            headers = {"Content-Type": "application/json"};
            data = {};
            break;
          case 7:
            data = {};
            break;
          case 8:
            data = new URLSearchParams('?name=小黄&age=2');
            break;
        }
        request(url, {method: method, body: data, headers: headers}, callback);
      });

      // Demo文件上传事件
      $('input:file').change(function (e) {
          const id = $(this).data('id'), url = $(this).data('url'), data = new FormData(), method = 'POST',
            headers = {"Content-Type": "multipart/form-data"};
          switch ( id ) {
            case 9: // 单文件上传
              data.append('file', e.currentTarget.files[ 0 ]);
              break;
            case 10: // 多文件上传
              let i = 0;
              for ( let v of e.currentTarget.files ) {
                console.log(v);
                data.append('file_' + i, v);
                i ++;
              }
              data.append('name', '王小二');
              break;
          }
          request(url, {method: method, body: data, headers: headers});
        }
      );
    })
  } )(window, jQuery);
</script>
<--! 引入build目录下bundle.js文件 -->
<script type="text/javascript" src="./bundle.js?c5421d57f488d29ad184"></script>
<--! 引入自定义配置文件 -->
<script type="text/javascript" src="./config.js?c5421d57f488d29ad184"></script>
</body>
</html>