十二、.net core(.NET 6)添加通用的访问webapi的方法(包括HttpClient和HttpWebRequest)

本文涉及的产品
云数据库 Redis 版,社区版 2GB
推荐场景:
搭建游戏排行榜
简介: 开发通用的访问webapi方法。在common工具文件夹下,新建一个类库项目:Wsk.Core.WebHelper,并引用Package包项目,然后新建一个类HttpClientHelper,用于使用HttpClient方法进行访问webapi:


开发通用的访问webapi方法。

 

common工具文件夹下,新建一个类库项目:Wsk.Core.WebHelper,并引用Package包项目,然后新建一个类HttpClientHelper,用于使用HttpClient方法进行访问webapi:

1995789-20210606190523027-1881363596.png

 

新建一个接口IHttpClientHelper,用于HttpClientHelper继承该接口。然后接口内新增一个返回泛型类型的通用的POST访问webapi的方法:

1995789-20210606190552738-1803264386.png

 

接着,在HttpClientHelper类里面,进行对该方法的实现:

1995789-20210606190607859-2066938035.png


说明:虽然使用了using,可以自动释放资源;但是难免还是需要一点时间。在finally下面通过手动释放资源,比自动释放资源,资源释放率会更快,在并发场景下,性能会更好一点点。当然,此处可以不适用using,因为手动释放了,以上纯属个人喜好的风格写法。


再来一个使用Basic加密进行访问的通用方法,写法如上,具体请看代码示例。先新建带用户名和密码参数的接口:

1995789-20210606190726411-1206750832.png

 

然后,在HttpClientHelper里面进行对应的实现:

1995789-20210606190740123-855045588.png

 

以上为使用POST的方式进行,如果需要使用例如GETPUT等,可以自行尝试,写法类似。


接口代码:


public interface IHttpClientHelper
    {
        /// <summary>
        /// 通用访问webapi方法
        /// </summary>
        /// <param name="url"></param>
        /// <param name="data"></param>
        /// <returns></returns>
        T Post<T>(string url, string data);
        /// <summary>
        /// 带用户名和密码的通用访问webapi方法
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="url"></param>
        /// <param name="data"></param>
        /// <param name="account">用户名</param>
        /// <param name="pwd">密码</param>
        /// <returns></returns>
        T Post<T>(string url, string data, string account, string pwd);
    }


实现类代码:


public class HttpClientHelper:IHttpClientHelper
    {
        readonly ILogger<HttpClientHelper> _logger;
        public HttpClientHelper(ILogger<HttpClientHelper> logger)
        {
            _logger = logger;
        }
        public T Post<T>(string url, string data)
        {
            var result = default(T);
            using (HttpClient client = new HttpClient())
            {
                try
                {
                    client.Timeout = new TimeSpan(0, 0, 10); // 10是秒数,用于设置超时时长
                    HttpContent content = new StringContent(data);
                    content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/json");
                    client.DefaultRequestHeaders.Connection.Add("keep-alive");
                    Task<HttpResponseMessage> res = client.PostAsync(url, content);
                    if (res.Result.StatusCode == System.Net.HttpStatusCode.OK)
                    {
                        result = JsonConvert.DeserializeObject<T>(res.Result.Content.ReadAsStringAsync().Result);
                    }
                    else
                    {
                        _logger.LogError($"访问webapi方法状态码错误:\r url:{url} \r data:{data} \r 状态码:{res.Result.StatusCode}");
                    }
                }
                catch (Exception ex)
                {
                    _logger.LogError($"访问webapi方法异常:\r url:{url} \r data:{data} \r 异常信息:{ex.Message}");
                }
                finally
                {
                    client.Dispose();
                }
            }
            return result;
        }
        public T Post<T>(string url, string data, string account, string pwd)
        {
            var result = default(T);
            using (HttpClient client = new HttpClient())
            {
                try
                {
                    string authorization = "Basic " + Convert.ToBase64String(Encoding.UTF8.GetBytes(account + ":" + pwd));
                    client.DefaultRequestHeaders.Add("authorization", authorization);
                    client.Timeout = new TimeSpan(0, 0, 10);
                    HttpContent content = new StringContent(data);
                    content.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/json");
                    Task<HttpResponseMessage> res = client.PostAsync(url, content);
                    if (res.Result.StatusCode == System.Net.HttpStatusCode.OK)
                    {
                        result = JsonConvert.DeserializeObject<T>(res.Result.Content.ReadAsStringAsync().Result);
                    }
                    else
                    {
                        _logger.LogError($"访问带用户名参数的webapi方法状态码错误:\r url:{url} \r data:{data} \r 状态码:{res.Result.StatusCode}");
                    }
                }
                catch (Exception ex)
                {
                    _logger.LogError($"访问带用户名参数的webapi方法异常:\r url:{url} \r data:{data} \r 异常信息:{ex.Message}");
                }
                finally
                {
                    client.Dispose();
                }
            }
            return result;
        }
    }


