vue-autoui自匹配webapi的UI控件的實(shí)現(xiàn)

更新時(shí)間：2020年03月20日 15:07:15 作者：beetlex

這篇文章主要介紹了vue-autoui自匹配webapi的UI控件的實(shí)現(xiàn)，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

vue-autoui 是一款基于vue和element擴(kuò)展的一個(gè)自動(dòng)化UI控件，它主要提供兩個(gè)控件封裝分別是auto-form和auto-grid; 通過(guò)這兩個(gè)控件可以完成大多數(shù)的信息輸入和查詢(xún)輸出的需要.auto-form和auto-grid是通過(guò)json來(lái)描述展示的結(jié)構(gòu)，在處理上要比寫(xiě)html標(biāo)簽來(lái)得方便簡(jiǎn)單，但這控件的最大優(yōu)勢(shì)并不是在這里，它最重要的功能是可以結(jié)合webapi的信息來(lái)自動(dòng)輸出界面，只需要調(diào)整webapi的信息結(jié)構(gòu)即可完成UI的調(diào)整。

基礎(chǔ)使用

控件可以直接在vuejs功能中使用，但需要結(jié)合json來(lái)設(shè)置具體UI展示，以下是一個(gè)簡(jiǎn)單的例子

 <auto-form ref="form" v-model="data" size="mini" :info="info">

  </auto-form>
  <el-button @click="if($refs.form.success()){alert(JSON.stringify(data))}">確定</el-button>

功能很簡(jiǎn)單就是顯示當(dāng)前輸入并驗(yàn)證通過(guò)的數(shù)據(jù)，下面用json描述信息輸入源。

data(){     
      return {
        info: { items: [] },
        data: { },
      };
    },
    mounted(){
      var items = [];
      items.push({
        name: 'active', label: '活動(dòng)名稱(chēng)', rules: [
          { required: true, message: '請(qǐng)輸入活動(dòng)名稱(chēng)', trigger: 'blur' },
          { min: 3, max: 5, message: '長(zhǎng)度在 3 到 5 個(gè)字符', trigger: 'blur' }
        ]
      });
      items.push({
        name: 'region', label: '活動(dòng)區(qū)域', type: 'select',
        data: [{ value: '廣州' }, { value: '深圳' }, { value: '上海' }, { value: '北京' }],
        rules: [{ required: true, message: '請(qǐng)選擇活動(dòng)區(qū)域', trigger: 'change' }],
        eof: true
      });
      items.push({ name: 'starttime', label: '開(kāi)啟時(shí)間', type: 'date', rules: [{ type: 'date', required: true, message: '請(qǐng)選擇日期', trigger: 'change' }] });
      items.push({ name: 'endtime', label: '-', type: 'date', eof: true, rules: [{ type: 'date', required: true, message: '請(qǐng)選擇日期', trigger: 'change' }] });
      items.push({ name: 'instant', type: 'switch', label: '即時(shí)配送', eof: true });
      items.push({
        name: 'nature', type: 'checkbox', label: '活動(dòng)性質(zhì)',
        rules: [{ type: 'array', required: true, message: '請(qǐng)至少選擇一個(gè)活動(dòng)性質(zhì)', trigger: 'change' }],
        data: [{ value: '美食/餐廳線上活動(dòng)' }, { value: '地推活動(dòng)' }, { value: '線下主題活動(dòng)' }, { value: '單純品牌暴光' }], eof: true
      });
      items.push({
        name: 'resource', label: '特殊資源', type: 'radio', rules: [{ required: true, message: '請(qǐng)選擇活動(dòng)資源', trigger: 'change' }],
        data: [{ value: '線上品牌商贊助' }, { value: '線下場(chǎng)地免費(fèi)' }], eof: true
      });
      items.push({ name: 'remark', label: '活動(dòng)形式', type: 'remark', rules: [{ required: true, message: '請(qǐng)?zhí)顚?xiě)活動(dòng)形式', trigger: 'blur' }] })
      this.info = { items: items}
    }

以上是使用json來(lái)描述一個(gè)輸出的界面，具體效果如下:

雖然用json來(lái)描述界面會(huì)比html描述會(huì)方便一些，但總體上來(lái)說(shuō)工作量還是有些大的，在調(diào)整界面的時(shí)候也不方便。接下介紹一下如何結(jié)合BeetleX.FastHttpApi來(lái)進(jìn)一步簡(jiǎn)化這些繁瑣的操作。

