备案控制台
开发者社区 开发与运维 文章 正文

[ABP框架]动态web Api的拦截用法。

2017-06-30 1826
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 先进行配置首先这种需求，一般发生在APP端，我们给APP，不会给所有项目系统的接口给他们用。我们系统有200个接口，但是APP的需求只会用20个。那么这个需求也就应运而生了。

先进行配置

首先这种需求，一般发生在APP端，我们给APP，不会给所有项目系统的接口给他们用。我们系统有200个接口，但是APP的需求只会用20个。那么这个需求也就应运而生了。

img_7038b506c2e564e6c9a65a2cfdd0b862.png
项目结构.png

以上为API文件夹中为项目接口，没有啥特别复杂的东西存在。

首先创建好，一个网站项目，进行模块的配置。
首先引入以下的nuget包：
以下是WebApp项目中的packages.config

<?xml version="1.0" encoding="utf-8"?>
<packages>
  <package id="Abp" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Castle.Log4Net" version="1.5.1" targetFramework="net452" />
  <package id="Abp.EntityFramework" version="1.5.1" targetFramework="net452" />
  <package id="Abp.EntityFramework.Common" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Owin" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Web" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Web.Api" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Web.Common" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Web.Mvc" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Web.Resources" version="1.5.2" targetFramework="net452" />
  <package id="Abp.Zero" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Zero.EntityFramework" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Zero.Owin" version="1.5.1" targetFramework="net452" />
  <package id="Antlr" version="3.5.0.2" targetFramework="net452" />
  <package id="bootstrap" version="3.0.0" targetFramework="net452" />
  <package id="Castle.Core" version="3.3.3" targetFramework="net452" />
  <package id="Castle.LoggingFacility" version="3.4.0" targetFramework="net452" />
  <package id="Castle.Windsor" version="3.4.0" targetFramework="net452" />
  <package id="EntityFramework" version="6.1.3" targetFramework="net452" />
  <package id="EntityFramework.DynamicFilters" version="1.4.11" targetFramework="net452" />
  <package id="JetBrains.Annotations" version="10.4.0" targetFramework="net452" />
  <package id="jQuery" version="1.6.4" targetFramework="net452" />
  <package id="log4net" version="2.0.8" targetFramework="net452" />
  <package id="Microsoft.AspNet.Identity.Core" version="2.2.1" targetFramework="net452" />
  <package id="Microsoft.AspNet.Identity.Owin" version="2.2.1" targetFramework="net452" />
  <package id="Microsoft.AspNet.Mvc" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.Mvc.zh-Hans" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.Razor" version="3.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.Razor.zh-Hans" version="3.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.Web.Optimization" version="1.1.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.Web.Optimization.zh-Hans" version="1.1.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.Client" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.Client.zh-Hans" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.Core" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.Core.zh-Hans" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.HelpPage" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.Owin" version="5.2.3" targetFramework="net461" />
  <package id="Microsoft.AspNet.WebApi.WebHost" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.WebHost.zh-Hans" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebPages" version="3.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebPages.zh-Hans" version="3.2.3" targetFramework="net452" />
  <package id="Microsoft.Bcl" version="1.1.10" targetFramework="net452" />
  <package id="Microsoft.Bcl.Async" version="1.0.168" targetFramework="net452" />
  <package id="Microsoft.Bcl.Build" version="1.0.21" targetFramework="net452" />
  <package id="Microsoft.CodeDom.Providers.DotNetCompilerPlatform" version="1.0.3" targetFramework="net452" />
  <package id="Microsoft.Net.Compilers" version="1.3.2" targetFramework="net452" developmentDependency="true" />
  <package id="Microsoft.Owin" version="3.1.0" targetFramework="net452" />
  <package id="Microsoft.Owin.FileSystems" version="3.0.1" targetFramework="net452" />
  <package id="Microsoft.Owin.Host.SystemWeb" version="3.0.1" targetFramework="net452" />
  <package id="Microsoft.Owin.Security" version="3.1.0" targetFramework="net452" />
  <package id="Microsoft.Owin.Security.Cookies" version="3.0.1" targetFramework="net452" />
  <package id="Microsoft.Owin.Security.OAuth" version="3.0.1" targetFramework="net452" />
  <package id="Microsoft.Owin.StaticFiles" version="3.0.1" targetFramework="net452" />
  <package id="Microsoft.Web.Infrastructure" version="1.0.0.0" targetFramework="net452" />
  <package id="Modernizr" version="2.8.3" targetFramework="net452" />
  <package id="Newtonsoft.Json" version="9.0.1" targetFramework="net452" />
  <package id="Nito.AsyncEx" version="4.0.1" targetFramework="net452" />
  <package id="Owin" version="1.0" targetFramework="net452" />
  <package id="Respond" version="1.2.0" targetFramework="net452" />
  <package id="Swashbuckle.Core" version="5.5.3" targetFramework="net461" />
  <package id="System.Collections.Immutable" version="1.3.1" targetFramework="net452" />
  <package id="System.Linq.Dynamic" version="1.0.7" targetFramework="net452" />
  <package id="WebGrease" version="1.6.0" targetFramework="net452" />
