WebService笔记

WebService笔记

转载

转载 netcore构建webservice以及调用的完整流程_net core 调用webservice base64-CSDN博客

构建

前置准备

框架版本要求：netcore3.1以上 引入nuget包 SoapCore

编写服务

1.编写服务接口 示例

using System.ServiceModel;
​
namespace Services;
​
[ServiceContract(Namespace = "http://Demo.WebService/")]
 public interface ISampleService{
    [OperationContract]
    int CalcAdd(int a,int b);
}

2.继承服务接口 示例

public class SampleService:ISampleService{
    public int CalcAdd(int a,int b){
        return a+b;
    }
}

如果输入输出参数是一个类，需要这么声明

using System.Runtime.Serialization;
​
namespace Models;
​
[DataContract]
public class ReturnValue
{
    [DataMember]
    public int Id { get; set; }
    [DataMember]
    public string Name { get; set; }
}

挂载服务

.net6\7写法

//other code
builder.Services.AddSoapCore();
builder.Services.TryAddSingleton<ISampleService, SampleService>();
//other code
app.UseRouting();
app.UseEndpoints(endpoints =>
{
    //注册webservice
    endpoints.UseSoapEndpoint<ISampleService>("/SampleService.asmx", new SoapEncoderOptions(), SoapSerializer.XmlSerializer);
});

至此最小案例已完成，启动服务后，任意支持webservice的客户端可通过"SampleService.asmx"调用服务

处理SoapHeader

1.创建承载Header的类 示例

public class HeaderValue{
    public string Token{get;set;}
}

2.创建ServiceBase

public class ServiceBase{
    public HeaderValue headerValue;
    public ServiceBase(){
        headerValue=new HeaderValue();
    }
     /// <summary>
    /// 从BODY解析SoapHeader，SoapCore没有提供解析Header，因此从客户端提交的XML内容里取出SoapHeader
    /// </summary>
    /// <param name="body"></param>
    public void ParseHeaderFromBody(Stream body){
        body.Seek(0, SeekOrigin.Begin);
            using var reader = new StreamReader(body);
            var xml = reader.ReadToEndAsync().GetAwaiter().GetResult();
            if (string.IsNullOrEmpty(xml))
            {
                return;
            }
            var envelope = new XmlDocument();
            envelope.LoadXml(xml);
            var node = envelope.DocumentElement?.ChildNodes.Cast<XmlNode>().FirstOrDefault(n => n.LocalName == "Header")?.FirstChild;
            if (node == null)
            {
                return;
            }
             var cns = node.ChildNodes.Cast<XmlNode>();
             headerValue.Token=cns.FirstOrDefault(d => d.LocalName == "Token")?.InnerText;
    }
}

3.所有服务继承ServiceBase 示例

public class SampleService:ServiceBase,ISampleService{
    public int CalcAdd(int a,int b){
        Console.WriteLine($"headervalue-token:{headerValue.Token}");
        return a+b;
    }
}

4.创建ServiceOperationTuner

public class ServiceOperationTuner : IServiceOperationTuner
    {
        public void Tune(HttpContext httpContext, object serviceInstance, OperationDescription operation)
        {
            var service = serviceInstance as ServiceBase;
            service.ParseHeaderFromBody(httpContext.Request.Body);
        }
    }

5.挂载ServiceOperationTuner

builder.Services.AddSoapServiceOperationTuner(new ServiceOperationTuner());

6.其它配置

//全局启用流缓冲
app.Use((context, next) =>
{
    context.Request.EnableBuffering();
    return next();
});

调用

添加服务

一路下一步就行了

调用服务

//初始化client,连接地址是服务发现里填的那个，如果想改地址，查看这个构造函数的其它重载
var _SampleServiceClient = new SampleServiceClient();
//处理SoapHeader
using var scope = new OperationContextScope(_SampleServiceClient.InnerChannel);
//客户端准备好同样的HeaderValue类
 var header = MessageHeader.CreateHeader("headerValue", "http://Demo.WebService/", new HeaderValue
            {
                Token="this is token"
            });
OperationContext.Current.OutgoingMessageHeaders.Add(header);
//调用服务里的函数
_SampleServiceClient.CalcAdd(1,2);

补充内容

1.netcore创建的webservice没有主动声明SoapHeader，所以客户端想携带Header就要绕一下 2.soapheader和http header是俩个概念，soapheader存在于服务请求的body中，http header存在于服务请求的协议报文中 3.SoapCore来源

2补充-在没有完整的wsdl文件

在没有webservice服务引用及没有wsdl文件情况下如何调用接口

//虽然没有服务引用与完整的wsdl文件 ，只有 SOAP 格式命名空间和参数
// 准备 SOAP 请求
string soap = @"<?xml version=""1.0"" encoding=""utf-8""?>
<soapenv:Envelope xmlns:soapenv=""http://schemas.xmlsoap.org/soap/envelope/"" xmlns:tns=""http://Demo.WebService/"">
   <soapenv:Header/>
   <soapenv:Body>
      <tns:CalcAdd>
         <tns:a>5</tns:a>
         <tns:b>10</tns:b>
      </tns:CalcAdd>
   </soapenv:Body>
</soapenv:Envelope>";

            // Web 服务 URL
            string url = "http://127.0.0.1:5789/WebService/WebService.asmx"; // 这里需要替换成你的服务地址

            // 创建 HttpClient 实例
            using (HttpClient client = new HttpClient())
            {
                // 创建 HttpRequestMessage 实例
                HttpRequestMessage requestMessage = new HttpRequestMessage(HttpMethod.Post, url)
                {
                    Content = new StringContent(soap, Encoding.UTF8, "text/xml") // 设置请求体为 SOAP 消息
                };

                // 设置 SOAPAction（可选，取决于 Web 服务要求）
                requestMessage.Headers.Add("SOAPAction", "http://Demo.WebService/CalcAdd");

                // 发送请求并获取响应
                HttpResponseMessage response = await client.SendAsync(requestMessage);

                // 读取响应内容
                string responseContent = await response.Content.ReadAsStringAsync();
                Console.WriteLine("Response: \n" + responseContent);

                // 解析响应内容
                XmlDocument responseXml = new XmlDocument();
                responseXml.LoadXml(responseContent);
                Console.WriteLine("Parsed Response: \n" + responseXml.OuterXml);
                //得到<xml>建议后续提取返回体使用string.indexof('<xxxResponse>')-string.indexof('</xxxResponse>')

                return Ok(responseXml.OuterXml.ToString());
            }