Проверка данных переднего плана начинается с моделирования

внешний интерфейс JavaScript

Какие бизнес-функции вам больше всего раздражают во время разработки интерфейса?

Над интерфейсом работаю давно, не знаю, есть ли у вас такие же ощущения, как у меня, в некоторых веб-приложениях обработка формы доставляет больше хлопот, чем другие функциональные модули, много ручной работы , и зачастую проверка данных занимает много времени. .

Чтобы сделать эту часть кода более организованной, мы предопределяем модель данных в части проверки данных через Schema, вбрасываем в нее данные и возвращаем результат проверки.

Далее я представлю этот инструмент,schema-typedЭто инструмент моделирования и проверки данных, он может быть очень удобным для разработки структуры данных формы, конечно, он не ограничивается использованием форм. Если вы используете React в продакшене, тоReact SuiteКомпонент формы просто сильнее.

Установить

npm install schema-typed --save

Пример

import { SchemaModel, StringType, DateType, NumberType } from 'schema-typed';

const model = SchemaModel({
  username: StringType().isRequired('用户名不能为空'),
  email: StringType().isEmail('请输入正确的邮箱'),
  age: NumberType('年龄应该是一个数字').range(18, 30, '年龄应该在 18 到 30 岁之间')
});

const checkResult = model.check({
  username: 'foobar',
  email: 'foo@bar.com',
  age: 40
});

console.log(checkResult);

checkResultСтруктура возврата:

{
    username: { hasError: false },
    email: { hasError: false },
    age: { hasError: true, errorMessage: '年龄应该在 18 到 30 岁之间' }
}

многофакторная аутентификация

StringType()
  .minLength(6, '不能少于 6 个字符')
  .maxLength(30, '不能大于 30 个字符')
  .isRequired('该字段不能为空');

пользовательская проверка

пройти черезaddRuleФункция настраивает правило.

Если вы проверяете данные строкового типа, вы можете передатьpatternМетод задает регулярное выражение для пользовательской проверки.

const model = SchemaModel({
  field1: StringType().addRule((value, data) => {
    return /^[1-9][0-9]{3}\s?[a-zA-Z]{2}$/.test(value);
  }, '请输入合法字符'),
  field2: StringType().pattern(/^[1-9][0-9]{3}\s?[a-zA-Z]{2}$/, '请输入合法字符')
});

model.check({ field1: '', field2: '' });

/**
{
  field1: {
    hasError: true,
    errorMessage: '请输入合法字符'
  },
  field2: {
    hasError: true,
    errorMessage: '请输入合法字符'
  }
};
**/

Пользовательская проверка — перекрестная проверка нескольких полей

Например, чтобы убедиться, что пароль, введенный дважды, один и тот же

const model = SchemaModel({
  password1: StringType().isRequired('该字段不能为空'),
  password2: StringType().addRule((value, data) => {
    if (value !== data.password1) {
      return false;
    }
    return true;
  }, '两次密码不一致')
});

model.check({ password1: '123456', password2: 'root' });

/**
{
  password1: { hasError: false },
  password2: {
    hasError: true,
    errorMessage: '两次密码不一致'
  }
};
**/

вложенные объекты

Для сложного вложенного Object вы можете использовать метод ObjectType().shape для определения, например:

const model = SchemaModel({
  id: NumberType().isRequired('该字段不能为空'),
  name: StringType().isRequired('用户名不能为空'),
  info: ObjectType().shape({
    email: StringType().isEmail('应该是一个 email'),
    age: numberType().min(18, '年龄应该大于18岁')
  });
});

Кроме того, рекомендуется сгладить конструкцию объекта.

import { flaser } from 'object-flaser';

const model = SchemaModel({
  id: NumberType().isRequired('该字段不能为空'),
  name: StringType().isRequired('用户名不能为空'),
  'info.email': StringType().isEmail('应该是一个 email'),
  'info.age': numberType().min(18, '年龄应该大于18岁')
});

const user = flaser({
  id: 1,
  name: 'schema-type',
  info: {
    email: 'schema-type@gmail.com',
    age: 17
  }
});

model.check(data);

комбинация

SchemaModelпредоставляет статический методcombine, можно использовать для несколькихSchemaModelслияние возвращает новыйSchemaModel.

const model1 = SchemaModel({
  username: StringType().isRequired('用户名不能为空'),
  email: StringType().isEmail('请输入正确的邮箱')
});

const model2 = SchemaModel({
  username: StringType().minLength(7, '最少7个字符'),
  age: NumberType().range(18, 30, '年应该在 18 到 30 岁')
});

const model3 = SchemaModel({
  groupId: NumberType().isRequired('该字段不能为空')
});

const model4 = SchemaModel.combine(model1, model2, model3);

model4.check({
  username: 'foobar',
  email: 'foo@bar.com',
  age: 40,
  groupId: 1
});

API

  • SchemaModel
  • StringType
  • NumberType
  • ArrayType
  • DateType
  • ObjectType
  • BooleanType

SchemaModel

  • check(data: Object)
const model = SchemaModel({
  username: StringType().isRequired('该字段不能为空'),
  email: StringType().isEmail('请输入正确的邮箱')
});

model.check({
  username: 'root',
  email: 'root@email.com'
});
  • checkForField(fieldName: string, fieldValue: any, data: Object)