</packages>

新建一个'AbpProjectTemplateWebAppModule.cs' 的类文件：

  [DependsOn(
        typeof(AbpWebMvcModule),
        typeof(AbpZeroOwinModule),
        typeof(AbpProjectTemplateDataModule),
           typeof(AbpProjectTemplateWebAppApiModule),

        typeof(AbpProjectTemplateApplicationModule)

    )]
    public class AbpProjectTemplateWebAppModule : AbpModule
    {
        public override void PreInitialize()
        {
           
        }
        public override void Initialize()
        {
            //进行以来注入
            IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());

            IocManager.IocContainer.Register(
                Component
                    .For<IAuthenticationManager>()
                    .UsingFactoryMethod(() => HttpContext.Current.GetOwinContext().Authentication)
                    .LifestyleTransient()
            );
            //Areas
            AreaRegistration.RegisterAllAreas();

            //Routes
            RouteConfig.RegisterRoutes(RouteTable.Routes);

            //Bundling
            BundleTable.Bundles.IgnoreList.Clear();
            BundleConfig.RegisterBundles(BundleTable.Bundles);
        }
 
    }

对Global.asax文件进行修改，修改后：

    public class WebApiApplication : AbpWebApplication<AbpProjectTemplateWebAppModule>
    {
        protected override void Application_Start(object sender, EventArgs e)
        {
            //Use UTC clock. Remove this to use local time for your application.
             
            //Log4Net configuration
            AbpBootstrapper.IocManager.IocContainer
                .AddFacility<LoggingFacility>(f => f.UseAbpLog4Net()
                    .WithConfig("log4net.config")
                );

            base.Application_Start(sender, e);
        }

       
    }

不要尝试在webapp中，直接引入abp.webapi。我失败了两次，但是之前的0.97版本又是可以的。。

然后创建一个webappapi的类库：
引入如下的nuge包
这个是webAppApi项目中的package.config:

<?xml version="1.0" encoding="utf-8"?>
<packages>
  <package id="Abp" version="1.5.1" targetFramework="net452" />
  <package id="Abp.AutoMapper" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Web" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Web.Api" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Web.Common" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Zero" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Zero.Owin" version="1.5.1" targetFramework="net452" />
  <package id="AutoMapper" version="5.2.0" targetFramework="net452" />
  <package id="Castle.Core" version="3.3.3" targetFramework="net461" />
  <package id="Castle.LoggingFacility" version="3.4.0" targetFramework="net452" />
  <package id="Castle.Windsor" version="3.4.0" targetFramework="net452" />
  <package id="JetBrains.Annotations" version="10.4.0" targetFramework="net452" />
  <package id="Microsoft.AspNet.Identity.Core" version="2.2.1" targetFramework="net452" />
  <package id="Microsoft.AspNet.Identity.Owin" version="2.2.1" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.Client" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.Core" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.Owin" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.WebHost" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.Bcl" version="1.1.10" targetFramework="net452" />
  <package id="Microsoft.Bcl.Async" version="1.0.168" targetFramework="net452" />
  <package id="Microsoft.Bcl.Build" version="1.0.21" targetFramework="net452" />
  <package id="Microsoft.Owin" version="3.1.0" targetFramework="net461" />
  <package id="Microsoft.Owin.Security" version="3.1.0" targetFramework="net461" />
  <package id="Microsoft.Owin.Security.Cookies" version="3.0.1" targetFramework="net461" />
  <package id="Microsoft.Owin.Security.OAuth" version="3.0.1" targetFramework="net461" />
  <package id="Newtonsoft.Json" version="9.0.1" targetFramework="net452" />
  <package id="Nito.AsyncEx" version="4.0.1" targetFramework="net452" />
  <package id="Owin" version="1.0" targetFramework="net452" />
  <package id="Swashbuckle.Core" version="5.5.3" targetFramework="net452" />
  <package id="System.Collections.Immutable" version="1.3.1" targetFramework="net452" />
  <package id="System.Linq.Dynamic" version="1.0.7" targetFramework="net452" />
