自定義react資料驗證元件

Jaxu發表於2018-10-18
React元件

　　我們在做前端表單提交時，經常會遇到要對錶單中的資料進行校驗的問題。如果使用者提交的資料不合法，例如格式不正確、非數字型別、超過最大長度、是否必填項、最大值和最小值等等，我們需要在相應的地方給出提示資訊。如果使用者修正了資料，我們還要將提示資訊隱藏起來。

　　有一些現成的外掛可以讓你非常方便地實現這一功能，如果你使用的是knockout框架，那麼你可以藉助於Knockout-Validation這一外掛。使用起來很簡單，例如我下面的這一段程式碼：

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上的說明文件和示例。

 

　　但是，如果我們前端使用的是React框架，如何來實現和上面knockout類似的功能呢？我們可以考慮將這一相對獨立的功能抽出來，寫成一個React元件。看下面的程式碼：

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>
  }
}

　　該元件支援的驗證項有：

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

　　如何使用？

　　我們在父元件的render()方法中加入該元件的引用：

<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()方法對傳入的資料按照預先設定的規則進行驗證，並決定是否顯示錯誤資訊。

　　注意，這裡我們在引用ValidationInputs元件時，設定了一個ref屬性，這是為了方便在父元件中獲得ValidationInputs元件的驗證結果（成功或失敗）。我們可以在父元件中通過下面這個方法來進行判斷（假設父元件中引用了多個ValidationInputs元件，並且每個引用都設定了不同的ref值）：

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

    return true;
}

 　　這樣，我們在父元件提交資料之前，可以通過這個方法來判斷所有的資料項是否都已經通過驗證，如果未通過驗證，則不提交表單。

　　其它幾個基於React的資料驗證元件，不過貌似都是server端使用的：

　　https://github.com/edwardfhsiao/react-inputs-validation

　　https://github.com/learnetto/react-form-validation-demo

　　https://learnetto.com/blog/how-to-do-simple-form-validation-in-reactjs

相關文章