Why does the. NETCORE httpclient automatically bring a requestid header when sending a request?

Agile.Zhou 2020-11-09 01:26:14
the. netcore httpclient automatically bring


Strange question

Recently, there is a system in the company that needs to call a third party webservice. Originally called a very simple thing , Use HttpClient Construct a SOAP Please send it out and get it XML That's it .
It's strange that our request will be sent to the server after running for a period of time 504 It was rejected . Make the system unusable , Users complain .
Weirdness is weird. It doesn't happen every time , It's a random query , Every time I modify the code, I release it and think it's OK ,
Two days later, it didn't work , It's so overwhelming .

Postman test

In the case of repeated debugging code failure , I suspect it's the other server's problem . So he took it out Postman Send a request test to the opposite server .
postman The problem was detected as soon as the test was carried out , No matter what you send , The server gives all of them 504 Response . Because it's accessed in the browser webservice The home page is OK , But why postman It doesn't work on the top ?
So I started checking it over and over again postman What's the difference between the requests for , It's not far from finding the problem here . After checking it over and over again, I began to suspect that postman A head problem :

Postman-Token: 4d407574-636b-9343-8216-7f2845cbeef1

postman Every time you send a request, you bring a name called postman-token The head of . So I disabled the head and tried again , Decisive success .
After repeated tests, I finally understood , The other server should be protected , as long as http Request with a custom header will be given directly 504 Response , Reject request directly .
At this point, the reason why the server refused the request finally became clear .

fiddler monitor

however , Our code sent the request without any custom headers . Should not .NET Core Do you take any headers with you when you send a request ?
So install it on the server fiddler, Pass the request fiddler Agent forward , And then monitor http The head of the request . When the system goes wrong again
Go up and check it decisively fiddler. After a look, we found the problem , All rejected requests carry a name called “Request-Id” The head of .
BTgP1A.png
I was shocked ,.NetCore He even talks to himself and adds a head to me ?
If it wasn't discovered in person , I won't believe it if I kill you . Maybe you don't believe it when you see it here , I was thinking that I must be wrong .

Request-Id Where the hell did the head come from ?

This is a question that can't be solved , So he began to ask for advice google. Soon .net core runtime Of github Upper issues Found the same problem :
HttpClient automatically adds Request-Id HTTP header
The questioner said to use HttpClient The request was sent with an inexplicable addition of Request-Id, It's the same as me .
So some people began to discuss it . Some people say HttpClient It's impossible to add it yourself Request-Id This head , The elder brother below is directly in the face , say : In fact, it will , The location of the source code is also given . Smile to cry ! Later, some developers replied that this function was built-in , It's for distributed tracking .
Since the source code has been given out , Directly from the source location given by the elder brother above, start to chase the source code . Here is a general description of the source code :
HttpClient Default constructor :

 public HttpClient()
: this(new HttpClientHandler())
{
}

Keep looking inside HttpClientHandler:

 protected internal override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request,
CancellationToken cancellationToken)
{
return DiagnosticsHandler.IsEnabled() ?
_diagnosticsHandler.SendAsync(request, cancellationToken) :
_socketsHttpHandler.SendAsync(request, cancellationToken);
}

HttpClientHandler When sending a request, it will determine whether to use diagnosticsHandler To send a request . Continue to look at diagnosticsHandler Code for :

 private static void InjectHeaders(Activity currentActivity, HttpRequestMessage request)
{
if (currentActivity.IdFormat == ActivityIdFormat.W3C)
{
if (!request.Headers.Contains(DiagnosticsHandlerLoggingStrings.TraceParentHeaderName))
{
request.Headers.TryAddWithoutValidation(DiagnosticsHandlerLoggingStrings.TraceParentHeaderName, currentActivity.Id);
if (currentActivity.TraceStateString != null)
{
request.Headers.TryAddWithoutValidation(DiagnosticsHandlerLoggingStrings.TraceStateHeaderName, currentActivity.TraceStateString);
}
}
}
else
{
if (!request.Headers.Contains(DiagnosticsHandlerLoggingStrings.RequestIdHeaderName))
{
request.Headers.TryAddWithoutValidation(DiagnosticsHandlerLoggingStrings.RequestIdHeaderName, currentActivity.Id);
}
}
// we expect baggage to be empty or contain a few items
using (IEnumerator<KeyValuePair<string, string?>> e = currentActivity.Baggage.GetEnumerator())
{
if (e.MoveNext())
{
var baggage = new List<string>();
do
{
KeyValuePair<string, string?> item = e.Current;
baggage.Add(new NameValueHeaderValue(WebUtility.UrlEncode(item.Key), WebUtility.UrlEncode(item.Value)).ToString());
}
while (e.MoveNext());
request.Headers.TryAddWithoutValidation(DiagnosticsHandlerLoggingStrings.CorrelationContextHeaderName, baggage);
}
}
}
private static readonly DiagnosticListener s_diagnosticListener =
new DiagnosticListener(DiagnosticsHandlerLoggingStrings.DiagnosticListenerName);
#endregion
}