const model = SchemaModel({
  username: StringType().isRequired('该字段不能为空'),
  email: StringType().isEmail('请输入正确的邮箱')
});

model.checkForField('username', 'root');

StringType

  • isRequired(errorMessage: string)
StringType().isRequired('该字段不能为空');
  • isEmail(errorMessage: string)
StringType().isEmail('请输入正确的邮箱地址');
  • isURL(errorMessage: string)
StringType().isURL('请输入正确的URL地址');
  • isOneOf(items: Array, errorMessage: string)
StringType().isOneOf(['Javascript', 'CSS'], '只能输入 `Javascript`和 `CSS`');
  • containsLetter(errorMessage: string)
StringType().containsLetter('必须包含英文字符');
  • containsUppercaseLetter(errorMessage: string)
StringType().containsUppercaseLetter('必须包含大写的英文字符');
  • containsLowercaseLetter(errorMessage: string)
StringType().containsLowercaseLetter('必须包含小写的英文字符');
  • containsLetterOnly(errorMessage: string)
StringType().containsLetterOnly('只能包含的英文字符');
  • containsNumber(errorMessage: string)
StringType().containsNumber('必须包含数字');
  • pattern(regExp: RegExp, errorMessage: string)
StringType().pattern(/^[1-9][0-9]{3}\s?[a-zA-Z]{2}$/, '请输入合法字符');
  • rangeLength(minLength: number, maxLength: number, errorMessage: string)
StringType().rangeLength(6, 30, '字符个数只能在 6 - 30 之间');
  • minLength(minLength: number, errorMessage: string)
StringType().minLength(6, '最小需要6个字符');
  • maxLength(maxLength: number, errorMessage: string)
StringType().minLength(30, '最大只能30个字符');
  • addRule(onValid: Function, errorMessage: string)
StringType().addRule((value, data) => {
  return /^[1-9][0-9]{3}\s?[a-zA-Z]{2}$/.test(value);
}, '请输入合法字符');

NumberType

  • isRequired(errorMessage: string)
NumberType().isRequired('该字段必填');
  • isInteger(errorMessage: string)
NumberType().isInteger('只能是整型');
  • isOneOf(items: Array, errorMessage: string)
NumberType().isOneOf([5, 10, 15], '只能是`5`,`10`,`15`');
  • pattern(regExp: RegExp, errorMessage: string)
NumberType().pattern(/^[1-9][0-9]{3}$/, '请输入合法字符');
  • range(minLength: number, maxLength: number, errorMessage: string)
NumberType().range(18, 40, '请输入 18 - 40 之间的数字');
  • min(min: number, errorMessage: string)
NumberType().min(18, '最小值 18');
  • max(max: number, errorMessage: string)
NumberType().max(40, '最大值 40');
  • addRule(onValid: Function, errorMessage: string)
NumberType().addRule((value, data) => {
  return value % 5 === 0;
}, '请输入有效的数字');

ArrayType

  • isRequired(errorMessage: string)
ArrayType().isRequired('该字段必填');
  • rangeLength(minLength: number, maxLength: number, errorMessage: string)
ArrayType().rangeLength(1, 3, '至少选择1个，但不能超过3个');
  • minLength(minLength: number, errorMessage: string)
ArrayType().minLength(1, '至少选择1个');
  • maxLength(maxLength: number, errorMessage: string)
ArrayType().maxLength(3, '不能超过3个');
  • unrepeatable(errorMessage: string)
ArrayType().unrepeatable('不能出现重复选项');
  • of(type: Object, errorMessage: string)
ArrayType().of(StringType().isEmail(), '格式错误');
  • addRule(onValid: Function, errorMessage: string)
ArrayType().addRule((value, data) => {
  return value.length % 2 === 0;
}, '好事成双');

DateType

  • isRequired(errorMessage: string)
DateType().isRequired('日期不能为空');
  • range(min: Date, max: Date, errorMessage: string)
DateType().range(
  new Date('08/01/2017'),
  new Date('08/30/2017'),
  '时间应该在 08/01/2017 - 08/30/2017 之间'
);
  • min(min: Date, errorMessage: string)
DateType().min(new Date('08/01/2017'), '时间的最小值 08/01/2017');
  • max(max: Date, errorMessage: string)
DateType().max(new Date('08/30/2017'), '时间的最大值 08/30/2017');
  • addRule(onValid: Function, errorMessage: string)
DateType().addRule((value, data) => {
  return value.getDay() === 2;
}, '只能选择周二');

ObjectType

  • isRequired(errorMessage: string)
ObjectType().isRequired('该对象不能为空');
  • shape(type: Object)
ObjectType().shape({
  email: StringType().isEmail('应该是一个 email'),
  age: numberType().min(18, '年龄应该大于18岁')
});
  • addRule(onValid: Function, errorMessage: string)
ObjectType().addRule((value, data) => {
  if (value.id || value.email) {
    return true;
  }
  return false;
}, 'id 与 email 必须有一个不能为空');

BooleanType

  • isRequired(errorMessage: string)
BooleanType().isRequired('该字段不能为空');
  • addRule(onValid: Function, errorMessage: string)
ObjectType().addRule((value, data) => {
  if (typeof value === 'undefined' && A === 10) {
    return false;
  }
  return true;
}, '当 A 等于 10 的时候，该值必须为空');
Категории