C#进阶-ASP.NET WebForms调用ASMX的WebService接口

news2025/1/21 14:19:29

ASMX 文件在 ASP.NET WebForms 中提供了创建 Web 服务的便捷方式,通过公开 Web 方法,允许远程客户端调用这些方法并获取数据。本文介绍了 ASMX 文件的基本功能、如何定义 WebService 接口、通过 HTTP 和 SOAP 请求调用 WebService 接口,以及使用 Postman 进行测试的方法。掌握这些知识,可以帮助你在 ASP.NET WebForms 项目中更好地使用 ASMX 文件创建和调用 Web 服务。


一、名词简介

1、ASMX文件

ASMX 文件是 ASP.NET 中用于创建 Web 服务的文件。Web 服务是用于跨网络传输数据和服务的标准方法,使不同平台和编程语言的系统可以互相通信。通过 ASMX 文件,开发者可以创建基于 SOAP 协议 / HTTP 协议 的 Web 服务,这些服务可以被各种客户端(如浏览器、移动应用程序、其他服务器应用程序)调用。

ASMX 文件主要功能包括:

  • 提供跨平台、跨语言的服务接口。
  • 支持标准的 SOAP 协议进行数据交换。
  • 能够通过 HTTP/HTTPS 协议传输数据。
  • 允许公开 Web 方法,这些方法可以被远程客户端调用。

简答来说,就是 ASP.NET 提供的 Web 接口文件。


2、WebService接口

我们可以 在ASMX 文件中创建 WebService 接口, 定义 Web 服务提供的具体功能。每个接口由一组公开的方法(即 Web 方法)组成,这些方法可以通过 HTTP 请求被调用。

以下是一个简单的 ASMX 文件示例:

using System.Web.Services;

namespace TestAsmxProject.Asmx
{
    /// <summary>
    /// Test 的摘要说明
    /// </summary>
    [WebService(Namespace = "http://tempuri.org/")]
    [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
    [System.ComponentModel.ToolboxItem(false)]
    // 若要允许使用 ASP.NET AJAX 从脚本中调用此 Web 服务,请取消注释以下行。 
    // [System.Web.Script.Services.ScriptService]
    public class Test : System.Web.Services.WebService
    {

        [WebMethod]
        public string HelloWorld()
        {
            return "Hello World";
        }

        [WebMethod(Description = "计算两个数的和")]
        public int Add(int a, int b)
        {
            return a + b;
        }

    }
}

在上述示例中,HelloWorld 和 Add 是两个公开的 Web 方法,可以被客户端调用。


二、创建ASMX的WebService接口

1、创建ASP.NET WebForms项目

Visual Studio 2019 应用内新建项目,选择 ASP.NET Web应用程序(.NET Framework)。

项目名称起名为 TestAsmxProject,框架选择 .NET Framework 4.7.2。

选择 Web Forms,取消右侧 为 HTTPS 配置 的选项。

项目创建成功,目录如下:

我们点击上方 IIS Express 按钮,启动一下项目,看看是否能顺利运行。

启动成功。


2、创建ASMX接口程序

接着,我们创建 ASMX 文件。这里,我先创建了一个名为 Asmx 的文件夹,在文件夹里新建项。

添加新项 中选择 Web 服务 (ASMX),命名为 Test.asmx。

双击打开新建好的 Test.asmx,里面存在一个默认的 HelloWorld 方法。

我们在此基础上添加一个 Add 方法。

增加后,Test.asmx 代码如下:

using System.Web.Services;

namespace TestAsmxProject.Asmx
{
    /// <summary>
    /// Test 的摘要说明
    /// </summary>
    [WebService(Namespace = "http://tempuri.org/")]
    [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
    [System.ComponentModel.ToolboxItem(false)]
    // 若要允许使用 ASP.NET AJAX 从脚本中调用此 Web 服务,请取消注释以下行。 
    // [System.Web.Script.Services.ScriptService]
    public class Test : System.Web.Services.WebService
    {

        [WebMethod]
        public string HelloWorld()
        {
            return "Hello World";
        }

        [WebMethod(Description = "计算两个数的和")]
        public int Add(int a, int b)
        {
            return a + b;
        }

    }
}

3、测试ASMX接口程序

我们重新启动项目,测试 Test.asmx 接口程序。

程序启动后,浏览器输入 http://localhost:52028/Asmx/Test.asmx,页面如下:

这个是 ASP.NET 自带的 ASMX 接口程序的调试页面。

我们先测试 HelloWorld 接口,点击 HelloWorld。

这是一个输入参数的页面,因为我们这个是无参方法,所以,直接点击调用。

返回的XML格式结果如下:

<string xmlns="http://tempuri.org/">Hello World</string>

下面,我们再来测试 Test.asmx 接口程序的有参方法 Add。

点击 Add,进入需要输入参数的页面。

输入测试参数 (比如我这里写的 a=1、b=2),点击调用。

返回的XML格式结果如下:

<int xmlns="http://tempuri.org/">3</int>

以上就是调试 ASMX 接口程序的基本方法,但是我们实际开发中,肯定是通过程序来调用,所以我们需要通过网络协议请求,下面是两种常用的网络协议请求的示例。

在允许外部系统调用该WEB服务之前,我们需要放开下面这行代码的注释:


三、HTTP协议请求WebService接口

通过 HTTP 请求可以调用 Web 服务接口。使用工具(如浏览器、Postman 等)发送 HTTP 请求,并查看响应结果。以下是使用 Postman 调用 Add 方法的示例步骤:

  1. 打开 Postman,创建一个新的请求;
  2. 设置请求类型为 GET 或 POST;
  3. 输入 Web 服务的 URL,例如:http://localhost:52028/Asmx/Test.asmx/Add;
  4. 如果是 POST请求,在 Body 里需要填写参数,GET 填在 Params 里;
  5. 点击 Send 按钮发送请求,并查看响应结果;

示例请求:

POST /Asmx/Test.asmx/Add HTTP/1.1
Host: localhost:52028

示例参数:

{
	"a": 1,
	"b": 2
}

响应结果:

{
    "d": 3
}

如图:


四、SOAP协议请求WebService接口

SOAP 是一种基于 XML 的协议,用于在网络上交换结构化信息。通过 SOAP 请求,可以调用 Web 服务的公开方法。我们使用 SOAP协议 调用 Add 方法:

使用 Postman 发送 SOAP 请求的步骤:

  1. 打开 Postman,创建一个新的请求;
  2. 设置请求类型为 POST;
  3. 输入 Web 服务的 URL,例如:http://localhost:52028/Asmx/Test.asmx;
  4. 如果是 POST请求,在 Body 里需要填写 SOAP 格式的参数;
  5. 点击 Send 按钮发送请求,并查看响应结果;

示例请求:

POST /Asmx/Test.asmx HTTP/1.1
Host: localhost:52028
Content-Type: text/xml; charset=utf-8

示例参数:

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Add xmlns="http://tempuri.org/">
      <a>3</a>
      <b>5</b>
    </Add>
  </soap:Body>
</soap:Envelope>

响应结果:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <soap:Body>
        <AddResponse xmlns="http://tempuri.org/">
            <AddResult>3</AddResult>
        </AddResponse>
    </soap:Body>
</soap:Envelope>

如图:


五、ASMX功能和使用总结

我们通过以下表格来概述ASMX 文件的主要功能和使用方法:

说明
文件类型.asmx 文件
主要功能提供基于 SOAP 协议的 Web 服务,允许不同平台和语言的系统进行通信。
协议SOAP(Simple Object Access Protocol)
传输协议HTTP/HTTPS
主要用途创建跨平台、跨语言的数据和服务接口。
关键组件WebService 类、WebMethod 属性、SOAP 请求和响应。
调用工具Postman、浏览器、编程语言(如 C#、Java)
调试方法使用调试工具(如 Visual Studio 的断点调试、日志输出)
安全性可以通过 SoapExtension 实现 IP 拦截和其他安全措施。

ASMX 文件在 ASP.NET WebForms 中提供了创建 Web 服务的便捷方式,通过公开 Web 方法,允许远程客户端调用这些方法并获取数据。ASMX 文件支持标准的 SOAP 协议,可以通过 HTTP/HTTPS 进行数据传输,使其成为跨平台、跨语言系统集成的理想选择。

通过本文,我们介绍了 ASMX 文件的基本功能、如何定义 WebService 接口、通过 HTTP 和 SOAP 请求调用 WebService 接口,以及使用 Postman 进行测试的方法。掌握这些知识,可以帮助你在 ASP.NET WebForms 项目中更好地使用 ASMX 文件创建和调用 Web 服务。

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

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

相关文章

python实现网页自动化(自动登录需要验证的网页)

引言: python作为实现网页自动化的一个重要工具,其强大的各种封装的库使得程序运行更加简洁,只需要下载相应的库,然后调用库中的函数就可以简便的实现我们想要的网页相关操作。 正文: 我的前几篇文章写了关于初学爬虫中比较容易上手的功能,例如爬取静态网页的数据、动…

系统运维面试总结(shell编程)

SYNDDOS攻击&#xff0c;需要判断这个访问是正常访问还是信包攻击&#xff0c;当前这个信包发起的访问数量是多少&#xff0c;例如看到30个信包同时再访问时设置监控报警。

Wails 安装初体验

文章目录 Wails 安装说明1. 系统要求2. 安装步骤3. 构建应用 结论 Wails 安装说明 Wails 是一个用于构建桌面应用的 Go 框架&#xff0c;结合了现代前端技术。以下是安装步骤&#xff1a; 1. 系统要求 Go 1.16 或更高版本Node.js 和 npm可选&#xff1a;适用于 Windows、mac…

SSH版本升级-openssh-9.7p1

SSH版本升级-openssh-9.7p1 1、查看当前版本2、安装openssl2.1、编译安装ssl 3、下载新版本SSH4、备份原有的SSH配置5、上传文件并解压6、卸载原有的openssh包7、编译安装openssh7.1、在解压后的目录&#xff0c;初始化openssh7.2、将文件拷回7.3、修改配置文件 最终实现&#…

傻瓜交换机多网段互通组网、设备无法配置网关案例

记录一下&#xff1a; 一、傻瓜交换机多网段互通组网 1、客户在核心交换机上创建了VLAN10&#xff0c;VLAN20。 VLAN10&#xff1a;IP192.168.10.254 VLAN20&#xff1a;IP192.168.20.254 在核心交换机下挂了一台傻瓜交换机&#xff0c;傻瓜交换机接入了一台OA服务器IP&#…

Qt之Pdb生成及Dump崩溃文件生成与调试(含注释和源码)

文章目录 一、Pdb生成及Dump文件使用示例图1.Pdb文件生成2.Dump文件调试3.参数不全Pdb生成的Dump文件调试 二、个人理解1.生成Pdb文件的方式2.Dump文件不生产的情况 三、源码Pro文件mian.cppMainWindowUi文件 总结 一、Pdb生成及Dump文件使用示例图 1.Pdb文件生成 下图先通过…

Transformer详解encoder

目录 1. Input Embedding 2. Positional Encoding 3. Multi-Head Attention 4. Add & Norm 5. Feedforward Add & Norm 6.代码展示 &#xff08;1&#xff09;layer_norm &#xff08;2&#xff09;encoder_layer1 最近刚好梳理了下transformer&#xff0c;今…

深入理解PHP命名空间

在PHP项目中&#xff0c;命名空间&#xff08;namespace&#xff09;是一个非常重要的特性。它不仅帮助开发者组织代码&#xff0c;还能避免类、函数、常量等命名冲突问题。本文将详细介绍PHP命名空间的概念、使用方法和最佳实践。 一、什么是命名空间&#xff1f; 命名空间…

LeetCode:经典题之2、445 题解及延伸

系列目录 88.合并两个有序数组 52.螺旋数组 567.字符串的排列 643.子数组最大平均数 150.逆波兰表达式 61.旋转链表 160.相交链表 83.删除排序链表中的重复元素 389.找不同 1491.去掉最低工资和最高工资后的工资平均值 896.单调序列 206.反转链表 92.反转链表II 141.环形链表 …

github主页这样优化,让人眼前一亮

我的主页&#xff08;一之十六&#xff09; 1. 创建与账户ID同名的仓库 注意&#xff1a;记得勾选Add a README file 2. markdown语法自定义README.md 3. 辅助工具 优秀profile&#xff1a;https://zzetao.github.io/awesome-github-profile/动态文字&#xff1a;https://r…

pytest测试框架pytest-cov插件生成代码覆盖率

Pytest提供了丰富的插件来扩展其功能&#xff0c;本章介绍下pytest-cov插件&#xff0c;用于生成测试覆盖率报告&#xff0c;帮助开发者了解哪些部分的代码被测试覆盖&#xff0c;哪些部分还需要进一步的测试。 pytest-cov 支持多种报告格式&#xff0c;包括纯文本、HTML、XML …

修复vcruntime140.dll方法分享

修复vcruntime140.dll方法分享 最近在破解typora的时候出现了缺失vcruntime140.dll文件的报错导致软件启动失败。所以找了一番资料发现都不是很方便的处理&#xff0c;甚至有的dll处理工具还需要花钱&#xff1f;&#xff1f;&#xff1f;&#xff1f;&#xff0c;我本来就是为…

前端学习 Vue 插槽如何实现组件内容分发?

目录 一、Vue.js框架介绍二、什么是Vue 插槽三、Vue 插槽的应用场景四、Vue 插槽如何实现组件内容分发 一、Vue.js框架介绍 Vue.js是一个用于构建用户界面的渐进式JavaScript框架。它设计得非常灵活&#xff0c;可以轻松地被集成到现有的项目中&#xff0c;也可以作为一个完整…

新型发电系统——光伏行业推动能源转型

一、发展背景 “十四五”期间&#xff0c;随着“双碳”目标提出及逐步落实&#xff0c;本就呈现出较好发展势头的分布式光伏发展有望大幅提速。就“十四五”光伏发展规划&#xff0c;国家发改委能源研究所可再生能源发展中心副主任陶冶表示&#xff0c;“双碳”目标意味着国家…

轻松解锁电脑强悍性能,4000MHz的玖合星舞 DDR4 内存很能打

轻松解锁电脑强悍性能&#xff0c;4000MHz的玖合星舞 DDR4 内存很能打 哈喽小伙伴们好&#xff0c;我是Stark-C~ 很多有经验的电脑玩家在自己DIY电脑选购内存条的时候&#xff0c;除了内存总容量&#xff0c;最看重的参数那就是频率了。内存频率和我们常说的CPU主频一样&…

计网之IP

IP IP基本认识 不使用NAT时&#xff0c;源IP地址和目的IP地址不变&#xff0c;只要源MAC和目的MAC地址在变化 IP地址 D类是组播地址&#xff0c;E类是保留地址 无分类地址CIDR 解决直接分类的B类65536太多&#xff0c;C类256太少a.b.c.d/x的前x位属于网路号&#xff0c;剩…

pytest测试框架pytest-random-order插件随机执行用例顺序

Pytest提供了丰富的插件来扩展其功能&#xff0c;本章介绍下pytest-random-order插件&#xff0c;随机设置pytest测试用例的运行顺序&#xff0c;并对随机性进行一些控制。 官方文档&#xff1a; https://pytest-cov.readthedocs.io/en/latest/index.html 适配版本说明&#x…

ComfyUI局部重绘的四种方式 (附件工作流在最后)

前言 局部重绘需要在图片中选择重绘区域&#xff0c;点击图片右击选择Open in MaskEditor&#xff08;在蒙版编辑器中打开&#xff09;&#xff0c;用鼠标描绘出需要重绘的区域 方式一&#xff1a;重绘编码器 这种方式重绘比较生硬&#xff0c;需要额外搭配使用才行 方式二&…

ThreadPoolExecutor基于ctl变量的声明周期管理

个人博客 ThreadPoolExecutor基于ctl变量的声明周期管理 | iwts’s blog 总集 想要完整了解下ThreadPoolExecutor&#xff1f;可以参考&#xff1a; 基于源码详解ThreadPoolExecutor实现原理 | iwts’s blog ctl字段的应用 线程池内部使用一个变量ctl维护两个值&#xff…

逆变器--学习笔记(一)

并网&#xff1a; 逆变器中的“并网”指的是逆变器将其产生的交流电与电网同步&#xff0c;并输送到公共电网中。并网逆变器通常用于太阳能发电系统和其他分布式发电系统&#xff0c;将其产生的电能输送到电网供其他用户使用。 THD谐波失真总量: 逆变器的THD&#xff08;Tot…