1. 统一返回结果类(Result)

Result 是后端API的统一返回结果类,用于界面根据结果展示数据或者提醒错误。

1.1. 快速开始

import {Result} from "@zhoujianhui/vip3-core"

// 构造成功结果
Result.success("操作成功").data({}).build()

// 构造错误结果
Result.error("操作失败").build()

// 构造器完整模式
Result.builder().type("success").msg("操作成功").data().build()
Result.builder().type("error").msg("操作失败").build()

其中:

  • type:结果类型,支持:success、error、info、warning,用于不同的风格的提示。

1.2. 示例

用户服务 user-service.js

import {Result} from "@zhoujianhui/vip3-core"

const userService = {
    async addUser(user) {
        try {
            await axios.post("https://example.com/users", user)

            return Result.success("新增用户成功!").build()
        } catch (error) {
            return Result.error(`新增用户失败!具体原因:${error.message}`).build()
        }
    }
}

添加用户 UserAdd.vue


<script>
  import {noticeManager} from "@zhoujianhui/vip3-core"
  import User from "../model/User"
  import userService from "../service/user-service"

  export default {
    name: "UserAdd",
    data() {
      return {
        user: new User()
      }
    },
    methods: {
      async handleAddUserBtnClick() {
        const result = await userService.addUser(this.user)

        if (result.isSuccess()) {
          // 省略重新获取用户列表
        }

        // 提示添加成功或者失败原因
        noticeManager.showMessage(result.msg, result.type);
      }
    }
  }
</script>
Copyright ©zhoujianhui all right reserved,powered by Gitbook更新时间: 2024-10-28 15:38:30

results matching ""

    No results matching ""