[Volo.Abp升级笔记]使用旧版Api规则替换RESTful Api以兼容老程序

news2024/11/23 21:19:17

Volo.Abp 配置应用层自动生成Controller，增删查改服务（CrudAppService）将会以RESTful Api的方式生成对应的接口
(官方文档)，这与旧版本的Abp区别很大。RESTful固然好，虽然项目里新的Api会逐步使用RESTful Api代替旧的，但在前后端分离的项目中已经定好的接口，往往需要兼容之前的方式。

原理分析

旧版行为

应用层继承于AsyncCrudAppService的类，在Web层调用CreateControllersForAppServices后，Abp框架将以默认的规则实现Controller，具体的规则如下：

  • Get: 如果方法名称以GetList,GetAll或Get开头.
  • Put: 如果方法名称以Put或Update开头.
  • Delete: 如果方法名称以Delete或Remove开头.
  • Post: 如果方法名称以Create,Add,Insert或Post开头.
  • Patch: 如果方法名称以Patch开头.
  • 其他情况, Post 为 默认方式.
  • 自动删除'Async'后缀.

例子：
在这里插入图片描述

新版行为：
将会以RESTful Api的方式生成对应的接口，具体规则如下

服务方法名称HTTP MethodRoute
GetAsync(Guid id)GET/api/app/book/
GetListAsync()GET/api/app/book
CreateAsync(CreateBookDto input)POST/api/app/book
UpdateAsync(Guid id, UpdateBookDto input)PUT/api/app/book/
DeleteAsync(Guid id)DELETE/api/app/book/
GetEditorsAsync(Guid id)GET/api/app/book/{id}/editors
CreateEditorAsync(Guid id, BookEditorCreateDto input)POST/api/app/book/{id}/editor

例子
在这里插入图片描述

开始改造

更换基类型

为了兼容旧版Abp，先来还原增删查改服务（CrudAppService）的方法签名。
注意到

  1. Volo.Abp 中 UpdateAsync方法签名已与旧版不同
  2. 旧版中的GetAllAsync方法，被GetListAsync所取代。

新建一个CrudAppServiceBase类继承 CrudAppService。并重写UpdateAsync和GetListAsync方法。

为了还原旧版的接口，将用private new关键字覆盖掉 UpdateAsync，GetListAsync方法，并重新实现更改和查询列表的功能




public abstract class CrudAppServiceBase<TEntity, TGetOutputDto, TGetListOutputDto, TKey, TGetListInput, TCreateInput, TUpdateInput>
    : CrudAppService<TEntity, TGetOutputDto, TGetListOutputDto, TKey, TGetListInput, TCreateInput, TUpdateInput>
    where TEntity : class, IEntity<TKey>
        where TGetOutputDto : IEntityDto<TKey>
where TGetListOutputDto : IEntityDto<TKey>
{
    protected CrudAppServiceBase(IRepository<TEntity, TKey> repository)
: base(repository)
    {

    }

    private new Task<TGetOutputDto> UpdateAsync(TKey id, TUpdateInput input)
    {
        return base.UpdateAsync(id, input);
    }
    private new Task<PagedResultDto<TGetListOutputDto>> GetListAsync(TGetListInput input)
    {
        return base.GetListAsync(input);
    }

    public virtual async Task<TGetOutputDto> UpdateAsync(TUpdateInput input)
    {
        await CheckUpdatePolicyAsync();
        var entity = await GetEntityByIdAsync((input as IEntityDto<TKey>).Id);
        MapToEntity(input, entity);
        await Repository.UpdateAsync(entity, autoSave: true);
        return await MapToGetOutputDtoAsync(entity);

    }
    public virtual Task<PagedResultDto<TGetListOutputDto>> GetAllAsync(TGetListInput input)
    {
        return this.GetListAsync(input);
    }   

}

基于扩展性考虑，我们可以像官方实现一样做好类型复用

public abstract class CrudAppServiceBase<TEntity, TEntityDto, TKey>
    : CrudAppServiceBase<TEntity, TEntityDto, TKey, PagedAndSortedResultRequestDto>
    where TEntity : class, IEntity<TKey>
    where TEntityDto : IEntityDto<TKey>
{
    protected CrudAppServiceBase(IRepository<TEntity, TKey> repository)
        : base(repository)
    {

    }
}

