如何正确使用Formik的setError方法？（React库）

Question

我正在使用React与后端进行通信。现在正在尝试正确地实现Formik（表单库）。

主要问题： 如何正确使用Formik的setError方法？

客户端验证错误已经正确显示，但现在我正在尝试设置/显示后端验证错误，这些错误是通过状态码400返回的响应中返回的。

链接到我正在尝试使用的方法的文档

我在以下代码中的名为handle400Error的方法中使用了这种方法。

我的React（和Formik）代码：

import React, { Component } from "react";
import axios from "axios";
import { Formik } from "formik";
import * as Yup from "yup";
import styled from "styled-components";
import FormError from "../formError";

const Label = styled.label``;

class LoginForm extends Component {
  initialValues = {
    password: "",
    username: ""
  };

  getErrorsFromValidationError = validationError => {
    const FIRST_ERROR = 0;
    return validationError.inner.reduce((errors, error) => {
      return {
        ...errors,
        [error.path]: error.errors[FIRST_ERROR]
      };
    }, {});
  };

  getValidationSchema = values => {
    return Yup.object().shape({
      password: Yup.string()
        .min(6, "Password must be at least 6 characters long")
        .required("Password is required!"),
      username: Yup.string()
        .min(5, "Username must be at least 5 characters long")
        .max(40, "Username can not be longer than 40 characters")
        .required("Username is required")
    });
  };

  handleSubmit = async (values, { setErrors }) => {
    console.log("handleSubmit");

    try {
      const response = await axios.post(
        "http://127.0.0.1:8000/rest-auth/login/",
        values
      );
      const loginToken = response.data["key"];
      this.handleLoginSuccess(loginToken);
    } catch (exception) {
      // Expected: 400 status code
      if (exception.response && exception.response.status === 400) {
        // Display server validation errors
        this.handle400Error(exception.response.data, setErrors);
      }
      console.log("exception", exception);
      console.log("exception.response", exception.response);
    }
  };

  handle400Error = (backendErrors, setErrors) => {
    let errors = {};
    for (let key in backendErrors) {
      errors[key] = backendErrors[key][0]; // for now only take the first error of the array
    }
    console.log("errors object", errors);
    setErrors({ errors });
  };

  handleUnexpectedError = () => {};

  handleLoginSuccess = loginToken => {
    console.log("handleLoginSuccess");
    this.props.setGreeneryAppState({
      loginToken: loginToken
    });
    this.props.history.replace(`/${this.props.locale}/`);
  };

  validate = values => {
    const validationSchema = this.getValidationSchema(values);
    try {
      validationSchema.validateSync(values, { abortEarly: false });
      return {};
    } catch (error) {
      return this.getErrorsFromValidationError(error);
    }
  };

