无效参数-详解

发布时间：2023-05-18

一、常见错误

输入参数错误经常会在程序开发中遇到。这种错误主要的表现就是用户传入的参数不符合方法或函数所要求的参数类型和数量。在这种情况下，程序开发者需要提供及时明确的错误信息，并且告诉用户如何才能输入正确的参数。


public void SomeMethod(string arg1, int arg2){
    if(string.IsNullOrEmpty(arg1)){
        throw new ArgumentException("参数必须有值", "arg1");
    }

    if(arg2 < 0 || arg2 > 10){
        throw new ArgumentOutOfRangeException("参数不在指定范围内", "arg2");
    }

    //正常的方法逻辑
}

上面的代码示例用的是C#语言，展示了如何防止无效参数的方法。在这个例子中，首先检查arg1是不是空或空串，如果是，则抛出异常。下一步检查arg2是否在0到10的有效范围之内，如果不是，则抛出异常。最后，如果没有任何异常，执行正常的程序逻辑。

二、优先规范化验证规则

验证规则是可帮助程序开发者保证应用程序传递给方法和函数的参数是正确的，但是在这之前，他们必须要验证规则是否符合一致性，被正确的执行。在不同的编程语言、不同的框架中，验证规则也存在差异。

始终优先考虑最基本的问题：需要什么参数，这些参数是什么类型。首先在代码中增加反射或其他代码分析工具，识别要求的参数类型。然后，为每一个参数类型开发验证规则。由于在将错误的数据进行验证之前进行一致性验证，因而深思熟虑的开发规范化检查心得首先要进行保证。

三、保证错误信息足够详细且易于理解

当出现无效参数时，用户需要获得足够详细的信息。这是因为如果信息不够详细，用户将可能会无法理解并解决问题。因此，当发生无效参数时，请您提供详细的错误信息和适当的引导，使用户能够快速解决问题。您还应该考虑使用错误页或大型警告来显示错误信息。


public void SomeMethod(string arg1, int arg2){
    if(string.IsNullOrEmpty(arg1)){
        string message = $"参数{arg1}必须有值";
        throw new ArgumentException(message, "arg1");
    }

    if(arg2 < 0 || arg2 > 10){
        string message = $"参数{arg2}不在指定范围内";
        throw new ArgumentOutOfRangeException(message, "arg2");
    }

    //正常的方法逻辑
}

四、使用特性进行验证

许多编程语言支持使用特性来进行参数的验证。例如，在C#中，您可以使用特性，例如RegularExpressionAttribute、RangeAttribute和RequiredAttribute，来确保传入参数的正确性。这样，无效参数会被拒绝，而不会到达应用程序的业务逻辑。


public class SomeRequestModel{
    [Required]
    [RegularExpression("^\\d{2,}$")]
    public string Name {get; set;}

    [Range(18, 60)]
    public int Age {get; set;}
}

public class SomeController : Controller{
    [HttpPost]
    public IActionResult SomeAction([FromBody] SomeRequestModel requestModel){
        if(!ModelState.IsValid){
            return BadRequest(ModelState);
        }

        //正常的业务逻辑
        return Ok();
    }
}
推荐文章