</packages>

然后下面就是创建一个"AbpProjectTemplateWebAppApiModule.cs"

 /// <summary>
    /// 在系统中进行WebApi的配置
    /// </summary>
    [DependsOn(typeof(AbpWebApiModule), typeof(AbpProjectTemplateApplicationModule))]
    public class AbpProjectTemplateWebAppApiModule : AbpModule
    {
       
        public override void Initialize()
        {
            IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());           
            Configuration.Modules.AbpWebApi().DynamicApiControllerBuilder
                .ForAll<IApplicationService>(typeof(AbpProjectTemplateApplicationModule).Assembly, "app")
                .Build();
            Configuration.Modules.AbpWebApi().HttpConfiguration.Filters.Add(new HostAuthenticationFilter("Bearer"));      
        }        
    }

然后就是配置EnableSwaggerUi了。这里的教程，请去看：ABP教程-给项目添加SwaggerUI,生成动态webapi

跑起来了后的截图：

img_e897d728bb5a9e42c6482bfb80e07b8e.png
API截图

接口太多了。那么我们就来折腾下
首先在application层创建一个

  /// <summary>
    /// 使用该特性进行app过滤
    ///  
    /// </summary>
    public class WebAppApiAttribute:System.Attribute
    {
        
    }

对AbpProjectTemplateWebAppApiModule中的配置方法进行改造下

Configuration.Modules.AbpWebApi().DynamicApiControllerBuilder
    .ForAll<IApplicationService>(Assembly.GetExecutingAssembly(), "app")
    .ForMethods(builder =>
    {
           if (!a.Method.IsDefined(typeof(WebAppApiAttribute)))
                        {
                            a.DontCreate = true;
                        }
    })
    .Build();

然后在特定的 方法上打上标记。

 public interface ICachingAppService : IApplicationService
    {
        [WebAppApi]
        ListResultDto<CacheDto> GetAllCaches();

        Task ClearCache(EntityDto<string> input);
        [WebAppApi]
        Task ClearAllCaches();
    }

然后我们运行项目，看到如下结果：

img_013d61a6394f38621554ecafd573360b.png
编译后的结果

更多的玩法，请参考官方文档：
Dynamic Web API Layer

https://aspnetboilerplate.com/Pages/Documents/v1.5.2/Dynamic-Web-API

文章标签：
API
Web App开发
关键词：
框架web
web框架
web api
API Web
框架API
wer_ltm
目录
相关文章
sky_qiyi
|
22天前
|
Java API
JavaSE——常用API进阶二（6/8）-ZoneId、ZoneDateTime、Instant（常见方法、用法示例）
JavaSE——常用API进阶二（6/8）-ZoneId、ZoneDateTime、Instant（常见方法、用法示例）
sky_qiyi
19 1
花开富贵111
|
2天前
|
弹性计算 算法 安全
视觉智能开放平台产品使用合集之在Web应用和WinForm应用程序中调用API时，出现Web端能够成功调用而WinForm端调用失败，是什么原因
视觉智能开放平台是指提供一系列基于视觉识别技术的API和服务的平台，这些服务通常包括图像识别、人脸识别、物体检测、文字识别、场景理解等。企业或开发者可以通过调用这些API，快速将视觉智能功能集成到自己的应用或服务中，而无需从零开始研发相关算法和技术。以下是一些常见的视觉智能开放平台产品及其应用场景的概览。
花开富贵111
7 0
叫个什么名字
|
6天前
|
前端开发 JavaScript API
探索现代Web开发中的动态数据交互——前端与后端整合实战
本文探讨了现代Web开发中前端与后端整合的关键技术点，通过实际案例演示了如何利用JavaScript和Node.js实现动态数据交互，全面解析从数据请求到响应的全过程。
叫个什么名字
41 18
1941623231718325
|
19天前
|
SQL 缓存 测试技术
RESTful API设计的最佳实践：构建高效、可维护的Web服务接口
【6月更文挑战第11天】构建高效、可维护的RESTful API涉及多个最佳实践：遵循客户端-服务器架构、无状态性等REST原则；设计时考虑URL结构（动词+宾语，使用标准HTTP方法）、使用HTTP状态码、统一响应格式及错误处理；确保数据安全（HTTPS、认证授权、输入验证）；实施版本控制；并提供详细文档和测试用例。这些实践能提升Web服务接口的性能和质量。
1941623231718325
22 2
opencv学堂
|
23天前
|
XML JavaScript 前端开发
基于SVG的web页面图形绘制API介绍
基于SVG的web页面图形绘制API介绍
opencv学堂
26 4
sky_qiyi
|
22天前
|
存储 Java API
JavaSE——常用API进阶二（8/8）-Arrays、Comparable、Comparator（Arrays类提供的的常见方法、用法示例）
JavaSE——常用API进阶二（8/8）-Arrays、Comparable、Comparator（Arrays类提供的的常见方法、用法示例）
sky_qiyi
21 2
sky_qiyi
|
22天前
|
安全 Java API
JavaSE——常用API进阶二（7/8）-DateTimeFormatter、Period、Duration（常见方法、用法示例）
JavaSE——常用API进阶二（7/8）-DateTimeFormatter、Period、Duration（常见方法、用法示例）
sky_qiyi
32 2
opencv学堂
|
22天前
|
JSON 前端开发 API
Apache HttpClient调用Spring3 MVC Restful Web API演示
Apache HttpClient调用Spring3 MVC Restful Web API演示
opencv学堂
18 1
sky_qiyi
|
22天前
|
存储 Java API
JavaSE——常用API进阶二（4/8）-秒杀案例（需求与分析、代码与运行结果）、Calendar（Calendar日历类的常见方法、用法示例）
JavaSE——常用API进阶二（4/8）-秒杀案例（需求与分析、代码与运行结果）、Calendar（Calendar日历类的常见方法、用法示例）
sky_qiyi
24 1
sky_qiyi
|
22天前
|
Java API
JavaSE——常用API进阶二（3/8）-Date、SimpleDateFormat（构造器、常用的方法、用法示例、时间格式的常见符号）
JavaSE——常用API进阶二（3/8）-Date、SimpleDateFormat（构造器、常用的方法、用法示例、时间格式的常见符号）
sky_qiyi
10 1