Finally found the key position, there is a name InjectHeaders There is such a sentence in the method request.Headers.TryAddWithoutValidation(DiagnosticsHandlerLoggingStrings.RequestIdHeaderName, currentActivity.Id); among DiagnosticsHandlerLoggingStrings.RequestIdHeaderName It's a constant , Its value is "Request-Id".
Who brought it here Request-Id The problem with the head is finally hammered .

Repetition problem

The reason is found , So we started testing the solution . The first step in solving the problem is to reproduce the problem first . You use it normally HttpClient You don't take this header with you when you send a request . It's not easy to have local requests with this header . After looking at the source code, we found that it was actually with .net core Of Diagnostics Mechanisms related to . Because of the complexity of the source code logic , Directly give the code with the header :
So let's define a Observer:

 public class MyObserver<T> : IObserver<T>
{
private Action<T> _next;
public MyObserver(Action<T> next)
{
_next = next;
}
public void OnCompleted()
{
}
public void OnError(Exception error)
{
}
public void OnNext(T value) => _next(value);
}

subscribe HttpHandlerDiagnosticListener:

 DiagnosticListener.AllListeners.Subscribe(new MyObserver<DiagnosticListener>(listener =>
{
// Determine the name of the publisher
if (listener.Name == "HttpHandlerDiagnosticListener")
{
// Get subscription information
listener.Subscribe(new MyObserver<KeyValuePair<string, object>>(listenerData =>
{
System.Console.WriteLine($" Listen to the name :{listenerData.Key}");
dynamic data = listenerData.Value;
}));
}
}));

When we subscribe HttpHandlerDiagnosticListener When HttpClient The request sent will take this header with it . This design is really abnormal , because DiagnosticListener.AllListeners Is static , So its impact is global . In other words, I subscribe to a monitor here , It will cause all of the HttpClient They all started to wear this head .
This also explains why our program has been running for some time before it comes with Request-Id The head of . Because other modules in our program , Or the referenced third-party library will start to subscribe when it reaches a certain state HttpHandlerDiagnosticListener This monitor , Cause me to ask webservice This header is also included in the code .

solve the problem

The cause of the problem has also been found , It's happening here , Now we're going to start really solving the problem . after google Follow the source code , Must let HttpClient Don't send this Request-Id There are several ways to head .

  1. Method 1

Set up System.Net.Http.EnableActivityPropagation The switch is false

string switchName = "System.Net.Http.EnableActivityPropagation";
AppContext.SetSwitch(switchName, false);
  1. Method 2
    Configure environment variables DOTNET_SYSTEM_NET_HTTP_ENABLEACTIVITYPROPAGATIO=false

  2. Method 3

 public class DisableActivityHandler : DelegatingHandler
{
public DisableActivityHandler(HttpMessageHandler innerHandler) : base(innerHandler)
{
}
protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
Activity.Current = null;
return await base.SendAsync(request, cancellationToken);
}
}
var httpClient = new HttpClient(new DisableActivityHandler(new HttpClientHandler()));

This method defines a DisableActivityHandler Reconstruct HttpClient, Send the request every time Activity.Current empty .

summary

Recently, by this Request-Id It's been a long time . I can't help but make complaints about it. , Is this built-in feature really good , Force insert custom header , Have you considered the feeling of firewall ? Or is it possible for developers to choose whether to include Diagnostic Statistics , Instead of adding headers to all requests at the beginning of a subscription somewhere , After all, we can't control whether the third-party library has any operation . If you want to turn this off Diagnostic Is it possible to be in HttpClient Instance directly gives a clear switch for developers to turn it off , Rather than what environment variables need to be configured .