  render() {
    return (
      <React.Fragment>
        <h1>Login</h1>
        <Formik
          initialValues={this.initialValues}
          validate={this.validate}
          validationSchema={this.validationSchema}
          onSubmit={this.handleSubmit}
          render={({
            errors,
            touched,
            values,
            handleBlur,
            handleChange,
            handleSubmit
          }) => (
            <form onSubmit={handleSubmit}>
              {errors.non_field_errors && (
                <formError>{errors.non_field_errors}</formError>
              )}
              <Label>Username</Label>
              <input
                onChange={handleChange}
                onBlur={handleBlur}
                value={values.username}
                type="text"
                name="username"
                placeholder="Enter username"
              />
              {touched.username &&
                errors.username && <FormError>{errors.username}</FormError>}
              <Label>Password</Label>
              <input
                onChange={handleChange}
                onBlur={handleBlur}
                value={values.password}
                type="password"
                name="password"
                placeholder="Enter password"
              />
              {touched.password &&
                errors.password && <FormError>{errors.password}</FormError>}
              <button type="submit">Log in</button>
            </form>
          )}
        />
      </React.Fragment>
    );
  }

- Rik Schoonbeek

Answer 1

Formik的作者在此...

setError 在v0.8.0中被弃用并更改为setStatus。您可以在handleSubmit函数中使用setErrors(errors)或setStatus(whateverYouWant)来获得所需的行为，如下所示：

handleSubmit = async (values, { setErrors, resetForm }) => {
   try {
     // attempt API call
   } catch(e) {
     setErrors(transformMyApiErrors(e))
     // or setStatus(transformMyApiErrors(e))
   }
}

使用 setStatus 和 setErrors 有什么区别？

如果您使用 setErrors，则您的错误将被 Formik 的下一个 validate 或 validationSchema 调用清除，这可以由用户输入（更改事件）或取消输入框的焦点（模糊事件）触发。注意：这假定您尚未手动设置 validateOnChange 和 validateOnBlur 属性为 false（它们默认为 true）。

在我看来，实际上在此处使用 setStatus 是更理想的，因为它会将错误消息放置在 Formik 状态的单独部分。然后，您可以决定何时向最终用户显示此消息。

// status can be whatever you want
{!!status && <FormError>{status}</FormError>}
// or mix it up, maybe transform status to mimic errors shape and then ...
{touched.email && (!!errors.email && <FormError>{errors.email}</FormError>) || (!!status && <FormError>{status.email}</FormError>) }

请注意，status 的存在或值不会影响阻止下一次表单提交。 只有在验证失败时，Formik 才会中止提交过程。

- jaredpalmer

---

“setErrors”方法是否仍然被弃用并将在未来某个版本中被删除？在我的使用情况下，直接修改错误对象（而不将其存储在“status”中）就足够了。使用“setErrors”是否安全？ - Dani Vijay

如果我正在使用redux，而我的handleSubmit是同步的，那么我该如何使用setStatus？ API调用在saga中执行，如果出现错误，我会使用错误更新状态。我需要在useEffect中调用setStatus吗？ - canecse

@jaredpalmer 当使用 setErrors 时，当其他字段被编辑时，所有其他错误消息都会被清除（用例：当您必须显示后端错误时）。 - Shamseer Ahammed

Answer 2

const formik = useFormik({
    initialValues:{
        email:"",password:"",username:""
    },
    validationSchema:validation_schema,
    onSubmit:(values) => {
        const {email,password,username} = values
        // ......
    }
});


formik.setErrors({email:"Is already taken"}) // error message for email field

- Youssef El-Shabasy

---

欢迎来到 StackOverflow！请查看 如何撰写优秀的答案，除了代码之外还包括必要的细节以回答问题。谢谢！ - Parzival

Answer 3

我刚刚解决了自己的问题。

我需要使用：

setErrors( errors )

代替：

setErrors({ errors })

- Rik Schoonbeek

---

你的代码块对于那些在 Formik 中寻找 setError 实现（包括后端和前端错误）的人来说是一个很好的帮助。 - Akhil Gautam

Answer 4

这就是你要找的内容

。

setErrors({ username: 'This is a dummy procedure error' });

- wavefly

Answer 5

另一种处理这种情况的方法是为您的api错误分配一个特定的键，并使用setStatus来设置状态消息。

__handleSubmit = (values, {setStatus, setErrors}) => {
  return this.props.onSubmit(values)
    .then(() => {
      setStatus("User was updated successfully.");
    })
    .catch((err) => {
      setErrors({api: _.get(err, ["message"])});
    });
}

然后，任何验证错误都将出现在字段旁边，任何API错误都可以出现在底部：

<Formik
  validationSchema={LoginSchema}
  initialValues={{login: ""}}
  onSubmit={this.__handleSubmit}
>
  {({isSubmitting, status, errors, values, setFieldValue}) => (
    <Form className={classNames("form")}>
      <FormGroup>
        <InputGroup>
          <InputGroup.Text>
            <FontAwesomeIcon icon={faUser} fixedWidth />
          </InputGroup.Text>
          <Field
            name="login"
            type={"text"}
            placeholder="Login"
            className="form-control"
          />
        </InputGroup>
        <ErrorMessage name="login" />
      </FormGroup>
      <Button type="submit" variant="primary" disabled={isSubmitting}>
        Submit
      </Button>
      {errors && _.has(errors, ["api"]) && <div className="text-danger">{_.get(errors, ["api"])}</div>}
      {status && <div className="text-success">{status}</div>}
    </Form>
  )}
</Formik>

不要忘记模式...

const LoginSchema = Yup.object().shape({
  login: Yup.string()
    .min(4, 'Too Short!')
    .max(70, 'Too Long!')
    .required('Login is required'),
});

api错误信息将一直显示，直到Formik进行下一次验证（即用户正在修复某些内容）。但status消息将保留，直到您使用定时器或Fade清除它。

- redheadedstep

Answer 6

<Formik
  validationSchema={schema}
  initialValues={{ email: '', pswrd: '' }}
  onSubmit={(values, actions) => {
    // initialise error status <---- 1
    actions.setStatus(undefined); 

    setTimeout(() => {

      // setting error status <---- 2
      actions.setStatus({
        email: 'This is email already exists.',
        pswrd: 'This is password is incorrect',
      });

    }, 500);
  }}
  // destructuring status <---- 3
  render={({ handleSubmit, handleChange, handleBlur, values, errors, status }) => (
    <form onSubmit={handleSubmit}>
      <input
        type="text"
        name="email"
        value={values['email']}
        onChange={handleChange}
        onBlur={handleBlur}
      />
      <input
        type="text"
        name="pswrd"
        value={values['pswrd']}
        onChange={handleChange}
        onBlur={handleBlur}
      />
      <button type="submit">Submit</button>

      // using error status <---- 4
      {status && status.email ? (
        <div>API Error: {status.email}</div>
      ) : (
        errors.email && <div>Validation Error: {errors.email}</div>
      )}

      {status && status.pswrd ? (
        <div>API Error: {status.pswrd}</div>
      ) : (
        errors.pswrd && <div>Validation Error: {errors.pswrd}</div>
      )}
    </form>
  )}
/>

- Harshal

---

正确答案 - Jimmy Kane