热门文章

最新文章

  • 1
    10：基于Servlet模拟用户登录功能的实现与解析-Java Web
  • 2
    14：Servlet中的页面跳转-Java Web
  • 3
    15：Servlet 3.0文件上传与下载-Java Web
  • 4
    13：会话跟踪技术Session的深度应用与实践-Java Web
  • 5
    13：Session机制实现用户登录与注销功能-Java Web
  • 6
    Web 测试神器：HackBar 保姆级教程
  • 7
    C# Web控件与数据感应之 Control 类
  • 8
    【Web 前端】ES6中，Set和Map的区别 ？
  • 9
    【Web 前端】如何在点击一个按钮时使用 jQuery 隐藏一个图片？
  • 10
    【Web 前端】网页上有 5 个div元素，如何使用JQ来选择它们？
  • 1
    Elasticsearch 8.10 同义词管理新篇章：引入同义词 API
    47
  • 2
    记录openai官网关于Setup your API key for a single project(为单个项目设置API 可以)的错误（2023/11/24）
    49
  • 3
    API在电子商务中的应用与优势：深入解析
    29
  • 4
    阿里云大佬叮嘱我务必要科普这个 Elasticsearch API
    37
  • 5
    电商数据分析的利器：电商关键词搜索API接口（标题丨图片丨价格丨链接）
    58
  • 6
    深入理解RESTful API设计原则与实践
    42
  • 7
    请问下钉钉有能够获取到群聊天和个人聊天历史记录的api嘛？
    37
  • 8
    淘宝商品评论数据获取：从API调用到应用实践
    44
  • 9
    🆚内部 API vs 公共 API：全面比较及管理策略
    41
  • 10
    C# 通过阿里云 API 实现企业营业执照OCR识别
    44

    • 相关课程

    更多
  • Python Web开发基础
  • Java Web开发系列课程 - Spring框架入门
  • 企业Web常用架构LAMP-LNMP实战
  • 高校精品课-西安交通大学-Web 编程技术
  • Java Web项目实战 - 图书商城
  • Java面试疑难点解析 - Java Web开发

    • 相关电子书

    更多
  • CUDA MATH API
  • API PLAYBOOK
  • 传统企业的“+互联网”-API服务在京东方的实践

    • 相关实验场景

    更多
  • Internet Information Services（IIS）部署Web项目
  • 云上Web及FTP
  • WEB网页编程实战
  • 网站用户流量分析—适用于电商网站、资讯网站、游戏主站等各类Web站点场景
  • Web Terminal环境使用指南
    • 下一篇
    部署LAMP环境（Alibaba Cloud Linux 3）