武装你的WEBAPI-OData与DTO

本文属于OData系列文章

Intro

前面写了很多有关OData使用的文章,很多读者会有疑问,直接将实体对象暴露给最终用户会不会有风险?$expand在默认配置的情况下,数据会不会有泄露风险?

答案是肯定的,由于OData的特性,提供给我们便捷同时也会带来一些风险。很多地方推荐使用DTO模式来隔离实体类与最终用户使用到类的关系,从而解决以上两个问题,OData同样也适用。

DTO

DTO代表Data Transfer Object,是一种设计模式,用于在不同层之间传输数据。它通常用于将数据从一个应用程序的逻辑层传输到另一个应用程序的界面层或持久化层,以及在分布式系统中传输数据。

DTO对象是纯数据对象,它包含要从一个应用程序传输到另一个应用程序的数据。它不包含业务逻辑或数据访问代码,因此它们不能直接与数据库交互或执行任何操作,而只是简单地保存数据。

DTO对象通常由开发人员创建,并且可以根据需要进行扩展。它们可以包含各种属性和方法,以提供使用方便和更好的可读性。使用DTO对象可以降低耦合度,使不同层之间的数据传输更加简单和安全。

AutoMapper

我们需要将实体对象与DTO进行转换,对于需要转换数量不是很多的情况,直接编写一个转换函数就方便了。

    public static class DeviceDataExtension
    {
        public static DeviceDataDto ToDeviceDataDto(this Datum deviceData)
        {
            if (deviceData == null) return null;
            DeviceDataDto deviceDataDto = new()
            {
                DataArray = deviceData.DataArray,
                DeviceId = deviceData.DeviceId,
                Timestamp = deviceData.Timestamp,
                Id = Guid.NewGuid().ToString()
            };
            return deviceDataDto;
        }
    }

但是如果需要映射的属性很多,或者有很多对象的情况,建议使用对象映射工具:AutoMapper。基础用法不详细说了,讲讲对OData的支持。

首先安装对OData支持的包,由于我使用默认的DI,还需要安装DI支持的包:

Install-Package AutoMapper.Extensions.Microsoft.DependencyInjection
Install-Package AutoMapper.AspNetCore.OData.EFCore

然后有三个要求:

  • 一定要对对象声明显示展开(explicit expansion)。
  • 调用IMapper的GetAsync()或者GetQueryAsync()方法。
  • 不能在Controller或者方法上使用[EnableQuery]特性:这个我熟,因为GetQueryAsync()函数需要利用ODataQueryOptions参数,如果同时使用[EnableQuery]会导致对结果再进行一次筛选,导致返回数据错误。

代码:

            services.AddAutoMapper(option =>
            {
                option.CreateMap<Datum, DeviceDataDto>()
                .ForMember(dest => dest.Id, opt => opt.MapFrom(src => Guid.NewGuid().ToString()))
                .ForPath(dest => dest.DataArray, opt => opt.MapFrom(src => src.DataArray))
                .ForAllMembers(w => w.ExplicitExpansion());
            });

        public DeviceDatasController(IMapper mapper)
        {
            _mapper = mapper;
        }
        
        [HttpGet]
        [ProducesResponseType(typeof(IEnumerable<DeviceDataDto>), Status200OK)]
        public async Task<IActionResult> GetAsync(string key, ODataQueryOptions<DeviceDataDto> options)
        {
            var insp = await _context.DeviceData.Where(w => w.DeviceId == key).GetQueryAsync(_mapper, options);
            return Ok(insp);
        }

这样,我们就可以正常使用 OData,同时也享受了的 DTO 的好处,即可以对 DeviceDataDto 使用的 OData 查询。使用的时候要注意,如果有导航属性,导航属性也需要配置映射。

参考资料

原文链接:https://www.cnblogs.com/podolski/archive/2023/05/08/17380728.html

本站文章如无特殊说明,均为本站原创,如若转载,请注明出处:武装你的WEBAPI-OData与DTO - Python技术站

(0)
上一篇 2023年5月8日
下一篇 2023年5月8日

