添加带冒号的User-Agent时触发System.FormatException的解决方法

问题背景 #

我需要在C#中调用接口https://tools.keycdn.com/geo.json?host=google.com，根据要求必须使用自定义User-Agent：

User-Agent: keycdn-tools:https://myownsite.com

使用以下代码发起请求时，添加User-Agent环节抛出System.FormatException：

HttpClient? client = new HttpClient();

// Add correct user agent.
var request = new HttpRequestMessage(HttpMethod.Get, "https://tools.keycdn.com/geo.json?host=" + textBoxDomain.Text);
var useragentValue = new ProductInfoHeaderValue("keycdn-tools:https://myownsite.com");
request.Headers.UserAgent.Add(useragentValue);

var result = await client.SendAsync(request);

尝试过两种方式都得到相同错误：

• 直接向client.DefaultRequestHeaders添加User-Agent
• 向request的Headers添加User-Agent

错误原因 #

ProductInfoHeaderValue类的构造参数需要符合HTTP标准的User-Agent产品信息格式，不允许包含冒号、斜杠这类特殊字符。它的设计目的是拆分User-Agent为产品名称/版本号的结构，而我们需要的是一个完整的自定义字符串，不符合该类的格式要求，因此抛出格式异常。

解决方法 #

跳过ProductInfoHeaderValue，直接通过Headers的Add方法添加完整的User-Agent字符串即可：

方案1：给单个请求添加User-Agent #

HttpClient? client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://tools.keycdn.com/geo.json?host=" + textBoxDomain.Text);
// 直接添加完整的User-Agent字符串
request.Headers.Add("User-Agent", "keycdn-tools:https://myownsite.com");

var result = await client.SendAsync(request);

方案2：给HttpClient全局添加默认User-Agent #

HttpClient? client = new HttpClient();
// 全局默认User-Agent，所有请求都会携带
client.DefaultRequestHeaders.Add("User-Agent", "keycdn-tools:https://myownsite.com");

var request = new HttpRequestMessage(HttpMethod.Get, "https://tools.keycdn.com/geo.json?host=" + textBoxDomain.Text);
var result = await client.SendAsync(request);

这样就能避免格式校验错误，成功设置符合要求的User-Agent。

内容的提问来源于stack exchange，提问作者MrPython