现在再新建一个使用HttpWebRequest的通用访问webapi的方式。在WebHelper项目下面,新建 HttpWebRequestHelper类,以及IHttpWebRequestHelper接口:


1995789-20210606190921148-924208770.png


在接口里面,新建一个通用的泛型类型的访问webapi的请求接口:

1995789-20210606190933782-1025215566.png


然后,在HttpWebRequestHelper类里面,进行有关的实现:


1995789-20210606190952366-1159103896.png

HttpWebRequest没有Dispose方法,所以此处没有使用using写法,最后需要手动使用Abort方法进行释放资源。


接口代码:


public interface IHttpWebRequestHelper
    {
        /// <summary>
        /// 通用方法
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="url"></param>
        /// <param name="data"></param>
        /// <param name="method">默认POST</param>
        /// <returns></returns>
        T Request<T>(string url, string data, string method = "POST");
    }


接口实现代码:


public class HttpWebRequestHelper:IHttpWebRequestHelper
    {
        readonly ILogger<HttpWebRequestHelper> _logger;
        public HttpWebRequestHelper(ILogger<HttpWebRequestHelper> logger)
        {
            _logger = logger;
        }
        public T Request<T>(string url, string data,string method="POST")
        {
            var result = default(T);
            HttpWebRequest request = null;
            try
            {
                request = (HttpWebRequest)WebRequest.Create(url);
                var byteData = Encoding.UTF8.GetBytes(data);
                request.Method = method;
                request.ContentType = "application/json"; 
                request.ContentLength = data.Length;
                request.Timeout = 10000; // 超时时间,毫秒单位
                using (var stream = request.GetRequestStream())
                {
                    stream.Write(byteData, 0, data.Length);
                }
                var response = (HttpWebResponse)request.GetResponse(); // 发送请求
                using (var resStream = response.GetResponseStream()) // 读取数据
                {
                    using (var reader = new StreamReader(resStream, Encoding.UTF8))
                    {
                        result = JsonConvert.DeserializeObject<T>(reader.ReadToEnd()); 
                    }
                }
            }
            catch (Exception ex)
            {
                  _logger.LogError($"使用HttpWebRequest访问webapi方法异常:\r url:{url} \r data:{data} \r 异常信息:{ex.Message}");
            }
            finally
            {
                if (request != null)
                {
                    request.Abort(); // 释放资源
                }
            }
            return result;
        }
    }


现在开发两个webapi进行测试。首先把该类库项目,添加到启动项目的项目引用里面。然后,在启动项目里面的AutofacRegister里面,添加对Wsk.Core.WebHelper类库项目的所有接口进行依赖注入注册:

1995789-20210606191315025-211510183.png


注册部分代码:


var assemblysWebhelper = Assembly.Load("Wsk.Core.WebHelper"); // 
            container.RegisterAssemblyTypes(assemblysWebhelper)
                .SingleInstance()
               .AsImplementedInterfaces() 
               .EnableInterfaceInterceptors();


新建一个实体类,用来当作参数和返回值的测试:


1995789-20210606191410614-1039858461.png

 

接着,在控制器里面写几个测试方法进行测试,测试内容如下:

1995789-20210606191423276-1887306644.png


控制器部分代码:


[Route("[controller]/[action]")]
    [ApiController]
    public class WSKController : ControllerBase
    {
        private readonly ITestAutofac _autofac;
        private readonly ILogger<WSKController> _logger;
        private readonly IRedisManage _redis;
        private readonly IHttpClientHelper _httpClient;
        private readonly IHttpWebRequestHelper _httpWebRequestHelper;
        public WSKController(ITestAutofac autofac, ILogger<WSKController> logger, IRedisManage redis, IHttpClientHelper httpClient, IHttpWebRequestHelper httpWebRequestHelper) {
            _autofac = autofac;
            _logger = logger;
            _redis = redis;
            _httpClient = httpClient;
            _httpWebRequestHelper = httpWebRequestHelper;
        }
        [HttpPost]
        public IActionResult HelloWorld(string url1,string url2)
        {
            TestWebHelperInfo info = new TestWebHelperInfo();
            info.name = "Hello";
            var value1 = _httpClient.Post<TestWebHelperInfo>(url1,JsonConvert.SerializeObject(info));
            info.name = "World";
            var value2 = _httpWebRequestHelper.Request<TestWebHelperInfo>(url2, JsonConvert.SerializeObject(info));
            return Ok($"value1:{value1.name} value2:{value2.name}");
        }
        [HttpPost]
        public IActionResult Test1([FromBody] TestWebHelperInfo info)
        {
            return Ok(info);
        }
        [HttpPost]
        public IActionResult Test2([FromBody] TestWebHelperInfo info)
        {
            return Ok(info);
        }
    }