Webapi動(dòng)態(tài)輸出

其實(shí)在構(gòu)建vue-autoui的時(shí)候更多是考慮和BeetleX.FastHttpApi進(jìn)行一個(gè)整合，通過(guò)和后端融合可以把這些UI編寫(xiě)的工作量大大節(jié)省下來(lái)，讓開(kāi)發(fā)這些功能變得更簡(jiǎn)單方便，更重要的是api變化后界面就自動(dòng)適應(yīng)。使用要求：在和BeetleX.FastHttpApi整合還需要引用BeetleX.FastHttpApi.ApiDoc插件，因?yàn)檫@個(gè)插件用于給接口輸出對(duì)應(yīng)UI的JSON信息。接下來(lái)通過(guò)幾個(gè)示例來(lái)介紹整合的方便性：

登陸

登陸功能是比較常見(jiàn)的，接下來(lái)看一下使用auto-form如何結(jié)合webapi來(lái)完成這個(gè)功能。

<div>
  <auto-form ref="login" url="/login" v-model="login.data" size="mini">

  </auto-form>
  <el-button size="mini" @click="if($refs.login.success())login.post()">
    登陸
  </el-button>
</div>

以上是一個(gè)登陸功能UI的定義，是不是很簡(jiǎn)單呢？通過(guò)指定url的webapi連接即可以自動(dòng)適應(yīng)UI;這時(shí)候只需要針對(duì)登陸接口進(jìn)行一個(gè)定義即可:

[Input(Label = "用戶(hù)名", Name = "name", Eof = true)]
    [Required("用戶(hù)名不能為空", Name = "name")]
    [Input(Label = "密碼", Name = "pwd", Type = "password", Eof = true)]
    [Required("用戶(hù)密碼不能為空", Name = "pwd")]
    [Input(Label = "保存狀態(tài)", Value = true, Name = "saveStatus")]
    public bool Login(string name, string pwd, bool saveStatus)
    {
      Console.WriteLine($"name:{name} pwd:{pwd} saveStatus:{saveStatus}");
      return name == "admin";
    }

注冊(cè)

接下來(lái)定義一個(gè)信息多些的注冊(cè)界面

<div>
  <auto-form ref="login" url="/register" v-model="register.data" size="mini" @completed="onCompleted">

  </auto-form>
  <el-button size="mini" @click="if($refs.login.success())register.post()">
    注冊(cè)
  </el-button>
</div>

在UI定義上基于沒(méi)什么變化，只是調(diào)整一下對(duì)應(yīng)的url地址，在這里多了一下completed事件，這個(gè)事件主要是通過(guò)接口加載UI信息才會(huì)觸發(fā)的。對(duì)應(yīng)功能的javascript代碼

data(){
      return {
        register: new beetlexAction('/register', {}),
        checkConfirmPassword: (rule, value, callback) => {
          var password = this.$refs.login.getField('Password');
          var cpassword = this.$refs.login.getField('ConfirmPassword');
          if (password.value != cpassword.value)
            callback(new Error('確認(rèn)密碼不正確!'));
          else
            callback();
        },
      }
    },
    methods: {
      onCompleted(){
        this.$refs.login.getField('ConfirmPassword').rules.push({ validator: this.checkConfirmPassword, trigger: 'blur' });
      },
    },
    mounted() {

      this.register.requested = (r) => {
        alert(JSON.stringify(r));
      };
    }

代碼主要是定密碼和確認(rèn)密碼的對(duì)比驗(yàn)證，接下來(lái)看一下后臺(tái)注冊(cè)對(duì)應(yīng)的接口

[Post]
  public RegisterDto Register(RegisterDto register)
  {
      Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(register));
      return register;
  }
  public class RegisterDto
  {
    [Input(Label = "用戶(hù)名", Eof = true)]
    [Required("用戶(hù)名不能為空")]
    [DataRange("用戶(hù)名的必須大于3個(gè)字符", Min = 3)]
    public string Name { get; set; }

    [Input(Label = "郵箱地址", Eof = true)]
    [Required("郵件地址無(wú)效", Type = "email")]
    public string Email { get; set; }

    [Input(Label = "密碼", Eof = true, Type = "password")]
    [Required("輸入密碼")]
    public string Password { get; set; }

    [Input(Label = "確認(rèn)密碼", Eof = true, Type = "password")]
    [Required("輸入確認(rèn)密碼")]
    public string ConfirmPassword { get; set; }

    [GenderInput(Label = "性別", Value = "男", Eof = true)]
    public string Gender { get; set; }

    [Required("選擇所在城市")]
    [CityInput(Label = "城市", Eof = true)]
    public string City { get; set; }

    [HobbyInput(Label = "愛(ài)好")]
    [Required("選擇愛(ài)好", Type = "array", Trigger = "change")]
    public string[] Hobby { get; set; }
  }