相关文章

  • 详解C#编程中异常的创建和引发以及异常处理

    详解C#编程中异常的创建和引发以及异常处理 在C#编程中,异常是一种表示在程序执行过程中出现的错误或异常情况的机制。当程序执行期间发生异常时,通常需要采取一些措施来处理这些异常,以避免程序崩溃或产生意外的结果。本文将详细讲解C#编程中异常的创建和引发以及异常处理的完整攻略。 异常的创建和引发 要创建和引发异常,需要执行以下几个步骤: 声明并定义异常类。异常类…

    C# 2023年5月15日
    00
  • jQuery使用$.ajax进行即时验证实例详解

    让我来详细讲解“jQuery使用$.ajax进行即时验证实例详解”。 标题 首先,我们需要了解一下什么是jQuery以及$.ajax。jQuery是一个快速且简洁的JavaScript库,它简化了HTML文档遍历、事件处理、动画等操作。而$.ajax是jQuery中一个重要的函数,用来进行异步请求,可以实现无需刷新页面即可获取/修改数据。 具体步骤 在实现即…

    C# 2023年6月8日
    00
  • C#流程控制详解

    C#流程控制详解 前言 C#中的流程控制结构对于程序设计师是非常重要的,它可以控制代码的执行次序和执行条件,使得程序可以更好的实现我们所期望的功能。本文将讲解C#中常见的流程控制结构,包括分支语句和循环语句,并对每种结构进行详细解释和举例。 分支语句 if语句 if语句是一种最基本的分支语句,用于判断某个条件是否成立,如果条件成立执行一定的代码块,如果条件不…

    C# 2023年5月14日
    00
  • C# 多线程更新界面的错误的解决方法

    好的。首先,让我们来深入了解一下为什么在多线程环境下,更新界面会引起错误。 为什么会出现多线程更新界面的错误 在C#中,UI线程是单线程的,也就是说,任何对UI的更新必须在UI线程中进行。但是,在多线程环境下,如果我们想要更新UI,就必须把更新操作发送到UI线程中去执行。否则,就会出现跨线程访问UI控件的错误。 常见的出现这种错误的场景是:我们在后台线程中执…

    C# 2023年5月15日
    00
  • 百万行WPF项目代码重构记录分析

    下面是关于“百万行WPF项目代码重构记录分析”的完整攻略,包含两个示例。 1. 为什么需要重构 在软件开发过程中,随着项目的不断迭代和扩展,代码会变得越来越复杂和难以维护。这时候就需要进行代码重构,以提高代码的可读性、可维护性和可扩展性。在WPF项目中,代码重构尤为重要,因为WPF项目通常包含大量的XAML代码和复杂的UI逻辑。 2. 代码重构的步骤 代码重…

    C# 2023年5月15日
    00
  • C#在winform中实现数据增删改查等功能

    让我来为你讲解“C#在Winform中实现数据增删改查等功能”的完整攻略及两个示例。 一、引言: Winform 是操作系统 Windows 操作界面的一种扩展————当开发人员需要创建 Windows 应用程序,它是基于 .NET 平台构建的,扮演着桥梁的角色。使用 C# 在 Winform 中实现数据增删改查等功能,我们可以通过 Visual Studi…

    C# 2023年6月1日
    00
  • C#中间语言及ILDASM工具用法

    C#编译器会将C#源代码编译成一个叫做CIL(Common Intermediate Language,公用中间语言)的中间语言,这个中间语言是基于栈的虚拟机语言。CIL是一种基于栈的虚拟机语言,每个CIL指令都会入栈一个或多个值,并且返回结果也会通过栈来返回。 ILDASM是一个IL(Intermediate Language,中间语言)反汇编器,允许用户…

    C# 2023年6月3日
    00
  • 在Winform分页控件中集成保存用户列表显示字段及宽度调整设置

    在Winform的分页控件里面,我们提供了很多丰富的功能,如常规分页,中文转义、导出Excel、导出PDF等,基于DevExpress的样式的分页控件,我们在其上面做了不少封装,以便更好的使用,其中就包括集成保存用户列表显示字段及宽度调整设置。本篇随笔介绍这个实现的过程,通过在当前程序中序列化方式存储一个记录用户设置的文件,提供介质的存储和加载处理。 1、集…

    C# 2023年5月11日
    00
合作推广
合作推广
分享本页
返回顶部