public abstract class CrudAppServiceBase<TEntity, TEntityDto, TKey, TGetListInput>
    : CrudAppServiceBase<TEntity, TEntityDto, TKey, TGetListInput, TEntityDto>
    where TEntity : class, IEntity<TKey>
    where TEntityDto : IEntityDto<TKey>
{
    protected CrudAppServiceBase(IRepository<TEntity, TKey> repository)
        : base(repository)
    {

    }
}


public abstract class CrudAppServiceBase<TEntity, TEntityDto, TKey, TGetListInput, TCreateInput>
    : CrudAppServiceBase<TEntity, TEntityDto, TKey, TGetListInput, TCreateInput, TCreateInput>
    where TEntity : class, IEntity<TKey>
    where TEntityDto : IEntityDto<TKey>
{
    protected CrudAppServiceBase(IRepository<TEntity, TKey> repository)
        : base(repository)
    {

    }
}

public abstract class CrudAppServiceBase<TEntity, TEntityDto, TKey, TGetListInput, TCreateInput, TUpdateInput>
: CrudAppServiceBase<TEntity, TEntityDto, TEntityDto, TKey, TGetListInput, TCreateInput, TUpdateInput>
where TEntity : class, IEntity<TKey>
where TEntityDto : IEntityDto<TKey>
{
    protected CrudAppServiceBase(IRepository<TEntity, TKey> repository)
        : base(repository)
    {

    }

    protected override Task<TEntityDto> MapToGetListOutputDtoAsync(TEntity entity)
    {
        return MapToGetOutputDtoAsync(entity);
    }

    protected override TEntityDto MapToGetListOutputDto(TEntity entity)
    {
        return MapToGetOutputDto(entity);
    }
}

重写接口

重写增删查改服务接口

public interface IBaseCrudAppService<TGetOutputDto, TGetListOutputDto, in TKey, in TGetListInput, in TCreateInput, in TUpdateInput>

    {
        Task<TGetOutputDto> GetAsync(TKey id);

        Task<PagedResultDto<TGetListOutputDto>> GetAllAsync(TGetListInput input);

        Task<TGetOutputDto> CreateAsync(TCreateInput input);

        Task<TGetOutputDto> UpdateAsync(TUpdateInput input);

        Task DeleteAsync(TKey id);

    }

基于扩展性考虑，我们可以像官方实现一样做好类型复用

public interface IBaseCrudAppService<TEntityDto, in TKey>
    : IBaseCrudAppService<TEntityDto, TKey, PagedAndSortedResultRequestDto>
{

}

public interface IBaseCrudAppService<TEntityDto, in TKey, in TGetListInput>
    : IBaseCrudAppService<TEntityDto, TKey, TGetListInput, TEntityDto>
{

}

public interface IBaseCrudAppService<TEntityDto, in TKey, in TGetListInput, in TCreateInput>
    : IBaseCrudAppService<TEntityDto, TKey, TGetListInput, TCreateInput, TCreateInput>
{

}

public interface IBaseCrudAppService<TEntityDto, in TKey, in TGetListInput, in TCreateInput, in TUpdateInput>
    : IBaseCrudAppService<TEntityDto, TEntityDto, TKey, TGetListInput, TCreateInput, TUpdateInput>
{

}

将应用服务接口IReservationAppService继承于IBaseCrudAppService和IApplicationService

public interface IReservationAppService: IBaseCrudAppService<ReservationDto, long>, IApplicationService
{
    //除增删查改业务的其他业务
}

创建应用服务类ReservationAppService，此时应用服务派生自CrudAppServiceBase，应用服务应该会完全实现接口

public class ReservationAppService : CrudAppServiceBase<Workflow.Reservation.Reservation, ReservationDto, long>, IReservationAppService
{
    ...
}

替换默认规则

