ASP.NET MVC - Как сохранить ошибки ModelState в RedirectToAction?
-
09-10-2019 - |
Вопрос
У меня есть следующие два метода действия (упрощенные для вопроса):
[HttpGet]
public ActionResult Create(string uniqueUri)
{
// get some stuff based on uniqueuri, set in ViewData.
return View();
}
[HttpPost]
public ActionResult Create(Review review)
{
// validate review
if (validatedOk)
{
return RedirectToAction("Details", new { postId = review.PostId});
}
else
{
ModelState.AddModelError("ReviewErrors", "some error occured");
return RedirectToAction("Create", new { uniqueUri = Request.RequestContext.RouteData.Values["uniqueUri"]});
}
}
Итак, если проверка проходит успешно, я перенаправляю на другую страницу (подтверждение).
Если возникает ошибка, мне нужно отобразить ту же страницу с ошибкой.
Если я это сделаю return View()
, отображается сообщение об ошибке, но если я сделаю return RedirectToAction
(как указано выше), он теряет ошибки модели.
Я не удивлен этой проблемой, просто интересно, как вы, ребята, справляетесь с этим?
Я мог бы, конечно, просто вернуть то же представление вместо перенаправления, но у меня есть логика в методе "Create", который заполняет данные представления, которые мне пришлось бы дублировать.
Есть какие-нибудь предложения?
Решение
Вам нужно иметь тот же экземпляр Review
на ваше HttpGet
действие. Сделать это, вы должны сохранить объект Review review
в TEMP переменной на вашем HttpPost
действие, а затем восстановить его на HttpGet
действие.
[HttpGet]
public ActionResult Create(string uniqueUri)
{
//Restore
Review review = TempData["Review"] as Review;
// get some stuff based on uniqueuri, set in ViewData.
return View(review);
}
[HttpPost]
public ActionResult Create(Review review)
{
//Save your object
TempData["Review"] = review;
// validate review
if (validatedOk)
{
return RedirectToAction("Details", new { postId = review.PostId});
}
else
{
ModelState.AddModelError("ReviewErrors", "some error occured");
return RedirectToAction("Create", new { uniqueUri = Request.RequestContext.RouteData.Values["uniqueUri"]});
}
}
Если вы хотите, чтобы это работать, даже если браузер обновляется после первого выполнения HttpGet
Действие, вы могли бы сделать это:
Review review = TempData["Review"] as Review;
TempData["Review"] = review;
В противном случае на кнопке обновления объекта review
будет пустым, потому что не будут никаких данных в TempData["Review"]
.
Другие советы
Я должен был решить эту проблему сегодня сам и наступил на этот вопрос.
Некоторые из ответов полезны (используя tempdata), но на самом деле не отвечают на вопрос под рукой.
Лучший совет, который я нашел, был в этом блоге:
http://www.jefclaes.be/2012/06/persisting-model-state-when-using-prg.html.
По сути, используйте Tempdata для сохранения и восстановления объекта ModelState. Тем не менее, это намного чище, если вы абстранируете это в атрибуты.
Например
public class SetTempDataModelStateAttribute : ActionFilterAttribute
{
public override void OnActionExecuted(ActionExecutedContext filterContext)
{
base.OnActionExecuted(filterContext);
filterContext.Controller.TempData["ModelState"] =
filterContext.Controller.ViewData.ModelState;
}
}
public class RestoreModelStateFromTempDataAttribute : ActionFilterAttribute
{
public override void OnActionExecuting(ActionExecutingContext filterContext)
{
base.OnActionExecuting(filterContext);
if (filterContext.Controller.TempData.ContainsKey("ModelState"))
{
filterContext.Controller.ViewData.ModelState.Merge(
(ModelStateDictionary)filterContext.Controller.TempData["ModelState"]);
}
}
}
Затем, согласно вашему примеру, вы можете сохранить / восстанавливать модель ModelState так:
[HttpGet]
[RestoreModelStateFromTempData]
public ActionResult Create(string uniqueUri)
{
// get some stuff based on uniqueuri, set in ViewData.
return View();
}
[HttpPost]
[SetTempDataModelState]
public ActionResult Create(Review review)
{
// validate review
if (validatedOk)
{
return RedirectToAction("Details", new { postId = review.PostId});
}
else
{
ModelState.AddModelError("ReviewErrors", "some error occured");
return RedirectToAction("Create", new { uniqueUri = Request.RequestContext.RouteData.Values["uniqueUri"]});
}
}
Если вы также хотите передать модель вместе в Tempdata (как предложил BIGB), тогда вы все равно можете сделать это тоже.
Почему бы не создать закрытую функцию с логикой в методе "Create" и не вызвать этот метод как из метода Get, так и из метода Post и просто не вернуть View().
Я мог бы использовать TempData["Errors"]
Tempdata передаются Accross Действия, сохраняющие данные 1 раз.
Я предлагаю вам вернуть представление и избежать дублирования через атрибут на действии. Вот пример заполнения для просмотра данных. Вы можете сделать что-то похожее с вашим методом создания логики.
public class GetStuffBasedOnUniqueUriAttribute : ActionFilterAttribute
{
public override void OnActionExecuting(ActionExecutingContext filterContext)
{
var filter = new GetStuffBasedOnUniqueUriFilter();
filter.OnActionExecuting(filterContext);
}
}
public class GetStuffBasedOnUniqueUriFilter : IActionFilter
{
#region IActionFilter Members
public void OnActionExecuted(ActionExecutedContext filterContext)
{
}
public void OnActionExecuting(ActionExecutingContext filterContext)
{
filterContext.Controller.ViewData["somekey"] = filterContext.RouteData.Values["uniqueUri"];
}
#endregion
}
Вот пример:
[HttpGet, GetStuffBasedOnUniqueUri]
public ActionResult Create()
{
return View();
}
[HttpPost, GetStuffBasedOnUniqueUri]
public ActionResult Create(Review review)
{
// validate review
if (validatedOk)
{
return RedirectToAction("Details", new { postId = review.PostId });
}
ModelState.AddModelError("ReviewErrors", "some error occured");
return View(review);
}
У меня есть метод, который добавляет моделей состояния в данные TEMP. Затем у меня есть метод в моем базовом контроллере, который проверяет данные TEMP для любых ошибок. Если он имеет их, он добавляет их обратно в ModelState.
Мой сценарий немного сложнее, так как я использую шаблон PRG, поэтому мой ViewModel («SummaryVM») находится в Tempdata, а мой сводный экран отображает его. На этой странице есть небольшая форма, чтобы опубликовать некоторую информацию к другому действию. Осложнение пришло бы от требования для пользователя редактировать некоторые поля в SummaryVM на этой странице.
Summary.chtml имеет сводку валидации, которая будет ловить ошибки ModelState, которые мы создадим.
@Html.ValidationSummary()
Моя форма теперь должна опубликовать действие httpPost для резюме (). У меня есть еще один очень маленький ViewModel для представления отредактированных полей, а ModelBinding помет их мне.
Новая форма:
@using (Html.BeginForm("Summary", "MyController", FormMethod.Post))
{
@Html.Hidden("TelNo") @* // Javascript to update this *@
и действие ...
[HttpPost]
public ActionResult Summary(EditedItemsVM vm)
Здесь я делаю некоторую проверку, и я обнаруживаю какой-то плохой вход, поэтому мне нужно вернуться на страницу сводки с ошибками. Для этого я использую темпдата, которые выдержит перенаправление. Если нет проблем с данными, я заменяю объект SummaryVM с копией (но с помощью редактированных полей изменены курс), затем выполните перенаправить действие («Newimation»);
// Telephone number wasn't in the right format
List<string> listOfErrors = new List<string>();
listOfErrors.Add("Telephone Number was not in the correct format. Value supplied was: " + vm.TelNo);
TempData["SummaryEditedErrors"] = listOfErrors;
return RedirectToAction("Summary");
Действие сводного контроллера, где все это начинается, ищет любые ошибки в Tempdata и добавляет их к ModelState.
[HttpGet]
[OutputCache(Duration = 0)]
public ActionResult Summary()
{
// setup, including retrieval of the viewmodel from TempData...
// And finally if we are coming back to this after a failed attempt to edit some of the fields on the page,
// load the errors stored from TempData.
List<string> editErrors = new List<string>();
object errData = TempData["SummaryEditedErrors"];
if (errData != null)
{
editErrors = (List<string>)errData;
foreach(string err in editErrors)
{
// ValidationSummary() will see these
ModelState.AddModelError("", err);
}
}
Я предпочитаю добавить метод My ViewModel, который заполняет значения по умолчанию:
public class RegisterViewModel
{
public string FirstName { get; set; }
public IList<Gender> Genders { get; set; }
//Some other properties here ....
//...
//...
ViewModelType PopulateDefaultViewData()
{
this.FirstName = "No body";
this.Genders = new List<Gender>()
{
Gender.Male,
Gender.Female
};
//Maybe other assinments here for other properties...
}
}
Тогда я называю это, когда мне понадобится какие-либо исходные данные, такие как это:
[HttpGet]
public async Task<IActionResult> Register()
{
var vm = new RegisterViewModel().PopulateDefaultViewValues();
return View(vm);
}
[HttpPost]
public async Task<IActionResult> Register(RegisterViewModel vm)
{
if (!ModelState.IsValid)
{
return View(vm.PopulateDefaultViewValues());
}
var user = await userService.RegisterAsync(
email: vm.Email,
password: vm.Password,
firstName: vm.FirstName,
lastName: vm.LastName,
gender: vm.Gender,
birthdate: vm.Birthdate);
return Json("Registered successfully!");
}
Microsoft сняла возможность хранения сложных типов данных в Tempdata, поэтому предыдущие ответы больше не работают; Вы можете хранить только простые типы, такие как строки. Я изменил ответ @ Asgo1 для работы, как ожидалось.
public class SetTempDataModelStateAttribute : ActionFilterAttribute
{
public override void OnActionExecuted(ActionExecutedContext filterContext)
{
base.OnActionExecuted(filterContext);
var controller = filterContext.Controller as Controller;
var modelState = controller?.ViewData.ModelState;
if (modelState != null)
{
var listError = modelState.Where(x => x.Value.Errors.Any())
.ToDictionary(m => m.Key, m => m.Value.Errors
.Select(s => s.ErrorMessage)
.FirstOrDefault(s => s != null));
controller.TempData["KEY HERE"] = JsonConvert.SerializeObject(listError);
}
}
public class RestoreModelStateFromTempDataAttribute : ActionFilterAttribute
{
public override void OnActionExecuting(ActionExecutingContext filterContext)
{
base.OnActionExecuting(filterContext);
var controller = filterContext.Controller as Controller;
var tempData = controller?.TempData?.Keys;
if (controller != null && tempData != null)
{
if (tempData.Contains("KEY HERE"))
{
var modelStateString = controller.TempData["KEY HERE"].ToString();
var listError = JsonConvert.DeserializeObject<Dictionary<string, string>>(modelStateString);
var modelState = new ModelStateDictionary();
foreach (var item in listError)
{
modelState.AddModelError(item.Key, item.Value ?? "");
}
controller.ViewData.ModelState.Merge(modelState);
}
}
}
}
}
Отсюда вы можете просто добавить необходимую аннотацию данных в методе контроллера по мере необходимости.
[RestoreModelStateFromTempDataAttribute]
[HttpGet]
public async Task<IActionResult> MethodName()
{
}
[SetTempDataModelStateAttribute]
[HttpPost]
public async Task<IActionResult> MethodName()
{
ModelState.AddModelError("KEY HERE", "ERROR HERE");
}