ps: If using HttpWebRequest Class sending requests has the same problem , because HttpWebRequest When you send a request, you use HttpClient.

Pay attention to my official account and play with technology

版权声明
本文为[Agile.Zhou]所创,转载请带上原文链接,感谢

  1. [front end -- JavaScript] knowledge point (IV) -- memory leakage in the project (I)
  2. This mechanism in JS
  3. Vue 3.0 source code learning 1 --- rendering process of components
  4. Learning the realization of canvas and simple drawing
  5. gin里获取http请求过来的参数
  6. vue3的新特性
  7. Get the parameters from HTTP request in gin
  8. New features of vue3
  9. vue-cli 引入腾讯地图(最新 api,rocketmq原理面试
  10. Vue 学习笔记(3,免费Java高级工程师学习资源
  11. Vue 学习笔记(2,Java编程视频教程
  12. Vue cli introduces Tencent maps (the latest API, rocketmq)
  13. Vue learning notes (3, free Java senior engineer learning resources)
  14. Vue learning notes (2, Java programming video tutorial)
  15. 【Vue】—props属性
  16. 【Vue】—创建组件
  17. [Vue] - props attribute
  18. [Vue] - create component
  19. 浅谈vue响应式原理及发布订阅模式和观察者模式
  20. On Vue responsive principle, publish subscribe mode and observer mode
  21. 浅谈vue响应式原理及发布订阅模式和观察者模式
  22. On Vue responsive principle, publish subscribe mode and observer mode
  23. Xiaobai can understand it. It only takes 4 steps to solve the problem of Vue keep alive cache component
  24. Publish, subscribe and observer of design patterns
  25. Summary of common content added in ES6 + (II)
  26. No.8 Vue element admin learning (III) vuex learning and login method analysis
  27. Write a mini webpack project construction tool
  28. Shopping cart (front-end static page preparation)
  29. Introduction to the fluent platform
  30. Webpack5 cache
  31. The difference between drop-down box select option and datalist
  32. CSS review (III)
  33. Node.js学习笔记【七】
  34. Node.js learning notes [VII]
  35. Vue Router根据后台数据加载不同的组件(思考-&gt;实现-&gt;不止于实现)
  36. Vue router loads different components according to background data (thinking - & gt; Implementation - & gt; (more than implementation)
  37. 【JQuery框架,Java编程教程视频下载
  38. [jQuery framework, Java programming tutorial video download
  39. Vue Router根据后台数据加载不同的组件(思考-&gt;实现-&gt;不止于实现)
  40. Vue router loads different components according to background data (thinking - & gt; Implementation - & gt; (more than implementation)
  41. 【Vue,阿里P8大佬亲自教你
  42. 【Vue基础知识总结 5,字节跳动算法工程师面试经验
  43. [Vue, Ali P8 teaches you personally
  44. [Vue basic knowledge summary 5. Interview experience of byte beating Algorithm Engineer
  45. 【问题记录】- 谷歌浏览器 Html生成PDF
  46. [problem record] - PDF generated by Google browser HTML
  47. 【问题记录】- 谷歌浏览器 Html生成PDF
  48. [problem record] - PDF generated by Google browser HTML
  49. 【JavaScript】查漏补缺 —数组中reduce()方法
  50. [JavaScript] leak checking and defect filling - reduce() method in array
  51. 【重识 HTML (3),350道Java面试真题分享
  52. 【重识 HTML (2),Java并发编程必会的多线程你竟然还不会
  53. 【重识 HTML (1),二本Java小菜鸟4面字节跳动被秒成渣渣
  54. [re recognize HTML (3) and share 350 real Java interview questions
  55. [re recognize HTML (2). Multithreading is a must for Java Concurrent Programming. How dare you not
  56. [re recognize HTML (1), two Java rookies' 4-sided bytes beat and become slag in seconds
  57. 【重识 HTML ,nginx面试题阿里
  58. 【重识 HTML (4),ELK原来这么简单
  59. [re recognize HTML, nginx interview questions]
  60. [re recognize HTML (4). Elk is so simple