Abp封装了Controller自动生成规则，利用了Asp.Net MVC的约定接口IApplicationModelConvention，这一特性，所谓规则即Convention，AbpServiceConvention是此接口的实现类，在此类中约定了如何将应用层程序集增删查改服务（CrudAppService）中的成员方法，按上述规则生成Controller。

规则的具体代码封装在ConventionalRouteBuilder里

既然是默认规则方式，我们就重写一个自定义的Convention来代替它默认的那个。
假设有领域Workflow，在Web层中新建WorkflowServiceConvention，把原AbpServiceConvention类中的所有内容复制到这个类中

public class WorkflowServiceConvention : IAbpServiceConvention, ITransientDependency
{

}

将不需要用到的对象删掉

// 删除 protected IConventionalRouteBuilder ConventionalRouteBuilder { get; }

重写CreateAbpServiceAttributeRouteModel

protected virtual AttributeRouteModel CreateAbpServiceAttributeRouteModel(string rootPath, string controllerName, ActionModel action, string httpMethod, [CanBeNull] ConventionalControllerSetting configuration)
{
    return new AttributeRouteModel(
        new RouteAttribute(
                $"api/services/{rootPath}/{controllerName}/{action.ActionName}"
        )
    );
}

在Web层的Module文件WorkflowHostModule中，添加WorkflowApplicationModule

Configure<AbpAspNetCoreMvcOptions>(options =>
{
    options
        .ConventionalControllers
        .Create(typeof(WorkflowApplicationModule).Assembly);
});

用WorkflowServiceConvention替换原始的AbpServiceConvention实现。

Configure<MvcOptions>(options =>
{
    options.Conventions.RemoveAt(0);
    options.Conventions.Add(convention.Value);
});

在微服务架构中的问题

Asp.Net MVC在微服务的网关层中无法通过仅引用应用层方法的接口，生成Controller，即便改写 ControllerFeatureProvider， 还是需要引用实现类，这些实现类在应用层中。
但网关仅仅依赖定义层，若要拿到实现类，将改变微服务架构的依赖关系。

在官方的微服务实例中，也没有用Controller的自动生成，在这个issue中作者也给出了解答
https://github.com/abpframework/abp/issues/1731
在这里插入图片描述

因此如果想达到目的，只能用重写controller基类的方式了，这个方式好处在于简单好用，可读性和可维护性高，缺陷就是每写一个应用层类，需要写一个对应的Controller类，但在项目不多用CV大法还是可以接受的。

新建WorkflowController并继承于AbpControllerBase，并创建增删查改（Curd）的终结点路由，通过调用ITAppService的方法，实现各业务功能

public abstract class WorkflowController<ITAppService, TGetOutputDto, TGetListOutputDto, TKey, TGetListInput, TCreateInput, TUpdateInput>
    : AbpControllerBase
where ITAppService : IBaseCrudAppService<TGetOutputDto, TGetListOutputDto, TKey, TGetListInput, TCreateInput, TUpdateInput>
        where TGetOutputDto : IEntityDto<TKey>
where TGetListOutputDto : IEntityDto<TKey>
{


    protected WorkflowController()
    {
        LocalizationResource = typeof(WorkflowResource);
    }


    private readonly ITAppService _recipeAppService;

    public WorkflowController(ITAppService recipeAppService)
    {
        _recipeAppService = recipeAppService;
    }

    [HttpPost]
    [Route("Create")]

    public async Task<TGetOutputDto> CreateAsync(TCreateInput input)
    {
        return await _recipeAppService.CreateAsync(input);
    }

    [HttpDelete]
    [Route("Delete")]
    public async Task DeleteAsync(TKey id)
    {
        await _recipeAppService.DeleteAsync(id);
    }

    [HttpGet]
    [Route("GetAll")]
    public async Task<PagedResultDto<TGetListOutputDto>> GetAllAsync(TGetListInput input)
    {
        return await _recipeAppService.GetAllAsync(input);
    }

    [HttpGet]
    [Route("Get")]
    public async Task<TGetOutputDto> GetAsync(TKey id)
    {
        return await _recipeAppService.GetAsync(id);
    }

    [HttpPut]
    [Route("Update")]
    public async Task<TGetOutputDto> UpdateAsync(TUpdateInput input)
    {
        return await _recipeAppService.UpdateAsync(input);
    }
}

