winform桌面程序如何调用后台API的方法（一）

最新推荐文章于 2024-06-30 17:04:43 发布
最新推荐文章于 2024-06-30 17:04:43 发布
阅读量2.1k 收藏 7
点赞数 1
文章标签： c# 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_36175133/article/details/131681664
版权
文章介绍了如何在winform桌面程序中通过调用后台API来解决代码复用和动态更新问题。通过创建后台API，当需要修复或更新方法时，可以在不影响其他项目的情况下，直接在后台修改并立即影响到所有引用该项目的程序，提高开发效率和代码维护性。
摘要由CSDN通过智能技术生成

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

前言

        每当进行winform桌面程序开发时，为了实现项目之间的代码复用，通常会将一些通用的方法封装成动态库（.dll）。但是这样也存在一个问题，假设将方法A方法封装成动态库MyDll后，项目Project1引用了MyDll，可以使用A方法；在项目Project2引用MyDll使用A方法时，发现A方法有bug，并对A方法进行修复。此时，Project1使用的方法A仍然存在bug，需要重新引用最新的MyDll才能修复A的bug。那么，是否有更好的解决方法，在Project2修复完成时，Project1引用的方法A也同步修复呢？

提示：以下是本篇文章正文内容，下面案例可供参考

一、如何解决？

        现在我给大家介绍的，就是如何使用winform调用后台的API

二、使用步骤

步骤一：构建后台API

  1. 开发工具：VS2019
  2. 目标框架：.net core 3.1
  3. 先在后台写一个简单的方法GetDateTime，用于winform端进行调用。

代码如下（GetDateTime）：

using Agreement.Business.System;
using Agreement.Entity.Enum;
using Agreement.Entity.Models.AgreementEntity;
using log4net;
using Microsoft.AspNetCore.Mvc;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace tokendemo.Controllers
{
    [ApiController]
    [Route("[controller]/[action]")]
    public class MyTestDemoController : CommServers
    {
        private readonly ILog _logger;
        public MyTestDemoController()
        {
            _logger = LogManager.GetLogger(typeof(MyTestDemoController));
        }

        [HttpGet]
        public async Task<TData> GetDateTime()
        {
            string strResult= "Beijing Time:" + DateTime.Now.ToString();
            return ReturnObj<bool>(ResultEnum.Sucess, true, strResult);
          
        }


    }
}

4.为了将返回值进行统一，封装一个CommServers.cs类，用于赋值返回，需要引用类TData.cs和枚举ResultEnum.cs：

代码如下（CommServers.cs）：

using Agreement.Entity.Enum;
using Agreement.Entity.Models.AgreementEntity;
using System;
using System.Collections.Generic;
using System.Text;
using System.Threading.Tasks;


namespace Agreement.Business.System
{
    public class CommServers
    {
        /// <summary>
        /// 构造返回结果
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="result"></param>
        /// <param name="data"></param>
        /// <param name="mesage"></param>
        /// <returns></returns>
        public TData<T> ReturnObj<T>(ResultEnum result, T data, string mesage)
        {
            TData<T> obj = new TData<T>();
            obj.Result = result;
            obj.Data = data;
            obj.TotalCount = 1;
            obj.Message = mesage;
            return obj;
        }

    }
}

5.第（4）点需要引用类TData.cs和枚举ResultEnum.cs

代码如下（TData.cs）：

using Agreement.Entity.Enum;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;


namespace Agreement.Entity.Models.AgreementEntity
{
        public class TData
        {
        /// <summary>
        /// 操作结果，Result为1代表成功，0代表失败，其他的验证返回结果，可根据需要设置
        /// </summary>
        public ResultEnum Result { get; set; }

            /// <summary>
            /// 提示信息或异常信息
            /// </summary>
            public string Message { get; set; }

            /// <summary>
            /// 扩展Message
            /// </summary>
            public string Description { get; set; }
        }

