ABP vnext 控制器知识整理

使用

• ABP通过Abp.Web.Mvc nuget包集成了ASP.NET MVC控制器。可像常规那样创建MVC控制器。

例1

控制器常用模板

XXX.HttpApi\Controllers\XXXXController.cs

[RemoteService]
[Route("api/Acceptance/Qlqt")]
public class XXXController: XXXXController,IXXXAppService
{
    /// <summary>
    /// 服务
    /// </summary>
    private readonly IXXXAppService service;

    /// <summary>
    /// 初始化
    /// </summary>
    /// <param name="service">服务</param>
    public XXXController(IXXXAppService service)
    {
        this.service = service;
    }

    /// <summary>
    /// 新增一条记录
    /// </summary>
    /// <param name="model">参数模型</param>
    /// <returns>操作结果</returns>
    [HttpPost("Insert")]
    public async Task<bool> InsertAsync(XXXDto model)
    {
        return await service.InsertAsync(model);
    }

    /// <summary>
    /// 删除一条记录
    /// </summary>
    /// <param name="id">一条记录的id</param>
    /// <returns>操作结果</returns>
    [HttpDelete("{id}")]
    public async Task<bool> DeleteAsync(Guid id)
    {
        return await service.DeleteAsync(id);
    }
    
    /// <summary>
    /// 更新数据
    /// </summary>
    /// <param name="model">参数模型</param>
    /// <returns>操作结果</returns>
    [HttpPut("Update")]
    public async Task<bool> UpdateAsync([FromBody] XXXDto model)
    {
        return await service.UpdateAsync(model);
    }

    /// <summary>
    /// 根据id查询记录
    /// </summary>
    /// <param name="id">Id</param>
    /// <returns>查询结果</returns>
    [HttpGet("{id}")]
    public async Task<XXXtDto> GetAsync(Guid id)
    {
        return await service.GetAsync(id);
    }
    
        /// <summary>
        /// 获取分页结果
        /// </summary>
        /// <param name="dto">分页请求Dto</param>
        /// <returns>分页结果</returns>
        [HttpGet("GetPagedList")]
        public async Task<PagedResultDto<TechnicalSupportDto>> GetPagedListAsync(PagedResultRequestDto dto)
        {
            return await service.GetPagedListAsync(dto);
        }
}

例2

返回object，会序列化为字符串返回给前端

[HttpGet("GetEcCertPdf")]
public object GetEcCertPdf()
{
    return new { 
        Title = "Ghostbusters", 
        Genre = "Comedy", 
        ReleaseDate = new DateTime(2017, 1, 1) ,
        Object=new { 
            Title="hello"
        }
    };
}

运行结果

{
  "title": "Ghostbusters",
  "genre": "Comedy",
  "releaseDate": "2017-01-01T00:00:00",
  "object": {
    "title": "hello"
  }
}

例3

/// <summary>
/// 下载电子证照
/// </summary>
/// <param name="certificateIdentifier">证照标识</param>
/// <returns>操作结果</returns>
[HttpGet("Download")]
public async Task<FileStreamResult> DownloadAsync(CertificateIdentifier certificateIdentifier)
{
    var result = await service.DownloadAsync(certificateIdentifier);
    result.Position = 0;
    return new FileStreamResult(result, "application/octet-stream");
}

例4

XXXX.HttpApi.Host\XXXXHttpApiHostModule.cs

context.Services.AddAbpSwaggerGenWithOAuth(
    configuration["AuthServer:Authority"],
    new Dictionary<string, string>e
    {
        {"Space", "Space API"}
    },
    options =>
    {
        var xmls = Directory.GetFiles(AppDomain.CurrentDomain.BaseDirectory, "*.xml")
        .Where(p => Path.GetFileName(p).StartsWith(nameof(ZswYhj)));
        xmls.ToList().ForEach(p => options.IncludeXmlComments(p, true));

        options.SwaggerDoc("v1", new OpenApiInfo {Title = "Space API", Version = "v1"});
        options.DocInclusionPredicate((docName, description) => true);
        options.CustomSchemaIds(type => type.FullName);
    });

例5

给应用服务自动添加控制器

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

例6

导入文件

/// <summary>
/// 批量导入查询
/// </summary>
/// <param name="forms">导入模型</param>
/// <returns>操作结果</returns>
[HttpPost("ImportForQuery")]
public async Task<FileStreamResult> ImportForQueryAsync(IFormCollection forms)
{
    try
    {
        if (!HttpContext.Request.Form.Files.Any())
        {
            throw new BusinessException("文件内容为空！");
        }
        using var memoryStream = new MemoryStream();
        await HttpContext.Request.Form.Files.First().CopyToAsync(memoryStream);
        memoryStream.Position = 0;
        var resStream = await service.ImportForQueryAsync(memoryStream.ToArray());
        return new FileStreamResult(resStream, "application/octet-stream") { FileDownloadName = $"{Guid.NewGuid()}.xlsx" };
    }
    catch (Exception ex)
    {
        Logger.LogError(ex, "读取文件失败！");
        throw new BusinessException("读取文件失败！");
    }

}

例7

如下图所示，有些默认的 webapi 是不需要的，可以考虑不显示这些 webapi。

context.Services.AddAbpSwaggerGenWithOAuth(
    configuration["AuthServer:Authority"],
    new Dictionary<string, string>
    {
        {"DbTool", "DbTool API"}
    },
    options =>
    {
        options.SwaggerDoc("v1", new OpenApiInfo {Title = "DbTool API", Version = "v1"});
		
        options.DocInclusionPredicate((docName, description) =>
        {
            if (description.GroupName != null && (description.GroupName.StartsWith("Identity") ||
                description.GroupName.StartsWith("Abp") || description.GroupName.StartsWith("Features") ||
                description.GroupName == "Profile") || description.GroupName.StartsWith("Tenant"))
            {
                return false;
            }
            else
            {
                return true;
            }
        });
    });