基于扩展性考虑，我们可以做好类型复用

public abstract class WorkflowController<ITAppService, TEntityDto, TKey>
      : WorkflowController<ITAppService, TEntityDto, TKey, PagedAndSortedResultRequestDto>
      where ITAppService : IBaseCrudAppService<TEntityDto, TKey>
      where TEntityDto : IEntityDto<TKey>
{
    protected WorkflowController(ITAppService appService)
        : base(appService)
    {

    }
}

public abstract class WorkflowController<ITAppService, TEntityDto, TKey, TGetListInput>
    : WorkflowController<ITAppService, TEntityDto, TKey, TGetListInput, TEntityDto>
    where ITAppService : IBaseCrudAppService<TEntityDto, TKey, TGetListInput>
    where TEntityDto : IEntityDto<TKey>
{
    protected WorkflowController(ITAppService appService)
        : base(appService)
    {

    }
}


public abstract class WorkflowController<ITAppService, TEntityDto, TKey, TGetListInput, TCreateInput>
 : WorkflowController<ITAppService, TEntityDto, TKey, TGetListInput, TCreateInput, TCreateInput>
 where ITAppService : IBaseCrudAppService<TEntityDto, TKey, TGetListInput, TCreateInput>
 where TEntityDto : IEntityDto<TKey>
{
    protected WorkflowController(ITAppService appService)
        : base(appService)
    {

    }
}

public abstract class WorkflowController<ITAppService, TEntityDto, TKey, TGetListInput, TCreateInput, TUpdateInput>
: WorkflowController<ITAppService, TEntityDto, TEntityDto, TKey, TGetListInput, TCreateInput, TUpdateInput>
where ITAppService : IBaseCrudAppService<TEntityDto, TKey, TGetListInput, TCreateInput, TUpdateInput>
where TEntityDto : IEntityDto<TKey>
{
    protected WorkflowController(ITAppService appService)
        : base(appService)
    {

    }

}

创建实际的Controller，定义Area名称和Controller路由“api/Workflow/reservation”

此时Controller派生自WorkflowController，应用服务应该会完全实现接口

[Area(WorkflowRemoteServiceConsts.ModuleName)]
[RemoteService(Name = WorkflowRemoteServiceConsts.RemoteServiceName)]
[Route("api/Workflow/reservation")]
public class ReservationController : WorkflowController<IReservationAppService, ReservationDto,long>, IReservationAppService
{
    private readonly IReservationAppService _reservationAppService;

    public ReservationController(IReservationAppService reservationAppService):base(reservationAppService)
    {
        _reservationAppService = reservationAppService;
    }
}

运行程序，我们将得到一个旧版的接口
在这里插入图片描述

每次为新的应用服务类创建Controller，只需要新建一个派生自WorkflowController类的Controller，并指定一个应用服务类对象。就完成了，不需要自己写一大堆的控制器方法。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/766500.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

JavaScript运算符

JavaScript运算符

减法运算符 在JavaScript中&#xff0c;我们可以使用简单的减法来计算一下你的出生年龄&#xff0c;例如&#xff1a; const zhangSan 2023 - 2000; console.log(zhangSan);● 当然&#xff0c;我们也可以在控制台中&#xff0c;一次性传入多个值&#xff1b; const zhangS…
阅读更多...
测试模型中理解压力测试和负载测试

测试模型中理解压力测试和负载测试

压力测试 对应的性能测试模式就是固定线程&#xff0c;通过使用固定线程的模式对服务进行性能测试&#xff0c;或者使用阶梯型的线程递增模式进行性能测试。 通过控制线程数来进行不同场景的测试。 关注指标&#xff1a;处理能力&#xff08;QPS或者说TPS&#xff09;&#…
阅读更多...
matplotlib绘制点线图

matplotlib绘制点线图

代码&#xff1a; import numpy as np import matplotlib.pyplot as pltX, Y (np.linspace(-3, 3, 100),np.linspace(-3, 3, 100))U, V np.mgrid[-3:3:100j, 0:0:100j]seed_points np.array([[-2, 0, 1], [-2, 0, 1]])fig0, ax0 plt.subplots() strm ax0.streamplot(X, Y…
阅读更多...
阿里云GPU服务器价格表（A100、A10、V100、T4）

阿里云GPU服务器价格表（A100、A10、V100、T4）

阿里云GPU服务器租用费用表包括包年包月、一个小时收费以及学生GPU服务器租用费用&#xff0c;阿里云GPU计算卡包括NVIDIA V100计算卡、T4计算卡、A10计算卡和A100计算卡&#xff0c;GPU云服务器gn6i可享受3折&#xff0c;阿里云百科分享阿里云GPU服务器租用表、GPU一个小时多少…
阅读更多...
Java集合类都有哪些？

Java集合类都有哪些？

Collection 是所有单列集合的父类 Map 是所有双列集合的父类&#xff0c;一次添加一对元素 单列集合 上图中&#xff0c;蓝色是实现类&#xff0c;红色是接口 Collection 下面分为两种单列集合 -- List 、 Set List 集合 List 下又分为三种 -- ArrayList 、 LinkList 、 …
阅读更多...
react的state和useState你了解多少？带你深入react state useState

react的state和useState你了解多少？带你深入react state useState

state和useState是react中很重要的概念&#xff0c;虽然笔者一直在用&#xff0c;但是总感觉有些地方认识不够透彻。于是乎&#xff0c;笔者重新阅读学习了react官方文档&#xff0c;感觉受益匪浅。希望能用尽量通俗简洁的语言把吸收的知识表述清楚&#xff0c;便写下此文。 如…
阅读更多...
二、DDL-3.数据类型

二、DDL-3.数据类型

分为3种&#xff1a;数值类型、字符串类型、日期时间类型。 一、数值类型 【案例】 年龄&#xff1a; age TINYINT UNSIGNED——范围&#xff08;0&#xff0c;255&#xff09;够用 分数&#xff1a;score double(4,1)——分数0-100有小数&#xff0c;4—最高位数&#xff0…
阅读更多...
学习开闭原则的方法：成为编程高手的秘诀

学习开闭原则的方法：成为编程高手的秘诀

成为一名优秀的编程高手&#xff0c;掌握开闭原则是至关重要的。开闭原则是软件设计中的核心概念之一&#xff0c;它能够帮助我们构建可扩展、可维护的代码&#xff0c;提升自身的编程水平。在本文中&#xff0c;我们将分享学习开闭原则的方法&#xff0c;揭示成为编程高手的秘…
阅读更多...
记android studio打包踩雷

记android studio打包踩雷

由于包太大考虑离线打包但是折腾一通打包完之后才发现&#xff0c;如果使用了插件市场上面的付费插件 离线打包时走不通的&#xff0c;只能老老实实付费云打包。
阅读更多...
数据结构--图的存储 十字链表、邻接多重表

数据结构--图的存储 十字链表、邻接多重表

数据结构–图的存储 十字链表、邻接多重表 十字链表存储有向图 空间复杂度&#xff1a;O(|V||E|) 如何找到指定顶点的所有出边&#xff1f;——顺着绿色线路找 如何找到指定顶点的所有入边&#xff1f;——顺着橙色线路找 注意&#xff1a;十字链表只用于存储有向图 \color{re…
阅读更多...
杨辉三角 II

杨辉三角 II

给定一个非负索引 rowIndex&#xff0c;返回「杨辉三角」的第 rowIndex 行。 在「杨辉三角」中&#xff0c;每个数是它左上方和右上方的数的和。 示例 1: 输入: rowIndex 3 输出: [1,3,3,1] 示例 2: 输入: rowIndex 0 输出: [1] 示例 3: 输入: rowIndex 1 输出: [1,1]…
阅读更多...
redis 相关

redis 相关

redis相关面试题 redis支持哪几种数据形式&#xff1f; String,hash,set,zset,list redis主要消费什么物理资源&#xff1f; 内存&#xff0c;key-value的形式&#xff0c; redis 具有快速和数据持久化的特征&#xff0c;如果不将数据放在内存中&#xff0c;磁盘 I/O 速度为严…
阅读更多...
实现视频监控场景下的抽烟目标检测：改进 YOLOv5 的关键方法与代码实现

实现视频监控场景下的抽烟目标检测：改进 YOLOv5 的关键方法与代码实现

文章目录 概要技术细节小结 概要 目标检测是计算机视觉领域的重要任务之一&#xff0c;而改进现有的目标检测模型以实现对细微差异目标的准确检测是当前研究的热点。本文将探讨如何通过对 YOLOv5 进行改进&#xff0c;以增强其对细微差异目标的感知能力。我们将介绍一些关键方…
阅读更多...
CN期刊《教师博览》是什么级别的刊物？

CN期刊《教师博览》是什么级别的刊物？

CN期刊《教师博览》是什么级别的刊物&#xff1f; 《教师博览》创刊于1993年&#xff0c;经国家新闻出版总署批准&#xff0c;江西省教育厅主管的省级G4学术期刊。 《教师博览》 是江西教育厅主管、江西教育期刊社主办的一份面向全国发行的教育杂志&#xff0c;其文摘版创办于…
阅读更多...
pdf怎么分成多个文件？教你4招PDF拆分!

pdf怎么分成多个文件？教你4招PDF拆分!

有时候&#xff0c;我们可能需要将一个包含多个页面的PDF文件拆分成多个独立的文件。这样做可以方便我们在需要的时候单独查看或处理某些页面&#xff0c;提高工作效率。本文将介绍四种常用的方法来将PDF文件分割成多个文件&#xff0c;包括使用Adobe Acrobat、记灵在线工具、P…
阅读更多...
地埋式积水在线监测系统助力城市内涝解决方案

地埋式积水在线监测系统助力城市内涝解决方案

一、方案背景 随着我国城镇化快速发展&#xff0c;城市建设产生的大量地面硬底化&#xff0c;大部分的降雨将形成地表径流&#xff0c;仅有少量雨水渗入地下&#xff0c;导致城市内涝等一系列问题。当前&#xff0c;全国多地发生洪涝&#xff0c;我国南北方全面进入主汛期。与往…
阅读更多...
linux文件系统只读导致监听异常

linux文件系统只读导致监听异常

项目经理发来截图&#xff0c;监听无法启动了&#xff0c;截图如下 orcl:/home/oraclehydb> lsnrctl start LSNRCTL for Linux: Version 11.2.0.4.0 - Production on 18-JUL-2023 11:29:54 Copyright (c) 1991, 2013, Oracle. All rights reserved. Starting /u01/app/…
阅读更多...
流体力学中动力粘度和运动粘度的定义和区别

流体力学中动力粘度和运动粘度的定义和区别

流体力学中动力粘度和运动粘度的定义和相互关系 在流体力学中&#xff0c;常遇到动力粘度和运动粘度参数。本文讲解这两个参数的含义和相关关系。 1.动力粘度&#xff08;Dynamic viscosity&#xff09; 1.1 动力粘度定义 动力粘度&#xff08;dynamic viscosity&#xff0…
阅读更多...
2023年在线帮助文档的特点和市场趋势变化

2023年在线帮助文档的特点和市场趋势变化

2023年在线帮助文档的特点和市场趋势变化将受到多种因素的影响。随着技术的不断进步和用户需求的变化&#xff0c;在线帮助文档将呈现出一些新的特点和趋势。 以下是可能出现的一些特点和市场趋势变化&#xff1a; 多样化的内容形式&#xff1a; 传统的在线帮助文档通常是以…
阅读更多...
gitea使用教程从搭建到远程访问通过API构建仓库上传代码

gitea使用教程从搭建到远程访问通过API构建仓库上传代码

文章目录 安装gitea远程访问安装gitea docker 安装gitea 教程 安装完成后就进入了类似这样的界面，先注册再登录。 登录后进入首页，包括了对gitea服务的设置和仓库的管理。 点击组织下的加号+用于创建仓库 仓库是git最核心的部分，是代码存储和迭代的容器。 创建仓库后进入…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023