setaria

Setaria

FrontEnd SPA Enterprise Framework

功能

Setaria框架主要用于解决进行应用开发时经常面对的公共场景。

• 提供了错误处理的统一接口用于解决由浏览器，第三方依赖和Promise抛出的异常
• 提供了统一的Restful服务调用接口
• 可通过Setaria.config.js配置文件对应用开发中的消息，路由，状态等模块进行配置和管理
• 提供了中间件(middleware)配置
• 可使用History接口判断页面的跳转方向（前进/后退）

开发所需软件

• NodeJS

用于在本地进行前端的开发与调试。

安装包下载地址 安装说明

1.使用国内镜像
npm config set registry https://registry.npm.taobao.org
// 配置后可通过下面方式来验证是否成功
npm config get registry

• Yarn

用于安装项目所需的第三方依赖包

安装包下载地址和安装说明

• Git

版本管理工具。用于下载项目的代码和在开发时进行代码和文档的版本管理。

安装说明

安装步骤

# 下载工程到本地
git clone https://github.com/bluejfox/setaria.git
# 进入工程目录
cd setaria
# 安装项目依赖
yarn install

浏览器支持

支持各种主流浏览器(Chrome, Firefox, Safari)和Internet Explorer 9+.

依赖包列表

• vue
• axios
• lodash
• moment
• vue-router
• vuex

开发前需要掌握的知识

• ES6

生态圈

• Setaria-UI 桌面端组件库

特色功能

1. 初始化数据设置 2. 统一错误处理

1. 初始化数据设置

约定一个地方生产和消费初始化数据

1.1 启用方式

// 在app.js中将传入new Vue构造函数中的组件配置信息放置到 `Setaria.config.entry` 中
new Setaria({
  // Vue入口组件配置信息
  entry： {
    // 原new Vue构造函数参数
    el: '#app',
    // 原new Vue构造函数参数
    render: h => h(App)
  },
  // 定义getInitialState函数，必须返回Promise对象
  getInitialState ({ http }) {
    return new Promise((resolve, reject) => {
      http.biz.get('user', { showLoading: true })
        .then((res) => {
          const { data } = res.data
          // 返回值会由Setaria存入Vuex中，请根据实际情况构建适合的initialState结构
          resolve({ user: data })
        })
        .catch((error) => {
          reject(error)
        })
    })
  },
  loading: LoadingComponent,
  error: ErrorComponent,
  http: {
    defaults: {},
    biz: {
    }
  },
  routes
})

1.2 运行时配置

getInitialState函数会在整个应用最开始执行，返回值会作为全局共享的数据。执行成功后框架会初始化根Vue实例，之后在Vue实例中可以通过 this.$store.getters[constants.STORE_KEY.GET_INITIAL_STATE] 直接获取到这份数据。

1.3 API

获取返回值

computed: {
  initialState() {
    const { data, error } = this.$store.getters[constants.STORE_KEY.GET_INITIAL_STATE];
    return data;
  }
},

data

• Type: any
• Default: null

运行时配置中，getInitialState 的返回值

error

• Type: Error
• Default: null

当运行时配置中，getInitialState throw Error 时，会将错误储存在 error 中。

refreshInitialState 刷新初始化数据

• Type: () => Promise

重新执行 getInitialState 方法，并获取新数据。

import Setaria from 'setaria'

Setaria.refreshInitialState()

// 或者在Vue实例内使用如下方式执行
// this.$setaria.api.refreshInitialState()

手动设置返回值

通过Vuex使用constants.STORE_KEY.SET_INITIAL_STATE mutation将数据手动保存至全局Vuex Module中

import { constants } from 'setaria';

this.$store.commit(constants.STORE_KEY.SET_INITIAL_STATE, {
  data: {
    user: {
      id: 'setaria-user',
      sex: 'gender'
    }
  }
})

2. 统一错误处理

前端页面中，基于vue的前端应用一般情况下需要捕获三个错误处理接口:

• window.onerror
• vue.config.errorHandler
• Promise onunhandledrejection

注: Vue从2.6.0版本之后，在vue实例内的 生命周期函数(created等) 和 事件钩子函数(v-on DOM 监听器内部) 抛出的普通 error 和 promise error 都可以捕获并统一从 errorHandler 接口抛出。

因此，Setaria提供了一套统一的错误处理方案，将如上接口进行封装并触发 config.errorHandler 配置的函数，并把不同类型的错误信息(字符串，promise等)通过 ApplicationError(执行期异常) 和 ServiceError(服务调用异常) 传递，方便对错误进行后续的操作（页面提示等）

2.1 运行时配置

new Setaria({
  /**
   * @param {ApplicationError} error 封装的错误对象
   * @param {string} type
   * 'NORMAL_ERROR': 0, 非Vue组件的常规错误
   * 'PROMISE_UNREJECT_ERROR': 1, Promise回调函数中的错误
   * 'VUE_ERROR': 2 从 Vue 2.2.0 起，Vue组件生命周期钩子里的错误可以被捕获。从 Vue 2.4.0 起，Vue组件自定义事件句柄内部的错误可以被捕获。
   * @param {object} origin 原始错误对象
   **/
  errorHandler(error, type, origin) => {
    const exception = {
      // 错误code
      code: error.errorCode,
      // 错误消息
      message: error.errorMessage,
      // 后端request唯一ID
      requestId: error.requestId,
      // 后端业务单据号
      oddNumber: error.oddNumber,
      // 错误显示方式 0 silent; 1 message.warn; 2 message.error; 4 notification; 9 page
      showType: error.showType
    }
    alert(exception.message)
  },
  http: {
  }
})

2.2 API

ApplicationError

抛出普通异常信息，一般用于在处理中抛出指定业务异常

import { ApplicationError } from 'setaria'

// MCM006E为在Setaria.config.message中定义的消息ID
throw new ApplicationError('MCM006E')

ServiceError

抛出服务异常信息，当服务端返回异常时，异常信息会用此类型包装后抛出

errorCode

错误码

• Type: String
• Default: null

errorMessage

错误消息

• Type: String
• Default: null

requestId

后端请求唯一标识ID，一般用于辅助快速查找后端错误

• Type: String
• Default: null

showType

错误渲染方式(0 静默; 1 message.warn; 2 message.error; 4 notification; 9 page)

• Type: Number
• Default: 2

公共模块

• 鉴权
• 消息处理
• 服务调用
• 异常处理
• 路由处理
• 数据存储管理
• 用户状态管理

License

MIT