自定義react數據驗證組件

時間 2019-11-05

原文原文鏈接

　　咱們在作前端表單提交時，常常會遇到要對錶單中的數據進行校驗的問題。若是用戶提交的數據不合法，例如格式不正確、非數字類型、超過最大長度、是否必填項、最大值和最小值等等，咱們須要在相應的地方給出提示信息。若是用戶修正了數據，咱們還要將提示信息隱藏起來。前端

　　有一些現成的插件可讓你很是方便地實現這一功能，若是你使用的是knockout框架，那麼你能夠藉助於Knockout-Validation這一插件。使用起來很簡單，例如我下面的這一段代碼：react

ko.validation.locale('zh-CN');
ko.validation.rules['money'] = {
    validator: function (val) {
        if (val === '') return true;
        return /^\d+(\.\d{1,2})?$/.test(val);
    },
    message: '輸入的金額不正確'
};
ko.validation.rules['moneyNoZero'] = {
    validator: function (val) {
        if (val === '') return true;
        return isNaN(val) || val != 0;
    },
    message: '輸入的金額不能爲0'
};
ko.validation.registerExtenders();

var model = {
    MSRP: ko.observable(0),
    price: ko.observable().extend({ required: true, number: true, min: 10000, money: true, moneyNoZero: true }),
    licence_service_fee: ko.observable().extend({ required: true, money: true }),
    purchase_tax: ko.observable().extend({ required: true, money: true }),
    vehicle_tax: ko.observable().extend({ required: true, money: true }),
    insurance: ko.observable().extend({ required: true, money: true }),
    commercial_insurance: ko.observable().extend({ required: true, money: true }),
    mortgage: ko.observable(''),
    interest_discount: ko.observable(''),
    allowance: ko.observable().extend({ money: true }),
    special_spec_fee_explain: ko.observable(''),
    has_extra_fee: ko.observable(false),
    is_new_energy: ko.observable(false)
};

model.extra_fee_explain = ko.observable().extend({
    required: {
        onlyIf: function () {
            return model.has_extra_fee() === true;
        }
    }
});

model.extra_fee = ko.observable().extend({
    required: {
        onlyIf: function () {
            return model.has_extra_fee() === true;
        }
    },
    money: {
        onlyIf: function () {
            return model.has_extra_fee() === true;
        }
    }
});

model.new_energy_allowance_explain = ko.observable().extend({
    required: {
        onlyIf: function () {
            return model.is_new_energy() === true;
        }
    }
});

model.total_price = ko.computed(function () {
    var _total = Number(model.price()) + Number(model.licence_service_fee()) +
        Number(model.purchase_tax()) + Number(model.vehicle_tax()) +
        Number(model.insurance()) + Number(model.commercial_insurance());
    if (model.has_extra_fee()) {
        _total += Number(model.extra_fee());
    }
    if (model.is_new_energy()) {
        _total -= Number(model.new_energy_allowance());
    }
    return isNaN(_total) ? '0' : _total.toFixed(2).replace(/(\.0*$)|(0*$)/, '');
});

model.errors = ko.validation.group(model);
ko.applyBindings(model);

　　更多使用方法能夠查看github上的說明文檔和示例。git

　　可是，若是咱們前端使用的是React框架，如何來實現和上面knockout相似的功能呢？咱們能夠考慮將這一相對獨立的功能抽出來，寫成一個React組件。看下面的代碼：github

class ValidationInputs extends React.Component {
  constructor(props) {
    super(props);
    this.state = {
      isValid: true,
      required: this.props.required,
      number: this.props.number,
      min: this.props.min,
      max: this.props.max,
      money: this.props.money,
      data: null,
      errors: ""
    }
  }

  componentWillReceiveProps(nextProps) {
    var that = this;
    if (this.state.data !== nextProps.data) {
      return setStateQ({data: nextProps.data}, this).then(function () {
        return that.handleValidation();
      });
    }
  }

  handleValidation() {
    var fields = this.state.data;

    // required validation
    if(this.state.required && isNilOrEmpty(fields)){
      return setStateQ({errors: '必須填寫', isValid: false}, this);

    }
    // number validation
    if (this.state.number) {
      if (isNaN(fields)) {
        return setStateQ({errors: '請輸入數字', isValid: false}, this);
      }
      if (!isNilOrEmpty(this.state.min) && !isNaN(this.state.min) && Number(this.state.min) > Number(fields)) {
        return setStateQ({errors: '輸入值必須大於等於' + this.state.min, isValid: false}, this);
      }
      if (!isNilOrEmpty(this.state.max) && !isNaN(this.state.max) && Number(this.state.max) < Number(fields)) {
        return setStateQ({errors: '輸入值必須小於等於' + this.state.max, isValid: false}, this);
      }
    }
    // money validation
    if (this.state.money) {
      if (fields.length > 0 && !/^\d+(\.\d{1,2})?$/.test(fields)) {
        return setStateQ({errors: '輸入的金額不正確', isValid: false}, this);
      }
    }

    return setStateQ({errors: '', isValid: true}, this);
  }

  render() {
    return <span className="text-danger">{this.state.errors}</span>
  }
}

　　該組件支持的驗證項有：app

required：true | false 檢查是否必填項。
number：true | false 檢查輸入的值是否爲數字。
- 若是number爲true，可經過max和min來驗證最大值和最小值。max和min屬性的值都必須爲一個有效的數字。
money：true | false 驗證輸入的值是否爲一個有效的貨幣格式。貨幣格式必須爲數字，最多容許有兩位小數。

　　如何使用？框架

　　咱們在父組件的render()方法中加入該組件的引用：ui

<div className="item">
    <div className="col-xs-4">淨車價：</div>
    <div className="col-xs-7">
        <input type="text" className="form-control" placeholder="0" value={this.state.price} onChange={this.changePrice.bind(this)}/>
        <ValidationInputs ref="validation1" data={this.state.price} required="true" number="true" min="10000" max="99999999" money="true"/>
    </div>
    <div className="col-xs-1 text-center">元</div>
    <div className="clear"></div>
</div>

　　咱們將price變量加到父組件的state中，並給input控件綁定onChange事件，以便用戶在修改了文本框中的內容時，price變量的值能夠實時傳入到ValidationInputs組件中。這樣，ValidationInputs組件就能夠當即經過本身的handleValidation()方法對傳入的數據按照預先設定的規則進行驗證，並決定是否顯示錯誤信息。this

　　注意，這裏咱們在引用ValidationInputs組件時，設置了一個ref屬性，這是爲了方便在父組件中得到ValidationInputs組件的驗證結果（成功或失敗）。咱們能夠在父組件中經過下面這個方法來進行判斷（假設父組件中引用了多個ValidationInputs組件，而且每一個引用都設置了不一樣的ref值）：spa

// 父組件調用該方法來判斷全部的輸入項是否合法
checkInputs() {
    for (var r in this.refs) {
        var _ref = this.refs[r];
        if (_ref instanceof ValidationInputs) {
            if (!_ref.state.isValid) return false;
        }
    }

    return true;
}