服務(wù)代碼也沒(méi)太多的變化，只是通過(guò)一些標(biāo)簽來(lái)標(biāo)記一下相關(guān)屬性的數(shù)據(jù)源和輸入要求.具體運(yùn)行效果如下:

數(shù)據(jù)列表

有應(yīng)用中除了數(shù)據(jù)輸出外更多的數(shù)據(jù)列表，auto-grid即是專(zhuān)門(mén)用于處理列表的一個(gè)控件，這個(gè)控件提供分頁(yè)，選擇，編輯和刪除的功能；接下來(lái)做一個(gè)簡(jiǎn)單的雇員列表示例:

<auto-grid url="/employees" @completed="employees.get()"
      @itemchange="onItemChange" 
      @itemdelete="onItemDelete"
      @command="onCommand"
      :data="employees.result" 
      size="mini" height="100%" 
      edit="true" delete="true">
</auto-grid>

這個(gè)列表提供編輯和刪除功能，相關(guān)腳本代碼如下:

data(){
      return {
        employees: new beetlexAction('/employees', {}, [])
      }
    },
    methods: {
      onCommand(e){
        this.$open('models-employee', e.data);
      },
      onItemChange(item){
        if (confirm('是否要修改' + item.data.FirstName + '?')) {
          item.success();
        }
      },
      onItemDelete(item){
        if (confirm('是否要?jiǎng)h除' + item.data.FirstName + '?')) {
          item.success();
        }
      },
    },
    mounted() {

    }

接下來(lái)的工作就是在服務(wù)端定義api來(lái)輸出結(jié)果

[Column("FirstName", Type = "link")]
    [Column("LastName", Read = true)]
    [Column("Title")]
    [Column("HomePhone")]
    [Column("City")]
    [Column("Address")]
    public object Employees()
    {
      return DataHelper.Defalut.Employees;
    }

動(dòng)態(tài)查詢(xún)

實(shí)際應(yīng)用中需要提供查詢(xún)條件輸入，這個(gè)時(shí)候就可以把auto-form和auto-grid整合起來(lái)，以下通過(guò)一個(gè)簡(jiǎn)單的訂單查詢(xún)來(lái)展示這兩個(gè)控件結(jié)合使用

<auto-form url="/orders" v-model="orders.data" @completed="orders.get()" size="mini" @fieldchange="orders.get()">

  </auto-form>
  <auto-grid url="/orders" height="300" :data="orders.result.items" :pages="orders.result.pages" :currentpage="orders.result.index" @pagechange="onPageChange" size="mini">

  </auto-grid>

可以在auto-form的fieldchange事件中自動(dòng)執(zhí)行查詢(xún),對(duì)應(yīng)的腳本代碼如下:

data(){
      return {
        orders: new beetlexAction("/orders", {}, { index: 0, pages: 0, items: [] })
      };
    },
    methods: {
      onPageChange(page){
        this.orders.data.index = page;
        this.orders.get();
      },
    },
    mounted(){

    }

接下來(lái)需要實(shí)現(xiàn)服務(wù)端代碼，由于方法需要描述輸入和列表所以對(duì)應(yīng)的標(biāo)簽比較多

data(){
      return {
        orders: new beetlexAction("/orders", {}, { index: 0, pages: 0, items: [] })
      };
    },
    methods: {
      onPageChange(page){
        this.orders.data.index = page;
        this.orders.get();
      },
    },
    mounted(){

    }

插件詳細(xì)代碼https://github.com/IKende/BeetleX-Samples/tree/master/Web.AutoUI

https://github.com/IKende/vue-autoui

到此這篇關(guān)于vue-autoui自匹配webapi的UI控件的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)vue-autoui自匹配webapi的UI控件內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: