消灭代码中的 if :请求参数校验的优雅之道

开发
传统的参数校验方法往往充斥着大量的if语句,如何干掉这些烦人的if语句,让参数校验变得更加优雅呢?下面,我们将通过C#的例子来探讨这个问题。

在软件开发中,参数校验是一个非常重要的环节。它不仅能确保数据的完整性和准确性,还能在一定程度上防止潜在的安全风险。然而,传统的参数校验方法往往充斥着大量的if语句,这不仅让代码变得冗长且难以维护,还降低了代码的可读性和优雅性。

那么,如何干掉这些烦人的if语句,让参数校验变得更加优雅呢?下面,我们将通过C#的例子来探讨这个问题。

使用特性(Attributes)进行校验

C# 提供了丰富的特性(Attributes)机制,我们可以利用这一机制来进行参数校验。通过定义自定义的特性,并将这些特性应用于方法的参数上,我们可以在运行时自动进行参数校验,从而避免了大量的if语句。

下面是一个简单的例子,展示如何使用自定义特性进行参数校验:

using System;
using System.Reflection;

// 定义一个自定义的校验特性
[AttributeUsage(AttributeTargets.Parameter, AllowMultiple = false)]
public class NotNullAttribute : Attribute
{
    // 可以在这里添加一些自定义的逻辑
}

public class Validator
{
    public static void ValidateParameters(MethodInfo method, object[] parameters)
    {
        ParameterInfo[] paramInfos = method.GetParameters();
        for (int i = 0; i < paramInfos.Length; i++)
        {
            object param = parameters[i];
            NotNullAttribute attr = paramInfos[i].GetCustomAttribute<NotNullAttribute>();
            if (attr != null && param == null)
            {
                throw new ArgumentNullException(paramInfos[i].Name);
            }
            // 可以根据需要添加更多的校验逻辑
        }
    }
}

public class ExampleService
{
    public void ExampleMethod([NotNull] string param1, int param2)
    {
        // 方法体
    }
}

public class Program
{
    public static void Main(string[] args)
    {
        ExampleService service = new ExampleService();
        MethodInfo method = typeof(ExampleService).GetMethod("ExampleMethod");
        object[] parameters = new object[] { null, 123 }; // 这里故意传入一个null值以触发校验失败
        Validator.ValidateParameters(method, parameters); // 这行会抛出ArgumentNullException异常,因为param1为null且被标记为[NotNull]
        // 如果校验通过,则继续执行方法体
        // method.Invoke(service, parameters); // 实际使用时,在校验通过后再调用方法
    }
}

在这个例子中,我们定义了一个NotNullAttribute特性,并将其应用于ExampleMethod方法的param1参数上。然后,我们创建了一个Validator类,该类具有一个静态方法ValidateParameters,该方法接受一个MethodInfo对象和一个参数数组,并对参数进行校验。如果某个参数被标记为NotNull但值为null,则该方法会抛出一个ArgumentNullException异常。

使用FluentValidation库

除了使用自定义特性外,我们还可以利用现有的校验库来简化参数校验。FluentValidation是一个流行的.NET校验库,它提供了丰富的校验规则和友好的API。

下面是一个使用FluentValidation进行参数校验的例子:

首先,安装FluentValidation NuGet包:

Install-Package FluentValidation

然后,创建一个校验器类:

using FluentValidation;

public class ExampleValidator : AbstractValidator<ExampleRequest>
{
    public ExampleValidator()
    {
        RuleFor(x => x.Param1).NotNull().WithMessage("Param1 cannot be null");
        RuleFor(x => x.Param2).GreaterThan(0).WithMessage("Param2 must be greater than 0");
        // 可以根据需要添加更多的校验规则
    }
}

public class ExampleRequest
{
    public string Param1 { get; set; }
    public int Param2 { get; set; }
}

在业务逻辑中使用校验器:

public class ExampleService
{
    private readonly ExampleValidator _validator;
    
    public ExampleService()
    {
        _validator = new ExampleValidator();
    }
    
    public void ExampleMethod(ExampleRequest request)
    {
        ValidationResult result = _validator.Validate(request);
        if (!result.IsValid)
        {
            throw new ValidationException(result.Errors); // 这里可以自定义异常处理逻辑
        }
        // 如果校验通过,则继续执行方法体
    }
}

在这个例子中,我们创建了一个ExampleValidator类,该类继承了FluentValidation的AbstractValidator类,并定义了校验规则。然后,在ExampleService类的ExampleMethod方法中,我们使用ExampleValidator对请求参数进行校验。如果校验失败,我们抛出一个自定义的异常。这种方法使代码更加清晰和易于维护,同时避免了大量的if语句。

责任编辑:赵宁宁 来源: 程序员编程日记
相关推荐

2023-08-04 08:52:52

Optional消灭空指针

2023-11-29 07:23:04

参数springboto

2018-07-23 08:19:26

编程语言Python工具

2018-09-18 16:20:08

Asyncjavascript前端

2022-05-03 10:43:43

SpringJava

2024-06-21 09:19:45

代码接口重复请求开发

2021-11-10 10:03:18

SpringBootJava代码

2019-10-11 09:07:46

Java代码对象

2022-04-21 09:59:53

Nest参数校验

2023-03-28 08:07:12

2022-11-10 07:53:54

Spring参数校验

2021-08-12 10:32:50

Spring Boot参数校验分组校验

2024-02-07 01:47:47

atexit模块程序

2021-08-10 15:11:27

Spring Boot参数校验

2019-01-27 14:37:47

数据HTTP服务

2014-02-28 13:46:35

Angular代码

2024-06-24 14:19:48

2024-09-29 09:58:57

2024-09-20 08:14:16

2021-06-17 09:32:39

重复请求并发请求Java
点赞
收藏

51CTO技术栈公众号