        public class TData<T> : TData
        {
            /// <summary>
            /// 列表的记录数
            /// </summary>
            public int TotalCount { get; set; }

            /// <summary>
            /// 数据
            /// </summary>
            public T Data { get; set; }

        }

    
}

代码如下（ResultEnum.cs）：

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using System.Threading.Tasks;

namespace Agreement.Entity.Enum
{

    /// <summary>
    /// 操作结果，Result为1代表成功，0代表失败，其他的验证返回结果，可根据需要设置
    /// </summary>
    public enum ResultEnum
    {

        /// <summary>
        /// 成功
        /// </summary>
        [Description("成功")]
        Sucess = 1,

        /// <summary>
        /// 失败
        /// </summary>
        [Description("失败")]
        Faill = 0

    }
}

运行后，先在后台测试方法是否可用，如下图：

 

步骤二：构建后台API

  1. 开发工具：VS2019
  2. 目标框架：.net Framework 4.7.2
  3. 先创建一个简单的winform程序，并添加一个简单的测试按钮，如下图：

     4. 在项目通过NutGet程序包，添加Newtonsoft.Json，操作步骤如下图：

     5. 完成Newtonsoft.Json程序包的安装之后，新建两个类，HttpReuestUtility.cs(将和后台通讯的方法封装到这个类中)和JsonObject.cs(主要将后台的通讯结果进行封装)。

代码如下（HttpReuestUtility.cs）：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Net;
using System.IO;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using Newtonsoft.Json.Converters;

namespace JasonHelp
{
    public class HttpReuestUtility
    {
     
        /// <summary>
        /// 发送jason到服务器
        /// </summary>
        /// <param name="SendDate"></param>
        /// <param name="InterfaceName"></param>
        /// <returns></returns>
        public static JsonObject GetResponseData(string SendDate, string InterfaceName)  
        {

            JsonObject reJson = new JsonObject();
            try
            {
                if (SendDate == "")
                {
                    SendDate = "{}";
                }
                byte[] bytes = Encoding.UTF8.GetBytes(SendDate);
                HttpWebRequest request = (HttpWebRequest)WebRequest.Create(InterfaceName);
                request.Method = "POST";
                //request.ContentType = "application/x-www-form-urlencoded";
                //request.Accept = "text/plain";
                request.ContentType = "application/json";
                request.Accept = "application/json";
                request.ContentLength = bytes.Length;
                Stream reqstream = request.GetRequestStream();
                reqstream.Write(bytes, 0, bytes.Length);

                //声明一个HttpWebRequest请求  
                request.Timeout = 60000;
                //设置连接超时时间  
                request.Headers.Set("Pragma", "no-cache");
                HttpWebResponse response = (HttpWebResponse)request.GetResponse();
                Stream streamReceive = response.GetResponseStream();
                Encoding encoding = Encoding.UTF8;

               StreamReader streamReader = new StreamReader(streamReceive, encoding);
               string strResult = streamReader.ReadToEnd();
               streamReceive.Dispose();
               streamReader.Dispose();
               JObject JsonResult= JObject.Parse(strResult);
               int isSuccess = JsonResult["result"].Value<int>();
               string Result = JsonResult["message"].Value<string>();
               //JArray jar = JArray.Parse(JsonResult["Data"].ToString());
               reJson.isSuccess = isSuccess;
               reJson.Result = Result;
               reJson.Data = JsonResult["data"];

             
                return reJson;
            }
            catch (Exception ex)
            {
                throw ex;
            }
        }




        /// <summary>
        /// 发送jason到服务器
        /// </summary>
        /// <param name="SendDate"></param>
        /// <param name="InterfaceName"></param>
        /// <returns></returns>
        public static JsonObject GetResponseDataByGet(string InterfaceName)
        {

            JsonObject reJson = new JsonObject();
            try
            {
               
               // byte[] bytes = Encoding.UTF8.GetBytes(SendDate);
                HttpWebRequest request = (HttpWebRequest)WebRequest.Create(InterfaceName);
                request.Method = "GET";

                //request.ContentType = "application/x-www-form-urlencoded";
                //request.Accept = "text/plain";
                //request.ContentType = "application/json";
                //request.Accept = "application/json";
                //request.ContentLength = bytes.Length;
                //Stream reqstream = request.GetRequestStream();
              //  reqstream.Write(bytes, 0, bytes.Length);

                //声明一个HttpWebRequest请求  
                request.Timeout = 60000;
                //设置连接超时时间  
                request.Headers.Set("Pragma", "no-cache");
                HttpWebResponse response = (HttpWebResponse)request.GetResponse();
                Stream streamReceive = response.GetResponseStream();
                Encoding encoding = Encoding.UTF8;

                StreamReader streamReader = new StreamReader(streamReceive, encoding);
                string strResult = streamReader.ReadToEnd();
                streamReceive.Dispose();
                streamReader.Dispose();
                JObject JsonResult = JObject.Parse(strResult);
                int isSuccess = JsonResult["result"].Value<int>();
                string Result = JsonResult["message"].Value<string>();
                //JArray jar = JArray.Parse(JsonResult["Data"].ToString());
                reJson.isSuccess = isSuccess;
                reJson.Result = Result;
                reJson.Data = JsonResult["data"];


                return reJson;
            }
            catch (Exception ex)
            {
                throw ex;
            }
        }

    }
}

代码如下（JsonObject.cs）：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Newtonsoft.Json.Linq;

namespace JasonHelp
{
    public class JsonObject
    {

        private int _isSuccess = 0;
        private string _Result = "";
        //private JArray _Data = new JArray();
        public object _Data = new object();
        public JsonObject()
        {
            _isSuccess =0;
            _Result = "";
            _Data = null;
        }


        /// <summary>
        /// 是否成功
        /// </summary>
        public int isSuccess
        {
            set { _isSuccess = value; }
            get { return _isSuccess; }
        }

        /// <summary>
        ///结果
        /// </summary>
        public string Result
        {
            set { _Result = value; }
            get { return _Result; }
        }

        /// <summary>
        ///返回数据
        /// </summary>
        public object Data
        {
            set { _Data = value; }
            get { return _Data; }
        }


    }
}

       6. 在新建的测试按钮，添加点击事件。

代码如下（按钮事件）：

        /// <summary>
        /// 调用API GetDateTime 按钮事件
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void btnGetTime_Click(object sender, EventArgs e)
        {
            StringBuilder sb = new StringBuilder();
            try
            {
                string strMessage = "";
                JsonObject reJson = new JsonObject();
                //后台地址
                string strInterFace = "http://localhost:3252/MyTestDemo/GetDateTime";
                reJson = HttpReuestUtility.GetResponseDataByGet(strInterFace);
                if (reJson != null)
                {
                    if (reJson.isSuccess == 1)//获取成功
                    {
                        strMessage = reJson.Result.ToString();
                        sb.AppendLine("结论：成功");
                        sb.AppendLine("结果：" + strMessage);
                    }
                    else
                    {
                        strMessage = reJson.Result.ToString();
                        sb.AppendLine("结论：失败");
                        sb.AppendLine("结果：" + strMessage);
                    }

                }
                else
                {
                    strMessage = "和结果判定服务器通讯失败";
                    sb.AppendLine("结论：失败");
                    sb.AppendLine("结果：" + strMessage);
                }
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message);
            }
            finally {
                this.richMessage.Text = sb.ToString();
            }
        }

步骤三：效果展示

  1. 先运行后台端服务

      2.运行winform桌面程序后，点击调用API。

三、总结

以上就是今天要讲的内容，本文仅仅通过一个简单Demo，介绍了winform桌面程序如何调用后台API接口，方便大家参考使用。

qq_36175133
关注
webapi 项目代码及winform下调用接口
01-30
webapi 项目平台，包含接口生成，及接口调用方法，项目代码清晰明了，非常值得初学者参考借鉴
WinFrom调用webapi接口方法及其应用实例
最新发布
susan的博客
08-01 807
WinFrom调用webapi接口方法及其应用实例
C# 调用webapi
weixin_30849403的博客
02-01 325
C#winform程序调用webapi： /// <summary> /// 调用api返回json /// </summary> /// <param name="url">api地址</param> /// <param name="jsonstr">接收参数&lt...
winform调用API
weixin_30369041的博客
11-10 482
简单的调用API用法： using System;using System.Collections.Generic;using System.ComponentModel;using System.Data;using System.Drawing;using System.Linq;using System.Text;using System.Windows.Forms;using Syste...
在Winform混合式框架中整合外部API接口的调用
weixin_34092370的博客
04-02 453
在我们常规的业务处理中，一般内部处理的接口多数都是以数据库相关的，基于混合式开发的Winform开发框架，虽然在客户端调用的时候，一般选择也是基于Web API的调用，不过后端我们可能不仅仅是针对我们业务数据库的处理，也可以能是调用其他外部接口，如物流、供应商接口等接口，本随笔就是主要介绍基于混合式开发框架如何整合外部API接口的调用。 1、混合式框架的结构介绍  我们知道，混合式的框架是可以...
winform内调用API
AntherFantacy的博客
10-09 1548
/// <summary> /// 调用API接口类 /// </summary> public static class HttpRequest { //调用接口返回内容 public static string GetFunction(string Url,string Method) ...
winform调用webapi获取Token授权案例,webapi使用oauth2.0权限控制
03-01
在IT行业中，Windows Forms（WinForms）是一种常用的桌面应用程序开发框架，而WebAPI则是用于构建RESTful服务的ASP.NET框架。本案例主要涉及如何在WinForm应用中通过HttpClient调用使用OAuth2.0授权的WebAPI接口。...
c# WebApi Winform托管
08-30
本示例中的"WebApi Winform托管"是一个结合了C#的Windows Forms（Winform）和ASP.NET Web API的技术实现，它允许在Winform应用内部托管和调用Web API服务。下面我们将深入探讨这个主题。 **WebAPI**是微软为构建...
C# WEBAPI 及winform调用
02-03
webapi 项目平台，包含接口生成，及接口调用方法，项目代码清晰明了，非常值得初学者参考借鉴，更具体的开发步骤可以登入我的博客查看：http://www.cnblogs.com/gudaozi/p/8384734.html
C#调用api接口
12-06
API函数是构筑Windows应用程序的基石，是Windows编程的必备利器。每一种Windows应用程序开发工具都提供了间接或直接调用了Windows API函数的方法
WInform API开发详解
09-12
windows api 开发详解光盘 实例+注释
C#winform调用webapi.rar
05-12
C#winform调用webapi 上传json格式字符串，返回json字符串结果
.net 后台Post，get方式调用webapi
03-26
.net 后台Post，get方式调用webapi,包括上传文件
Winform使用HttpClient调用webApi接口
yanzean的博客
09-14 5215
Winform使用HttpClient调用webApi接口
Winform使用HttpClient调用WebApi的基本用法
gc_2299的博客
06-30 1048
学习并记录采用HttpClient调用基于GET、POST请求的WebApi的基本方式
WinForm 调用Web API接口
qq_41842588的博客
05-17 5913
#region 调用API /// <summary> /// Post调用API返回JSON /// </summary> /// <param name="url">请求地址</param> /// <param name="dic">参数值</param> /// <param name="type">调用...
Winform简单调用WebApi
weixin_34321977的博客
01-08 3365
WebAPI  Controllers public class SimuController : ApiController { //EF 5 BIM_GENERALDICTONARY_DBEntities entities=new BIM_GENERALDICTONARY_DBEntities(); ...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值