运行,然后测试一下12接口是否可以使用,如果可以使用,拷贝对应的url地址,当作参数传给主测试api里面。

1995789-20210606191526921-676627913.png


获得到请求的url地址前缀是:http://localhost:35678/WSK/,带入参数进行验证:

1995789-20210606191547907-1589423717.png

 

由此可见,两个通用方法都可用。


备注:如果不适用泛型,也可以直接使用返回String即可,不需要进行类型转换。


相关实践学习
基于Redis实现在线游戏积分排行榜
本场景将介绍如何基于Redis数据库实现在线游戏中的游戏玩家积分排行榜功能。
云数据库 Redis 版使用教程
云数据库Redis版是兼容Redis协议标准的、提供持久化的内存数据库服务,基于高可靠双机热备架构及可无缝扩展的集群架构,满足高读写性能场景及容量需弹性变配的业务需求。 产品详情:https://www.aliyun.com/product/kvstore &nbsp; &nbsp; ------------------------------------------------------------------------- 阿里云数据库体验:数据库上云实战 开发者云会免费提供一台带自建MySQL的源数据库&nbsp;ECS 实例和一台目标数据库&nbsp;RDS实例。跟着指引,您可以一步步实现将ECS自建数据库迁移到目标数据库RDS。 点击下方链接,领取免费ECS&amp;RDS资源,30分钟完成数据库上云实战!https://developer.aliyun.com/adc/scenario/51eefbd1894e42f6bb9acacadd3f9121?spm=a2c6h.13788135.J_3257954370.9.4ba85f24utseFl
目录
相关文章
|
16天前
|
数据可视化 网络协议 C#
C#/.NET/.NET Core优秀项目和框架2024年3月简报
公众号每月定期推广和分享的C#/.NET/.NET Core优秀项目和框架(每周至少会推荐两个优秀的项目和框架当然节假日除外),公众号推文中有项目和框架的介绍、功能特点、使用方式以及部分功能截图等(打不开或者打开GitHub很慢的同学可以优先查看公众号推文,文末一定会附带项目和框架源码地址)。注意:排名不分先后,都是十分优秀的开源项目和框架,每周定期更新分享(欢迎关注公众号:追逐时光者,第一时间获取每周精选分享资讯🔔)。
|
3月前
|
开发框架 前端开发 JavaScript
盘点72个ASP.NET Core源码Net爱好者不容错过
盘点72个ASP.NET Core源码Net爱好者不容错过
71 0
|
3月前
|
开发框架 .NET
ASP.NET Core NET7 增加session的方法
ASP.NET Core NET7 增加session的方法
37 0
|
3月前
|
开发框架 JavaScript .NET
ASP.NET Core的超级大BUG
ASP.NET Core的超级大BUG
42 0
|
1月前
|
开发框架 人工智能 .NET
C#/.NET/.NET Core拾遗补漏合集(持续更新)
C#/.NET/.NET Core拾遗补漏合集(持续更新)
|
1月前
|
开发框架 中间件 .NET
C# .NET面试系列七:ASP.NET Core
## 第一部分:ASP.NET Core #### 1. 如何在 controller 中注入 service? 在.NET中,在ASP.NET Core应用程序中的Controller中注入服务通常使用<u>依赖注入(Dependency Injection)</u>来实现。以下是一些步骤,说明如何在Controller中注入服务: 1、创建服务 首先,确保你已经在应用程序中注册了服务。这通常在Startup.cs文件的ConfigureServices方法中完成。例如: ```c# services.AddScoped<IMyService, MyService>(); //
63 0
|
2月前
|
开发框架 前端开发 .NET
福利来袭,.NET Core开发5大案例,30w字PDF文档大放送!!!
为了便于大家查找,特将之前开发的.Net Core相关的五大案例整理成文,共计440页,32w字,免费提供给大家,文章底部有PDF下载链接。
33 1
福利来袭,.NET Core开发5大案例,30w字PDF文档大放送!!!
|
2月前
|
算法 BI API
C#/.NET/.NET Core优秀项目和框架2024年1月简报
C#/.NET/.NET Core优秀项目和框架2024年1月简报
|
3月前
|
算法 C#
C# .Net Core bytes转换为GB/MB/KB 算法
C# .Net Core bytes转换为GB/MB/KB 算法
40 0
|
3月前
|
前端开发
.net core mvc获取IP地址和IP所在地(其实是百度的)
.net core mvc获取IP地址和IP所在地(其实是百度的)
124 0