無效參數-詳解

一、常見錯誤

輸入參數錯誤經常會在程序開發中遇到。這種錯誤主要的表現就是用戶傳入的參數不符合方法或函數所要求的參數類型和數量。在這種情況下，程序開發者需要提供及時明確的錯誤信息，並且告訴用戶如何才能輸入正確的參數。

public void SomeMethod(string arg1, int arg2){
    if(string.IsNullOrEmpty(arg1)){
        throw new ArgumentException("參數必須有值", "arg1");
    }

    if(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  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();
    }
}